@37signals/basecamp 0.20.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. package/README.md +1 -0
  2. package/dist/client.d.ts +5 -2
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +5 -2
  5. package/dist/client.js.map +1 -1
  6. package/dist/generated/metadata.d.ts.map +1 -1
  7. package/dist/generated/metadata.js +165 -2
  8. package/dist/generated/metadata.js.map +1 -1
  9. package/dist/generated/metadata.ts +165 -2
  10. package/dist/generated/openapi-stripped.json +2747 -1259
  11. package/dist/generated/path-mapping.d.ts.map +1 -1
  12. package/dist/generated/path-mapping.js +14 -1
  13. package/dist/generated/path-mapping.js.map +1 -1
  14. package/dist/generated/path-mapping.ts +14 -1
  15. package/dist/generated/person-id-sites.d.ts.map +1 -1
  16. package/dist/generated/person-id-sites.js +61 -2
  17. package/dist/generated/person-id-sites.js.map +1 -1
  18. package/dist/generated/person-id-sites.ts +61 -2
  19. package/dist/generated/schema.d.ts +1312 -129
  20. package/dist/generated/services/bookmarks.d.ts +1 -1
  21. package/dist/generated/services/bookmarks.js +1 -1
  22. package/dist/generated/services/bookmarks.ts +1 -1
  23. package/dist/generated/services/boosts.d.ts +2 -2
  24. package/dist/generated/services/boosts.js +2 -2
  25. package/dist/generated/services/boosts.ts +2 -2
  26. package/dist/generated/services/campfires.d.ts +4 -4
  27. package/dist/generated/services/campfires.js +4 -4
  28. package/dist/generated/services/campfires.ts +4 -4
  29. package/dist/generated/services/card-steps.d.ts +15 -11
  30. package/dist/generated/services/card-steps.d.ts.map +1 -1
  31. package/dist/generated/services/card-steps.js +4 -4
  32. package/dist/generated/services/card-steps.js.map +1 -1
  33. package/dist/generated/services/card-steps.ts +15 -11
  34. package/dist/generated/services/cards.d.ts +1 -1
  35. package/dist/generated/services/cards.js +1 -1
  36. package/dist/generated/services/cards.ts +1 -1
  37. package/dist/generated/services/checkins.d.ts +4 -4
  38. package/dist/generated/services/checkins.js +4 -4
  39. package/dist/generated/services/checkins.ts +4 -4
  40. package/dist/generated/services/client-approvals.d.ts +1 -1
  41. package/dist/generated/services/client-approvals.js +1 -1
  42. package/dist/generated/services/client-approvals.ts +1 -1
  43. package/dist/generated/services/client-correspondences.d.ts +1 -1
  44. package/dist/generated/services/client-correspondences.js +1 -1
  45. package/dist/generated/services/client-correspondences.ts +1 -1
  46. package/dist/generated/services/client-replies.d.ts +1 -1
  47. package/dist/generated/services/client-replies.js +1 -1
  48. package/dist/generated/services/client-replies.ts +1 -1
  49. package/dist/generated/services/comments.d.ts +1 -1
  50. package/dist/generated/services/comments.js +1 -1
  51. package/dist/generated/services/comments.ts +1 -1
  52. package/dist/generated/services/documents.d.ts +1 -1
  53. package/dist/generated/services/documents.js +1 -1
  54. package/dist/generated/services/documents.ts +1 -1
  55. package/dist/generated/services/drafts.d.ts +1 -1
  56. package/dist/generated/services/drafts.js +1 -1
  57. package/dist/generated/services/drafts.ts +1 -1
  58. package/dist/generated/services/events.d.ts +1 -1
  59. package/dist/generated/services/events.js +1 -1
  60. package/dist/generated/services/events.ts +1 -1
  61. package/dist/generated/services/everything.d.ts +14 -14
  62. package/dist/generated/services/everything.js +14 -14
  63. package/dist/generated/services/everything.ts +14 -14
  64. package/dist/generated/services/forwards.d.ts +2 -2
  65. package/dist/generated/services/forwards.js +2 -2
  66. package/dist/generated/services/forwards.ts +2 -2
  67. package/dist/generated/services/index.d.ts +2 -1
  68. package/dist/generated/services/index.d.ts.map +1 -1
  69. package/dist/generated/services/index.js +2 -1
  70. package/dist/generated/services/index.js.map +1 -1
  71. package/dist/generated/services/index.ts +2 -1
  72. package/dist/generated/services/message-types.d.ts +1 -1
  73. package/dist/generated/services/message-types.js +1 -1
  74. package/dist/generated/services/message-types.ts +1 -1
  75. package/dist/generated/services/messages.d.ts +1 -1
  76. package/dist/generated/services/messages.js +1 -1
  77. package/dist/generated/services/messages.ts +1 -1
  78. package/dist/generated/services/my-notifications.d.ts +3 -2
  79. package/dist/generated/services/my-notifications.d.ts.map +1 -1
  80. package/dist/generated/services/my-notifications.js +1 -1
  81. package/dist/generated/services/my-notifications.js.map +1 -1
  82. package/dist/generated/services/my-notifications.ts +3 -2
  83. package/dist/generated/services/people.d.ts +3 -3
  84. package/dist/generated/services/people.js +3 -3
  85. package/dist/generated/services/people.ts +3 -3
  86. package/dist/generated/services/projects.d.ts +1 -1
  87. package/dist/generated/services/projects.js +1 -1
  88. package/dist/generated/services/projects.ts +1 -1
  89. package/dist/generated/services/recordings.d.ts +3 -3
  90. package/dist/generated/services/recordings.js +3 -3
  91. package/dist/generated/services/recordings.ts +3 -3
  92. package/dist/generated/services/reports.d.ts +1 -1
  93. package/dist/generated/services/reports.js +1 -1
  94. package/dist/generated/services/reports.ts +1 -1
  95. package/dist/generated/services/schedules.d.ts +1 -1
  96. package/dist/generated/services/schedules.js +1 -1
  97. package/dist/generated/services/schedules.ts +1 -1
  98. package/dist/generated/services/subtasks.d.ts +157 -0
  99. package/dist/generated/services/subtasks.d.ts.map +1 -0
  100. package/dist/generated/services/subtasks.js +240 -0
  101. package/dist/generated/services/subtasks.js.map +1 -0
  102. package/dist/generated/services/subtasks.ts +336 -0
  103. package/dist/generated/services/templates.d.ts +114 -10
  104. package/dist/generated/services/templates.d.ts.map +1 -1
  105. package/dist/generated/services/templates.js +147 -10
  106. package/dist/generated/services/templates.js.map +1 -1
  107. package/dist/generated/services/templates.ts +220 -13
  108. package/dist/generated/services/timeline.d.ts +1 -1
  109. package/dist/generated/services/timeline.js +1 -1
  110. package/dist/generated/services/timeline.ts +1 -1
  111. package/dist/generated/services/timesheets.d.ts +3 -3
  112. package/dist/generated/services/timesheets.js +3 -3
  113. package/dist/generated/services/timesheets.ts +3 -3
  114. package/dist/generated/services/todolist-groups.d.ts +1 -1
  115. package/dist/generated/services/todolist-groups.js +1 -1
  116. package/dist/generated/services/todolist-groups.ts +1 -1
  117. package/dist/generated/services/todolists.d.ts +1 -1
  118. package/dist/generated/services/todolists.js +1 -1
  119. package/dist/generated/services/todolists.ts +1 -1
  120. package/dist/generated/services/todos.d.ts +1 -1
  121. package/dist/generated/services/todos.js +1 -1
  122. package/dist/generated/services/todos.ts +1 -1
  123. package/dist/generated/services/uploads.d.ts +2 -2
  124. package/dist/generated/services/uploads.js +2 -2
  125. package/dist/generated/services/uploads.ts +2 -2
  126. package/dist/generated/services/vaults.d.ts +1 -1
  127. package/dist/generated/services/vaults.js +1 -1
  128. package/dist/generated/services/vaults.ts +1 -1
  129. package/dist/generated/services/webhooks.d.ts +1 -1
  130. package/dist/generated/services/webhooks.js +1 -1
  131. package/dist/generated/services/webhooks.ts +1 -1
  132. package/dist/index.d.ts +2 -1
  133. package/dist/index.d.ts.map +1 -1
  134. package/dist/index.js +3 -0
  135. package/dist/index.js.map +1 -1
  136. package/package.json +3 -3
  137. package/src/generated/metadata.ts +165 -2
  138. package/src/generated/openapi-stripped.json +2747 -1259
  139. package/src/generated/path-mapping.ts +14 -1
  140. package/src/generated/person-id-sites.ts +61 -2
  141. package/src/generated/schema.d.ts +1312 -129
  142. package/src/generated/services/bookmarks.ts +1 -1
  143. package/src/generated/services/boosts.ts +2 -2
  144. package/src/generated/services/campfires.ts +4 -4
  145. package/src/generated/services/card-steps.ts +15 -11
  146. package/src/generated/services/cards.ts +1 -1
  147. package/src/generated/services/checkins.ts +4 -4
  148. package/src/generated/services/client-approvals.ts +1 -1
  149. package/src/generated/services/client-correspondences.ts +1 -1
  150. package/src/generated/services/client-replies.ts +1 -1
  151. package/src/generated/services/comments.ts +1 -1
  152. package/src/generated/services/documents.ts +1 -1
  153. package/src/generated/services/drafts.ts +1 -1
  154. package/src/generated/services/events.ts +1 -1
  155. package/src/generated/services/everything.ts +14 -14
  156. package/src/generated/services/forwards.ts +2 -2
  157. package/src/generated/services/index.ts +2 -1
  158. package/src/generated/services/message-types.ts +1 -1
  159. package/src/generated/services/messages.ts +1 -1
  160. package/src/generated/services/my-notifications.ts +3 -2
  161. package/src/generated/services/people.ts +3 -3
  162. package/src/generated/services/projects.ts +1 -1
  163. package/src/generated/services/recordings.ts +3 -3
  164. package/src/generated/services/reports.ts +1 -1
  165. package/src/generated/services/schedules.ts +1 -1
  166. package/src/generated/services/subtasks.ts +336 -0
  167. package/src/generated/services/templates.ts +220 -13
  168. package/src/generated/services/timeline.ts +1 -1
  169. package/src/generated/services/timesheets.ts +3 -3
  170. package/src/generated/services/todolist-groups.ts +1 -1
  171. package/src/generated/services/todolists.ts +1 -1
  172. package/src/generated/services/todos.ts +1 -1
  173. package/src/generated/services/uploads.ts +2 -2
  174. package/src/generated/services/vaults.ts +1 -1
  175. package/src/generated/services/webhooks.ts +1 -1
