@37signals/basecamp 0.2.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 +600 -0
- package/dist/auth-strategy.d.ts +36 -0
- package/dist/auth-strategy.d.ts.map +1 -0
- package/dist/auth-strategy.js +33 -0
- package/dist/auth-strategy.js.map +1 -0
- package/dist/client.d.ts +224 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +715 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +137 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +269 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/metadata.json +2281 -0
- package/dist/generated/openapi-stripped.json +21268 -0
- package/dist/generated/path-mapping.d.ts +8 -0
- package/dist/generated/path-mapping.d.ts.map +1 -0
- package/dist/generated/path-mapping.js +192 -0
- package/dist/generated/path-mapping.js.map +1 -0
- package/dist/generated/path-mapping.ts +199 -0
- package/dist/generated/schema.d.ts +14883 -0
- package/dist/generated/services/attachments.d.ts +27 -0
- package/dist/generated/services/attachments.d.ts.map +1 -0
- package/dist/generated/services/attachments.js +49 -0
- package/dist/generated/services/attachments.js.map +1 -0
- package/dist/generated/services/attachments.ts +59 -0
- package/dist/generated/services/boosts.d.ts +114 -0
- package/dist/generated/services/boosts.d.ts.map +1 -0
- package/dist/generated/services/boosts.js +179 -0
- package/dist/generated/services/boosts.js.map +1 -0
- package/dist/generated/services/boosts.ts +250 -0
- package/dist/generated/services/campfires.d.ts +202 -0
- package/dist/generated/services/campfires.d.ts.map +1 -0
- package/dist/generated/services/campfires.js +309 -0
- package/dist/generated/services/campfires.js.map +1 -0
- package/dist/generated/services/campfires.ts +433 -0
- package/dist/generated/services/card-columns.d.ts +163 -0
- package/dist/generated/services/card-columns.d.ts.map +1 -0
- package/dist/generated/services/card-columns.js +264 -0
- package/dist/generated/services/card-columns.js.map +1 -0
- package/dist/generated/services/card-columns.ts +360 -0
- package/dist/generated/services/card-steps.d.ts +105 -0
- package/dist/generated/services/card-steps.d.ts.map +1 -0
- package/dist/generated/services/card-steps.js +148 -0
- package/dist/generated/services/card-steps.js.map +1 -0
- package/dist/generated/services/card-steps.ts +221 -0
- package/dist/generated/services/card-tables.d.ts +27 -0
- package/dist/generated/services/card-tables.d.ts.map +1 -0
- package/dist/generated/services/card-tables.js +40 -0
- package/dist/generated/services/card-tables.js.map +1 -0
- package/dist/generated/services/card-tables.ts +55 -0
- package/dist/generated/services/cards.d.ts +118 -0
- package/dist/generated/services/cards.d.ts.map +1 -0
- package/dist/generated/services/cards.js +166 -0
- package/dist/generated/services/cards.js.map +1 -0
- package/dist/generated/services/cards.ts +247 -0
- package/dist/generated/services/checkins.d.ts +278 -0
- package/dist/generated/services/checkins.d.ts.map +1 -0
- package/dist/generated/services/checkins.js +420 -0
- package/dist/generated/services/checkins.js.map +1 -0
- package/dist/generated/services/checkins.ts +600 -0
- package/dist/generated/services/client-approvals.d.ts +45 -0
- package/dist/generated/services/client-approvals.d.ts.map +1 -0
- package/dist/generated/services/client-approvals.js +58 -0
- package/dist/generated/services/client-approvals.js.map +1 -0
- package/dist/generated/services/client-approvals.ts +89 -0
- package/dist/generated/services/client-correspondences.d.ts +45 -0
- package/dist/generated/services/client-correspondences.d.ts.map +1 -0
- package/dist/generated/services/client-correspondences.js +58 -0
- package/dist/generated/services/client-correspondences.js.map +1 -0
- package/dist/generated/services/client-correspondences.ts +89 -0
- package/dist/generated/services/client-replies.d.ts +47 -0
- package/dist/generated/services/client-replies.d.ts.map +1 -0
- package/dist/generated/services/client-replies.js +65 -0
- package/dist/generated/services/client-replies.js.map +1 -0
- package/dist/generated/services/client-replies.ts +95 -0
- package/dist/generated/services/client-visibility.d.ts +35 -0
- package/dist/generated/services/client-visibility.d.ts.map +1 -0
- package/dist/generated/services/client-visibility.js +44 -0
- package/dist/generated/services/client-visibility.js.map +1 -0
- package/dist/generated/services/client-visibility.ts +68 -0
- package/dist/generated/services/comments.d.ts +86 -0
- package/dist/generated/services/comments.d.ts.map +1 -0
- package/dist/generated/services/comments.js +129 -0
- package/dist/generated/services/comments.js.map +1 -0
- package/dist/generated/services/comments.ts +185 -0
- package/dist/generated/services/documents.d.ts +92 -0
- package/dist/generated/services/documents.d.ts.map +1 -0
- package/dist/generated/services/documents.js +129 -0
- package/dist/generated/services/documents.js.map +1 -0
- package/dist/generated/services/documents.ts +191 -0
- package/dist/generated/services/events.d.ts +34 -0
- package/dist/generated/services/events.d.ts.map +1 -0
- package/dist/generated/services/events.js +39 -0
- package/dist/generated/services/events.js.map +1 -0
- package/dist/generated/services/events.ts +64 -0
- package/dist/generated/services/forwards.d.ts +112 -0
- package/dist/generated/services/forwards.d.ts.map +1 -0
- package/dist/generated/services/forwards.js +172 -0
- package/dist/generated/services/forwards.js.map +1 -0
- package/dist/generated/services/forwards.ts +241 -0
- package/dist/generated/services/index.d.ts +39 -0
- package/dist/generated/services/index.d.ts.map +1 -0
- package/dist/generated/services/index.js +39 -0
- package/dist/generated/services/index.js.map +1 -0
- package/dist/generated/services/index.ts +38 -0
- package/dist/generated/services/lineup.d.ts +67 -0
- package/dist/generated/services/lineup.d.ts.map +1 -0
- package/dist/generated/services/lineup.js +99 -0
- package/dist/generated/services/lineup.js.map +1 -0
- package/dist/generated/services/lineup.ts +143 -0
- package/dist/generated/services/message-boards.d.ts +27 -0
- package/dist/generated/services/message-boards.d.ts.map +1 -0
- package/dist/generated/services/message-boards.js +40 -0
- package/dist/generated/services/message-boards.js.map +1 -0
- package/dist/generated/services/message-boards.ts +55 -0
- package/dist/generated/services/message-types.d.ts +100 -0
- package/dist/generated/services/message-types.d.ts.map +1 -0
- package/dist/generated/services/message-types.js +144 -0
- package/dist/generated/services/message-types.js.map +1 -0
- package/dist/generated/services/message-types.ts +210 -0
- package/dist/generated/services/messages.d.ts +122 -0
- package/dist/generated/services/messages.d.ts.map +1 -0
- package/dist/generated/services/messages.js +180 -0
- package/dist/generated/services/messages.js.map +1 -0
- package/dist/generated/services/messages.ts +258 -0
- package/dist/generated/services/people.d.ts +122 -0
- package/dist/generated/services/people.d.ts.map +1 -0
- package/dist/generated/services/people.js +167 -0
- package/dist/generated/services/people.js.map +1 -0
- package/dist/generated/services/people.ts +252 -0
- package/dist/generated/services/projects.d.ts +109 -0
- package/dist/generated/services/projects.d.ts.map +1 -0
- package/dist/generated/services/projects.js +153 -0
- package/dist/generated/services/projects.js.map +1 -0
- package/dist/generated/services/projects.ts +224 -0
- package/dist/generated/services/recordings.d.ts +93 -0
- package/dist/generated/services/recordings.d.ts.map +1 -0
- package/dist/generated/services/recordings.js +138 -0
- package/dist/generated/services/recordings.js.map +1 -0
- package/dist/generated/services/recordings.ts +191 -0
- package/dist/generated/services/reports.d.ts +90 -0
- package/dist/generated/services/reports.d.ts.map +1 -0
- package/dist/generated/services/reports.js +124 -0
- package/dist/generated/services/reports.js.map +1 -0
- package/dist/generated/services/reports.ts +187 -0
- package/dist/generated/services/schedules.d.ts +162 -0
- package/dist/generated/services/schedules.d.ts.map +1 -0
- package/dist/generated/services/schedules.js +228 -0
- package/dist/generated/services/schedules.js.map +1 -0
- package/dist/generated/services/schedules.ts +335 -0
- package/dist/generated/services/search.d.ts +45 -0
- package/dist/generated/services/search.d.ts.map +1 -0
- package/dist/generated/services/search.js +56 -0
- package/dist/generated/services/search.js.map +1 -0
- package/dist/generated/services/search.ts +89 -0
- package/dist/generated/services/subscriptions.d.ts +73 -0
- package/dist/generated/services/subscriptions.d.ts.map +1 -0
- package/dist/generated/services/subscriptions.js +119 -0
- package/dist/generated/services/subscriptions.js.map +1 -0
- package/dist/generated/services/subscriptions.ts +160 -0
- package/dist/generated/services/templates.d.ts +140 -0
- package/dist/generated/services/templates.d.ts.map +1 -0
- package/dist/generated/services/templates.js +207 -0
- package/dist/generated/services/templates.js.map +1 -0
- package/dist/generated/services/templates.ts +294 -0
- package/dist/generated/services/timeline.d.ts +31 -0
- package/dist/generated/services/timeline.d.ts.map +1 -0
- package/dist/generated/services/timeline.js +39 -0
- package/dist/generated/services/timeline.js.map +1 -0
- package/dist/generated/services/timeline.ts +62 -0
- package/dist/generated/services/timesheets.d.ts +145 -0
- package/dist/generated/services/timesheets.d.ts.map +1 -0
- package/dist/generated/services/timesheets.js +186 -0
- package/dist/generated/services/timesheets.js.map +1 -0
- package/dist/generated/services/timesheets.ts +289 -0
- package/dist/generated/services/todolist-groups.d.ts +74 -0
- package/dist/generated/services/todolist-groups.d.ts.map +1 -0
- package/dist/generated/services/todolist-groups.js +100 -0
- package/dist/generated/services/todolist-groups.js.map +1 -0
- package/dist/generated/services/todolist-groups.ts +151 -0
- package/dist/generated/services/todolists.d.ts +95 -0
- package/dist/generated/services/todolists.d.ts.map +1 -0
- package/dist/generated/services/todolists.js +130 -0
- package/dist/generated/services/todolists.js.map +1 -0
- package/dist/generated/services/todolists.ts +192 -0
- package/dist/generated/services/todos.d.ts +175 -0
- package/dist/generated/services/todos.d.ts.map +1 -0
- package/dist/generated/services/todos.js +255 -0
- package/dist/generated/services/todos.js.map +1 -0
- package/dist/generated/services/todos.ts +369 -0
- package/dist/generated/services/todosets.d.ts +27 -0
- package/dist/generated/services/todosets.d.ts.map +1 -0
- package/dist/generated/services/todosets.js +40 -0
- package/dist/generated/services/todosets.js.map +1 -0
- package/dist/generated/services/todosets.ts +55 -0
- package/dist/generated/services/tools.d.ts +122 -0
- package/dist/generated/services/tools.d.ts.map +1 -0
- package/dist/generated/services/tools.js +197 -0
- package/dist/generated/services/tools.js.map +1 -0
- package/dist/generated/services/tools.ts +267 -0
- package/dist/generated/services/uploads.d.ts +109 -0
- package/dist/generated/services/uploads.d.ts.map +1 -0
- package/dist/generated/services/uploads.js +153 -0
- package/dist/generated/services/uploads.js.map +1 -0
- package/dist/generated/services/uploads.ts +227 -0
- package/dist/generated/services/vaults.d.ts +86 -0
- package/dist/generated/services/vaults.d.ts.map +1 -0
- package/dist/generated/services/vaults.js +126 -0
- package/dist/generated/services/vaults.js.map +1 -0
- package/dist/generated/services/vaults.ts +182 -0
- package/dist/generated/services/webhooks.d.ts +106 -0
- package/dist/generated/services/webhooks.d.ts.map +1 -0
- package/dist/generated/services/webhooks.js +157 -0
- package/dist/generated/services/webhooks.js.map +1 -0
- package/dist/generated/services/webhooks.ts +226 -0
- package/dist/hooks/otel.d.ts +136 -0
- package/dist/hooks/otel.d.ts.map +1 -0
- package/dist/hooks/otel.js +240 -0
- package/dist/hooks/otel.js.map +1 -0
- package/dist/hooks.d.ts +171 -0
- package/dist/hooks.d.ts.map +1 -0
- package/dist/hooks.js +196 -0
- package/dist/hooks.js.map +1 -0
- package/dist/index.d.ts +90 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +122 -0
- package/dist/index.js.map +1 -0
- package/dist/oauth/authorize.d.ts +48 -0
- package/dist/oauth/authorize.d.ts.map +1 -0
- package/dist/oauth/authorize.js +56 -0
- package/dist/oauth/authorize.js.map +1 -0
- package/dist/oauth/callback-server.d.ts +56 -0
- package/dist/oauth/callback-server.d.ts.map +1 -0
- package/dist/oauth/callback-server.js +150 -0
- package/dist/oauth/callback-server.js.map +1 -0
- package/dist/oauth/discovery.d.ts +54 -0
- package/dist/oauth/discovery.d.ts.map +1 -0
- package/dist/oauth/discovery.js +116 -0
- package/dist/oauth/discovery.js.map +1 -0
- package/dist/oauth/exchange.d.ts +96 -0
- package/dist/oauth/exchange.d.ts.map +1 -0
- package/dist/oauth/exchange.js +324 -0
- package/dist/oauth/exchange.js.map +1 -0
- package/dist/oauth/identity.d.ts +30 -0
- package/dist/oauth/identity.d.ts.map +1 -0
- package/dist/oauth/identity.js +82 -0
- package/dist/oauth/identity.js.map +1 -0
- package/dist/oauth/index.d.ts +50 -0
- package/dist/oauth/index.d.ts.map +1 -0
- package/dist/oauth/index.js +58 -0
- package/dist/oauth/index.js.map +1 -0
- package/dist/oauth/interactive-login.d.ts +62 -0
- package/dist/oauth/interactive-login.d.ts.map +1 -0
- package/dist/oauth/interactive-login.js +106 -0
- package/dist/oauth/interactive-login.js.map +1 -0
- package/dist/oauth/pkce.d.ts +68 -0
- package/dist/oauth/pkce.d.ts.map +1 -0
- package/dist/oauth/pkce.js +80 -0
- package/dist/oauth/pkce.js.map +1 -0
- package/dist/oauth/token-manager.d.ts +92 -0
- package/dist/oauth/token-manager.d.ts.map +1 -0
- package/dist/oauth/token-manager.js +126 -0
- package/dist/oauth/token-manager.js.map +1 -0
- package/dist/oauth/token-store.d.ts +45 -0
- package/dist/oauth/token-store.d.ts.map +1 -0
- package/dist/oauth/token-store.js +105 -0
- package/dist/oauth/token-store.js.map +1 -0
- package/dist/oauth/types.d.ts +98 -0
- package/dist/oauth/types.d.ts.map +1 -0
- package/dist/oauth/types.js +8 -0
- package/dist/oauth/types.js.map +1 -0
- package/dist/pagination-utils.d.ts +27 -0
- package/dist/pagination-utils.d.ts.map +1 -0
- package/dist/pagination-utils.js +54 -0
- package/dist/pagination-utils.js.map +1 -0
- package/dist/pagination.d.ts +56 -0
- package/dist/pagination.d.ts.map +1 -0
- package/dist/pagination.js +57 -0
- package/dist/pagination.js.map +1 -0
- package/dist/security.d.ts +68 -0
- package/dist/security.d.ts.map +1 -0
- package/dist/security.js +107 -0
- package/dist/security.js.map +1 -0
- package/dist/services/authorization.d.ts +124 -0
- package/dist/services/authorization.d.ts.map +1 -0
- package/dist/services/authorization.js +117 -0
- package/dist/services/authorization.js.map +1 -0
- package/dist/services/base.d.ts +102 -0
- package/dist/services/base.d.ts.map +1 -0
- package/dist/services/base.js +230 -0
- package/dist/services/base.js.map +1 -0
- package/dist/webhooks/adapters/node-http.d.ts +14 -0
- package/dist/webhooks/adapters/node-http.d.ts.map +1 -0
- package/dist/webhooks/adapters/node-http.js +60 -0
- package/dist/webhooks/adapters/node-http.js.map +1 -0
- package/dist/webhooks/events.d.ts +52 -0
- package/dist/webhooks/events.d.ts.map +1 -0
- package/dist/webhooks/events.js +52 -0
- package/dist/webhooks/events.js.map +1 -0
- package/dist/webhooks/handler.d.ts +62 -0
- package/dist/webhooks/handler.d.ts.map +1 -0
- package/dist/webhooks/handler.js +226 -0
- package/dist/webhooks/handler.js.map +1 -0
- package/dist/webhooks/index.d.ts +5 -0
- package/dist/webhooks/index.d.ts.map +1 -0
- package/dist/webhooks/index.js +5 -0
- package/dist/webhooks/index.js.map +1 -0
- package/dist/webhooks/verify.d.ts +11 -0
- package/dist/webhooks/verify.d.ts.map +1 -0
- package/dist/webhooks/verify.js +25 -0
- package/dist/webhooks/verify.js.map +1 -0
- package/package.json +70 -0
- package/src/generated/metadata.json +2281 -0
- package/src/generated/openapi-stripped.json +21268 -0
- package/src/generated/path-mapping.ts +199 -0
- package/src/generated/schema.d.ts +14883 -0
- package/src/generated/services/attachments.ts +59 -0
- package/src/generated/services/boosts.ts +250 -0
- package/src/generated/services/campfires.ts +433 -0
- package/src/generated/services/card-columns.ts +360 -0
- package/src/generated/services/card-steps.ts +221 -0
- package/src/generated/services/card-tables.ts +55 -0
- package/src/generated/services/cards.ts +247 -0
- package/src/generated/services/checkins.ts +600 -0
- package/src/generated/services/client-approvals.ts +89 -0
- package/src/generated/services/client-correspondences.ts +89 -0
- package/src/generated/services/client-replies.ts +95 -0
- package/src/generated/services/client-visibility.ts +68 -0
- package/src/generated/services/comments.ts +185 -0
- package/src/generated/services/documents.ts +191 -0
- package/src/generated/services/events.ts +64 -0
- package/src/generated/services/forwards.ts +241 -0
- package/src/generated/services/index.ts +38 -0
- package/src/generated/services/lineup.ts +143 -0
- package/src/generated/services/message-boards.ts +55 -0
- package/src/generated/services/message-types.ts +210 -0
- package/src/generated/services/messages.ts +258 -0
- package/src/generated/services/people.ts +252 -0
- package/src/generated/services/projects.ts +224 -0
- package/src/generated/services/recordings.ts +191 -0
- package/src/generated/services/reports.ts +187 -0
- package/src/generated/services/schedules.ts +335 -0
- package/src/generated/services/search.ts +89 -0
- package/src/generated/services/subscriptions.ts +160 -0
- package/src/generated/services/templates.ts +294 -0
- package/src/generated/services/timeline.ts +62 -0
- package/src/generated/services/timesheets.ts +289 -0
- package/src/generated/services/todolist-groups.ts +151 -0
- package/src/generated/services/todolists.ts +192 -0
- package/src/generated/services/todos.ts +369 -0
- package/src/generated/services/todosets.ts +55 -0
- package/src/generated/services/tools.ts +267 -0
- package/src/generated/services/uploads.ts +227 -0
- package/src/generated/services/vaults.ts +182 -0
- package/src/generated/services/webhooks.ts +226 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reports service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
import { BaseService } from "../../services/base.js";
|
|
7
|
+
import type { components } from "../schema.js";
|
|
8
|
+
import type { PaginationOptions } from "../../pagination.js";
|
|
9
|
+
/**
|
|
10
|
+
* Options for progress.
|
|
11
|
+
*/
|
|
12
|
+
export interface ProgressReportOptions extends PaginationOptions {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Options for upcoming.
|
|
16
|
+
*/
|
|
17
|
+
export interface UpcomingReportOptions {
|
|
18
|
+
/** Window starts on */
|
|
19
|
+
windowStartsOn?: string;
|
|
20
|
+
/** Window ends on */
|
|
21
|
+
windowEndsOn?: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Options for assigned.
|
|
25
|
+
*/
|
|
26
|
+
export interface AssignedReportOptions {
|
|
27
|
+
/** Group by "bucket" or "date" */
|
|
28
|
+
groupBy?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Service for Reports operations.
|
|
32
|
+
*/
|
|
33
|
+
export declare class ReportsService extends BaseService {
|
|
34
|
+
/**
|
|
35
|
+
* Get account-wide activity feed (progress report)
|
|
36
|
+
* @param options - Optional query parameters
|
|
37
|
+
* @returns All results across all pages, with .meta.totalCount
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* const result = await client.reports.progress();
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
progress(options?: ProgressReportOptions): Promise<components["schemas"]["GetProgressReportResponseContent"]>;
|
|
45
|
+
/**
|
|
46
|
+
* Get upcoming schedule entries within a date window
|
|
47
|
+
* @param options - Optional query parameters
|
|
48
|
+
* @returns The upcoming_schedule
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* const result = await client.reports.upcoming();
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
upcoming(options?: UpcomingReportOptions): Promise<components["schemas"]["GetUpcomingScheduleResponseContent"]>;
|
|
56
|
+
/**
|
|
57
|
+
* Get todos assigned to a specific person
|
|
58
|
+
* @param personId - The person ID
|
|
59
|
+
* @param options - Optional query parameters
|
|
60
|
+
* @returns The assigned_todo
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const result = await client.reports.assigned(123);
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
assigned(personId: number, options?: AssignedReportOptions): Promise<components["schemas"]["GetAssignedTodosResponseContent"]>;
|
|
68
|
+
/**
|
|
69
|
+
* Get overdue todos grouped by lateness
|
|
70
|
+
* @returns The overdue_todo
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* const result = await client.reports.overdue();
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
overdue(): Promise<components["schemas"]["GetOverdueTodosResponseContent"]>;
|
|
78
|
+
/**
|
|
79
|
+
* Get a person's activity timeline
|
|
80
|
+
* @param personId - The person ID
|
|
81
|
+
* @returns The person_progress
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* const result = await client.reports.personProgress(123);
|
|
86
|
+
* ```
|
|
87
|
+
*/
|
|
88
|
+
personProgress(personId: number): Promise<components["schemas"]["GetPersonProgressResponseContent"]>;
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=reports.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.d.ts","sourceRoot":"","sources":["../../../src/generated/services/reports.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,qBAAsB,SAAQ,iBAAiB;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,uBAAuB;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qBAAqB;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;OASG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,kCAAkC,CAAC,CAAC;IAenH;;;;;;;;;OASG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,oCAAoC,CAAC,CAAC;IAkBrH;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,iCAAiC,CAAC,CAAC;IAoBpI;;;;;;;;OAQG;IACG,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;IAejF;;;;;;;;;OASG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,kCAAkC,CAAC,CAAC;CAkB3G"}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reports service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
import { BaseService } from "../../services/base.js";
|
|
7
|
+
// =============================================================================
|
|
8
|
+
// Service
|
|
9
|
+
// =============================================================================
|
|
10
|
+
/**
|
|
11
|
+
* Service for Reports operations.
|
|
12
|
+
*/
|
|
13
|
+
export class ReportsService extends BaseService {
|
|
14
|
+
/**
|
|
15
|
+
* Get account-wide activity feed (progress report)
|
|
16
|
+
* @param options - Optional query parameters
|
|
17
|
+
* @returns All results across all pages, with .meta.totalCount
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const result = await client.reports.progress();
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
async progress(options) {
|
|
25
|
+
return this.requestPaginated({
|
|
26
|
+
service: "Reports",
|
|
27
|
+
operation: "GetProgressReport",
|
|
28
|
+
resourceType: "progress_report",
|
|
29
|
+
isMutation: false,
|
|
30
|
+
}, () => this.client.GET("/reports/progress.json", {}), options);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Get upcoming schedule entries within a date window
|
|
34
|
+
* @param options - Optional query parameters
|
|
35
|
+
* @returns The upcoming_schedule
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const result = await client.reports.upcoming();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
async upcoming(options) {
|
|
43
|
+
const response = await this.request({
|
|
44
|
+
service: "Reports",
|
|
45
|
+
operation: "GetUpcomingSchedule",
|
|
46
|
+
resourceType: "upcoming_schedule",
|
|
47
|
+
isMutation: false,
|
|
48
|
+
}, () => this.client.GET("/reports/schedules/upcoming.json", {
|
|
49
|
+
params: {
|
|
50
|
+
query: { "window_starts_on": options?.windowStartsOn, "window_ends_on": options?.windowEndsOn },
|
|
51
|
+
},
|
|
52
|
+
}));
|
|
53
|
+
return response;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Get todos assigned to a specific person
|
|
57
|
+
* @param personId - The person ID
|
|
58
|
+
* @param options - Optional query parameters
|
|
59
|
+
* @returns The assigned_todo
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const result = await client.reports.assigned(123);
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
async assigned(personId, options) {
|
|
67
|
+
const response = await this.request({
|
|
68
|
+
service: "Reports",
|
|
69
|
+
operation: "GetAssignedTodos",
|
|
70
|
+
resourceType: "assigned_todo",
|
|
71
|
+
isMutation: false,
|
|
72
|
+
resourceId: personId,
|
|
73
|
+
}, () => this.client.GET("/reports/todos/assigned/{personId}", {
|
|
74
|
+
params: {
|
|
75
|
+
path: { personId },
|
|
76
|
+
query: { "group_by": options?.groupBy },
|
|
77
|
+
},
|
|
78
|
+
}));
|
|
79
|
+
return response;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Get overdue todos grouped by lateness
|
|
83
|
+
* @returns The overdue_todo
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const result = await client.reports.overdue();
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
async overdue() {
|
|
91
|
+
const response = await this.request({
|
|
92
|
+
service: "Reports",
|
|
93
|
+
operation: "GetOverdueTodos",
|
|
94
|
+
resourceType: "overdue_todo",
|
|
95
|
+
isMutation: false,
|
|
96
|
+
}, () => this.client.GET("/reports/todos/overdue.json", {}));
|
|
97
|
+
return response;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Get a person's activity timeline
|
|
101
|
+
* @param personId - The person ID
|
|
102
|
+
* @returns The person_progress
|
|
103
|
+
*
|
|
104
|
+
* @example
|
|
105
|
+
* ```ts
|
|
106
|
+
* const result = await client.reports.personProgress(123);
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
async personProgress(personId) {
|
|
110
|
+
const response = await this.request({
|
|
111
|
+
service: "Reports",
|
|
112
|
+
operation: "GetPersonProgress",
|
|
113
|
+
resourceType: "person_progress",
|
|
114
|
+
isMutation: false,
|
|
115
|
+
resourceId: personId,
|
|
116
|
+
}, () => this.client.GET("/reports/users/progress/{personId}", {
|
|
117
|
+
params: {
|
|
118
|
+
path: { personId },
|
|
119
|
+
},
|
|
120
|
+
}));
|
|
121
|
+
return response;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
//# sourceMappingURL=reports.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../../src/generated/services/reports.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAmCrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,OAA+B;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE,EACzC,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CAAC,OAA+B;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,mBAAmB;YACjC,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAClD,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,kBAAkB,EAAE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE;aAChG;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAA+B;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,kBAAkB;YAC7B,YAAY,EAAE,eAAe;YAC7B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE;YACpD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;gBAClB,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE;aACxC;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,iBAAiB;YAC5B,YAAY,EAAE,cAAc;YAC5B,UAAU,EAAE,KAAK;SAClB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAC9C,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAAC,QAAgB;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,mBAAmB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,oCAAoC,EAAE;YACpD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reports service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BaseService } from "../../services/base.js";
|
|
8
|
+
import type { components } from "../schema.js";
|
|
9
|
+
import { ListResult } from "../../pagination.js";
|
|
10
|
+
import type { PaginationOptions } from "../../pagination.js";
|
|
11
|
+
|
|
12
|
+
// =============================================================================
|
|
13
|
+
// Types
|
|
14
|
+
// =============================================================================
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Options for progress.
|
|
19
|
+
*/
|
|
20
|
+
export interface ProgressReportOptions extends PaginationOptions {
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Options for upcoming.
|
|
25
|
+
*/
|
|
26
|
+
export interface UpcomingReportOptions {
|
|
27
|
+
/** Window starts on */
|
|
28
|
+
windowStartsOn?: string;
|
|
29
|
+
/** Window ends on */
|
|
30
|
+
windowEndsOn?: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Options for assigned.
|
|
35
|
+
*/
|
|
36
|
+
export interface AssignedReportOptions {
|
|
37
|
+
/** Group by "bucket" or "date" */
|
|
38
|
+
groupBy?: string;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
// =============================================================================
|
|
43
|
+
// Service
|
|
44
|
+
// =============================================================================
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Service for Reports operations.
|
|
48
|
+
*/
|
|
49
|
+
export class ReportsService extends BaseService {
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Get account-wide activity feed (progress report)
|
|
53
|
+
* @param options - Optional query parameters
|
|
54
|
+
* @returns All results across all pages, with .meta.totalCount
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```ts
|
|
58
|
+
* const result = await client.reports.progress();
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
async progress(options?: ProgressReportOptions): Promise<components["schemas"]["GetProgressReportResponseContent"]> {
|
|
62
|
+
return this.requestPaginated(
|
|
63
|
+
{
|
|
64
|
+
service: "Reports",
|
|
65
|
+
operation: "GetProgressReport",
|
|
66
|
+
resourceType: "progress_report",
|
|
67
|
+
isMutation: false,
|
|
68
|
+
},
|
|
69
|
+
() =>
|
|
70
|
+
this.client.GET("/reports/progress.json", {
|
|
71
|
+
})
|
|
72
|
+
, options
|
|
73
|
+
);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Get upcoming schedule entries within a date window
|
|
78
|
+
* @param options - Optional query parameters
|
|
79
|
+
* @returns The upcoming_schedule
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* const result = await client.reports.upcoming();
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
async upcoming(options?: UpcomingReportOptions): Promise<components["schemas"]["GetUpcomingScheduleResponseContent"]> {
|
|
87
|
+
const response = await this.request(
|
|
88
|
+
{
|
|
89
|
+
service: "Reports",
|
|
90
|
+
operation: "GetUpcomingSchedule",
|
|
91
|
+
resourceType: "upcoming_schedule",
|
|
92
|
+
isMutation: false,
|
|
93
|
+
},
|
|
94
|
+
() =>
|
|
95
|
+
this.client.GET("/reports/schedules/upcoming.json", {
|
|
96
|
+
params: {
|
|
97
|
+
query: { "window_starts_on": options?.windowStartsOn, "window_ends_on": options?.windowEndsOn },
|
|
98
|
+
},
|
|
99
|
+
})
|
|
100
|
+
);
|
|
101
|
+
return response;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Get todos assigned to a specific person
|
|
106
|
+
* @param personId - The person ID
|
|
107
|
+
* @param options - Optional query parameters
|
|
108
|
+
* @returns The assigned_todo
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* ```ts
|
|
112
|
+
* const result = await client.reports.assigned(123);
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
async assigned(personId: number, options?: AssignedReportOptions): Promise<components["schemas"]["GetAssignedTodosResponseContent"]> {
|
|
116
|
+
const response = await this.request(
|
|
117
|
+
{
|
|
118
|
+
service: "Reports",
|
|
119
|
+
operation: "GetAssignedTodos",
|
|
120
|
+
resourceType: "assigned_todo",
|
|
121
|
+
isMutation: false,
|
|
122
|
+
resourceId: personId,
|
|
123
|
+
},
|
|
124
|
+
() =>
|
|
125
|
+
this.client.GET("/reports/todos/assigned/{personId}", {
|
|
126
|
+
params: {
|
|
127
|
+
path: { personId },
|
|
128
|
+
query: { "group_by": options?.groupBy },
|
|
129
|
+
},
|
|
130
|
+
})
|
|
131
|
+
);
|
|
132
|
+
return response;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Get overdue todos grouped by lateness
|
|
137
|
+
* @returns The overdue_todo
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* ```ts
|
|
141
|
+
* const result = await client.reports.overdue();
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
async overdue(): Promise<components["schemas"]["GetOverdueTodosResponseContent"]> {
|
|
145
|
+
const response = await this.request(
|
|
146
|
+
{
|
|
147
|
+
service: "Reports",
|
|
148
|
+
operation: "GetOverdueTodos",
|
|
149
|
+
resourceType: "overdue_todo",
|
|
150
|
+
isMutation: false,
|
|
151
|
+
},
|
|
152
|
+
() =>
|
|
153
|
+
this.client.GET("/reports/todos/overdue.json", {
|
|
154
|
+
})
|
|
155
|
+
);
|
|
156
|
+
return response;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* Get a person's activity timeline
|
|
161
|
+
* @param personId - The person ID
|
|
162
|
+
* @returns The person_progress
|
|
163
|
+
*
|
|
164
|
+
* @example
|
|
165
|
+
* ```ts
|
|
166
|
+
* const result = await client.reports.personProgress(123);
|
|
167
|
+
* ```
|
|
168
|
+
*/
|
|
169
|
+
async personProgress(personId: number): Promise<components["schemas"]["GetPersonProgressResponseContent"]> {
|
|
170
|
+
const response = await this.request(
|
|
171
|
+
{
|
|
172
|
+
service: "Reports",
|
|
173
|
+
operation: "GetPersonProgress",
|
|
174
|
+
resourceType: "person_progress",
|
|
175
|
+
isMutation: false,
|
|
176
|
+
resourceId: personId,
|
|
177
|
+
},
|
|
178
|
+
() =>
|
|
179
|
+
this.client.GET("/reports/users/progress/{personId}", {
|
|
180
|
+
params: {
|
|
181
|
+
path: { personId },
|
|
182
|
+
},
|
|
183
|
+
})
|
|
184
|
+
);
|
|
185
|
+
return response;
|
|
186
|
+
}
|
|
187
|
+
}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Schedules service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
import { BaseService } from "../../services/base.js";
|
|
7
|
+
import type { components } from "../schema.js";
|
|
8
|
+
import { ListResult } from "../../pagination.js";
|
|
9
|
+
import type { PaginationOptions } from "../../pagination.js";
|
|
10
|
+
/** ScheduleEntry entity from the Basecamp API. */
|
|
11
|
+
export type ScheduleEntry = components["schemas"]["ScheduleEntry"];
|
|
12
|
+
/** Schedule entity from the Basecamp API. */
|
|
13
|
+
export type Schedule = components["schemas"]["Schedule"];
|
|
14
|
+
/**
|
|
15
|
+
* Request parameters for updateEntry.
|
|
16
|
+
*/
|
|
17
|
+
export interface UpdateEntryScheduleRequest {
|
|
18
|
+
/** Summary text */
|
|
19
|
+
summary?: string;
|
|
20
|
+
/** Starts at (RFC3339 (e.g., 2024-12-15T09:00:00Z)) */
|
|
21
|
+
startsAt?: string;
|
|
22
|
+
/** Ends at (RFC3339 (e.g., 2024-12-15T09:00:00Z)) */
|
|
23
|
+
endsAt?: string;
|
|
24
|
+
/** Rich text description (HTML) */
|
|
25
|
+
description?: string;
|
|
26
|
+
/** Participant ids */
|
|
27
|
+
participantIds?: number[];
|
|
28
|
+
/** All day */
|
|
29
|
+
allDay?: boolean;
|
|
30
|
+
/** Whether to send notifications to relevant people */
|
|
31
|
+
notify?: boolean;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Request parameters for updateSettings.
|
|
35
|
+
*/
|
|
36
|
+
export interface UpdateSettingsScheduleRequest {
|
|
37
|
+
/** Include due assignments */
|
|
38
|
+
includeDueAssignments: boolean;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Options for listEntries.
|
|
42
|
+
*/
|
|
43
|
+
export interface ListEntriesScheduleOptions extends PaginationOptions {
|
|
44
|
+
/** Filter by status */
|
|
45
|
+
status?: "active" | "archived" | "trashed";
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Request parameters for createEntry.
|
|
49
|
+
*/
|
|
50
|
+
export interface CreateEntryScheduleRequest {
|
|
51
|
+
/** Summary text */
|
|
52
|
+
summary: string;
|
|
53
|
+
/** Starts at (RFC3339 (e.g., 2024-12-15T09:00:00Z)) */
|
|
54
|
+
startsAt: string;
|
|
55
|
+
/** Ends at (RFC3339 (e.g., 2024-12-15T09:00:00Z)) */
|
|
56
|
+
endsAt: string;
|
|
57
|
+
/** Rich text description (HTML) */
|
|
58
|
+
description?: string;
|
|
59
|
+
/** Participant ids */
|
|
60
|
+
participantIds?: number[];
|
|
61
|
+
/** All day */
|
|
62
|
+
allDay?: boolean;
|
|
63
|
+
/** Whether to send notifications to relevant people */
|
|
64
|
+
notify?: boolean;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Service for Schedules operations.
|
|
68
|
+
*/
|
|
69
|
+
export declare class SchedulesService extends BaseService {
|
|
70
|
+
/**
|
|
71
|
+
* Get a single schedule entry by id.
|
|
72
|
+
* @param entryId - The entry ID
|
|
73
|
+
* @returns The ScheduleEntry
|
|
74
|
+
* @throws {BasecampError} If the resource is not found
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const result = await client.schedules.getEntry(123);
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
getEntry(entryId: number): Promise<ScheduleEntry>;
|
|
82
|
+
/**
|
|
83
|
+
* Update an existing schedule entry
|
|
84
|
+
* @param entryId - The entry ID
|
|
85
|
+
* @param req - Schedule_entry update parameters
|
|
86
|
+
* @returns The ScheduleEntry
|
|
87
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```ts
|
|
91
|
+
* const result = await client.schedules.updateEntry(123, { });
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
updateEntry(entryId: number, req: UpdateEntryScheduleRequest): Promise<ScheduleEntry>;
|
|
95
|
+
/**
|
|
96
|
+
* Get a specific occurrence of a recurring schedule entry
|
|
97
|
+
* @param entryId - The entry ID
|
|
98
|
+
* @param date - The date
|
|
99
|
+
* @returns The ScheduleEntry
|
|
100
|
+
* @throws {BasecampError} If the resource is not found
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const result = await client.schedules.getEntryOccurrence(123, "example");
|
|
105
|
+
* ```
|
|
106
|
+
*/
|
|
107
|
+
getEntryOccurrence(entryId: number, date: string): Promise<ScheduleEntry>;
|
|
108
|
+
/**
|
|
109
|
+
* Get a schedule
|
|
110
|
+
* @param scheduleId - The schedule ID
|
|
111
|
+
* @returns The Schedule
|
|
112
|
+
* @throws {BasecampError} If the resource is not found
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* ```ts
|
|
116
|
+
* const result = await client.schedules.get(123);
|
|
117
|
+
* ```
|
|
118
|
+
*/
|
|
119
|
+
get(scheduleId: number): Promise<Schedule>;
|
|
120
|
+
/**
|
|
121
|
+
* Update schedule settings
|
|
122
|
+
* @param scheduleId - The schedule ID
|
|
123
|
+
* @param req - Schedule_setting update parameters
|
|
124
|
+
* @returns The Schedule
|
|
125
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```ts
|
|
129
|
+
* const result = await client.schedules.updateSettings(123, { includeDueAssignments: true });
|
|
130
|
+
* ```
|
|
131
|
+
*/
|
|
132
|
+
updateSettings(scheduleId: number, req: UpdateSettingsScheduleRequest): Promise<Schedule>;
|
|
133
|
+
/**
|
|
134
|
+
* List entries on a schedule
|
|
135
|
+
* @param scheduleId - The schedule ID
|
|
136
|
+
* @param options - Optional query parameters
|
|
137
|
+
* @returns All ScheduleEntry across all pages, with .meta.totalCount
|
|
138
|
+
*
|
|
139
|
+
* @example
|
|
140
|
+
* ```ts
|
|
141
|
+
* const result = await client.schedules.listEntries(123);
|
|
142
|
+
*
|
|
143
|
+
* // With options
|
|
144
|
+
* const filtered = await client.schedules.listEntries(123, { status: "active" });
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
listEntries(scheduleId: number, options?: ListEntriesScheduleOptions): Promise<ListResult<ScheduleEntry>>;
|
|
148
|
+
/**
|
|
149
|
+
* Create a new schedule entry
|
|
150
|
+
* @param scheduleId - The schedule ID
|
|
151
|
+
* @param req - Schedule_entry creation parameters
|
|
152
|
+
* @returns The ScheduleEntry
|
|
153
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "2025-06-01T09:00:00Z", endsAt: "2025-06-01T09:00:00Z" });
|
|
158
|
+
* ```
|
|
159
|
+
*/
|
|
160
|
+
createEntry(scheduleId: number, req: CreateEntryScheduleRequest): Promise<ScheduleEntry>;
|
|
161
|
+
}
|
|
162
|
+
//# sourceMappingURL=schedules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schedules.d.ts","sourceRoot":"","sources":["../../../src/generated/services/schedules.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,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACnE,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,8BAA8B;IAC9B,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,uBAAuB;IACvB,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBvD;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;IA4B3F;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmB/E;;;;;;;;;;OAUG;IACG,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhD;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,6BAA6B,GAAG,OAAO,CAAC,QAAQ,CAAC;IAsB/F;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAoB/G;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;CAoC/F"}
|