Exposed more documentation modules.

chatbotkit · Nov 27, 2023 · 6e10d92 · 6e10d92
1 parent 2c489bc
commit 6e10d92
Show file tree

Hide file tree

Showing 37 changed files with 773 additions and 100 deletions.
diff --git a/packages/sdk/docs/classes/bot.BotClient.md b/packages/sdk/docs/classes/bot.BotClient.md
@@ -4,9 +4,7 @@
 
 [bot](../modules/bot.md).BotClient
 
-**`Template`**
-
-**`Template`**
+Bot client.
 
 ## Hierarchy
 
@@ -20,6 +18,10 @@
 
 - [constructor](bot.BotClient.md#constructor)
 
+### Properties
+
+- [session](bot.BotClient.md#session)
+
 ### Methods
 
 - [clientFetch](bot.BotClient.md#clientfetch)
@@ -51,7 +53,17 @@
 
 #### Defined in
 
-[bot/index.js:15](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L15)
+[bot/index.js:18](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L18)
+
+## Properties
+
+### session
+
+• **session**: [`BotSessionClient`](bot_session.BotSessionClient.md)
+
+#### Defined in
+
+[bot/index.js:24](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L24)
 
 ## Methods
 
@@ -111,7 +123,7 @@ Creates a new bot.
 
 #### Defined in
 
-[bot/index.js:47](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L47)
+[bot/index.js:53](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L53)
 
 ___
 
@@ -133,7 +145,7 @@ Deletes the bot.
 
 #### Defined in
 
-[bot/index.js:68](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L68)
+[bot/index.js:74](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L74)
 
 ___
 
@@ -155,7 +167,7 @@ Fetches a bot.
 
 #### Defined in
 
-[bot/index.js:37](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L37)
+[bot/index.js:43](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L43)
 
 ___
 
@@ -177,7 +189,7 @@ Retrieves a list of all bots.
 
 #### Defined in
 
-[bot/index.js:27](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L27)
+[bot/index.js:33](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L33)
 
 ___
 
@@ -200,4 +212,4 @@ Updates a bot.
 
 #### Defined in
 
-[bot/index.js:58](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L58)
+[bot/index.js:64](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/index.js#L64)
diff --git a/packages/sdk/docs/classes/bot_session.BotSessionClient.md b/packages/sdk/docs/classes/bot_session.BotSessionClient.md
@@ -0,0 +1,109 @@
+[@chatbotkit/sdk](../README.md) / [Modules](../modules.md) / [bot/session](../modules/bot_session.md) / BotSessionClient
+
+# Class: BotSessionClient
+
+[bot/session](../modules/bot_session.md).BotSessionClient
+
+Bot session client.
+
+## Hierarchy
+
+- [`ChatBotKitClient`](client.ChatBotKitClient.md)
+
+  ↳ **`BotSessionClient`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](bot_session.BotSessionClient.md#constructor)
+
+### Methods
+
+- [clientFetch](bot_session.BotSessionClient.md#clientfetch)
+- [create](bot_session.BotSessionClient.md#create)
+
+## Constructors
+
+### constructor
+
+• **new BotSessionClient**(`options`): [`BotSessionClient`](bot_session.BotSessionClient.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | [`ChatBotKitClientOptions`](../modules/client.md#chatbotkitclientoptions) |
+
+#### Returns
+
+[`BotSessionClient`](bot_session.BotSessionClient.md)
+
+#### Overrides
+
+[ChatBotKitClient](client.ChatBotKitClient.md).[constructor](client.ChatBotKitClient.md#constructor)
+
+#### Defined in
+
+[bot/session/index.js:11](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/session/index.js#L11)
+
+## Methods
+
+### clientFetch
+
+▸ **clientFetch**\<`T`, `U`\>(`path`, `options?`): [`ResponsePromise`](client.ResponsePromise.md)\<`T`, `U`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+| `U` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `options?` | `Object` |
+| `options.data?` | `Record`\<`string`, `any`\> |
+| `options.file?` | `Object` |
+| `options.file.data` | `string` \| `ArrayBuffer` |
+| `options.file.name?` | `string` |
+| `options.file.type?` | `string` |
+| `options.query?` | `Record`\<`string`, `any`\> |
+
+#### Returns
+
+[`ResponsePromise`](client.ResponsePromise.md)\<`T`, `U`\>
+
+#### Inherited from
+
+[ChatBotKitClient](client.ChatBotKitClient.md).[clientFetch](client.ChatBotKitClient.md#clientfetch)
+
+#### Defined in
+
+[client.js:211](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/client.js#L211)
+
+___
+
+### create
+
+▸ **create**(`botId`, `request`): `Promise`\<[`BotSessionCreateResponse`](../modules/bot_session_v1.md#botsessioncreateresponse)\>
+
+Creates a new session.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `botId` | `string` |
+| `request` | [`BotSessionCreateRequest`](../modules/bot_session_v1.md#botsessioncreaterequest) |
+
+#### Returns
+
+`Promise`\<[`BotSessionCreateResponse`](../modules/bot_session_v1.md#botsessioncreateresponse)\>
+
+#### Defined in
+
+[bot/session/index.js:22](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/bot/session/index.js#L22)
diff --git a/packages/sdk/docs/classes/client.ChatBotKitClient.md b/packages/sdk/docs/classes/client.ChatBotKitClient.md
@@ -10,10 +10,16 @@
 
   ↳ [`BotClient`](bot.BotClient.md)
 
+  ↳ [`BotSessionClient`](bot_session.BotSessionClient.md)
+
   ↳ [`ConversationClient`](conversation.ConversationClient.md)
 
   ↳ [`ConversationMessageClient`](conversation_message.ConversationMessageClient.md)
 
+  ↳ [`ConversationSessionClient`](conversation_session.ConversationSessionClient.md)
+
+  ↳ [`DatasetFileClient`](dataset_file.DatasetFileClient.md)
+
   ↳ [`DatasetClient`](dataset.DatasetClient.md)
 
   ↳ [`DatasetRecordClient`](dataset_record.DatasetRecordClient.md)
@@ -26,6 +32,8 @@
 
   ↳ [`MagicClient`](magic.MagicClient.md)
 
+  ↳ [`PartnerClient`](partner.PartnerClient.md)
+
   ↳ [`PartnerUserClient`](partner_user.PartnerUserClient.md)
 
   ↳ [`PartnerUserTokenClient`](partner_user_token.PartnerUserTokenClient.md)

diff --git a/packages/sdk/docs/classes/conversation.ConversationClient.md b/packages/sdk/docs/classes/conversation.ConversationClient.md
@@ -4,9 +4,7 @@
 
 [conversation](../modules/conversation.md).ConversationClient
 
-**`Template`**
-
-**`Template`**
+Conversation client.
 
 ## Hierarchy
 
@@ -20,6 +18,11 @@
 
 - [constructor](conversation.ConversationClient.md#constructor)
 
+### Properties
+
+- [message](conversation.ConversationClient.md#message)
+- [session](conversation.ConversationClient.md#session)
+
 ### Methods
 
 - [clientFetch](conversation.ConversationClient.md#clientfetch)
@@ -54,7 +57,27 @@
 
 #### Defined in
 
-[conversation/index.js:26](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L26)
+[conversation/index.js:29](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L29)
+
+## Properties
+
+### message
+
+• **message**: [`ConversationMessageClient`](conversation_message.ConversationMessageClient.md)
+
+#### Defined in
+
+[conversation/index.js:35](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L35)
+
+___
+
+### session
+
+• **session**: [`ConversationSessionClient`](conversation_session.ConversationSessionClient.md)
+
+#### Defined in
+
+[conversation/index.js:40](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L40)
 
 ## Methods
 
@@ -113,7 +136,7 @@ ___
 
 #### Defined in
 
-[conversation/index.js:85](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L85)
+[conversation/index.js:95](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L95)
 
 ▸ **complete**(`conversationId`, `request`): [`ResponsePromise`](client.ResponsePromise.md)\<[`ConversationCompleteMessageResponse`](../modules/conversation_v1.md#conversationcompletemessageresponse), [`ConversationCompleteMessageStreamType`](../modules/conversation_v1.md#conversationcompletemessagestreamtype)\>
 
@@ -130,7 +153,7 @@ ___
 
 #### Defined in
 
-[conversation/index.js:92](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L92)
+[conversation/index.js:102](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L102)
 
 ___
 
@@ -152,7 +175,7 @@ Creates a new conversation.
 
 #### Defined in
 
-[conversation/index.js:59](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L59)
+[conversation/index.js:69](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L69)
 
 ___
 
@@ -174,7 +197,7 @@ Deletes the conversation.
 
 #### Defined in
 
-[conversation/index.js:80](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L80)
+[conversation/index.js:90](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L90)
 
 ___
 
@@ -196,7 +219,7 @@ Fetches a conversation.
 
 #### Defined in
 
-[conversation/index.js:49](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L49)
+[conversation/index.js:59](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L59)
 
 ___
 
@@ -218,7 +241,7 @@ Retrieves a list of all conversations.
 
 #### Defined in
 
-[conversation/index.js:39](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L39)
+[conversation/index.js:49](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L49)
 
 ___
 
@@ -241,7 +264,7 @@ Receives a message from the conversation.
 
 #### Defined in
 
-[conversation/index.js:139](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L139)
+[conversation/index.js:149](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L149)
 
 ___
 
@@ -264,7 +287,7 @@ Sends a message to the conversation.
 
 #### Defined in
 
-[conversation/index.js:128](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L128)
+[conversation/index.js:138](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L138)
 
 ___
 
@@ -287,4 +310,4 @@ Updates a conversation.
 
 #### Defined in
 
-[conversation/index.js:70](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L70)
+[conversation/index.js:80](https://github.com/chatbotkit/node-sdk/blob/main/packages/sdk/src/conversation/index.js#L80)