@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
@@ -14,21 +14,65 @@ import { Errors } from "../../errors.js";
14
14
  // Types
15
15
  // =============================================================================
16
16
 
17
+ /** CardTable entity from the Basecamp API. */
18
+ export type CardTable = components["schemas"]["CardTable"];
19
+ /** Todolist entity from the Basecamp API. */
20
+ export type Todolist = components["schemas"]["Todolist"];
17
21
  /** Template entity from the Basecamp API. */
18
22
  export type Template = components["schemas"]["Template"];
19
23
 
24
+ /**
25
+ * Request parameters for createTemplatification.
26
+ */
27
+ export interface CreateTemplatificationTemplateRequest {
28
+ /** What to call the template. Defaults to the source recording's own title. */
29
+ templateName?: string;
30
+ /** Carry the comments across. */
31
+ copyComments?: boolean;
32
+ /** Carry assignees and the people involved across, adding them to the library
33
+ if they are not already there. */
34
+ copyAssignments?: boolean;
35
+ /** Gather the cards into Triage. Card tables only, and ignored otherwise. */
36
+ moveCardsToTriage?: boolean;
37
+ }
38
+
39
+ /**
40
+ * Request parameters for createLibraryCardTable.
41
+ */
42
+ export interface CreateLibraryCardTableTemplateRequest {
43
+ /** The template's name. Write-only: the response carries it as `title`. */
44
+ name: string;
45
+ }
46
+
20
47
  /**
21
48
  * Request parameters for createLibraryCopy.
22
49
  */
23
50
  export interface CreateLibraryCopyTemplateRequest {
24
- /** Template recording id */
51
+ /** The to-do list or card table in the library to copy. */
25
52
  templateRecordingId: number;
26
- /** Destination parent id */
27
- destinationParentId: number;
53
+ /** The destination project. Basecamp resolves the container from the
54
+ template's kind, so a caller naming a project needs to know nothing about
55
+ docks or to-do sets. Supply this or destination_parent_id; if both are
56
+ sent, destination_parent_id wins. */
57
+ destinationProjectId?: number;
58
+ /** The container to copy into, for a caller that already holds one: the
59
+ project's to-do set for a to-do list template, or its dock for a card
60
+ table. A caller who may not edit it gets 404, not 403. */
61
+ destinationParentId?: number;
28
62
  /** Confirm granting destination-project access to people referenced by the template. */
29
63
  addingPeopleConfirmed?: boolean;
30
64
  }
31
65
 
66
+ /**
67
+ * Request parameters for createLibraryTodolist.
68
+ */
69
+ export interface CreateLibraryTodolistTemplateRequest {
70
+ /** What to call the template. */
71
+ name: string;
72
+ /** Rich text describing the template. */
73
+ description?: string;
74
+ }
75
+
32
76
  /**
33
77
  * Options for list.
34
78
  */
