@kernelminds/scailo-sdk 0.1.28 → 0.1.29

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

@@ -9,56 +9,56 @@ const protobuf_1 = require("@bufbuild/protobuf");
 const base_scailo_pb_js_1 = require("./base.scailo_pb.js");
 /**
  *
- * Describes the available sort keys
+ * Enumeration of fields available for sorting action code search results.
  *
  * @generated from enum Scailo.ACTION_CODE_SORT_KEY
  */
 var ACTION_CODE_SORT_KEY;
 (function (ACTION_CODE_SORT_KEY) {
     /**
-     * Fetch ordered results by id
+     * @description Default sort behavior (by internal ID).
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_ID_UNSPECIFIED = 0;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_ID_UNSPECIFIED"] = 0] = "ACTION_CODE_SORT_KEY_ID_UNSPECIFIED";
     /**
-     * Fetch ordered results by the creation timestamp
+     * @description Sort by the timestamp the record was initially created.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_CREATED_AT = 1;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_CREATED_AT"] = 1] = "ACTION_CODE_SORT_KEY_CREATED_AT";
     /**
-     * Fetch ordered results by the modified timestamp
+     * @description Sort by the timestamp the record was last modified.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_MODIFIED_AT = 2;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_MODIFIED_AT"] = 2] = "ACTION_CODE_SORT_KEY_MODIFIED_AT";
     /**
-     * Fetch ordered results by the approved on timestamp
+     * @description Sort by the official approval timestamp.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_APPROVED_ON = 3;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_APPROVED_ON"] = 3] = "ACTION_CODE_SORT_KEY_APPROVED_ON";
     /**
-     * Fetch ordered results by the approved by field
+     * @description Sort by the system ID of the approving user.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_APPROVED_BY = 4;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_APPROVED_BY"] = 4] = "ACTION_CODE_SORT_KEY_APPROVED_BY";
     /**
-     * Fetch ordered results by the approver's role ID
+     * @description Sort by the security role ID used by the approver.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_APPROVER_ROLE_ID = 5;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_APPROVER_ROLE_ID"] = 5] = "ACTION_CODE_SORT_KEY_APPROVER_ROLE_ID";
     /**
-     * Fetch ordered results by the name
+     * @description Sort alphabetically by the user-provided display name.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_NAME = 10;
      */
     ACTION_CODE_SORT_KEY[ACTION_CODE_SORT_KEY["ACTION_CODE_SORT_KEY_NAME"] = 10] = "ACTION_CODE_SORT_KEY_NAME";
     /**
-     * Fetch ordered results by the code
+     * @description Sort alphabetically by the user-provided unique alphanumeric identifier.
      *
      * @generated from enum value: ACTION_CODE_SORT_KEY_CODE = 11;
      */
@@ -77,7 +77,12 @@ protobuf_1.proto3.util.setEnumType(ACTION_CODE_SORT_KEY, "Scailo.ACTION_CODE_SOR
 ]);
 /**
  *
- * Describes the parameters necessary to create a record
+ * Request message for creating a new Action Code.
+ * Action Codes are used to classify specific activities, events, or status changes
+ * within the system, often organized in a hierarchical (tree) structure.
+ *
+ * **Note:** This is a configuration-level entity used to define categorization
+ * logic for reporting, workflows, and UI visualization.
  *
  * @generated from message Scailo.ActionsCodesServiceCreateRequest
  */
@@ -85,55 +90,132 @@ class ActionsCodesServiceCreateRequest extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * ActionsCodes 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;
          */
         this.entityUuid = "";
         /**
-         * ActionsCodes any comment that the user might add during this operation
+         *
+         * @optional
+         *
+         * @description Audit log comment or justification for creating this action code. Useful for tracking configuration changes in the system history.
+         *
+         * @example "Adding new sub-code for regional compliance tracking."
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string user_comment = 2;
          */
         this.userComment = "";
         /**
-         * The name of the action code
+         *
+         * @mandatory
+         *
+         * @description The display name of the action code. Must be at least 1 character long.
+         *
+         * @example "Technical Support"
+         *
+         * @regex .+
+         *
+         * @format May contain any UTF-8 characters.
          *
          * @generated from field: string name = 10;
          */
         this.name = "";
         /**
-         * The unique code by which the action code is classified
+         *
+         * @mandatory
+         *
+         * @description The unique alphanumeric identifier used for system classification. This is typically a short string or mnemonic used in logic and filtering.
+         *
+         * @example "TECH_SUP_01"
+         *
+         * @regex .+
+         *
+         * @format May contain any UTF-8 characters.
          *
          * @generated from field: string code = 11;
          */
         this.code = "";
         /**
-         * The color of the text that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description The Hexadecimal foreground (text) color for UI rendering. Used to visually distinguish codes in dashboards or lists.
+         *
+         * @example "#FFFFFF"
+         *
+         * @regex "^#[0-9a-fA-F]{6}$"
+         *
+         * @format Must be a 6-digit hex code starting with #.
          *
          * @generated from field: string fg_color = 12;
          */
         this.fgColor = "";
         /**
-         * The background color that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description The Hexadecimal background color for UI rendering. Used to visually distinguish codes in dashboards or lists.
+         *
+         * @example "#FF5733"
+         *
+         * @regex "^#[0-9a-fA-F]{6}$"
+         *
+         * @format Must be a 6-digit hex code starting with #.
          *
          * @generated from field: string bg_color = 13;
          */
         this.bgColor = "";
         /**
-         * The ID of the associated non-leaf parent action code (0, if the first action code that is being created is a leaf action code)
+         *
+         * @optional
+         *
+         * @description The ID of the parent category in the action code hierarchy. Set to `0` if this is a top-level (root) action code.
+         *
+         * @example 105
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 parent_action_code_id = 16;
          */
         this.parentActionCodeId = protobuf_1.protoInt64.zero;
         /**
-         * Stores if this is a leaf action code or a non-leaf action code
+         *
+         * @mandatory
+         *
+         * @description Indicates whether this code is a terminal "leaf" node. If `true`, no further sub-codes can be nested under this entry.
+         *
+         * @example true
          *
          * @generated from field: bool is_leaf = 17;
          */
         this.isLeaf = false;
         /**
-         * The description of the action code
+         *
+         * @optional
+         *
+         * @description Detailed explanation of what this action code represents and when it should be used.
+         *
+         * @example "Used for tracking inbound technical support tickets for Tier 1 issues."
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string description = 18;
          */
@@ -169,7 +251,13 @@ ActionsCodesServiceCreateRequest.fields = protobuf_1.proto3.util.newFieldList(()
 ]);
 /**
  *
- * Describes the parameters necessary to update a record
+ * Request message for updating an existing Action Code record.
+ * Only applicable for records in `DRAFT` or `REVISION` states.
+ * This message allows for modifying the visual properties, naming, and
+ * metadata of an established Action Code.
+ *
+ * **Note:** Only fields provided in the request will typically be updated.
+ * The unique system ID is required to locate the target record.
  *
  * @generated from message Scailo.ActionsCodesServiceUpdateRequest
  */
