dart-tools 0.3.8 → 0.3.9

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/index.d.ts CHANGED
@@ -12,6 +12,7 @@ export type { Doc } from "./models/Doc";
12
12
  export type { DocCreate } from "./models/DocCreate";
13
13
  export type { DocUpdate } from "./models/DocUpdate";
14
14
  export type { Folder } from "./models/Folder";
15
+ export type { PaginatedCommentList } from "./models/PaginatedCommentList";
15
16
  export type { PaginatedConciseDocList } from "./models/PaginatedConciseDocList";
16
17
  export type { PaginatedConciseTaskList } from "./models/PaginatedConciseTaskList";
17
18
  export { Priority } from "./models/Priority";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../dart/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,4CAA2C;AAAlC,oGAAA,QAAQ,OAAA;AACjB,8DAA0E;AAAjE,sHAAA,iBAAiB,OAAA;AAAE,gHAAA,WAAW,OAAA;AACvC,0CAAyC;AAAhC,kGAAA,OAAO,OAAA;AAehB,8CAA6C;AAApC,oGAAA,QAAQ,OAAA;AAmBjB,4DAA2D;AAAlD,gHAAA,cAAc,OAAA;AACvB,0DAAyD;AAAhD,8GAAA,aAAa,OAAA;AACtB,gEAA+D;AAAtD,oHAAA,gBAAgB,OAAA;AACzB,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,0DAAyD;AAAhD,8GAAA,aAAa,OAAA;AACtB,sDAAqD;AAA5C,0GAAA,WAAW,OAAA;AACpB,sDAAqD;AAA5C,0GAAA,WAAW,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../dart/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,4CAA2C;AAAlC,oGAAA,QAAQ,OAAA;AACjB,8DAA0E;AAAjE,sHAAA,iBAAiB,OAAA;AAAE,gHAAA,WAAW,OAAA;AACvC,0CAAyC;AAAhC,kGAAA,OAAO,OAAA;AAgBhB,8CAA6C;AAApC,oGAAA,QAAQ,OAAA;AAmBjB,4DAA2D;AAAlD,gHAAA,cAAc,OAAA;AACvB,0DAAyD;AAAhD,8GAAA,aAAa,OAAA;AACtB,gEAA+D;AAAtD,oHAAA,gBAAgB,OAAA;AACzB,oDAAmD;AAA1C,wGAAA,UAAU,OAAA;AACnB,0DAAyD;AAAhD,8GAAA,aAAa,OAAA;AACtB,sDAAqD;AAA5C,0GAAA,WAAW,OAAA;AACpB,sDAAqD;AAA5C,0GAAA,WAAW,OAAA"}
package/dist/index.mjs CHANGED
@@ -467,6 +467,31 @@ class CommentService {
467
467
  },
468
468
  });
469
469
  }
470
+ /**
471
+ * List all comments that the user has access to. This will return a list of comments, including the text, associated task ID, and others. Comments are ordered by thread and then by when they were written.
472
+ * @returns PaginatedCommentList
473
+ * @throws ApiError
474
+ */
475
+ static listComments({ taskId, author, authorId, ids, limit, o, offset, parentId, publishedAtAfter, publishedAtBefore, task, text, }) {
476
+ return request(OpenAPI, {
477
+ method: "GET",
478
+ url: "/comments/list",
479
+ query: {
480
+ author: author,
481
+ author_id: authorId,
482
+ ids: ids,
483
+ limit: limit,
484
+ o: o,
485
+ offset: offset,
486
+ parent_id: parentId,
487
+ published_at_after: publishedAtAfter,
488
+ published_at_before: publishedAtBefore,
489
+ task: task,
490
+ task_id: taskId,
491
+ text: text,
492
+ },
493
+ });
494
+ }
470
495
  }
471
496
 
472
497
  class ConfigService {
package/dist/index.umd.js CHANGED
@@ -470,6 +470,31 @@
470
470
  },
471
471
  });
472
472
  }
473
+ /**
474
+ * List all comments that the user has access to. This will return a list of comments, including the text, associated task ID, and others. Comments are ordered by thread and then by when they were written.
475
+ * @returns PaginatedCommentList
476
+ * @throws ApiError
477
+ */
478
+ static listComments({ taskId, author, authorId, ids, limit, o, offset, parentId, publishedAtAfter, publishedAtBefore, task, text, }) {
479
+ return request(OpenAPI, {
480
+ method: "GET",
481
+ url: "/comments/list",
482
+ query: {
483
+ author: author,
484
+ author_id: authorId,
485
+ ids: ids,
486
+ limit: limit,
487
+ o: o,
488
+ offset: offset,
489
+ parent_id: parentId,
490
+ published_at_after: publishedAtAfter,
491
+ published_at_before: publishedAtBefore,
492
+ task: task,
493
+ task_id: taskId,
494
+ text: text,
495
+ },
496
+ });
497
+ }
473
498
  }
474
499
 
