@kernelminds/scailo-sdk 0.1.28 → 0.1.30

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

@@ -31,7 +31,19 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.Draft
          */
@@ -42,7 +54,13 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.DraftUpdate
          */
@@ -53,7 +71,15 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.SendForVerification
          */
@@ -64,7 +90,12 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.Verify
          */
@@ -75,7 +106,13 @@ exports.WorkOrdersService = {
             kind: protobuf_1.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.WorkOrdersService.Approve
          */
@@ -86,7 +123,14 @@ exports.WorkOrdersService = {
             kind: protobuf_1.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.WorkOrdersService.SendForRevision
          */
@@ -97,7 +141,10 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.RevisionUpdate
          */
@@ -108,7 +155,9 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Halt
+         * Temporarily halts processing of the record.
+         *
+         * **Status Transition:** -> `HALTED`
          *
          * @generated from rpc Scailo.WorkOrdersService.Halt
          */
@@ -119,7 +168,11 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Discard
+         * Permanently cancels the record.
+         *
+         * Records in this state are typically ignored.
+         *
+         * **Status Transition:** -> `DISCARDED`
          *
          * @generated from rpc Scailo.WorkOrdersService.Discard
          */
@@ -130,7 +183,10 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.Restore
          */
@@ -141,7 +197,12 @@ exports.WorkOrdersService = {
             kind: protobuf_1.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.WorkOrdersService.Complete
          */
@@ -174,7 +235,7 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Add comment
+         * Adds an audit comment to the record's history without changing its current lifecycle status.
          *
          * @generated from rpc Scailo.WorkOrdersService.CommentAdd
          */
@@ -196,7 +257,9 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * 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.WorkOrdersService.CreateMagicLink
          */
@@ -406,7 +469,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewByID
          */
@@ -417,7 +480,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewByUUID
          */
@@ -439,7 +502,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewEssentialByID
          */
@@ -450,7 +513,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewEssentialByUUID
          */
@@ -461,7 +524,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewFromIDs
          */
@@ -483,7 +546,7 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.WorkOrdersService.ViewAll
          */
@@ -494,7 +557,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewAllForEntityUUID
          */
@@ -505,7 +568,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.ViewWithPagination
          */
@@ -604,7 +667,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.SearchAll
          */
@@ -615,7 +678,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.Filter
          */
@@ -626,7 +689,7 @@ exports.WorkOrdersService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Count in status
+         * Returns the total number of records currently in a specific lifecycle status.
          *
          * @generated from rpc Scailo.WorkOrdersService.CountInStatus
          */
@@ -637,7 +700,7 @@ exports.WorkOrdersService = {
             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.WorkOrdersService.Count
          */