@@ -177,43 +265,102 @@ class ActionsCodesServiceUpdateRequest extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * ActionsCodes any comment that the user might add during this operation
+         *
+         * @optional
+         *
+         * @description Audit log comment or justification for this specific update. Captured in the version history for administrative tracking.
+         *
+         * @example "Updating brand colors to match new UI guidelines."
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string user_comment = 1;
          */
         this.userComment = "";
         /**
-         * The ID of the record that needs to be updated
+         *
+         * @mandatory
+         *
+         * @description The unique system identifier of the Action Code to be updated. Must be a value greater than `0`.
+         *
+         * @example 402
+         *
+         * @regex ^[1-9][0-9]*$
+         *
+         * @format Must be a strictly positive integer (1 or greater).
          *
          * @generated from field: uint64 id = 2;
          */
         this.id = protobuf_1.protoInt64.zero;
         /**
-         * Optional boolean value that actions codes 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 name of the action code
+         *
+         * @mandatory
+         *
+         * @description The updated display name of the action code. Must contain at least 1 character.
+         *
+         * @example "Emergency Maintenance"
+         *
+         * @regex .+
+         *
+         * @format May contain any UTF-8 characters.
          *
          * @generated from field: string name = 10;
          */
         this.name = "";
         /**
-         * The color of the text that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description The updated Hexadecimal foreground (text) color.
+         *
+         * @example "#000000"
+         *
+         * @regex "^#[0-9a-fA-F]{6}$"
+         *
+         * @format Must be a 6-digit hex code starting with #.
          *
          * @generated from field: string fg_color = 12;
          */
         this.fgColor = "";
         /**
-         * The background color that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description The updated Hexadecimal background color.
+         *
+         * @example "#FFFF00"
+         *
+         * @regex "^#[0-9a-fA-F]{6}$"
+         *
+         * @format Must be a 6-digit hex code starting with #.
          *
          * @generated from field: string bg_color = 13;
          */
         this.bgColor = "";
         /**
-         * The description of the action code
+         *
+         * @optional
+         *
+         * @description An updated detailed description of the action code's purpose.
+         *
+         * @example "Revised to include high-priority hardware failures."
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string description = 18;
          */
