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

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

@@ -1,7 +1,46 @@
 import { RunTaskOptions } from '../types/tasks';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages asynchronous task execution in the system
+ *
+ * This class provides functionality to:
+ * - Execute various system tasks like event sending, broadcasting, sharing cards to agents, etc.
+ *
+ * @remarks
+ * - All methods in this class interact with the `/tasks` endpoint
+ * @public
+ */
 export declare class Tasks extends HITLBase {
     protected static MODULE_URL: string;
+    /**
+     * Executes a specified task with provided data
+     *
+     * @param options - Configuration parameters for task execution
+     *
+     * Required parameters:
+     * - `task` - (string) The type/name of task to execute
+     * - `data` - (object) Task-specific data required for execution
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<void>} Promise that resolves when the task is initiated
+     *
+     * @example
+     * ```typescript
+     * await hitlApi.tasks.runTask({
+     *   task: 'shareCardsToAgents',
+     *   data: {
+     *     cardIds: ['card-id-1', 'card-id-2'],
+     *   }
+     * });
+     * ```
+     *
+     * @remarks
+     * Makes a POST request to the `/tasks` endpoint
+     * @public
+     */
     static runTask({ task, data, ...options }: RunTaskOptions): Promise<void>;
 }
 //# sourceMappingURL=Tasks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Tasks.d.ts","sourceRoot":"","sources":["../../../src/api/Tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAYtC,qBAAa,KAAM,SAAQ,QAAQ;IACjC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAW;WA+BlB,OAAO,CACzB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,cAAc,GACzC,OAAO,CAAC,IAAI,CAAC;CAWjB"}
