@or-sdk/hitl 0.36.5 → 0.37.0-beta.4142.0

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

@@ -1,19 +1,241 @@
 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,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"}
+{"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"}

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

@@ -1,10 +1,137 @@
 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;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"}
+{"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"}

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

@@ -0,0 +1,177 @@
+import { ScheduledMessage, GetScheduledMessagesOptions, GetScheduledMessagesResponse, CreateScheduledMessageOptions, UpdateScheduledMessageOptions, DeleteScheduledMessageOptions } from '../types/scheduled-messages';
+import { HITLBase } from './HITLBase';
+/**
+ * Manages scheduled messages in the system
+ *
+ * This class provides functionality to create, retrieve, update, and delete scheduled messages.
+ * Scheduled messages are messages that can be sent at a specific time to contacts and sessions.
+ *
+ * Key features:
+ * - Schedule messages for future delivery
+ * - Target specific contacts and sessions
+ * - Support for various channel types for messages
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * // Get all scheduled messages
+ * const messages = await hitlApi.scheduledMessages.getScheduledMessages();
+ *
+ * // Create a new scheduled message
+ * const newMessage = await hitlApi.scheduledMessages.createScheduledMessage({
+ *   message: {
+ *     message: 'Hello! This is a scheduled message.',
+ *     media: []
+ *   },
+ *   type: 'SMS',
+ *   contactIds: ['contact-1', 'contact-2'],
+ *   timestamp: new Date('2024-12-25T10:00:00Z').toISOString()
+ * });
+ * ```
+ *
+ * @remarks
+ * - All methods in this class interact with the `/scheduled-messages` endpoint
+ * - These methods are available only when you pass `{ version: 1 }` in the parameters.
+ * @public
+ */
+export declare class ScheduledMessages extends HITLBase {
+    protected static MODULE_URL: string;
+    /**
+     * Gets a list of scheduled messages
+     *
+     * @param options - Configuration parameters for the scheduled messages list request
+     *
+     * Optional parameters:
+     * - `id` - (string) Get specific scheduled message by ID
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetScheduledMessagesResponse | ScheduledMessage>} Promise resolving to:
+     * - `data` - Array of scheduled message objects {@link ScheduledMessage}
+     *
+     * @example
+     * ```typescript
+     * const response = await hitlApi.scheduledMessages.getScheduledMessages({
+     *   id: 'message-id-1'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/scheduled-messages` endpoint
+     * @public
+     */
+    static getScheduledMessages(options?: GetScheduledMessagesOptions): Promise<GetScheduledMessagesResponse | ScheduledMessage>;
+    /**
+     * Creates a new scheduled message
+     *
+     * @param options - Configuration parameters for creating the scheduled message
+     *
+     * Required parameters:
+     * - `message` - (Message) Message content and media
+     * - `type` - (string) Type of the scheduled message
+     * - `contactIds` - (string[]) Array of contact IDs to send the message to
+     * - `timestamp` - (Date) When the message should be sent
+     *
+     * Optional parameters:
+     * - `sessionId` - (string) Session ID to associate with
+     * - `toIdentifier` - (string) Identifier for message targeting
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<ScheduledMessage>} Promise resolving to the created scheduled message
+     *
+     * @example
+     * ```typescript
+     * const newMessage = await hitlApi.scheduledMessages.createScheduledMessage({
+     *   message: {
+     *     message: 'Your appointment is tomorrow at 3 PM',
+     *     media: [
+     *       {
+     *         type: 'image',
+     *         url: 'https://example.com/reminder.jpg'
+     *       }
+     *     ]
+     *   },
+     *   type: 'SMS',
+     *   contactIds: ['contact-123'],
+     *   timestamp: new Date('2024-12-24T15:00:00Z').toISOString(),
+     *   sessionId: 'session-456'
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/scheduled-messages` endpoint
+     * @public
+     */
+    static createScheduledMessage(options: CreateScheduledMessageOptions): Promise<ScheduledMessage>;
+    /**
+     * Updates an existing scheduled message
+     *
+     * @param options - Configuration parameters for updating the scheduled message
+     *
+     * Required parameters:
+     * - `id` - (string) Unique identifier of the message to update
+     *
+     * Optional parameters:
+     * - `message` - (Message) Updated message content and media
+     * - `type` - (string) Updated type of the scheduled message
+     * - `contactIds` - (string[]) Updated array of contact IDs
+     * - `sessionId` - (string) Updated session ID
+     * - `toIdentifier` - (string) Updated identifier for message targeting
+     * - `timestamp` - (Date) Updated send time
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * System fields (automatically managed):
+     * - `createdAt` - (Date) Creation timestamp
+     * - `updatedAt` - (Date) Last update timestamp
+     * - `agentId` - (string) Agent who created the message
+     * - `status` - (string) Current status of the message
+     *
+     * @returns {Promise<ScheduledMessage>} Promise resolving to the updated scheduled message
+     *
+     * @example
+     * ```typescript
+     * const updatedMessage = await hitlApi.scheduledMessages.updateScheduledMessage({
+     *   id: "msg-id-1",
+     *   message: {
+     *     message: "Updated reminder: Your appointment is at 4 PM",
+     *     media: []
+     *   },
+     *   timestamp: new Date('2024-12-24T16:00:00Z').toISOString()
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a PUT request to the `/scheduled-messages` endpoint
+     * @public
+     */
+    static updateScheduledMessage(options: UpdateScheduledMessageOptions): Promise<ScheduledMessage>;
+    /**
+     * Deletes a scheduled message
+     *
+     * @param options - Configuration parameters for deleting the scheduled message
+     *
+     * Required parameters:
+     * - `id` - (string) Unique identifier of the message to delete
+     *
+     * Optional parameters:
+     * - `version` - (string | number) API version to use
+     * - `timeout` - (number) Request timeout in milliseconds
+     *
+     * @returns {Promise<void>} Promise that resolves when deletion is complete
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.scheduledMessages.deleteScheduledMessage({
+     *   id: "msg-id-1"
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a DELETE request to the `/scheduled-messages` endpoint
+     * @public
+     */
+    static deleteScheduledMessage({ id, ...options }: DeleteScheduledMessageOptions): Promise<void>;
+}
+//# sourceMappingURL=ScheduledMessages.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ScheduledMessages.d.ts","sourceRoot":"","sources":["../../../src/api/ScheduledMessages.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,qBAAa,iBAAkB,SAAQ,QAAQ;IAC7C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAwB;IAEnD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,oBAAoB,CACtC,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,GAAG,gBAAgB,CAAC;IAc3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;WACiB,sBAAsB,CACxC,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,gBAAgB,CAAC;IAc5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;WACiB,sBAAsB,CACxC,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,gBAAgB,CAAC;IAc5B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,sBAAsB,CACxC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,6BAA6B,GAChD,OAAO,CAAC,IAAI,CAAC;CAUjB"}