@@ -247,7 +394,7 @@ ActionsCodesServiceUpdateRequest.fields = protobuf_1.proto3.util.newFieldList(()
 ]);
 /**
  *
- * Describes the parameters that are part of a standard response
+ * Represents a full Action Code within the system.
  *
  * @generated from message Scailo.ActionCode
  */
@@ -255,61 +402,87 @@ class ActionCode extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * ActionsCodes 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 action code
+         *
+         * @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;
         /**
-         * ActionsCodes the logs of every operation performed on this action code
+         *
+         * @description Comprehensive audit trail of every operation performed on this record.
          *
          * @generated from field: repeated Scailo.LogbookLogConciseSLC logs = 5;
          */
         this.logs = [];
         /**
-         * The name of the action code
+         *
+         * @description The display name of the action code.
+         *
+         * @example "Technical Support"
          *
          * @generated from field: string name = 10;
          */
         this.name = "";
         /**
-         * The unique code by which the action code is classified
+         *
+         * @description The unique alphanumeric identifier used for system classification. This is typically a short string or mnemonic used in logic and filtering.
+         *
+         * @example "TECH_SUP_01"
          *
          * @generated from field: string code = 11;
          */
         this.code = "";
         /**
-         * The color of the text that is displayed for easy recognition
+         *
+         * @description The Hexadecimal foreground (text) color for UI rendering. Used to visually distinguish codes in dashboards or lists.
+         *
+         * @example "#FFFFFF"
          *
          * @generated from field: string fg_color = 12;
          */
         this.fgColor = "";
         /**
-         * The background color that is displayed for easy recognition
+         *
+         * @description The Hexadecimal background color for UI rendering. Used to visually distinguish codes in dashboards or lists.
+         *
+         * @example "#FF5733"
          *
          * @generated from field: string bg_color = 13;
          */
         this.bgColor = "";
         /**
-         * The ID of the associated non-leaf parent action code (0, if the first action code that is being created is a leaf action code)
+         *
+         * @description The ID of the associated non-leaf parent action code in the action code hierarchy. If `0`, this is a top-level (root) action code.
+         *
+         * @example 105
          *
          * @generated from field: uint64 parent_action_code_id = 16;
          */
         this.parentActionCodeId = protobuf_1.protoInt64.zero;
         /**
-         * Stores if this is a leaf action code or a non-leaf action code
+         *
+         * @description Indicates whether this code is a terminal "leaf" node. If `true`, no further sub-codes can be nested under this entry.
+         *
+         * @example true
          *
          * @generated from field: bool is_leaf = 17;
          */
         this.isLeaf = false;
         /**
-         * The description of the action code
+         *
+         * @description Detailed explanation of what this action code represents and when it should be used.
+         *
+         * @example "Used for tracking inbound technical support tickets for Tier 1 issues."
          *
          * @generated from field: string description = 18;
          */
@@ -348,7 +521,7 @@ ActionCode.fields = protobuf_1.proto3.util.newFieldList(() => [
 ]);
 /**
  *
- * Describes the message consisting of the list of records
+ * Container message for a collection of Action Code records.
  *
  * @generated from message Scailo.ActionsCodesList
  */
