@or-sdk/hitl 0.36.1 → 0.36.2

package/dist/types/api/Listeners.d.ts

@@ -1,162 +1,12 @@
 import { Listener, GetListenersOptions, GetListenerByIdOptions, GetListenersResponse, CreateListenersOptions, UpdateListenersOptions, DeleteListenersOptions } from '../types/listeners';
 import { HITLBase } from './HITLBase';
-/**
- * Manages HitL event listeners in the system
- *
- * This class provides functionality to manage event listeners, which can be:
- * - Active WebSocket connections in Agent UI
- * - Flow event subscription callbacks
- * - Mobile application push notification callbacks
- *
- * Key features:
- * - Retrieve listeners (all or by ID)
- * - Create new listeners
- * - Update existing listeners
- * - Delete listeners
- *
- * @remarks
- * - All methods in this class interact with the `/listeners` endpoint
- * @public
- */
 export declare class Listeners extends HITLBase {
     protected static MODULE_URL: string;
     protected static LISTENER_VERSION_FIELD: "listenerVersion";
-    /**
-     * Retrieves a list of HitL event listeners
-     *
-     * @param options - Configuration parameters for retrieving listeners
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetListenersResponse>} Promise resolving to the listeners list
-     *
-     * @example
-     * ```typescript
-     * const listeners = await hitlApi.listeners.getListeners();
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/listeners` endpoint
-     * @public
-     */
     static getListeners(options?: GetListenersOptions): Promise<GetListenersResponse>;
-    /**
-     * Retrieves a specific HitL event listener by ID
-     *
-     * @param options - Configuration parameters for retrieving the listener
-     *
-     * Required parameters:
-     * - `callbackId` - (string) ID of the listener to retrieve
-     *
-     * Optional parameters:
-     * - `agentId` - (string) Agent ID to filter by
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetListenersResponse>} Promise resolving to the listener details
-     *
-     * @example
-     * ```typescript
-     * const listener = await hitlApi.listeners.getListenerById({
-     *   callbackId: 'listener-1'
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/listeners/{callbackId}` endpoint
-     * @public
-     */
     static getListenerById({ agentId, callbackId, ...options }: GetListenerByIdOptions): Promise<GetListenersResponse>;
-    /**
-     * Creates a new HitL event listener
-     *
-     * @param options - Configuration parameters for creating the listener
-     *
-     * Required parameters:
-     * - `callback` - ({@link ListenerCallback}) Callback configuration for the listener
-     *
-     * Optional parameters:
-     * - `agentId` - (string) ID of the agent associated with the listener
-     * - `listenerVersion` - (number) Version of the listener
-     * - `sessionIds` - (string[]) Array of session IDs to associate with the listener
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `type` - (any) Type of the listener
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Listener>} Promise resolving to the created listener
-     *
-     * @example
-     * ```typescript
-     * const newListener = await hitlApi.listeners.createListener({
-     *   callback: {
-     *     type: "sync",
-     *     expire: 1750940155085,
-     *     name: "MxPMqfr4PHcCGCw=",
-     *     v: 0
-     *   }
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a POST request to the `/listeners` endpoint
-     * @public
-     */
     static createListener(options: CreateListenersOptions): Promise<Listener>;
-    /**
-     * Updates an existing HitL event listener
-     *
-     * @param options - Configuration parameters for updating the listener
-     *
-     * Required parameters:
-     * - `callbackId` - (string) ID of the listener to update
-     * - `sessionIds` - (string[]) list of subscribed sessions by this listener
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<Listener>} Promise resolving to the updated listener
-     *
-     * @example
-     * ```typescript
-     * const updatedListener = await hitlApi.listeners.updateListener({
-     *   callbackId: 'listener-1',
-     *   sessionIds: ['session-id-1']
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a PUT request to the `/listeners/{callbackId}` endpoint
-     * @public
-     */
     static updateListener({ callbackId, ...options }: UpdateListenersOptions): Promise<Listener>;
-    /**
-     * Deletes a HitL event listener
-     *
-     * @param options - Configuration parameters for deleting the listener
-     *
-     * Required parameters:
-     * - `callbackId` - (string) ID of the listener to delete
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise that resolves when deletion is complete
-     *
-     * @example
-     * ```typescript
-     * await hitlApi.listeners.deleteListener({
-     *   callbackId: 'listener-1',
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a DELETE request to the `/listeners/{callbackId}` endpoint
-     * @public
-     */
     static deleteListener({ callbackId, ...options }: DeleteListenersOptions): Promise<void>;
 }
 //# sourceMappingURL=Listeners.d.ts.map

