@athenaintel/sdk 4.3.2321 → 4.3.2323

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.
Files changed (48) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/assets/client/Client.d.ts +2 -2
  3. package/dist/cjs/api/resources/assets/client/Client.js +2 -2
  4. package/dist/cjs/api/resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.d.ts +1 -1
  5. package/dist/cjs/api/resources/assets/client/requests/CreateUploadLinkRequestIn.d.ts +1 -1
  6. package/dist/cjs/api/resources/tasks/client/Client.d.ts +2 -1
  7. package/dist/cjs/api/resources/tasks/client/Client.js +2 -1
  8. package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequestIn.d.ts +3 -0
  9. package/dist/cjs/api/resources/tasks/client/requests/CreateTaskRequestIn.js +1 -0
  10. package/dist/cjs/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.ts +8 -0
  11. package/dist/cjs/api/resources/tasks/client/requests/SetTaskStatusRequestIn.js +4 -0
  12. package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.ts +10 -0
  13. package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequestIn.js +5 -0
  14. package/dist/cjs/api/types/TaskOut.d.ts +14 -0
  15. package/dist/cjs/api/types/TaskOut.js +5 -0
  16. package/dist/cjs/api/types/TaskParentOut.d.ts +22 -0
  17. package/dist/cjs/api/types/TaskParentOut.js +11 -0
  18. package/dist/cjs/api/types/TaskSubtaskProgressOut.d.ts +9 -0
  19. package/dist/cjs/api/types/TaskSubtaskProgressOut.js +3 -0
  20. package/dist/cjs/api/types/index.d.ts +2 -0
  21. package/dist/cjs/api/types/index.js +2 -0
  22. package/dist/cjs/version.d.ts +1 -1
  23. package/dist/cjs/version.js +1 -1
  24. package/dist/esm/BaseClient.mjs +2 -2
  25. package/dist/esm/api/resources/assets/client/Client.d.mts +2 -2
  26. package/dist/esm/api/resources/assets/client/Client.mjs +2 -2
  27. package/dist/esm/api/resources/assets/client/requests/BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost.d.mts +1 -1
  28. package/dist/esm/api/resources/assets/client/requests/CreateUploadLinkRequestIn.d.mts +1 -1
  29. package/dist/esm/api/resources/tasks/client/Client.d.mts +2 -1
  30. package/dist/esm/api/resources/tasks/client/Client.mjs +2 -1
  31. package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequestIn.d.mts +3 -0
  32. package/dist/esm/api/resources/tasks/client/requests/CreateTaskRequestIn.mjs +1 -0
  33. package/dist/esm/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.mts +8 -0
  34. package/dist/esm/api/resources/tasks/client/requests/SetTaskStatusRequestIn.mjs +4 -0
  35. package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.mts +10 -0
  36. package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequestIn.mjs +5 -0
  37. package/dist/esm/api/types/TaskOut.d.mts +14 -0
  38. package/dist/esm/api/types/TaskOut.mjs +5 -0
  39. package/dist/esm/api/types/TaskParentOut.d.mts +22 -0
  40. package/dist/esm/api/types/TaskParentOut.mjs +8 -0
  41. package/dist/esm/api/types/TaskSubtaskProgressOut.d.mts +9 -0
  42. package/dist/esm/api/types/TaskSubtaskProgressOut.mjs +2 -0
  43. package/dist/esm/api/types/index.d.mts +2 -0
  44. package/dist/esm/api/types/index.mjs +2 -0
  45. package/dist/esm/version.d.mts +1 -1
  46. package/dist/esm/version.mjs +1 -1
  47. package/package.json +1 -1
  48. package/reference.md +4 -3
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@athenaintel/sdk",
46
- "X-Fern-SDK-Version": "4.3.2321",
47
- "User-Agent": "@athenaintel/sdk/4.3.2321",
46
+ "X-Fern-SDK-Version": "4.3.2323",
47
+ "User-Agent": "@athenaintel/sdk/4.3.2323",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  "X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
@@ -74,7 +74,7 @@ export declare class AssetsClient {
74
74
  create(request: AthenaIntelligence.CreateAssetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.CreateAssetResponseOut>;
75
75
  private __create;
76
76
  /**
77
- * Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
77
+ * Create a Word document from a .docx file, or a presentation from a PowerPoint presentation, show or template (.pptx, .pptm, .ppsx, .ppsm, .potx, .potm), holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A macro-enabled file keeps its macros, never run, and the presentation downloads in the file's own format. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
78
78
  *
79
79
  * @param {AthenaIntelligence.BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost} request
80
80
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -158,7 +158,7 @@ export declare class AssetsClient {
158
158
  duplicate(request: AthenaIntelligence.DuplicateAssetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DuplicateAssetResponseOut>;
159
159
  private __duplicate;
160
160
  /**
161
- * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
161
+ * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
162
162
  *
163
163
  * @param {AthenaIntelligence.CreateUploadLinkRequestIn} request
164
164
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -357,7 +357,7 @@ class AssetsClient {
357
357
  });
358
358
  }
359
359
  /**
360
- * Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
360
+ * Create a Word document from a .docx file, or a presentation from a PowerPoint presentation, show or template (.pptx, .pptm, .ppsx, .ppsm, .potx, .potm), holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A macro-enabled file keeps its macros, never run, and the presentation downloads in the file's own format. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
361
361
  *
362
362
  * @param {AthenaIntelligence.BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost} request
363
363
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -725,7 +725,7 @@ class AssetsClient {
725
725
  });
726
726
  }
727
727
  /**
728
- * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
728
+ * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
729
729
  *
730
730
  * @param {AthenaIntelligence.CreateUploadLinkRequestIn} request
731
731
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -14,6 +14,6 @@ export interface BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost {
14
14
  workspace_id?: string | null;
15
15
  /** An asset you can read that the file came from; without parent_folder_id the new asset goes next to it when you may create there */
16
16
  source_asset_id?: string | null;
17
- /** The .docx, .pptx, .potx, .ppt, .pps, .md, .markdown, .txt, .text, .html or .htm file to create the asset from */
17
+ /** The .docx, .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt, .pps, .md, .markdown, .txt, .text, .html or .htm file to create the asset from */
18
18
  file: core.file.Uploadable;
19
19
  }
@@ -7,7 +7,7 @@
7
7
  * }