@@ -356,7 +529,7 @@ class ActionsCodesList extends protobuf_1.Message {
     constructor(data) {
         super();
         /**
-         * List of records
+         * @description An array of Action Code records.
          *
          * @generated from field: repeated Scailo.ActionCode list = 1;
          */
@@ -384,7 +557,7 @@ ActionsCodesList.fields = protobuf_1.proto3.util.newFieldList(() => [
 ]);
 /**
  *
- * Describes a pagination request to retrieve records
+ * Pagination request for retrieving slices of Action Code records.
  *
  * @generated from message Scailo.ActionsCodesServicePaginationReq
  */
@@ -392,37 +565,73 @@ class ActionsCodesServicePaginationReq 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.ACTION_CODE_SORT_KEY sort_key = 5;
          */
         this.sortKey = ACTION_CODE_SORT_KEY.ACTION_CODE_SORT_KEY_ID_UNSPECIFIED;
         /**
-         * The status of this action code
+         *
+         * @optional
+         *
+         * @description Filter results by a specific lifecycle status.
+         *
+         * @example STANDING
          *
          * @generated from field: Scailo.STANDARD_LIFECYCLE_STATUS status = 6;
          */
@@ -455,7 +664,7 @@ ActionsCodesServicePaginationReq.fields = protobuf_1.proto3.util.newFieldList(()
 ]);
 /**
  *
- * Describes the response to a pagination request
+ * Response message for paginated queries, including total counts for UI elements.
  *
  * @generated from message Scailo.ActionsCodesServicePaginationResponse
  */
@@ -463,25 +672,35 @@ class ActionsCodesServicePaginationResponse 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.ActionCode payload = 4;
          */
@@ -512,7 +731,7 @@ ActionsCodesServicePaginationResponse.fields = protobuf_1.proto3.util.newFieldLi
 ]);
 /**
  *
- * Describes the base request payload of a filter search
+ * Advanced filter request for searching action codes using multiple logical criteria.
  *
  * @generated from message Scailo.ActionsCodesServiceFilterReq
  */
@@ -520,127 +739,294 @@ class ActionsCodesServiceFilterReq 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.ACTION_CODE_SORT_KEY sort_key = 5;
          */
         this.sortKey = ACTION_CODE_SORT_KEY.ACTION_CODE_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 action code
+         *
+         * @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 name of the action code
+         *
+         * @optional
+         *
+         * @description Fuzzy match for the display name.
+         *
+         * @example "Technical Support"
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string name = 20;
          */
         this.name = "";
         /**
-         * The unique code by which the action code is classified
+         *
+         * @optional
+         *
+         * @description Exact match for the unique alphanumeric identifier.
+         *
+         * @example "TECH_SUP_01"
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string code = 21;
          */
         this.code = "";
         /**
-         * The color of the text that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description Exact match for the Hexadecimal foreground (text) color.
+         *
+         * @example "#FFFFFF"
+         *
+         * @regex "^$|^#[0-9a-fA-F]{6}$"
+         *
+         * @format May be empty, but if provided, must be a '#' followed by exactly 6 hex characters.
          *
          * @generated from field: string fg_color = 22;
          */
         this.fgColor = "";
         /**
-         * The background color that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description Exact match for the Hexadecimal background (text) color.
+         *
+         * @example "#FF5733"
+         *
+         * @regex "^$|^#[0-9a-fA-F]{6}$"
+         *
+         * @format May be empty, but if provided, must be a '#' followed by exactly 6 hex characters.
          *
          * @generated from field: string bg_color = 23;
          */
         this.bgColor = "";
         /**
-         * The ID of the associated non-leaf parent action code (0, if the first action code that is being created is a leaf action code)
+         *
+         * @optional
+         *
+         * @description Filter by specific ID of the parent action code. If this is set, then all the action codes that are associated to this parent action code are retrieved.
+         *
+         * @example 1024
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 parent_action_code_id = 26;
          */
         this.parentActionCodeId = protobuf_1.protoInt64.zero;
         /**
-         * Filter with the given leaf property
+         *
+         * @optional
+         *
+         * @description Filter by the given leaf property (TRUE, FALSE, ANY)
+         *
+         * @example ANY
          *
          * @generated from field: Scailo.BOOL_FILTER is_leaf = 27;
          */