package/dist/types/api/Listeners.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Listeners.d.ts","sourceRoot":"","sources":["../../../src/api/Listeners.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,QAAQ,EAGR,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACrC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAe;IAC1C,SAAS,CAAC,MAAM,CAAC,sBAAsB,oBAA8B;IAErE;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,eAAe,CACjC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC1D,OAAO,CAAC,oBAAoB,CAAC;IAYhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACiB,cAAc,CAChC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;IAiBpB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"Listeners.d.ts","sourceRoot":"","sources":["../../../src/api/Listeners.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,QAAQ,EAGR,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAoBtC,qBAAa,SAAU,SAAQ,QAAQ;IACrC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAe;IAC1C,SAAS,CAAC,MAAM,CAAC,sBAAsB,oBAA8B;WAsBjD,YAAY,CAC9B,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC;WAwCZ,eAAe,CACjC,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC1D,OAAO,CAAC,oBAAoB,CAAC;WA8CZ,cAAc,CAChC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;WA4CA,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,QAAQ,CAAC;WAwCA,cAAc,CAChC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GACjD,OAAO,CAAC,IAAI,CAAC;CAUjB"}

package/dist/types/api/Migrations.d.ts

@@ -1,241 +1,19 @@
 import { ApiVersionOptions } from '../types';
 import { GetMigrationsOptions, GetMigrationsResponse, RunMigrationsOptions, RunMigrationsResponse, CreateDefaultRecordsResponse, GetMigrationsInfoResponse, GetRunMigrationsStatusResponse, GetDefaultRecordsOptions, GetDefaultRecordsResponse, SyncDefaultRecordsOptions, SyncDefaultRecordsResponse } from '../types/migrations';
 import { HITLBase } from './HITLBase';