+{"version":3,"file":"Tasks.d.ts","sourceRoot":"","sources":["../../../src/api/Tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;GASG;AACH,qBAAa,KAAM,SAAQ,QAAQ;IACjC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAW;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,OAAO,CACzB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,cAAc,GACzC,OAAO,CAAC,IAAI,CAAC;CAWjB"}

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

@@ -1,12 +1,92 @@
 import { ApiVersionOptions } from '../types';
 import { GetVersionsListResponse, GetVersionInfoResponse, GetStepsToUIVersionsMapOptions } from '../types/versions';
 import { HITLBase } from './HITLBase';
+/**
+ * Manages UI version information and compatibility
+ *
+ * This class provides functionality to:
+ * - Retrieve available UI versions
+ * - Get detailed version information
+ *
+ * Key features:
+ * - List all available UI versions
+ * - Get specific version details
+ *
+ * @remarks
+ * - All methods in this class interact with the `/ui-versions` endpoint
+ * @public
+ */
 export declare class Versions extends HITLBase {
     protected static MODULE_URL: string;
     protected static VERSION_INFO: string;
     protected static STEPS_TO_UI_VERSIONS_MAP: string;
+    /**
+     * Retrieves a list of available UI versions
+     *
+     * @param options - Configuration parameters for retrieving versions
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetVersionsListResponse>} Promise resolving to the list of available versions
+     *
+     * @example
+     * ```typescript
+     * const versions = await hitlApi.versions.getVersionsList();
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/ui-versions` endpoint
+     * @public
+     */
     static getVersionsList(options: ApiVersionOptions): Promise<GetVersionsListResponse>;
+    /**
+     * Retrieves detailed information about the last available version of HitL UI
+     *
+     * @param options - Configuration parameters for retrieving version information
+     *
+     * Optional parameters:
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetVersionInfoResponse>} Promise resolving to the version information
+     *
+     * @example
+     * ```typescript
+     * const versionInfo = await hitlApi.versions.getVersionInfo();
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/ui-versions/version-info` endpoint
+     * @public
+     */
     static getVersionInfo(options: ApiVersionOptions): Promise<GetVersionInfoResponse>;
+    /**
+     * Retrieves information about the compatibility of steps to UI versions
+     *
+     * @param options - Configuration parameters for retrieving steps to UI versions map
+     *
+     * Optional parameters:
+     * - `stepName` - (string) The name of the step to retrieve mapping information for
+     * - `timeout` - (number) Request timeout in milliseconds
+     * - `version` - (string | number) API version to use
+     *
+     * @returns {Promise<GetStepsToUIVersionsMapResponse>} Promise resolving to steps to UI versions map
+     *
+     * @example
+     * ```typescript
+     * const stepsToUIVesionsMap = await hitlApi.versions.getStepsToUIVersionsMap();
+     * ```
+     *
+     * ```typescript
+     * const stepToUIVesionsMap = await hitlApi.versions.getStepsToUIVersionsMap({ stepName });
+     * ```
+     *
+     * @remarks
+     * Makes a GET request to the `/ui-versions/steps-to-ui-map` endpoint
+     * @public
+     */
     static getStepsToUIVersionsMap({ stepName, ...options }: GetStepsToUIVersionsMapOptions): Promise<object>;
 }
 //# sourceMappingURL=Versions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Versions.d.ts","sourceRoot":"","sources":["../../../src/api/Versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAiBtC,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;IAC5C,SAAS,CAAC,MAAM,CAAC,YAAY,SAAkB;IAC/C,SAAS,CAAC,MAAM,CAAC,wBAAwB,SAAqB;WAsB1C,eAAe,CACjC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,uBAAuB,CAAC;WA6Bf,cAAc,CAChC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,sBAAsB,CAAC;WAmCd,uBAAuB,CACzC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,8BAA8B,GACvD,OAAO,CAAC,MAAM,CAAC;CAUnB"}
+{"version":3,"file":"Versions.d.ts","sourceRoot":"","sources":["../../../src/api/Versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;IAC5C,SAAS,CAAC,MAAM,CAAC,YAAY,SAAkB;IAC/C,SAAS,CAAC,MAAM,CAAC,wBAAwB,SAAqB;IAE9D;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,eAAe,CACjC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,uBAAuB,CAAC;IASnC;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,cAAc,CAChC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAUlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,uBAAuB,CACzC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,8BAA8B,GACvD,OAAO,CAAC,MAAM,CAAC;CAUnB"}

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

@@ -17,4 +17,5 @@ export { Versions } from './Versions';
 export { Tasks } from './Tasks';
 export { SessionRelations } from './SessionRelations';
 export { Contacts } from './Contacts';
+export { ScheduledMessages } from './ScheduledMessages';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/types/types/agents.d.ts

@@ -51,7 +51,10 @@ export interface SetAgentStatusOptions extends ApiVersionOptions, NoAccountId<Ag
 export interface UpdateAgentsStatusByQueryOptions extends ApiVersionOptions, NoAccountId<Agents.IUpdateAgentsStatusQuery>, Agents.IUpdateAgentsStatusBody {
     readonly maxRetries?: number;
 }
+/** Agent status enumeration defining possible states of an agent */
 export { AGENT_STATUS };
+/** Events that can be broadcast related to agents */
 export { AGENT_BROADCAST_EVENTS };
+/** Available user role types */
 export { USER_ROLE };
 //# sourceMappingURL=agents.d.ts.map

package/dist/types/types/agents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../../src/types/agents.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,YAAY,EACZ,sBAAsB,EACtB,SAAS,EACV,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,WAAW;CAAG;AAC1D,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,sBAAsB;CAAG;AAE/E,MAAM,WAAW,KAAM,SAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;CACzB;AACD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,oBAAoB;CAAG;AAElF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACd,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,gBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;CAAG;AAE5C,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,2BAA2B,EAClC,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAEpD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,mBACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,iBAAiB;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,kBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAClC,MAAM,CAAC,aAAa;CAAE;AAE1B,MAAM,WAAW,6BACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,4BACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAGpD,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,WAAW;CAAG;AACrE,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SACrC,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACxC,MAAM,CAAC,mBAAmB;IACxB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,UAAU,EAAE,WAAW,CAAA;CACxB;AAEH,MAAM,WAAW,gCAAiC,SAChD,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,wBAAwB,CAAC,EAC5C,MAAM,CAAC,uBAAuB;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAGD,OAAO,EAAE,YAAY,EAAE,CAAC;AAGxB,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAGlC,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../../src/types/agents.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,YAAY,EACZ,sBAAsB,EACtB,SAAS,EACV,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,WAAW;CAAG;AAC1D,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,sBAAsB;CAAG;AAE/E,MAAM,WAAW,KAAM,SAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;CACzB;AACD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,oBAAoB;CAAG;AAElF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACd,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,gBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;CAAG;AAE5C,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,2BAA2B,EAClC,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAEpD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,mBACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,iBAAiB;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,kBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAClC,MAAM,CAAC,aAAa;CAAE;AAE1B,MAAM,WAAW,6BACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,4BACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAGpD,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,WAAW;CAAG;AACrE,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SACrC,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACxC,MAAM,CAAC,mBAAmB;IACxB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,UAAU,EAAE,WAAW,CAAA;CACxB;AAEH,MAAM,WAAW,gCAAiC,SAChD,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,wBAAwB,CAAC,EAC5C,MAAM,CAAC,uBAAuB;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,oEAAoE;AACpE,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB,qDAAqD;AACrD,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAElC,gCAAgC;AAChC,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/types/types/index.d.ts

@@ -18,4 +18,5 @@ export * as Versions from './versions';
 export * as Tasks from './tasks';
 export * as SessionRelations from './session-relations';
 export * as Contacts from './contacts';
+export * as ScheduledMessages from './scheduled-messages';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,aAAa,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,aAAa,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAC"}

package/dist/types/types/scheduled-messages.d.ts

@@ -0,0 +1,16 @@
+import { ScheduledMessages } from '@onereach/types-hitl-api';
+import { ApiVersionOptions, NoAccountId } from './common';
+export interface ScheduledMessage extends ScheduledMessages.IScheduledMessage {
+}
+export interface GetScheduledMessagesOptions extends ApiVersionOptions, NoAccountId<ScheduledMessages.IGetScheduledMessagesQuery> {
+}
+export interface GetScheduledMessagesResponse extends ScheduledMessages.IGetScheduledMessagesResponse {
+    data: ScheduledMessage[];
+}
+export interface CreateScheduledMessageOptions extends ApiVersionOptions, ScheduledMessages.ICreateScheduledMessageBody {
+}
+export interface UpdateScheduledMessageOptions extends ApiVersionOptions, ScheduledMessages.IUpdateScheduledMessageBody {
+}
+export interface DeleteScheduledMessageOptions extends ApiVersionOptions, NoAccountId<ScheduledMessages.IDeleteScheduledMessageQuery> {
+}
+//# sourceMappingURL=scheduled-messages.d.ts.map

package/dist/types/types/scheduled-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-messages.d.ts","sourceRoot":"","sources":["../../../src/types/scheduled-messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,CAAC,iBAAiB;CAAG;AAEhF,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB,EACpE,WAAW,CAAC,iBAAiB,CAAC,0BAA0B,CAAC;CAAG;AAE9D,MAAM,WAAW,4BACf,SAAQ,iBAAiB,CAAC,6BAA6B;IACvD,IAAI,EAAE,gBAAgB,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,iBAAiB,CAAC,2BAA2B;CAAG;AAElD,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,iBAAiB,CAAC,2BAA2B;CAAG;AAElD,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,WAAW,CAAC,iBAAiB,CAAC,4BAA4B,CAAC;CAAG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/hitl",
-  "version": "0.36.5",
+  "version": "0.37.0-beta.4142.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -18,7 +18,7 @@
     "dev": "pnpm build:watch:esm"
   },
   "dependencies": {
-    "@onereach/types-hitl-api": "1.0.4-rc.4",
+    "@onereach/types-hitl-api": "1.0.6-rc.3",
     "@or-sdk/base": "^0.44.2",
     "urijs": "^1.19.8"
   },
@@ -29,6 +29,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "475a8aa2633c34c73873ec04ba593e0c56b90135"
+  }
 }

