@onedeskpro/chatbot-types 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -78,7 +78,10 @@ interface ChatResponseData {
78
78
  sessionId: string;
79
79
  mode: ChatbotTicketMode;
80
80
  }
81
- /** Shared shape for `POST /sdk/human-request`, `GET /sdk/ticket-status`, and `ticket:status`. */
81
+ /**
82
+ * Shared shape for `POST /sdk/human-request`, `POST /sdk/human-request/cancel`,
83
+ * `POST /sdk/conversation/close`, `GET /sdk/ticket-status`, and `ticket:status`.
84
+ */
82
85
  interface TicketStatusData {
83
86
  mode: ChatbotTicketMode;
84
87
  conversationId?: string;
@@ -125,10 +128,13 @@ type ChatbotEventMap = {
125
128
  open: void;
126
129
  close: void;
127
130
  error: Error;
131
+ /** Fired when the chat is cleared for a new conversation (`resetSession` or `startNewConversation`). */
128
132
  'session-reset': void;
129
133
  ready: void;
130
134
  /** Fired after a successful `POST /sdk/human-request`. */
131
135
  'human-requested': void;
136
+ /** Fired when `cancelHumanRequest` handed the conversation back to the AI. */
137
+ 'human-request-cancelled': void;
132
138
  /** Fired when ticket mode changes via REST restore or `/sdk` socket push. */
133
139
  'ticket-status': TicketStatusData;
134
140
  };
package/dist/index.d.ts CHANGED
@@ -78,7 +78,10 @@ interface ChatResponseData {
78
78
  sessionId: string;
79
79
  mode: ChatbotTicketMode;
80
80
  }
81
- /** Shared shape for `POST /sdk/human-request`, `GET /sdk/ticket-status`, and `ticket:status`. */
81
+ /**
82
+ * Shared shape for `POST /sdk/human-request`, `POST /sdk/human-request/cancel`,
83
+ * `POST /sdk/conversation/close`, `GET /sdk/ticket-status`, and `ticket:status`.
84
+ */
82
85
  interface TicketStatusData {
83
86
  mode: ChatbotTicketMode;
84
87
  conversationId?: string;
@@ -125,10 +128,13 @@ type ChatbotEventMap = {
125
128
  open: void;
126
129
  close: void;
127
130
  error: Error;
131
+ /** Fired when the chat is cleared for a new conversation (`resetSession` or `startNewConversation`). */
128
132
  'session-reset': void;
129
133
  ready: void;
130
134
  /** Fired after a successful `POST /sdk/human-request`. */
131
135
  'human-requested': void;
136
+ /** Fired when `cancelHumanRequest` handed the conversation back to the AI. */
137
+ 'human-request-cancelled': void;
132
138
  /** Fired when ticket mode changes via REST restore or `/sdk` socket push. */
133
139
  'ticket-status': TicketStatusData;
134
140
  };
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@onedeskpro/chatbot-types",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "Shared TypeScript types for the Onedesk Pro Chatbot SDK",
5
5
  "license": "MIT",
6
6
  "author": "Typetech IT <support@onedeskpro.com>",
7
- "homepage": "https://github.com/onedeskpro/onedeskpro-chatbot-sdk#readme",
7
+ "homepage": "https://github.com/onedeskpro/onedeskpro-chatbot#readme",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": "git+https://github.com/onedeskpro/onedeskpro-chatbot-sdk.git",
10
+ "url": "git+https://github.com/onedeskpro/onedeskpro-chatbot.git",
11
11
  "directory": "packages/shared-types"
12
12
  },
13
13
  "bugs": {
14
- "url": "https://github.com/onedeskpro/onedeskpro-chatbot-sdk/issues"
14
+ "url": "https://github.com/onedeskpro/onedeskpro-chatbot/issues"
15
15
  },
16
16
  "keywords": [
17
17
  "onedeskpro",