@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
|
@@ -20,15 +20,17 @@ export type ScheduleEntry = components["schemas"]["ScheduleEntry"];
|
|
|
20
20
|
export type Schedule = components["schemas"]["Schedule"];
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* Request parameters for
|
|
23
|
+
* Request parameters for replaceEntry.
|
|
24
24
|
*/
|
|
25
|
-
export interface
|
|
25
|
+
export interface ReplaceEntryScheduleRequest {
|
|
26
26
|
/** Summary text */
|
|
27
27
|
summary?: string;
|
|
28
|
-
/**
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
28
|
+
/** The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
|
|
29
|
+
full timestamp otherwise. Same rule as CreateScheduleEntry: send it
|
|
30
|
+
verbatim, never parsed and re-rendered. */
|
|
31
|
+
startsAt: string;
|
|
32
|
+
/** The entry's end. See starts_at for the date-vs-timestamp rule. */
|
|
33
|
+
endsAt: string;
|
|
32
34
|
/** Rich text description (HTML) */
|
|
33
35
|
description?: string;
|
|
34
36
|
/** Replaces the entry's participants.
|
|
@@ -41,10 +43,36 @@ including the shape in BC3's own "Update a schedule entry" doc example —
|
|
|
41
43
|
silently removed every participant and notified each one. The controller
|
|
42
44
|
now guards on the request actually addressing participants. */
|
|
43
45
|
participantIds?: number[];
|
|
44
|
-
/**
|
|
46
|
+
/** Whether the entry occupies whole days rather than a time range.
|
|
47
|
+
|
|
48
|
+
Not carved out, and the carve-out list is what makes that dangerous to
|
|
49
|
+
forget: `schedule_entries.all_day` is NOT NULL with a `false` default, so
|
|
50
|
+
omitting this member on a replace resets it — silently converting an
|
|
51
|
+
all-day entry into a midnight-to-midnight timed one. The SDK's merge-safe
|
|
52
|
+
update and edit resend it from the read-back for exactly this reason.
|
|
53
|
+
|
|
54
|
+
Sending an explicit null is worse than omitting it: the column rejects
|
|
55
|
+
NULL, so BC3 raises rather than falling back to the default. The same is
|
|
56
|
+
true of highlighted. */
|
|
45
57
|
allDay?: boolean;
|
|
46
58
|
/** Whether to send notifications to relevant people */
|
|
47
59
|
notify?: boolean;
|
|
60
|
+
/** The entry's join link — a video-call URL or similar, up to 2500
|
|
61
|
+
characters, validated as a URL when present.
|
|
62
|
+
|
|
63
|
+
Omitting this member preserves the current join link; sending an empty
|
|
64
|
+
string clears it. Read it back as `join_url`, never as `url`: the entry's
|
|
65
|
+
`url` is its own Basecamp API URL, written by a partial that renders
|
|
66
|
+
before this one, so BC3 emits the join link under a non-colliding key.
|
|
67
|
+
Echoing the response's `url` into this member would write the API URL into
|
|
68
|
+
the join link. */
|
|
69
|
+
url?: string;
|
|
70
|
+
/** Whether the entry is highlighted on the schedule.
|
|
71
|
+
|
|
72
|
+
Omitting this member preserves the current highlight; sending false
|
|
73
|
+
removes it. Preserved on omission because until basecamp/bc3#12502 the
|
|
74
|
+
field was writable but never returned, so no caller could resend it. */
|
|
75
|
+
highlighted?: boolean;
|
|
48
76
|
}
|
|
49
77
|
|
|
50
78
|
/**
|
|
@@ -61,6 +89,8 @@ export interface UpdateSettingsScheduleRequest {
|
|
|
61
89
|
export interface ListEntriesScheduleOptions extends PaginationOptions {
|
|
62
90
|
/** Filter by status */
|
|
63
91
|
status?: "active" | "archived" | "trashed";
|
|
92
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
93
|
+
page?: number;
|
|
64
94
|
}
|
|
65
95
|
|
|
66
96
|
/**
|
|
@@ -69,9 +99,21 @@ export interface ListEntriesScheduleOptions extends PaginationOptions {
|
|
|
69
99
|
export interface CreateEntryScheduleRequest {
|
|
70
100
|
/** Summary text */
|
|
71
101
|
summary: string;
|
|
72
|
-
/**
|
|
102
|
+
/** The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
|
|
103
|
+
full timestamp ("2026-06-01T09:00:00Z") otherwise — the same two forms the
|
|
104
|
+
response renders, and the same two ReplaceScheduleEntry accepts.
|
|
105
|
+
|
|
106
|
+
Create and replace share one permit list:
|
|
107
|
+
`Schedules::Entries::BaseController#base_schedule_entry_params` is what
|
|
108
|
+
both `new_schedule_entry_params` and `update_schedule_entry_params` call,
|
|
109
|
+
and Schedule::Entry does no format-specific parsing of either bound, so
|
|
110
|
+
whatever one operation takes the other takes too.
|
|
111
|
+
|
|
112
|
+
Treat the value as opaque and send it verbatim. Parsing it into a
|
|
113
|
+
date-time type and re-rendering rewrites an all-day entry's bounds into
|
|
114
|
+
midnight timestamps, which is why every SDK models it as a string. */
|
|
73
115
|
startsAt: string;
|
|
74
|
-
/**
|
|
116
|
+
/** The entry's end. See starts_at for the date-vs-timestamp rule. */
|
|
75
117
|
endsAt: string;
|
|
76
118
|
/** Rich text description (HTML) */
|
|
77
119
|
description?: string;
|
|
@@ -81,6 +123,43 @@ export interface CreateEntryScheduleRequest {
|
|
|
81
123
|
allDay?: boolean;
|
|
82
124
|
/** Whether to send notifications to relevant people */
|
|
83
125
|
notify?: boolean;
|
|
126
|
+
/** The entry's join link — a video-call URL or similar, up to 2500
|
|
127
|
+
characters, validated as a URL when present. A scheme-less value is
|
|
128
|
+
normalized to `https://`.
|
|
129
|
+
|
|
130
|
+
Spell it `url` on the way in and read it back as `join_url`: the response
|
|
131
|
+
key `url` is the entry's own Basecamp API URL, written by a partial that
|
|
132
|
+
renders before this field, so BC3 emits the join link under a
|
|
133
|
+
non-colliding name. Sending `join_url` instead is silently dropped by
|
|
134
|
+
strong parameters — the create succeeds with no join link.
|
|
135
|
+
|
|
136
|
+
Accepted on create since long before it was documented:
|
|
137
|
+
`Schedules::Entries::BaseController#base_schedule_entry_params` permits it
|
|
138
|
+
and `new_schedule_entry_params` passes it through unchanged for API
|
|
139
|
+
requests. Modeling it only on ReplaceScheduleEntry forced callers into a
|
|
140
|
+
three-request read-modify-write for a field the create already took — and
|
|
141
|
+
create is the notifying write, so participants learned about a video call
|
|
142
|
+
before its link existed. */
|
|
143
|
+
url?: string;
|
|
144
|
+
/** Whether the entry is highlighted on the schedule. Defaults to false.
|
|
145
|
+
|
|
146
|
+
Do not send an explicit null: `schedule_entries.highlighted` is NOT NULL,
|
|
147
|
+
so BC3 raises rather than falling back to the default. Omit it instead —
|
|
148
|
+
every SDK's request compactor already drops unset members. */
|
|
149
|
+
highlighted?: boolean;
|
|
150
|
+
/** Publication state at creation — `active|drafted`, defaulting to `active`
|
|
151
|
+
for an API create.
|
|
152
|
+
|
|
153
|
+
A top-level parameter, not part of the entry's attributes: `status` is a
|
|
154
|
+
Recording column, so `wrap_parameters` leaves it outside the
|
|
155
|
+
`schedule_entry` envelope and `Recording::StatusParam#status_param` reads
|
|
156
|
+
it directly. On create it accepts `drafted`, `active`, `archived` or
|
|
157
|
+
`trashed` and raises `ActionController::BadRequest` — a 400, not a 422 —
|
|
158
|
+
for anything else; the two documented values are the two worth sending.
|
|
159
|
+
|
|
160
|
+
Unlike messages and documents, schedule-entry drafts are not listed by
|
|
161
|
+
GetMyDrafts. */
|
|
162
|
+
status?: string;
|
|
84
163
|
/** Subscriptions */
|
|
85
164
|
subscriptions?: number[];
|
|
86
165
|
/** Visible to clients */
|
|
@@ -128,22 +207,28 @@ export class SchedulesService extends BaseService {
|
|
|
128
207
|
}
|
|
129
208
|
|
|
130
209
|
/**
|
|
131
|
-
*
|
|
210
|
+
* Replace a schedule entry with a new complete representation.
|
|
132
211
|
* @param entryId - The entry ID
|
|
133
|
-
* @param req - Schedule_entry
|
|
212
|
+
* @param req - Schedule_entry request parameters
|
|
134
213
|
* @returns The ScheduleEntry
|
|
135
|
-
* @throws {BasecampError} If the
|
|
214
|
+
* @throws {BasecampError} If the request fails
|
|
136
215
|
*
|
|
137
216
|
* @example
|
|
138
217
|
* ```ts
|
|
139
|
-
* const result = await client.schedules.
|
|
218
|
+
* const result = await client.schedules.replaceEntry(123, { startsAt: "example", endsAt: "example" });
|
|
140
219
|
* ```
|
|
141
220
|
*/
|
|
142
|
-
async
|
|
221
|
+
async replaceEntry(entryId: number, req: ReplaceEntryScheduleRequest): Promise<ScheduleEntry> {
|
|
222
|
+
if (!req.startsAt) {
|
|
223
|
+
throw Errors.validation("Starts at is required");
|
|
224
|
+
}
|
|
225
|
+
if (!req.endsAt) {
|
|
226
|
+
throw Errors.validation("Ends at is required");
|
|
227
|
+
}
|
|
143
228
|
const response = await this.request(
|
|
144
229
|
{
|
|
145
230
|
service: "Schedules",
|
|
146
|
-
operation: "
|
|
231
|
+
operation: "ReplaceScheduleEntry",
|
|
147
232
|
resourceType: "schedule_entry",
|
|
148
233
|
isMutation: true,
|
|
149
234
|
resourceId: entryId,
|
|
@@ -161,6 +246,8 @@ export class SchedulesService extends BaseService {
|
|
|
161
246
|
participant_ids: req.participantIds,
|
|
162
247
|
all_day: req.allDay,
|
|
163
248
|
notify: req.notify,
|
|
249
|
+
url: req.url,
|
|
250
|
+
highlighted: req.highlighted,
|
|
164
251
|
},
|
|
165
252
|
})
|
|
166
253
|
);
|
|
@@ -289,7 +376,7 @@ export class SchedulesService extends BaseService {
|
|
|
289
376
|
this.client.GET("/schedules/{scheduleId}/entries.json", {
|
|
290
377
|
params: {
|
|
291
378
|
path: { scheduleId },
|
|
292
|
-
query: { status: options?.status },
|
|
379
|
+
query: { status: options?.status, page: options?.page },
|
|
293
380
|
},
|
|
294
381
|
})
|
|
295
382
|
, options
|
|
@@ -305,7 +392,7 @@ export class SchedulesService extends BaseService {
|
|
|
305
392
|
*
|
|
306
393
|
* @example
|
|
307
394
|
* ```ts
|
|
308
|
-
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "
|
|
395
|
+
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "example", endsAt: "example" });
|
|
309
396
|
* ```
|
|
310
397
|
*/
|
|
311
398
|
async createEntry(scheduleId: number, req: CreateEntryScheduleRequest): Promise<ScheduleEntry> {
|
|
@@ -339,6 +426,9 @@ export class SchedulesService extends BaseService {
|
|
|
339
426
|
participant_ids: req.participantIds,
|
|
340
427
|
all_day: req.allDay,
|
|
341
428
|
notify: req.notify,
|
|
429
|
+
url: req.url,
|
|
430
|
+
highlighted: req.highlighted,
|
|
431
|
+
status: req.status,
|
|
342
432
|
subscriptions: req.subscriptions,
|
|
343
433
|
visible_to_clients: req.visibleToClients,
|
|
344
434
|
},
|
|
@@ -41,6 +41,8 @@ export interface SearchSearchOptions extends PaginationOptions {
|
|
|
41
41
|
* @deprecated prefer creator_ids[].
|
|
42
42
|
*/
|
|
43
43
|
creatorId?: number;
|
|
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
|
* Service for Search operations.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/generated/services/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D;qEACiE;IACjE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;oCACgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sBAAsB;IACtB,KAAK,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,cAAc,GAAG,gBAAgB,GAAG,SAAS,CAAC;IACvF,qBAAqB;IACrB,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/generated/services/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D;qEACiE;IACjE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;oCACgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,sBAAsB;IACtB,KAAK,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,cAAc,GAAG,gBAAgB,GAAG,SAAS,CAAC;IACvF,qBAAqB;IACrB,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAkB/G;;;;;;;;OAQG;IACG,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,kCAAkC,CAAC,CAAC;CAcrF"}
|
|
@@ -30,7 +30,7 @@ export class SearchService extends BaseService {
|
|
|
30
30
|
isMutation: false,
|
|
31
31
|
}, () => this.client.GET("/search.json", {
|
|
32
32
|
params: {
|
|
33
|
-
query: { q: q, "type_names[]": options?.typeNames, "bucket_ids[]": options?.bucketIds, "creator_ids[]": options?.creatorIds, "file_type": options?.fileType, "exclude_chat": options?.excludeChat, since: options?.since, sort: options?.sort, type: options?.type, "bucket_id": options?.bucketId, "creator_id": options?.creatorId },
|
|
33
|
+
query: { q: q, "type_names[]": options?.typeNames, "bucket_ids[]": options?.bucketIds, "creator_ids[]": options?.creatorIds, "file_type": options?.fileType, "exclude_chat": options?.excludeChat, since: options?.since, sort: options?.sort, type: options?.type, "bucket_id": options?.bucketId, "creator_id": options?.creatorId, page: options?.page },
|
|
34
34
|
},
|
|
35
35
|
}), options);
|
|
36
36
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/generated/services/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/generated/services/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAkDrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,CAAS,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC5V;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAC1C,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -49,6 +49,8 @@ endpoint's `file_search_types`. */
|
|
|
49
49
|
* @deprecated prefer creator_ids[].
|
|
50
50
|
*/
|
|
51
51
|
creatorId?: number;
|
|
52
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
53
|
+
page?: number;
|
|
52
54
|
}
|
|
53
55
|
|
|
54
56
|
|
|
@@ -83,7 +85,7 @@ export class SearchService extends BaseService {
|
|
|
83
85
|
() =>
|
|
84
86
|
this.client.GET("/search.json", {
|
|
85
87
|
params: {
|
|
86
|
-
query: { q: q, "type_names[]": options?.typeNames, "bucket_ids[]": options?.bucketIds, "creator_ids[]": options?.creatorIds, "file_type": options?.fileType, "exclude_chat": options?.excludeChat, since: options?.since, sort: options?.sort, type: options?.type, "bucket_id": options?.bucketId, "creator_id": options?.creatorId },
|
|
88
|
+
query: { q: q, "type_names[]": options?.typeNames, "bucket_ids[]": options?.bucketIds, "creator_ids[]": options?.creatorIds, "file_type": options?.fileType, "exclude_chat": options?.excludeChat, since: options?.since, sort: options?.sort, type: options?.type, "bucket_id": options?.bucketId, "creator_id": options?.creatorId, page: options?.page },
|
|
87
89
|
},
|
|
88
90
|
})
|
|
89
91
|
, options
|
|
@@ -15,6 +15,8 @@ export type Template = components["schemas"]["Template"];
|
|
|
15
15
|
export interface ListTemplateOptions extends PaginationOptions {
|
|
16
16
|
/** Filter by status */
|
|
17
17
|
status?: "active" | "archived" | "trashed";
|
|
18
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
19
|
+
page?: number;
|
|
18
20
|
}
|
|
19
21
|
/**
|
|
20
22
|
* Request parameters for create.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/generated/services/templates.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,mBAAoB,SAAQ,iBAAiB;IAC5D,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/generated/services/templates.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,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;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,cAAc;IACd,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,+BAA+B,CAAC,CAAC;CACjE;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAkBxE;;;;;;;;;;OAUG;IACG,MAAM,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsB3D;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAuB/E;;;;;;;;;;OAUG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/C;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,0CAA0C,CAAC,CAAC;IAyBtJ;;;;;;;;;;;OAWG;IACG,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,uCAAuC,CAAC,CAAC;CAkB3I"}
|
|
@@ -33,7 +33,7 @@ export class TemplatesService extends BaseService {
|
|
|
33
33
|
isMutation: false,
|
|
34
34
|
}, () => this.client.GET("/templates.json", {
|
|
35
35
|
params: {
|
|
36
|
-
query: { status: options?.status },
|
|
36
|
+
query: { status: options?.status, page: options?.page },
|
|
37
37
|
},
|
|
38
38
|
}), options);
|
|
39
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/generated/services/templates.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":"templates.js","sourceRoot":"","sources":["../../../src/generated/services/templates.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAgDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,IAAI,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,eAAe;YAC1B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,EAAE;gBACN,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;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,GAA0B;QACrC,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;SACjB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAClC,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;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,UAAkB;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACzC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,GAA0B;QACzD,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,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACzC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;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;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,UAAkB;QAC7B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAyB,EAAE;YAC5C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB,EAAE,GAAiC;QACvE,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,2BAA2B;YACtC,YAAY,EAAE,uBAAuB;YACrC,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE;YACrE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,CAAC,UAAkB,EAAE,cAAsB;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,wBAAwB;YACnC,YAAY,EAAE,sBAAsB;YACpC,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,cAAc;SAC3B,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gEAAgE,EAAE;YAChF,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE,cAAc,EAAE;aACrC;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -23,6 +23,8 @@ export type Template = components["schemas"]["Template"];
|
|
|
23
23
|
export interface ListTemplateOptions extends PaginationOptions {
|
|
24
24
|
/** Filter by status */
|
|
25
25
|
status?: "active" | "archived" | "trashed";
|
|
26
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
27
|
+
page?: number;
|
|
26
28
|
}
|
|
27
29
|
|
|
28
30
|
/**
|
|
@@ -87,7 +89,7 @@ export class TemplatesService extends BaseService {
|
|
|
87
89
|
() =>
|
|
88
90
|
this.client.GET("/templates.json", {
|
|
89
91
|
params: {
|
|
90
|
-
query: { status: options?.status },
|
|
92
|
+
query: { status: options?.status, page: options?.page },
|
|
91
93
|
},
|
|
92
94
|
})
|
|
93
95
|
, options
|
|
@@ -13,6 +13,8 @@ export type TimelineEvent = components["schemas"]["TimelineEvent"];
|
|
|
13
13
|
* Options for projectTimeline.
|
|
14
14
|
*/
|
|
15
15
|
export interface ProjectTimelineTimelineOptions extends PaginationOptions {
|
|
16
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
17
|
+
page?: number;
|
|
16
18
|
}
|
|
17
19
|
/**
|
|
18
20
|
* Service for Timeline operations.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeline.d.ts","sourceRoot":"","sources":["../../../src/generated/services/timeline.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;AAM7D,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;
|
|
1
|
+
{"version":3,"file":"timeline.d.ts","sourceRoot":"","sources":["../../../src/generated/services/timeline.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;AAM7D,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;IACvE,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;CAmBvH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeline.js","sourceRoot":"","sources":["../../../src/generated/services/timeline.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"timeline.js","sourceRoot":"","sources":["../../../src/generated/services/timeline.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAqBrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAE9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,OAAwC;QAC/E,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,kBAAkB;YAChC,UAAU,EAAE,KAAK;YACjB,SAAS;SACV,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACrD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,SAAS,EAAE;gBACnB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -20,6 +20,8 @@ export type TimelineEvent = components["schemas"]["TimelineEvent"];
|
|
|
20
20
|
* Options for projectTimeline.
|
|
21
21
|
*/
|
|
22
22
|
export interface ProjectTimelineTimelineOptions 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
|
|
|
@@ -56,6 +58,7 @@ export class TimelineService extends BaseService {
|
|
|
56
58
|
this.client.GET("/projects/{projectId}/timeline.json", {
|
|
57
59
|
params: {
|
|
58
60
|
path: { projectId },
|
|
61
|
+
query: { page: options?.page },
|
|
59
62
|
},
|
|
60
63
|
})
|
|
61
64
|
, options
|
|
@@ -19,6 +19,8 @@ export interface ForProjectTimesheetOptions extends PaginationOptions {
|
|
|
19
19
|
to?: string;
|
|
20
20
|
/** Person id */
|
|
21
21
|
personId?: number;
|
|
22
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
23
|
+
page?: number;
|
|
22
24
|
}
|
|
23
25
|
/**
|
|
24
26
|
* Options for forRecording.
|
|
@@ -30,6 +32,8 @@ export interface ForRecordingTimesheetOptions extends PaginationOptions {
|
|
|
30
32
|
to?: string;
|
|
31
33
|
/** Person id */
|
|
32
34
|
personId?: number;
|
|
35
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
36
|
+
page?: number;
|
|
33
37
|
}
|
|
34
38
|
/**
|
|
35
39
|
* Request parameters for create.
|
|
@@ -145,5 +149,17 @@ export declare class TimesheetsService extends BaseService {
|
|
|
145
149
|
* ```
|
|
146
150
|
*/
|
|
147
151
|
update(entryId: number, req: UpdateTimesheetRequest): Promise<TimesheetEntry>;
|
|
152
|
+
/**
|
|
153
|
+
* Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
|
|
154
|
+
* @param entryId - The entry ID
|
|
155
|
+
* @returns void
|
|
156
|
+
* @throws {BasecampError} If the request fails
|
|
157
|
+
*
|
|
158
|
+
* @example
|
|
159
|
+
* ```ts
|
|
160
|
+
* await client.timesheets.destroy(123);
|
|
161
|
+
* ```
|
|
162
|
+
*/
|
|
163
|
+
destroy(entryId: number): Promise<void>;
|
|
148
164
|
}
|
|
149
165
|
//# sourceMappingURL=timesheets.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timesheets.d.ts","sourceRoot":"","sources":["../../../src/generated/services/timesheets.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,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS;IACT,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"timesheets.d.ts","sourceRoot":"","sources":["../../../src/generated/services/timesheets.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,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS;IACT,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,iBAAiB;IACrE,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS;IACT,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS;IACT,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAOD;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAEhD;;;;;;;;;;OAUG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAoB9G;;;;;;;;;;OAUG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAoBpH;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IA+BvF;;;;;;;;;OASG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAkBzE;;;;;;;;;;OAUG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAmBnD;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,cAAc,CAAC;IAyBnF;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB9C"}
|
|
@@ -33,7 +33,7 @@ export class TimesheetsService extends BaseService {
|
|
|
33
33
|
}, () => this.client.GET("/projects/{projectId}/timesheet.json", {
|
|
34
34
|
params: {
|
|
35
35
|
path: { projectId },
|
|
36
|
-
query: { from: options?.from, to: options?.to, "person_id": options?.personId },
|
|
36
|
+
query: { from: options?.from, to: options?.to, "person_id": options?.personId, page: options?.page },
|
|
37
37
|
},
|
|
38
38
|
}), options);
|
|
39
39
|
}
|
|
@@ -58,7 +58,7 @@ export class TimesheetsService extends BaseService {
|
|
|
58
58
|
}, () => this.client.GET("/recordings/{recordingId}/timesheet.json", {
|
|
59
59
|
params: {
|
|
60
60
|
path: { recordingId },
|
|
61
|
-
query: { from: options?.from, to: options?.to, "person_id": options?.personId },
|
|
61
|
+
query: { from: options?.from, to: options?.to, "person_id": options?.personId, page: options?.page },
|
|
62
62
|
},
|
|
63
63
|
}), options);
|
|
64
64
|
}
|
|
@@ -180,5 +180,29 @@ export class TimesheetsService extends BaseService {
|
|
|
180
180
|
}));
|
|
181
181
|
return response;
|
|
182
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
|
|
185
|
+
* @param entryId - The entry ID
|
|
186
|
+
* @returns void
|
|
187
|
+
* @throws {BasecampError} If the request fails
|
|
188
|
+
*
|
|
189
|
+
* @example
|
|
190
|
+
* ```ts
|
|
191
|
+
* await client.timesheets.destroy(123);
|
|
192
|
+
* ```
|
|
193
|
+
*/
|
|
194
|
+
async destroy(entryId) {
|
|
195
|
+
await this.request({
|
|
196
|
+
service: "Timesheets",
|
|
197
|
+
operation: "DestroyTimesheetEntry",
|
|
198
|
+
resourceType: "timesheet_entry",
|
|
199
|
+
isMutation: true,
|
|
200
|
+
resourceId: entryId,
|
|
201
|
+
}, () => this.client.DELETE("/timesheet_entries/{entryId}", {
|
|
202
|
+
params: {
|
|
203
|
+
path: { entryId },
|
|
204
|
+
},
|
|
205
|
+
}));
|
|
206
|
+
}
|
|
183
207
|
}
|
|
184
208
|
//# sourceMappingURL=timesheets.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timesheets.js","sourceRoot":"","sources":["../../../src/generated/services/timesheets.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":"timesheets.js","sourceRoot":"","sources":["../../../src/generated/services/timesheets.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA8EzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAEhD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,OAAoC;QACtE,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,mBAAmB;YACjC,UAAU,EAAE,KAAK;YACjB,SAAS;SACV,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,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aACrG;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,OAAsC;QAC5E,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,uBAAuB;YAClC,YAAY,EAAE,qBAAqB;YACnC,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;gBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aACrG;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,GAA2B;QAC3D,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,MAAM,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC9C,CAAC;QACD,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,YAAY;YACrB,SAAS,EAAE,sBAAsB;YACjC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE;YACnE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,SAAS,EAAE,GAAG,CAAC,QAAQ;aACxB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,OAAgC;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,kBAAkB;YAChC,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACzC,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE;aAChF;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,IAAI,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE;YAC9C,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,GAA2B;QACvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,sBAAsB;YACjC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,EAAE;YAC9C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,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,OAAO,CAAC,OAAe;QAC3B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,uBAAuB;YAClC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,8BAA8B,EAAE;YACjD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -27,6 +27,8 @@ export interface ForProjectTimesheetOptions extends PaginationOptions {
|
|
|
27
27
|
to?: string;
|
|
28
28
|
/** Person id */
|
|
29
29
|
personId?: number;
|
|
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
|
/**
|
|
@@ -39,6 +41,8 @@ export interface ForRecordingTimesheetOptions extends PaginationOptions {
|
|
|
39
41
|
to?: string;
|
|
40
42
|
/** Person id */
|
|
41
43
|
personId?: number;
|
|
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;
|
|
42
46
|
}
|
|
43
47
|
|
|
44
48
|
/**
|
|
@@ -115,7 +119,7 @@ export class TimesheetsService extends BaseService {
|
|
|
115
119
|
this.client.GET("/projects/{projectId}/timesheet.json", {
|
|
116
120
|
params: {
|
|
117
121
|
path: { projectId },
|
|
118
|
-
query: { from: options?.from, to: options?.to, "person_id": options?.personId },
|
|
122
|
+
query: { from: options?.from, to: options?.to, "person_id": options?.personId, page: options?.page },
|
|
119
123
|
},
|
|
120
124
|
})
|
|
121
125
|
, options
|
|
@@ -146,7 +150,7 @@ export class TimesheetsService extends BaseService {
|
|
|
146
150
|
this.client.GET("/recordings/{recordingId}/timesheet.json", {
|
|
147
151
|
params: {
|
|
148
152
|
path: { recordingId },
|
|
149
|
-
query: { from: options?.from, to: options?.to, "person_id": options?.personId },
|
|
153
|
+
query: { from: options?.from, to: options?.to, "person_id": options?.personId, page: options?.page },
|
|
150
154
|
},
|
|
151
155
|
})
|
|
152
156
|
, options
|
|
@@ -290,4 +294,33 @@ export class TimesheetsService extends BaseService {
|
|
|
290
294
|
);
|
|
291
295
|
return response;
|
|
292
296
|
}
|
|
297
|
+
|
|
298
|
+
/**
|
|
299
|
+
* Permanently delete a timesheet entry; answers 403 when the caller may not archive or trash it.
|
|
300
|
+
* @param entryId - The entry ID
|
|
301
|
+
* @returns void
|
|
302
|
+
* @throws {BasecampError} If the request fails
|
|
303
|
+
*
|
|
304
|
+
* @example
|
|
305
|
+
* ```ts
|
|
306
|
+
* await client.timesheets.destroy(123);
|
|
307
|
+
* ```
|
|
308
|
+
*/
|
|
309
|
+
async destroy(entryId: number): Promise<void> {
|
|
310
|
+
await this.request(
|
|
311
|
+
{
|
|
312
|
+
service: "Timesheets",
|
|
313
|
+
operation: "DestroyTimesheetEntry",
|
|
314
|
+
resourceType: "timesheet_entry",
|
|
315
|
+
isMutation: true,
|
|
316
|
+
resourceId: entryId,
|
|
317
|
+
},
|
|
318
|
+
() =>
|
|
319
|
+
this.client.DELETE("/timesheet_entries/{entryId}", {
|
|
320
|
+
params: {
|
|
321
|
+
path: { entryId },
|
|
322
|
+
},
|
|
323
|
+
})
|
|
324
|
+
);
|
|
325
|
+
}
|
|
293
326
|
}
|
|
@@ -7,8 +7,8 @@ import { BaseService } from "../../services/base.js";
|
|
|
7
7
|
import type { components } from "../schema.js";
|
|
8
8
|
import { ListResult } from "../../pagination.js";
|
|
9
9
|
import type { PaginationOptions } from "../../pagination.js";
|
|
10
|
-
/**
|
|
11
|
-
export type
|
|
10
|
+
/** Todolist entity from the Basecamp API. */
|
|
11
|
+
export type Todolist = components["schemas"]["Todolist"];
|
|
12
12
|
/**
|
|
13
13
|
* Request parameters for reposition.
|
|
14
14
|
*/
|
|
@@ -20,6 +20,8 @@ export interface RepositionTodolistGroupRequest {
|
|
|
20
20
|
* Options for list.
|
|
21
21
|
*/
|
|
22
22
|
export interface ListTodolistGroupOptions 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.
|
|
@@ -49,19 +51,22 @@ export declare class TodolistGroupsService extends BaseService {
|
|
|
49
51
|
* List groups in a todolist
|
|
50
52
|
* @param todolistId - The todolist ID
|
|
51
53
|
* @param options - Optional query parameters
|
|
52
|
-
* @returns All
|
|
54
|
+
* @returns All Todolist across all pages, with .meta.totalCount
|
|
53
55
|
*
|
|
54
56
|
* @example
|
|
55
57
|
* ```ts
|
|
56
58
|
* const result = await client.todolistGroups.list(123);
|
|
59
|
+
*
|
|
60
|
+
* // With options
|
|
61
|
+
* const filtered = await client.todolistGroups.list(123, { page: 1 });
|
|
57
62
|
* ```
|
|
58
63
|
*/
|
|
59
|
-
list(todolistId: number, options?: ListTodolistGroupOptions): Promise<ListResult<
|
|
64
|
+
list(todolistId: number, options?: ListTodolistGroupOptions): Promise<ListResult<Todolist>>;
|
|
60
65
|
/**
|
|
61
66
|
* Create a new group in a todolist
|
|
62
67
|
* @param todolistId - The todolist ID
|
|
63
68
|
* @param req - Todolist_group creation parameters
|
|
64
|
-
* @returns The
|
|
69
|
+
* @returns The Todolist
|
|
65
70
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
66
71
|
*
|
|
67
72
|
* @example
|
|
@@ -69,6 +74,6 @@ export declare class TodolistGroupsService extends BaseService {
|
|
|
69
74
|
* const result = await client.todolistGroups.create(123, { name: "My example" });
|
|
70
75
|
* ```
|
|
71
76
|
*/
|
|
72
|
-
create(todolistId: number, req: CreateTodolistGroupRequest): Promise<
|
|
77
|
+
create(todolistId: number, req: CreateTodolistGroupRequest): Promise<Todolist>;
|
|
73
78
|
}
|
|
74
79
|
//# sourceMappingURL=todolist-groups.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"todolist-groups.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todolist-groups.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,
|
|
1
|
+
{"version":3,"file":"todolist-groups.d.ts","sourceRoot":"","sources":["../../../src/generated/services/todolist-groups.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,8BAA8B;IAC7C,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAOD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IAEpD;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBrF;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAoBjG;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC;CAwBrF"}
|