@37signals/basecamp 0.12.0 → 0.14.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.
- package/README.md +114 -17
- package/dist/.build-complete +0 -0
- package/dist/client.d.ts +53 -11
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +132 -150
- package/dist/client.js.map +1 -1
- package/dist/download.d.ts +7 -0
- package/dist/download.d.ts.map +1 -1
- package/dist/download.js +82 -22
- package/dist/download.js.map +1 -1
- package/dist/errors.d.ts +19 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +138 -14
- package/dist/errors.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +291 -141
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +291 -141
- package/dist/generated/openapi-stripped.json +5954 -3523
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +28 -16
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +28 -16
- package/dist/generated/schema.d.ts +4390 -2357
- package/dist/generated/services/bookmarks.d.ts +1 -1
- package/dist/generated/services/bookmarks.d.ts.map +1 -1
- package/dist/generated/services/bookmarks.ts +1 -1
- package/dist/generated/services/boosts.d.ts +10 -0
- package/dist/generated/services/boosts.d.ts.map +1 -1
- package/dist/generated/services/boosts.js +8 -0
- package/dist/generated/services/boosts.js.map +1 -1
- package/dist/generated/services/boosts.ts +12 -0
- package/dist/generated/services/campfires.d.ts +54 -40
- package/dist/generated/services/campfires.d.ts.map +1 -1
- package/dist/generated/services/campfires.js +82 -65
- package/dist/generated/services/campfires.js.map +1 -1
- package/dist/generated/services/campfires.ts +107 -85
- package/dist/generated/services/cards.d.ts +5 -0
- package/dist/generated/services/cards.d.ts.map +1 -1
- package/dist/generated/services/cards.js +4 -0
- package/dist/generated/services/cards.js.map +1 -1
- package/dist/generated/services/cards.ts +6 -0
- package/dist/generated/services/checkins.d.ts +14 -0
- package/dist/generated/services/checkins.d.ts.map +1 -1
- package/dist/generated/services/checkins.js +14 -1
- package/dist/generated/services/checkins.js.map +1 -1
- package/dist/generated/services/checkins.ts +20 -0
- package/dist/generated/services/client-approvals.d.ts +6 -3
- package/dist/generated/services/client-approvals.d.ts.map +1 -1
- package/dist/generated/services/client-approvals.js +8 -5
- package/dist/generated/services/client-approvals.js.map +1 -1
- package/dist/generated/services/client-approvals.ts +10 -5
- package/dist/generated/services/client-correspondences.d.ts +6 -3
- package/dist/generated/services/client-correspondences.d.ts.map +1 -1
- package/dist/generated/services/client-correspondences.js +8 -5
- package/dist/generated/services/client-correspondences.js.map +1 -1
- package/dist/generated/services/client-correspondences.ts +10 -5
- package/dist/generated/services/client-replies.d.ts +11 -4
- package/dist/generated/services/client-replies.d.ts.map +1 -1
- package/dist/generated/services/client-replies.js +16 -8
- package/dist/generated/services/client-replies.js.map +1 -1
- package/dist/generated/services/client-replies.ts +18 -8
- package/dist/generated/services/cloud-files.d.ts +92 -0
- package/dist/generated/services/cloud-files.d.ts.map +1 -0
- package/dist/generated/services/cloud-files.js +121 -0
- package/dist/generated/services/cloud-files.js.map +1 -0
- package/dist/generated/services/cloud-files.ts +188 -0
- package/dist/generated/services/comments.d.ts +5 -0
- package/dist/generated/services/comments.d.ts.map +1 -1
- package/dist/generated/services/comments.js +4 -0
- package/dist/generated/services/comments.js.map +1 -1
- package/dist/generated/services/comments.ts +6 -0
- package/dist/generated/services/documents.d.ts +12 -7
- package/dist/generated/services/documents.d.ts.map +1 -1
- package/dist/generated/services/documents.js +10 -6
- package/dist/generated/services/documents.js.map +1 -1
- package/dist/generated/services/documents.ts +14 -8
- package/dist/generated/services/drafts.d.ts +1 -1
- package/dist/generated/services/drafts.d.ts.map +1 -1
- package/dist/generated/services/drafts.ts +1 -1
- package/dist/generated/services/events.d.ts +5 -0
- package/dist/generated/services/events.d.ts.map +1 -1
- package/dist/generated/services/events.js +4 -0
- package/dist/generated/services/events.js.map +1 -1
- package/dist/generated/services/events.ts +6 -0
- package/dist/generated/services/everything.d.ts +14 -14
- package/dist/generated/services/everything.d.ts.map +1 -1
- package/dist/generated/services/everything.ts +14 -14
- package/dist/generated/services/folders.d.ts +96 -0
- package/dist/generated/services/folders.d.ts.map +1 -0
- package/dist/generated/services/folders.js +140 -0
- package/dist/generated/services/folders.js.map +1 -0
- package/dist/generated/services/folders.ts +201 -0
- package/dist/generated/services/forwards.d.ts +7 -20
- package/dist/generated/services/forwards.d.ts.map +1 -1
- package/dist/generated/services/forwards.js +6 -35
- package/dist/generated/services/forwards.js.map +1 -1
- package/dist/generated/services/forwards.ts +10 -48
- package/dist/generated/services/gauges.d.ts +7 -0
- package/dist/generated/services/gauges.d.ts.map +1 -1
- package/dist/generated/services/gauges.js +5 -1
- package/dist/generated/services/gauges.js.map +1 -1
- package/dist/generated/services/gauges.ts +9 -1
- package/dist/generated/services/google-documents.d.ts +98 -0
- package/dist/generated/services/google-documents.d.ts.map +1 -0
- package/dist/generated/services/google-documents.js +123 -0
- package/dist/generated/services/google-documents.js.map +1 -0
- package/dist/generated/services/google-documents.ts +196 -0
- package/dist/generated/services/index.d.ts +7 -4
- package/dist/generated/services/index.d.ts.map +1 -1
- package/dist/generated/services/index.js +7 -4
- package/dist/generated/services/index.js.map +1 -1
- package/dist/generated/services/index.ts +7 -4
- package/dist/generated/services/messages.d.ts +2 -0
- package/dist/generated/services/messages.d.ts.map +1 -1
- package/dist/generated/services/messages.js +1 -1
- package/dist/generated/services/messages.js.map +1 -1
- package/dist/generated/services/messages.ts +3 -1
- package/dist/generated/services/my-notes.d.ts +1 -1
- package/dist/generated/services/my-notes.js +1 -1
- package/dist/generated/services/my-notes.ts +1 -1
- package/dist/generated/services/my-notifications.d.ts +4 -2
- package/dist/generated/services/my-notifications.d.ts.map +1 -1
- package/dist/generated/services/my-notifications.js.map +1 -1
- package/dist/generated/services/my-notifications.ts +4 -2
- package/dist/generated/services/people.d.ts +11 -1
- package/dist/generated/services/people.d.ts.map +1 -1
- package/dist/generated/services/people.js +13 -2
- package/dist/generated/services/people.js.map +1 -1
- package/dist/generated/services/people.ts +15 -1
- package/dist/generated/services/projects.d.ts +26 -0
- package/dist/generated/services/projects.d.ts.map +1 -1
- package/dist/generated/services/projects.js +49 -1
- package/dist/generated/services/projects.js.map +1 -1
- package/dist/generated/services/projects.ts +61 -1
- package/dist/generated/services/recordings.d.ts +2 -12
- package/dist/generated/services/recordings.d.ts.map +1 -1
- package/dist/generated/services/recordings.js +1 -26
- package/dist/generated/services/recordings.js.map +1 -1
- package/dist/generated/services/recordings.ts +3 -31
- package/dist/generated/services/reports.d.ts +8 -12
- package/dist/generated/services/reports.d.ts.map +1 -1
- package/dist/generated/services/reports.js +11 -5
- package/dist/generated/services/reports.js.map +1 -1
- package/dist/generated/services/reports.ts +13 -14
- package/dist/generated/services/schedules.d.ts +94 -15
- package/dist/generated/services/schedules.d.ts.map +1 -1
- package/dist/generated/services/schedules.js +19 -8
- package/dist/generated/services/schedules.js.map +1 -1
- package/dist/generated/services/schedules.ts +107 -17
- package/dist/generated/services/search.d.ts +2 -0
- package/dist/generated/services/search.d.ts.map +1 -1
- package/dist/generated/services/search.js +1 -1
- package/dist/generated/services/search.js.map +1 -1
- package/dist/generated/services/search.ts +3 -1
- package/dist/generated/services/templates.d.ts +2 -0
- package/dist/generated/services/templates.d.ts.map +1 -1
- package/dist/generated/services/templates.js +1 -1
- package/dist/generated/services/templates.js.map +1 -1
- package/dist/generated/services/templates.ts +3 -1
- package/dist/generated/services/timeline.d.ts +2 -0
- package/dist/generated/services/timeline.d.ts.map +1 -1
- package/dist/generated/services/timeline.js +1 -0
- package/dist/generated/services/timeline.js.map +1 -1
- package/dist/generated/services/timeline.ts +3 -0
- package/dist/generated/services/timesheets.d.ts +16 -0
- package/dist/generated/services/timesheets.d.ts.map +1 -1
- package/dist/generated/services/timesheets.js +26 -2
- package/dist/generated/services/timesheets.js.map +1 -1
- package/dist/generated/services/timesheets.ts +35 -2
- package/dist/generated/services/todolist-groups.d.ts +11 -6
- package/dist/generated/services/todolist-groups.d.ts.map +1 -1
- package/dist/generated/services/todolist-groups.js +7 -3
- package/dist/generated/services/todolist-groups.js.map +1 -1
- package/dist/generated/services/todolist-groups.ts +13 -7
- package/dist/generated/services/todolists.d.ts +15 -13
- package/dist/generated/services/todolists.d.ts.map +1 -1
- package/dist/generated/services/todolists.js +11 -8
- package/dist/generated/services/todolists.js.map +1 -1
- package/dist/generated/services/todolists.ts +19 -14
- package/dist/generated/services/todos.d.ts +2 -12
- package/dist/generated/services/todos.d.ts.map +1 -1
- package/dist/generated/services/todos.js +1 -25
- package/dist/generated/services/todos.js.map +1 -1
- package/dist/generated/services/todos.ts +3 -30
- package/dist/generated/services/uploads.d.ts +41 -2
- package/dist/generated/services/uploads.d.ts.map +1 -1
- package/dist/generated/services/uploads.js +41 -1
- package/dist/generated/services/uploads.js.map +1 -1
- package/dist/generated/services/uploads.ts +71 -2
- package/dist/generated/services/vaults.d.ts +5 -0
- package/dist/generated/services/vaults.d.ts.map +1 -1
- package/dist/generated/services/vaults.js +4 -0
- package/dist/generated/services/vaults.js.map +1 -1
- package/dist/generated/services/vaults.ts +6 -0
- package/dist/index.d.ts +16 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -8
- package/dist/index.js.map +1 -1
- package/dist/oauth/authorization-document.d.ts +201 -0
- package/dist/oauth/authorization-document.d.ts.map +1 -0
- package/dist/oauth/authorization-document.js +130 -0
- package/dist/oauth/authorization-document.js.map +1 -0
- package/dist/oauth/identity.d.ts +7 -1
- package/dist/oauth/identity.d.ts.map +1 -1
- package/dist/oauth/identity.js +8 -19
- package/dist/oauth/identity.js.map +1 -1
- package/dist/oauth/index.d.ts +1 -0
- package/dist/oauth/index.d.ts.map +1 -1
- package/dist/oauth/index.js +2 -0
- package/dist/oauth/index.js.map +1 -1
- package/dist/pagination-utils.d.ts +46 -0
- package/dist/pagination-utils.d.ts.map +1 -1
- package/dist/pagination-utils.js +85 -2
- package/dist/pagination-utils.js.map +1 -1
- package/dist/pagination.d.ts +11 -0
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js.map +1 -1
- package/dist/retry.d.ts +110 -0
- package/dist/retry.d.ts.map +1 -0
- package/dist/retry.js +253 -0
- package/dist/retry.js.map +1 -0
- package/dist/services/authorization.d.ts +22 -52
- package/dist/services/authorization.d.ts.map +1 -1
- package/dist/services/authorization.js +14 -32
- package/dist/services/authorization.js.map +1 -1
- package/dist/services/base.d.ts.map +1 -1
- package/dist/services/base.js +59 -5
- package/dist/services/base.js.map +1 -1
- package/dist/services/cards-extensions.d.ts +26 -21
- package/dist/services/cards-extensions.d.ts.map +1 -1
- package/dist/services/cards-extensions.js +28 -31
- package/dist/services/cards-extensions.js.map +1 -1
- package/dist/services/documents-extensions.d.ts +122 -0
- package/dist/services/documents-extensions.d.ts.map +1 -0
- package/dist/services/documents-extensions.js +125 -0
- package/dist/services/documents-extensions.js.map +1 -0
- package/dist/services/merge-safe.d.ts +167 -0
- package/dist/services/merge-safe.d.ts.map +1 -0
- package/dist/services/merge-safe.js +217 -0
- package/dist/services/merge-safe.js.map +1 -0
- package/dist/services/schedules-extensions.d.ts +266 -0
- package/dist/services/schedules-extensions.d.ts.map +1 -0
- package/dist/services/schedules-extensions.js +268 -0
- package/dist/services/schedules-extensions.js.map +1 -0
- package/dist/services/todolists-extensions.d.ts +110 -0
- package/dist/services/todolists-extensions.d.ts.map +1 -0
- package/dist/services/todolists-extensions.js +262 -0
- package/dist/services/todolists-extensions.js.map +1 -0
- package/dist/services/todos-extensions.d.ts +12 -1
- package/dist/services/todos-extensions.d.ts.map +1 -1
- package/dist/services/todos-extensions.js +27 -8
- package/dist/services/todos-extensions.js.map +1 -1
- package/package.json +6 -5
- package/src/generated/metadata.ts +291 -141
- package/src/generated/openapi-stripped.json +5954 -3523
- package/src/generated/path-mapping.ts +28 -16
- package/src/generated/schema.d.ts +4390 -2357
- package/src/generated/services/bookmarks.ts +1 -1
- package/src/generated/services/boosts.ts +12 -0
- package/src/generated/services/campfires.ts +107 -85
- package/src/generated/services/cards.ts +6 -0
- package/src/generated/services/checkins.ts +20 -0
- package/src/generated/services/client-approvals.ts +10 -5
- package/src/generated/services/client-correspondences.ts +10 -5
- package/src/generated/services/client-replies.ts +18 -8
- package/src/generated/services/cloud-files.ts +188 -0
- package/src/generated/services/comments.ts +6 -0
- package/src/generated/services/documents.ts +14 -8
- package/src/generated/services/drafts.ts +1 -1
- package/src/generated/services/events.ts +6 -0
- package/src/generated/services/everything.ts +14 -14
- package/src/generated/services/folders.ts +201 -0
- package/src/generated/services/forwards.ts +10 -48
- package/src/generated/services/gauges.ts +9 -1
- package/src/generated/services/google-documents.ts +196 -0
- package/src/generated/services/index.ts +7 -4
- package/src/generated/services/messages.ts +3 -1
- package/src/generated/services/my-notes.ts +1 -1
- package/src/generated/services/my-notifications.ts +4 -2
- package/src/generated/services/people.ts +15 -1
- package/src/generated/services/projects.ts +61 -1
- package/src/generated/services/recordings.ts +3 -31
- package/src/generated/services/reports.ts +13 -14
- package/src/generated/services/schedules.ts +107 -17
- package/src/generated/services/search.ts +3 -1
- package/src/generated/services/templates.ts +3 -1
- package/src/generated/services/timeline.ts +3 -0
- package/src/generated/services/timesheets.ts +35 -2
- package/src/generated/services/todolist-groups.ts +13 -7
- package/src/generated/services/todolists.ts +19 -14
- package/src/generated/services/todos.ts +3 -30
- package/src/generated/services/uploads.ts +71 -2
- package/src/generated/services/vaults.ts +6 -0
|
@@ -31,7 +31,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
31
31
|
resourceType: "todolist_group",
|
|
32
32
|
isMutation: true,
|
|
33
33
|
resourceId: groupId,
|
|
34
|
-
}, () => this.client.PUT("/todolists/{groupId}/position.json", {
|
|
34
|
+
}, () => this.client.PUT("/todolists/groups/{groupId}/position.json", {
|
|
35
35
|
params: {
|
|
36
36
|
path: { groupId },
|
|
37
37
|
},
|
|
@@ -44,11 +44,14 @@ 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
|
|
47
|
+
* @returns All Todolist across all pages, with .meta.totalCount
|
|
48
48
|
*
|
|
49
49
|
* @example
|
|
50
50
|
* ```ts
|
|
51
51
|
* const result = await client.todolistGroups.list(123);
|
|
52
|
+
*
|
|
53
|
+
* // With options
|
|
54
|
+
* const filtered = await client.todolistGroups.list(123, { page: 1 });
|
|
52
55
|
* ```
|
|
53
56
|
*/
|
|
54
57
|
async list(todolistId, options) {
|
|
@@ -61,6 +64,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
61
64
|
}, () => this.client.GET("/todolists/{todolistId}/groups.json", {
|
|
62
65
|
params: {
|
|
63
66
|
path: { todolistId },
|
|
67
|
+
query: { page: options?.page },
|
|
64
68
|
},
|
|
65
69
|
}), options);
|
|
66
70
|
}
|
|
@@ -68,7 +72,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
68
72
|
* Create a new group in a todolist
|
|
69
73
|
* @param todolistId - The todolist ID
|
|
70
74
|
* @param req - Todolist_group creation parameters
|
|
71
|
-
* @returns The
|
|
75
|
+
* @returns The Todolist
|
|
72
76
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
73
77
|
*
|
|
74
78
|
* @example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todolist-groups.js","sourceRoot":"","sources":["../../../src/generated/services/todolist-groups.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"todolist-groups.js","sourceRoot":"","sources":["../../../src/generated/services/todolist-groups.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkCzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAEpD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,GAAmC;QACnE,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,yBAAyB;YACpC,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,2CAA2C,EAAE;YAC3D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,UAAkB,EAAE,OAAkC;QAC/D,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;gBACpB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,GAA+B;QAC9D,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE;YACtD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;aACf;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -14,8 +14,8 @@ import { Errors } from "../../errors.js";
|
|
|
14
14
|
// Types
|
|
15
15
|
// =============================================================================
|
|
16
16
|
|
|
17
|
-
/**
|
|
18
|
-
export type
|
|
17
|
+
/** Todolist entity from the Basecamp API. */
|
|
18
|
+
export type Todolist = components["schemas"]["Todolist"];
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Request parameters for reposition.
|
|
@@ -29,6 +29,8 @@ export interface RepositionTodolistGroupRequest {
|
|
|
29
29
|
* Options for list.
|
|
30
30
|
*/
|
|
31
31
|
export interface ListTodolistGroupOptions extends PaginationOptions {
|
|
32
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
33
|
+
page?: number;
|
|
32
34
|
}
|
|
33
35
|
|
|
34
36
|
/**
|
|
@@ -71,7 +73,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
71
73
|
resourceId: groupId,
|
|
72
74
|
},
|
|
73
75
|
() =>
|
|
74
|
-
this.client.PUT("/todolists/{groupId}/position.json", {
|
|
76
|
+
this.client.PUT("/todolists/groups/{groupId}/position.json", {
|
|
75
77
|
params: {
|
|
76
78
|
path: { groupId },
|
|
77
79
|
},
|
|
@@ -86,14 +88,17 @@ export class TodolistGroupsService extends BaseService {
|
|
|
86
88
|
* List groups in a todolist
|
|
87
89
|
* @param todolistId - The todolist ID
|
|
88
90
|
* @param options - Optional query parameters
|
|
89
|
-
* @returns All
|
|
91
|
+
* @returns All Todolist across all pages, with .meta.totalCount
|
|
90
92
|
*
|
|
91
93
|
* @example
|
|
92
94
|
* ```ts
|
|
93
95
|
* const result = await client.todolistGroups.list(123);
|
|
96
|
+
*
|
|
97
|
+
* // With options
|
|
98
|
+
* const filtered = await client.todolistGroups.list(123, { page: 1 });
|
|
94
99
|
* ```
|
|
95
100
|
*/
|
|
96
|
-
async list(todolistId: number, options?: ListTodolistGroupOptions): Promise<ListResult<
|
|
101
|
+
async list(todolistId: number, options?: ListTodolistGroupOptions): Promise<ListResult<Todolist>> {
|
|
97
102
|
return this.requestPaginated(
|
|
98
103
|
{
|
|
99
104
|
service: "TodolistGroups",
|
|
@@ -106,6 +111,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
106
111
|
this.client.GET("/todolists/{todolistId}/groups.json", {
|
|
107
112
|
params: {
|
|
108
113
|
path: { todolistId },
|
|
114
|
+
query: { page: options?.page },
|
|
109
115
|
},
|
|
110
116
|
})
|
|
111
117
|
, options
|
|
@@ -116,7 +122,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
116
122
|
* Create a new group in a todolist
|
|
117
123
|
* @param todolistId - The todolist ID
|
|
118
124
|
* @param req - Todolist_group creation parameters
|
|
119
|
-
* @returns The
|
|
125
|
+
* @returns The Todolist
|
|
120
126
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
121
127
|
*
|
|
122
128
|
* @example
|
|
@@ -124,7 +130,7 @@ export class TodolistGroupsService extends BaseService {
|
|
|
124
130
|
* const result = await client.todolistGroups.create(123, { name: "My example" });
|
|
125
131
|
* ```
|
|
126
132
|
*/
|
|
127
|
-
async create(todolistId: number, req: CreateTodolistGroupRequest): Promise<
|
|
133
|
+
async create(todolistId: number, req: CreateTodolistGroupRequest): Promise<Todolist> {
|
|
128
134
|
if (!req.name) {
|
|
129
135
|
throw Errors.validation("Name is required");
|
|
130
136
|
}
|
|
@@ -10,12 +10,12 @@ import type { PaginationOptions } from "../../pagination.js";
|
|
|
10
10
|
/** Todolist entity from the Basecamp API. */
|
|
11
11
|
export type Todolist = components["schemas"]["Todolist"];
|
|
12
12
|
/**
|
|
13
|
-
* Request parameters for
|
|
13
|
+
* Request parameters for replace.
|
|
14
14
|
*/
|
|
15
|
-
export interface
|
|
16
|
-
/** Name (required for
|
|
17
|
-
name
|
|
18
|
-
/** Description (
|
|
15
|
+
export interface ReplaceTodolistRequest {
|
|
16
|
+
/** Name (required for a to-do list and for a group alike) - presence-validated server-side, so omitting it is a 422, not a preserve */
|
|
17
|
+
name: string;
|
|
18
|
+
/** Description (rich text HTML) - writable for a todolist group as well as a todolist, and omitting it clears it either way */
|
|
19
19
|
description?: string;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
@@ -31,6 +31,8 @@ export interface RepositionTodolistRequest {
|
|
|
31
31
|
export interface ListTodolistOptions extends PaginationOptions {
|
|
32
32
|
/** Filter by status */
|
|
33
33
|
status?: "active" | "archived" | "trashed";
|
|
34
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
35
|
+
page?: number;
|
|
34
36
|
}
|
|
35
37
|
/**
|
|
36
38
|
* Request parameters for create.
|
|
@@ -50,7 +52,7 @@ export declare class TodolistsService extends BaseService {
|
|
|
50
52
|
/**
|
|
51
53
|
* Get a single todolist or todolist group by id
|
|
52
54
|
* @param id - The id
|
|
53
|
-
* @returns The
|
|
55
|
+
* @returns The Todolist
|
|
54
56
|
* @throws {BasecampError} If the resource is not found
|
|
55
57
|
*
|
|
56
58
|
* @example
|
|
@@ -58,20 +60,20 @@ export declare class TodolistsService extends BaseService {
|
|
|
58
60
|
* const result = await client.todolists.get(123);
|
|
59
61
|
* ```
|
|
60
62
|
*/
|
|
61
|
-
get(id: number): Promise<
|
|
63
|
+
get(id: number): Promise<Todolist>;
|
|
62
64
|
/**
|
|
63
|
-
*
|
|
65
|
+
* Replace a todolist (or todolist group) with a new complete representation.
|
|
64
66
|
* @param id - The id
|
|
65
|
-
* @param req - Todolist_or_group
|
|
66
|
-
* @returns The
|
|
67
|
-
* @throws {BasecampError} If the
|
|
67
|
+
* @param req - Todolist_or_group request parameters
|
|
68
|
+
* @returns The Todolist
|
|
69
|
+
* @throws {BasecampError} If the request fails
|
|
68
70
|
*
|
|
69
71
|
* @example
|
|
70
72
|
* ```ts
|
|
71
|
-
* const result = await client.todolists.
|
|
73
|
+
* const result = await client.todolists.replace(123, { name: "My example" });
|
|
72
74
|
* ```
|
|
73
75
|
*/
|
|
74
|
-
|
|
76
|
+
replace(id: number, req: ReplaceTodolistRequest): Promise<Todolist>;
|
|
75
77
|
/**
|
|
76
78
|
* Reposition a to-do list within its to-do set.
|
|
77
79
|
* @param todolistId - The todolist ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todolists.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todolists.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,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"todolists.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todolists.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,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,uIAAuI;IACvI,IAAI,EAAE,MAAM,CAAC;IACb,+HAA+H;IAC/H,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAC3C,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBxC;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BzE;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBnF;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAoB3F;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;CA0B/E"}
|
|
@@ -15,7 +15,7 @@ export class TodolistsService extends BaseService {
|
|
|
15
15
|
/**
|
|
16
16
|
* Get a single todolist or todolist group by id
|
|
17
17
|
* @param id - The id
|
|
18
|
-
* @returns The
|
|
18
|
+
* @returns The Todolist
|
|
19
19
|
* @throws {BasecampError} If the resource is not found
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
@@ -38,18 +38,21 @@ export class TodolistsService extends BaseService {
|
|
|
38
38
|
return response;
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Replace a todolist (or todolist group) with a new complete representation.
|
|
42
42
|
* @param id - The id
|
|
43
|
-
* @param req - Todolist_or_group
|
|
44
|
-
* @returns The
|
|
45
|
-
* @throws {BasecampError} If the
|
|
43
|
+
* @param req - Todolist_or_group request parameters
|
|
44
|
+
* @returns The Todolist
|
|
45
|
+
* @throws {BasecampError} If the request fails
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* ```ts
|
|
49
|
-
* const result = await client.todolists.
|
|
49
|
+
* const result = await client.todolists.replace(123, { name: "My example" });
|
|
50
50
|
* ```
|
|
51
51
|
*/
|
|
52
|
-
async
|
|
52
|
+
async replace(id, req) {
|
|
53
|
+
if (!req.name) {
|
|
54
|
+
throw Errors.validation("Name is required");
|
|
55
|
+
}
|
|
53
56
|
const response = await this.request({
|
|
54
57
|
service: "Todolists",
|
|
55
58
|
operation: "UpdateTodolistOrGroup",
|
|
@@ -119,7 +122,7 @@ export class TodolistsService extends BaseService {
|
|
|
119
122
|
}, () => this.client.GET("/todosets/{todosetId}/todolists.json", {
|
|
120
123
|
params: {
|
|
121
124
|
path: { todosetId },
|
|
122
|
-
query: { status: options?.status },
|
|
125
|
+
query: { status: options?.status, page: options?.page },
|
|
123
126
|
},
|
|
124
127
|
}), options);
|
|
125
128
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todolists.js","sourceRoot":"","sources":["../../../src/generated/services/todolists.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"todolists.js","sourceRoot":"","sources":["../../../src/generated/services/todolists.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAkDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,mBAAmB;YACjC,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,EAAE;SACf,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,EAAE,EAAE;aACb;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,GAA2B;QACnD,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,uBAAuB;YAClC,YAAY,EAAE,mBAAmB;YACjC,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,EAAE;SACf,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,EAAE,EAAE;aACb;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,WAAW,EAAE,GAAG,CAAC,WAAW;aAC7B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,UAAkB,EAAE,GAA8B;QACjE,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE;YAChE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,SAAiB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACtD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;gBACnB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aACxD;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,GAA0B;QACxD,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;aACpB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,kBAAkB,EAAE,GAAG,CAAC,gBAAgB;aACzC;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -18,12 +18,12 @@ import { Errors } from "../../errors.js";
|
|
|
18
18
|
export type Todolist = components["schemas"]["Todolist"];
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* Request parameters for
|
|
21
|
+
* Request parameters for replace.
|
|
22
22
|
*/
|
|
23
|
-
export interface
|
|
24
|
-
/** Name (required for
|
|
25
|
-
name
|
|
26
|
-
/** Description (
|
|
23
|
+
export interface ReplaceTodolistRequest {
|
|
24
|
+
/** Name (required for a to-do list and for a group alike) - presence-validated server-side, so omitting it is a 422, not a preserve */
|
|
25
|
+
name: string;
|
|
26
|
+
/** Description (rich text HTML) - writable for a todolist group as well as a todolist, and omitting it clears it either way */
|
|
27
27
|
description?: string;
|
|
28
28
|
}
|
|
29
29
|
|
|
@@ -41,6 +41,8 @@ export interface RepositionTodolistRequest {
|
|
|
41
41
|
export interface ListTodolistOptions extends PaginationOptions {
|
|
42
42
|
/** Filter by status */
|
|
43
43
|
status?: "active" | "archived" | "trashed";
|
|
44
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
45
|
+
page?: number;
|
|
44
46
|
}
|
|
45
47
|
|
|
46
48
|
/**
|
|
@@ -68,7 +70,7 @@ export class TodolistsService extends BaseService {
|
|
|
68
70
|
/**
|
|
69
71
|
* Get a single todolist or todolist group by id
|
|
70
72
|
* @param id - The id
|
|
71
|
-
* @returns The
|
|
73
|
+
* @returns The Todolist
|
|
72
74
|
* @throws {BasecampError} If the resource is not found
|
|
73
75
|
*
|
|
74
76
|
* @example
|
|
@@ -76,7 +78,7 @@ export class TodolistsService extends BaseService {
|
|
|
76
78
|
* const result = await client.todolists.get(123);
|
|
77
79
|
* ```
|
|
78
80
|
*/
|
|
79
|
-
async get(id: number): Promise<
|
|
81
|
+
async get(id: number): Promise<Todolist> {
|
|
80
82
|
const response = await this.request(
|
|
81
83
|
{
|
|
82
84
|
service: "Todolists",
|
|
@@ -96,18 +98,21 @@ export class TodolistsService extends BaseService {
|
|
|
96
98
|
}
|
|
97
99
|
|
|
98
100
|
/**
|
|
99
|
-
*
|
|
101
|
+
* Replace a todolist (or todolist group) with a new complete representation.
|
|
100
102
|
* @param id - The id
|
|
101
|
-
* @param req - Todolist_or_group
|
|
102
|
-
* @returns The
|
|
103
|
-
* @throws {BasecampError} If the
|
|
103
|
+
* @param req - Todolist_or_group request parameters
|
|
104
|
+
* @returns The Todolist
|
|
105
|
+
* @throws {BasecampError} If the request fails
|
|
104
106
|
*
|
|
105
107
|
* @example
|
|
106
108
|
* ```ts
|
|
107
|
-
* const result = await client.todolists.
|
|
109
|
+
* const result = await client.todolists.replace(123, { name: "My example" });
|
|
108
110
|
* ```
|
|
109
111
|
*/
|
|
110
|
-
async
|
|
112
|
+
async replace(id: number, req: ReplaceTodolistRequest): Promise<Todolist> {
|
|
113
|
+
if (!req.name) {
|
|
114
|
+
throw Errors.validation("Name is required");
|
|
115
|
+
}
|
|
111
116
|
const response = await this.request(
|
|
112
117
|
{
|
|
113
118
|
service: "Todolists",
|
|
@@ -190,7 +195,7 @@ export class TodolistsService extends BaseService {
|
|
|
190
195
|
this.client.GET("/todosets/{todosetId}/todolists.json", {
|
|
191
196
|
params: {
|
|
192
197
|
path: { todosetId },
|
|
193
|
-
query: { status: options?.status },
|
|
198
|
+
query: { status: options?.status, page: options?.page },
|
|
194
199
|
},
|
|
195
200
|
})
|
|
196
201
|
, options
|
|
@@ -36,6 +36,8 @@ export interface ListTodoOptions extends PaginationOptions {
|
|
|
36
36
|
status?: "active" | "archived" | "trashed";
|
|
37
37
|
/** Completed */
|
|
38
38
|
completed?: boolean;
|
|
39
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
40
|
+
page?: number;
|
|
39
41
|
}
|
|
40
42
|
/**
|
|
41
43
|
* Request parameters for create.
|
|
@@ -155,18 +157,6 @@ export declare class TodosService extends BaseService {
|
|
|
155
157
|
* ```
|
|
156
158
|
*/
|
|
157
159
|
replace(todoId: number, req: ReplaceTodoRequest): Promise<Todo>;
|
|
158
|
-
/**
|
|
159
|
-
* Trash a todo. Trashed items can be recovered.
|
|
160
|
-
* @param todoId - The todo ID
|
|
161
|
-
* @returns void
|
|
162
|
-
* @throws {BasecampError} If the request fails
|
|
163
|
-
*
|
|
164
|
-
* @example
|
|
165
|
-
* ```ts
|
|
166
|
-
* await client.todos.trash(123);
|
|
167
|
-
* ```
|
|
168
|
-
*/
|
|
169
|
-
trash(todoId: number): Promise<void>;
|
|
170
160
|
/**
|
|
171
161
|
* Mark a todo as complete
|
|
172
162
|
* @param todoId - The todo ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todos.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todos.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,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAC3C,gBAAgB;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"todos.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todos.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,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IAC3C,gBAAgB;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAOD;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;;;OAYG;IACG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAsC9G;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAoBpF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxC;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCrE;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB7C;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/C;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB5E"}
|
|
@@ -82,7 +82,7 @@ export class TodosService extends BaseService {
|
|
|
82
82
|
}, () => this.client.GET("/todolists/{todolistId}/todos.json", {
|
|
83
83
|
params: {
|
|
84
84
|
path: { todolistId },
|
|
85
|
-
query: { status: options?.status, completed: options?.completed },
|
|
85
|
+
query: { status: options?.status, completed: options?.completed, page: options?.page },
|
|
86
86
|
},
|
|
87
87
|
}), options);
|
|
88
88
|
}
|
|
@@ -199,30 +199,6 @@ export class TodosService extends BaseService {
|
|
|
199
199
|
}));
|
|
200
200
|
return response;
|
|
201
201
|
}
|
|
202
|
-
/**
|
|
203
|
-
* Trash a todo. Trashed items can be recovered.
|
|
204
|
-
* @param todoId - The todo ID
|
|
205
|
-
* @returns void
|
|
206
|
-
* @throws {BasecampError} If the request fails
|
|
207
|
-
*
|
|
208
|
-
* @example
|
|
209
|
-
* ```ts
|
|
210
|
-
* await client.todos.trash(123);
|
|
211
|
-
* ```
|
|
212
|
-
*/
|
|
213
|
-
async trash(todoId) {
|
|
214
|
-
await this.request({
|
|
215
|
-
service: "Todos",
|
|
216
|
-
operation: "TrashTodo",
|
|
217
|
-
resourceType: "todo",
|
|
218
|
-
isMutation: true,
|
|
219
|
-
resourceId: todoId,
|
|
220
|
-
}, () => this.client.DELETE("/todos/{todoId}", {
|
|
221
|
-
params: {
|
|
222
|
-
path: { todoId },
|
|
223
|
-
},
|
|
224
|
-
}));
|
|
225
|
-
}
|
|
226
202
|
/**
|
|
227
203
|
* Mark a todo as complete
|
|
228
204
|
* @param todoId - The todo ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todos.js","sourceRoot":"","sources":["../../../src/generated/services/todos.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"todos.js","sourceRoot":"","sources":["../../../src/generated/services/todos.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA4FzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,SAAiB,EAAE,GAAiC;QAC5F,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9D,MAAM,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,QAAQ;YACnB,UAAU,EAAE,SAAS;SACtB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qDAAqD,EAAE;YACtE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE;aAC9B;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,YAAY,EAAE,GAAG,CAAC,WAAW;gBAC7B,yBAAyB,EAAE,GAAG,CAAC,uBAAuB;gBACtD,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,UAAkB,EAAE,OAAyB;QACtD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE;YACpD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;gBACpB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aACvF;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,GAAsB;QACrD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9D,MAAM,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,YAAY,EAAE,GAAG,CAAC,WAAW;gBAC7B,yBAAyB,EAAE,GAAG,CAAC,uBAAuB;gBACtD,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,GAAuB;QACnD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9D,MAAM,MAAM,CAAC,UAAU,CAAC,wCAAwC,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,YAAY,EAAE,GAAG,CAAC,WAAW;gBAC7B,yBAAyB,EAAE,GAAG,CAAC,uBAAuB;gBACtD,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAc;QAC3B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAClD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc;QAC7B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iCAAiC,EAAE;YACpD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,GAA0B;QACzD,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE;YAC/C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -45,6 +45,8 @@ export interface ListTodoOptions extends PaginationOptions {
|
|
|
45
45
|
status?: "active" | "archived" | "trashed";
|
|
46
46
|
/** Completed */
|
|
47
47
|
completed?: boolean;
|
|
48
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
49
|
+
page?: number;
|
|
48
50
|
}
|
|
49
51
|
|
|
50
52
|
/**
|
|
@@ -185,7 +187,7 @@ export class TodosService extends BaseService {
|
|
|
185
187
|
this.client.GET("/todolists/{todolistId}/todos.json", {
|
|
186
188
|
params: {
|
|
187
189
|
path: { todolistId },
|
|
188
|
-
query: { status: options?.status, completed: options?.completed },
|
|
190
|
+
query: { status: options?.status, completed: options?.completed, page: options?.page },
|
|
189
191
|
},
|
|
190
192
|
})
|
|
191
193
|
, options
|
|
@@ -320,35 +322,6 @@ export class TodosService extends BaseService {
|
|
|
320
322
|
return response;
|
|
321
323
|
}
|
|
322
324
|
|
|
323
|
-
/**
|
|
324
|
-
* Trash a todo. Trashed items can be recovered.
|
|
325
|
-
* @param todoId - The todo ID
|
|
326
|
-
* @returns void
|
|
327
|
-
* @throws {BasecampError} If the request fails
|
|
328
|
-
*
|
|
329
|
-
* @example
|
|
330
|
-
* ```ts
|
|
331
|
-
* await client.todos.trash(123);
|
|
332
|
-
* ```
|
|
333
|
-
*/
|
|
334
|
-
async trash(todoId: number): Promise<void> {
|
|
335
|
-
await this.request(
|
|
336
|
-
{
|
|
337
|
-
service: "Todos",
|
|
338
|
-
operation: "TrashTodo",
|
|
339
|
-
resourceType: "todo",
|
|
340
|
-
isMutation: true,
|
|
341
|
-
resourceId: todoId,
|
|
342
|
-
},
|
|
343
|
-
() =>
|
|
344
|
-
this.client.DELETE("/todos/{todoId}", {
|
|
345
|
-
params: {
|
|
346
|
-
path: { todoId },
|
|
347
|
-
},
|
|
348
|
-
})
|
|
349
|
-
);
|
|
350
|
-
}
|
|
351
|
-
|
|
352
325
|
/**
|
|
353
326
|
* Mark a todo as complete
|
|
354
327
|
* @param todoId - The todo ID
|
|
@@ -9,6 +9,8 @@ import { ListResult } from "../../pagination.js";
|
|
|
9
9
|
import type { PaginationOptions } from "../../pagination.js";
|
|
10
10
|
/** Upload entity from the Basecamp API. */
|
|
11
11
|
export type Upload = components["schemas"]["Upload"];
|
|
12
|
+
/** UploadVersion entity from the Basecamp API. */
|
|
13
|
+
export type UploadVersion = components["schemas"]["UploadVersion"];
|
|
12
14
|
/**
|
|
13
15
|
* Request parameters for update.
|
|
14
16
|
*/
|
|
@@ -23,10 +25,31 @@ export interface UpdateUploadRequest {
|
|
|
23
25
|
*/
|
|
24
26
|
export interface ListVersionsUploadOptions extends PaginationOptions {
|
|
25
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Request parameters for createVersion.
|
|
30
|
+
*/
|
|
31
|
+
export interface CreateVersionUploadRequest {
|
|
32
|
+
/** Attachable sgid */
|
|
33
|
+
attachableSgid: string;
|
|
34
|
+
/** Omit to keep the uploaded file's own name. Sending "" also keeps it. */
|
|
35
|
+
baseName?: string;
|
|
36
|
+
/** Presence-aware: omit to carry the previous version's description forward,
|
|
37
|
+
send "" to clear it, send a value to set it. */
|
|
38
|
+
description?: string;
|
|
39
|
+
/** Who to notify: "default", "everyone", or "custom" (the people in subscriptions).
|
|
40
|
+
|
|
41
|
+
Omit both this and subscriptions to notify nobody. A subscriptions array sent
|
|
42
|
+
without notify is read as "custom". */
|
|
43
|
+
notify?: string;
|
|
44
|
+
/** People to notify about the replacement and subscribe to the upload. */
|
|
45
|
+
subscriptions?: number[];
|
|
46
|
+
}
|
|
26
47
|
/**
|
|
27
48
|
* Options for list.
|
|
28
49
|
*/
|
|
29
50
|
export interface ListUploadOptions extends PaginationOptions {
|
|
51
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
52
|
+
page?: number;
|
|
30
53
|
}
|
|
31
54
|
/**
|
|
32
55
|
* Request parameters for create.
|
|
@@ -76,14 +99,27 @@ export declare class UploadsService extends BaseService {
|
|
|
76
99
|
* List versions of an upload
|
|
77
100
|
* @param uploadId - The upload ID
|
|
78
101
|
* @param options - Optional query parameters
|
|
79
|
-
* @returns All
|
|
102
|
+
* @returns All UploadVersion across all pages, with .meta.totalCount
|
|
80
103
|
*
|
|
81
104
|
* @example
|
|
82
105
|
* ```ts
|
|
83
106
|
* const result = await client.uploads.listVersions(123);
|
|
84
107
|
* ```
|
|
85
108
|
*/
|
|
86
|
-
listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<
|
|
109
|
+
listVersions(uploadId: number, options?: ListVersionsUploadOptions): Promise<ListResult<UploadVersion>>;
|
|
110
|
+
/**
|
|
111
|
+
* Replace an upload's file with a new version
|
|
112
|
+
* @param uploadId - The upload ID
|
|
113
|
+
* @param req - Upload_version creation parameters
|
|
114
|
+
* @returns The Upload
|
|
115
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const result = await client.uploads.createVersion(123, { attachableSgid: "example" });
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
createVersion(uploadId: number, req: CreateVersionUploadRequest): Promise<Upload>;
|
|
87
123
|
/**
|
|
88
124
|
* List uploads in a vault
|
|
89
125
|
* @param vaultId - The vault ID
|
|
@@ -93,6 +129,9 @@ export declare class UploadsService extends BaseService {
|
|
|
93
129
|
* @example
|
|
94
130
|
* ```ts
|
|
95
131
|
* const result = await client.uploads.list(123);
|
|
132
|
+
*
|
|
133
|
+
* // With options
|
|
134
|
+
* const filtered = await client.uploads.list(123, { page: 1 });
|
|
96
135
|
* ```
|
|
97
136
|
*/
|
|
98
137
|
list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../../../src/generated/services/uploads.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,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["../../../src/generated/services/uploads.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,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AACrD,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;iDAC6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;wCAGoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAOD;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB5C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBzE;;;;;;;;;;OAUG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAmB7G;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IA6BvF;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAoBrF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CA4BzE"}
|