@kernelminds/scailo-sdk 0.1.28 → 0.1.30

package/lib/esm/src/inventory.scailo_pb.js

@@ -208,7 +208,10 @@ protobuf_1.proto3.util.setEnumType(INVENTORY_NODE_ORIGIN_TYPE, "Scailo.INVENTORY
  */
 class GenericInventory extends protobuf_1.Message {
     /**
-     * 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;
      */
@@ -483,7 +486,10 @@ exports.GenericInventoryList = GenericInventoryList;
  */
 class InventoryCodeMap extends protobuf_1.Message {
     /**
-     * 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;
      */
@@ -761,43 +767,92 @@ exports.ReturnableInventorySearchReq = ReturnableInventorySearchReq;
  */
 class SearchReturnableInventoryReq extends protobuf_1.Message {
     /**
-     * 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 = base_scailo_pb_js_1.BOOL_FILTER.BOOL_FILTER_ANY_UNSPECIFIED;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = base_scailo_pb_js_1.SORT_ORDER.ASCENDING_UNSPECIFIED;
     /**
-     * The sort key that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description The field used for sorting.
      *
      * @generated from field: Scailo.INVENTORY_SORT_KEY sort_key = 5;
      */
     sortKey = base_scailo_pb_js_1.INVENTORY_SORT_KEY.INVENTORY_SORT_KEY_ID_UNSPECIFIED;
     /**
-     * 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 = "";
     /**
-     * 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;
      */
@@ -952,61 +1007,137 @@ exports.SearchReturnableInventoryForIdentifierUUID = SearchReturnableInventoryFo
  */
 class FilterReturnableInventoryReq extends protobuf_1.Message {
     /**
-     * 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 = base_scailo_pb_js_1.BOOL_FILTER.BOOL_FILTER_ANY_UNSPECIFIED;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = base_scailo_pb_js_1.SORT_ORDER.ASCENDING_UNSPECIFIED;
     /**
-     * The sort key that is to be used to fetch the pagination response
+     *
+     * @optional
+     *
+     * @description The field used for sorting.
      *
      * @generated from field: Scailo.INVENTORY_SORT_KEY sort_key = 5;
      */
     sortKey = base_scailo_pb_js_1.INVENTORY_SORT_KEY.INVENTORY_SORT_KEY_ID_UNSPECIFIED;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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 = protobuf_1.protoInt64.zero;
     /**
-     * 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;
      */

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

@@ -31,7 +31,19 @@ exports.InwardJobsService = {
             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.InwardJobsService.Draft
          */
@@ -42,7 +54,13 @@ exports.InwardJobsService = {
             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.InwardJobsService.DraftUpdate
          */
@@ -53,7 +71,15 @@ exports.InwardJobsService = {
             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.InwardJobsService.SendForVerification
          */
@@ -64,7 +90,12 @@ exports.InwardJobsService = {
             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.InwardJobsService.Verify
          */
@@ -75,7 +106,13 @@ exports.InwardJobsService = {
             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.InwardJobsService.Approve
          */
@@ -86,7 +123,14 @@ exports.InwardJobsService = {
             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.InwardJobsService.SendForRevision
          */
@@ -97,7 +141,10 @@ exports.InwardJobsService = {
             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.InwardJobsService.RevisionUpdate
          */
@@ -108,7 +155,9 @@ exports.InwardJobsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Halt
+         * Temporarily halts processing of the record.
+         *
+         * **Status Transition:** -> `HALTED`
          *
          * @generated from rpc Scailo.InwardJobsService.Halt
          */
@@ -119,7 +168,11 @@ exports.InwardJobsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Discard
+         * Permanently cancels the record.
+         *
+         * Records in this state are typically ignored.
+         *
+         * **Status Transition:** -> `DISCARDED`
          *
          * @generated from rpc Scailo.InwardJobsService.Discard
          */
@@ -130,7 +183,10 @@ exports.InwardJobsService = {
             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.InwardJobsService.Restore
          */
@@ -141,7 +197,12 @@ exports.InwardJobsService = {
             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.InwardJobsService.Complete
          */
@@ -174,7 +235,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.CommentAdd
          */
@@ -207,7 +268,9 @@ exports.InwardJobsService = {
             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.InwardJobsService.CreateMagicLink
          */
@@ -636,7 +699,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewByID
          */
@@ -647,7 +710,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewByUUID
          */
@@ -658,7 +721,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewEssentialByID
          */
@@ -669,7 +732,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewEssentialByUUID
          */
@@ -680,7 +743,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewFromIDs
          */
@@ -702,7 +765,7 @@ exports.InwardJobsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.InwardJobsService.ViewAll
          */
@@ -713,7 +776,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewAllForEntityUUID
          */
@@ -724,7 +787,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.ViewWithPagination
          */
@@ -856,7 +919,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.SearchAll
          */
@@ -867,7 +930,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.Filter
          */
@@ -878,7 +941,7 @@ exports.InwardJobsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Count in status
+         * Returns the total number of records currently in a specific lifecycle status.
          *
          * @generated from rpc Scailo.InwardJobsService.CountInStatus
          */
@@ -889,7 +952,7 @@ exports.InwardJobsService = {
             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.InwardJobsService.Count
          */