@kernelminds/scailo-sdk 0.1.28 → 0.1.30

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

@@ -4,7 +4,7 @@
 /* eslint-disable */
 // @ts-nocheck
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FamiliesServiceUpdateMinStockToMaintainRequest = exports.FamiliesServiceUpdatePriceRequest = exports.FamilyImagesList = exports.FamilyImage = exports.FamiliesServiceImageUpdateRequest = exports.FamiliesServiceImageCreateRequest = exports.FamilyQCGroupsList = exports.FamilyQCGroup = exports.FamiliesServiceQCGroupCreateRequest = exports.FamilyUnitConversionsList = exports.FamilyUnitConversion = exports.FamiliesServiceUnitConversionCreateRequest = exports.FamiliesServiceUnitConversionPresenceRequest = exports.FamilyStoragesList = exports.FamilyStorage = exports.FamiliesServiceStorageCreateRequest = exports.FamilyLabelsList = exports.FamilyLabel = exports.FamiliesServiceLabelCreateRequest = exports.FilterFamiliesReqForIdentifier = exports.FamiliesServiceSearchAllReq = exports.FamiliesServiceCountReq = exports.FamiliesServiceFilterReq = exports.FamiliesServicePaginationResponse = exports.FamiliesServicePaginationReq = exports.FamiliesList = exports.Family = exports.FamiliesServiceUpdateRequest = exports.FamiliesServiceCreateRequest = exports.FamilyTypesList = exports.FAMILY_SORT_KEY = exports.CONSUMPTION_SEQUENCE = exports.FAMILY_TYPE = void 0;
+exports.FamiliesServiceUpdateMinStockToMaintainRequest = exports.FamiliesServiceUpdatePriceRequest = exports.FamilyImagesList = exports.FamilyImage = exports.FamiliesServiceImageUpdateRequest = exports.FamiliesServiceImageCreateRequest = exports.FamilyQCGroupsList = exports.FamilyQCGroup = exports.FamiliesServiceQCGroupCreateRequest = exports.FamilyUnitConversionsList = exports.FamilyUnitConversion = exports.FamiliesServiceUnitConversionCreateRequest = exports.FamiliesServiceUnitConversionPresenceRequest = exports.FamilyStoragesList = exports.FamilyStorage = exports.FamiliesServiceStorageCreateRequest = exports.FamilyLabelsList = exports.FamilyLabel = exports.FamiliesServiceLabelCreateRequest = exports.FilterFamiliesReqForIdentifier = exports.FamiliesServiceSearchAllReq = exports.FamiliesServiceCountReq = exports.FamiliesServiceFilterReq = exports.FamiliesServicePaginationResponse = exports.FamiliesServicePaginationReq = exports.FamiliesList = exports.Family = exports.FamiliesServiceUpdateIdentityRequest = exports.FamiliesServiceUpdateRequest = exports.FamiliesServiceCreateRequest = exports.FamilyTypesList = exports.FAMILY_SORT_KEY = exports.CONSUMPTION_SEQUENCE = exports.FAMILY_TYPE = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 const forms_fields_data_scailo_pb_js_1 = require("./forms_fields_data.scailo_pb.js");
 const base_scailo_pb_js_1 = require("./base.scailo_pb.js");
@@ -270,7 +270,16 @@ exports.FamilyTypesList = FamilyTypesList;
  */
 class FamiliesServiceCreateRequest 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;
      */