-/**
- * Manages database migrations and default records in the system
- *
- * This class provides functionality to:
- * - Manage database migrations
- * - Handle default records for tables
- * - Monitor migration status
- * - Control migration locks
- *
- * @remarks
- * - All methods in this class interact with the `/migrations` endpoint
- * @public
- */
 export declare class Migrations extends HITLBase {
     protected static readonly MODULE_URL = "migrations";
     protected static DEFAULT_RECORDS_URL: string;
     protected static MIGRATIONS_INFO_URL: string;
     protected static MIGRATIONS_LOCK_URL: string;
     protected static MIGRATIONS_STATUS_URL: string;
-    /**
-     * Retrieves a list of pending migrations
-     *
-     * @param options - Configuration parameters for retrieving migrations
-     *
-     * Optional parameters:
-     * - `appVersion` - (string) Application version to check migrations against
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetMigrationsResponse>} Promise resolving to the list of pending migrations
-     *
-     * @example
-     * ```typescript
-     * const migrations = await hitlApi.migrations.getListOfMigrations({
-     *   appVersion: '0.81.0',
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/migrations` endpoint
-     * @public
-     */
     static getListOfMigrations({ appVersion, ...options }?: GetMigrationsOptions): Promise<GetMigrationsResponse>;
-    /**
-     * Executes pending migrations
-     *
-     * @param options - Configuration parameters for running migrations
-     *
-     * Optional parameters:
-     * - `appVersion` - (string) Version of the application to migrate for
-     * - `meta` - (object) Additional metadata for the migration
-     * - `method` - ("up" | "down") Direction of migration, either "up" or "down"
-     * - `name` - (string) Name of specific migration to run
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise that resolves when migrations are complete
-     *
-     * @example
-     * ```typescript
-     * // Run all migrations up to latest version
-     * await migrationApi.runAllMigrations();
-     *
-     * // Run specific migration with metadata
-     * await migrationApi.runAllMigrations({
-     *   name: "27-create-contact-rule-groups-table",
-     *   method: "up",
-     *   meta: {
-     *     appVersion: "0.81.0",
-     *   }
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a POST request to the `/migrations` endpoint
-     * @public
-     */
     static runAllMigrations({ meta, ...options }?: RunMigrationsOptions): Promise<RunMigrationsResponse>;
-    /**
-     * Retrieves the current status of running migrations
-     *
-     * @param options - Configuration parameters
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetRunMigrationsStatusResponse>} Promise resolving to the migration status
-     *
-     * @example
-     * ```typescript
-     * const status = await hitlApi.migrations.getRunMigrationsStatus();
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/migrations/status` endpoint
-     * @public
-     */
     static getRunMigrationsStatus(options?: ApiVersionOptions): Promise<GetRunMigrationsStatusResponse>;
-    /**
-     * Removes the migrations table lock that is set during migration runs
-     *
-     * @param options - Configuration parameters
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise that resolves when the lock is deleted
-     *
-     * @example
-     * ```typescript
-     * await hitlApi.migrations.deleteMigrationsTableLock();
-     * ```
-     *
-     * @remarks
-     * Makes a DELETE request to the `/migrations/lock` endpoint
-     * @public
-     */
     static deleteMigrationsTableLock(options?: ApiVersionOptions): Promise<unknown>;
-    /**
-     * Retrieves migration compatibility information with UI versions
-     *
-     * @param options - Configuration parameters
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetMigrationsInfoResponse>} Promise resolving to the migrations compatibility info
-     *
-     * @example
-     * ```typescript
-     * const info = await hitlApi.migrations.getMigrationsInfo();
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/migrations/info` endpoint
-     * @public
-     */
     static getMigrationsInfo(options?: ApiVersionOptions): Promise<GetMigrationsInfoResponse>;
-    /**
-     * Retrieves default records for specific tables
-     *
-     * Supported tables:
-     * - settings
-     * - filters
-     * - event_templates
-     * - rule_groups
-     *
-     * @param options - Configuration parameters for retrieving default records
-     *
-     * Required parameters:
-     * - `tableName` - ({@link DEFAULT_DATA_TABLE_NAME}) Name of the table to retrieve default records from
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<GetDefaultRecordsResponse>} Promise resolving to the default records
-     *
-     * @example
-     * ```typescript
-     * const records = await hitlApi.migrations.getTableDefaultRecords({
-     *   tableName: 'EVENT_TEMPLATES'
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/migrations/default-records` endpoint
-     * @public
-     */
     static getTableDefaultRecords(options: GetDefaultRecordsOptions): Promise<GetDefaultRecordsResponse>;
-    /**
-     * Creates default records for specific tables
-     *
-     * Supported tables:
-     * - settings
-     * - filters
-     * - event_templates
-     * - rule_groups
-     *
-     * @param options - Configuration parameters
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<CreateDefaultRecordsResponse>} Promise resolving to the created records
-     *
-     * @example
-     * ```typescript
-     * const result = await hitlApi.migrations.createTableDefaultRecords();
-     * ```
-     *
-     * @remarks
-     * Makes a POST request to the `/migrations/default-records` endpoint
-     * @public
-     */
     static createTableDefaultRecords(options?: ApiVersionOptions): Promise<CreateDefaultRecordsResponse>;
-    /**
-     * Synchronizes default records for specific tables
-     *
-     * Supported tables:
-     * - settings
-     * - filters
-     * - event_templates
-     * - rule_groups
-     *
-     * @param options - Configuration parameters for syncing records
-     *
-     * Optional parameters:
-     * - `keys` - (string[]) Array of specific record keys to synchronize. If not provided, all records will be synchronized
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<SyncDefaultRecordsResponse>} Promise resolving to the sync results
-     *
-     * @example
-     * // Sync all default records
-     * await tableApi.syncTableDefaultRecords({
-     *   tableName: DEFAULT_DATA_TABLE_NAME.FILTERS
-     * });
-     *
-     * // Sync specific records by keys
-     * await tableApi.syncTableDefaultRecords({
-     *   tableName: DEFAULT_DATA_TABLE_NAME.FILTERS,
-     *   keys: ['filter-id-1', 'filter-id-3']
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a PUT request to the `/migrations/default-records` endpoint
-     * @public
-     */
     static syncTableDefaultRecords(options: SyncDefaultRecordsOptions): Promise<SyncDefaultRecordsResponse>;
 }
 //# sourceMappingURL=Migrations.d.ts.map