@@ -9,6 +9,7 @@ export { ClientApprovalsService } from "./client-approvals.js";
9
9
  export { ClientCorrespondencesService } from "./client-correspondences.js";
10
10
  export { ClientRepliesService } from "./client-replies.js";
11
11
  export { ToolsService } from "./tools.js";
12
+ export { TemplatesService } from "./templates.js";
12
13
  export { TodosService } from "./todos.js";
13
14
  export { CloudFilesService } from "./cloud-files.js";
14
15
  export { GoogleDocumentsService } from "./google-documents.js";
@@ -41,11 +42,11 @@ export { BubbleUpsService } from "./bubble-ups.js";
41
42
  export { ClientVisibilityService } from "./client-visibility.js";
42
43
  export { EventsService } from "./events.js";
43
44
  export { SubscriptionsService } from "./subscriptions.js";
45
+ export { SubtasksService } from "./subtasks.js";
44
46
  export { ReportsService } from "./reports.js";
45
47
  export { SchedulesService } from "./schedules.js";
46
48
  export { SearchService } from "./search.js";
47
49
  export { FoldersService } from "./folders.js";
48
- export { TemplatesService } from "./templates.js";
49
50
  export { TodolistGroupsService } from "./todolist-groups.js";
50
51
  export { TodolistsService } from "./todolists.js";