package/src/HITL.ts

@@ -20,6 +20,7 @@ import {
   Tasks,
   SessionRelations,
   Contacts,
+  ScheduledMessages,
 } from './api';
 import { AppError } from './AppError';
 import { SERVICE_KEY } from './constants';
@@ -53,6 +54,7 @@ export class HITL extends Base {
   public readonly tasks: typeof Tasks;
   public readonly sessionRelations: typeof SessionRelations;
   public readonly contacts: typeof Contacts;
+  public readonly scheduledMessages: typeof ScheduledMessages;
 
   /**
    * ```typescript
@@ -89,6 +91,7 @@ export class HITL extends Base {
     this.tasks = Tasks.configure(request);
     this.sessionRelations = SessionRelations.configure(request);
     this.contacts = Contacts.configure(request);
+    this.scheduledMessages = ScheduledMessages.configure(request);
   }
 
   public parseError(e: AxiosError<AppErrorObject>): AppError {

package/src/api/ScheduledMessages.ts

@@ -0,0 +1,244 @@
+import { DEFAULT_OMIT_FIELDS } from '../constants';
+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 class ScheduledMessages extends HITLBase {
+  protected static MODULE_URL = 'scheduled-messages';
+
+  /**
+   * 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
+   */
+  public static async getScheduledMessages(
+    options: GetScheduledMessagesOptions = {},
+  ): Promise<GetScheduledMessagesResponse | ScheduledMessage> {
+    const route = this.getBaseUrl(options);
+    const params = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
+    );
+
+    return this.request({
+      method: 'GET',
+      route,
+      params,
+      ...this.getBaseSettings(options),
+    });
+  }
+
+  /**
+   * 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
+   */
+  public static async createScheduledMessage(
+    options: CreateScheduledMessageOptions,
+  ): Promise<ScheduledMessage> {
+    const route = this.getBaseUrl(options);
+    const data = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
+    );
+
+    return this.request({
+      method: 'POST',
+      route,
+      data,
+      ...this.getBaseSettings(options),
+    });
+  }
+
+  /**
+   * 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
+   */
+  public static async updateScheduledMessage(
+    options: UpdateScheduledMessageOptions,
+  ): Promise<ScheduledMessage> {
+    const route = this.getBaseUrl(options);
+    const data = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
+    );
+
+    return this.request({
+      method: 'PUT',
+      route,
+      data,
+      ...this.getBaseSettings(options),
+    });
+  }
+
+  /**
+   * 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
+   */
+  public static async deleteScheduledMessage(
+    { id, ...options }: DeleteScheduledMessageOptions,
+  ): Promise<void> {
+    const route = this.getBaseUrl(options);
+
+    return this.request({
+      method: 'DELETE',
+      route,
+      params: { id },
+      ...this.getBaseSettings(options),
+    });
+  }
+}

