@kernelminds/scailo-sdk 0.1.28 → 0.1.29

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

@@ -151,7 +151,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.CommentAdd
          */
@@ -162,7 +162,9 @@ exports.FeedstocksService = {
             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.FeedstocksService.CreateMagicLink
          */
@@ -173,7 +175,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewByID
          */
@@ -184,7 +186,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewByUUID
          */
@@ -195,7 +197,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewEssentialByID
          */
@@ -206,7 +208,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewEssentialByUUID
          */
@@ -217,7 +219,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewFromIDs
          */
@@ -239,7 +241,7 @@ exports.FeedstocksService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.FeedstocksService.ViewAll
          */
@@ -250,7 +252,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.ViewWithPagination
          */
@@ -260,6 +262,17 @@ exports.FeedstocksService = {
             O: feedstocks_scailo_pb_js_1.FeedstocksServicePaginationResponse,
             kind: protobuf_1.MethodKind.Unary,
         },
+        /**
+         * View the unit price at which the inventory item was purchased (the corresponding vendor invoice price)
+         *
+         * @generated from rpc Scailo.FeedstocksService.ViewVendorInvoiceUnitPrice
+         */
+        viewVendorInvoiceUnitPrice: {
+            name: "ViewVendorInvoiceUnitPrice",
+            I: base_scailo_pb_js_1.IdentifierUUID,
+            O: base_scailo_pb_js_1.PriceResponse,
+            kind: protobuf_1.MethodKind.Unary,
+        },
         /**
          * Download QC Report with the given Identifier
          *
@@ -316,7 +329,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.SearchAll
          */
@@ -327,7 +340,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.Filter
          */
@@ -338,7 +351,7 @@ exports.FeedstocksService = {
             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.FeedstocksService.Count
          */
@@ -372,7 +385,13 @@ exports.FeedstocksService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Import records using a CSV file. Imports records as initial stock
+         * 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.FeedstocksService.ImportFromCSV
          */

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

@@ -56,7 +56,16 @@ protobuf_1.proto3.util.setEnumType(FEEDSTOCK_REF_FROM, "Scailo.FEEDSTOCK_REF_FRO
  */
 class FeedstocksServiceCreateRequest extends protobuf_1.Message {
     /**
-     * Stores a globally unique entity UUID. This will be set at the organization level
+     *
+     * @optional
+     *
+     * @description The globally unique identifier for the Organization or Business Entity.
+     *
+     * @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 = 1;
      */
@@ -202,7 +211,12 @@ class FeedstocksServiceUpdateRequest extends protobuf_1.Message {
      */
     id = protobuf_1.protoInt64.zero;
     /**
-     * Optional boolean value that stores if a notification needs to be sent to users about the update to the record. This is useful when a subsequent operation needs to be performed immediately (such as send to verification after updating the revision)
+     *
+     * @optional
+     *
+     * @description Flag to trigger system notifications to relevant users upon update. Set to true if subsequent workflows (like verification) depend on this change.
+     *
+     * @example true
      *
      * @generated from field: bool notify_users = 3;
      */
@@ -409,7 +423,10 @@ exports.FeedstocksServiceSendToStoreRequest = FeedstocksServiceSendToStoreReques
  */
 class Feedstock 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;
      */
@@ -698,31 +715,62 @@ exports.FeedstocksList = FeedstocksList;
  */
 class FeedstocksServicePaginationReq 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
+     *
+     * @mandatory
+     *
+     * @description Number of records to return per page.
+     *
+     * @example 50
+     *
+     * @regex ^[1-9][0-9]*$
+     *
+     * @format Must be a strictly positive integer (1 or greater).
      *
      * @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 specific field key to sort the results by.
      *
      * @generated from field: Scailo.INVENTORY_SORT_KEY sort_key = 5;
      */
@@ -769,25 +817,35 @@ exports.FeedstocksServicePaginationReq = FeedstocksServicePaginationReq;
  */
 class FeedstocksServicePaginationResponse extends protobuf_1.Message {
     /**
-     * The number of records in this payload
+     *
+     * @description Number of records returned in the current response slice.
+     *
+     * @example 50
      *
      * @generated from field: uint64 count = 1;
      */
     count = protobuf_1.protoInt64.zero;
     /**
-     * The number that has been offset before fetching the records. This is the same value that has been sent as part of the pagination request
+     *
+     * @description The offset provided in the request.
+     *
+     * @example 0
      *
      * @generated from field: uint64 offset = 2;
      */
     offset = protobuf_1.protoInt64.zero;
     /**
-     * The total number of records that are available
+     *
+     * @description The total number of records matching the criteria.
+     *
+     * @example 1250
      *
      * @generated from field: uint64 total = 3;
      */
     total = protobuf_1.protoInt64.zero;
     /**
-     * The list of records
+     *
+     * @description The array of records for the current page.
      *
      * @generated from field: repeated Scailo.Feedstock payload = 4;
      */
@@ -826,61 +884,137 @@ exports.FeedstocksServicePaginationResponse = FeedstocksServicePaginationRespons
  */
 class FeedstocksServiceFilterReq 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;
      */
@@ -1102,37 +1236,87 @@ exports.FeedstocksServiceFilterReq = FeedstocksServiceFilterReq;
  */
 class FeedstocksServiceCountReq 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 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;
      */
@@ -1350,37 +1534,77 @@ exports.FeedstocksServiceCountReq = FeedstocksServiceCountReq;
  */
 class FeedstocksServiceSearchAllReq 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;
      */
@@ -1392,7 +1616,16 @@ class FeedstocksServiceSearchAllReq extends protobuf_1.Message {
      */
     status = base_scailo_pb_js_1.INVENTORY_LIFECYCLE.INVENTORY_LIFECYCLE_ANY_UNSPECIFIED;
     /**
-     * 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;
      */