@or-sdk/idw 9.0.9-beta.4275.0 → 9.0.9-beta.4276.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/README.md +202 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -44,3 +44,205 @@ HTTP errors are thrown as types from `@or-sdk/base` (for example `ApiError`); im
|
|
|
44
44
|
### Notes
|
|
45
45
|
|
|
46
46
|
- **Service discovery key** is `idw-api` (`SERVICE_KEY`). If your registry uses a different key, change the constant in source or pass **`idwApiUrl`** to skip discovery.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## Additional API reference
|
|
50
|
+
|
|
51
|
+
Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
|
|
52
|
+
|
|
53
|
+
### `IdwClient`
|
|
54
|
+
|
|
55
|
+
| Method | Returns | Purpose |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| `makeRequest(params: CalApiParams)` | `Promise<T>` | See the exported TypeScript signature for behavior and constraints. |
|
|
58
|
+
|
|
59
|
+
### `AccountApi`
|
|
60
|
+
|
|
61
|
+
| Method | Returns | Purpose |
|
|
62
|
+
|---|---|---|
|
|
63
|
+
| `listAccountIdws(params?: QueryAccountId)` | `Promise<IdwDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
64
|
+
|
|
65
|
+
### `ChatApi`
|
|
66
|
+
|
|
67
|
+
| Method | Returns | Purpose |
|
|
68
|
+
|---|---|---|
|
|
69
|
+
| `listChats(params?: ChatsListQueryDto)` | `Promise<ChatDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
70
|
+
| `createChat(data: ChatCreateDto)` | `Promise<ChatDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
71
|
+
| `getChat(chatId: string)` | `Promise<ChatDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
72
|
+
| `updateChat(chatId: string, data: ChatPatchDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
73
|
+
| `updateChatModels(chatId: string, data: ChatModelsPatchDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
74
|
+
| `deleteChat(chatId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
75
|
+
| `getChatMessages(chatId: string)` | `Promise<ChatMessageDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
76
|
+
| `listChatSkills(chatId: string)` | `Promise<ChatSkillDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
77
|
+
| `attachChatSkill(chatId: string, data: CreateChatSkillDto)` | `Promise<ChatSkillDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
78
|
+
| `deleteChatSkill(chatId: string, skillSessionId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
79
|
+
| `touchChatSkill(chatId: string, skillSessionId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
80
|
+
|
|
81
|
+
### `DatasourceSelectionsApi`
|
|
82
|
+
|
|
83
|
+
| Method | Returns | Purpose |
|
|
84
|
+
|---|---|---|
|
|
85
|
+
| `getUserSelections()` | `Promise<DatasourceSelectionResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
86
|
+
| `saveUserSelections(data: DatasourceSelectionDto)` | `Promise<DatasourceSelectionResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
87
|
+
|
|
88
|
+
### `DatasourcesApi`
|
|
89
|
+
|
|
90
|
+
| Method | Returns | Purpose |
|
|
91
|
+
|---|---|---|
|
|
92
|
+
| `listDatasources(params?: FilterDatasourcesDto)` | `Promise<DatasourceDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
93
|
+
| `getDatasource(datasourceId: string)` | `Promise<DatasourceDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
94
|
+
| `createDatasource(data: CreateDatasourceDto)` | `Promise<DatasourceDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
95
|
+
| `updateDatasource(datasourceId: string, data: UpdateDatasourceDto)` | `Promise<DatasourceDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
96
|
+
| `updateDatasourceStatus(datasourceId: string, data: UpdateDatasourceStatusDto)` | `Promise<DatasourceDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
97
|
+
| `deleteDatasource(datasourceId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
98
|
+
| `listDatasourcesForAdmin()` | `Promise<DatasourceDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
99
|
+
|
|
100
|
+
### `DomainsApi`
|
|
101
|
+
|
|
102
|
+
| Method | Returns | Purpose |
|
|
103
|
+
|---|---|---|
|
|
104
|
+
| `listDomains()` | `Promise<DomainListResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
105
|
+
| `listDomainsWithNotesCount()` | `Promise<DomainWithCountListResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
106
|
+
| `getDomain(domainId: string)` | `Promise<DomainDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
107
|
+
| `getDomainWithNotesCount(domainId: string)` | `Promise<DomainWithCountDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
108
|
+
| `deleteDomain(domainId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
109
|
+
| `createDomain(data: CreateDomainParams)` | `Promise<CreateDomainResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
110
|
+
| `updateDomain(domainId: string, data: CreateDomainParams)` | `Promise<CreateDomainResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
111
|
+
|
|
112
|
+
### `FeedApi`
|
|
113
|
+
|
|
114
|
+
| Method | Returns | Purpose |
|
|
115
|
+
|---|---|---|
|
|
116
|
+
| `listComments(params: ListCommentsParams)` | `Promise<CommentResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
117
|
+
| `listFeeds(params?: ListFeedQuery)` | `Promise<ListFeedResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
118
|
+
| `getFeedById(feedId: string)` | `Promise<FeedItem>` | See the exported TypeScript signature for behavior and constraints. |
|
|
119
|
+
| `createFeed(data: CreateFeedParams)` | `Promise<CreateFeedResult>` | See the exported TypeScript signature for behavior and constraints. |
|
|
120
|
+
| `updateFeed(data: FeedUpdateDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
121
|
+
| `deleteFeed(feedId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
122
|
+
| `addComment(data: AddCommentParams)` | `Promise<CommentResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
123
|
+
| `updateComment(data: UpdateCommentParams)` | `Promise<CommentResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
124
|
+
| `deleteComment(commentId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
125
|
+
| `listReactions(feedId: string)` | `Promise<ReactionResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
126
|
+
| `addReaction(data: AddCommentParams)` | `Promise<ReactionResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
127
|
+
| `deleteReaction(reactionId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
128
|
+
| `markAllPostsAsRead()` | `Promise<FeedMarkReadResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
129
|
+
| `markPostAsRead(feedId: string)` | `Promise<FeedReadHistoryRecord>` | See the exported TypeScript signature for behavior and constraints. |
|
|
130
|
+
| `hasUnreadPosts()` | `Promise<FeedUnreadStatus>` | See the exported TypeScript signature for behavior and constraints. |
|
|
131
|
+
| `enhanceFeedContent(content: string)` | `Promise<string>` | See the exported TypeScript signature for behavior and constraints. |
|
|
132
|
+
|
|
133
|
+
### `FilesApi`
|
|
134
|
+
|
|
135
|
+
| Method | Returns | Purpose |
|
|
136
|
+
|---|---|---|
|
|
137
|
+
| `parseFile(data: ParseDocumentBody)` | `Promise<ParseFileResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
138
|
+
|
|
139
|
+
### `IdwApi`
|
|
140
|
+
|
|
141
|
+
| Method | Returns | Purpose |
|
|
142
|
+
|---|---|---|
|
|
143
|
+
| `getIdw()` | `Promise<IdwDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
144
|
+
| `getIdwInfo()` | `Promise<IdwInfoDto \| null>` | See the exported TypeScript signature for behavior and constraints. |
|
|
145
|
+
| `updateIdw(data: UpdateIdwDto)` | `Promise<IdwDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
146
|
+
|
|
147
|
+
### `IdwSettingsApi`
|
|
148
|
+
|
|
149
|
+
| Method | Returns | Purpose |
|
|
150
|
+
|---|---|---|
|
|
151
|
+
| `setCoreSettings(data: SetCoreSettingsDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
152
|
+
| `setAccessSettings(data: SetAccessSettingsDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
153
|
+
| `setSignUpSettings(data: SetSignUpSettingsDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
154
|
+
| `setWelcomeScreenSettings(data: SetWelcomeScreenSettingsDto)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
155
|
+
|
|
156
|
+
### `IdwSystemApi`
|
|
157
|
+
|
|
158
|
+
| Method | Returns | Purpose |
|
|
159
|
+
|---|---|---|
|
|
160
|
+
| `createIdw(data: CreateIdwDto)` | `Promise<IdwDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
161
|
+
| `listIdws()` | `Promise<IdwDto[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
162
|
+
| `deleteIdw(idwId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
163
|
+
|
|
164
|
+
### `IdwUserApi`
|
|
165
|
+
|
|
166
|
+
| Method | Returns | Purpose |
|
|
167
|
+
|---|---|---|
|
|
168
|
+
| `getUserDetails(params?: UserDetailsQuery)` | `Promise<UserDetaulsResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
169
|
+
| `getLogo(params?: QueryAccountId)` | `Promise<string>` | SVG markup (`image/svg+xml`). |
|
|
170
|
+
| `updateContact(data: CurrentProfile)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
171
|
+
| `getContactId()` | `Promise<string>` | See the exported TypeScript signature for behavior and constraints. |
|
|
172
|
+
|
|
173
|
+
### `InstallerApi`
|
|
174
|
+
|
|
175
|
+
| Method | Returns | Purpose |
|
|
176
|
+
|---|---|---|
|
|
177
|
+
| `installSpace(data: InstallSpaceDto)` | `Promise<CreateSkillResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
178
|
+
|
|
179
|
+
### `KnowledgeApi`
|
|
180
|
+
|
|
181
|
+
| Method | Returns | Purpose |
|
|
182
|
+
|---|---|---|
|
|
183
|
+
| `listKnowledge(params?: ListKnowledgeQuery)` | `Promise<ListKnowledgeResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
184
|
+
| `listKnowledgeAuthors(params?: { domainId?: string })` | `Promise<ListKnowledgeResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
185
|
+
| `getKnowledge(knowledgeId: string)` | `Promise<KnowledgeDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
186
|
+
| `createKnowledge(data: KnowledgeCreateDto)` | `Promise<KnowledgeDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
187
|
+
| `enhanceTitle(content: string)` | `Promise<KnowledgeDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
188
|
+
| `enhanceContent(content: string)` | `Promise<KnowledgeDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
189
|
+
| `updateKnowledge(knowledgeId: string, data: KnowledgeUpdateDto)` | `Promise<KnowledgeDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
190
|
+
| `deleteKnowledge(knowledgeId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
191
|
+
|
|
192
|
+
### `LookupApi`
|
|
193
|
+
|
|
194
|
+
| Method | Returns | Purpose |
|
|
195
|
+
|---|---|---|
|
|
196
|
+
| `publish(data: KnowledgeDocumentDto)` | `Promise<LookupPublishedDocument>` | See the exported TypeScript signature for behavior and constraints. |
|
|
197
|
+
| `unpublish(documentId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
198
|
+
| `proxy(data: LookupProxyParams, params?: QueryAccountId)` | `Promise<TResult>` | See the exported TypeScript signature for behavior and constraints. |
|
|
199
|
+
|
|
200
|
+
### `ReportingApi`
|
|
201
|
+
|
|
202
|
+
| Method | Returns | Purpose |
|
|
203
|
+
|---|---|---|
|
|
204
|
+
| `getHeadlineMetrics(params: FiltersQueryDto)` | `Promise<HeadlineMetricsResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
205
|
+
| `getSessionsOverTime(params: FiltersGranularityQueryDto)` | `Promise<ListSessionsOverTimeResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
206
|
+
| `getMessagesOverTime(params: FiltersGranularityQueryDto)` | `Promise<ListMessagesOverTimeResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
207
|
+
| `getSkillInvocPerSession(params: FiltersQueryDto)` | `Promise<ListSkillInvPerSessionsResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
208
|
+
| `getSkillInvocationsOverTime(params: FiltersGranularityQueryDto)` | `Promise<ListSkillInvocationsOverTimeResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
209
|
+
| `getDatasourceUsagePerSession(params: FiltersGranularityQueryDto)` | `Promise<ListDatasourceUsagePerSessionResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
210
|
+
| `getDatasourceInvocationsVsResponses(params: FiltersGranularityQueryDto)` | `Promise<DatasourceInvocationsVsResponsesResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
211
|
+
| `getMembersOverTime(params: FiltersGranularityQueryDto)` | `Promise<ListMembersOverTimeResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
212
|
+
| `getUserSessionStats(params: FiltersPaginationQueryDto)` | `Promise<UserSessionStatsResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
213
|
+
| `getSkillPerformance(skillId: string, params: FiltersQueryDto)` | `Promise<SkillPerformanceResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
214
|
+
| `getSkillUsageTrend(skillId: string, params: FiltersGranularityQueryDto)` | `Promise<SkillUsageOverTimeResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
215
|
+
| `getSkillUserStats(skillId: string, params: FiltersPaginationQueryDto)` | `Promise<SkillUserStatsResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
216
|
+
|
|
217
|
+
### `SkillsApi`
|
|
218
|
+
|
|
219
|
+
| Method | Returns | Purpose |
|
|
220
|
+
|---|---|---|
|
|
221
|
+
| `listSkills()` | `Promise<ListSkillsResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
222
|
+
| `listSkillsForAdmin()` | `Promise<ListSkillsResponse[]>` | See the exported TypeScript signature for behavior and constraints. |
|
|
223
|
+
| `createSkill(data: CreateSkillParams)` | `Promise<CreateSkillResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
224
|
+
| `editSkill(skillId: string, data: EditSkillParams)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
225
|
+
| `deleteSkill(skillId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
226
|
+
| `checkSkillAccess(data: CheckSkillAccessParams, customHeaders?: Record<string, string>)` | `Promise<CheckSkillAccessResponse>` | See the exported TypeScript signature for behavior and constraints. |
|
|
227
|
+
|
|
228
|
+
### `SystemApi`
|
|
229
|
+
|
|
230
|
+
| Method | Returns | Purpose |
|
|
231
|
+
|---|---|---|
|
|
232
|
+
| `getVersion()` | `Promise<ApiVersionDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
233
|
+
| `syncGraph(idwId: string)` | `Promise<void>` | See the exported TypeScript signature for behavior and constraints. |
|
|
234
|
+
| `checkProgress(params: CheckProgressDto)` | `Promise<SystemProgressResult>` | See the exported TypeScript signature for behavior and constraints. |
|
|
235
|
+
|
|
236
|
+
### `UserInfoApi`
|
|
237
|
+
|
|
238
|
+
| Method | Returns | Purpose |
|
|
239
|
+
|---|---|---|
|
|
240
|
+
| `getUserInfo()` | `Promise<UserInfoDto>` | See the exported TypeScript signature for behavior and constraints. |
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## Exported utility reference
|
|
244
|
+
|
|
245
|
+
| Function | Returns | Purpose |
|
|
246
|
+
|---|---|---|
|
|
247
|
+
| `resolveIdwId(client: IdwHttpClient, idwIdOverride?: string)` | `string` | Exported utility; see its TypeScript signature for behavior. |
|
|
248
|
+
| `idwScopedRoute(client: IdwHttpClient, idwIdOverride: string \| undefined, suffix: string)` | `string` | Exported utility; see its TypeScript signature for behavior. |
|