package/dist/types/api/Migrations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Migrations.d.ts","sourceRoot":"","sources":["../../../src/api/Migrations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAGL,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,yBAAyB,EACzB,8BAA8B,EAC9B,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,QAAQ;IACtC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IACpD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAqB;IACzD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAY;IAElD;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,mBAAmB,CACrC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAE,oBAAyB,GACpD,OAAO,CAAC,qBAAqB,CAAC;IAUjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;WACiB,gBAAgB,CAClC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAE,oBAAyB,GAC9C,OAAO,CAAC,qBAAqB,CAAC;IAejC;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,sBAAsB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAUpH;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,yBAAyB,CAAC,OAAO,GAAE,iBAAsB;IAW7E;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,iBAAiB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAU1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,sBAAsB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAejH;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,yBAAyB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAWrH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;WACiB,uBAAuB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAcrH"}
+{"version":3,"file":"Migrations.d.ts","sourceRoot":"","sources":["../../../src/api/Migrations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAGL,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,4BAA4B,EAC5B,yBAAyB,EACzB,8BAA8B,EAC9B,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAetC,qBAAa,UAAW,SAAQ,QAAQ;IACtC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IACpD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAqB;IACzD,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,mBAAmB,SAAU;IAC9C,SAAS,CAAC,MAAM,CAAC,qBAAqB,SAAY;WAyB9B,mBAAmB,CACrC,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAE,oBAAyB,GACpD,OAAO,CAAC,qBAAqB,CAAC;WA4Cb,gBAAgB,CAClC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAE,oBAAyB,GAC9C,OAAO,CAAC,qBAAqB,CAAC;WAmCb,sBAAsB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,8BAA8B,CAAC;WA8BhG,yBAAyB,CAAC,OAAO,GAAE,iBAAsB;WA+BzD,iBAAiB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,yBAAyB,CAAC;WAyCtF,sBAAsB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;WAyC7F,yBAAyB,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,4BAA4B,CAAC;WA8CjG,uBAAuB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAcrH"}

package/dist/types/api/RuleGroups.d.ts

@@ -1,137 +1,10 @@
 import { SearchRuleGroupsOptions, SearchRuleGroupsResponse, RuleGroup, CreateRuleGroupOptions, UpdateRuleGroupOptions, DeleteRuleGroupOptions } from '../types/rule-groups';
 import { HITLBase } from './HITLBase';
-/**
- * Manages rule groups in the system
- *
- * This class provides functionality to manage rule groups, including searching,
- * creating, updating, and deleting rule groups.
- *
- * Key features:
- * - Search and retrieve rule groups
- * - Create new rule groups
- * - Update existing rule groups
- * - Delete rule groups
- *
- * @remarks
- * - All methods in this class interact with the `/rule-groups` endpoint
- * @public
- */
 export declare class RuleGroups extends HITLBase {
     protected static MODULE_URL: string;
-    /**
-     * Searches for rule groups or retrieves specific groups
-     *
-     * @param options - Configuration parameters for the rule groups search
-     *
-     * Optional parameters:
-     * - `groupIdList` - (string[]) List of specific group IDs to retrieve
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<SearchRuleGroupsResponse | RuleGroup>} Promise resolving to:
-     * - Either a list of rule groups or a single rule group if specific ID is provided
-     *
-     * @example
-     * ```typescript
-     * // Search all rule groups
-     * const response = await hitlApi.ruleGroups.searchRuleGroups();
-     *
-     * // Search specific rule groups
-     * const groups = await hitlApi.ruleGroups.searchRuleGroups({
-     *   groupIdList: ['group-1', 'group-2']
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a GET request to the `/rule-groups` endpoint
-     * @public
-     */
     static searchRuleGroups({ groupIdList, ...options }?: SearchRuleGroupsOptions): Promise<SearchRuleGroupsResponse | RuleGroup>;
-    /**
-     * Creates a new rule group
-     *
-     * @param options - Configuration parameters for creating the rule group
-     *
-     * Required parameters:
-     * - `groupId` - (string) Unique identifier for the group
-     * - `name` - (string) Name of the rule group
-     * - `rules` - (RuleDefinition[]) Array of rules for the group
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<RuleGroup>} Promise resolving to the created rule group
-     *
-     * @example
-     * ```typescript
-     * const newGroup = await hitlApi.ruleGroups.createRuleGroup({
-     *   groupId: 'group-1',
-     *   name: 'Allow sms',
-     *   rules: ['sms']
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a POST request to the `/rule-groups` endpoint
-     * @public
-     */
     static createRuleGroup({ groupId, name, rules, ...options }: CreateRuleGroupOptions): Promise<RuleGroup>;
-    /**
-     * Updates an existing rule group
-     *
-     * @param options - Configuration parameters for updating the rule group
-     *
-     * Required parameters:
-     * - `groupId` - (string) ID of the group to update
-     * - `name` - (string) Updated name for the rule group
-     * - `rules` - (RuleDefinition[]) Updated array of rules
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<RuleGroup>} Promise resolving to the updated rule group
-     *
-     * @example
-     * ```typescript
-     * const updatedGroup = await hitlApi.ruleGroups.updateRuleGroup({
-     *   groupId: 'group-1',
-     *   name: 'Default sms',
-     *   rules: ['sms', 'hitl']
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a PUT request to the `/rule-groups` endpoint
-     * @public
-     */
     static updateRuleGroup({ groupId, name, rules, ...options }: UpdateRuleGroupOptions): Promise<RuleGroup>;
-    /**
-     * Deletes a rule group
-     *
-     * @param options - Configuration parameters for deleting the rule group
-     *
-     * Required parameters:
-     * - `groupId` - (string) ID of the group to delete
-     *
-     * Optional parameters:
-     * - `timeout` - (number) Request timeout in milliseconds
-     * - `version` - (string | number) API version to use
-     *
-     * @returns {Promise<void>} Promise that resolves when deletion is complete
-     *
-     * @example
-     * ```typescript
-     * await hitlApi.ruleGroups.deleteRuleGroup({
-     *   groupId: 'group-1'
-     * });
-     * ```
-     *
-     * @remarks
-     * Makes a DELETE request to the `/rule-groups` endpoint
-     * @public
-     */
     static deleteRuleGroup({ groupId, ...options }: DeleteRuleGroupOptions): Promise<void>;
 }
 //# sourceMappingURL=RuleGroups.d.ts.map

package/dist/types/api/RuleGroups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RuleGroups.d.ts","sourceRoot":"","sources":["../../../src/api/RuleGroups.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,UAAW,SAAQ,QAAQ;IACtC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;WACW,gBAAgB,CAC5B,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACxD,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAchD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,eAAe,CAC3B,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;IAerB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,eAAe,CAC3B,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;IAerB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACW,eAAe,CAC3B,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC9C,OAAO,CAAC,IAAI,CAAC;CAUjB"}
+{"version":3,"file":"RuleGroups.d.ts","sourceRoot":"","sources":["../../../src/api/RuleGroups.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,SAAS,EACT,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAkBtC,qBAAa,UAAW,SAAQ,QAAQ;IACtC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;WA8B9B,gBAAgB,CAC5B,EAAE,WAAW,EAAE,GAAG,OAAO,EAAE,GAAE,uBAA4B,GACxD,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;WA2ClC,eAAe,CAC3B,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;WA4CP,eAAe,CAC3B,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC3D,OAAO,CAAC,SAAS,CAAC;WAwCP,eAAe,CAC3B,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,sBAAsB,GAC9C,OAAO,CAAC,IAAI,CAAC;CAUjB"}