@kernelminds/scailo-sdk 0.1.28 → 0.1.30

package/lib/cjs/types/src/absences.scailo_pb.d.ts

@@ -4,85 +4,85 @@ import { FormFieldDatum, FormFieldDatumCreateRequest, FormFieldDatumFilterReques
 import { ApprovalMetadata, BOOL_FILTER, EmployeeMetadata, LogbookLogConciseSLC, SORT_ORDER, STANDARD_LIFECYCLE_STATUS } from "./base.scailo_pb.js";
 /**
  *
- * Describes the available sort keys
+ * Enumeration of fields available for sorting absence search results.
  *
  * @generated from enum Scailo.ABSENCE_SORT_KEY
  */
 export declare enum ABSENCE_SORT_KEY {
     /**
-     * Fetch ordered results by id
+     * @description Default sort behavior (by internal ID).
      *
      * @generated from enum value: ABSENCE_SORT_KEY_ID_UNSPECIFIED = 0;
      */
     ABSENCE_SORT_KEY_ID_UNSPECIFIED = 0,
     /**
-     * Fetch ordered results by the creation timestamp
+     * @description Sort by the timestamp the record was initially created.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_CREATED_AT = 1;
      */
     ABSENCE_SORT_KEY_CREATED_AT = 1,
     /**
-     * Fetch ordered results by the modified timestamp
+     * @description Sort by the timestamp the record was last modified.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_MODIFIED_AT = 2;
      */
     ABSENCE_SORT_KEY_MODIFIED_AT = 2,
     /**
-     * Fetch ordered results by the approved on timestamp
+     * @description Sort by the official approval timestamp.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_APPROVED_ON = 3;
      */
     ABSENCE_SORT_KEY_APPROVED_ON = 3,
     /**
-     * Fetch ordered results by the approved by field
+     * @description Sort by the system ID of the approving user.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_APPROVED_BY = 4;
      */
     ABSENCE_SORT_KEY_APPROVED_BY = 4,
     /**
-     * Fetch ordered results by the approver's role ID
+     * @description Sort by the security role ID used by the approver.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_APPROVER_ROLE_ID = 5;
      */
     ABSENCE_SORT_KEY_APPROVER_ROLE_ID = 5,
     /**
-     * Fetch ordered results by the approver's completed on timestamp
+     * @description Sort by the timestamp of record completion.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_COMPLETED_ON = 6;
      */
     ABSENCE_SORT_KEY_COMPLETED_ON = 6,
     /**
-     * Fetch ordered results by the reference ID
+     * @description Sort alphabetically by the user-provided reference ID.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_REFERENCE_ID = 10;
      */
     ABSENCE_SORT_KEY_REFERENCE_ID = 10,
     /**
-     * Fetch ordered results by the final ref number
+     * @description Sort alphabetically by the system-generated reference number.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_FINAL_REF_NUMBER = 11;
      */
     ABSENCE_SORT_KEY_FINAL_REF_NUMBER = 11,
     /**
-     * Fetch ordered results by the user ID
+     * @description Sort numerically by the employee's user ID.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_USER_ID = 12;
      */
     ABSENCE_SORT_KEY_USER_ID = 12,
     /**
-     * Fetch ordered results by the leave request ID
+     * @description Sort numerically by the linked leave request ID.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_LEAVE_REQUEST_ID = 13;
      */
     ABSENCE_SORT_KEY_LEAVE_REQUEST_ID = 13,
     /**
-     * Fetch ordered results by the "from timestamp"
+     * @description Sort chronologically by the absence start date.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_FROM_TIMESTAMP = 14;
      */
     ABSENCE_SORT_KEY_FROM_TIMESTAMP = 14,
     /**
-     * Fetch ordered results by the "to timestamp"
+     * @description Sort chronologically by the absence end date.
      *
      * @generated from enum value: ABSENCE_SORT_KEY_TO_TIMESTAMP = 15;
      */
@@ -90,79 +90,186 @@ export declare enum ABSENCE_SORT_KEY {
 }
 /**
  *
- * Describes the parameters necessary to create a record
+ * Request message for recording a new employee absence.
+ * This record tracks non-attendance periods such as sick leave, unauthorized absences,
+ * or specific time-off types not covered by standard leave requests.
+ *
+ * **Note:** This is the primary entry point for HR and Managers to log time away
+ * from work for compliance and payroll processing.
  *
  * @generated from message Scailo.AbsencesServiceCreateRequest
  */
 export declare class AbsencesServiceCreateRequest extends Message<AbsencesServiceCreateRequest> {
     /**
-     * Stores a globally unique entity UUID. This will be set at the organization level
+     *
+     * @optional
+     *
+     * @description The globally unique identifier for the Organization or Business Entity.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     *
+     * @regex ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+     *
+     * @format If provided, must be a valid v4 UUID in canonical hyphenated form.
      *
      * @generated from field: string entity_uuid = 1;
      */
     entityUuid: string;
     /**
-     * Stores any comment that the user might add during this operation
+     *
+     * @optional
+     *
+     * @description Audit log comment or justification for creating this record. This is stored in the record's history for compliance purposes.
+     *
+     * @example "Employee called in with flu symptoms."
+     *
+     * @regex .*
+     *
+     * @format May contain any UTF-8 characters or be left empty.
      *
      * @generated from field: string user_comment = 2;
      */
     userComment: string;
     /**
-     * The associated vault folder ID
+     *
+     * @optional
+     *
+     * @description The ID of the associated vault folder for storing documents. Defaults to 0 if no specific folder is assigned.
+     *
+     * @example 15234
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
     vaultFolderId: bigint;
     /**
-     * The reference ID of the absence
+     *
+     * @mandatory
+     *
+     * @description A unique external reference ID for the record. Must be alphanumeric (spaces allowed). Used for cross-referencing with external systems.
+     *
+     * @example "ABS-2023-001"
+     *
+     * @regex "[0-9A-Za-z ]+$"
+     *
+     * @format Alphanumeric characters and spaces only. No special symbols or punctuation allowed.
      *
      * @generated from field: string reference_id = 10;
      */
     referenceId: string;
     /**
-     * The ID of the user who has been marked as absent
+     *
+     * @mandatory
+     *
+     * @description The unique system identifier of the employee who is absent.
+     *
+     * @example 1024
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 user_id = 11;
      */
     userId: bigint;
     /**
-     * The ID of the optional associated leave request
+     *
+     * @optional
+     *
+     * @description The ID of the Leave Request if this absence is linked to a formal approval. Set to 0 if not applicable.
+     *
+     * @example 552
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 leave_request_id = 12;
      */
     leaveRequestId: bigint;
     /**
-     * The UNIX timestamp from when the user is absent
+     *
+     * @mandatory
+     *
+     * @description Start of the absence period in UNIX Epoch Seconds.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 from_timestamp = 13;
      */
     fromTimestamp: bigint;
     /**
-     * The UNIX timestamp until when the user is absent
+     *
+     * @mandatory
+     *
+     * @description End of the absence period in UNIX Epoch Seconds.
+     *
+     * @example 1698307200
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 to_timestamp = 14;
      */
     toTimestamp: bigint;
     /**
-     * Stores the unit of material ID
+     *
+     * @mandatory
+     *
+     * @description Unit of Measure ID for the absence quantity (e.g., Days, Hours).
+     *
+     * @example 1
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 uom_id = 15;
      */
     uomId: bigint;
     /**
-     * Stores the quantity of absence (in cents)
+     *
+     * @mandatory
+     *
+     * @description The total quantity of absence expressed in **cents** (multiplied by 100).
+     *
+     * @example 1.5 days -> 150; 2.5 hours -> 250.
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 quantity = 16;
      */
     quantity: bigint;
     /**
-     * The description of the absence
+     *
+     * @optional
+     *
+     * @description Detailed description or notes regarding the nature of the absence.
+     *
+     * @example "Medical leave - Doctor's note pending"
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string description = 17;
      */
     description: string;
     /**
-     * The list of dynamic forms
+     *
+     * @optional
+     *
+     * @description A collection of dynamic form fields for organization-specific data.
      *
      * @generated from field: repeated Scailo.FormFieldDatumCreateRequest form_data = 30;
      */
@@ -178,75 +285,168 @@ export declare class AbsencesServiceCreateRequest extends Message<AbsencesServic
 }
 /**
  *
- * Describes the parameters necessary to update a record
+ * Request message for updating an existing Absence record.
+ * Only applicable for records in `DRAFT` or `REVISION` states.
+ * This message allows for modifying the naming, leave request, start and end timestamps and quantity
+ * of an established Action Code.
+ *
+ * **Note:** Only fields provided in the request will typically be updated.
+ * The unique system ID is required to locate the target record.
  *
  * @generated from message Scailo.AbsencesServiceUpdateRequest
  */
 export declare class AbsencesServiceUpdateRequest extends Message<AbsencesServiceUpdateRequest> {
     /**
-     * Stores any comment that the user might add during this operation
+     *
+     * @optional
+     *
+     * @description Audit log comment or justification for this specific update. Captured in the version history for administrative tracking.
+     *
+     * @example "Corrected the end date as per the medical certificate."
+     *
+     * @regex .*
+     *
+     * @format May contain any UTF-8 characters or be left empty.
      *
      * @generated from field: string user_comment = 1;
      */
     userComment: string;
     /**
-     * The ID of the record that needs to be updated
+     *
+     * @mandatory
+     *
+     * @description The unique system identifier of the Absence to be modified. Must be a value greater than `0`.
+     *
+     * @example 98765
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 id = 2;
      */
     id: bigint;
     /**
-     * Optional boolean value that stores if a notification needs to be sent to users about the update to the record. This is useful when a subsequent operation needs to be performed immediately (such as send to verification after updating the revision)
+     *
+     * @optional
+     *
+     * @description Flag to trigger system notifications to relevant users upon update. Set to true if subsequent workflows (like verification) depend on this change.
+     *
+     * @example true
      *
      * @generated from field: bool notify_users = 3;
      */
     notifyUsers: boolean;
     /**
-     * The associated vault folder ID
+     *
+     * @optional
+     *
+     * @description Updated vault folder ID for documentation storage.
+     *
+     * @example 15235
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
     vaultFolderId: bigint;
     /**
-     * The reference ID of the absence
+     *
+     * @mandatory
+     *
+     * @description Updated alphanumeric reference ID. Must contain at least 1 character.
+     *
+     * @example "ABS-2023-001-REV"
+     *
+     * @regex "[0-9A-Za-z ]+$"
+     *
+     * @format Alphanumeric characters and spaces only. No special symbols or punctuation allowed.
      *
      * @generated from field: string reference_id = 10;
      */
     referenceId: string;
     /**
-     * The ID of the optional associated leave request
+     *
+     * @optional
+     *
+     * @description Updated link to a Leave Request.
+     *
+     * @example 553
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 leave_request_id = 12;
      */
     leaveRequestId: bigint;
     /**
-     * The UNIX timestamp from when the user is absent
+     *
+     * @mandatory
+     *
+     * @description Updated start timestamp in UNIX Epoch Seconds.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 from_timestamp = 13;
      */
     fromTimestamp: bigint;
     /**
-     * The UNIX timestamp until when the user is absent
+     *
+     * @mandatory
+     *
+     * @description Updated end timestamp in UNIX Epoch Seconds.
+     *
+     * @example 1698393600
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 to_timestamp = 14;
      */
     toTimestamp: bigint;
     /**
-     * // Stores the unit of material ID
-     * uint64 uom_id = 15 [(buf.validate.field).uint64.gt = 0];
-     * Stores the quantity of absence (in cents)
+     *
+     * @mandatory
+     *
+     * @description Updated quantity in cents (x100).
+     *
+     * @example 200
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: uint64 quantity = 16;
      */
     quantity: bigint;
     /**
-     * The description of the absence
+     *
+     * @optional
+     *
+     * @description Updated textual description.
+     *
+     * @example "Confirmed medical leave."
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string description = 17;
      */
     description: string;
     /**
-     * The list of dynamic forms
+     *
+     * @optional
+     *
+     * @description Updated custom dynamic form data.
      *
      * @generated from field: repeated Scailo.FormFieldDatumCreateRequest form_data = 30;
      */
@@ -262,109 +462,150 @@ export declare class AbsencesServiceUpdateRequest extends Message<AbsencesServic
 }
 /**
  *
- * Describes the parameters that are part of a standard response
+ * Represents a full Absence within the system.
  *
  * @generated from message Scailo.Absence
  */
 export declare class Absence extends Message<Absence> {
     /**
-     * Stores a globally unique entity UUID. This will be set at the organization level
+     *
+     * @description The organization's globally unique identifier.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
      *
      * @generated from field: string entity_uuid = 1;
      */
     entityUuid: string;
     /**
-     * Stores the metadata of this absence
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata?: EmployeeMetadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata?: ApprovalMetadata;
     /**
-     * The status of this absence
+     *
+     * @description The current lifecycle status (e.g., DRAFT, VERIFIED, STANDING).
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 4;
      */
     status: STANDARD_LIFECYCLE_STATUS;
     /**
-     * Stores the logs of every operation performed on this absence
+     *
+     * @description Comprehensive audit trail of every operation performed on this record.
      *
      * @generated from field: repeated Scailo.LogbookLogConciseSLC logs = 5;
      */
     logs: LogbookLogConciseSLC[];
     /**
-     * The timestamp of when this absence was marked as completed
+     *
+     * @description UNIX timestamp of when the record transitioned to the COMPLETED state.
+     *
+     * @example 1698400000
      *
      * @generated from field: uint64 completed_on = 6;
      */
     completedOn: bigint;
     /**
-     * The associated vault folder ID
+     *
+     * @description Link to the document storage folder.
+     *
+     * @example 15234
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
     vaultFolderId: bigint;
     /**
-     * The reference_id of the absence
+     *
+     * @description The user-provided reference ID.
+     *
+     * @example "ABS-2023-001"
      *
      * @generated from field: string reference_id = 10;
      */
     referenceId: string;
     /**
-     * The unique reference number that has been automatically generated
+     *
+     * @description The system-generated immutable reference number.
+     *
+     * @example "ABS-2023-X9Z2"
      *
      * @generated from field: string final_ref_number = 11;
      */
     finalRefNumber: string;
     /**
-     * The ID of the user who has been marked as absent
+     *
+     * @description The ID of the employee associated with this record.
+     *
+     * @example 1024
      *
      * @generated from field: uint64 user_id = 12;
      */
     userId: bigint;
     /**
-     * The ID of the optional associated leave request
+     *
+     * @description The ID of the linked leave request, if any.
+     *
+     * @example 552
      *
      * @generated from field: uint64 leave_request_id = 13;
      */
     leaveRequestId: bigint;
     /**
-     * The UNIX timestamp from when the user is absent
+     *
+     * @description Start time of the absence (UNIX Epoch).
+     *
+     * @example 1698220800
      *
      * @generated from field: uint64 from_timestamp = 14;
      */
     fromTimestamp: bigint;
     /**
-     * The UNIX timestamp until when the user is absent
+     *
+     * @description End time of the absence (UNIX Epoch).
+     *
+     * @example 1698307200
      *
      * @generated from field: uint64 to_timestamp = 15;
      */
     toTimestamp: bigint;
     /**
-     * Stores the unit of material ID
+     *
+     * @description The unit of measure ID.
+     *
+     * @example 1
      *
      * @generated from field: uint64 uom_id = 16;
      */
     uomId: bigint;
     /**
-     * Stores the quantity of absence (in cents)
+     *
+     * @description Total quantity in cents (multiplied by 100).
+     *
+     * @example 150
      *
      * @generated from field: uint64 quantity = 17;
      */
     quantity: bigint;
     /**
-     * The description of the absence
+     *
+     * @description Descriptive notes for the absence.
+     *
+     * @example "Sick Leave"
      *
      * @generated from field: string description = 18;
      */
     description: string;
     /**
-     * The list of dynamic forms
+     *
+     * @description Collection of organization-specific dynamic data.
      *
      * @generated from field: repeated Scailo.FormFieldDatum form_data = 30;
      */
@@ -380,13 +621,13 @@ export declare class Absence extends Message<Absence> {
 }
 /**
  *
- * Describes the message consisting of the list of records
+ * Container message for a collection of Absence records.
  *
  * @generated from message Scailo.AbsencesList
  */
 export declare class AbsencesList extends Message<AbsencesList> {
     /**
-     * List of records
+     * @description An array of Absence records.
      *
      * @generated from field: repeated Scailo.Absence list = 1;
      */
@@ -402,43 +643,79 @@ export declare class AbsencesList extends Message<AbsencesList> {
 }
 /**
  *
- * Describes a pagination request to retrieve records
+ * Pagination request for retrieving slices of Absence records.
  *
  * @generated from message Scailo.AbsencesServicePaginationReq
  */
 export declare class AbsencesServicePaginationReq extends Message<AbsencesServicePaginationReq> {
     /**
-     * If true, then returns only active records. If false, then returns only inactive records
+     *
+     * @optional
+     *
+     * @description Filter by active status. If `true`, then returns only active records. If `false`, then returns only inactive records.
+     *
+     * @example ANY
      *
      * @generated from field: Scailo.BOOL_FILTER is_active = 1;
      */
     isActive: BOOL_FILTER;
     /**
-     * The number of records that need to be sent in the response
+     *
+     * @mandatory
+     *
+     * @description Number of records to return per page.
+     *
+     * @example 50
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @generated from field: int64 count = 2;
      */
     count: bigint;
     /**
-     * The number that need to be offset by before fetching the records
+     *
+     * @optional
+     *
+     * @description Number of records to skip (offset) for pagination.
+     *
+     * @example 0
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 offset = 3;
      */
     offset: bigint;
     /**
-     * The sort order that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description Sort direction.
+     *
+     * @example DESCENDING
      *
      * @generated from field: Scailo.SORT_ORDER sort_order = 4;
      */
     sortOrder: SORT_ORDER;
     /**
-     * The sort key that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description The specific field key to sort the results by.
      *
      * @generated from field: Scailo.ABSENCE_SORT_KEY sort_key = 5;
      */
     sortKey: ABSENCE_SORT_KEY;
     /**
-     * The status of this absence
+     *
+     * @optional
+     *
+     * @description Filter results by a specific lifecycle status.
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 6;
      */
@@ -454,31 +731,41 @@ export declare class AbsencesServicePaginationReq extends Message<AbsencesServic
 }
 /**
  *
- * Describes the response to a pagination request
+ * Response message for paginated queries, including total counts for UI elements.
  *
  * @generated from message Scailo.AbsencesServicePaginationResponse
  */
 export declare class AbsencesServicePaginationResponse extends Message<AbsencesServicePaginationResponse> {
     /**
-     * The number of records in this payload
+     *
+     * @description Number of records returned in the current response slice.
+     *
+     * @example 50
      *
      * @generated from field: uint64 count = 1;
      */
     count: bigint;
     /**
-     * The number that has been offset before fetching the records. This is the same value that has been sent as part of the pagination request
+     *
+     * @description The offset provided in the request.
+     *
+     * @example 0
      *
      * @generated from field: uint64 offset = 2;
      */
     offset: bigint;
     /**
-     * The total number of records that are available
+     *
+     * @description The total number of records matching the criteria.
+     *
+     * @example 1250
      *
      * @generated from field: uint64 total = 3;
      */
     total: bigint;
     /**
-     * The list of records
+     *
+     * @description The array of records for the current page.
      *
      * @generated from field: repeated Scailo.Absence payload = 4;
      */
@@ -494,181 +781,418 @@ export declare class AbsencesServicePaginationResponse extends Message<AbsencesS
 }
 /**
  *
- * Describes the base request payload of a filter search
+ * Advanced filter request for searching absences using multiple logical criteria.
  *
  * @generated from message Scailo.AbsencesServiceFilterReq
  */
 export declare class AbsencesServiceFilterReq extends Message<AbsencesServiceFilterReq> {
     /**
-     * If true, then returns only active records. If false, then returns only inactive records
+     *
+     * @optional
+     *
+     * @description Filter by active status. If `true`, then returns only active records. If `false`, then returns only inactive records.
+     *
+     * @example ANY
      *
      * @generated from field: Scailo.BOOL_FILTER is_active = 1;
      */
     isActive: BOOL_FILTER;
     /**
-     * The number of records that need to be sent in the response. Returns all records if it is set to -1
+     *
+     * @mandatory
+     *
+     * @description Number of records to fetch. **Critical:** Use `-1` to retrieve all records. A value of `0` will return no results. Default is `0`.
+     *
+     * @example 100
+     *
+     * @regex ^(?:-1|0|[1-9][0-9]*)$
+     *
+     * @format Must be -1 or any non-negative integer (>= -1).
      *
      * @generated from field: int64 count = 2;
      */
     count: bigint;
     /**
-     * The number that need to be offset by before fetching the records
+     *
+     * @optional
+     *
+     * @description Number of records to skip (offset) for pagination.
+     *
+     * @example 0
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 offset = 3;
      */
     offset: bigint;
     /**
-     * The sort order that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description Sort direction.
+     *
+     * @example DESCENDING
      *
      * @generated from field: Scailo.SORT_ORDER sort_order = 4;
      */
     sortOrder: SORT_ORDER;
     /**
-     * The sort key that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description The field used for sorting.
      *
      * @generated from field: Scailo.ABSENCE_SORT_KEY sort_key = 5;
      */
     sortKey: ABSENCE_SORT_KEY;
     /**
-     * The minimum timestamp that needs to be considered to filter by creation
+     *
+     * @optional
+     *
+     * @description Filter records created ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 creation_timestamp_start = 101;
      */
     creationTimestampStart: bigint;
     /**
-     * The maximum timestamp that needs to be considered to filter by creation
+     *
+     * @optional
+     *
+     * @description Filter records created ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 creation_timestamp_end = 102;
      */
     creationTimestampEnd: bigint;
     /**
-     * The minimum timestamp that needs to be considered to filter by modification
+     *
+     * @optional
+     *
+     * @description Filter records modified ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 modification_timestamp_start = 103;
      */
     modificationTimestampStart: bigint;
     /**
-     * The maximum timestamp that needs to be considered to filter by modification
+     *
+     * @optional
+     *
+     * @description Filter records modified ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 modification_timestamp_end = 104;
      */
     modificationTimestampEnd: bigint;
     /**
-     * The entity UUID that is to be used to filter records
+     *
+     * @optional
+     *
+     * @description Filter by the organization UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     *
+     * @regex ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+     *
+     * @format If provided, must be a valid v4 UUID in canonical hyphenated form.
      *
      * @generated from field: string entity_uuid = 8;
      */
     entityUuid: string;
     /**
-     * The status of this absence
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
     status: STANDARD_LIFECYCLE_STATUS;
     /**
-     * The start range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_start = 11;
      */
     approvedOnStart: bigint;
     /**
-     * The end range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_end = 12;
      */
     approvedOnEnd: bigint;
     /**
-     * The ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the specific user ID who approved the records.
+     *
+     * @example 501
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_by_user_id = 13;
      */
     approvedByUserId: bigint;
     /**
-     * The role ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the role ID of the approver.
+     *
+     * @example 5
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approver_role_id = 14;
      */
     approverRoleId: bigint;
     /**
-     * The start range of completed timestamp
+     *
+     * @optional
+     *
+     * @description Filter records completed ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 completed_on_start = 15;
      */
     completedOnStart: bigint;
     /**
-     * The end range of completed timestamp
+     *
+     * @optional
+     *
+     * @description Filter records completed ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 completed_on_end = 16;
      */
     completedOnEnd: bigint;
     /**
-     * The reference_id of the absence
+     *
+     * @optional
+     *
+     * @description Fuzzy match for the user-defined reference ID.
+     *
+     * @example "ABS-2023-001"
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string reference_id = 20;
      */
     referenceId: string;
     /**
-     * The unique reference number that has been automatically generated
+     *
+     * @optional
+     *
+     * @description Fuzzy match for the system-generated ref number.
+     *
+     * @example "ABS-2023-X9Z2"
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string final_ref_number = 21;
      */
     finalRefNumber: string;
     /**
-     * The ID of the user who has been marked as absent
+     *
+     * @optional
+     *
+     * @description Filter by specific employee ID.
+     *
+     * @example 1024
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 user_id = 22;
      */
     userId: bigint;
     /**
-     * The ID of the optionally associated leave request
+     *
+     * @optional
+     *
+     * @description Filter by linked leave request ID.
+     *
+     * @example 552
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 leave_request_id = 23;
      */
     leaveRequestId: bigint;
     /**
-     * The start range of "from timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences starting ON or AFTER this timestamp.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 from_timestamp_start = 24;
      */
     fromTimestampStart: bigint;
     /**
-     * The end range of "from timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences starting ON or BEFORE this timestamp.
+     *
+     * @example 1698307200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 from_timestamp_end = 25;
      */
     fromTimestampEnd: bigint;
     /**
-     * The start range of "to timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences ending ON or AFTER this timestamp.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 to_timestamp_start = 26;
      */
     toTimestampStart: bigint;
     /**
-     * The end range of "to timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences ending ON or BEFORE this timestamp.
+     *
+     * @example 1698307200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 to_timestamp_end = 27;
      */
     toTimestampEnd: bigint;
     /**
-     * Stores the unit of material ID
+     *
+     * @optional
+     *
+     * @description Filter by Unit of Measure (e.g., Days, Hours).
+     *
+     * @example 1
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 uom_id = 28;
      */
     uomId: bigint;
     /**
-     * The min quantity of absence (in cents)
+     *
+     * @optional
+     *
+     * @description Minimum quantity filter (expressed in cents).
+     *
+     * @example 100
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 quantity_min = 29;
      */
     quantityMin: bigint;
     /**
-     * The max quantity of absence (in cents)
+     *
+     * @optional
+     *
+     * @description Maximum quantity filter (expressed in cents).
+     *
+     * @example 500
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 quantity_max = 30;
      */
     quantityMax: bigint;
     /**
-     * The list of form data filters
+     *
+     * @optional
+     *
+     * @description Filter based on dynamic form field values.
      *
      * @generated from field: repeated Scailo.FormFieldDatumFilterRequest form_data = 500;
      */
@@ -684,157 +1208,368 @@ export declare class AbsencesServiceFilterReq extends Message<AbsencesServiceFil
 }
 /**
  *
- * Describes the base request payload of a count search
+ * Request message to count records matching specific criteria.
  *
  * @generated from message Scailo.AbsencesServiceCountReq
  */
 export declare class AbsencesServiceCountReq extends Message<AbsencesServiceCountReq> {
     /**
-     * If true, then returns only active records. If false, then returns only inactive records
+     *
+     * @optional
+     *
+     * @description Filter by active status. If `true`, then returns only active records. If `false`, then returns only inactive records.
+     *
+     * @example ANY
      *
      * @generated from field: Scailo.BOOL_FILTER is_active = 1;
      */
     isActive: BOOL_FILTER;
     /**
-     * The minimum timestamp that needs to be considered to filter by creation
+     *
+     * @optional
+     *
+     * @description Filter records created ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 creation_timestamp_start = 101;
      */
     creationTimestampStart: bigint;
     /**
-     * The maximum timestamp that needs to be considered to filter by creation
+     *
+     * @optional
+     *
+     * @description Filter records created ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 creation_timestamp_end = 102;
      */
     creationTimestampEnd: bigint;
     /**
-     * The minimum timestamp that needs to be considered to filter by modification
+     *
+     * @optional
+     *
+     * @description Filter records modified ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 modification_timestamp_start = 103;
      */
     modificationTimestampStart: bigint;
     /**
-     * The maximum timestamp that needs to be considered to filter by modification
+     *
+     * @optional
+     *
+     * @description Filter records modified ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 modification_timestamp_end = 104;
      */
     modificationTimestampEnd: bigint;
     /**
-     * The entity UUID that is to be used to filter records
+     *
+     * @optional
+     *
+     * @description Filter by the organization UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     *
+     * @regex ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+     *
+     * @format If provided, must be a valid v4 UUID in canonical hyphenated form.
      *
      * @generated from field: string entity_uuid = 8;
      */
     entityUuid: string;
     /**
-     * The status of this absence
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status.
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
     status: STANDARD_LIFECYCLE_STATUS;
     /**
-     * The start range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_start = 11;
      */
     approvedOnStart: bigint;
     /**
-     * The end range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_end = 12;
      */
     approvedOnEnd: bigint;
     /**
-     * The ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by specific user who approved the records.
+     *
+     * @example 501
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_by_user_id = 13;
      */
     approvedByUserId: bigint;
     /**
-     * The role ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the role used during approval.
+     *
+     * @example 5
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approver_role_id = 14;
      */
     approverRoleId: bigint;
     /**
-     * The start range of completed timestamp
+     *
+     * @optional
+     *
+     * @description Filter records completed ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 completed_on_start = 15;
      */
     completedOnStart: bigint;
     /**
-     * The end range of completed timestamp
+     *
+     * @optional
+     *
+     * @description Filter records completed ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 completed_on_end = 16;
      */
     completedOnEnd: bigint;
     /**
-     * The reference_id of the absence
+     *
+     * @optional
+     *
+     * @description Fuzzy match for the user-defined reference ID.
+     *
+     * @example "ABS-2023-001"
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string reference_id = 20;
      */
     referenceId: string;
     /**
-     * The unique reference number that has been automatically generated
+     *
+     * @optional
+     *
+     * @description Fuzzy match for the system-generated ref number.
+     *
+     * @example "ABS-2023-X9Z2"
+     *
+     * @regex [0-9A-Za-z ]*$
+     *
+     * @format: Alphanumeric characters and spaces only. Can be left empty.
      *
      * @generated from field: string final_ref_number = 21;
      */
     finalRefNumber: string;
     /**
-     * The ID of the user who has been marked as absent
+     *
+     * @optional
+     *
+     * @description Filter by specific employee ID.
+     *
+     * @example 1024
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 user_id = 22;
      */
     userId: bigint;
     /**
-     * The ID of the optionally associated leave request
+     *
+     * @optional
+     *
+     * @description Filter by linked leave request ID.
+     *
+     * @example 552
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 leave_request_id = 23;
      */
     leaveRequestId: bigint;
     /**
-     * The start range of "from timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences starting ON or AFTER this timestamp.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 from_timestamp_start = 24;
      */
     fromTimestampStart: bigint;
     /**
-     * The end range of "from timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences starting ON or BEFORE this timestamp.
+     *
+     * @example 1698307200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 from_timestamp_end = 25;
      */
     fromTimestampEnd: bigint;
     /**
-     * The start range of "to timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences ending ON or AFTER this timestamp.
+     *
+     * @example 1698220800
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 to_timestamp_start = 26;
      */
     toTimestampStart: bigint;
     /**
-     * The end range of "to timestamp"
+     *
+     * @optional
+     *
+     * @description Filter absences ending ON or BEFORE this timestamp.
+     *
+     * @example 1698307200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 to_timestamp_end = 27;
      */
     toTimestampEnd: bigint;
     /**
-     * Stores the unit of material ID
+     *
+     * @optional
+     *
+     * @description Filter by specific Unit of Measure.
+     *
+     * @example 1
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 uom_id = 28;
      */
     uomId: bigint;
     /**
-     * The min quantity of absence (in cents)
+     *
+     * @optional
+     *
+     * @description Minimum quantity filter (in cents).
+     *
+     * @example 100
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 quantity_min = 29;
      */
     quantityMin: bigint;
     /**
-     * The max quantity of absence (in cents)
+     *
+     * @optional
+     *
+     * @description Maximum quantity filter (in cents).
+     *
+     * @example 500
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 quantity_max = 30;
      */
     quantityMax: bigint;
     /**
-     * The list of form data filters
+     *
+     * @optional
+     *
+     * @description Custom field filters.
      *
      * @generated from field: repeated Scailo.FormFieldDatumFilterRequest form_data = 500;
      */
@@ -850,61 +1585,124 @@ export declare class AbsencesServiceCountReq extends Message<AbsencesServiceCoun
 }
 /**
  *
- * Describes the request payload for performing a generic search operation on records
+ * Generic search request for finding absences using a free-text search key.
  *
  * @generated from message Scailo.AbsencesServiceSearchAllReq
  */
 export declare class AbsencesServiceSearchAllReq extends Message<AbsencesServiceSearchAllReq> {
     /**
-     * If true, then returns only active records. If false, then returns only inactive records
+     *
+     * @optional
+     *
+     * @description Filter by active status. If `true`, then returns only active records. If `false`, then returns only inactive records.
+     *
+     * @example ANY
      *
      * @generated from field: Scailo.BOOL_FILTER is_active = 1;
      */
     isActive: BOOL_FILTER;
     /**
-     * The number of records that need to be sent in the response. Returns all records if it is set to -1
+     *
+     * @mandatory
+     *
+     * @description Number of records to fetch. **Critical:** Use `-1` to retrieve all records. A value of `0` will return no results. Default is `0`.
+     *
+     * @example 100
+     *
+     * @regex ^(?:-1|0|[1-9][0-9]*)$
+     *
+     * @format Must be -1 or any non-negative integer (>= -1).
      *
      * @generated from field: int64 count = 2;
      */
     count: bigint;
     /**
-     * The number that need to be offset by before fetching the records
+     *
+     * @optional
+     *
+     * @description Number of records to skip (offset) for pagination.
+     *
+     * @example 0
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 offset = 3;
      */
     offset: bigint;
     /**
-     * The sort order that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description Sort direction.
+     *
+     * @example DESCENDING
      *
      * @generated from field: Scailo.SORT_ORDER sort_order = 4;
      */
     sortOrder: SORT_ORDER;
     /**
-     * The sort key that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description The field used for sorting.
      *
      * @generated from field: Scailo.ABSENCE_SORT_KEY sort_key = 5;
      */
     sortKey: ABSENCE_SORT_KEY;
     /**
-     * The entity UUID that is to be used to filter records
+     *
+     * @optional
+     *
+     * @description Filter by the organization UUID.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
+     *
+     * @regex ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+     *
+     * @format If provided, must be a valid v4 UUID in canonical hyphenated form.
      *
      * @generated from field: string entity_uuid = 6;
      */
     entityUuid: string;
     /**
-     * Limit the search space to the given status
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
     status: STANDARD_LIFECYCLE_STATUS;
     /**
-     * Describes the key with which the search operation needs to be performed
+     *
+     * @mandatory
+     *
+     * @description The search string to match against reference IDs.
+     *
+     * @example "Medical 2023"
+     *
+     * @regex .*
+     *
+     * @format: May contain any UTF-8 characters.
      *
      * @generated from field: string search_key = 11;
      */
     searchKey: string;
     /**
-     * The ID of the user who has been marked as absent
+     *
+     * @optional
+     *
+     * @description Limit search results to a specific employee ID.
+     *
+     * @example 1024
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 user_id = 22;
      */