8
8
  */
9
9
  export interface CreateUploadLinkRequestIn {
10
- /** The name of the file you will send, which decides what it becomes, as in POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation */
10
+ /** The name of the file you will send, which decides what it becomes, as in POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation */
11
11
  file_name: string;
12
12
  /** Folder to put the new asset in; you need EDIT on it */
13
13
  parent_folder_id?: string | null;
@@ -102,7 +102,7 @@ export declare class TasksClient {
102
102
  update(request: AthenaIntelligence.UpdateTaskRequestIn, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.TaskOut>;
103
103
  private __update;
104
104
  /**
105
- * 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.
105
+ * Mark a task done (completed, or not_planned: won't do), or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who, when and why; reopening clears them.
106
106
  *
107
107
  * @param {AthenaIntelligence.SetTaskStatusRequestIn} request
108
108
  * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -116,6 +116,7 @@ export declare class TasksClient {
116
116
  * @example
117
117
  * await client.tasks.setStatus({
118
118
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
119
+ * reason: "completed",
119
120
  * status: "done"
120
121
  * })
121
122
  */
@@ -444,7 +444,7 @@ class TasksClient {
444
444
  });
445
445
  }
446
446
  /**
447
- * 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.
447
+ * Mark a task done (completed, or not_planned: won't do), or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who, when and why; reopening clears them.
448
448
  *
449
449
  * @param {AthenaIntelligence.SetTaskStatusRequestIn} request
450
450
  * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -458,6 +458,7 @@ class TasksClient {
458
458
  * @example
459
459
  * await client.tasks.setStatus({
460
460
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
461
+ * reason: "completed",
461
462
  * status: "done"
462
463
  * })
463
464
  */
@@ -34,6 +34,8 @@ export interface CreateTaskRequestIn {
34
34
  links?: AthenaIntelligence.TaskLinkIn[] | null;
35
35
  /** A folder or project to put it in; needs edit access there. */
36
36
  parent_folder_id?: string | null;
37
+ /** A task to make it a sub-task of: one of the same workspace the caller can open and change. */
38
+ parent_task_id?: string | null;
37
39
  /** How much it matters; left out, none. */
38
40
  priority?: CreateTaskRequestIn.Priority | null;
39
41
  /** What to do, in a short line (at most 500 characters). */
@@ -47,6 +49,7 @@ export declare namespace CreateTaskRequestIn {
47
49
  readonly Low: "low";
48
50
  readonly Medium: "medium";
49
51
  readonly High: "high";
52
+ readonly Urgent: "urgent";
50
53
  };
51
54
  type Priority = (typeof Priority)[keyof typeof Priority];
52
55
  }
@@ -9,5 +9,6 @@ var CreateTaskRequestIn;
9
9
  Low: "low",
10
10
  Medium: "medium",
11
11
  High: "high",
12
+ Urgent: "urgent",
12
13
  };
13
14
  })(CreateTaskRequestIn || (exports.CreateTaskRequestIn = CreateTaskRequestIn = {}));
@@ -2,16 +2,24 @@
2
2
  * @example
3
3
  * {
4
4
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
5
+ * reason: "completed",
5
6
  * status: "done"
6
7
  * }
