@botpress/client 0.26.5 → 0.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/client",
-  "version": "0.26.5",
+  "version": "0.28.0",
   "description": "Botpress Client",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -30,7 +30,7 @@
     "type-fest": "^3.4.0"
   },
   "devDependencies": {
-    "@botpress/api": "0.38.3",
+    "@botpress/api": "0.39.0",
     "@types/qs": "^6.9.7",
     "esbuild": "^0.16.12",
     "lodash": "^4.17.21",

package/readme.md

@@ -13,24 +13,33 @@ pnpm add @botpress/client # for pnpm
 ## Usage
 
 ```ts
-import { Client, ClientOutputs } from '@botpress/client'
+import { Client } from '@botpress/client'
 
-type Bot = ClientOutputs['listBots']['bots'][number]
+// 0. Type definitions for each operation's IO
+type GetBotInput = ClientInputs['getBot']
+type GetBotOutput = ClientOutputs['getBot']
 
 const main = async () => {
   const token = 'your-token'
   const workspaceId = 'your-workspace-id'
-  const client = new Client({ token, workspaceId })
-
-  const allBots: Bot[] = []
-  let nextToken: string | undefined
-  do {
-    const resp = await client.listBots({ nextToken })
-    nextToken = resp.meta.nextToken
-    allBots.push(...resp.bots)
-  } while (nextToken)
-
-  console.log(allBots)
+  const botId = 'your-bot-id'
+  const client = new Client({ token, workspaceId, botId })
+
+  // 1. plain operations
+  const { bot } = await client.getBot({ id: botId })
+  console.log('### bot', bot)
+
+  // 2. list utils with `.collect()` function
+  const [latestConversation] = await client.list
+    .conversations({ sortField: 'createdAt', sortDirection: 'desc', integrationName: 'telegram' })
+    .collect({ limit: 1 })
+  console.log('### latestConversation', latestConversation)
+
+  // 3. list utils with async generator and `for await` syntax
+  for await (const message of client.list.messages({ conversationId: latestConversation.id })) {
+    console.log(`### [${message.userId}]`, message.payload)
+  }
 }
+
 void main()
 ```