@kernelminds/scailo-sdk 0.1.27 → 0.1.29

package/lib/esm/src/actions_codes.scailo_connect.js

@@ -10,7 +10,10 @@ const base_scailo_pb_js_1 = require("./base.scailo_pb.js");
 const protobuf_1 = require("@bufbuild/protobuf");
 /**
  *
- * Describes the common methods applicable on each action code
+ * The ActionsCodesService manages the full lifecycle of action code records.
+ * It provides standard CRUD operations alongside a robust state machine for
+ * classification of specific activities, events, or status changes
+ * within the system, often organized in a hierarchical (tree) structure.
  *
  * @generated from service Scailo.ActionsCodesService
  */
@@ -18,7 +21,19 @@ exports.ActionsCodesService = {
     typeName: "Scailo.ActionsCodesService",
     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., empty name or code).
+         * - `ALREADY_EXISTS`: If the `code` is already taken.
          *
          * @generated from rpc Scailo.ActionsCodesService.Create
          */
@@ -29,7 +44,19 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.Draft
          */
@@ -40,7 +67,13 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.DraftUpdate
          */
@@ -51,7 +84,15 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.SendForVerification
          */
@@ -62,7 +103,12 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.Verify
          */
@@ -73,7 +119,12 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Approve
+         * Officially approves the record.
+         *
+         * **Status Transition:** -> `STANDING`
+         *
+         * **Side Effects:**
+         * - Records the approver's identity and timestamp.
          *
          * @generated from rpc Scailo.ActionsCodesService.Approve
          */
@@ -84,7 +135,14 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Send For Revision
+         * Sends the record back to the creator for corrections.
+         *
+         * Use this if details are incorrect or missing.
+         *
+         * **Status Transition:** -> `REVISION`
+         *
+         * **Side Effects:**
+         * - Notifies the record creator that changes are required.
          *
          * @generated from rpc Scailo.ActionsCodesService.SendForRevision
          */
@@ -95,7 +153,10 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.RevisionUpdate
          */
@@ -106,7 +167,9 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Halt
+         * Temporarily halts processing of the record.
+         *
+         * **Status Transition:** -> `HALTED`
          *
          * @generated from rpc Scailo.ActionsCodesService.Halt
          */
@@ -117,7 +180,11 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Discard
+         * Permanently cancels the record.
+         *
+         * Records in this state are typically ignored.
+         *
+         * **Status Transition:** -> `DISCARDED`
          *
          * @generated from rpc Scailo.ActionsCodesService.Discard
          */
@@ -128,7 +195,10 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.Restore
          */
@@ -139,10 +209,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Add comment
-         *
-         * Send Email
-         * rpc SendEmail (Identifier) returns (IdentifierResponse);
+         * Adds an audit comment to the record's history without changing its current lifecycle status.
          *
          * @generated from rpc Scailo.ActionsCodesService.CommentAdd
          */
@@ -153,7 +220,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.ViewByID
          */
@@ -164,7 +231,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.ViewByUUID
          */
@@ -175,7 +242,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.ViewEssentialByID
          */
@@ -186,7 +253,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.ViewEssentialByUUID
          */
@@ -197,7 +264,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.ViewFromIDs
          */
@@ -208,7 +275,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.ActionsCodesService.ViewAll
          */
@@ -219,7 +286,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all with the given entity UUID
+         * Returns all records belonging to a specific organization/entity UUID.
          *
          * @generated from rpc Scailo.ActionsCodesService.ViewAllForEntityUUID
          */
@@ -230,7 +297,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View with pagination
+         * Retrieves a paginated list of records based on status, sort keys, and offsets.
          *
          * @generated from rpc Scailo.ActionsCodesService.ViewWithPagination
          */
@@ -241,7 +308,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.SearchAll
          */
@@ -252,7 +319,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.Filter
          */
@@ -263,7 +330,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Count in status
+         * Returns the total number of records currently in a specific lifecycle status.
          *
          * @generated from rpc Scailo.ActionsCodesService.CountInStatus
          */
@@ -274,7 +341,7 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.ActionsCodesService.Count
          */
@@ -285,8 +352,9 @@ exports.ActionsCodesService = {
             kind: protobuf_1.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.
+         * The same file could also be used as a template for uploading records.
          *
          * @generated from rpc Scailo.ActionsCodesService.DownloadAsCSV
          */
@@ -297,7 +365,13 @@ exports.ActionsCodesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Import records using a CSV file (duplicate codes will be skipped)
+         * Bulk imports records from a provided CSV file.
+         * Behavior:
+         * - Deduplication: Skips entries where the `code` already exists in the system.
+         * - Atomicity: This is an "all-or-nothing" operation; if any part of the
+         *   import fails, no changes are committed.
+         * - Idempotency: Multiple calls with the same CSV result in the same state.
+         * Returns a list of UUIDs for all successfully processed or existing records.
          *
          * @generated from rpc Scailo.ActionsCodesService.ImportFromCSV
          */