7
8
  */
8
9
  export interface SetTaskStatusRequestIn {
9
10
  /** The task's asset id. */
10
11
  asset_id: string;
12
+ /** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. */
13
+ reason?: SetTaskStatusRequestIn.Reason | null;
11
14
  /** open or done. */
12
15
  status: SetTaskStatusRequestIn.Status;
13
16
  }
14
17
  export declare namespace SetTaskStatusRequestIn {
18
+ const Reason: {
19
+ readonly Completed: "completed";
20
+ readonly NotPlanned: "not_planned";
21
+ };
22
+ type Reason = (typeof Reason)[keyof typeof Reason];
15
23
  /** open or done. */
16
24
  const Status: {
17
25
  readonly Open: "open";
@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.SetTaskStatusRequestIn = void 0;
5
5
  var SetTaskStatusRequestIn;
6
6
  (function (SetTaskStatusRequestIn) {
7
+ SetTaskStatusRequestIn.Reason = {
8
+ Completed: "completed",
9
+ NotPlanned: "not_planned",
10
+ };
7
11
  /** open or done. */
8
12
  SetTaskStatusRequestIn.Status = {
9
13
  Open: "open",
@@ -11,6 +11,8 @@ export interface UpdateTaskRequestIn {
11
11
  asset_id: string;
12
12
  /** user_…, agent_asset_… or me; null assigns it to nobody. The assignee must already be able to open the task. */
13
13
  assignee_ref?: string | null;
14
+ /** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. */
15
+ completion_reason?: UpdateTaskRequestIn.CompletionReason | null;
14
16
  /** New details (markdown); null clears them. */
15
17
  description?: string | null;
16
18
  /** YYYY-MM-DD; null clears the due date and its time. */
@@ -23,6 +25,8 @@ export interface UpdateTaskRequestIn {
23
25
  labels?: AthenaIntelligence.TaskLabelIn[] | null;
24
26
  /** The full new set of links; null removes them all. Links already on the task that the caller cannot open are kept. */
25
27
  links?: AthenaIntelligence.TaskLinkIn[] | null;
28
+ /** A task to make it a sub-task of (same workspace, one the caller can open and change, never one of its own sub-tasks); null makes it no sub-task. */
29
+ parent_task_id?: string | null;
26
30
  /** How much it matters; null is none. */
27
31
  priority?: UpdateTaskRequestIn.Priority | null;
28
32
  /** open or done (it cannot be cleared). */
@@ -31,11 +35,17 @@ export interface UpdateTaskRequestIn {
31
35
  title?: string | null;
32
36
  }
33
37
  export declare namespace UpdateTaskRequestIn {
38
+ const CompletionReason: {
39
+ readonly Completed: "completed";
40
+ readonly NotPlanned: "not_planned";
41
+ };
42
+ type CompletionReason = (typeof CompletionReason)[keyof typeof CompletionReason];
34
43
  const Priority: {
35
44
  readonly None: "none";
36
45
  readonly Low: "low";
37
46
  readonly Medium: "medium";
38
47
  readonly High: "high";
48
+ readonly Urgent: "urgent";
39
49
  };
40
50
  type Priority = (typeof Priority)[keyof typeof Priority];
41
51
  const Status: {
@@ -4,11 +4,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.UpdateTaskRequestIn = void 0;
5
5
  var UpdateTaskRequestIn;
6
6
  (function (UpdateTaskRequestIn) {
7
+ UpdateTaskRequestIn.CompletionReason = {
8
+ Completed: "completed",
9
+ NotPlanned: "not_planned",
10
+ };
7
11
  UpdateTaskRequestIn.Priority = {
8
12
  None: "none",
9
13
  Low: "low",
10
14
  Medium: "medium",
11
15
  High: "high",
16
+ Urgent: "urgent",
12
17
  };
13
18
  UpdateTaskRequestIn.Status = {
14
19
  Open: "open",
@@ -11,6 +11,8 @@ export interface TaskOut {
11
11
  completed_at: string | null;
12
12
  /** Who marked it done. */
13
13
  completed_by_ref: string | null;
14
+ /** Why it is done (completed or not_planned); null while open. */
15
+ completion_reason: TaskOut.CompletionReason | null;
14
16
  created_at: string | null;
15
17
  /** The user who created it. */
16
18
  created_by: string | null;
@@ -29,18 +31,30 @@ export interface TaskOut {
29
31
  labels: AthenaIntelligence.TaskLabelOut[];
30
32
  /** The records it is about, read as the caller. Always empty in a list. */
31
33
  links: AthenaIntelligence.TaskLinkOut[];
34
+ /** Its number in its workspace (1, 2, 3, …), shown as T-<n>; null for a task written before tasks were numbered. */
35
+ number: number | null;
36
+ /** The task it is a sub-task of, read through that task's own gate; null when it is no sub-task. */
37
+ parent: AthenaIntelligence.TaskParentOut | null;
32
38
  priority: TaskOut.Priority;
33
39
  status: TaskOut.Status;
40
+ /** How many of its sub-tasks the caller can open are done, of how many. */
41
+ subtask_progress: AthenaIntelligence.TaskSubtaskProgressOut;
34
42
  title: string;
35
43
  updated_at: string | null;
36
44
  workspace_id: string;
37
45
  }
38
46
  export declare namespace TaskOut {
47
+ const CompletionReason: {
48
+ readonly Completed: "completed";
49
+ readonly NotPlanned: "not_planned";
50
+ };
51
+ type CompletionReason = (typeof CompletionReason)[keyof typeof CompletionReason];
39
52
  const Priority: {
40
53
  readonly None: "none";
41
54
  readonly Low: "low";
42
55
  readonly Medium: "medium";
43
56
  readonly High: "high";
57
+ readonly Urgent: "urgent";
44
58
  };
45
59
  type Priority = (typeof Priority)[keyof typeof Priority];
46
60
  const Status: {
@@ -4,11 +4,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.TaskOut = void 0;
5
5
  var TaskOut;
6
6
  (function (TaskOut) {
7
+ TaskOut.CompletionReason = {
8
+ Completed: "completed",
9
+ NotPlanned: "not_planned",
10
+ };
7
11
  TaskOut.Priority = {
8
12
  None: "none",
9
13
  Low: "low",
10
14
  Medium: "medium",
11
15
  High: "high",
16
+ Urgent: "urgent",
12
17
  };
13
18
  TaskOut.Status = {
14
19
  Open: "open",
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The task a sub-task belongs to, read through its own gate.
3
+ */
4
+ export interface TaskParentOut {
5
+ /** Its asset id; null when the caller can't open it. */
6
+ id: string | null;
7
+ /** Its number (T-<n>); null when the caller can't open it. */
8
+ number: number | null;
9
+ /** Whether the caller can open it. */
10
+ readable: boolean;
11
+ /** open or done; null when the caller can't open it. */
12
+ status: TaskParentOut.Status | null;
13
+ /** Its title; null when the caller can't open it. */
14
+ title: string | null;
15
+ }
16
+ export declare namespace TaskParentOut {
17
+ const Status: {
18
+ readonly Open: "open";
19
+ readonly Done: "done";
20
+ };
21
+ type Status = (typeof Status)[keyof typeof Status];
22
+ }
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.TaskParentOut = void 0;
5
+ var TaskParentOut;
6
+ (function (TaskParentOut) {
7
+ TaskParentOut.Status = {
8
+ Open: "open",
9
+ Done: "done",
10
+ };
11
+ })(TaskParentOut || (exports.TaskParentOut = TaskParentOut = {}));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * How far along a task's sub-tasks are, among those the caller can open.
3
+ */
4
+ export interface TaskSubtaskProgressOut {
5
+ /** How many of them are done. */
6
+ done: number;
7
+ /** How many there are. */
8
+ total: number;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -162,6 +162,8 @@ export * from "./TaskLinkIn.js";
162
162
  export * from "./TaskLinkOut.js";
163
163
  export * from "./TaskListOut.js";
164
164
  export * from "./TaskOut.js";
165
+ export * from "./TaskParentOut.js";
166
+ export * from "./TaskSubtaskProgressOut.js";
165
167
  export * from "./TextContent.js";
166
168
  export * from "./TextFormatModel.js";
167
169
  export * from "./ThemeColor.js";
@@ -178,6 +178,8 @@ __exportStar(require("./TaskLinkIn.js"), exports);
178
178
  __exportStar(require("./TaskLinkOut.js"), exports);
179
179
  __exportStar(require("./TaskListOut.js"), exports);
180
180
  __exportStar(require("./TaskOut.js"), exports);
181
+ __exportStar(require("./TaskParentOut.js"), exports);
182
+ __exportStar(require("./TaskSubtaskProgressOut.js"), exports);
181
183
  __exportStar(require("./TextContent.js"), exports);
182
184
  __exportStar(require("./TextFormatModel.js"), exports);
183
185
  __exportStar(require("./ThemeColor.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2321";
1
+ export declare const SDK_VERSION = "4.3.2323";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "4.3.2321";
4
+ exports.SDK_VERSION = "4.3.2323";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@athenaintel/sdk",
9
- "X-Fern-SDK-Version": "4.3.2321",
10
- "User-Agent": "@athenaintel/sdk/4.3.2321",
9
+ "X-Fern-SDK-Version": "4.3.2323",
10
+ "User-Agent": "@athenaintel/sdk/4.3.2323",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  "X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
@@ -74,7 +74,7 @@ export declare class AssetsClient {
74
74
  create(request: AthenaIntelligence.CreateAssetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.CreateAssetResponseOut>;
75
75
  private __create;
76
76
  /**
77
- * Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
77
+ * Create a Word document from a .docx file, or a presentation from a PowerPoint presentation, show or template (.pptx, .pptm, .ppsx, .ppsm, .potx, .potm), holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A macro-enabled file keeps its macros, never run, and the presentation downloads in the file's own format. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
78
78
  *
79
79
  * @param {AthenaIntelligence.BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost} request
80
80
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -158,7 +158,7 @@ export declare class AssetsClient {
158
158
  duplicate(request: AthenaIntelligence.DuplicateAssetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DuplicateAssetResponseOut>;
159
159
  private __duplicate;
160
160
  /**
161
- * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
161
+ * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
162
162
  *
163
163
  * @param {AthenaIntelligence.CreateUploadLinkRequestIn} request
164
164
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -321,7 +321,7 @@ export class AssetsClient {
321
321
  });
322
322
  }
323
323
  /**
324
- * Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
324
+ * Create a Word document from a .docx file, or a presentation from a PowerPoint presentation, show or template (.pptx, .pptm, .ppsx, .ppsm, .potx, .potm), holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A macro-enabled file keeps its macros, never run, and the presentation downloads in the file's own format. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
325
325
  *
326
326
  * @param {AthenaIntelligence.BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost} request
327
327
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -689,7 +689,7 @@ export class AssetsClient {
689
689
  });
690
690
  }
691
691
  /**
692
- * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
692
+ * Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
693
693
  *
694
694
  * @param {AthenaIntelligence.CreateUploadLinkRequestIn} request
695
695
  * @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -14,6 +14,6 @@ export interface BodyCreateAssetFromFilePublicApiV0AssetsCreateFromFilePost {
14
14
  workspace_id?: string | null;
15
15
  /** An asset you can read that the file came from; without parent_folder_id the new asset goes next to it when you may create there */
16
16
  source_asset_id?: string | null;
17
- /** The .docx, .pptx, .potx, .ppt, .pps, .md, .markdown, .txt, .text, .html or .htm file to create the asset from */
17
+ /** The .docx, .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt, .pps, .md, .markdown, .txt, .text, .html or .htm file to create the asset from */
18
18
  file: core.file.Uploadable;
19
19
  }
@@ -7,7 +7,7 @@
7
7
  * }
8
8
  */
9
9
  export interface CreateUploadLinkRequestIn {
10
- /** The name of the file you will send, which decides what it becomes, as in POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation */
10
+ /** The name of the file you will send, which decides what it becomes, as in POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation */
11
11
  file_name: string;
12
12
  /** Folder to put the new asset in; you need EDIT on it */
13
13
  parent_folder_id?: string | null;
@@ -102,7 +102,7 @@ export declare class TasksClient {
102
102
  update(request: AthenaIntelligence.UpdateTaskRequestIn, requestOptions?: TasksClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.TaskOut>;
103
103
  private __update;
104
104
  /**
105
- * 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.
105
+ * Mark a task done (completed, or not_planned: won't do), or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who, when and why; reopening clears them.
106
106
  *
107
107
  * @param {AthenaIntelligence.SetTaskStatusRequestIn} request
108
108
  * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -116,6 +116,7 @@ export declare class TasksClient {
116
116
  * @example
117
117
  * await client.tasks.setStatus({
118
118
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
119
+ * reason: "completed",
119
120
  * status: "done"
120
121
  * })
121
122
  */
@@ -408,7 +408,7 @@ export class TasksClient {
408
408
  });
409
409
  }
410
410
  /**
411
- * 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.
411
+ * Mark a task done (completed, or not_planned: won't do), or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who, when and why; reopening clears them.
412
412
  *
413
413
  * @param {AthenaIntelligence.SetTaskStatusRequestIn} request
414
414
  * @param {TasksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -422,6 +422,7 @@ export class TasksClient {
422
422
  * @example
423
423
  * await client.tasks.setStatus({
424
424
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
425
+ * reason: "completed",
425
426
  * status: "done"
426
427
  * })
427
428
  */
@@ -34,6 +34,8 @@ export interface CreateTaskRequestIn {
34
34
  links?: AthenaIntelligence.TaskLinkIn[] | null;
35
35
  /** A folder or project to put it in; needs edit access there. */
36
36
  parent_folder_id?: string | null;
37
+ /** A task to make it a sub-task of: one of the same workspace the caller can open and change. */
38
+ parent_task_id?: string | null;
37
39
  /** How much it matters; left out, none. */
38
40
  priority?: CreateTaskRequestIn.Priority | null;
39
41
  /** What to do, in a short line (at most 500 characters). */
@@ -47,6 +49,7 @@ export declare namespace CreateTaskRequestIn {
47
49
  readonly Low: "low";
48
50
  readonly Medium: "medium";
49
51
  readonly High: "high";
52
+ readonly Urgent: "urgent";
50
53
  };
51
54
  type Priority = (typeof Priority)[keyof typeof Priority];
52
55
  }
@@ -6,5 +6,6 @@ export var CreateTaskRequestIn;
6
6
  Low: "low",
7
7
  Medium: "medium",
8
8
  High: "high",
9
+ Urgent: "urgent",
9
10
  };
10
11
  })(CreateTaskRequestIn || (CreateTaskRequestIn = {}));
@@ -2,16 +2,24 @@
2
2
  * @example
3
3
  * {
4
4
  * asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
5
+ * reason: "completed",
5
6
  * status: "done"
6
7
  * }
7
8
  */
8
9
  export interface SetTaskStatusRequestIn {
9
10
  /** The task's asset id. */
10
11
  asset_id: string;
12
+ /** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. */
13
+ reason?: SetTaskStatusRequestIn.Reason | null;
11
14
  /** open or done. */
12
15
  status: SetTaskStatusRequestIn.Status;
13
16
  }
14
17
  export declare namespace SetTaskStatusRequestIn {
18
+ const Reason: {
19
+ readonly Completed: "completed";
20
+ readonly NotPlanned: "not_planned";
21
+ };
22
+ type Reason = (typeof Reason)[keyof typeof Reason];
15
23
  /** open or done. */
16
24
  const Status: {
17
25
  readonly Open: "open";
@@ -1,6 +1,10 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export var SetTaskStatusRequestIn;
3
3
  (function (SetTaskStatusRequestIn) {
4
+ SetTaskStatusRequestIn.Reason = {
5
+ Completed: "completed",
6
+ NotPlanned: "not_planned",
7
+ };
4
8
  /** open or done. */
5
9
  SetTaskStatusRequestIn.Status = {
6
10
  Open: "open",
@@ -11,6 +11,8 @@ export interface UpdateTaskRequestIn {
11
11
  asset_id: string;
12
12
  /** user_…, agent_asset_… or me; null assigns it to nobody. The assignee must already be able to open the task. */
13
13
  assignee_ref?: string | null;
14
+ /** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. */
15
+ completion_reason?: UpdateTaskRequestIn.CompletionReason | null;
14
16
  /** New details (markdown); null clears them. */
15
17
  description?: string | null;
16
18
  /** YYYY-MM-DD; null clears the due date and its time. */
@@ -23,6 +25,8 @@ export interface UpdateTaskRequestIn {
23
25
  labels?: AthenaIntelligence.TaskLabelIn[] | null;
24
26
  /** The full new set of links; null removes them all. Links already on the task that the caller cannot open are kept. */
25
27
  links?: AthenaIntelligence.TaskLinkIn[] | null;
28
+ /** A task to make it a sub-task of (same workspace, one the caller can open and change, never one of its own sub-tasks); null makes it no sub-task. */
29
+ parent_task_id?: string | null;
26
30
  /** How much it matters; null is none. */
27
31
  priority?: UpdateTaskRequestIn.Priority | null;
28
32
  /** open or done (it cannot be cleared). */
@@ -31,11 +35,17 @@ export interface UpdateTaskRequestIn {
31
35
  title?: string | null;
32
36
  }
33
37
  export declare namespace UpdateTaskRequestIn {
38
+ const CompletionReason: {
39
+ readonly Completed: "completed";
40
+ readonly NotPlanned: "not_planned";
41
+ };
42
+ type CompletionReason = (typeof CompletionReason)[keyof typeof CompletionReason];
34
43
  const Priority: {
35
44
  readonly None: "none";
36
45
  readonly Low: "low";
37
46
  readonly Medium: "medium";
38
47
  readonly High: "high";
48
+ readonly Urgent: "urgent";
39
49
  };
40
50
  type Priority = (typeof Priority)[keyof typeof Priority];
41
51
  const Status: {
@@ -1,11 +1,16 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export var UpdateTaskRequestIn;
3
3
  (function (UpdateTaskRequestIn) {
4
+ UpdateTaskRequestIn.CompletionReason = {
5
+ Completed: "completed",
6
+ NotPlanned: "not_planned",
7
+ };
4
8
  UpdateTaskRequestIn.Priority = {
5
9
  None: "none",
6
10
  Low: "low",
7
11
  Medium: "medium",
8
12
  High: "high",
13
+ Urgent: "urgent",
9
14
  };
10
15
  UpdateTaskRequestIn.Status = {
11
16
  Open: "open",
@@ -11,6 +11,8 @@ export interface TaskOut {
11
11
  completed_at: string | null;
12
12
  /** Who marked it done. */
13
13
  completed_by_ref: string | null;
14
+ /** Why it is done (completed or not_planned); null while open. */
15
+ completion_reason: TaskOut.CompletionReason | null;
14
16
  created_at: string | null;
15
17
  /** The user who created it. */
16
18
  created_by: string | null;
@@ -29,18 +31,30 @@ export interface TaskOut {
29
31
  labels: AthenaIntelligence.TaskLabelOut[];
30
32
  /** The records it is about, read as the caller. Always empty in a list. */
31
33
  links: AthenaIntelligence.TaskLinkOut[];
34
+ /** Its number in its workspace (1, 2, 3, …), shown as T-<n>; null for a task written before tasks were numbered. */
35
+ number: number | null;
36
+ /** The task it is a sub-task of, read through that task's own gate; null when it is no sub-task. */
37
+ parent: AthenaIntelligence.TaskParentOut | null;
32
38
  priority: TaskOut.Priority;
33
39
  status: TaskOut.Status;
40
+ /** How many of its sub-tasks the caller can open are done, of how many. */
41
+ subtask_progress: AthenaIntelligence.TaskSubtaskProgressOut;
34
42
  title: string;
35
43
  updated_at: string | null;
36
44
  workspace_id: string;
37
45
  }
38
46
  export declare namespace TaskOut {
47
+ const CompletionReason: {
48
+ readonly Completed: "completed";
49
+ readonly NotPlanned: "not_planned";
50
+ };
51
+ type CompletionReason = (typeof CompletionReason)[keyof typeof CompletionReason];
39
52
  const Priority: {
40
53
  readonly None: "none";
41
54
  readonly Low: "low";
42
55
  readonly Medium: "medium";
43
56
  readonly High: "high";
57
+ readonly Urgent: "urgent";
44
58
  };
45
59
  type Priority = (typeof Priority)[keyof typeof Priority];
46
60
  const Status: {
@@ -1,11 +1,16 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  export var TaskOut;
3
3
  (function (TaskOut) {
4
+ TaskOut.CompletionReason = {
5
+ Completed: "completed",
6
+ NotPlanned: "not_planned",
7
+ };
4
8
  TaskOut.Priority = {
5
9
  None: "none",
6
10
  Low: "low",
7
11
  Medium: "medium",
8
12
  High: "high",
13
+ Urgent: "urgent",
9
14
  };
10
15
  TaskOut.Status = {
11
16
  Open: "open",
@@ -0,0 +1,22 @@
1
+ /**
2
+ * The task a sub-task belongs to, read through its own gate.
3
+ */
4
+ export interface TaskParentOut {
5
+ /** Its asset id; null when the caller can't open it. */
6
+ id: string | null;
7
+ /** Its number (T-<n>); null when the caller can't open it. */
8
+ number: number | null;
9
+ /** Whether the caller can open it. */
10
+ readable: boolean;
11
+ /** open or done; null when the caller can't open it. */
12
+ status: TaskParentOut.Status | null;
13
+ /** Its title; null when the caller can't open it. */
14
+ title: string | null;
15
+ }
16
+ export declare namespace TaskParentOut {
17
+ const Status: {
18
+ readonly Open: "open";
19
+ readonly Done: "done";
20
+ };
21
+ type Status = (typeof Status)[keyof typeof Status];
22
+ }
@@ -0,0 +1,8 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var TaskParentOut;
3
+ (function (TaskParentOut) {
4
+ TaskParentOut.Status = {
5
+ Open: "open",
6
+ Done: "done",
7
+ };
8
+ })(TaskParentOut || (TaskParentOut = {}));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * How far along a task's sub-tasks are, among those the caller can open.
3
+ */
4
+ export interface TaskSubtaskProgressOut {
5
+ /** How many of them are done. */
6
+ done: number;
7
+ /** How many there are. */
8
+ total: number;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -162,6 +162,8 @@ export * from "./TaskLinkIn.mjs";
162
162
  export * from "./TaskLinkOut.mjs";
163
163
  export * from "./TaskListOut.mjs";
164
164
  export * from "./TaskOut.mjs";
165
+ export * from "./TaskParentOut.mjs";
166
+ export * from "./TaskSubtaskProgressOut.mjs";
165
167
  export * from "./TextContent.mjs";
166
168
  export * from "./TextFormatModel.mjs";
167
169
  export * from "./ThemeColor.mjs";
@@ -162,6 +162,8 @@ export * from "./TaskLinkIn.mjs";
162
162
  export * from "./TaskLinkOut.mjs";
163
163
  export * from "./TaskListOut.mjs";
164
164
  export * from "./TaskOut.mjs";
165
+ export * from "./TaskParentOut.mjs";
166
+ export * from "./TaskSubtaskProgressOut.mjs";
165
167
  export * from "./TextContent.mjs";
166
168
  export * from "./TextFormatModel.mjs";
167
169
  export * from "./ThemeColor.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2321";
1
+ export declare const SDK_VERSION = "4.3.2323";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2321";
1
+ export const SDK_VERSION = "4.3.2323";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2321",
3
+ "version": "4.3.2323",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -715,7 +715,7 @@ await client.assets.create({
715
715
  <dl>
716
716
  <dd>
717
717
 
718
- Create a Word document from a .docx file, or a presentation from a .pptx or .potx file, holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
718
+ Create a Word document from a .docx file, or a presentation from a PowerPoint presentation, show or template (.pptx, .pptm, .ppsx, .ppsm, .potx, .potm), holding that file's content: the asset Athena makes when you create one from a file in the app. Athena imports the file through DOCX Studio or PPTX Studio with its own studio credential, as your write, and answers once the asset is ready (a large deck can take a few minutes). A PowerPoint 97-2003 presentation or show (.ppt, .pps) makes a presentation too: PPTX Studio converts it to .pptx first, as PowerPoint for the web does to edit one, and the presentation's import report says so. A macro-enabled file keeps its macros, never run, and the presentation downloads in the file's own format. A Markdown (.md, .markdown) or plain-text (.txt, .text) file becomes an Athena document, its Markdown rendered (headings, lists, tables, links) and plain text one paragraph per line, and an HTML (.html, .htm) file becomes a user interface: Athena stores the file and converts it in place in the request, as the app's Convert to does, so the original upload stays downloadable from the new asset's Versions pane. A Markdown or text file may be up to 2 MiB and an HTML file up to 5 MiB. Nothing is left behind when the import or conversion fails. The file's name decides the type; the title defaults to the name without its extension. Gates are those of POST /api/v0/assets/create: membership in the workspace (workspace_id, else parent_folder_id's, else your current one) and EDIT on parent_folder_id. With source_asset_id (an asset you can read, for example the document the file was exported from) and no parent_folder_id, the new asset goes into the source's folder when you may create there, otherwise at your root. Unlike POST /api/v0/tools/file/save, which stores the file itself and turns an Office upload into its editable type in the background, this makes the editable asset in the request and keeps no file asset. A Word file may be up to 100 MB, Word for the web's limit, a PowerPoint file up to 100 MiB. A Word file gets the app's upload checks before anything is created, and one it refuses answers 422 with detail {code, message}: code is password_protected, rights_managed, damaged (unreadable content, which File > Import in the app can recover), format_mismatch (a template or macro-enabled file named .docx), not_ooxml, too_large or uncompressed_too_large, and message says why in Word's words. From an agent run (a verified X-Athena-Session-Credential), a Word document's first write also records the run, a presentation takes the create_presentation_pptx_studio tool policy and a user interface the create_new_user_interface tool policy.
719
719
  </dd>
720
720
  </dl>
721
721
  </dd>
@@ -978,7 +978,7 @@ await client.assets.duplicate({
978
978
  <dl>
979
979
  <dd>
980
980
 
981
- Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .potx, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
981
+ Mint a one-time link that takes one file without an API key, for a caller that can run a shell command but holds no key, such as an agent connected through an Athena MCP server. The file's name decides what it becomes, as with POST /api/v0/assets/create-from-file: a .md, .markdown, .txt or .text file an Athena document, a .html or .htm file a user interface, a .docx file a Word document and a .pptx, .pptm, .ppsx, .ppsm, .potx, .potm, .ppt or .pps file a presentation. The gates of create-from-file run now (membership in the workspace, EDIT on parent_folder_id, the deployment's offering, an agent run's tool policy) and again when the file arrives. Send the file's bytes as the body of one PUT to upload_url with the X-Athena-Upload-Token header (the curl field is that command); its answer is the new asset. A link works once, for 15 minutes.
982
982
  </dd>
983
983
  </dl>
984
984
  </dd>
@@ -5415,7 +5415,7 @@ await client.tasks.update({
5415
5415
  <dl>
5416
5416
  <dd>
5417
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.
5418
+ Mark a task done (completed, or not_planned: won't do), or open it again. Needs edit access, and the task must not be in the trash. Marking it done records who, when and why; reopening clears them.
5419
5419
  </dd>
5420
5420
  </dl>
5421
5421
  </dd>
@@ -5432,6 +5432,7 @@ Mark a task done, or open it again. Needs edit access, and the task must not be
5432
5432
  ```typescript
5433
5433
  await client.tasks.setStatus({
5434
5434
  asset_id: "asset_7c1e5b2a-4f3d-4e8a-9b6c-1d2e3f4a5b6c",
5435
+ reason: "completed",
5435
5436
  status: "done"
5436
5437
  });
5437
5438