@kernelminds/scailo-sdk 0.1.28 → 0.1.29

package/lib/cjs/src/departments.scailo_pb.js

@@ -99,7 +99,16 @@ class DepartmentsServiceCreateRequest 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;
          */
@@ -111,7 +120,16 @@ class DepartmentsServiceCreateRequest 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;
          */
@@ -189,13 +207,27 @@ class DepartmentsServiceUpdateRequest extends protobuf_1.Message {
          */
         this.id = protobuf_1.protoInt64.zero;
         /**
-         * Optional boolean value that stores if a notification needs to be sent to users about the update to the record. This is useful when a subsequent operation needs to be performed immediately (such as send to verification after updating the revision)
+         *
+         * @optional
+         *
+         * @description Flag to trigger system notifications to relevant users upon update. Set to true if subsequent workflows (like verification) depend on this change.
+         *
+         * @example true
          *
          * @generated from field: bool notify_users = 3;
          */
         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;
          */
@@ -262,31 +294,42 @@ class Department 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 department
+         *
+         * @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 department
+         *
+         * @description Comprehensive audit trail of every operation performed on this record.
          *
          * @generated from field: repeated Scailo.LogbookLogConciseSLC logs = 5;
          */
         this.logs = [];
         /**
-         * The timestamp of when this department was marked as completed
+         *
+         * @description UNIX timestamp of when the record transitioned to the COMPLETED state.
+         *
+         * @example 1698400000
          *
          * @generated from field: uint64 completed_on = 6;
          */
         this.completedOn = protobuf_1.protoInt64.zero;
         /**
-         * The associated vault folder ID
+         *
+         * @description Link to the document storage folder.
+         *
+         * @example 15234
          *
          * @generated from field: uint64 vault_folder_id = 9;
          */
@@ -392,31 +435,62 @@ class DepartmentsServicePaginationReq 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.DEPARTMENT_SORT_KEY sort_key = 5;
          */
@@ -463,25 +537,35 @@ class DepartmentsServicePaginationResponse 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.Department payload = 4;
          */
@@ -520,103 +604,238 @@ class DepartmentsServiceFilterReq 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.DEPARTMENT_SORT_KEY sort_key = 5;
          */
         this.sortKey = DEPARTMENT_SORT_KEY.DEPARTMENT_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 department
+         *
+         * @optional
+         *
+         * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+         *
+         * @example STANDING
          *
          * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
          */
         this.status = base_scailo_pb_js_1.STANDARD_LIFECYCLE_STATUS.ANY_UNSPECIFIED;
         /**
-         * 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;
          */
         this.approverRoleId = protobuf_1.protoInt64.zero;
         /**
-         * The start range of completed timestamp
+         *
+         * @optional
+         *
+         * @description Filter records completed ON or AFTER this UNIX timestamp.
+         *
+         * @example 1672531200
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 completed_on_start = 15;
          */
         this.completedOnStart = protobuf_1.protoInt64.zero;
         /**
-         * The end range of completed timestamp
+         *
+         * @optional
+         *
+         * @description Filter records completed ON or BEFORE this UNIX timestamp.
+         *
+         * @example 1704067199
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 completed_on_end = 16;
          */
@@ -689,79 +908,188 @@ class DepartmentsServiceCountReq 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 department
+         *
+         * @optional
+         *
+         * @description Filter by lifecycle status (e.g., DRAFT, STANDING).
+         *
+         * @example STANDING
          *
          * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 10;
          */
         this.status = base_scailo_pb_js_1.STANDARD_LIFECYCLE_STATUS.ANY_UNSPECIFIED;
         /**
-         * 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;
          */
         this.approverRoleId = protobuf_1.protoInt64.zero;
         /**
-         * The start range of completed timestamp
+         *
+         * @optional
+         *
+         * @description Filter records completed ON or AFTER this UNIX timestamp.
+         *
+         * @example 1672531200
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 completed_on_start = 15;
          */
         this.completedOnStart = protobuf_1.protoInt64.zero;
         /**
-         * The end range of completed timestamp
+         *
+         * @optional
+         *
+         * @description Filter records completed ON or BEFORE this UNIX timestamp.
+         *
+         * @example 1704067199
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 completed_on_end = 16;
          */
@@ -830,49 +1158,103 @@ class DepartmentsServiceSearchAllReq 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.DEPARTMENT_SORT_KEY sort_key = 5;
          */
         this.sortKey = DEPARTMENT_SORT_KEY.DEPARTMENT_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;
          */
         this.status = base_scailo_pb_js_1.STANDARD_LIFECYCLE_STATUS.ANY_UNSPECIFIED;
         /**
-         * Describes the key with which the search operation needs to be performed
+         *
+         * @mandatory
+         *
+         * @description The search string to match against reference IDs.
+         *
+         * @example "Medical 2023"
+         *
+         * @regex .*
+         *
+         * @format: May contain any UTF-8 characters.
          *
          * @generated from field: string search_key = 11;
          */