@aiqa/sdk 3.0.0-develop.2 → 3.1.0-develop.1

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/README.md CHANGED
@@ -286,8 +286,9 @@ User-provided application status: `draft`, `pending`, `completed`, `expired`,
286
286
  #### `upsertAdvisor()`
287
287
 
288
288
  Creates an advisor in your organization, or updates the name of an existing
289
- advisor with the same email. Use the returned `advisor_id` with
290
- `updateConversation({ advisorId })`.
289
+ advisor with the same email. Then link the call to the advisor with
290
+ `updateConversation({ advisorEmail })`, passing the same email, or with
291
+ `updateConversation({ advisorId })`, passing the returned `advisor_id`.
291
292
 
292
293
  **Parameters:**
293
294
 
@@ -297,11 +298,11 @@ advisor with the same email. Use the returned `advisor_id` with
297
298
 
298
299
  - `Promise<UpsertAdvisorResult>`
299
300
 
300
- | your organization has | result |
301
- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
302
- | no user with that email | the advisor is created; `created: true` |
303
- | an advisor with that email | its first and last name are updated; `created: false` |
304
- | a user with that email who is not an advisor, such as an administrator | the user is not changed and keeps its own first and last name, which can differ from what you sent; `created: false`. You can still pass its `advisor_id` to `updateConversation({ advisorId })` |
301
+ | your organization has | result |
302
+ | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
303
+ | no user with that email | the advisor is created; `created: true` |
304
+ | an advisor with that email | its first and last name are updated; `created: false` |
305
+ | a user with that email who is not an advisor, such as an administrator | the user is not changed and keeps its own first and last name, which can differ from what you sent; `created: false`. You can still link the call to it with `advisorEmail` or `advisorId` |
305
306
 
306
307
  - `advisor_id` is the email in lowercase.
307
308
  - The Promise rejects when the advisor cannot be saved: invalid input (for
@@ -314,7 +315,8 @@ const result = await sdk.upsertAdvisor({
314
315
  firstName: "Jane",
315
316
  lastName: "Doe",
316
317
  });
317
- await sdk.updateConversation({ advisorId: result.advisor.advisor_id });
318
+ await sdk.updateConversation({ advisorEmail: "advisor@example.com" });
319
+ // or: await sdk.updateConversation({ advisorId: result.advisor.advisor_id });
318
320
  ```
319
321
 
320
322
  ### Fact Management
@@ -3407,7 +3407,7 @@ var compareVersions = (left, right) => {
3407
3407
  // package.json
3408
3408
  var package_default = {
3409
3409
  name: "@aiqa/sdk",
3410
- version: "3.0.0-develop.1",
3410
+ version: "3.0.0-develop.2",
3411
3411
  main: "dist/node/node.js",
3412
3412
  module: "dist/node/node.js",
3413
3413
  types: "dist/node/node.d.ts",