@@ -78,39 +122,143 @@ export interface CreateProjectTemplateRequest {
78
122
  export class TemplatesService extends BaseService {
79
123
 
80
124
  /**
81
- * Get the account's to-do list template library
82
- * @returns The template_library
125
+ * Templatify a to-do list or card table
126
+ * @param bucketId - The bucket ID
127
+ * @param recordingId - The to-do list or card table to templatify. Anything else is a 403.
128
+ * @param req - Templatification creation parameters
129
+ * @returns The templatification
130
+ * @throws {BasecampError} If required fields are missing or invalid
131
+ *
132
+ * @example
133
+ * ```ts
134
+ * const result = await client.templates.createTemplatification(123, 123, { });
135
+ * ```
136
+ */
137
+ async createTemplatification(bucketId: number, recordingId: number, req: CreateTemplatificationTemplateRequest): Promise<components["schemas"]["CreateTemplatificationResponseContent"]> {
138
+ const response = await this.request(
139
+ {
140
+ service: "Templates",
141
+ operation: "CreateTemplatification",
142
+ resourceType: "templatification",
143
+ isMutation: true,
144
+ projectId: bucketId,
145
+ resourceId: recordingId,
146
+ },
147
+ () =>
148
+ this.client.POST("/buckets/{bucketId}/recordings/{recordingId}/templatifications.json", {
149
+ params: {
150
+ path: { bucketId, recordingId },
151
+ },
152
+ body: {
153
+ template_name: req.templateName,
154
+ copy_comments: req.copyComments,
155
+ copy_assignments: req.copyAssignments,
156
+ move_cards_to_triage: req.moveCardsToTriage,
157
+ },
158
+ })
159
+ );
160
+ return response;
161
+ }
162
+
163
+ /**
164
+ * Get a templatification
165
+ * @param bucketId - The bucket ID
166
+ * @param recordingId - The recording ID
167
+ * @param templatificationId - The templatification ID
168
+ * @returns The templatification
83
169
  * @throws {BasecampError} If the resource is not found
84
170
  *
85
171
  * @example
86
172
  * ```ts
87
- * const result = await client.templates.getLibrary();
173
+ * const result = await client.templates.getTemplatification(123, 123, 123);
88
174
  * ```
89
175
  */
90
- async getLibrary(): Promise<components["schemas"]["GetTemplateLibraryResponseContent"]> {
176
+ async getTemplatification(bucketId: number, recordingId: number, templatificationId: number): Promise<components["schemas"]["GetTemplatificationResponseContent"]> {
91
177
  const response = await this.request(
92
178
  {
93
179
  service: "Templates",
94
- operation: "GetTemplateLibrary",
95
- resourceType: "template_library",
180
+ operation: "GetTemplatification",
181
+ resourceType: "templatification",
96
182
  isMutation: false,
183
+ projectId: bucketId,
184
+ resourceId: templatificationId,
185
+ },
186
+ () =>
187
+ this.client.GET("/buckets/{bucketId}/recordings/{recordingId}/templatifications/{templatificationId}", {
188
+ params: {
189
+ path: { bucketId, recordingId, templatificationId },
190
+ },
191
+ })
192
+ );
193
+ return response;
194
+ }
195
+
196
+ /**
197
+ * Get the account's card table templates
198
+ * @returns The template_library_card_table
199
+ * @throws {BasecampError} If the resource is not found
200
+ *
201
+ * @example
202
+ * ```ts
203
+ * const result = await client.templates.getLibraryCardTables();
204
+ * ```
205
+ */
206
+ async getLibraryCardTables(): Promise<components["schemas"]["GetTemplateLibraryCardTablesResponseContent"]> {
207
+ const response = await this.request(
208
+ {
209
+ service: "Templates",
210
+ operation: "GetTemplateLibraryCardTables",
211
+ resourceType: "template_library_card_table",
212
+ isMutation: false,
213
+ },
214
+ () =>
215
+ this.client.GET("/template_library/card_tables.json", {
216
+ })
217
+ );
218
+ return response;
219
+ }
220
+
221
+ /**
222
+ * Create a card table template with the default columns
223
+ * @param req - Template_library_card_table creation parameters
224
+ * @returns The CardTable
225
+ * @throws {BasecampError} If required fields are missing or invalid
226
+ *
227
+ * @example
228
+ * ```ts
229
+ * const result = await client.templates.createLibraryCardTable({ name: "My example" });
230
+ * ```
231
+ */
232
+ async createLibraryCardTable(req: CreateLibraryCardTableTemplateRequest): Promise<CardTable> {
233
+ if (!req.name) {
234
+ throw Errors.validation("Name is required");
235
+ }
236
+ const response = await this.request(
237
+ {
238
+ service: "Templates",
239
+ operation: "CreateTemplateLibraryCardTable",
240
+ resourceType: "template_library_card_table",
241
+ isMutation: true,
97
242
  },
98
243
  () =>
99
- this.client.GET("/template_library.json", {
244
+ this.client.POST("/template_library/card_tables.json", {
245
+ body: {
246
+ name: req.name,
247
+ },
100
248
  })
101
249
  );
102
250
  return response;
103
251
  }
104
252
 
105
253
  /**
106
- * Start copying a to-do list template into a project
254
+ * Start copying a to-do list or card table template into a project
107
255
  * @param req - Template_library_copy creation parameters
108
256
  * @returns The template_library_copy
109
257
  * @throws {BasecampError} If required fields are missing or invalid
110
258
  *
111
259
  * @example
112
260
  * ```ts
113
- * const result = await client.templates.createLibraryCopy({ templateRecordingId: 1, destinationParentId: 1 });
261
+ * const result = await client.templates.createLibraryCopy({ templateRecordingId: 1 });
114
262
  * ```
115
263
  */
116
264
  async createLibraryCopy(req: CreateLibraryCopyTemplateRequest): Promise<components["schemas"]["CreateTemplateLibraryCopyResponseContent"]> {
@@ -125,6 +273,7 @@ export class TemplatesService extends BaseService {
125
273
  this.client.POST("/template_library/copies.json", {
126
274
  body: {
127
275
  template_recording_id: req.templateRecordingId,
276
+ destination_project_id: req.destinationProjectId,
128
277
  destination_parent_id: req.destinationParentId,
129
278
  adding_people_confirmed: req.addingPeopleConfirmed,
130
279
  },
@@ -163,10 +312,68 @@ export class TemplatesService extends BaseService {
163
312
  return response;
164
313
  }
165
314
 
315
+ /**
316
+ * Get the account's to-do list templates
317
+ * @returns The template_library_todolist
318
+ * @throws {BasecampError} If the resource is not found
319
+ *
320
+ * @example
321
+ * ```ts
322
+ * const result = await client.templates.getLibraryTodolists();
323
+ * ```
324
+ */
325
+ async getLibraryTodolists(): Promise<components["schemas"]["GetTemplateLibraryTodolistsResponseContent"]> {
326
+ const response = await this.request(
327
+ {
328
+ service: "Templates",
329
+ operation: "GetTemplateLibraryTodolists",
330
+ resourceType: "template_library_todolist",
331
+ isMutation: false,
332
+ },
333
+ () =>
334
+ this.client.GET("/template_library/todolists.json", {
335
+ })
336
+ );
337
+ return response;
338
+ }
339
+
340
+ /**
341
+ * Create an empty to-do list template
342
+ * @param req - Template_library_todolist creation parameters
343
+ * @returns The Todolist
344
+ * @throws {BasecampError} If required fields are missing or invalid
345
+ *
346
+ * @example
347
+ * ```ts
348
+ * const result = await client.templates.createLibraryTodolist({ name: "My example" });
349
+ * ```
350
+ */
351
+ async createLibraryTodolist(req: CreateLibraryTodolistTemplateRequest): Promise<Todolist> {
352
+ if (!req.name) {
353
+ throw Errors.validation("Name is required");
354
+ }
355
+ const response = await this.request(
356
+ {
357
+ service: "Templates",
358
+ operation: "CreateTemplateLibraryTodolist",
359
+ resourceType: "template_library_todolist",
360
+ isMutation: true,
361
+ },
362
+ () =>
363
+ this.client.POST("/template_library/todolists.json", {
364
+ body: {
365
+ name: req.name,
366
+ description: req.description,
367
+ },
368
+ })
369
+ );
370
+ return response;
371
+ }
372
+
166
373
  /**
167
374
  * List all templates visible to the current user
168
375
  * @param options - Optional query parameters
169
- * @returns All Template across all pages, with .meta.totalCount
376
+ * @returns Every Template across all pages, with .meta.totalCount
170
377
  *
171
378
  * @example
172
379
  * ```ts
@@ -24,7 +24,7 @@ export declare class TimelineService extends BaseService {
24
24
  * Get project timeline
25
25
  * @param projectId - The project ID
26
26
  * @param options - Optional query parameters
27
- * @returns All TimelineEvent across all pages, with .meta.totalCount
27
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
28
28
  *
29
29
  * @example
30
30
  * ```ts
@@ -15,7 +15,7 @@ export class TimelineService extends BaseService {
15
15
  * Get project timeline
16
16
  * @param projectId - The project ID
17
17
  * @param options - Optional query parameters
18
- * @returns All TimelineEvent across all pages, with .meta.totalCount
18
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
19
19
  *
20
20
  * @example
21
21
  * ```ts
@@ -38,7 +38,7 @@ export class TimelineService extends BaseService {
38
38
  * Get project timeline
39
39
  * @param projectId - The project ID
40
40
  * @param options - Optional query parameters
41
- * @returns All TimelineEvent across all pages, with .meta.totalCount
41
+ * @returns Every TimelineEvent across all pages, with .meta.totalCount
42
42
  *
43
43
  * @example
44
44
  * ```ts
@@ -80,7 +80,7 @@ export declare class TimesheetsService extends BaseService {
80
80
  * Get timesheet for a specific project
81
81
  * @param projectId - The project ID
82
82
  * @param options - Optional query parameters
83
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
83
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
84
84
  *
85
85
  * @example
86
86
  * ```ts
@@ -92,7 +92,7 @@ export declare class TimesheetsService extends BaseService {
92
92
  * Get timesheet for a specific recording
93
93
  * @param recordingId - The recording ID
94
94
  * @param options - Optional query parameters
95
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
95
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
96
96
  *
97
97
  * @example
98
98
  * ```ts
@@ -150,7 +150,7 @@ export declare class TimesheetsService extends BaseService {
150
150
  */
151
151
  update(entryId: number, req: UpdateTimesheetRequest): Promise<TimesheetEntry>;
152
152
  /**
153
- * Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
153
+ * Permanently delete a timesheet entry, which never appears in the trash and cannot be restored; this is the only way to remove one, since bc3 answers 403 to TrashRecording and ArchiveRecording for every timesheet entry, and it answers 403 when the caller may not remove the entry.
154
154
  * @param entryId - The entry ID
155
155
  * @returns void
156
156
  * @throws {BasecampError} If the request fails
@@ -16,7 +16,7 @@ export class TimesheetsService extends BaseService {
16
16
  * Get timesheet for a specific project
17
17
  * @param projectId - The project ID
18
18
  * @param options - Optional query parameters
19
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
19
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
20
20
  *
21
21
  * @example
22
22
  * ```ts
@@ -41,7 +41,7 @@ export class TimesheetsService extends BaseService {
41
41
  * Get timesheet for a specific recording
42
42
  * @param recordingId - The recording ID
43
43
  * @param options - Optional query parameters
44
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
44
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
45
45
  *
46
46
  * @example
47
47
  * ```ts
@@ -181,7 +181,7 @@ export class TimesheetsService extends BaseService {
181
181
  return response;
182
182
  }
183
183
  /**
184
- * Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
184
+ * Permanently delete a timesheet entry, which never appears in the trash and cannot be restored; this is the only way to remove one, since bc3 answers 403 to TrashRecording and ArchiveRecording for every timesheet entry, and it answers 403 when the caller may not remove the entry.
185
185
  * @param entryId - The entry ID
186
186
  * @returns void
187
187
  * @throws {BasecampError} If the request fails
@@ -99,7 +99,7 @@ export class TimesheetsService extends BaseService {
99
99
  * Get timesheet for a specific project
100
100
  * @param projectId - The project ID
101
101
  * @param options - Optional query parameters
102
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
102
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
103
103
  *
104
104
  * @example
105
105
  * ```ts
@@ -130,7 +130,7 @@ export class TimesheetsService extends BaseService {
130
130
  * Get timesheet for a specific recording
131
131
  * @param recordingId - The recording ID
132
132
  * @param options - Optional query parameters
133
- * @returns All TimesheetEntry across all pages, with .meta.totalCount
133
+ * @returns Every TimesheetEntry across all pages, with .meta.totalCount
134
134
  *
135
135
  * @example
136
136
  * ```ts
@@ -296,7 +296,7 @@ export class TimesheetsService extends BaseService {
296
296
  }
297
297
 
298
298
  /**
299
- * Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
299
+ * Permanently delete a timesheet entry, which never appears in the trash and cannot be restored; this is the only way to remove one, since bc3 answers 403 to TrashRecording and ArchiveRecording for every timesheet entry, and it answers 403 when the caller may not remove the entry.
300
300
  * @param entryId - The entry ID
301
301
  * @returns void
302
302
  * @throws {BasecampError} If the request fails
@@ -51,7 +51,7 @@ export declare class TodolistGroupsService extends BaseService {
51
51
  * List groups in a todolist
52
52
  * @param todolistId - The todolist ID
53
53
  * @param options - Optional query parameters
54
- * @returns All Todolist across all pages, with .meta.totalCount
54
+ * @returns Every Todolist across all pages, with .meta.totalCount
55
55
  *
56
56
  * @example
57
57
  * ```ts
@@ -44,7 +44,7 @@ export class TodolistGroupsService extends BaseService {
44
44
  * List groups in a todolist
45
45
  * @param todolistId - The todolist ID
46
46
  * @param options - Optional query parameters
47
- * @returns All Todolist across all pages, with .meta.totalCount
47
+ * @returns Every Todolist across all pages, with .meta.totalCount
48
48
  *
49
49
  * @example
50
50
  * ```ts
@@ -88,7 +88,7 @@ export class TodolistGroupsService extends BaseService {
88
88
  * List groups in a todolist
89
89
  * @param todolistId - The todolist ID
90
90
  * @param options - Optional query parameters
91
- * @returns All Todolist across all pages, with .meta.totalCount
91
+ * @returns Every Todolist across all pages, with .meta.totalCount
92
92
  *
93
93
  * @example
94
94
  * ```ts
@@ -91,7 +91,7 @@ export declare class TodolistsService extends BaseService {
91
91
  * List todolists in a todoset
92
92
  * @param todosetId - The todoset ID
93
93
  * @param options - Optional query parameters
94
- * @returns All Todolist across all pages, with .meta.totalCount
94
+ * @returns Every Todolist across all pages, with .meta.totalCount
95
95
  *
96
96
  * @example
97
97
  * ```ts
@@ -102,7 +102,7 @@ export class TodolistsService extends BaseService {
102
102
  * List todolists in a todoset
103
103
  * @param todosetId - The todoset ID
104
104
  * @param options - Optional query parameters
105
- * @returns All Todolist across all pages, with .meta.totalCount
105
+ * @returns Every Todolist across all pages, with .meta.totalCount
106
106
  *
107
107
  * @example
108
108
  * ```ts
@@ -172,7 +172,7 @@ export class TodolistsService extends BaseService {
172
172
  * List todolists in a todoset
173
173
  * @param todosetId - The todoset ID
174
174
  * @param options - Optional query parameters
175
- * @returns All Todolist across all pages, with .meta.totalCount
175
+ * @returns Every Todolist across all pages, with .meta.totalCount
176
176
  *
177
177
  * @example
178
178
  * ```ts
@@ -108,7 +108,7 @@ export declare class TodosService extends BaseService {
108
108
  * List todos in a todolist
109
109
  * @param todolistId - The todolist ID
110
110
  * @param options - Optional query parameters
111
- * @returns All Todo across all pages, with .meta.totalCount
111
+ * @returns Every Todo across all pages, with .meta.totalCount
112
112
  *
113
113
  * @example
114
114
  * ```ts
@@ -62,7 +62,7 @@ export class TodosService extends BaseService {
62
62
  * List todos in a todolist
63
63
  * @param todolistId - The todolist ID
64
64
  * @param options - Optional query parameters
65
- * @returns All Todo across all pages, with .meta.totalCount
65
+ * @returns Every Todo across all pages, with .meta.totalCount
66
66
  *
67
67
  * @example
68
68
  * ```ts
@@ -164,7 +164,7 @@ export class TodosService extends BaseService {
164
164
  * List todos in a todolist
165
165
  * @param todolistId - The todolist ID
166
166
  * @param options - Optional query parameters
167
- * @returns All Todo across all pages, with .meta.totalCount
167
+ * @returns Every Todo across all pages, with .meta.totalCount
168
168
  *
169
169
  * @example
170
170
  * ```ts
@@ -99,7 +99,7 @@ export declare class UploadsService extends BaseService {
99
99
  * List versions of an upload
100
100
  * @param uploadId - The upload ID
101
101
  * @param options - Optional query parameters
102
- * @returns All UploadVersion across all pages, with .meta.totalCount
102
+ * @returns Every UploadVersion across all pages, with .meta.totalCount
103
103
  *
104
104
  * @example
105
105
  * ```ts
@@ -124,7 +124,7 @@ export declare class UploadsService extends BaseService {
124
124
  * List uploads in a vault
125
125
  * @param vaultId - The vault ID
126
126
  * @param options - Optional query parameters
127
- * @returns All Upload across all pages, with .meta.totalCount
127
+ * @returns Every Upload across all pages, with .meta.totalCount
128
128
  *
129
129
  * @example
130
130
  * ```ts
@@ -71,7 +71,7 @@ export class UploadsService extends BaseService {
71
71
  * List versions of an upload
72
72
  * @param uploadId - The upload ID
73
73
  * @param options - Optional query parameters
74
- * @returns All UploadVersion across all pages, with .meta.totalCount
74
+ * @returns Every UploadVersion across all pages, with .meta.totalCount
75
75
  *
76
76
  * @example
77
77
  * ```ts
@@ -131,7 +131,7 @@ export class UploadsService extends BaseService {
131
131
  * List uploads in a vault
132
132
  * @param vaultId - The vault ID
133
133
  * @param options - Optional query parameters
134
- * @returns All Upload across all pages, with .meta.totalCount
134
+ * @returns Every Upload across all pages, with .meta.totalCount
135
135
  *
136
136
  * @example
137
137
  * ```ts
@@ -158,7 +158,7 @@ export class UploadsService extends BaseService {
158
158
  * List versions of an upload
159
159
  * @param uploadId - The upload ID
160
160
  * @param options - Optional query parameters
161
- * @returns All UploadVersion across all pages, with .meta.totalCount
161
+ * @returns Every UploadVersion across all pages, with .meta.totalCount
162
162
  *
163
163
  * @example
164
164
  * ```ts
@@ -229,7 +229,7 @@ export class UploadsService extends BaseService {
229
229
  * List uploads in a vault
230
230
  * @param vaultId - The vault ID
231
231
  * @param options - Optional query parameters
232
- * @returns All Upload across all pages, with .meta.totalCount
232
+ * @returns Every Upload across all pages, with .meta.totalCount
233
233
  *
234
234
  * @example
235
235
  * ```ts
@@ -63,7 +63,7 @@ export declare class VaultsService extends BaseService {
63
63
  * List vaults (subfolders) in a vault
64
64
  * @param vaultId - The vault ID
65
65
  * @param options - Optional query parameters
66
- * @returns All Vault across all pages, with .meta.totalCount
66
+ * @returns Every Vault across all pages, with .meta.totalCount
67
67
  *
68
68
  * @example
69
69
  * ```ts
@@ -70,7 +70,7 @@ export class VaultsService extends BaseService {
70
70
  * List vaults (subfolders) in a vault
71
71
  * @param vaultId - The vault ID
72
72
  * @param options - Optional query parameters
73
- * @returns All Vault across all pages, with .meta.totalCount
73
+ * @returns Every Vault across all pages, with .meta.totalCount
74
74
  *
75
75
  * @example
76
76
  * ```ts
@@ -119,7 +119,7 @@ export class VaultsService extends BaseService {
119
119
  * List vaults (subfolders) in a vault
120
120
  * @param vaultId - The vault ID
121
121
  * @param options - Optional query parameters
122
- * @returns All Vault across all pages, with .meta.totalCount
122
+ * @returns Every Vault across all pages, with .meta.totalCount
123
123
  *
124
124
  * @example
125
125
  * ```ts
@@ -44,7 +44,7 @@ export declare class WebhooksService extends BaseService {
44
44
  * List all webhooks for a project
45
45
  * @param bucketId - The bucket ID
46
46
  * @param options - Optional query parameters
47
- * @returns All Webhook across all pages, with .meta.totalCount
47
+ * @returns Every Webhook across all pages, with .meta.totalCount
48
48
  *
49
49
  * @example
50
50
  * ```ts
@@ -16,7 +16,7 @@ export class WebhooksService extends BaseService {
16
16
  * List all webhooks for a project
17
17
  * @param bucketId - The bucket ID
18
18
  * @param options - Optional query parameters
19
- * @returns All Webhook across all pages, with .meta.totalCount
19
+ * @returns Every Webhook across all pages, with .meta.totalCount
20
20
  *
21
21
  * @example
22
22
  * ```ts
@@ -61,7 +61,7 @@ export class WebhooksService extends BaseService {
61
61
  * List all webhooks for a project
62
62
  * @param bucketId - The bucket ID
63
63
  * @param options - Optional query parameters
64
- * @returns All Webhook across all pages, with .meta.totalCount
64
+ * @returns Every Webhook across all pages, with .meta.totalCount
65
65
  *
66
66
  * @example
67
67
  * ```ts
package/dist/index.d.ts CHANGED
@@ -56,7 +56,7 @@ export { CardTablesService, type CardTable, } from "./generated/services/card-ta
56
56
  export { type Card, type CreateCardRequest, type UpdateVerbatimCardRequest, type MoveCardRequest, } from "./generated/services/cards.js";
57
57
  export { CardsService, type UpdateCardRequest, } from "./services/cards-extensions.js";
58
58
  export { CardColumnsService, type CardColumn, type CreateCardColumnRequest, type UpdateCardColumnRequest, type MoveCardColumnRequest, type SetColorCardColumnRequest, } from "./generated/services/card-columns.js";
59
- export { CardStepsService, type CardStep, type CreateCardStepRequest, type UpdateCardStepRequest, } from "./generated/services/card-steps.js";
59
+ export { CardStepsService, type CreateCardStepRequest, type UpdateCardStepRequest, } from "./generated/services/card-steps.js";
60
60
  export { WormholesService, type Wormhole, type CreateWormholeRequest, type UpdateWormholeRequest, } from "./generated/services/wormholes.js";
61
61
  export { MessageBoardsService, type MessageBoard, } from "./generated/services/message-boards.js";
62
62
  export { MessageTypesService, type MessageType, type CreateMessageTypeRequest, type UpdateMessageTypeRequest, } from "./generated/services/message-types.js";
@@ -102,6 +102,7 @@ export { LineupService, type LineupMarker, type CreateLineupRequest, type Update
102
102
  export { TodolistGroupsService, type CreateTodolistGroupRequest, } from "./generated/services/todolist-groups.js";
103
103
  export { ToolsService, type Tool, } from "./generated/services/tools.js";
104
104
  export { BoostsService, type Boost, type ListForRecordingBoostOptions, type CreateForRecordingBoostRequest, type ListForEventBoostOptions, type CreateForEventBoostRequest, } from "./generated/services/boosts.js";
105
+ export { SubtasksService, type Subtask, type CardStep, type ListSubtaskOptions, type CreateSubtaskRequest, type UpdateSubtaskRequest, type RepositionSubtaskRequest, } from "./generated/services/subtasks.js";
105
106
  export { AccountService, } from "./generated/services/account.js";
106
107
  export { GaugesService, } from "./generated/services/gauges.js";
107
108
  export { MyAssignmentsService, } from "./generated/services/my-assignments.js";