@cimulate/copilot-sdk 3.10.1 → 3.12.0

package/dist/types/model/AskCim.d.ts

@@ -0,0 +1,6 @@
+import { Attachments } from './Attachments';
+interface AskCim {
+    userPrompt: string;
+    attachments?: Attachments;
+}
+export { AskCim };

package/dist/types/model/AskCimAck.d.ts

@@ -0,0 +1,10 @@
+import { AskCim } from './AskCim';
+interface AskCimAck {
+    name: 'ask_cim';
+    request: AskCim;
+    sessionId: string;
+    id: string;
+    createdAt: string;
+    status: number;
+}
+export { AskCimAck };

package/dist/types/model/Attachments.d.ts

@@ -0,0 +1,4 @@
+interface Attachments {
+    image?: string;
+}
+export { Attachments };

package/dist/types/model/CopilotApiAck.d.ts

@@ -2,6 +2,7 @@
  This not generated automatically by the generate model script.
  For any new event, manually create an entry here.
  */
+import { AskCimAck } from "./AskCimAck";
 import { CancelAck } from "./CancelAck";
 import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotBrowseAck } from "./CopilotBrowseAck";
@@ -9,4 +10,4 @@ import { CopilotError } from "./CopilotError";
 import { CopilotSearchAck } from "./CopilotSearchAck";
 import { FacetedNavigationAck } from "./FacetedNavigationAck";
 import { ProductViewAck } from "./ProductViewAck";
-export type CopilotAPIAck = CancelAck | CopilotBrowseAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | ProductViewAck | CopilotError;
+export type CopilotAPIAck = AskCimAck | CancelAck | CopilotBrowseAck | CopilotSearchAck | ConversationResetAck | FacetedNavigationAck | ProductViewAck | CopilotError;

package/dist/types/model/CopilotBrowse.d.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { BrowseParams } from './BrowseParams';
 interface CopilotBrowse {
     browseParams: BrowseParams;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { CopilotBrowse };

package/dist/types/model/CopilotSearch.d.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { SearchParams } from './SearchParams';
 interface CopilotSearch {
     searchParams: SearchParams;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { CopilotSearch };

package/dist/types/model/ProductView.d.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 interface ProductView {
     productId: string;
     pdpLink?: string;
     userPrompt?: string;
+    attachments?: Attachments;
 }
 export { ProductView };

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

@@ -1,3 +1,6 @@
+export * from './AskCim';
+export * from './AskCimAck';
+export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
 export * from './CancelAck';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cimulate/copilot-sdk",
-  "version": "3.10.1",
+  "version": "3.12.0",
   "description": "A lightweight API client SDK for Cimulate Copilot",
   "files": [
     "dist/**",

package/src/copilot.ts

@@ -2,6 +2,8 @@ import io, { ManagerOptions, Socket, SocketOptions } from "socket.io-client";
 
 import deepmerge from "deepmerge";
 import type {
+  AskCim,
+  AskCimAck,
   Cancel,
   CancelAck,
   CopilotAPIAck,
@@ -313,6 +315,24 @@ export default class CimulateCopilot<
     );
   }
 
+  async askCim(
+    args: AskCim
+  ): Promise<CopilotResult<T, AskCimAck>>;
+  async askCim(
+    args: AskCim,
+    callback?: (event: AskCimAck) => void
+  ): Promise<void>;
+  async askCim(
+    args: AskCim,
+    callback?: (event: AskCimAck) => void
+  ): Promise<CopilotResult<T, AskCimAck> | void> {
+    return this.asyncResponse<AskCim, AskCimAck>(
+      "ask_cim",
+      args,
+      callback
+    );
+  }
+
   async requestSessionInformation(): Promise<
     CopilotResult<T, SessionInformation>
   >;

package/src/model/AskCim.ts

@@ -0,0 +1,6 @@
+import { Attachments } from './Attachments';
+interface AskCim {
+  userPrompt: string;
+  attachments?: Attachments;
+}
+export { AskCim };

package/src/model/AskCimAck.ts

@@ -0,0 +1,10 @@
+import { AskCim } from './AskCim';
+interface AskCimAck {
+  name: 'ask_cim';
+  request: AskCim;
+  sessionId: string;
+  id: string;
+  createdAt: string;
+  status: number;
+}
+export { AskCimAck };

package/src/model/Attachments.ts

@@ -0,0 +1,5 @@
+
+interface Attachments {
+  image?: string;
+}
+export { Attachments };

package/src/model/CopilotApiAck.ts

@@ -2,6 +2,7 @@
  This not generated automatically by the generate model script.
  For any new event, manually create an entry here.
  */
+import { AskCimAck } from "./AskCimAck";
 import { CancelAck } from "./CancelAck";
 import { ConversationResetAck } from "./ConversationResetAck";
 import { CopilotBrowseAck } from "./CopilotBrowseAck";
@@ -11,6 +12,7 @@ import { FacetedNavigationAck } from "./FacetedNavigationAck";
 import { ProductViewAck } from "./ProductViewAck";
 
 export type CopilotAPIAck =
+  | AskCimAck
   | CancelAck
   | CopilotBrowseAck
   | CopilotSearchAck

package/src/model/CopilotBrowse.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { BrowseParams } from './BrowseParams';
 interface CopilotBrowse {
   browseParams: BrowseParams;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { CopilotBrowse };

package/src/model/CopilotSearch.ts

@@ -1,6 +1,8 @@
+import { Attachments } from './Attachments';
 import { SearchParams } from './SearchParams';
 interface CopilotSearch {
   searchParams: SearchParams;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { CopilotSearch };

package/src/model/ProductView.ts

@@ -1,7 +1,8 @@
-
+import { Attachments } from './Attachments';
 interface ProductView {
   productId: string;
   pdpLink?: string;
   userPrompt?: string;
+  attachments?: Attachments;
 }
 export { ProductView };

package/src/model/index.ts

@@ -1,3 +1,6 @@
+export * from './AskCim';
+export * from './AskCimAck';
+export * from './Attachments';
 export * from './BrowseParams';
 export * from './Cancel';
 export * from './CancelAck';