51
52
  export { TodosetsService } from "./todosets.js";
@@ -40,7 +40,7 @@ export declare class MessageTypesService extends BaseService {
40
40
  * List message types in a project
41
41
  * @param bucketId - The bucket ID
42
42
  * @param options - Optional query parameters
43
- * @returns All MessageType across all pages, with .meta.totalCount
43
+ * @returns Every MessageType across all pages, with .meta.totalCount
44
44
  *
45
45
  * @example
46
46
  * ```ts
@@ -16,7 +16,7 @@ export class MessageTypesService extends BaseService {
16
16
  * List message types in a project
17
17
  * @param bucketId - The bucket ID
18
18
  * @param options - Optional query parameters
19
- * @returns All MessageType across all pages, with .meta.totalCount
19
+ * @returns Every MessageType across all pages, with .meta.totalCount
20
20
  *
21
21
  * @example
22
22
  * ```ts
@@ -57,7 +57,7 @@ export class MessageTypesService extends BaseService {
57
57
  * List message types in a project
58
58
  * @param bucketId - The bucket ID
59
59
  * @param options - Optional query parameters
60
- * @returns All MessageType across all pages, with .meta.totalCount
60
+ * @returns Every MessageType across all pages, with .meta.totalCount
61
61
  *
62
62
  * @example
63
63
  * ```ts
@@ -58,7 +58,7 @@ export declare class MessagesService extends BaseService {
58
58
  * List messages on a message board
59
59
  * @param boardId - The board ID
60
60
  * @param options - Optional query parameters
61
- * @returns All Message across all pages, with .meta.totalCount
61
+ * @returns Every Message across all pages, with .meta.totalCount
62
62
  *
63
63
  * @example
64
64
  * ```ts
@@ -16,7 +16,7 @@ export class MessagesService extends BaseService {
16
16
  * List messages on a message board
17
17
  * @param boardId - The board ID
18
18
  * @param options - Optional query parameters
19
- * @returns All Message across all pages, with .meta.totalCount
19
+ * @returns Every Message across all pages, with .meta.totalCount
20
20
  *
21
21
  * @example
22
22
  * ```ts
@@ -75,7 +75,7 @@ export class MessagesService extends BaseService {
75
75
  * List messages on a message board
76
76
  * @param boardId - The board ID
77
77
  * @param options - Optional query parameters
78
- * @returns All Message across all pages, with .meta.totalCount
78
+ * @returns Every Message across all pages, with .meta.totalCount
79
79
  *
80
80
  * @example
81
81
  * ```ts
@@ -34,7 +34,8 @@ export interface BubbleUpsMyNotificationOptions extends PaginationOptions {
34
34
  * Request parameters for markAsRead.
35
35
  */
36
36
  export interface MarkAsReadMyNotificationRequest {
37
- /** Array of readable_sgid values identifying the items to mark as read */
37
+ /** Array of readable_sgid values identifying the items to mark as read.
38
+ At most 500 per request. */
38
39
  readables: string[];
39
40
  }
40
41
  /**
@@ -55,7 +56,7 @@ export declare class MyNotificationsService extends BaseService {
55
56
  /**
56
57
  * Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
57
58
  * @param options - Optional query parameters
58
- * @returns All Notification across all pages, with .meta.totalCount
59
+ * @returns Every Notification across all pages, with .meta.totalCount
59
60
  *
60
61
  * @example
61
62
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"my-notifications.d.ts","sourceRoot":"","sources":["../../../src/generated/services/my-notifications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;gDAE4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;0BAGsB;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;IACvE,yHAAyH;IACzH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,0EAA0E;IAC1E,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAOD;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IAErD;;;;;;;;;OASG;IACG,eAAe,CAAC,OAAO,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,mCAAmC,CAAC,CAAC;IAkB1I;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAkB5F;;;;;;;;;;OAUG;IACG,UAAU,CAAC,GAAG,EAAE,+BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBtE"}
1
+ {"version":3,"file":"my-notifications.d.ts","sourceRoot":"","sources":["../../../src/generated/services/my-notifications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,iDAAiD;AACjD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;gDAE4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;0BAGsB;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;IACvE,yHAAyH;IACzH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;6BACyB;IACzB,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAOD;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IAErD;;;;;;;;;OASG;IACG,eAAe,CAAC,OAAO,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,mCAAmC,CAAC,CAAC;IAkB1I;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IAkB5F;;;;;;;;;;OAUG;IACG,UAAU,CAAC,GAAG,EAAE,+BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBtE"}
@@ -38,7 +38,7 @@ export class MyNotificationsService extends BaseService {
38
38
  /**
39
39
  * Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
40
40
  * @param options - Optional query parameters
41
- * @returns All Notification across all pages, with .meta.totalCount
41
+ * @returns Every Notification across all pages, with .meta.totalCount
42
42
  *
43
43
  * @example
44
44
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"my-notifications.js","sourceRoot":"","sources":["../../../src/generated/services/my-notifications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAyCzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAErD;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAC,OAA8C;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,cAAc,EAAE;aAC5E;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,OAAwC;QACtD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,WAAW;YACzB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE;YAC9C,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,GAAoC;QACnD,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;SACjB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAClC,IAAI,EAAE;gBACJ,SAAS,EAAE,GAAG,CAAC,SAAS;aACzB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"my-notifications.js","sourceRoot":"","sources":["../../../src/generated/services/my-notifications.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA0CzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAErD;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAC,OAA8C;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,cAAc,EAAE;aAC5E;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,OAAwC;QACtD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,WAAW;YACzB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE;YAC9C,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,GAAoC;QACnD,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;SACjB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAClC,IAAI,EAAE;gBACJ,SAAS,EAAE,GAAG,CAAC,SAAS;aACzB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}
@@ -44,7 +44,8 @@ export interface BubbleUpsMyNotificationOptions extends PaginationOptions {
44
44
  * Request parameters for markAsRead.
45
45
  */
46
46
  export interface MarkAsReadMyNotificationRequest {
47
- /** Array of readable_sgid values identifying the items to mark as read */
47
+ /** Array of readable_sgid values identifying the items to mark as read.
48
+ At most 500 per request. */
48
49
  readables: string[];
49
50
  }
50
51
 
@@ -89,7 +90,7 @@ export class MyNotificationsService extends BaseService {
89
90
  /**
90
91
  * Get the current user's current and scheduled bubble-ups (paginated, 50 per page).
91
92
  * @param options - Optional query parameters
92
- * @returns All Notification across all pages, with .meta.totalCount
93
+ * @returns Every Notification across all pages, with .meta.totalCount
93
94
  *
94
95
  * @example
95
96
  * ```ts
@@ -92,7 +92,7 @@ export declare class PeopleService extends BaseService {
92
92
  /**
93
93
  * List all account users who can be pinged
94
94
  * @param options - Optional query parameters
95
- * @returns All Person across all pages, with .meta.totalCount
95
+ * @returns Every Person across all pages, with .meta.totalCount
96
96
  *
97
97
  * @example
98
98
  * ```ts
@@ -147,7 +147,7 @@ export declare class PeopleService extends BaseService {
147
147
  /**
148
148
  * List all people visible to the current user
149
149
  * @param options - Optional query parameters
150
- * @returns All Person across all pages, with .meta.totalCount
150
+ * @returns Every Person across all pages, with .meta.totalCount
151
151
  *
152
152
  * @example
153
153
  * ```ts
@@ -234,7 +234,7 @@ export declare class PeopleService extends BaseService {
234
234
  * List all active people on a project
235
235
  * @param projectId - The project ID
236
236
  * @param options - Optional query parameters
237
- * @returns All Person across all pages, with .meta.totalCount
237
+ * @returns Every Person across all pages, with .meta.totalCount
238
238
  *
239
239
  * @example
240
240
  * ```ts
@@ -15,7 +15,7 @@ export class PeopleService extends BaseService {
15
15
  /**
16
16
  * List all account users who can be pinged
17
17
  * @param options - Optional query parameters
18
- * @returns All Person across all pages, with .meta.totalCount
18
+ * @returns Every Person across all pages, with .meta.totalCount
19
19
  *
20
20
  * @example
21
21
  * ```ts
@@ -126,7 +126,7 @@ export class PeopleService extends BaseService {
126
126
  /**
127
127
  * List all people visible to the current user
128
128
  * @param options - Optional query parameters
129
- * @returns All Person across all pages, with .meta.totalCount
129
+ * @returns Every Person across all pages, with .meta.totalCount
130
130
  *
131
131
  * @example
132
132
  * ```ts
@@ -307,7 +307,7 @@ export class PeopleService extends BaseService {
307
307
  * List all active people on a project
308
308
  * @param projectId - The project ID
309
309
  * @param options - Optional query parameters
310
- * @returns All Person across all pages, with .meta.totalCount
310
+ * @returns Every Person across all pages, with .meta.totalCount
311
311
  *
312
312
  * @example
313
313
  * ```ts
@@ -114,7 +114,7 @@ export class PeopleService extends BaseService {
114
114
  /**
115
115
  * List all account users who can be pinged
116
116
  * @param options - Optional query parameters
117
- * @returns All Person across all pages, with .meta.totalCount
117
+ * @returns Every Person across all pages, with .meta.totalCount
118
118
  *
119
119
  * @example
120
120
  * ```ts
@@ -254,7 +254,7 @@ export class PeopleService extends BaseService {
254
254
  /**
255
255
  * List all people visible to the current user
256
256
  * @param options - Optional query parameters
257
- * @returns All Person across all pages, with .meta.totalCount
257
+ * @returns Every Person across all pages, with .meta.totalCount
258
258
  *
259
259
  * @example
260
260
  * ```ts
@@ -471,7 +471,7 @@ export class PeopleService extends BaseService {
471
471
  * List all active people on a project
472
472
  * @param projectId - The project ID
473
473
  * @param options - Optional query parameters
474
- * @returns All Person across all pages, with .meta.totalCount
474
+ * @returns Every Person across all pages, with .meta.totalCount
475
475
  *
476
476
  * @example
477
477
  * ```ts
@@ -57,7 +57,7 @@ export declare class ProjectsService extends BaseService {
57
57
  /**
58
58
  * List projects (active by default; optionally archived/trashed)
59
59
  * @param options - Optional query parameters
60
- * @returns All Project across all pages, with .meta.totalCount
60
+ * @returns Every Project across all pages, with .meta.totalCount
61
61
  *
62
62
  * @example
63
63
  * ```ts
@@ -33,7 +33,7 @@ export class ProjectsService extends BaseService {
33
33
  /**
34
34
  * List projects (active by default; optionally archived/trashed)
35
35
  * @param options - Optional query parameters
36
- * @returns All Project across all pages, with .meta.totalCount
36
+ * @returns Every Project across all pages, with .meta.totalCount
37
37
  *
38
38
  * @example
39
39
  * ```ts
@@ -88,7 +88,7 @@ export class ProjectsService extends BaseService {
88
88
  /**
89
89
  * List projects (active by default; optionally archived/trashed)
90
90
  * @param options - Optional query parameters
91
- * @returns All Project across all pages, with .meta.totalCount
91
+ * @returns Every Project across all pages, with .meta.totalCount
92
92
  *
93
93
  * @example
94
94
  * ```ts
@@ -32,7 +32,7 @@ export declare class RecordingsService extends BaseService {
32
32
  * List recordings of a given type across projects
33
33
  * @param type - Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
34
34
  * @param options - Optional query parameters
35
- * @returns All Recording across all pages, with .meta.totalCount
35
+ * @returns Every Recording across all pages, with .meta.totalCount
36
36
  *
37
37
  * @example
38
38
  * ```ts
@@ -80,7 +80,7 @@ export declare class RecordingsService extends BaseService {
80
80
  */
81
81
  unarchive(recordingId: number): Promise<void>;
82
82
  /**
83
- * Archive a recording
83
+ * Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them
84
84
  * @param recordingId - The recording ID
85
85
  * @returns void
86
86
  * @throws {BasecampError} If the request fails
@@ -92,7 +92,7 @@ export declare class RecordingsService extends BaseService {
92
92
  */
93
93
  archive(recordingId: number): Promise<void>;
94
94
  /**
95
- * Trash a recording. Trashed items can be recovered.
95
+ * Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently). Trashed items can be recovered.
96
96
  * @param recordingId - The recording ID
97
97
  * @returns void
98
98
  * @throws {BasecampError} If the request fails
@@ -15,7 +15,7 @@ export class RecordingsService extends BaseService {
15
15
  * List recordings of a given type across projects
16
16
  * @param type - Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
17
17
  * @param options - Optional query parameters
18
- * @returns All Recording across all pages, with .meta.totalCount
18
+ * @returns Every Recording across all pages, with .meta.totalCount
19
19
  *
20
20
  * @example
21
21
  * ```ts
@@ -111,7 +111,7 @@ export class RecordingsService extends BaseService {
111
111
  }));
112
112
  }
113
113
  /**
114
- * Archive a recording
114
+ * Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them
115
115
  * @param recordingId - The recording ID
116
116
  * @returns void
117
117
  * @throws {BasecampError} If the request fails
@@ -135,7 +135,7 @@ export class RecordingsService extends BaseService {
135
135
  }));
136
136
  }
137
137
  /**
138
- * Trash a recording. Trashed items can be recovered.
138
+ * Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently). Trashed items can be recovered.
139
139
  * @param recordingId - The recording ID
140
140
  * @returns void
141
141
  * @throws {BasecampError} If the request fails
@@ -46,7 +46,7 @@ export class RecordingsService extends BaseService {
46
46
  * List recordings of a given type across projects
47
47
  * @param type - Comment|Document|Door|Kanban::Card|Kanban::Step|Message|Question::Answer|Schedule::Entry|Todo|Todolist|Upload|Vault
48
48
  * @param options - Optional query parameters
49
- * @returns All Recording across all pages, with .meta.totalCount
49
+ * @returns Every Recording across all pages, with .meta.totalCount
50
50
  *
51
51
  * @example
52
52
  * ```ts
@@ -163,7 +163,7 @@ export class RecordingsService extends BaseService {
163
163
  }
164
164
 
165
165
  /**
166
- * Archive a recording
166
+ * Archive a recording; bc3 answers 403 for types it never lets be archived, timesheet entries among them
167
167
  * @param recordingId - The recording ID
168
168
  * @returns void
169
169
  * @throws {BasecampError} If the request fails
@@ -192,7 +192,7 @@ export class RecordingsService extends BaseService {
192
192
  }
193
193
 
194
194
  /**
195
- * Trash a recording. Trashed items can be recovered.
195
+ * Trash a recording; bc3 answers 403 for types it never lets be trashed, timesheet entries among them (DestroyTimesheetEntry removes those, permanently). Trashed items can be recovered.
196
196
  * @param recordingId - The recording ID
197
197
  * @returns void
198
198
  * @throws {BasecampError} If the request fails
@@ -39,7 +39,7 @@ export declare class ReportsService extends BaseService {
39
39
  /**
40
40
  * Get account-wide activity feed (progress report)
41
41
  * @param options - Optional query parameters
42
- * @returns All TimelineEvent across all pages, with .meta.totalCount
42
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
43
43
  *
44
44
  * @example
45
45
  * ```ts
@@ -14,7 +14,7 @@ export class ReportsService extends BaseService {
14
14
  /**
15
15
  * Get account-wide activity feed (progress report)
16
16
  * @param options - Optional query parameters
17
- * @returns All TimelineEvent across all pages, with .meta.totalCount
17
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
18
18
  *
19
19
  * @example
20
20
  * ```ts
@@ -55,7 +55,7 @@ export class ReportsService extends BaseService {
55
55
  /**
56
56
  * Get account-wide activity feed (progress report)
57
57
  * @param options - Optional query parameters
58
- * @returns All TimelineEvent across all pages, with .meta.totalCount
58
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
59
59
  *
60
60
  * @example
61
61
  * ```ts
@@ -225,7 +225,7 @@ export declare class SchedulesService extends BaseService {
225
225
  * List entries on a schedule
226
226
  * @param scheduleId - The schedule ID
227
227
  * @param options - Optional query parameters
228
- * @returns All ScheduleEntry across all pages, with .meta.totalCount
228
+ * @returns Every ScheduleEntry across all pages, with .meta.totalCount
229
229
  *
230
230
  * @example
231
231
  * ```ts
@@ -164,7 +164,7 @@ export class SchedulesService extends BaseService {
164
164
  * List entries on a schedule
165
165
  * @param scheduleId - The schedule ID
166
166
  * @param options - Optional query parameters
167
- * @returns All ScheduleEntry across all pages, with .meta.totalCount
167
+ * @returns Every ScheduleEntry across all pages, with .meta.totalCount
168
168
  *
169
169
  * @example
170
170
  * ```ts
@@ -353,7 +353,7 @@ export class SchedulesService extends BaseService {
353
353
  * List entries on a schedule
354
354
  * @param scheduleId - The schedule ID
355
355
  * @param options - Optional query parameters
356
- * @returns All ScheduleEntry across all pages, with .meta.totalCount
356
+ * @returns Every ScheduleEntry across all pages, with .meta.totalCount
357
357
  *
358
358
  * @example
359
359
  * ```ts
@@ -0,0 +1,157 @@
1
+ /**
2
+ * Subtasks service for the Basecamp API.
3
+ *
4
+ * @generated from OpenAPI spec - do not edit directly
5
+ */
6
+ import { BaseService } from "../../services/base.js";
7
+ import type { components } from "../schema.js";
8
+ import { ListResult } from "../../pagination.js";
9
+ import type { PaginationOptions } from "../../pagination.js";
10
+ /** Subtask entity from the Basecamp API. */
11
+ export type Subtask = components["schemas"]["Subtask"];
12
+ /** @deprecated renamed to Subtask, the same Kanban::Step record. */
13
+ export type CardStep = Subtask;
14
+ /**
15
+ * Options for list.
16
+ */
17
+ export interface ListSubtaskOptions extends PaginationOptions {
18
+ /** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
19
+ page?: number;
20
+ }
21
+ /**
22
+ * Request parameters for create.
23
+ */
24
+ export interface CreateSubtaskRequest {
25
+ /** Title */
26
+ title: string;
27
+ /** Due date (YYYY-MM-DD) */
28
+ dueOn?: string;
29
+ /** Person IDs to assign to */
30
+ assigneeIds?: number[];
31
+ }
32
+ /**
33
+ * Request parameters for update.
34
+ */
35
+ export interface UpdateSubtaskRequest {
36
+ /** Title */
37
+ title?: string;
38
+ /** Due date (YYYY-MM-DD) */
39
+ dueOn?: string;
40
+ /** Person IDs to assign to */
41
+ assigneeIds?: number[];
42
+ }
43
+ /**
44
+ * Request parameters for reposition.
45
+ */
46
+ export interface RepositionSubtaskRequest {
47
+ /** The 1-based position to move it to */
48
+ position: number;
49
+ }
50
+ /**
51
+ * Service for Subtasks operations.
52
+ */
53
+ export declare class SubtasksService extends BaseService {
54
+ /**
55
+ * List a recording's subtasks, in position order
56
+ * @param recordingId - The recording ID
57
+ * @param options - Optional query parameters
58
+ * @returns Every Subtask across all pages, with .meta.totalCount
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const result = await client.subtasks.list(123);
63
+ *
64
+ * // With options
65
+ * const filtered = await client.subtasks.list(123, { page: 1 });
66
+ * ```
67
+ */
68
+ list(recordingId: number, options?: ListSubtaskOptions): Promise<ListResult<Subtask>>;
69
+ /**
70
+ * Create a subtask under a to-do or a card
71
+ * @param recordingId - The recording ID
72
+ * @param req - Subtask creation parameters
73
+ * @returns The Subtask
74
+ * @throws {BasecampError} If required fields are missing or invalid
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const result = await client.subtasks.create(123, { title: "example" });
79
+ * ```
80
+ */
81
+ create(recordingId: number, req: CreateSubtaskRequest): Promise<Subtask>;
82
+ /**
83
+ * Get a subtask by ID
84
+ * @param subtaskId - The subtask ID
85
+ * @returns The Subtask
86
+ * @throws {BasecampError} If the resource is not found
87
+ *
88
+ * @example
89
+ * ```ts
90
+ * const result = await client.subtasks.get(123);
91
+ * ```
92
+ */
93
+ get(subtaskId: number): Promise<Subtask>;
94
+ /**
95
+ * Update a subtask
96
+ * @param subtaskId - The subtask ID
97
+ * @param req - Subtask update parameters
98
+ * @returns The Subtask
99
+ * @throws {BasecampError} If the resource is not found or fields are invalid
100
+ *
101
+ * @example
102
+ * ```ts
103
+ * const result = await client.subtasks.update(123, { });
104
+ * ```
105
+ */
106
+ update(subtaskId: number, req: UpdateSubtaskRequest): Promise<Subtask>;
107
+ /**
108
+ * Delete a subtask
109
+ * @param subtaskId - The subtask ID
110
+ * @returns void
111
+ * @throws {BasecampError} If the request fails
112
+ *
113
+ * @example
114
+ * ```ts
115
+ * await client.subtasks.delete(123);
116
+ * ```
117
+ */
118
+ delete(subtaskId: number): Promise<void>;
119
+ /**
120
+ * Mark a subtask as completed
121
+ * @param subtaskId - The subtask ID
122
+ * @returns void
123
+ * @throws {BasecampError} If the request fails
124
+ *
125
+ * @example
126
+ * ```ts
127
+ * await client.subtasks.complete(123);
128
+ * ```
129
+ */
130
+ complete(subtaskId: number): Promise<void>;
131
+ /**
132
+ * Mark a subtask as not completed
133
+ * @param subtaskId - The subtask ID
134
+ * @returns void
135
+ * @throws {BasecampError} If the request fails
136
+ *
137
+ * @example
138
+ * ```ts
139
+ * await client.subtasks.uncomplete(123);
140
+ * ```
141
+ */
142
+ uncomplete(subtaskId: number): Promise<void>;
143
+ /**
144
+ * Move a subtask to a new position among its siblings
145
+ * @param subtaskId - The subtask ID
146
+ * @param req - Subtask request parameters
147
+ * @returns void
148
+ * @throws {BasecampError} If the request fails
149
+ *
150
+ * @example
151
+ * ```ts
152
+ * await client.subtasks.reposition(123, { position: 1 });
153
+ * ```
154
+ */
155
+ reposition(subtaskId: number, req: RepositionSubtaskRequest): Promise<void>;
156
+ }
157
+ //# sourceMappingURL=subtasks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subtasks.d.ts","sourceRoot":"","sources":["../../../src/generated/services/subtasks.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,oEAAoE;AACpE,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAoB3F;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B9E;;;;;;;;;;OAUG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB9C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IA2B5E;;;;;;;;;;OAUG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9C;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBhD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBlD;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBlF"}