@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
|
@@ -28,6 +28,8 @@ export interface ListRecordingOptions extends PaginationOptions {
|
|
|
28
28
|
sort?: "created_at" | "updated_at";
|
|
29
29
|
/** Filter by direction */
|
|
30
30
|
direction?: "asc" | "desc";
|
|
31
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
32
|
+
page?: number;
|
|
31
33
|
}
|
|
32
34
|
|
|
33
35
|
|
|
@@ -65,43 +67,13 @@ export class RecordingsService extends BaseService {
|
|
|
65
67
|
() =>
|
|
66
68
|
this.client.GET("/projects/recordings.json", {
|
|
67
69
|
params: {
|
|
68
|
-
query: { type: type, bucket: options?.bucket?.join(","), status: options?.status, sort: options?.sort, direction: options?.direction },
|
|
70
|
+
query: { type: type, bucket: options?.bucket?.join(","), status: options?.status, sort: options?.sort, direction: options?.direction, page: options?.page },
|
|
69
71
|
},
|
|
70
72
|
})
|
|
71
73
|
, options
|
|
72
74
|
);
|
|
73
75
|
}
|
|
74
76
|
|
|
75
|
-
/**
|
|
76
|
-
* Get a single recording by id
|
|
77
|
-
* @param recordingId - The recording ID
|
|
78
|
-
* @returns The Recording
|
|
79
|
-
* @throws {BasecampError} If the resource is not found
|
|
80
|
-
*
|
|
81
|
-
* @example
|
|
82
|
-
* ```ts
|
|
83
|
-
* const result = await client.recordings.get(123);
|
|
84
|
-
* ```
|
|
85
|
-
*/
|
|
86
|
-
async get(recordingId: number): Promise<Recording> {
|
|
87
|
-
const response = await this.request(
|
|
88
|
-
{
|
|
89
|
-
service: "Recordings",
|
|
90
|
-
operation: "GetRecording",
|
|
91
|
-
resourceType: "recording",
|
|
92
|
-
isMutation: false,
|
|
93
|
-
resourceId: recordingId,
|
|
94
|
-
},
|
|
95
|
-
() =>
|
|
96
|
-
this.client.GET("/recordings/{recordingId}", {
|
|
97
|
-
params: {
|
|
98
|
-
path: { recordingId },
|
|
99
|
-
},
|
|
100
|
-
})
|
|
101
|
-
);
|
|
102
|
-
return response;
|
|
103
|
-
}
|
|
104
|
-
|
|
105
77
|
/**
|
|
106
78
|
* Unarchive a recording (restore to active status)
|
|
107
79
|
* @param recordingId - The recording ID
|
|
@@ -15,15 +15,8 @@ export type Person = components["schemas"]["Person"];
|
|
|
15
15
|
* Options for progress.
|
|
16
16
|
*/
|
|
17
17
|
export interface ProgressReportOptions extends PaginationOptions {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
* Options for upcoming.
|
|
21
|
-
*/
|
|
22
|
-
export interface UpcomingReportOptions {
|
|
23
|
-
/** Window starts on */
|
|
24
|
-
windowStartsOn?: string;
|
|
25
|
-
/** Window ends on */
|
|
26
|
-
windowEndsOn?: string;
|
|
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;
|
|
27
20
|
}
|
|
28
21
|
/**
|
|
29
22
|
* Options for assigned.
|
|
@@ -36,6 +29,8 @@ export interface AssignedReportOptions {
|
|
|
36
29
|
* Options for personProgress.
|
|
37
30
|
*/
|
|
38
31
|
export interface PersonProgressReportOptions extends PaginationOptions {
|
|
32
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
33
|
+
page?: number;
|
|
39
34
|
}
|
|
40
35
|
/**
|
|
41
36
|
* Service for Reports operations.
|
|
@@ -54,15 +49,16 @@ export declare class ReportsService extends BaseService {
|
|
|
54
49
|
progress(options?: ProgressReportOptions): Promise<ListResult<TimelineEvent>>;
|
|
55
50
|
/**
|
|
56
51
|
* Get upcoming schedule entries and assignable items within a date window.
|
|
57
|
-
* @param
|
|
52
|
+
* @param windowStartsOn - Inclusive first day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
53
|
+
* @param windowEndsOn - Inclusive last day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
58
54
|
* @returns The upcoming_schedule
|
|
59
55
|
*
|
|
60
56
|
* @example
|
|
61
57
|
* ```ts
|
|
62
|
-
* const result = await client.reports.upcoming();
|
|
58
|
+
* const result = await client.reports.upcoming("window_starts_on", "window_ends_on");
|
|
63
59
|
* ```
|
|
64
60
|
*/
|
|
65
|
-
upcoming(
|
|
61
|
+
upcoming(windowStartsOn: string, windowEndsOn: string): Promise<components["schemas"]["GetUpcomingScheduleResponseContent"]>;
|
|
66
62
|
/**
|
|
67
63
|
* Get todos assigned to a specific person
|
|
68
64
|
* @param personId - The person ID
|
|
@@ -1 +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;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;AACnE,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;
|
|
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;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;AACnE,2CAA2C;AAC3C,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAE7C;;;;;;;;;OASG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAkBnF;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,oCAAoC,CAAC,CAAC;IAkBlI;;;;;;;;;;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;;;;;;;;;;OAUG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;KAAE,CAAC;CAmB9I"}
|
|
@@ -27,19 +27,24 @@ export class ReportsService extends BaseService {
|
|
|
27
27
|
operation: "GetProgressReport",
|
|
28
28
|
resourceType: "progress_report",
|
|
29
29
|
isMutation: false,
|
|
30
|
-
}, () => this.client.GET("/reports/progress.json", {
|
|
30
|
+
}, () => this.client.GET("/reports/progress.json", {
|
|
31
|
+
params: {
|
|
32
|
+
query: { page: options?.page },
|
|
33
|
+
},
|
|
34
|
+
}), options);
|
|
31
35
|
}
|
|
32
36
|
/**
|
|
33
37
|
* Get upcoming schedule entries and assignable items within a date window.
|
|
34
|
-
* @param
|
|
38
|
+
* @param windowStartsOn - Inclusive first day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
39
|
+
* @param windowEndsOn - Inclusive last day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
35
40
|
* @returns The upcoming_schedule
|
|
36
41
|
*
|
|
37
42
|
* @example
|
|
38
43
|
* ```ts
|
|
39
|
-
* const result = await client.reports.upcoming();
|
|
44
|
+
* const result = await client.reports.upcoming("window_starts_on", "window_ends_on");
|
|
40
45
|
* ```
|
|
41
46
|
*/
|
|
42
|
-
async upcoming(
|
|
47
|
+
async upcoming(windowStartsOn, windowEndsOn) {
|
|
43
48
|
const response = await this.request({
|
|
44
49
|
service: "Reports",
|
|
45
50
|
operation: "GetUpcomingSchedule",
|
|
@@ -47,7 +52,7 @@ export class ReportsService extends BaseService {
|
|
|
47
52
|
isMutation: false,
|
|
48
53
|
}, () => this.client.GET("/reports/schedules/upcoming.json", {
|
|
49
54
|
params: {
|
|
50
|
-
query: { "window_starts_on":
|
|
55
|
+
query: { "window_starts_on": windowStartsOn, "window_ends_on": windowEndsOn },
|
|
51
56
|
},
|
|
52
57
|
}));
|
|
53
58
|
return response;
|
|
@@ -117,6 +122,7 @@ export class ReportsService extends BaseService {
|
|
|
117
122
|
}, () => this.client.GET("/reports/users/progress/{personId}.json", {
|
|
118
123
|
params: {
|
|
119
124
|
path: { personId },
|
|
125
|
+
query: { page: options?.page },
|
|
120
126
|
},
|
|
121
127
|
}), "events", options);
|
|
122
128
|
}
|
|
@@ -1 +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;
|
|
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;AAuCrD,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;YACxC,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,cAAsB,EAAE,YAAoB;QACzD,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,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE;aAC9E;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;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAqC;QAC1E,OAAO,IAAI,CAAC,uBAAuB,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,yCAAyC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;gBAClB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAC/B;SACF,CAAC,EACF,QAAQ,EAAE,OAAO,CACgD,CAAC;IACxE,CAAC;CACF"}
|
|
@@ -22,16 +22,8 @@ export type Person = components["schemas"]["Person"];
|
|
|
22
22
|
* Options for progress.
|
|
23
23
|
*/
|
|
24
24
|
export interface ProgressReportOptions extends PaginationOptions {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Options for upcoming.
|
|
29
|
-
*/
|
|
30
|
-
export interface UpcomingReportOptions {
|
|
31
|
-
/** Window starts on */
|
|
32
|
-
windowStartsOn?: string;
|
|
33
|
-
/** Window ends on */
|
|
34
|
-
windowEndsOn?: string;
|
|
25
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
26
|
+
page?: number;
|
|
35
27
|
}
|
|
36
28
|
|
|
37
29
|
/**
|
|
@@ -46,6 +38,8 @@ export interface AssignedReportOptions {
|
|
|
46
38
|
* Options for personProgress.
|
|
47
39
|
*/
|
|
48
40
|
export interface PersonProgressReportOptions extends PaginationOptions {
|
|
41
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
42
|
+
page?: number;
|
|
49
43
|
}
|
|
50
44
|
|
|
51
45
|
|
|
@@ -78,6 +72,9 @@ export class ReportsService extends BaseService {
|
|
|
78
72
|
},
|
|
79
73
|
() =>
|
|
80
74
|
this.client.GET("/reports/progress.json", {
|
|
75
|
+
params: {
|
|
76
|
+
query: { page: options?.page },
|
|
77
|
+
},
|
|
81
78
|
})
|
|
82
79
|
, options
|
|
83
80
|
);
|
|
@@ -85,15 +82,16 @@ export class ReportsService extends BaseService {
|
|
|
85
82
|
|
|
86
83
|
/**
|
|
87
84
|
* Get upcoming schedule entries and assignable items within a date window.
|
|
88
|
-
* @param
|
|
85
|
+
* @param windowStartsOn - Inclusive first day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
86
|
+
* @param windowEndsOn - Inclusive last day of the window, `YYYY-MM-DD`. Required — BC3 answers 400 without it.
|
|
89
87
|
* @returns The upcoming_schedule
|
|
90
88
|
*
|
|
91
89
|
* @example
|
|
92
90
|
* ```ts
|
|
93
|
-
* const result = await client.reports.upcoming();
|
|
91
|
+
* const result = await client.reports.upcoming("window_starts_on", "window_ends_on");
|
|
94
92
|
* ```
|
|
95
93
|
*/
|
|
96
|
-
async upcoming(
|
|
94
|
+
async upcoming(windowStartsOn: string, windowEndsOn: string): Promise<components["schemas"]["GetUpcomingScheduleResponseContent"]> {
|
|
97
95
|
const response = await this.request(
|
|
98
96
|
{
|
|
99
97
|
service: "Reports",
|
|
@@ -104,7 +102,7 @@ export class ReportsService extends BaseService {
|
|
|
104
102
|
() =>
|
|
105
103
|
this.client.GET("/reports/schedules/upcoming.json", {
|
|
106
104
|
params: {
|
|
107
|
-
query: { "window_starts_on":
|
|
105
|
+
query: { "window_starts_on": windowStartsOn, "window_ends_on": windowEndsOn },
|
|
108
106
|
},
|
|
109
107
|
})
|
|
110
108
|
);
|
|
@@ -190,6 +188,7 @@ export class ReportsService extends BaseService {
|
|
|
190
188
|
this.client.GET("/reports/users/progress/{personId}.json", {
|
|
191
189
|
params: {
|
|
192
190
|
path: { personId },
|
|
191
|
+
query: { page: options?.page },
|
|
193
192
|
},
|
|
194
193
|
})
|
|
195
194
|
, "events", options
|
|
@@ -12,15 +12,17 @@ export type ScheduleEntry = components["schemas"]["ScheduleEntry"];
|
|
|
12
12
|
/** Schedule entity from the Basecamp API. */
|
|
13
13
|
export type Schedule = components["schemas"]["Schedule"];
|
|
14
14
|
/**
|
|
15
|
-
* Request parameters for
|
|
15
|
+
* Request parameters for replaceEntry.
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface ReplaceEntryScheduleRequest {
|
|
18
18
|
/** Summary text */
|
|
19
19
|
summary?: string;
|
|
20
|
-
/**
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
/** The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
|
|
21
|
+
full timestamp otherwise. Same rule as CreateScheduleEntry: send it
|
|
22
|
+
verbatim, never parsed and re-rendered. */
|
|
23
|
+
startsAt: string;
|
|
24
|
+
/** The entry's end. See starts_at for the date-vs-timestamp rule. */
|
|
25
|
+
endsAt: string;
|
|
24
26
|
/** Rich text description (HTML) */
|
|
25
27
|
description?: string;
|
|
26
28
|
/** Replaces the entry's participants.
|
|
@@ -33,10 +35,36 @@ export interface UpdateEntryScheduleRequest {
|
|
|
33
35
|
silently removed every participant and notified each one. The controller
|
|
34
36
|
now guards on the request actually addressing participants. */
|
|
35
37
|
participantIds?: number[];
|
|
36
|
-
/**
|
|
38
|
+
/** Whether the entry occupies whole days rather than a time range.
|
|
39
|
+
|
|
40
|
+
Not carved out, and the carve-out list is what makes that dangerous to
|
|
41
|
+
forget: `schedule_entries.all_day` is NOT NULL with a `false` default, so
|
|
42
|
+
omitting this member on a replace resets it — silently converting an
|
|
43
|
+
all-day entry into a midnight-to-midnight timed one. The SDK's merge-safe
|
|
44
|
+
update and edit resend it from the read-back for exactly this reason.
|
|
45
|
+
|
|
46
|
+
Sending an explicit null is worse than omitting it: the column rejects
|
|
47
|
+
NULL, so BC3 raises rather than falling back to the default. The same is
|
|
48
|
+
true of highlighted. */
|
|
37
49
|
allDay?: boolean;
|
|
38
50
|
/** Whether to send notifications to relevant people */
|
|
39
51
|
notify?: boolean;
|
|
52
|
+
/** The entry's join link — a video-call URL or similar, up to 2500
|
|
53
|
+
characters, validated as a URL when present.
|
|
54
|
+
|
|
55
|
+
Omitting this member preserves the current join link; sending an empty
|
|
56
|
+
string clears it. Read it back as `join_url`, never as `url`: the entry's
|
|
57
|
+
`url` is its own Basecamp API URL, written by a partial that renders
|
|
58
|
+
before this one, so BC3 emits the join link under a non-colliding key.
|
|
59
|
+
Echoing the response's `url` into this member would write the API URL into
|
|
60
|
+
the join link. */
|
|
61
|
+
url?: string;
|
|
62
|
+
/** Whether the entry is highlighted on the schedule.
|
|
63
|
+
|
|
64
|
+
Omitting this member preserves the current highlight; sending false
|
|
65
|
+
removes it. Preserved on omission because until basecamp/bc3#12502 the
|
|
66
|
+
field was writable but never returned, so no caller could resend it. */
|
|
67
|
+
highlighted?: boolean;
|
|
40
68
|
}
|
|
41
69
|
/**
|
|
42
70
|
* Request parameters for updateSettings.
|
|
@@ -51,6 +79,8 @@ export interface UpdateSettingsScheduleRequest {
|
|
|
51
79
|
export interface ListEntriesScheduleOptions extends PaginationOptions {
|
|
52
80
|
/** Filter by status */
|
|
53
81
|
status?: "active" | "archived" | "trashed";
|
|
82
|
+
/** Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8. */
|
|
83
|
+
page?: number;
|
|
54
84
|
}
|
|
55
85
|
/**
|
|
56
86
|
* Request parameters for createEntry.
|
|
@@ -58,9 +88,21 @@ export interface ListEntriesScheduleOptions extends PaginationOptions {
|
|
|
58
88
|
export interface CreateEntryScheduleRequest {
|
|
59
89
|
/** Summary text */
|
|
60
90
|
summary: string;
|
|
61
|
-
/**
|
|
91
|
+
/** The entry's start, as a bare date ("2026-06-01") for an all-day entry or a
|
|
92
|
+
full timestamp ("2026-06-01T09:00:00Z") otherwise — the same two forms the
|
|
93
|
+
response renders, and the same two ReplaceScheduleEntry accepts.
|
|
94
|
+
|
|
95
|
+
Create and replace share one permit list:
|
|
96
|
+
`Schedules::Entries::BaseController#base_schedule_entry_params` is what
|
|
97
|
+
both `new_schedule_entry_params` and `update_schedule_entry_params` call,
|
|
98
|
+
and Schedule::Entry does no format-specific parsing of either bound, so
|
|
99
|
+
whatever one operation takes the other takes too.
|
|
100
|
+
|
|
101
|
+
Treat the value as opaque and send it verbatim. Parsing it into a
|
|
102
|
+
date-time type and re-rendering rewrites an all-day entry's bounds into
|
|
103
|
+
midnight timestamps, which is why every SDK models it as a string. */
|
|
62
104
|
startsAt: string;
|
|
63
|
-
/**
|
|
105
|
+
/** The entry's end. See starts_at for the date-vs-timestamp rule. */
|
|
64
106
|
endsAt: string;
|
|
65
107
|
/** Rich text description (HTML) */
|
|
66
108
|
description?: string;
|
|
@@ -70,6 +112,43 @@ export interface CreateEntryScheduleRequest {
|
|
|
70
112
|
allDay?: boolean;
|
|
71
113
|
/** Whether to send notifications to relevant people */
|
|
72
114
|
notify?: boolean;
|
|
115
|
+
/** The entry's join link — a video-call URL or similar, up to 2500
|
|
116
|
+
characters, validated as a URL when present. A scheme-less value is
|
|
117
|
+
normalized to `https://`.
|
|
118
|
+
|
|
119
|
+
Spell it `url` on the way in and read it back as `join_url`: the response
|
|
120
|
+
key `url` is the entry's own Basecamp API URL, written by a partial that
|
|
121
|
+
renders before this field, so BC3 emits the join link under a
|
|
122
|
+
non-colliding name. Sending `join_url` instead is silently dropped by
|
|
123
|
+
strong parameters — the create succeeds with no join link.
|
|
124
|
+
|
|
125
|
+
Accepted on create since long before it was documented:
|
|
126
|
+
`Schedules::Entries::BaseController#base_schedule_entry_params` permits it
|
|
127
|
+
and `new_schedule_entry_params` passes it through unchanged for API
|
|
128
|
+
requests. Modeling it only on ReplaceScheduleEntry forced callers into a
|
|
129
|
+
three-request read-modify-write for a field the create already took — and
|
|
130
|
+
create is the notifying write, so participants learned about a video call
|
|
131
|
+
before its link existed. */
|
|
132
|
+
url?: string;
|
|
133
|
+
/** Whether the entry is highlighted on the schedule. Defaults to false.
|
|
134
|
+
|
|
135
|
+
Do not send an explicit null: `schedule_entries.highlighted` is NOT NULL,
|
|
136
|
+
so BC3 raises rather than falling back to the default. Omit it instead —
|
|
137
|
+
every SDK's request compactor already drops unset members. */
|
|
138
|
+
highlighted?: boolean;
|
|
139
|
+
/** Publication state at creation — `active|drafted`, defaulting to `active`
|
|
140
|
+
for an API create.
|
|
141
|
+
|
|
142
|
+
A top-level parameter, not part of the entry's attributes: `status` is a
|
|
143
|
+
Recording column, so `wrap_parameters` leaves it outside the
|
|
144
|
+
`schedule_entry` envelope and `Recording::StatusParam#status_param` reads
|
|
145
|
+
it directly. On create it accepts `drafted`, `active`, `archived` or
|
|
146
|
+
`trashed` and raises `ActionController::BadRequest` — a 400, not a 422 —
|
|
147
|
+
for anything else; the two documented values are the two worth sending.
|
|
148
|
+
|
|
149
|
+
Unlike messages and documents, schedule-entry drafts are not listed by
|
|
150
|
+
GetMyDrafts. */
|
|
151
|
+
status?: string;
|
|
73
152
|
/** Subscriptions */
|
|
74
153
|
subscriptions?: number[];
|
|
75
154
|
/** Visible to clients */
|
|
@@ -92,18 +171,18 @@ export declare class SchedulesService extends BaseService {
|
|
|
92
171
|
*/
|
|
93
172
|
getEntry(entryId: number): Promise<ScheduleEntry>;
|
|
94
173
|
/**
|
|
95
|
-
*
|
|
174
|
+
* Replace a schedule entry with a new complete representation.
|
|
96
175
|
* @param entryId - The entry ID
|
|
97
|
-
* @param req - Schedule_entry
|
|
176
|
+
* @param req - Schedule_entry request parameters
|
|
98
177
|
* @returns The ScheduleEntry
|
|
99
|
-
* @throws {BasecampError} If the
|
|
178
|
+
* @throws {BasecampError} If the request fails
|
|
100
179
|
*
|
|
101
180
|
* @example
|
|
102
181
|
* ```ts
|
|
103
|
-
* const result = await client.schedules.
|
|
182
|
+
* const result = await client.schedules.replaceEntry(123, { startsAt: "example", endsAt: "example" });
|
|
104
183
|
* ```
|
|
105
184
|
*/
|
|
106
|
-
|
|
185
|
+
replaceEntry(entryId: number, req: ReplaceEntryScheduleRequest): Promise<ScheduleEntry>;
|
|
107
186
|
/**
|
|
108
187
|
* Get a specific occurrence of a recurring schedule entry
|
|
109
188
|
* @param entryId - The entry ID
|
|
@@ -166,7 +245,7 @@ export declare class SchedulesService extends BaseService {
|
|
|
166
245
|
*
|
|
167
246
|
* @example
|
|
168
247
|
* ```ts
|
|
169
|
-
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "
|
|
248
|
+
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "example", endsAt: "example" });
|
|
170
249
|
* ```
|
|
171
250
|
*/
|
|
172
251
|
createEntry(scheduleId: number, req: CreateEntryScheduleRequest): Promise<ScheduleEntry>;
|
|
@@ -1 +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,
|
|
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,2BAA2B;IAC1C,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;4CAEwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;gEAQ4D;IAC5D,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;;;;;yBAUqB;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;;mBAQe;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;yEAIqE;IACrE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;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;IAC3C,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;uEAYmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,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;IACjB;;;;;;;;;;;;;;;;6BAgByB;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;+DAI2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;iBAWa;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,yBAAyB;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBvD;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAoC7F;;;;;;;;;;;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;CAyC/F"}
|
|
@@ -38,21 +38,27 @@ export class SchedulesService extends BaseService {
|
|
|
38
38
|
return response;
|
|
39
39
|
}
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Replace a schedule entry with a new complete representation.
|
|
42
42
|
* @param entryId - The entry ID
|
|
43
|
-
* @param req - Schedule_entry
|
|
43
|
+
* @param req - Schedule_entry request parameters
|
|
44
44
|
* @returns The ScheduleEntry
|
|
45
|
-
* @throws {BasecampError} If the
|
|
45
|
+
* @throws {BasecampError} If the request fails
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* ```ts
|
|
49
|
-
* const result = await client.schedules.
|
|
49
|
+
* const result = await client.schedules.replaceEntry(123, { startsAt: "example", endsAt: "example" });
|
|
50
50
|
* ```
|
|
51
51
|
*/
|
|
52
|
-
async
|
|
52
|
+
async replaceEntry(entryId, req) {
|
|
53
|
+
if (!req.startsAt) {
|
|
54
|
+
throw Errors.validation("Starts at is required");
|
|
55
|
+
}
|
|
56
|
+
if (!req.endsAt) {
|
|
57
|
+
throw Errors.validation("Ends at is required");
|
|
58
|
+
}
|
|
53
59
|
const response = await this.request({
|
|
54
60
|
service: "Schedules",
|
|
55
|
-
operation: "
|
|
61
|
+
operation: "ReplaceScheduleEntry",
|
|
56
62
|
resourceType: "schedule_entry",
|
|
57
63
|
isMutation: true,
|
|
58
64
|
resourceId: entryId,
|
|
@@ -68,6 +74,8 @@ export class SchedulesService extends BaseService {
|
|
|
68
74
|
participant_ids: req.participantIds,
|
|
69
75
|
all_day: req.allDay,
|
|
70
76
|
notify: req.notify,
|
|
77
|
+
url: req.url,
|
|
78
|
+
highlighted: req.highlighted,
|
|
71
79
|
},
|
|
72
80
|
}));
|
|
73
81
|
return response;
|
|
@@ -176,7 +184,7 @@ export class SchedulesService extends BaseService {
|
|
|
176
184
|
}, () => this.client.GET("/schedules/{scheduleId}/entries.json", {
|
|
177
185
|
params: {
|
|
178
186
|
path: { scheduleId },
|
|
179
|
-
query: { status: options?.status },
|
|
187
|
+
query: { status: options?.status, page: options?.page },
|
|
180
188
|
},
|
|
181
189
|
}), options);
|
|
182
190
|
}
|
|
@@ -189,7 +197,7 @@ export class SchedulesService extends BaseService {
|
|
|
189
197
|
*
|
|
190
198
|
* @example
|
|
191
199
|
* ```ts
|
|
192
|
-
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "
|
|
200
|
+
* const result = await client.schedules.createEntry(123, { summary: "example", startsAt: "example", endsAt: "example" });
|
|
193
201
|
* ```
|
|
194
202
|
*/
|
|
195
203
|
async createEntry(scheduleId, req) {
|
|
@@ -220,6 +228,9 @@ export class SchedulesService extends BaseService {
|
|
|
220
228
|
participant_ids: req.participantIds,
|
|
221
229
|
all_day: req.allDay,
|
|
222
230
|
notify: req.notify,
|
|
231
|
+
url: req.url,
|
|
232
|
+
highlighted: req.highlighted,
|
|
233
|
+
status: req.status,
|
|
223
234
|
subscriptions: req.subscriptions,
|
|
224
235
|
visible_to_clients: req.visibleToClients,
|
|
225
236
|
},
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schedules.js","sourceRoot":"","sources":["../../../src/generated/services/schedules.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":"schedules.js","sourceRoot":"","sources":["../../../src/generated/services/schedules.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AA+JzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,kBAAkB;YAC7B,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,GAAgC;QAClE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,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,sBAAsB;YACjC,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,SAAS,EAAE,GAAG,CAAC,QAAQ;gBACvB,OAAO,EAAE,GAAG,CAAC,MAAM;gBACnB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,eAAe,EAAE,GAAG,CAAC,cAAc;gBACnC,OAAO,EAAE,GAAG,CAAC,MAAM;gBACnB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,WAAW,EAAE,GAAG,CAAC,WAAW;aAC7B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAe,EAAE,IAAY;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,4BAA4B;YACvC,YAAY,EAAE,2BAA2B;YACzC,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE;YAChE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;aACxB;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,cAAc,CAAC,UAAkB,EAAE,GAAkC;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,wBAAwB;YACnC,YAAY,EAAE,kBAAkB;YAChC,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,uBAAuB,EAAE,GAAG,CAAC,qBAAqB;aACnD;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB,EAAE,OAAoC;QACxE,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sCAAsC,EAAE;YACtD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;gBACpB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aACxD;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB,EAAE,GAA+B;QACnE,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YAChB,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,qBAAqB;YAChC,YAAY,EAAE,gBAAgB;YAC9B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,UAAU;SACvB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,UAAU,EAAE;aACrB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,SAAS,EAAE,GAAG,CAAC,QAAQ;gBACvB,OAAO,EAAE,GAAG,CAAC,MAAM;gBACnB,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,eAAe,EAAE,GAAG,CAAC,cAAc;gBACnC,OAAO,EAAE,GAAG,CAAC,MAAM;gBACnB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,GAAG;gBACZ,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,aAAa,EAAE,GAAG,CAAC,aAAa;gBAChC,kBAAkB,EAAE,GAAG,CAAC,gBAAgB;aACzC;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|