@athenaintel/sdk 4.3.2318 → 4.3.2320
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +13 -8
- package/dist/cjs/api/resources/aop/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/aop/client/Client.js +3 -0
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/tasks/client/Client.d.ts +124 -0
- package/dist/cjs/api/resources/tasks/client/Client.js +535 -0
- package/dist/cjs/api/resources/tasks/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/tasks/client/index.js +17 -0
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequestIn.d.ts +52 -0
- package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequestIn.js +13 -0
- package/dist/cjs/api/resources/tasks/client/requests/GetTasksRequest.d.ts +10 -0
- package/dist/cjs/api/resources/tasks/client/requests/GetTasksRequest.js +3 -0
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksRequest.d.ts +26 -0
- package/dist/cjs/api/resources/tasks/client/requests/ListTasksRequest.js +3 -0
- package/dist/cjs/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.ts +21 -0
- package/dist/cjs/api/resources/tasks/client/requests/SetTaskStatusRequestIn.js +12 -0
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.ts +46 -0
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequestIn.js +17 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/tasks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tasks/index.d.ts +2 -0
- package/dist/cjs/api/resources/tasks/index.js +18 -0
- package/dist/cjs/api/resources/tasks/types/ListTasksRequestStatus.d.ts +7 -0
- package/dist/cjs/api/resources/tasks/types/ListTasksRequestStatus.js +10 -0
- package/dist/cjs/api/resources/tasks/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/tasks/types/index.js +17 -0
- package/dist/cjs/api/types/TaskAssigneeOut.d.ts +19 -0
- package/dist/cjs/api/types/TaskAssigneeOut.js +12 -0
- package/dist/cjs/api/types/TaskLabelIn.d.ts +9 -0
- package/dist/cjs/api/types/TaskLabelIn.js +3 -0
- package/dist/cjs/api/types/TaskLabelOut.d.ts +12 -0
- package/dist/cjs/api/types/TaskLabelOut.js +3 -0
- package/dist/cjs/api/types/TaskLinkIn.d.ts +22 -0
- package/dist/cjs/api/types/TaskLinkIn.js +13 -0
- package/dist/cjs/api/types/TaskLinkOut.d.ts +17 -0
- package/dist/cjs/api/types/TaskLinkOut.js +3 -0
- package/dist/cjs/api/types/TaskListOut.d.ts +8 -0
- package/dist/cjs/api/types/TaskListOut.js +3 -0
- package/dist/cjs/api/types/TaskOut.d.ts +51 -0
- package/dist/cjs/api/types/TaskOut.js +17 -0
- package/dist/cjs/api/types/index.d.ts +7 -0
- package/dist/cjs/api/types/index.js +7 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/resources/aop/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/aop/client/Client.mjs +3 -0
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/tasks/client/Client.d.mts +124 -0
- package/dist/esm/api/resources/tasks/client/Client.mjs +498 -0
- package/dist/esm/api/resources/tasks/client/index.d.mts +1 -0
- package/dist/esm/api/resources/tasks/client/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequestIn.d.mts +52 -0
- package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequestIn.mjs +10 -0
- package/dist/esm/api/resources/tasks/client/requests/GetTasksRequest.d.mts +10 -0
- package/dist/esm/api/resources/tasks/client/requests/GetTasksRequest.mjs +2 -0
- package/dist/esm/api/resources/tasks/client/requests/ListTasksRequest.d.mts +26 -0
- package/dist/esm/api/resources/tasks/client/requests/ListTasksRequest.mjs +2 -0
- package/dist/esm/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.mts +21 -0
- package/dist/esm/api/resources/tasks/client/requests/SetTaskStatusRequestIn.mjs +9 -0
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.mts +46 -0
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequestIn.mjs +14 -0
- package/dist/esm/api/resources/tasks/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/tasks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tasks/index.d.mts +2 -0
- package/dist/esm/api/resources/tasks/index.mjs +2 -0
- package/dist/esm/api/resources/tasks/types/ListTasksRequestStatus.d.mts +7 -0
- package/dist/esm/api/resources/tasks/types/ListTasksRequestStatus.mjs +7 -0
- package/dist/esm/api/resources/tasks/types/index.d.mts +1 -0
- package/dist/esm/api/resources/tasks/types/index.mjs +1 -0
- package/dist/esm/api/types/TaskAssigneeOut.d.mts +19 -0
- package/dist/esm/api/types/TaskAssigneeOut.mjs +9 -0
- package/dist/esm/api/types/TaskLabelIn.d.mts +9 -0
- package/dist/esm/api/types/TaskLabelIn.mjs +2 -0
- package/dist/esm/api/types/TaskLabelOut.d.mts +12 -0
- package/dist/esm/api/types/TaskLabelOut.mjs +2 -0
- package/dist/esm/api/types/TaskLinkIn.d.mts +22 -0
- package/dist/esm/api/types/TaskLinkIn.mjs +10 -0
- package/dist/esm/api/types/TaskLinkOut.d.mts +17 -0
- package/dist/esm/api/types/TaskLinkOut.mjs +2 -0
- package/dist/esm/api/types/TaskListOut.d.mts +8 -0
- package/dist/esm/api/types/TaskListOut.mjs +2 -0
- package/dist/esm/api/types/TaskOut.d.mts +51 -0
- package/dist/esm/api/types/TaskOut.mjs +14 -0
- package/dist/esm/api/types/index.d.mts +7 -0
- package/dist/esm/api/types/index.mjs +7 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +341 -0
package/reference.md
CHANGED
|
@@ -5124,6 +5124,347 @@ await client.sessions.markUnread({
|
|
|
5124
5124
|
</dl>
|
|
5125
5125
|
|
|
5126
5126
|
|
|
5127
|
+
</dd>
|
|
5128
|
+
</dl>
|
|
5129
|
+
</details>
|
|
5130
|
+
|
|
5131
|
+
## Tasks
|
|
5132
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">list</a>({ ...params }) -> AthenaIntelligence.TaskListOut</code></summary>
|
|
5133
|
+
<dl>
|
|
5134
|
+
<dd>
|
|
5135
|
+
|
|
5136
|
+
#### 📝 Description
|
|
5137
|
+
|
|
5138
|
+
<dl>
|
|
5139
|
+
<dd>
|
|
5140
|
+
|
|
5141
|
+
<dl>
|
|
5142
|
+
<dd>
|
|
5143
|
+
|
|
5144
|
+
The tasks of a workspace the caller belongs to that they can open, soonest due first (tasks with no due date last, newest first). Open tasks unless status says otherwise. Filter by assignee (me for the caller's own), due dates (calendar days, inclusive), a label's name or a record the task links. A listed task carries no links and a null can_edit: read one task for them.
|
|
5145
|
+
</dd>
|
|
5146
|
+
</dl>
|
|
5147
|
+
</dd>
|
|
5148
|
+
</dl>
|
|
5149
|
+
|
|
5150
|
+
#### 🔌 Usage
|
|
5151
|
+
|
|
5152
|
+
<dl>
|
|
5153
|
+
<dd>
|
|
5154
|
+
|
|
5155
|
+
<dl>
|
|
5156
|
+
<dd>
|
|
5157
|
+
|
|
5158
|
+
```typescript
|
|
5159
|
+
await client.tasks.list({
|
|
5160
|
+
workspace_id: "ws_abc123-def456",
|
|
5161
|
+
limit: 50
|
|
5162
|
+
});
|
|
5163
|
+
|
|
5164
|
+
```
|
|
5165
|
+
</dd>
|
|
5166
|
+
</dl>
|
|
5167
|
+
</dd>
|
|
5168
|
+
</dl>
|
|
5169
|
+
|
|
5170
|
+
#### ⚙️ Parameters
|
|
5171
|
+
|
|
5172
|
+
<dl>
|
|
5173
|
+
<dd>
|
|
5174
|
+
|
|
5175
|
+
<dl>
|
|
5176
|
+
<dd>
|
|
5177
|
+
|
|
5178
|
+
**request:** `AthenaIntelligence.ListTasksRequest`
|
|
5179
|
+
|
|
5180
|
+
</dd>
|
|
5181
|
+
</dl>
|
|
5182
|
+
|
|
5183
|
+
<dl>
|
|
5184
|
+
<dd>
|
|
5185
|
+
|
|
5186
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
5187
|
+
|
|
5188
|
+
</dd>
|
|
5189
|
+
</dl>
|
|
5190
|
+
</dd>
|
|
5191
|
+
</dl>
|
|
5192
|
+
|
|
5193
|
+
|
|
5194
|
+
</dd>
|
|
5195
|
+
</dl>
|
|
5196
|
+
</details>
|
|
5197
|
+
|
|
5198
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">create</a>({ ...params }) -> AthenaIntelligence.TaskOut</code></summary>
|
|
5199
|
+
<dl>
|
|
5200
|
+
<dd>
|
|
5201
|
+
|
|
5202
|
+
#### 📝 Description
|
|
5203
|
+
|
|
5204
|
+
<dl>
|
|
5205
|
+
<dd>
|
|
5206
|
+
|
|
5207
|
+
<dl>
|
|
5208
|
+
<dd>
|
|
5209
|
+
|
|
5210
|
+
Create a task (an assignable to-do) in a workspace the caller belongs to, with an optional due date and time, priority, assignee, labels, links to the records it is about and a folder or project to put it in. It is the caller's own unless assignee_ref names someone who can already open it (assigning never shares it) or is null. Each link must be a record the caller can open, and a parent folder needs edit access.
|
|
5211
|
+
</dd>
|
|
5212
|
+
</dl>
|
|
5213
|
+
</dd>
|
|
5214
|
+
</dl>
|
|
5215
|
+
|
|
5216
|
+
#### 🔌 Usage
|
|
5217
|
+
|
|
5218
|
+
<dl>
|
|
5219
|
+
<dd>
|
|
5220
|
+
|
|
5221
|
+
<dl>
|
|
5222
|
+
<dd>
|
|
5223
|
+
|
|
5224
|
+
```typescript
|
|
5225
|
+
await client.tasks.create({
|
|
5226
|
+
due_date: "2026-11-13",
|
|
5227
|
+
due_time: "15:00",
|
|
5228
|
+
due_time_zone: "America/New_York",
|
|
5229
|
+
labels: [{
|
|
5230
|
+
name: "Investor"
|
|
5231
|
+
}],
|
|
5232
|
+
links: [{
|
|
5233
|
+
referenced: "external_url",
|
|
5234
|
+
url: "https://example.com"
|
|
5235
|
+
}],
|
|
5236
|
+
priority: "high",
|
|
5237
|
+
title: "Send the deck to Mayfield",
|
|
5238
|
+
workspace_id: "ws_abc123-def456"
|
|
5239
|
+
});
|
|
5240
|
+
|
|
5241
|
+
```
|
|
5242
|
+
</dd>
|
|
5243
|
+
</dl>
|
|
5244
|
+
</dd>
|
|
5245
|
+
</dl>
|
|
5246
|
+
|
|
5247
|
+
#### ⚙️ Parameters
|
|
5248
|
+
|
|
5249
|
+
<dl>
|
|
5250
|
+
<dd>
|
|
5251
|
+
|
|
5252
|
+
<dl>
|
|
5253
|
+
<dd>
|
|
5254
|
+
|
|
5255
|
+
**request:** `AthenaIntelligence.CreateTaskRequestIn`
|
|
5256
|
+
|
|
5257
|
+
</dd>
|
|
5258
|
+
</dl>
|
|
5259
|
+
|
|
5260
|
+
<dl>
|
|
5261
|
+
<dd>
|
|
5262
|
+
|
|
5263
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
5264
|
+
|
|
5265
|
+
</dd>
|
|
5266
|
+
</dl>
|
|
5267
|
+
</dd>
|
|
5268
|
+
</dl>
|
|
5269
|
+
|
|
5270
|
+
|
|
5271
|
+
</dd>
|
|
5272
|
+
</dl>
|
|
5273
|
+
</details>
|
|
5274
|
+
|
|
5275
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">get</a>({ ...params }) -> AthenaIntelligence.TaskOut</code></summary>
|
|
5276
|
+
<dl>
|
|
5277
|
+
<dd>
|
|
5278
|
+
|
|
5279
|
+
#### 📝 Description
|
|
5280
|
+
|
|
5281
|
+
<dl>
|
|
5282
|
+
<dd>
|
|
5283
|
+
|
|
5284
|
+
<dl>
|
|
5285
|
+
<dd>
|
|
5286
|
+
|
|
5287
|
+
One task the caller can open: its status, due date, priority, assignee, labels, the records it links (each read with the caller's own access: one they can't open shows its kind only) and whether they may change it.
|
|
5288
|
+
</dd>
|
|
5289
|
+
</dl>
|
|
5290
|
+
</dd>
|
|
5291
|
+
</dl>
|
|
5292
|
+
|
|
5293
|
+
#### 🔌 Usage
|
|
5294
|
+
|
|
5295
|
+
<dl>
|
|
5296
|
+
<dd>
|
|
5297
|
+
|
|
5298
|
+
<dl>
|
|
5299
|
+
<dd>
|
|
5300
|
+
|
|
5301
|
+
```typescript
|
|
5302
|
+
await client.tasks.get({
|
|
5303
|
+
asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c"
|
|
5304
|
+
});
|
|
5305
|
+
|
|
5306
|
+
```
|
|
5307
|
+
</dd>
|
|
5308
|
+
</dl>
|
|
5309
|
+
</dd>
|
|
5310
|
+
</dl>
|
|
5311
|
+
|
|
5312
|
+
#### ⚙️ Parameters
|
|
5313
|
+
|
|
5314
|
+
<dl>
|
|
5315
|
+
<dd>
|
|
5316
|
+
|
|
5317
|
+
<dl>
|
|
5318
|
+
<dd>
|
|
5319
|
+
|
|
5320
|
+
**request:** `AthenaIntelligence.GetTasksRequest`
|
|
5321
|
+
|
|
5322
|
+
</dd>
|
|
5323
|
+
</dl>
|
|
5324
|
+
|
|
5325
|
+
<dl>
|
|
5326
|
+
<dd>
|
|
5327
|
+
|
|
5328
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
5329
|
+
|
|
5330
|
+
</dd>
|
|
5331
|
+
</dl>
|
|
5332
|
+
</dd>
|
|
5333
|
+
</dl>
|
|
5334
|
+
|
|
5335
|
+
|
|
5336
|
+
</dd>
|
|
5337
|
+
</dl>
|
|
5338
|
+
</details>
|
|
5339
|
+
|
|
5340
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">update</a>({ ...params }) -> AthenaIntelligence.TaskOut</code></summary>
|
|
5341
|
+
<dl>
|
|
5342
|
+
<dd>
|
|
5343
|
+
|
|
5344
|
+
#### 📝 Description
|
|
5345
|
+
|
|
5346
|
+
<dl>
|
|
5347
|
+
<dd>
|
|
5348
|
+
|
|
5349
|
+
<dl>
|
|
5350
|
+
<dd>
|
|
5351
|
+
|
|
5352
|
+
Change a task: a field left out is kept, and an explicit null clears it (title and status cannot be cleared). Needs edit access, and the task must not be in the trash. Labels and links are replaced whole; links already on it that the caller cannot open are kept. Marking it done records who and when.
|
|
5353
|
+
</dd>
|
|
5354
|
+
</dl>
|
|
5355
|
+
</dd>
|
|
5356
|
+
</dl>
|
|
5357
|
+
|
|
5358
|
+
#### 🔌 Usage
|
|
5359
|
+
|
|
5360
|
+
<dl>
|
|
5361
|
+
<dd>
|
|
5362
|
+
|
|
5363
|
+
<dl>
|
|
5364
|
+
<dd>
|
|
5365
|
+
|
|
5366
|
+
```typescript
|
|
5367
|
+
await client.tasks.update({
|
|
5368
|
+
asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
|
|
5369
|
+
priority: "medium"
|
|
5370
|
+
});
|
|
5371
|
+
|
|
5372
|
+
```
|
|
5373
|
+
</dd>
|
|
5374
|
+
</dl>
|
|
5375
|
+
</dd>
|
|
5376
|
+
</dl>
|
|
5377
|
+
|
|
5378
|
+
#### ⚙️ Parameters
|
|
5379
|
+
|
|
5380
|
+
<dl>
|
|
5381
|
+
<dd>
|
|
5382
|
+
|
|
5383
|
+
<dl>
|
|
5384
|
+
<dd>
|
|
5385
|
+
|
|
5386
|
+
**request:** `AthenaIntelligence.UpdateTaskRequestIn`
|
|
5387
|
+
|
|
5388
|
+
</dd>
|
|
5389
|
+
</dl>
|
|
5390
|
+
|
|
5391
|
+
<dl>
|
|
5392
|
+
<dd>
|
|
5393
|
+
|
|
5394
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
5395
|
+
|
|
5396
|
+
</dd>
|
|
5397
|
+
</dl>
|
|
5398
|
+
</dd>
|
|
5399
|
+
</dl>
|
|
5400
|
+
|
|
5401
|
+
|
|
5402
|
+
</dd>
|
|
5403
|
+
</dl>
|
|
5404
|
+
</details>
|
|
5405
|
+
|
|
5406
|
+
<details><summary><code>client.tasks.<a href="/src/api/resources/tasks/client/Client.ts">setStatus</a>({ ...params }) -> AthenaIntelligence.TaskOut</code></summary>
|
|
5407
|
+
<dl>
|
|
5408
|
+
<dd>
|
|
5409
|
+
|
|
5410
|
+
#### 📝 Description
|
|
5411
|
+
|
|
5412
|
+
<dl>
|
|
5413
|
+
<dd>
|
|
5414
|
+
|
|
5415
|
+
<dl>
|
|
5416
|
+
<dd>
|
|
5417
|
+
|
|
5418
|
+
Mark a task done, or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who and when; reopening clears both.
|
|
5419
|
+
</dd>
|
|
5420
|
+
</dl>
|
|
5421
|
+
</dd>
|
|
5422
|
+
</dl>
|
|
5423
|
+
|
|
5424
|
+
#### 🔌 Usage
|
|
5425
|
+
|
|
5426
|
+
<dl>
|
|
5427
|
+
<dd>
|
|
5428
|
+
|
|
5429
|
+
<dl>
|
|
5430
|
+
<dd>
|
|
5431
|
+
|
|
5432
|
+
```typescript
|
|
5433
|
+
await client.tasks.setStatus({
|
|
5434
|
+
asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
|
|
5435
|
+
status: "done"
|
|
5436
|
+
});
|
|
5437
|
+
|
|
5438
|
+
```
|
|
5439
|
+
</dd>
|
|
5440
|
+
</dl>
|
|
5441
|
+
</dd>
|
|
5442
|
+
</dl>
|
|
5443
|
+
|
|
5444
|
+
#### ⚙️ Parameters
|
|
5445
|
+
|
|
5446
|
+
<dl>
|
|
5447
|
+
<dd>
|
|
5448
|
+
|
|
5449
|
+
<dl>
|
|
5450
|
+
<dd>
|
|
5451
|
+
|
|
5452
|
+
**request:** `AthenaIntelligence.SetTaskStatusRequestIn`
|
|
5453
|
+
|
|
5454
|
+
</dd>
|
|
5455
|
+
</dl>
|
|
5456
|
+
|
|
5457
|
+
<dl>
|
|
5458
|
+
<dd>
|
|
5459
|
+
|
|
5460
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
5461
|
+
|
|
5462
|
+
</dd>
|
|
5463
|
+
</dl>
|
|
5464
|
+
</dd>
|
|
5465
|
+
</dl>
|
|
5466
|
+
|
|
5467
|
+
|
|
5127
5468
|
</dd>
|
|
5128
5469
|
</dl>
|
|
5129
5470
|
</details>
|