UNPKG

hud-ai

Version:

Hud.ai API Client

github.com/FoundryAI/hud-ai-node

FoundryAI/hud-ai-node

51 lines (39 loc) • 1.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# ArticleHighlights | Attribute | Type | Description | | --------- | ---- | ----------- | | `id` | string | Resource ID **Cannot be edited** | | `createdAt` | Date | Creation date **Cannot be edited** | | `updatedAt` | Date | Last touch date **Cannot be edited** | | `articleId`* | **string** | Article being highlighted | | `body`* | **string** | Phrases that should be highlighted | | `userId`* | **string** | User the highlights apply to | ## `client.articleHighlights.list(query)` | Param | Type | |-------|------| | `query` | Object | | `query.type` | string | | `query.articleId` | string | | `query.linkHash` | string | | `query.userId` | string | ## `client.articleHighlights.create(params)` | Param | Type | |-------|------| | `query` | Object | | `query.articleId`* | **string** | | `query.body`* | **string** | | `query.userId`* | **string** | ## `client.articleHighlights.get(id)` | Param | Type | |-------|------| | `id` | string | ## `client.articleHighlights.update(id, params)` | Param | Type | |-------|------| | `id` | string | | `query.articleId` | string | | `query.body` | string | | `query.userId` | string | ## `client.articleHighlights.destroy(id)` | Param | Type | |-------|------| | `id` | string |