@or-sdk/hitl 0.36.2 → 0.36.3

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/hitl",
-  "version": "0.36.2",
+  "version": "0.36.3",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c0be7bf38017f5f90c179bf5990f548f03fddd4f"
+  "gitHead": "a419be0fc640fc0fbd68a1f99ff61219c210c63d"
 }

package/src/api/Sessions.ts

@@ -651,7 +651,7 @@ export class Sessions extends HITLBase {
    * @remarks Makes a POST request to `/sessions/{sessionId}/reopen`
    */
   public static async reopenSession(
-    options: ReopenSessionOptions,
+    { startedSessionId, ...options }: ReopenSessionOptions,
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl)
@@ -662,6 +662,7 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'POST',
       route,
+      params: { startedSessionId },
       ...this.getBaseSettings(options),
     });
   }