@kernelminds/scailo-sdk 0.1.28 → 0.1.30

package/lib/cjs/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");
@@ -272,7 +272,16 @@ class FamiliesServiceCreateRequest extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
@@ -284,7 +293,16 @@ class FamiliesServiceCreateRequest extends protobuf_1.Message {
          */
         this.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;
          */
@@ -452,7 +470,16 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
          */
         this.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;
          */
@@ -469,24 +496,12 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
          * @generated from field: string print_name = 11;
          */
         this.printName = "";
-        /**
-         * The unique code that represents the family (can be updated only prior to the first approval)
-         *
-         * @generated from field: string code = 12;
-         */
-        this.code = "";
         /**
          * The description of the family
          *
          * @generated from field: string description = 14;
          */
         this.description = "";
-        /**
-         * The type of the family (can be updated only prior to the first approval)
-         *
-         * @generated from field: Scailo.FAMILY_TYPE family_type = 15;
-         */
-        this.familyType = FAMILY_TYPE.FAMILY_TYPE_ANY_UNSPECIFIED;
         /**
          * The HSN/SAC code of the family
          *
@@ -505,18 +520,6 @@ class FamiliesServiceUpdateRequest extends protobuf_1.Message {
          * @generated from field: uint64 unit_quantity = 18;
          */
         this.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;
-         */
-        this.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;
-         */
-        this.isLeaf = false;
         /**
          * Stores the ID of the ledger
          *
@@ -578,14 +581,10 @@ FamiliesServiceUpdateRequest.fields = protobuf_1.proto3.util.newFieldList(() =>
     { 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 @@ FamiliesServiceUpdateRequest.fields = protobuf_1.proto3.util.newFieldList(() =>
     { no: 28, name: "consumption_sequence", kind: "enum", T: protobuf_1.proto3.getEnumType(CONSUMPTION_SEQUENCE) },
     { no: 50, name: "form_data", kind: "message", T: forms_fields_data_scailo_pb_js_1.FormFieldDatumCreateRequest, repeated: true },
 ]);
+/**
+ *
+ * Describes the parameters necessary to update the identity of a family
+ *
+ * @generated from message Scailo.FamiliesServiceUpdateIdentityRequest
+ */
+class FamiliesServiceUpdateIdentityRequest extends protobuf_1.Message {
+    constructor(data) {
+        super();
+        /**
+         * Stores any comment that the user might add during this operation
+         *
+         * @generated from field: string user_comment = 1;
+         */
+        this.userComment = "";
+        /**
+         * The ID of the record that needs to be updated
+         *
+         * @generated from field: uint64 id = 2;
+         */
+        this.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;
+         */
+        this.code = "";
+        /**
+         * The type of the family (can be updated only prior to the first approval)
+         *
+         * @generated from field: Scailo.FAMILY_TYPE family_type = 15;
+         */
+        this.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;
+         */
+        this.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;
+         */
+        this.isLeaf = false;
+        protobuf_1.proto3.util.initPartial(data, this);
+    }
+    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;
+FamiliesServiceUpdateIdentityRequest.runtime = protobuf_1.proto3;
+FamiliesServiceUpdateIdentityRequest.typeName = "Scailo.FamiliesServiceUpdateIdentityRequest";
+FamiliesServiceUpdateIdentityRequest.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 */ },
+]);
 /**
  *
  * Describes the parameters that are part of a family structure
@@ -603,25 +673,33 @@ class Family extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * The status of this family
+         *
+         * @description The current lifecycle status (e.g., DRAFT, VERIFIED, STANDING).
          *
          * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 4;
          */
         this.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;
          */
         this.logs = [];
         /**
-         * The associated vault folder ID
+         *
+         * @description Link to the document storage folder.
+         *
+         * @example 15234
          *
          * @generated from field: uint64 vault_folder_id = 9;
          */
@@ -817,31 +895,62 @@ class FamiliesServicePaginationReq extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -888,25 +997,35 @@ class FamiliesServicePaginationResponse extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -945,67 +1064,148 @@ class FamiliesServiceFilterReq extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -1017,25 +1217,61 @@ class FamiliesServiceFilterReq extends protobuf_1.Message {
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -1198,43 +1434,98 @@ class FamiliesServiceCountReq extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -1246,25 +1537,61 @@ class FamiliesServiceCountReq extends protobuf_1.Message {
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -1423,43 +1750,88 @@ class FamiliesServiceSearchAllReq extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
         this.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;
          */
@@ -1471,7 +1843,16 @@ class FamiliesServiceSearchAllReq extends protobuf_1.Message {
          */
         this.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;
          */
@@ -1630,13 +2011,17 @@ class FamilyLabel extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * Denotes if this record requires approval (or has been approved)
+         *
+         * @description The approval state of the record
          *
          * @generated from field: bool need_approval = 4;
          */
@@ -1782,13 +2167,17 @@ class FamilyStorage extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * Denotes if this record requires approval (or has been approved)
+         *
+         * @description The approval state of the record
          *
          * @generated from field: bool need_approval = 4;
          */
@@ -1991,13 +2380,17 @@ class FamilyUnitConversion extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * Denotes if this record requires approval (or has been approved)
+         *
+         * @description The approval state of the record
          *
          * @generated from field: bool need_approval = 4;
          */
@@ -2157,13 +2550,17 @@ class FamilyQCGroup extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * Denotes if this record requires approval (or has been approved)
+         *
+         * @description The approval state of the record
          *
          * @generated from field: bool need_approval = 4;
          */
@@ -2380,13 +2777,17 @@ class FamilyImage extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * 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;
          */
         this.entityUuid = "";
         /**
-         * Denotes if this record requires approval (or has been approved)
+         *
+         * @description The approval state of the record
          *
          * @generated from field: bool need_approval = 4;
          */