@37signals/basecamp 0.8.0 → 0.10.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 +3 -2
- package/dist/client.d.ts +9 -3
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +35 -13
- package/dist/client.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +343 -12
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +343 -12
- package/dist/generated/openapi-stripped.json +7127 -3763
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +27 -5
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +27 -5
- package/dist/generated/schema.d.ts +2911 -503
- package/dist/generated/services/boosts.d.ts +13 -10
- package/dist/generated/services/boosts.d.ts.map +1 -1
- package/dist/generated/services/boosts.js +5 -5
- package/dist/generated/services/boosts.js.map +1 -1
- package/dist/generated/services/boosts.ts +12 -10
- package/dist/generated/services/card-columns.d.ts.map +1 -1
- package/dist/generated/services/card-columns.js +3 -0
- package/dist/generated/services/card-columns.js.map +1 -1
- package/dist/generated/services/card-columns.ts +3 -0
- package/dist/generated/services/cards.d.ts +4 -4
- package/dist/generated/services/cards.d.ts.map +1 -1
- package/dist/generated/services/cards.js +2 -2
- package/dist/generated/services/cards.js.map +1 -1
- package/dist/generated/services/cards.ts +4 -4
- package/dist/generated/services/checkins.d.ts +3 -1
- package/dist/generated/services/checkins.d.ts.map +1 -1
- package/dist/generated/services/checkins.js +2 -1
- package/dist/generated/services/checkins.js.map +1 -1
- package/dist/generated/services/checkins.ts +4 -1
- package/dist/generated/services/documents.d.ts +2 -0
- package/dist/generated/services/documents.d.ts.map +1 -1
- package/dist/generated/services/documents.js +1 -0
- package/dist/generated/services/documents.js.map +1 -1
- package/dist/generated/services/documents.ts +3 -0
- package/dist/generated/services/everything.d.ts +323 -0
- package/dist/generated/services/everything.d.ts.map +1 -0
- package/dist/generated/services/everything.js +381 -0
- package/dist/generated/services/everything.js.map +1 -0
- package/dist/generated/services/everything.ts +632 -0
- package/dist/generated/services/gauges.d.ts +2 -2
- package/dist/generated/services/gauges.js +2 -2
- package/dist/generated/services/gauges.ts +2 -2
- package/dist/generated/services/index.d.ts +3 -1
- package/dist/generated/services/index.d.ts.map +1 -1
- package/dist/generated/services/index.js +3 -1
- package/dist/generated/services/index.js.map +1 -1
- package/dist/generated/services/index.ts +3 -1
- package/dist/generated/services/message-types.d.ts +15 -10
- package/dist/generated/services/message-types.d.ts.map +1 -1
- package/dist/generated/services/message-types.js +35 -18
- package/dist/generated/services/message-types.js.map +1 -1
- package/dist/generated/services/message-types.ts +34 -18
- 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 -0
- package/dist/generated/services/messages.js.map +1 -1
- package/dist/generated/services/messages.ts +3 -0
- package/dist/generated/services/my-notifications.d.ts +27 -0
- package/dist/generated/services/my-notifications.d.ts.map +1 -1
- package/dist/generated/services/my-notifications.js +23 -1
- package/dist/generated/services/my-notifications.js.map +1 -1
- package/dist/generated/services/my-notifications.ts +46 -1
- package/dist/generated/services/people.d.ts +2 -2
- package/dist/generated/services/people.js +2 -2
- package/dist/generated/services/people.ts +2 -2
- package/dist/generated/services/recordings.d.ts +2 -2
- package/dist/generated/services/recordings.d.ts.map +1 -1
- package/dist/generated/services/recordings.js +1 -1
- package/dist/generated/services/recordings.js.map +1 -1
- package/dist/generated/services/recordings.ts +2 -2
- package/dist/generated/services/schedules.d.ts +11 -1
- package/dist/generated/services/schedules.d.ts.map +1 -1
- package/dist/generated/services/schedules.js +1 -0
- package/dist/generated/services/schedules.js.map +1 -1
- package/dist/generated/services/schedules.ts +12 -1
- package/dist/generated/services/search.d.ts +30 -1
- 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 +31 -2
- package/dist/generated/services/templates.d.ts +3 -5
- package/dist/generated/services/templates.d.ts.map +1 -1
- package/dist/generated/services/templates.js +4 -5
- package/dist/generated/services/templates.js.map +1 -1
- package/dist/generated/services/templates.ts +6 -9
- package/dist/generated/services/todolists.d.ts +22 -0
- package/dist/generated/services/todolists.d.ts.map +1 -1
- package/dist/generated/services/todolists.js +31 -0
- package/dist/generated/services/todolists.js.map +1 -1
- package/dist/generated/services/todolists.ts +46 -0
- package/dist/generated/services/tools.d.ts +2 -0
- package/dist/generated/services/tools.d.ts.map +1 -1
- package/dist/generated/services/tools.js +2 -1
- package/dist/generated/services/tools.js.map +1 -1
- package/dist/generated/services/tools.ts +4 -1
- package/dist/generated/services/uploads.d.ts +2 -0
- package/dist/generated/services/uploads.d.ts.map +1 -1
- package/dist/generated/services/uploads.js +1 -0
- package/dist/generated/services/uploads.js.map +1 -1
- package/dist/generated/services/uploads.ts +3 -0
- package/dist/generated/services/webhooks.js +2 -2
- package/dist/generated/services/webhooks.js.map +1 -1
- package/dist/generated/services/webhooks.ts +2 -2
- package/dist/generated/services/wormholes.d.ts +70 -0
- package/dist/generated/services/wormholes.d.ts.map +1 -0
- package/dist/generated/services/wormholes.js +103 -0
- package/dist/generated/services/wormholes.js.map +1 -0
- package/dist/generated/services/wormholes.ts +145 -0
- package/dist/index.d.ts +6 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -1
- package/dist/index.js.map +1 -1
- package/dist/services/cards-extensions.d.ts +76 -0
- package/dist/services/cards-extensions.d.ts.map +1 -0
- package/dist/services/cards-extensions.js +67 -0
- package/dist/services/cards-extensions.js.map +1 -0
- package/package.json +2 -2
- package/src/generated/metadata.ts +343 -12
- package/src/generated/openapi-stripped.json +7127 -3763
- package/src/generated/path-mapping.ts +27 -5
- package/src/generated/schema.d.ts +2911 -503
- package/src/generated/services/boosts.ts +12 -10
- package/src/generated/services/card-columns.ts +3 -0
- package/src/generated/services/cards.ts +4 -4
- package/src/generated/services/checkins.ts +4 -1
- package/src/generated/services/documents.ts +3 -0
- package/src/generated/services/everything.ts +632 -0
- package/src/generated/services/gauges.ts +2 -2
- package/src/generated/services/index.ts +3 -1
- package/src/generated/services/message-types.ts +34 -18
- package/src/generated/services/messages.ts +3 -0
- package/src/generated/services/my-notifications.ts +46 -1
- package/src/generated/services/people.ts +2 -2
- package/src/generated/services/recordings.ts +2 -2
- package/src/generated/services/schedules.ts +12 -1
- package/src/generated/services/search.ts +31 -2
- package/src/generated/services/templates.ts +6 -9
- package/src/generated/services/todolists.ts +46 -0
- package/src/generated/services/tools.ts +4 -1
- package/src/generated/services/uploads.ts +3 -0
- package/src/generated/services/webhooks.ts +2 -2
- package/src/generated/services/wormholes.ts +145 -0
|
@@ -14,6 +14,8 @@ import { Errors } from "../../errors.js";
|
|
|
14
14
|
// Types
|
|
15
15
|
// =============================================================================
|
|
16
16
|
|
|
17
|
+
/** Boost entity from the Basecamp API. */
|
|
18
|
+
export type Boost = components["schemas"]["Boost"];
|
|
17
19
|
|
|
18
20
|
/**
|
|
19
21
|
* Options for listForRecording.
|
|
@@ -56,7 +58,7 @@ export class BoostsService extends BaseService {
|
|
|
56
58
|
/**
|
|
57
59
|
* Get a single boost
|
|
58
60
|
* @param boostId - The boost ID
|
|
59
|
-
* @returns The
|
|
61
|
+
* @returns The Boost
|
|
60
62
|
* @throws {BasecampError} If the resource is not found
|
|
61
63
|
*
|
|
62
64
|
* @example
|
|
@@ -64,7 +66,7 @@ export class BoostsService extends BaseService {
|
|
|
64
66
|
* const result = await client.boosts.get(123);
|
|
65
67
|
* ```
|
|
66
68
|
*/
|
|
67
|
-
async get(boostId: number): Promise<
|
|
69
|
+
async get(boostId: number): Promise<Boost> {
|
|
68
70
|
const response = await this.request(
|
|
69
71
|
{
|
|
70
72
|
service: "Boosts",
|
|
@@ -116,14 +118,14 @@ export class BoostsService extends BaseService {
|
|
|
116
118
|
* List boosts on a recording
|
|
117
119
|
* @param recordingId - The recording ID
|
|
118
120
|
* @param options - Optional query parameters
|
|
119
|
-
* @returns All
|
|
121
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
120
122
|
*
|
|
121
123
|
* @example
|
|
122
124
|
* ```ts
|
|
123
125
|
* const result = await client.boosts.listForRecording(123);
|
|
124
126
|
* ```
|
|
125
127
|
*/
|
|
126
|
-
async listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<
|
|
128
|
+
async listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<ListResult<Boost>> {
|
|
127
129
|
return this.requestPaginated(
|
|
128
130
|
{
|
|
129
131
|
service: "Boosts",
|
|
@@ -146,7 +148,7 @@ export class BoostsService extends BaseService {
|
|
|
146
148
|
* Create a boost on a recording
|
|
147
149
|
* @param recordingId - The recording ID
|
|
148
150
|
* @param req - Recording_boost creation parameters
|
|
149
|
-
* @returns The
|
|
151
|
+
* @returns The Boost
|
|
150
152
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
151
153
|
*
|
|
152
154
|
* @example
|
|
@@ -154,7 +156,7 @@ export class BoostsService extends BaseService {
|
|
|
154
156
|
* const result = await client.boosts.createForRecording(123, { content: "Hello world" });
|
|
155
157
|
* ```
|
|
156
158
|
*/
|
|
157
|
-
async createForRecording(recordingId: number, req: CreateForRecordingBoostRequest): Promise<
|
|
159
|
+
async createForRecording(recordingId: number, req: CreateForRecordingBoostRequest): Promise<Boost> {
|
|
158
160
|
if (!req.content) {
|
|
159
161
|
throw Errors.validation("Content is required");
|
|
160
162
|
}
|
|
@@ -184,14 +186,14 @@ export class BoostsService extends BaseService {
|
|
|
184
186
|
* @param recordingId - The recording ID
|
|
185
187
|
* @param eventId - The event ID
|
|
186
188
|
* @param options - Optional query parameters
|
|
187
|
-
* @returns All
|
|
189
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
188
190
|
*
|
|
189
191
|
* @example
|
|
190
192
|
* ```ts
|
|
191
193
|
* const result = await client.boosts.listForEvent(123, 123);
|
|
192
194
|
* ```
|
|
193
195
|
*/
|
|
194
|
-
async listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<
|
|
196
|
+
async listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<ListResult<Boost>> {
|
|
195
197
|
return this.requestPaginated(
|
|
196
198
|
{
|
|
197
199
|
service: "Boosts",
|
|
@@ -215,7 +217,7 @@ export class BoostsService extends BaseService {
|
|
|
215
217
|
* @param recordingId - The recording ID
|
|
216
218
|
* @param eventId - The event ID
|
|
217
219
|
* @param req - Event_boost creation parameters
|
|
218
|
-
* @returns The
|
|
220
|
+
* @returns The Boost
|
|
219
221
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
220
222
|
*
|
|
221
223
|
* @example
|
|
@@ -223,7 +225,7 @@ export class BoostsService extends BaseService {
|
|
|
223
225
|
* const result = await client.boosts.createForEvent(123, 123, { content: "Hello world" });
|
|
224
226
|
* ```
|
|
225
227
|
*/
|
|
226
|
-
async createForEvent(recordingId: number, eventId: number, req: CreateForEventBoostRequest): Promise<
|
|
228
|
+
async createForEvent(recordingId: number, eventId: number, req: CreateForEventBoostRequest): Promise<Boost> {
|
|
227
229
|
if (!req.content) {
|
|
228
230
|
throw Errors.validation("Content is required");
|
|
229
231
|
}
|
|
@@ -88,6 +88,7 @@ export class CardColumnsService extends BaseService {
|
|
|
88
88
|
operation: "SetCardColumnColor",
|
|
89
89
|
resourceType: "card_column_color",
|
|
90
90
|
isMutation: true,
|
|
91
|
+
projectId: bucketId,
|
|
91
92
|
resourceId: columnId,
|
|
92
93
|
},
|
|
93
94
|
() =>
|
|
@@ -122,6 +123,7 @@ export class CardColumnsService extends BaseService {
|
|
|
122
123
|
operation: "EnableCardColumnOnHold",
|
|
123
124
|
resourceType: "card_column_on_hold",
|
|
124
125
|
isMutation: true,
|
|
126
|
+
projectId: bucketId,
|
|
125
127
|
resourceId: columnId,
|
|
126
128
|
},
|
|
127
129
|
() =>
|
|
@@ -153,6 +155,7 @@ export class CardColumnsService extends BaseService {
|
|
|
153
155
|
operation: "DisableCardColumnOnHold",
|
|
154
156
|
resourceType: "card_column_on_hold",
|
|
155
157
|
isMutation: true,
|
|
158
|
+
projectId: bucketId,
|
|
156
159
|
resourceId: columnId,
|
|
157
160
|
},
|
|
158
161
|
() =>
|
|
@@ -18,9 +18,9 @@ import { Errors } from "../../errors.js";
|
|
|
18
18
|
export type Card = components["schemas"]["Card"];
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* Request parameters for
|
|
21
|
+
* Request parameters for updateVerbatim.
|
|
22
22
|
*/
|
|
23
|
-
export interface
|
|
23
|
+
export interface UpdateVerbatimCardRequest {
|
|
24
24
|
/** Title */
|
|
25
25
|
title?: string;
|
|
26
26
|
/** Text content */
|
|
@@ -110,10 +110,10 @@ export class CardsService extends BaseService {
|
|
|
110
110
|
*
|
|
111
111
|
* @example
|
|
112
112
|
* ```ts
|
|
113
|
-
* const result = await client.cards.
|
|
113
|
+
* const result = await client.cards.updateVerbatim(123, { });
|
|
114
114
|
* ```
|
|
115
115
|
*/
|
|
116
|
-
async
|
|
116
|
+
async updateVerbatim(cardId: number, req: UpdateVerbatimCardRequest): Promise<Card> {
|
|
117
117
|
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
118
118
|
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
119
119
|
}
|
|
@@ -53,6 +53,8 @@ export interface CreateQuestionCheckinRequest {
|
|
|
53
53
|
title: string;
|
|
54
54
|
/** Schedule */
|
|
55
55
|
schedule: components["schemas"]["QuestionSchedule"];
|
|
56
|
+
/** Visible to clients */
|
|
57
|
+
visibleToClients?: boolean;
|
|
56
58
|
}
|
|
57
59
|
|
|
58
60
|
/**
|
|
@@ -279,7 +281,7 @@ export class CheckinsService extends BaseService {
|
|
|
279
281
|
*
|
|
280
282
|
* @example
|
|
281
283
|
* ```ts
|
|
282
|
-
* const result = await client.checkins.createQuestion(123, { title: "example", schedule:
|
|
284
|
+
* const result = await client.checkins.createQuestion(123, { title: "example", schedule: { } });
|
|
283
285
|
* ```
|
|
284
286
|
*/
|
|
285
287
|
async createQuestion(questionnaireId: number, req: CreateQuestionCheckinRequest): Promise<Question> {
|
|
@@ -305,6 +307,7 @@ export class CheckinsService extends BaseService {
|
|
|
305
307
|
body: {
|
|
306
308
|
title: req.title,
|
|
307
309
|
schedule: req.schedule,
|
|
310
|
+
visible_to_clients: req.visibleToClients,
|
|
308
311
|
},
|
|
309
312
|
})
|
|
310
313
|
);
|
|
@@ -45,6 +45,8 @@ export interface CreateDocumentRequest {
|
|
|
45
45
|
status?: "active" | "drafted";
|
|
46
46
|
/** Subscriptions */
|
|
47
47
|
subscriptions?: number[];
|
|
48
|
+
/** Visible to clients */
|
|
49
|
+
visibleToClients?: boolean;
|
|
48
50
|
}
|
|
49
51
|
|
|
50
52
|
|
|
@@ -186,6 +188,7 @@ export class DocumentsService extends BaseService {
|
|
|
186
188
|
content: req.content,
|
|
187
189
|
status: req.status,
|
|
188
190
|
subscriptions: req.subscriptions,
|
|
191
|
+
visible_to_clients: req.visibleToClients,
|
|
189
192
|
},
|
|
190
193
|
})
|
|
191
194
|
);
|