@kernelminds/scailo-sdk 0.1.27 → 0.1.29

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

@@ -4,7 +4,9 @@ import { MethodKind } from "@bufbuild/protobuf";
 import { MagicLink, MagicLinksServiceCreateRequestForSpecificResource } from "./magic_links.scailo_pb.js";
 /**
  *
- * Describes the common methods applicable on each absence
+ * The AbsencesService manages the full lifecycle of employee absence records.
+ * It provides standard CRUD operations alongside a robust state machine for
+ * HR verification, manager approval, and completion.
  *
  * @generated from service Scailo.AbsencesService
  */
@@ -12,7 +14,19 @@ export declare const AbsencesService: {
     readonly typeName: "Scailo.AbsencesService";
     readonly methods: {
         /**
-         * Create and send for verification
+         * Creates a new record and immediately moves it to the verification workflow.
+         *
+         * This method validates all required fields.
+         * The record is created with a `STANDARD_LIFECYCLE_STATUS.PREVERIFY` status.
+         *
+         * **Side Effects:**
+         * - Generates a unique system UUID.
+         * - Records an audit log for the "Create" action.
+         * - May trigger automated verification workflows.
+         *
+         * **Errors:**
+         * - `INVALID_ARGUMENT`: If validation rules fail (e.g., negative quantity, invalid timestamps).
+         * - `ALREADY_EXISTS`: If the `reference_id` or `final_ref_number` is already taken.
          *
          * @generated from rpc Scailo.AbsencesService.Create
          */
@@ -23,7 +37,19 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Create and save as draft
+         * Saves a new record as a draft without triggering side effects.
+         *
+         * Use this method when you have incomplete information but wish to persist
+         * the record for later completion. The record remains in a `DRAFT` state.
+         *
+         * **Note:** Some strict validation rules may be relaxed in the backend for drafts compared to `Create`.
+         *
+         * **Side Effects:**
+         * - Generates a unique system UUID.
+         * - Records an audit log for the "Draft" action.
+         *
+         * **Errors:**
+         * - `INVALID_ARGUMENT`: If critical system fields are missing.
          *
          * @generated from rpc Scailo.AbsencesService.Draft
          */
@@ -34,7 +60,13 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Update draft
+         * Updates an existing record that is currently in `DRAFT` status.
+         *
+         * This method allows modification of all primary attributes while the record is not yet verified.
+         *
+         * **Errors:**
+         * - `FAILED_PRECONDITION`: If the record is not in a `DRAFT` state.
+         * - `NOT_FOUND`: If the provided ID does not exist.
          *
          * @generated from rpc Scailo.AbsencesService.DraftUpdate
          */
@@ -45,7 +77,15 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Send for verification
+         * Submits a record in `DRAFT` or `REVISION` status for verification.
+         *
+         * This triggers the first stage of the approval workflow.
+         *
+         * **Status Transition:** -> `PREVERIFY`
+         *
+         * **Side Effects:**
+         * - Notifies designated verifiers or approvers.
+         * - Locks certain fields from being updated without returning to `REVISION`.
          *
          * @generated from rpc Scailo.AbsencesService.SendForVerification
          */
@@ -56,7 +96,12 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Verify
+         * Marks a record as verified, signaling that it is ready for final approval.
+         *
+         * **Status Transition:** -> `VERIFIED`
+         *
+         * **Side Effects:**
+         * - Records the verifying user and timestamp in the audit logs.
          *
          * @generated from rpc Scailo.AbsencesService.Verify
          */
@@ -67,7 +112,13 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Approve
+         * Officially approves the record.
+         *
+         * **Status Transition:** -> `STANDING`
+         *
+         * **Side Effects:**
+         * - Finalizes the `final_ref_number`.
+         * - Records the approver's identity and timestamp.
          *
          * @generated from rpc Scailo.AbsencesService.Approve
          */
@@ -78,7 +129,14 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Send For Revision
+         * Sends the record back to the creator for corrections.
+         *
+         * Use this if details are incorrect or supporting documents (in the vault) are missing.
+         *
+         * **Status Transition:** -> `REVISION`
+         *
+         * **Side Effects:**
+         * - Notifies the record creator that changes are required.
          *
          * @generated from rpc Scailo.AbsencesService.SendForRevision
          */
@@ -89,7 +147,10 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Update revision
+         * Updates a record that has been sent back for `REVISION`.
+         *
+         * **Side Effects:**
+         * - Re-validates the updated fields.
          *
          * @generated from rpc Scailo.AbsencesService.RevisionUpdate
          */
@@ -100,7 +161,9 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Halt
+         * Temporarily halts processing of the record.
+         *
+         * **Status Transition:** -> `HALTED`
          *
          * @generated from rpc Scailo.AbsencesService.Halt
          */
@@ -111,7 +174,11 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Discard
+         * Permanently cancels the record.
+         *
+         * Records in this state are typically ignored.
+         *
+         * **Status Transition:** -> `DISCARDED`
          *
          * @generated from rpc Scailo.AbsencesService.Discard
          */
@@ -122,7 +189,10 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Restore
+         * Restores a previously `DISCARDED` or `HALTED` record.
+         *
+         * **Side Effects:**
+         * - Moves the record back to `PREVERIFY` and sends for verification.
          *
          * @generated from rpc Scailo.AbsencesService.Restore
          */
@@ -133,7 +203,12 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Complete
+         * Marks the record as finalized and fully processed.
+         *
+         * **Status Transition:** -> `COMPLETED`
+         *
+         * **Side Effects:**
+         * - Locks the record from further modification.
          *
          * @generated from rpc Scailo.AbsencesService.Complete
          */
@@ -144,7 +219,9 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Repeat
+         * Creates a new record based on an existing one (cloning).
+         *
+         * This is useful for repeating records or correcting finalized records by starting fresh.
          *
          * @generated from rpc Scailo.AbsencesService.Repeat
          */
@@ -155,7 +232,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Add comment
+         * Adds an audit comment to the record's history without changing its current lifecycle status.
          *
          * @generated from rpc Scailo.AbsencesService.CommentAdd
          */
@@ -166,9 +243,9 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Send Email
-         * rpc SendEmail (Identifier) returns (IdentifierResponse);
-         * Create a magic link
+         * Generates a magic link for temporary, authenticated access to the resource.
+         *
+         * This enables non-system users (or users without active sessions) to view specific details.
          *
          * @generated from rpc Scailo.AbsencesService.CreateMagicLink
          */
@@ -179,7 +256,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View by ID
+         * Retrieves a single record by its internal numeric ID. This operation is optimized for high-performance internal system logic and backend-to-backend communication
          *
          * @generated from rpc Scailo.AbsencesService.ViewByID
          */
@@ -190,7 +267,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View by UUID
+         * Retrieves a single record by its globally unique UUID. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.
          *
          * @generated from rpc Scailo.AbsencesService.ViewByUUID
          */
@@ -201,7 +278,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View only essential components by ID (without logs)
+         * Retrieves a record by ID excluding high-volume fields like logs for performance. This operation is optimized for high-performance internal system logic and backend-to-backend communication
          *
          * @generated from rpc Scailo.AbsencesService.ViewEssentialByID
          */
@@ -212,7 +289,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View only essential components (without logs) that matches the given UUID
+         * Retrieves a record by UUID excluding high-volume fields like logs. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.
          *
          * @generated from rpc Scailo.AbsencesService.ViewEssentialByUUID
          */
@@ -223,7 +300,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View all records with the given IDs
+         * Retrieves a list of records matching the provided array of internal IDs.
          *
          * @generated from rpc Scailo.AbsencesService.ViewFromIDs
          */
@@ -234,7 +311,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.AbsencesService.ViewAll
          */
@@ -245,7 +322,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View all with the given entity UUID
+         * Returns all records belonging to a specific organization/entity UUID.
          *
          * @generated from rpc Scailo.AbsencesService.ViewAllForEntityUUID
          */
@@ -256,7 +333,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View with pagination
+         * Retrieves a paginated list of records based on status, sort keys, and offsets.
          *
          * @generated from rpc Scailo.AbsencesService.ViewWithPagination
          */
@@ -267,7 +344,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View all that match the given search key
+         * Performs a free-text search across records using a search key.
          *
          * @generated from rpc Scailo.AbsencesService.SearchAll
          */
@@ -278,7 +355,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * View all that match the given filter criteria
+         * Performs a high-granularity search based on multiple specific field filters.
          *
          * @generated from rpc Scailo.AbsencesService.Filter
          */
@@ -289,7 +366,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Count in status
+         * Returns the total number of records currently in a specific lifecycle status.
          *
          * @generated from rpc Scailo.AbsencesService.CountInStatus
          */
@@ -300,7 +377,7 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * Count all that match the given criteria
+         * Returns the total count of records matching the given complex filter criteria.
          *
          * @generated from rpc Scailo.AbsencesService.Count
          */
@@ -311,8 +388,8 @@ export declare const AbsencesService: {
             readonly kind: MethodKind.Unary;
         };
         /**
-         * CSV operations
-         * Download the CSV file that consists of the list of records according to the given filter request. The same file could also be used as a template for uploading records
+         * Generates and returns a CSV file containing records matching the filter criteria.
+         * Ideal for generating monthly reports or data backups.
          *
          * @generated from rpc Scailo.AbsencesService.DownloadAsCSV
          */

package/lib/cjs/types/src/absences.scailo_connect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"absences.scailo_connect.d.ts","sourceRoot":"","sources":["../../../../src/absences.scailo_connect.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAC7Q,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,aAAa,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,cAAc,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACzM,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,iDAAiD,EAAE,MAAM,4BAA4B,CAAC;AAE1G;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;QAGxB;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;;;WAMG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;;WAKG;;;;;;;;CAQG,CAAC"}
+{"version":3,"file":"absences.scailo_connect.d.ts","sourceRoot":"","sources":["../../../../src/absences.scailo_connect.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAC7Q,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,aAAa,EAAE,UAAU,EAAE,kBAAkB,EAAE,eAAe,EAAE,cAAc,EAAE,6BAA6B,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACzM,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,iDAAiD,EAAE,MAAM,4BAA4B,CAAC;AAE1G;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe;;;QAGxB;;;;;;;;;;;;;;;;WAgBG;;;;;;;QAOH;;;;;;;;;;;;;;;;WAgBG;;;;;;;QAOH;;;;;;;;;;WAUG;;;;;;;QAOH;;;;;;;;;;;;WAYG;;;;;;;QAOH;;;;;;;;;WASG;;;;;;;QAOH;;;;;;;;;;WAUG;;;;;;;QAOH;;;;;;;;;;;WAWG;;;;;;;QAOH;;;;;;;WAOG;;;;;;;QAOH;;;;;;WAMG;;;;;;;QAOH;;;;;;;;WAQG;;;;;;;QAOH;;;;;;;WAOG;;;;;;;QAOH;;;;;;;;;WASG;;;;;;;QAOH;;;;;;WAMG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;;;WAMG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;WAIG;;;;;;;QAOH;;;;;WAKG;;;;;;;;CAQG,CAAC"}