@@ -696,103 +1082,244 @@ class ActionsCodesServiceCountReq 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 action code
+         *
+         * @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 name of the action code
+         *
+         * @optional
+         *
+         * @description Fuzzy match for the display name.
+         *
+         * @example "Technical Support"
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string name = 20;
          */
         this.name = "";
         /**
-         * The unique code by which the action code is classified
+         *
+         * @optional
+         *
+         * @description Exact match for the unique alphanumeric identifier.
+         *
+         * @example "TECH_SUP_01"
+         *
+         * @regex .*
+         *
+         * @format May contain any UTF-8 characters or be left empty.
          *
          * @generated from field: string code = 21;
          */
         this.code = "";
         /**
-         * The color of the text that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description Exact match for the Hexadecimal foreground (text) color.
+         *
+         * @example "#FFFFFF"
+         *
+         * @regex "^$|^#[0-9a-fA-F]{6}$"
+         *
+         * @format May be empty, but if provided, must be a '#' followed by exactly 6 hex characters.
          *
          * @generated from field: string fg_color = 22;
          */
         this.fgColor = "";
         /**
-         * The background color that is displayed for easy recognition
+         *
+         * @optional
+         *
+         * @description Exact match for the Hexadecimal background (text) color.
+         *
+         * @example "#FF5733"
+         *
+         * @regex "^$|^#[0-9a-fA-F]{6}$"
+         *
+         * @format May be empty, but if provided, must be a '#' followed by exactly 6 hex characters.
          *
          * @generated from field: string bg_color = 23;
          */
         this.bgColor = "";
         /**
-         * The ID of the associated non-leaf parent action code (0, if the first action code that is being created is a leaf action code)
+         *
+         * @optional
+         *
+         * @description Filter by specific ID of the parent action code. If this is set, then all the action codes that are associated to this parent action code are retrieved.
+         *
+         * @example 1024
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 parent_action_code_id = 26;
          */
         this.parentActionCodeId = protobuf_1.protoInt64.zero;
         /**
-         * Filter with the given leaf property
+         *
+         * @optional
+         *
+         * @description Filter by the given leaf property (TRUE, FALSE, ANY)
+         *
+         * @example ANY
          *
          * @generated from field: Scailo.BOOL_FILTER is_leaf = 27;
          */
@@ -844,61 +1371,129 @@ class ActionsCodesServiceSearchAllReq 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 return per page. **Critical:** Use `-1` to retrieve all records. A value of `0` will return no results. Default is `0`.
+         *
+         * @example 50
+         *
+         * @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 specific field key to sort the results by.
          *
          * @generated from field: Scailo.ACTION_CODE_SORT_KEY sort_key = 5;
          */
         this.sortKey = ACTION_CODE_SORT_KEY.ACTION_CODE_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.
+         *
+         * @example "Medical 2023"
+         *
+         * @regex .*
+         *
+         * @format: May contain any UTF-8 characters.
          *
          * @generated from field: string search_key = 11;
          */
         this.searchKey = "";
         /**
-         * The ID of the associated non-leaf parent action code (0, if the first action code that is being created is a leaf action code)
+         *
+         * @optional
+         *
+         * @description Filter by specific ID of the parent action code. If this is set, then all the action codes that are associated to this parent action code are retrieved.
+         *
+         * @example 1024
+         *
+         * @regex ^[0-9]+$
+         *
+         * @format Non-negative integer.
          *
          * @generated from field: uint64 parent_action_code_id = 25;
          */
         this.parentActionCodeId = protobuf_1.protoInt64.zero;
         /**
-         * Filter with the given leaf property
+         *
+         * @optional
+         *
+         * @description Filter by the given leaf property (TRUE, FALSE, ANY)
+         *
+         * @example ANY
          *
          * @generated from field: Scailo.BOOL_FILTER is_leaf = 26;
          */