@@ -282,7 +291,16 @@ class FamiliesServiceCreateRequest extends protobuf_1.Message {
      */
     userComment = "";
     /**
-     * The associated vault folder ID
+     *
+     * @optional
+     *
+     * @description The ID of the associated vault folder for storing documents. Defaults to 0 if no specific folder is assigned.
+     *
+     * @example 15234
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
@@ -450,7 +468,16 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
      */
     notifyUsers = false;
     /**
-     * The associated vault folder ID
+     *
+     * @optional
+     *
+     * @description Updated vault folder ID for documentation storage.
+     *
+     * @example 15235
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
@@ -467,24 +494,12 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
      * @generated from field: string print_name = 11;
      */
     printName = "";
-    /**
-     * The unique code that represents the family (can be updated only prior to the first approval)
-     *
-     * @generated from field: string code = 12;
-     */
-    code = "";
     /**
      * The description of the family
      *
      * @generated from field: string description = 14;
      */
     description = "";
-    /**
-     * The type of the family (can be updated only prior to the first approval)
-     *
-     * @generated from field: Scailo.FAMILY_TYPE family_type = 15;
-     */
-    familyType = FAMILY_TYPE.FAMILY_TYPE_ANY_UNSPECIFIED;
     /**
      * The HSN/SAC code of the family
      *
@@ -503,18 +518,6 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
      * @generated from field: uint64 unit_quantity = 18;
      */
     unitQuantity = protobuf_1.protoInt64.zero;
-    /**
-     * Stores the ID of the parent family (can be updated only prior to the first approval)
-     *
-     * @generated from field: uint64 parent_id = 19;
-     */
-    parentId = protobuf_1.protoInt64.zero;
-    /**
-     * Stores if the family is a leaf family (can be updated only prior to the first approval)
-     *
-     * @generated from field: bool is_leaf = 20;
-     */
-    isLeaf = false;
     /**
      * Stores the ID of the ledger
      *
@@ -564,14 +567,10 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
         { no: 9, name: "vault_folder_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
         { no: 10, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
         { no: 11, name: "print_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-        { no: 12, name: "code", kind: "scalar", T: 9 /* ScalarType.STRING */ },
         { no: 14, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-        { no: 15, name: "family_type", kind: "enum", T: protobuf_1.proto3.getEnumType(FAMILY_TYPE) },
         { no: 16, name: "hsn_sac_code", kind: "scalar", T: 9 /* ScalarType.STRING */ },
         { no: 17, name: "uom_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
         { no: 18, name: "unit_quantity", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
-        { no: 19, name: "parent_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
-        { no: 20, name: "is_leaf", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
         { no: 21, name: "ledger_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
         { no: 23, name: "tax_group_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
         { no: 26, name: "price", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
@@ -593,6 +592,77 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
     }
 }
 exports.FamiliesServiceUpdateRequest = FamiliesServiceUpdateRequest;
+/**
+ *
+ * Describes the parameters necessary to update the identity of a family
+ *
+ * @generated from message Scailo.FamiliesServiceUpdateIdentityRequest
+ */
+class FamiliesServiceUpdateIdentityRequest extends protobuf_1.Message {
+    /**
+     * Stores any comment that the user might add during this operation
+     *
+     * @generated from field: string user_comment = 1;
+     */
+    userComment = "";
+    /**
+     * The ID of the record that needs to be updated
+     *
+     * @generated from field: uint64 id = 2;
+     */
+    id = protobuf_1.protoInt64.zero;
+    /**
+     * The unique code that represents the family (can be updated only prior to the first approval)
+     *
+     * @generated from field: string code = 12;
+     */
+    code = "";
+    /**
+     * The type of the family (can be updated only prior to the first approval)
+     *
+     * @generated from field: Scailo.FAMILY_TYPE family_type = 15;
+     */
+    familyType = FAMILY_TYPE.FAMILY_TYPE_ANY_UNSPECIFIED;
+    /**
+     * Stores the ID of the parent family (can be updated only prior to the first approval)
+     *
+     * @generated from field: uint64 parent_id = 19;
+     */
+    parentId = protobuf_1.protoInt64.zero;
+    /**
+     * Stores if the family is a leaf family (can be updated only prior to the first approval)
+     *
+     * @generated from field: bool is_leaf = 20;
+     */
+    isLeaf = false;
+    constructor(data) {
+        super();
+        protobuf_1.proto3.util.initPartial(data, this);
+    }
+    static runtime = protobuf_1.proto3;
+    static typeName = "Scailo.FamiliesServiceUpdateIdentityRequest";
+    static fields = protobuf_1.proto3.util.newFieldList(() => [
+        { no: 1, name: "user_comment", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+        { no: 2, name: "id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
+        { no: 12, name: "code", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+        { no: 15, name: "family_type", kind: "enum", T: protobuf_1.proto3.getEnumType(FAMILY_TYPE) },
+        { no: 19, name: "parent_id", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
+        { no: 20, name: "is_leaf", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    ]);
+    static fromBinary(bytes, options) {
+        return new FamiliesServiceUpdateIdentityRequest().fromBinary(bytes, options);
+    }
+    static fromJson(jsonValue, options) {
+        return new FamiliesServiceUpdateIdentityRequest().fromJson(jsonValue, options);
+    }
+    static fromJsonString(jsonString, options) {
+        return new FamiliesServiceUpdateIdentityRequest().fromJsonString(jsonString, options);
+    }
+    static equals(a, b) {
+        return protobuf_1.proto3.util.equals(FamiliesServiceUpdateIdentityRequest, a, b);
+    }
+}
+exports.FamiliesServiceUpdateIdentityRequest = FamiliesServiceUpdateIdentityRequest;
 /**
  *
  * Describes the parameters that are part of a family structure
@@ -601,37 +671,47 @@ exports.FamiliesServiceUpdateRequest = FamiliesServiceUpdateRequest;
  */
 class Family 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * The status of this family
+     *
+     * @description The current lifecycle status (e.g., DRAFT, VERIFIED, STANDING).
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 4;
      */
     status = base_scailo_pb_js_1.STANDARD_LIFECYCLE_STATUS.ANY_UNSPECIFIED;
     /**
-     * Stores the logs of every operation performed on this purchase order
+     *
+     * @description Comprehensive audit trail of every operation performed on this record.
      *
      * @generated from field: repeated Scailo.LogbookLogConciseSLC logs = 5;
      */
     logs = [];
     /**
-     * The associated vault folder ID
+     *
+     * @description Link to the document storage folder.
+     *
+     * @example 15234
      *
      * @generated from field: uint64 vault_folder_id = 9;
      */
@@ -827,31 +907,62 @@ exports.FamiliesList = FamiliesList;
  */
 class FamiliesServicePaginationReq 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.FAMILY_SORT_KEY sort_key = 5;
      */
@@ -898,25 +1009,35 @@ exports.FamiliesServicePaginationReq = FamiliesServicePaginationReq;
  */
 class FamiliesServicePaginationResponse 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.Family payload = 4;
      */
@@ -955,67 +1076,148 @@ exports.FamiliesServicePaginationResponse = FamiliesServicePaginationResponse;
  */
 class FamiliesServiceFilterReq 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.FAMILY_SORT_KEY sort_key = 5;
      */
     sortKey = FAMILY_SORT_KEY.FAMILY_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;
      */
     entityUuid = "";
     /**
-     * The status of this family
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
@@ -1027,25 +1229,61 @@ class FamiliesServiceFilterReq extends protobuf_1.Message {
      */
     multiStatus = [];
     /**
-     * The start range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_start = 11;
      */
     approvedOnStart = protobuf_1.protoInt64.zero;
     /**
-     * The end range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_end = 12;
      */
     approvedOnEnd = protobuf_1.protoInt64.zero;
     /**
-     * The ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the specific user ID who approved the records.
+     *
+     * @example 501
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_by_user_id = 13;
      */
     approvedByUserId = protobuf_1.protoInt64.zero;
     /**
-     * The role ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the role ID of the approver.
+     *
+     * @example 5
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approver_role_id = 14;
      */
@@ -1208,43 +1446,98 @@ exports.FamiliesServiceFilterReq = FamiliesServiceFilterReq;
  */
 class FamiliesServiceCountReq 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;
      */
     entityUuid = "";
     /**
-     * The status of this family
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
@@ -1256,25 +1549,61 @@ class FamiliesServiceCountReq extends protobuf_1.Message {
      */
     multiStatus = [];
     /**
-     * The start range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or AFTER this UNIX timestamp.
+     *
+     * @example 1672531200
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_start = 11;
      */
     approvedOnStart = protobuf_1.protoInt64.zero;
     /**
-     * The end range of approved timestamp
+     *
+     * @optional
+     *
+     * @description Filter records approved ON or BEFORE this UNIX timestamp.
+     *
+     * @example 1704067199
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_on_end = 12;
      */
     approvedOnEnd = protobuf_1.protoInt64.zero;
     /**
-     * The ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the specific user ID who approved the records.
+     *
+     * @example 501
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approved_by_user_id = 13;
      */
     approvedByUserId = protobuf_1.protoInt64.zero;
     /**
-     * The role ID of the approver
+     *
+     * @optional
+     *
+     * @description Filter by the role ID of the approver.
+     *
+     * @example 5
+     *
+     * @regex ^[0-9]+$
+     *
+     * @format Non-negative integer.
      *
      * @generated from field: uint64 approver_role_id = 14;
      */
@@ -1433,43 +1762,88 @@ exports.FamiliesServiceCountReq = FamiliesServiceCountReq;
  */
 class FamiliesServiceSearchAllReq 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.FAMILY_SORT_KEY sort_key = 5;
      */
     sortKey = FAMILY_SORT_KEY.FAMILY_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 = "";
     /**
-     * Limit the search space to the given status
+     *
+     * @optional
+     *
+     * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+     *
+     * @example STANDING
      *
      * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
      */
@@ -1481,7 +1855,16 @@ class FamiliesServiceSearchAllReq extends protobuf_1.Message {
      */
     multiStatus = [];
     /**
-     * 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;
      */
@@ -1646,25 +2029,31 @@ exports.FamiliesServiceLabelCreateRequest = FamiliesServiceLabelCreateRequest;
  */
 class FamilyLabel 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * Denotes if this record requires approval (or has been approved)
+     *
+     * @description The approval state of the record
      *
      * @generated from field: bool need_approval = 4;
      */
@@ -1810,25 +2199,31 @@ exports.FamiliesServiceStorageCreateRequest = FamiliesServiceStorageCreateReques
  */
 class FamilyStorage 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * Denotes if this record requires approval (or has been approved)
+     *
+     * @description The approval state of the record
      *
      * @generated from field: bool need_approval = 4;
      */
@@ -2031,25 +2426,31 @@ exports.FamiliesServiceUnitConversionCreateRequest = FamiliesServiceUnitConversi
  */
 class FamilyUnitConversion 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * Denotes if this record requires approval (or has been approved)
+     *
+     * @description The approval state of the record
      *
      * @generated from field: bool need_approval = 4;
      */
@@ -2209,25 +2610,31 @@ exports.FamiliesServiceQCGroupCreateRequest = FamiliesServiceQCGroupCreateReques
  */
 class FamilyQCGroup 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * Denotes if this record requires approval (or has been approved)
+     *
+     * @description The approval state of the record
      *
      * @generated from field: bool need_approval = 4;
      */
@@ -2444,25 +2851,31 @@ exports.FamiliesServiceImageUpdateRequest = FamiliesServiceImageUpdateRequest;
  */
 class FamilyImage 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;
      */
     entityUuid = "";
     /**
-     * Stores the metadata of this family
+     *
+     * @description Standard employee and record metadata including timestamps.
      *
      * @generated from field: Scailo.EmployeeMetadata metadata = 2;
      */
     metadata;
     /**
-     * Stores the approval metadata
+     *
+     * @description Detailed approval workflow state (Approver ID, Role, and Timestamps).
      *
      * @generated from field: Scailo.ApprovalMetadata approval_metadata = 3;
      */
     approvalMetadata;
     /**
-     * Denotes if this record requires approval (or has been approved)
+     *
+     * @description The approval state of the record
      *
      * @generated from field: bool need_approval = 4;
      */