@kernelminds/scailo-sdk 0.1.27 → 0.1.29

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

@@ -107,7 +107,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.CommentAdd
          */
@@ -129,7 +129,9 @@ exports.QCSamplesService = {
             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.QCSamplesService.CreateMagicLink
          */
@@ -229,7 +231,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewByID
          */
@@ -240,7 +242,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewByUUID
          */
@@ -251,7 +253,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewEssentialByID
          */
@@ -262,7 +264,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewEssentialByUUID
          */
@@ -273,7 +275,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewFromIDs
          */
@@ -295,7 +297,7 @@ exports.QCSamplesService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.QCSamplesService.ViewAll
          */
@@ -306,7 +308,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewAllForEntityUUID
          */
@@ -317,7 +319,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.ViewWithPagination
          */
@@ -350,7 +352,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.SearchAll
          */
@@ -361,7 +363,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.Filter
          */
@@ -372,7 +374,7 @@ exports.QCSamplesService = {
             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.QCSamplesService.Count
          */