package/src/api/index.ts

@@ -17,3 +17,4 @@ export { Versions } from './Versions';
 export { Tasks } from './Tasks';
 export { SessionRelations } from './SessionRelations';
 export { Contacts } from './Contacts';
+export { ScheduledMessages } from './ScheduledMessages';

package/src/types/index.ts

@@ -18,3 +18,4 @@ export * as Versions from './versions';
 export * as Tasks from './tasks';
 export * as SessionRelations from './session-relations';
 export * as Contacts from './contacts';
+export * as ScheduledMessages from './scheduled-messages';

package/src/types/scheduled-messages.ts

@@ -0,0 +1,23 @@
+import { ScheduledMessages } from '@onereach/types-hitl-api';
+
+import { ApiVersionOptions, NoAccountId } from './common';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface ScheduledMessage extends ScheduledMessages.IScheduledMessage {}
+
+export interface GetScheduledMessagesOptions extends ApiVersionOptions,
+  NoAccountId<ScheduledMessages.IGetScheduledMessagesQuery> {}
+
+export interface GetScheduledMessagesResponse
+  extends ScheduledMessages.IGetScheduledMessagesResponse {
+  data: ScheduledMessage[];
+}
+
+export interface CreateScheduledMessageOptions extends ApiVersionOptions,
+  ScheduledMessages.ICreateScheduledMessageBody {}
+
+export interface UpdateScheduledMessageOptions extends ApiVersionOptions,
+  ScheduledMessages.IUpdateScheduledMessageBody {}
+
+export interface DeleteScheduledMessageOptions extends ApiVersionOptions,
+  NoAccountId<ScheduledMessages.IDeleteScheduledMessageQuery> {}