@kernelminds/scailo-sdk 0.1.28 → 0.1.30

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

@@ -62,7 +62,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ViewByID
          */
@@ -73,7 +73,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ViewByUUID
          */
@@ -95,7 +95,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ViewEssentialByID
          */
@@ -106,7 +106,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ViewEssentialByUUID
          */
@@ -117,7 +117,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ViewFromIDs
          */
@@ -172,7 +172,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.Filter
          */
@@ -183,7 +183,7 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.Count
          */
@@ -206,7 +206,13 @@ exports.FormsFieldsService = {
             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.FormsFieldsService.ImportFromCSV
          */

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

@@ -69,7 +69,10 @@ protobuf_1.proto3.util.setEnumType(FORM_FIELD_SORT_KEY, "Scailo.FORM_FIELD_SORT_
  */
 class FormField 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;
      */
@@ -239,25 +242,35 @@ exports.FormsFieldsList = FormsFieldsList;
  */
 class FormFieldPaginationResp 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.FormField payload = 4;
      */
@@ -296,7 +309,16 @@ exports.FormFieldPaginationResp = FormFieldPaginationResp;
  */
 class FormsFieldsServiceCreateRequest 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;
      */
@@ -550,31 +572,62 @@ exports.FormsFieldsServiceUpdateRequest = FormsFieldsServiceUpdateRequest;
  */
 class FormsFieldsServicePaginationReq 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.FORM_FIELD_SORT_KEY sort_key = 5;
      */
@@ -614,61 +667,137 @@ exports.FormsFieldsServicePaginationReq = FormsFieldsServicePaginationReq;
  */
 class FormsFieldsServiceFilterReq 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.FORM_FIELD_SORT_KEY sort_key = 5;
      */
     sortKey = FORM_FIELD_SORT_KEY.FORM_FIELD_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;
      */
@@ -741,37 +870,87 @@ exports.FormsFieldsServiceFilterReq = FormsFieldsServiceFilterReq;
  */
 class FormsFieldsServiceCountReq 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;
      */
@@ -840,7 +1019,12 @@ exports.FormsFieldsServiceCountReq = FormsFieldsServiceCountReq;
  */
 class FormsFieldsServiceSearchAllReq 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;
      */
@@ -870,7 +1054,16 @@ class FormsFieldsServiceSearchAllReq extends protobuf_1.Message {
      */
     sortKey = FORM_FIELD_SORT_KEY.FORM_FIELD_SORT_KEY_ID_UNSPECIFIED;
     /**
-     * The entity UUID that is to be used to filter forms fields
+     *
+     * @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;
      */

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

@@ -70,7 +70,10 @@ protobuf_1.proto3.util.setEnumType(FORM_FIELD_FILTER_OPERATOR, "Scailo.FORM_FIEL
  */
 class FormFieldDatum 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;
      */
@@ -149,25 +152,35 @@ class FormFieldDatum extends protobuf_1.Message {
 exports.FormFieldDatum = FormFieldDatum;
 /**
  *
- * Describes the data required for creating a dynamic form field entry
+ * Represents a single data entry for a dynamic form field.
+ * * Use this to submit values for custom fields defined at the organization level,
+ * such as "Emergency Contact Name" or "T-Shirt Size".
  *
  * @generated from message Scailo.FormFieldDatumCreateRequest
  */
 class FormFieldDatumCreateRequest extends protobuf_1.Message {
     /**
-     * The ID of the corresponding form field
+     * [Required] The unique identifier of the form field definition.
+     * This ID must correspond to an existing field in the Form Configuration.
      *
      * @generated from field: uint64 form_field_id = 1;
      */
     formFieldId = protobuf_1.protoInt64.zero;
     /**
-     * The value to be stored (for textarea and input)
+     * [Conditional] The text content for single-value inputs.
+     * Use this for `text`, `textarea`, `number`, or `date` field types.
+     *
+     * *Example:* "John Doe" or "123.45"
      *
      * @generated from field: string value = 2;
      */
     value = "";
     /**
-     * The list of selected values (for radio, checkbox, and select)
+     * [Conditional] A list of identifiers for multi-selection fields.
+     * Use this for `radio`, `checkbox`, or `dropdown` field types.
+     *
+     * *Note:* For radio buttons, this list should contain exactly one element.
+     * *Example:* ["option_1", "option_5"]
      *
      * @generated from field: repeated string selected_values = 3;
      */

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

@@ -62,7 +62,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ViewByID
          */
@@ -73,7 +73,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ViewByUUID
          */
@@ -84,7 +84,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ViewEssentialByID
          */
@@ -95,7 +95,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ViewEssentialByUUID
          */
@@ -106,7 +106,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ViewFromIDs
          */
@@ -161,7 +161,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.Filter
          */
@@ -172,7 +172,7 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.Count
          */
@@ -195,7 +195,13 @@ exports.FormsSectionsService = {
             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.FormsSectionsService.ImportFromCSV
          */