@37signals/basecamp 0.11.0 → 0.13.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 +112 -16
- package/dist/.build-complete +0 -0
- package/dist/client.d.ts +65 -11
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +235 -215
- 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 +128 -15
- package/dist/errors.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +443 -133
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +443 -133
- package/dist/generated/openapi-stripped.json +8999 -4907
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +40 -16
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +40 -16
- package/dist/generated/schema.d.ts +5508 -2346
- package/dist/generated/services/bookmarks.d.ts +76 -0
- package/dist/generated/services/bookmarks.d.ts.map +1 -0
- package/dist/generated/services/bookmarks.js +114 -0
- package/dist/generated/services/bookmarks.js.map +1 -0
- package/dist/generated/services/bookmarks.ts +158 -0
- 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/calendars.d.ts +47 -0
- package/dist/generated/services/calendars.d.ts.map +1 -0
- package/dist/generated/services/calendars.js +73 -0
- package/dist/generated/services/calendars.js.map +1 -0
- package/dist/generated/services/calendars.ts +102 -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 +38 -0
- package/dist/generated/services/drafts.d.ts.map +1 -0
- package/dist/generated/services/drafts.js +40 -0
- package/dist/generated/services/drafts.js.map +1 -0
- package/dist/generated/services/drafts.ts +67 -0
- 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 +83 -16
- package/dist/generated/services/everything.d.ts.map +1 -1
- package/dist/generated/services/everything.js +23 -13
- package/dist/generated/services/everything.js.map +1 -1
- package/dist/generated/services/everything.ts +100 -25
- 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 +12 -5
- package/dist/generated/services/index.d.ts.map +1 -1
- package/dist/generated/services/index.js +12 -5
- package/dist/generated/services/index.js.map +1 -1
- package/dist/generated/services/index.ts +12 -5
- 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-assignments.d.ts +52 -0
- package/dist/generated/services/my-assignments.d.ts.map +1 -1
- package/dist/generated/services/my-assignments.js +71 -0
- package/dist/generated/services/my-assignments.js.map +1 -1
- package/dist/generated/services/my-assignments.ts +104 -0
- package/dist/generated/services/my-notes.d.ts +45 -0
- package/dist/generated/services/my-notes.d.ts.map +1 -0
- package/dist/generated/services/my-notes.js +62 -0
- package/dist/generated/services/my-notes.js.map +1 -0
- package/dist/generated/services/my-notes.ts +92 -0
- 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 +35 -12
- package/dist/generated/services/todos.d.ts.map +1 -1
- package/dist/generated/services/todos.js +47 -25
- package/dist/generated/services/todos.js.map +1 -1
- package/dist/generated/services/todos.ts +74 -30
- package/dist/generated/services/uploads.d.ts +5 -0
- package/dist/generated/services/uploads.d.ts.map +1 -1
- package/dist/generated/services/uploads.js +4 -0
- package/dist/generated/services/uploads.js.map +1 -1
- package/dist/generated/services/uploads.ts +6 -0
- 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/hooks/otel.d.ts +1 -1
- package/dist/hooks/otel.js +1 -1
- package/dist/index.d.ts +21 -11
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +24 -9
- package/dist/index.js.map +1 -1
- package/dist/oauth/discovery.d.ts.map +1 -1
- package/dist/oauth/discovery.js +1 -0
- package/dist/oauth/discovery.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 +12 -1
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +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/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 +5 -4
- package/src/generated/metadata.ts +443 -133
- package/src/generated/openapi-stripped.json +8999 -4907
- package/src/generated/path-mapping.ts +40 -16
- package/src/generated/schema.d.ts +5508 -2346
- package/src/generated/services/bookmarks.ts +158 -0
- package/src/generated/services/boosts.ts +12 -0
- package/src/generated/services/calendars.ts +102 -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 +67 -0
- package/src/generated/services/events.ts +6 -0
- package/src/generated/services/everything.ts +100 -25
- 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 +12 -5
- package/src/generated/services/messages.ts +3 -1
- package/src/generated/services/my-assignments.ts +104 -0
- package/src/generated/services/my-notes.ts +92 -0
- 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 +74 -30
- package/src/generated/services/uploads.ts +6 -0
- package/src/generated/services/vaults.ts +6 -0
|
@@ -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
|
|
@@ -9,6 +9,25 @@ import { ListResult } from "../../pagination.js";
|
|
|
9
9
|
import type { PaginationOptions } from "../../pagination.js";
|
|
10
10
|
/** Todo entity from the Basecamp API. */
|
|
11
11
|
export type Todo = components["schemas"]["Todo"];
|
|
12
|
+
/**
|
|
13
|
+
* Request parameters for createTodosetTodo.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateTodosetTodoTodoRequest {
|
|
16
|
+
/** Text content */
|
|
17
|
+
content: string;
|
|
18
|
+
/** Rich text description (HTML) */
|
|
19
|
+
description?: string;
|
|
20
|
+
/** Person IDs to assign to */
|
|
21
|
+
assigneeIds?: number[];
|
|
22
|
+
/** Person IDs to notify on completion */
|
|
23
|
+
completionSubscriberIds?: number[];
|
|
24
|
+
/** Whether to send notifications to relevant people */
|
|
25
|
+
notify?: boolean;
|
|
26
|
+
/** Due date (YYYY-MM-DD) */
|
|
27
|
+
dueOn?: string;
|
|
28
|
+
/** Start date (YYYY-MM-DD) */
|
|
29
|
+
startsOn?: string;
|
|
30
|
+
}
|
|
12
31
|
/**
|
|
13
32
|
* Options for list.
|
|
14
33
|
*/
|
|
@@ -17,6 +36,8 @@ export interface ListTodoOptions extends PaginationOptions {
|
|
|
17
36
|
status?: "active" | "archived" | "trashed";
|
|
18
37
|
/** Completed */
|
|
19
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;
|
|
20
41
|
}
|
|
21
42
|
/**
|
|
22
43
|
* Request parameters for create.
|
|
@@ -69,6 +90,20 @@ export interface RepositionTodoRequest {
|
|
|
69
90
|
* Service for Todos operations.
|
|
70
91
|
*/
|
|
71
92
|
export declare class TodosService extends BaseService {
|
|
93
|
+
/**
|
|
94
|
+
* Create a to-do directly under a project's to-do set, outside any to-do list.
|
|
95
|
+
* @param bucketId - The bucket ID
|
|
96
|
+
* @param todosetId - The todoset ID
|
|
97
|
+
* @param req - Todo creation parameters
|
|
98
|
+
* @returns The Todo
|
|
99
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* const result = await client.todos.createTodosetTodo(123, 123, { content: "Hello world" });
|
|
104
|
+
* ```
|
|
105
|
+
*/
|
|
106
|
+
createTodosetTodo(bucketId: number, todosetId: number, req: CreateTodosetTodoTodoRequest): Promise<Todo>;
|
|
72
107
|
/**
|
|
73
108
|
* List todos in a todolist
|
|
74
109
|
* @param todolistId - The todolist ID
|
|
@@ -122,18 +157,6 @@ export declare class TodosService extends BaseService {
|
|
|
122
157
|
* ```
|
|
123
158
|
*/
|
|
124
159
|
replace(todoId: number, req: ReplaceTodoRequest): Promise<Todo>;
|
|
125
|
-
/**
|
|
126
|
-
* Trash a todo. Trashed items can be recovered.
|
|
127
|
-
* @param todoId - The todo ID
|
|
128
|
-
* @returns void
|
|
129
|
-
* @throws {BasecampError} If the request fails
|
|
130
|
-
*
|
|
131
|
-
* @example
|
|
132
|
-
* ```ts
|
|
133
|
-
* await client.todos.trash(123);
|
|
134
|
-
* ```
|
|
135
|
-
*/
|
|
136
|
-
trash(todoId: number): Promise<void>;
|
|
137
160
|
/**
|
|
138
161
|
* Mark a todo as complete
|
|
139
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,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"}
|
|
@@ -12,6 +12,52 @@ import { Errors } from "../../errors.js";
|
|
|
12
12
|
* Service for Todos operations.
|
|
13
13
|
*/
|
|
14
14
|
export class TodosService extends BaseService {
|
|
15
|
+
/**
|
|
16
|
+
* Create a to-do directly under a project's to-do set, outside any to-do list.
|
|
17
|
+
* @param bucketId - The bucket ID
|
|
18
|
+
* @param todosetId - The todoset ID
|
|
19
|
+
* @param req - Todo creation parameters
|
|
20
|
+
* @returns The Todo
|
|
21
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const result = await client.todos.createTodosetTodo(123, 123, { content: "Hello world" });
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
async createTodosetTodo(bucketId, todosetId, req) {
|
|
29
|
+
if (!req.content) {
|
|
30
|
+
throw Errors.validation("Content is required");
|
|
31
|
+
}
|
|
32
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
33
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
34
|
+
}
|
|
35
|
+
if (req.startsOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.startsOn)) {
|
|
36
|
+
throw Errors.validation("Starts on must be in YYYY-MM-DD format");
|
|
37
|
+
}
|
|
38
|
+
const response = await this.request({
|
|
39
|
+
service: "Todos",
|
|
40
|
+
operation: "CreateTodosetTodo",
|
|
41
|
+
resourceType: "todo",
|
|
42
|
+
isMutation: true,
|
|
43
|
+
projectId: bucketId,
|
|
44
|
+
resourceId: todosetId,
|
|
45
|
+
}, () => this.client.POST("/buckets/{bucketId}/todosets/{todosetId}/todos.json", {
|
|
46
|
+
params: {
|
|
47
|
+
path: { bucketId, todosetId },
|
|
48
|
+
},
|
|
49
|
+
body: {
|
|
50
|
+
content: req.content,
|
|
51
|
+
description: req.description,
|
|
52
|
+
assignee_ids: req.assigneeIds,
|
|
53
|
+
completion_subscriber_ids: req.completionSubscriberIds,
|
|
54
|
+
notify: req.notify,
|
|
55
|
+
due_on: req.dueOn,
|
|
56
|
+
starts_on: req.startsOn,
|
|
57
|
+
},
|
|
58
|
+
}));
|
|
59
|
+
return response;
|
|
60
|
+
}
|
|
15
61
|
/**
|
|
16
62
|
* List todos in a todolist
|
|
17
63
|
* @param todolistId - The todolist ID
|
|
@@ -36,7 +82,7 @@ export class TodosService extends BaseService {
|
|
|
36
82
|
}, () => this.client.GET("/todolists/{todolistId}/todos.json", {
|
|
37
83
|
params: {
|
|
38
84
|
path: { todolistId },
|
|
39
|
-
query: { status: options?.status, completed: options?.completed },
|
|
85
|
+
query: { status: options?.status, completed: options?.completed, page: options?.page },
|
|
40
86
|
},
|
|
41
87
|
}), options);
|
|
42
88
|
}
|
|
@@ -153,30 +199,6 @@ export class TodosService extends BaseService {
|
|
|
153
199
|
}));
|
|
154
200
|
return response;
|
|
155
201
|
}
|
|
156
|
-
/**
|
|
157
|
-
* Trash a todo. Trashed items can be recovered.
|
|
158
|
-
* @param todoId - The todo ID
|
|
159
|
-
* @returns void
|
|
160
|
-
* @throws {BasecampError} If the request fails
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* ```ts
|
|
164
|
-
* await client.todos.trash(123);
|
|
165
|
-
* ```
|
|
166
|
-
*/
|
|
167
|
-
async trash(todoId) {
|
|
168
|
-
await this.request({
|
|
169
|
-
service: "Todos",
|
|
170
|
-
operation: "TrashTodo",
|
|
171
|
-
resourceType: "todo",
|
|
172
|
-
isMutation: true,
|
|
173
|
-
resourceId: todoId,
|
|
174
|
-
}, () => this.client.DELETE("/todos/{todoId}", {
|
|
175
|
-
params: {
|
|
176
|
-
path: { todoId },
|
|
177
|
-
},
|
|
178
|
-
}));
|
|
179
|
-
}
|
|
180
202
|
/**
|
|
181
203
|
* Mark a todo as complete
|
|
182
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"}
|
|
@@ -17,6 +17,26 @@ import { Errors } from "../../errors.js";
|
|
|
17
17
|
/** Todo entity from the Basecamp API. */
|
|
18
18
|
export type Todo = components["schemas"]["Todo"];
|
|
19
19
|
|
|
20
|
+
/**
|
|
21
|
+
* Request parameters for createTodosetTodo.
|
|
22
|
+
*/
|
|
23
|
+
export interface CreateTodosetTodoTodoRequest {
|
|
24
|
+
/** Text content */
|
|
25
|
+
content: string;
|
|
26
|
+
/** Rich text description (HTML) */
|
|
27
|
+
description?: string;
|
|
28
|
+
/** Person IDs to assign to */
|
|
29
|
+
assigneeIds?: number[];
|
|
30
|
+
/** Person IDs to notify on completion */
|
|
31
|
+
completionSubscriberIds?: number[];
|
|
32
|
+
/** Whether to send notifications to relevant people */
|
|
33
|
+
notify?: boolean;
|
|
34
|
+
/** Due date (YYYY-MM-DD) */
|
|
35
|
+
dueOn?: string;
|
|
36
|
+
/** Start date (YYYY-MM-DD) */
|
|
37
|
+
startsOn?: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
20
40
|
/**
|
|
21
41
|
* Options for list.
|
|
22
42
|
*/
|
|
@@ -25,6 +45,8 @@ export interface ListTodoOptions extends PaginationOptions {
|
|
|
25
45
|
status?: "active" | "archived" | "trashed";
|
|
26
46
|
/** Completed */
|
|
27
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;
|
|
28
50
|
}
|
|
29
51
|
|
|
30
52
|
/**
|
|
@@ -87,6 +109,57 @@ export interface RepositionTodoRequest {
|
|
|
87
109
|
*/
|
|
88
110
|
export class TodosService extends BaseService {
|
|
89
111
|
|
|
112
|
+
/**
|
|
113
|
+
* Create a to-do directly under a project's to-do set, outside any to-do list.
|
|
114
|
+
* @param bucketId - The bucket ID
|
|
115
|
+
* @param todosetId - The todoset ID
|
|
116
|
+
* @param req - Todo creation parameters
|
|
117
|
+
* @returns The Todo
|
|
118
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```ts
|
|
122
|
+
* const result = await client.todos.createTodosetTodo(123, 123, { content: "Hello world" });
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
async createTodosetTodo(bucketId: number, todosetId: number, req: CreateTodosetTodoTodoRequest): Promise<Todo> {
|
|
126
|
+
if (!req.content) {
|
|
127
|
+
throw Errors.validation("Content is required");
|
|
128
|
+
}
|
|
129
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
130
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
131
|
+
}
|
|
132
|
+
if (req.startsOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.startsOn)) {
|
|
133
|
+
throw Errors.validation("Starts on must be in YYYY-MM-DD format");
|
|
134
|
+
}
|
|
135
|
+
const response = await this.request(
|
|
136
|
+
{
|
|
137
|
+
service: "Todos",
|
|
138
|
+
operation: "CreateTodosetTodo",
|
|
139
|
+
resourceType: "todo",
|
|
140
|
+
isMutation: true,
|
|
141
|
+
projectId: bucketId,
|
|
142
|
+
resourceId: todosetId,
|
|
143
|
+
},
|
|
144
|
+
() =>
|
|
145
|
+
this.client.POST("/buckets/{bucketId}/todosets/{todosetId}/todos.json", {
|
|
146
|
+
params: {
|
|
147
|
+
path: { bucketId, todosetId },
|
|
148
|
+
},
|
|
149
|
+
body: {
|
|
150
|
+
content: req.content,
|
|
151
|
+
description: req.description,
|
|
152
|
+
assignee_ids: req.assigneeIds,
|
|
153
|
+
completion_subscriber_ids: req.completionSubscriberIds,
|
|
154
|
+
notify: req.notify,
|
|
155
|
+
due_on: req.dueOn,
|
|
156
|
+
starts_on: req.startsOn,
|
|
157
|
+
},
|
|
158
|
+
})
|
|
159
|
+
);
|
|
160
|
+
return response;
|
|
161
|
+
}
|
|
162
|
+
|
|
90
163
|
/**
|
|
91
164
|
* List todos in a todolist
|
|
92
165
|
* @param todolistId - The todolist ID
|
|
@@ -114,7 +187,7 @@ export class TodosService extends BaseService {
|
|
|
114
187
|
this.client.GET("/todolists/{todolistId}/todos.json", {
|
|
115
188
|
params: {
|
|
116
189
|
path: { todolistId },
|
|
117
|
-
query: { status: options?.status, completed: options?.completed },
|
|
190
|
+
query: { status: options?.status, completed: options?.completed, page: options?.page },
|
|
118
191
|
},
|
|
119
192
|
})
|
|
120
193
|
, options
|
|
@@ -249,35 +322,6 @@ export class TodosService extends BaseService {
|
|
|
249
322
|
return response;
|
|
250
323
|
}
|
|
251
324
|
|
|
252
|
-
/**
|
|
253
|
-
* Trash a todo. Trashed items can be recovered.
|
|
254
|
-
* @param todoId - The todo ID
|
|
255
|
-
* @returns void
|
|
256
|
-
* @throws {BasecampError} If the request fails
|
|
257
|
-
*
|
|
258
|
-
* @example
|
|
259
|
-
* ```ts
|
|
260
|
-
* await client.todos.trash(123);
|
|
261
|
-
* ```
|
|
262
|
-
*/
|
|
263
|
-
async trash(todoId: number): Promise<void> {
|
|
264
|
-
await this.request(
|
|
265
|
-
{
|
|
266
|
-
service: "Todos",
|
|
267
|
-
operation: "TrashTodo",
|
|
268
|
-
resourceType: "todo",
|
|
269
|
-
isMutation: true,
|
|
270
|
-
resourceId: todoId,
|
|
271
|
-
},
|
|
272
|
-
() =>
|
|
273
|
-
this.client.DELETE("/todos/{todoId}", {
|
|
274
|
-
params: {
|
|
275
|
-
path: { todoId },
|
|
276
|
-
},
|
|
277
|
-
})
|
|
278
|
-
);
|
|
279
|
-
}
|
|
280
|
-
|
|
281
325
|
/**
|
|
282
326
|
* Mark a todo as complete
|
|
283
327
|
* @param todoId - The todo ID
|
|
@@ -27,6 +27,8 @@ export interface ListVersionsUploadOptions extends PaginationOptions {
|
|
|
27
27
|
* Options for list.
|
|
28
28
|
*/
|
|
29
29
|
export interface ListUploadOptions extends PaginationOptions {
|
|
30
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
31
|
+
page?: number;
|
|
30
32
|
}
|
|
31
33
|
/**
|
|
32
34
|
* Request parameters for create.
|
|
@@ -93,6 +95,9 @@ export declare class UploadsService extends BaseService {
|
|
|
93
95
|
* @example
|
|
94
96
|
* ```ts
|
|
95
97
|
* const result = await client.uploads.list(123);
|
|
98
|
+
*
|
|
99
|
+
* // With options
|
|
100
|
+
* const filtered = await client.uploads.list(123, { page: 1 });
|
|
96
101
|
* ```
|
|
97
102
|
*/
|
|
98
103
|
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;AAErD;;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,iBAAkB,SAAQ,iBAAiB;
|
|
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;AAErD;;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,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,MAAM,CAAC,CAAC;IAmBtG;;;;;;;;;;;;;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"}
|
|
@@ -100,6 +100,9 @@ export class UploadsService extends BaseService {
|
|
|
100
100
|
* @example
|
|
101
101
|
* ```ts
|
|
102
102
|
* const result = await client.uploads.list(123);
|
|
103
|
+
*
|
|
104
|
+
* // With options
|
|
105
|
+
* const filtered = await client.uploads.list(123, { page: 1 });
|
|
103
106
|
* ```
|
|
104
107
|
*/
|
|
105
108
|
async list(vaultId, options) {
|
|
@@ -112,6 +115,7 @@ export class UploadsService extends BaseService {
|
|
|
112
115
|
}, () => this.client.GET("/vaults/{vaultId}/uploads.json", {
|
|
113
116
|
params: {
|
|
114
117
|
path: { vaultId },
|
|
118
|
+
query: { page: options?.page },
|
|
115
119
|
},
|
|
116
120
|
}), options);
|
|
117
121
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uploads.js","sourceRoot":"","sources":["../../../src/generated/services/uploads.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":"uploads.js","sourceRoot":"","sources":["../../../src/generated/services/uploads.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,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,QAAgB;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qBAAqB,EAAE;YACrC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,GAAwB;QACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qBAAqB,EAAE;YACrC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,OAAmC;QACtE,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mCAAmC,EAAE;YACnD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,OAA2B;QACrD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gCAAgC,EAAE;YAChD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;gBACjB,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,OAAe,EAAE,GAAwB;QACpD,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,MAAM,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE;YACjD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,eAAe,EAAE,GAAG,CAAC,cAAc;gBACnC,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,CAAC,QAAQ;gBACvB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,kBAAkB,EAAE,GAAG,CAAC,gBAAgB;aACzC;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -37,6 +37,8 @@ export interface ListVersionsUploadOptions extends PaginationOptions {
|
|
|
37
37
|
* Options for list.
|
|
38
38
|
*/
|
|
39
39
|
export interface ListUploadOptions extends PaginationOptions {
|
|
40
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
41
|
+
page?: number;
|
|
40
42
|
}
|
|
41
43
|
|
|
42
44
|
/**
|
|
@@ -169,6 +171,9 @@ export class UploadsService extends BaseService {
|
|
|
169
171
|
* @example
|
|
170
172
|
* ```ts
|
|
171
173
|
* const result = await client.uploads.list(123);
|
|
174
|
+
*
|
|
175
|
+
* // With options
|
|
176
|
+
* const filtered = await client.uploads.list(123, { page: 1 });
|
|
172
177
|
* ```
|
|
173
178
|
*/
|
|
174
179
|
async list(vaultId: number, options?: ListUploadOptions): Promise<ListResult<Upload>> {
|
|
@@ -184,6 +189,7 @@ export class UploadsService extends BaseService {
|
|
|
184
189
|
this.client.GET("/vaults/{vaultId}/uploads.json", {
|
|
185
190
|
params: {
|
|
186
191
|
path: { vaultId },
|
|
192
|
+
query: { page: options?.page },
|
|
187
193
|
},
|
|
188
194
|
})
|
|
189
195
|
, options
|
|
@@ -20,6 +20,8 @@ export interface UpdateVaultRequest {
|
|
|
20
20
|
* Options for list.
|
|
21
21
|
*/
|
|
22
22
|
export interface ListVaultOptions extends PaginationOptions {
|
|
23
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
24
|
+
page?: number;
|
|
23
25
|
}
|
|
24
26
|
/**
|
|
25
27
|
* Request parameters for create.
|
|
@@ -66,6 +68,9 @@ export declare class VaultsService extends BaseService {
|
|
|
66
68
|
* @example
|
|
67
69
|
* ```ts
|
|
68
70
|
* const result = await client.vaults.list(123);
|
|
71
|
+
*
|
|
72
|
+
* // With options
|
|
73
|
+
* const filtered = await client.vaults.list(123, { page: 1 });
|
|
69
74
|
* ```
|
|
70
75
|
*/
|
|
71
76
|
list(vaultId: number, options?: ListVaultOptions): Promise<ListResult<Vault>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../../src/generated/services/vaults.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,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;
|
|
1
|
+
{"version":3,"file":"vaults.d.ts","sourceRoot":"","sources":["../../../src/generated/services/vaults.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,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAmB1C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IAsBtE;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAoBnF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;CAwBvE"}
|
|
@@ -75,6 +75,9 @@ export class VaultsService extends BaseService {
|
|
|
75
75
|
* @example
|
|
76
76
|
* ```ts
|
|
77
77
|
* const result = await client.vaults.list(123);
|
|
78
|
+
*
|
|
79
|
+
* // With options
|
|
80
|
+
* const filtered = await client.vaults.list(123, { page: 1 });
|
|
78
81
|
* ```
|
|
79
82
|
*/
|
|
80
83
|
async list(vaultId, options) {
|
|
@@ -87,6 +90,7 @@ export class VaultsService extends BaseService {
|
|
|
87
90
|
}, () => this.client.GET("/vaults/{vaultId}/vaults.json", {
|
|
88
91
|
params: {
|
|
89
92
|
path: { vaultId },
|
|
93
|
+
query: { page: options?.page },
|
|
90
94
|
},
|
|
91
95
|
}), options);
|
|
92
96
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vaults.js","sourceRoot":"","sources":["../../../src/generated/services/vaults.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":"vaults.js","sourceRoot":"","sources":["../../../src/generated/services/vaults.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,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,UAAU;YACrB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAuB;QACnD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,OAA0B;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE;YAC/C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;gBACjB,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,OAAe,EAAE,GAAuB;QACnD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE;YAChD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -29,6 +29,8 @@ export interface UpdateVaultRequest {
|
|
|
29
29
|
* Options for list.
|
|
30
30
|
*/
|
|
31
31
|
export interface ListVaultOptions 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
|
/**
|
|
@@ -122,6 +124,9 @@ export class VaultsService extends BaseService {
|
|
|
122
124
|
* @example
|
|
123
125
|
* ```ts
|
|
124
126
|
* const result = await client.vaults.list(123);
|
|
127
|
+
*
|
|
128
|
+
* // With options
|
|
129
|
+
* const filtered = await client.vaults.list(123, { page: 1 });
|
|
125
130
|
* ```
|
|
126
131
|
*/
|
|
127
132
|
async list(vaultId: number, options?: ListVaultOptions): Promise<ListResult<Vault>> {
|
|
@@ -137,6 +142,7 @@ export class VaultsService extends BaseService {
|
|
|
137
142
|
this.client.GET("/vaults/{vaultId}/vaults.json", {
|
|
138
143
|
params: {
|
|
139
144
|
path: { vaultId },
|
|
145
|
+
query: { page: options?.page },
|
|
140
146
|
},
|
|
141
147
|
})
|
|
142
148
|
, options
|
package/dist/hooks/otel.d.ts
CHANGED
|
@@ -128,7 +128,7 @@ export interface OtelHooksOptions {
|
|
|
128
128
|
* });
|
|
129
129
|
*
|
|
130
130
|
* // Operations will create spans and record metrics
|
|
131
|
-
* const todos = await client.todos.list(
|
|
131
|
+
* const todos = await client.todos.list(todolistId);
|
|
132
132
|
* ```
|
|
133
133
|
*/
|
|
134
134
|
export declare function otelHooks(options?: OtelHooksOptions): BasecampHooks;
|
package/dist/hooks/otel.js
CHANGED
|
@@ -88,7 +88,7 @@ function requestKey() {
|
|
|
88
88
|
* });
|
|
89
89
|
*
|
|
90
90
|
* // Operations will create spans and record metrics
|
|
91
|
-
* const todos = await client.todos.list(
|
|
91
|
+
* const todos = await client.todos.list(todolistId);
|
|
92
92
|
* ```
|
|
93
93
|
*/
|
|
94
94
|
export function otelHooks(options = {}) {
|