475
500
  class ConfigService {
@@ -4,17 +4,21 @@ export type Comment = {
4
4
  */
5
5
  id: string;
6
6
  /**
7
- * The URL that can be used to open the comment in the Dart web UI.
7
+ * The universal, unique ID of the parent comment, if any.
8
8
  */
9
- htmlUrl: string;
9
+ parentId?: string;
10
10
  /**
11
- * The universal, unique ID of the task that the comment is associated with.
11
+ * The URL that can be used to open the comment in the Dart web UI.
12
12
  */
13
- taskId: string;
13
+ htmlUrl: string;
14
14
  /**
15
15
  * The name or email of the user that authored the comment.
16
16
  */
17
17
  author: string;
18
+ /**
19
+ * The universal, unique ID of the task that the comment is associated with.
20
+ */
21
+ taskId: string;
18
22
  /**
19
23
  * The full content of the comment, which can include markdown formatting.
20
24
  */
@@ -1,4 +1,8 @@
1
1
  export type CommentCreate = {
2
+ /**
3
+ * The universal, unique ID of the parent comment, if any.
4
+ */
5
+ parentId?: string;
2
6
  /**
3
7
  * The universal, unique ID of the task that the comment is associated with.
4
8
  */
@@ -0,0 +1,7 @@
1
+ import type { Comment } from "./Comment";
2
+ export type PaginatedCommentList = {
3
+ count: number;
4
+ next?: string | null;
5
+ previous?: string | null;
6
+ results: Array<Comment>;
7
+ };
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=PaginatedCommentList.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"PaginatedCommentList.js","sourceRoot":"","sources":["../../dart/generated/models/PaginatedCommentList.ts"],"names":[],"mappings":""}
@@ -1,3 +1,4 @@
1
+ import type { PaginatedCommentList } from "../models/PaginatedCommentList";
1
2
  import type { WrappedComment } from "../models/WrappedComment";
2
3
  import type { WrappedCommentCreate } from "../models/WrappedCommentCreate";
3
4
  import type { CancelablePromise } from "../core/CancelablePromise";
@@ -10,4 +11,39 @@ export declare class CommentService {
10
11
  * @throws ApiError
11
12
  */
12
13
  static createComment(requestBody: WrappedCommentCreate): CancelablePromise<WrappedComment>;
14
+ /**
15
+ * List all comments that the user has access to. This will return a list of comments, including the text, associated task ID, and others. Comments are ordered by thread and then by when they were written.
16
+ * @returns PaginatedCommentList
17
+ * @throws ApiError
18
+ */
19
+ static listComments({ taskId, author, authorId, ids, limit, o, offset, parentId, publishedAtAfter, publishedAtBefore, task, text, }: {
20
+ taskId: string;
21
+ author?: string;
22
+ authorId?: string;
23
+ /**
24
+ * Filter by IDs
25
+ */
26
+ ids?: string;
27
+ /**
28
+ * Number of results to return per page.
29
+ */
30
+ limit?: number;
31
+ /**
32
+ * Ordering
33
+ *
34
+ * * `published_at` - Published At
35
+ * * `-published_at` - Published At (descending)
36
+ * * `hierarchical` - Hierarchical
37
+ */
38
+ o?: Array<"-published_at" | "hierarchical" | "published_at">;
39
+ /**
40
+ * The initial index from which to return the results.
41
+ */
42
+ offset?: number;
43
+ parentId?: string | null;
44
+ publishedAtAfter?: string;
45
+ publishedAtBefore?: string;
46
+ task?: string;
47
+ text?: string;
48
+ }): CancelablePromise<PaginatedCommentList>;
13
49
  }
@@ -22,6 +22,31 @@ class CommentService {
22
22
  },
23
23
  });
24
24
  }
25
+ /**
26
+ * List all comments that the user has access to. This will return a list of comments, including the text, associated task ID, and others. Comments are ordered by thread and then by when they were written.
27
+ * @returns PaginatedCommentList
28
+ * @throws ApiError
29
+ */
30
+ static listComments({ taskId, author, authorId, ids, limit, o, offset, parentId, publishedAtAfter, publishedAtBefore, task, text, }) {
31
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
32
+ method: "GET",
33
+ url: "/comments/list",
34
+ query: {
35
+ author: author,
36
+ author_id: authorId,
37
+ ids: ids,
38
+ limit: limit,
39
+ o: o,
40
+ offset: offset,
41
+ parent_id: parentId,
42
+ published_at_after: publishedAtAfter,
43
+ published_at_before: publishedAtBefore,
44
+ task: task,
45
+ task_id: taskId,
46
+ text: text,
47
+ },
48
+ });
49
+ }
25
50
  }
26
51
  exports.CommentService = CommentService;
27
52
  //# sourceMappingURL=CommentService.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"CommentService.js","sourceRoot":"","sources":["../../dart/generated/services/CommentService.ts"],"names":[],"mappings":";;;AAOA,6CAA0C;AAC1C,6CAAuD;AACvD,MAAa,cAAc;IACzB;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAiC;QAC3D,OAAO,IAAA,iBAAS,EAAC,iBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,WAAW;YAChB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,uCAAuC;aAC7C;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,wCAmBC"}
1
+ {"version":3,"file":"CommentService.js","sourceRoot":"","sources":["../../dart/generated/services/CommentService.ts"],"names":[],"mappings":";;;AAQA,6CAA0C;AAC1C,6CAAuD;AACvD,MAAa,cAAc;IACzB;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,WAAiC;QAC3D,OAAO,IAAA,iBAAS,EAAC,iBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,WAAW;YAChB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,uCAAuC;aAC7C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,EACzB,MAAM,EACN,MAAM,EACN,QAAQ,EACR,GAAG,EACH,KAAK,EACL,CAAC,EACD,MAAM,EACN,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,EACjB,IAAI,EACJ,IAAI,GA8BL;QACC,OAAO,IAAA,iBAAS,EAAC,iBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gBAAgB;YACrB,KAAK,EAAE;gBACL,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,QAAQ;gBACnB,GAAG,EAAE,GAAG;gBACR,KAAK,EAAE,KAAK;gBACZ,CAAC,EAAE,CAAC;gBACJ,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,QAAQ;gBACnB,kBAAkB,EAAE,gBAAgB;gBACpC,mBAAmB,EAAE,iBAAiB;gBACtC,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,IAAI;aACX;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAtFD,wCAsFC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dart-tools",
3
- "version": "0.3.8",
3
+ "version": "0.3.9",
4
4
  "description": "The Dart TypeScript/JavaScript client",
5
5
  "keywords": [
6
6
  "dart",