@37signals/basecamp 0.9.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 +1 -1
- package/dist/client.d.ts +6 -3
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +33 -13
- package/dist/client.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +290 -12
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +290 -12
- package/dist/generated/openapi-stripped.json +6274 -3872
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +23 -5
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +23 -5
- package/dist/generated/schema.d.ts +3004 -1145
- 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/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/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/index.d.ts +2 -1
- package/dist/generated/services/index.d.ts.map +1 -1
- package/dist/generated/services/index.js +2 -1
- package/dist/generated/services/index.js.map +1 -1
- package/dist/generated/services/index.ts +2 -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/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/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 +9 -1
- package/dist/generated/services/schedules.d.ts.map +1 -1
- package/dist/generated/services/schedules.js.map +1 -1
- package/dist/generated/services/schedules.ts +9 -1
- 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 +1 -0
- package/dist/generated/services/tools.js.map +1 -1
- package/dist/generated/services/tools.ts +3 -0
- package/dist/index.d.ts +4 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -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 +290 -12
- package/src/generated/openapi-stripped.json +6274 -3872
- package/src/generated/path-mapping.ts +23 -5
- package/src/generated/schema.d.ts +3004 -1145
- package/src/generated/services/boosts.ts +12 -10
- package/src/generated/services/cards.ts +4 -4
- package/src/generated/services/everything.ts +632 -0
- package/src/generated/services/index.ts +2 -1
- package/src/generated/services/message-types.ts +34 -18
- package/src/generated/services/my-notifications.ts +46 -1
- package/src/generated/services/recordings.ts +2 -2
- package/src/generated/services/schedules.ts +9 -1
- package/src/generated/services/tools.ts +3 -0
|
@@ -5,7 +5,10 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { BaseService } from "../../services/base.js";
|
|
7
7
|
import type { components } from "../schema.js";
|
|
8
|
+
import { ListResult } from "../../pagination.js";
|
|
8
9
|
import type { PaginationOptions } from "../../pagination.js";
|
|
10
|
+
/** Boost entity from the Basecamp API. */
|
|
11
|
+
export type Boost = components["schemas"]["Boost"];
|
|
9
12
|
/**
|
|
10
13
|
* Options for listForRecording.
|
|
11
14
|
*/
|
|
@@ -37,7 +40,7 @@ export declare class BoostsService extends BaseService {
|
|
|
37
40
|
/**
|
|
38
41
|
* Get a single boost
|
|
39
42
|
* @param boostId - The boost ID
|
|
40
|
-
* @returns The
|
|
43
|
+
* @returns The Boost
|
|
41
44
|
* @throws {BasecampError} If the resource is not found
|
|
42
45
|
*
|
|
43
46
|
* @example
|
|
@@ -45,7 +48,7 @@ export declare class BoostsService extends BaseService {
|
|
|
45
48
|
* const result = await client.boosts.get(123);
|
|
46
49
|
* ```
|
|
47
50
|
*/
|
|
48
|
-
get(boostId: number): Promise<
|
|
51
|
+
get(boostId: number): Promise<Boost>;
|
|
49
52
|
/**
|
|
50
53
|
* Delete a boost
|
|
51
54
|
* @param boostId - The boost ID
|
|
@@ -62,19 +65,19 @@ export declare class BoostsService extends BaseService {
|
|
|
62
65
|
* List boosts on a recording
|
|
63
66
|
* @param recordingId - The recording ID
|
|
64
67
|
* @param options - Optional query parameters
|
|
65
|
-
* @returns All
|
|
68
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
66
69
|
*
|
|
67
70
|
* @example
|
|
68
71
|
* ```ts
|
|
69
72
|
* const result = await client.boosts.listForRecording(123);
|
|
70
73
|
* ```
|
|
71
74
|
*/
|
|
72
|
-
listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<
|
|
75
|
+
listForRecording(recordingId: number, options?: ListForRecordingBoostOptions): Promise<ListResult<Boost>>;
|
|
73
76
|
/**
|
|
74
77
|
* Create a boost on a recording
|
|
75
78
|
* @param recordingId - The recording ID
|
|
76
79
|
* @param req - Recording_boost creation parameters
|
|
77
|
-
* @returns The
|
|
80
|
+
* @returns The Boost
|
|
78
81
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
79
82
|
*
|
|
80
83
|
* @example
|
|
@@ -82,26 +85,26 @@ export declare class BoostsService extends BaseService {
|
|
|
82
85
|
* const result = await client.boosts.createForRecording(123, { content: "Hello world" });
|
|
83
86
|
* ```
|
|
84
87
|
*/
|
|
85
|
-
createForRecording(recordingId: number, req: CreateForRecordingBoostRequest): Promise<
|
|
88
|
+
createForRecording(recordingId: number, req: CreateForRecordingBoostRequest): Promise<Boost>;
|
|
86
89
|
/**
|
|
87
90
|
* List boosts on a specific event within a recording
|
|
88
91
|
* @param recordingId - The recording ID
|
|
89
92
|
* @param eventId - The event ID
|
|
90
93
|
* @param options - Optional query parameters
|
|
91
|
-
* @returns All
|
|
94
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
92
95
|
*
|
|
93
96
|
* @example
|
|
94
97
|
* ```ts
|
|
95
98
|
* const result = await client.boosts.listForEvent(123, 123);
|
|
96
99
|
* ```
|
|
97
100
|
*/
|
|
98
|
-
listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<
|
|
101
|
+
listForEvent(recordingId: number, eventId: number, options?: ListForEventBoostOptions): Promise<ListResult<Boost>>;
|
|
99
102
|
/**
|
|
100
103
|
* Create a boost on a specific event within a recording
|
|
101
104
|
* @param recordingId - The recording ID
|
|
102
105
|
* @param eventId - The event ID
|
|
103
106
|
* @param req - Event_boost creation parameters
|
|
104
|
-
* @returns The
|
|
107
|
+
* @returns The Boost
|
|
105
108
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
106
109
|
*
|
|
107
110
|
* @example
|
|
@@ -109,6 +112,6 @@ export declare class BoostsService extends BaseService {
|
|
|
109
112
|
* const result = await client.boosts.createForEvent(123, 123, { content: "Hello world" });
|
|
110
113
|
* ```
|
|
111
114
|
*/
|
|
112
|
-
createForEvent(recordingId: number, eventId: number, req: CreateForEventBoostRequest): Promise<
|
|
115
|
+
createForEvent(recordingId: number, eventId: number, req: CreateForEventBoostRequest): Promise<Boost>;
|
|
113
116
|
}
|
|
114
117
|
//# sourceMappingURL=boosts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boosts.d.ts","sourceRoot":"","sources":["../../../src/generated/services/boosts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"boosts.d.ts","sourceRoot":"","sources":["../../../src/generated/services/boosts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,0CAA0C;AAC1C,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,iBAAiB;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAOD;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAmB1C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB5C;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAmB/G;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,8BAA8B,GAAG,OAAO,CAAC,KAAK,CAAC;IAyBlG;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAmBxH;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,KAAK,CAAC;CAwB5G"}
|
|
@@ -15,7 +15,7 @@ export class BoostsService extends BaseService {
|
|
|
15
15
|
/**
|
|
16
16
|
* Get a single boost
|
|
17
17
|
* @param boostId - The boost ID
|
|
18
|
-
* @returns The
|
|
18
|
+
* @returns The Boost
|
|
19
19
|
* @throws {BasecampError} If the resource is not found
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
@@ -65,7 +65,7 @@ export class BoostsService extends BaseService {
|
|
|
65
65
|
* List boosts on a recording
|
|
66
66
|
* @param recordingId - The recording ID
|
|
67
67
|
* @param options - Optional query parameters
|
|
68
|
-
* @returns All
|
|
68
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* ```ts
|
|
@@ -89,7 +89,7 @@ export class BoostsService extends BaseService {
|
|
|
89
89
|
* Create a boost on a recording
|
|
90
90
|
* @param recordingId - The recording ID
|
|
91
91
|
* @param req - Recording_boost creation parameters
|
|
92
|
-
* @returns The
|
|
92
|
+
* @returns The Boost
|
|
93
93
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
@@ -122,7 +122,7 @@ export class BoostsService extends BaseService {
|
|
|
122
122
|
* @param recordingId - The recording ID
|
|
123
123
|
* @param eventId - The event ID
|
|
124
124
|
* @param options - Optional query parameters
|
|
125
|
-
* @returns All
|
|
125
|
+
* @returns All Boost across all pages, with .meta.totalCount
|
|
126
126
|
*
|
|
127
127
|
* @example
|
|
128
128
|
* ```ts
|
|
@@ -147,7 +147,7 @@ export class BoostsService extends BaseService {
|
|
|
147
147
|
* @param recordingId - The recording ID
|
|
148
148
|
* @param eventId - The event ID
|
|
149
149
|
* @param req - Event_boost creation parameters
|
|
150
|
-
* @returns The
|
|
150
|
+
* @returns The Boost
|
|
151
151
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
152
152
|
*
|
|
153
153
|
* @example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"boosts.js","sourceRoot":"","sources":["../../../src/generated/services/boosts.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":"boosts.js","sourceRoot":"","sources":["../../../src/generated/services/boosts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAsCzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE5C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,UAAU;YACrB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;YACnC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE;YACtC,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,OAAO,EAAE;aAClB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gBAAgB,CAAC,WAAmB,EAAE,OAAsC;QAChF,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,qBAAqB;YAChC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;YACvD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CAAC,WAAmB,EAAE,GAAmC;QAC/E,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,sBAAsB;YACjC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE;YACxD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,OAAe,EAAE,OAAkC;QACzF,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,iBAAiB;YAC5B,YAAY,EAAE,aAAa;YAC3B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wDAAwD,EAAE;YACxE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE;aAC/B;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,OAAe,EAAE,GAA+B;QACxF,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,kBAAkB;YAC7B,YAAY,EAAE,aAAa;YAC3B,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,OAAO;SACpB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wDAAwD,EAAE;YACzE,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE;aAC/B;YACD,IAAI,EAAE;gBACJ,OAAO,EAAE,GAAG,CAAC,OAAO;aACrB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -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
|
}
|
|
@@ -10,9 +10,9 @@ import type { PaginationOptions } from "../../pagination.js";
|
|
|
10
10
|
/** Card entity from the Basecamp API. */
|
|
11
11
|
export type Card = components["schemas"]["Card"];
|
|
12
12
|
/**
|
|
13
|
-
* Request parameters for
|
|
13
|
+
* Request parameters for updateVerbatim.
|
|
14
14
|
*/
|
|
15
|
-
export interface
|
|
15
|
+
export interface UpdateVerbatimCardRequest {
|
|
16
16
|
/** Title */
|
|
17
17
|
title?: string;
|
|
18
18
|
/** Text content */
|
|
@@ -74,10 +74,10 @@ export declare class CardsService extends BaseService {
|
|
|
74
74
|
*
|
|
75
75
|
* @example
|
|
76
76
|
* ```ts
|
|
77
|
-
* const result = await client.cards.
|
|
77
|
+
* const result = await client.cards.updateVerbatim(123, { });
|
|
78
78
|
* ```
|
|
79
79
|
*/
|
|
80
|
-
|
|
80
|
+
updateVerbatim(cardId: number, req: UpdateVerbatimCardRequest): Promise<Card>;
|
|
81
81
|
/**
|
|
82
82
|
* Move a card to a different column
|
|
83
83
|
* @param cardId - The card ID
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../../src/generated/services/cards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../../src/generated/services/cards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,yCAAyC;AACzC,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAOD;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxC;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BnF;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB/D;;;;;;;;;;OAUG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAmBlF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CA8BtE"}
|
|
@@ -46,10 +46,10 @@ export class CardsService extends BaseService {
|
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* ```ts
|
|
49
|
-
* const result = await client.cards.
|
|
49
|
+
* const result = await client.cards.updateVerbatim(123, { });
|
|
50
50
|
* ```
|
|
51
51
|
*/
|
|
52
|
-
async
|
|
52
|
+
async updateVerbatim(cardId, req) {
|
|
53
53
|
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
54
54
|
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
55
55
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cards.js","sourceRoot":"","sources":["../../../src/generated/services/cards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAsDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,
|
|
1
|
+
{"version":3,"file":"cards.js","sourceRoot":"","sources":["../../../src/generated/services/cards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAIrD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAsDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,WAAW;IAE3C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,SAAS;YACpB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,GAA8B;QACjE,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,6BAA6B,EAAE;YAC7C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,YAAY,EAAE,GAAG,CAAC,WAAW;aAC9B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,GAAoB;QAC7C,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,UAAU;YACrB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE;YACzD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,SAAS,EAAE,GAAG,CAAC,QAAQ;gBACvB,QAAQ,EAAE,GAAG,CAAC,QAAQ;aACvB;SACF,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,OAAyB;QACpD,OAAO,IAAI,CAAC,gBAAgB,CAC1B;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YAC1D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;SACF,CAAC,EACF,OAAO,CACV,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,GAAsB;QACnD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,YAAY;YACvB,YAAY,EAAE,MAAM;YACpB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,QAAQ;SACrB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE;YAC3D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE;aACnB;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,MAAM,EAAE,GAAG,CAAC,MAAM;aACnB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -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
|
}
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Everything 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
|
+
/** EverythingBoost entity from the Basecamp API. */
|
|
11
|
+
export type EverythingBoost = components["schemas"]["EverythingBoost"];
|
|
12
|
+
/** BucketCardsGroup entity from the Basecamp API. */
|
|
13
|
+
export type BucketCardsGroup = components["schemas"]["BucketCardsGroup"];
|
|
14
|
+
/** Card entity from the Basecamp API. */
|
|
15
|
+
export type Card = components["schemas"]["Card"];
|
|
16
|
+
/** Recording entity from the Basecamp API. */
|
|
17
|
+
export type Recording = components["schemas"]["Recording"];
|
|
18
|
+
/** EverythingFile entity from the Basecamp API. */
|
|
19
|
+
export type EverythingFile = components["schemas"]["EverythingFile"];
|
|
20
|
+
/** BucketTodosGroup entity from the Basecamp API. */
|
|
21
|
+
export type BucketTodosGroup = components["schemas"]["BucketTodosGroup"];
|
|
22
|
+
/** Todo entity from the Basecamp API. */
|
|
23
|
+
export type Todo = components["schemas"]["Todo"];
|
|
24
|
+
/**
|
|
25
|
+
* Options for everythingBoosts.
|
|
26
|
+
*/
|
|
27
|
+
export interface EverythingBoostsEverythingOptions extends PaginationOptions {
|
|
28
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
29
|
+
page?: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Options for everythingCompletedCards.
|
|
33
|
+
*/
|
|
34
|
+
export interface EverythingCompletedCardsEverythingOptions extends PaginationOptions {
|
|
35
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
36
|
+
page?: number;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Options for everythingNoDueDateCards.
|
|
40
|
+
*/
|
|
41
|
+
export interface EverythingNoDueDateCardsEverythingOptions extends PaginationOptions {
|
|
42
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
43
|
+
page?: number;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Options for everythingNotNowCards.
|
|
47
|
+
*/
|
|
48
|
+
export interface EverythingNotNowCardsEverythingOptions extends PaginationOptions {
|
|
49
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
50
|
+
page?: number;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Options for everythingOpenCards.
|
|
54
|
+
*/
|
|
55
|
+
export interface EverythingOpenCardsEverythingOptions extends PaginationOptions {
|
|
56
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
57
|
+
page?: number;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Options for everythingUnassignedCards.
|
|
61
|
+
*/
|
|
62
|
+
export interface EverythingUnassignedCardsEverythingOptions extends PaginationOptions {
|
|
63
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
64
|
+
page?: number;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Options for everythingCheckins.
|
|
68
|
+
*/
|
|
69
|
+
export interface EverythingCheckinsEverythingOptions extends PaginationOptions {
|
|
70
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
71
|
+
page?: number;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Options for everythingComments.
|
|
75
|
+
*/
|
|
76
|
+
export interface EverythingCommentsEverythingOptions extends PaginationOptions {
|
|
77
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
78
|
+
page?: number;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Options for everythingFiles.
|
|
82
|
+
*/
|
|
83
|
+
export interface EverythingFilesEverythingOptions extends PaginationOptions {
|
|
84
|
+
/** Filter by file kind: all (default), images, pdfs, documents, or videos. */
|
|
85
|
+
kind?: string;
|
|
86
|
+
/** Restrict to files created by the given people (repeatable). */
|
|
87
|
+
peopleIds?: number[];
|
|
88
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
89
|
+
page?: number;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Options for everythingForwards.
|
|
93
|
+
*/
|
|
94
|
+
export interface EverythingForwardsEverythingOptions extends PaginationOptions {
|
|
95
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
96
|
+
page?: number;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Options for everythingMessages.
|
|
100
|
+
*/
|
|
101
|
+
export interface EverythingMessagesEverythingOptions extends PaginationOptions {
|
|
102
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
103
|
+
page?: number;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Options for everythingCompletedTodos.
|
|
107
|
+
*/
|
|
108
|
+
export interface EverythingCompletedTodosEverythingOptions extends PaginationOptions {
|
|
109
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
110
|
+
page?: number;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Options for everythingNoDueDateTodos.
|
|
114
|
+
*/
|
|
115
|
+
export interface EverythingNoDueDateTodosEverythingOptions extends PaginationOptions {
|
|
116
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
117
|
+
page?: number;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Options for everythingOpenTodos.
|
|
121
|
+
*/
|
|
122
|
+
export interface EverythingOpenTodosEverythingOptions extends PaginationOptions {
|
|
123
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
124
|
+
page?: number;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Options for everythingUnassignedTodos.
|
|
128
|
+
*/
|
|
129
|
+
export interface EverythingUnassignedTodosEverythingOptions extends PaginationOptions {
|
|
130
|
+
/** Page number for paginating through results. Defaults to 1. */
|
|
131
|
+
page?: number;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Service for Everything operations.
|
|
135
|
+
*/
|
|
136
|
+
export declare class EverythingService extends BaseService {
|
|
137
|
+
/**
|
|
138
|
+
* Get every boost across all accessible projects, newest-first (paginated).
|
|
139
|
+
* @param options - Optional query parameters
|
|
140
|
+
* @returns All EverythingBoost across all pages, with .meta.totalCount
|
|
141
|
+
*
|
|
142
|
+
* @example
|
|
143
|
+
* ```ts
|
|
144
|
+
* const result = await client.everything.everythingBoosts();
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
everythingBoosts(options?: EverythingBoostsEverythingOptions): Promise<ListResult<EverythingBoost>>;
|
|
148
|
+
/**
|
|
149
|
+
* Completed cards across all accessible projects, grouped by project (paginated).
|
|
150
|
+
* @param options - Optional query parameters
|
|
151
|
+
* @returns All BucketCardsGroup across all pages, with .meta.totalCount
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* ```ts
|
|
155
|
+
* const result = await client.everything.everythingCompletedCards();
|
|
156
|
+
* ```
|
|
157
|
+
*/
|
|
158
|
+
everythingCompletedCards(options?: EverythingCompletedCardsEverythingOptions): Promise<ListResult<BucketCardsGroup>>;
|
|
159
|
+
/**
|
|
160
|
+
* Open cards with no due date across all accessible projects, grouped by project (paginated).
|
|
161
|
+
* @param options - Optional query parameters
|
|
162
|
+
* @returns All BucketCardsGroup across all pages, with .meta.totalCount
|
|
163
|
+
*
|
|
164
|
+
* @example
|
|
165
|
+
* ```ts
|
|
166
|
+
* const result = await client.everything.everythingNoDueDateCards();
|
|
167
|
+
* ```
|
|
168
|
+
*/
|
|
169
|
+
everythingNoDueDateCards(options?: EverythingNoDueDateCardsEverythingOptions): Promise<ListResult<BucketCardsGroup>>;
|
|
170
|
+
/**
|
|
171
|
+
* Cards parked in a project's "Not now" column across all accessible projects, grouped by project (paginated).
|
|
172
|
+
* @param options - Optional query parameters
|
|
173
|
+
* @returns All BucketCardsGroup across all pages, with .meta.totalCount
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* ```ts
|
|
177
|
+
* const result = await client.everything.everythingNotNowCards();
|
|
178
|
+
* ```
|
|
179
|
+
*/
|
|
180
|
+
everythingNotNowCards(options?: EverythingNotNowCardsEverythingOptions): Promise<ListResult<BucketCardsGroup>>;
|
|
181
|
+
/**
|
|
182
|
+
* Incomplete cards in active columns across all accessible projects, grouped by project (paginated).
|
|
183
|
+
* @param options - Optional query parameters
|
|
184
|
+
* @returns All BucketCardsGroup across all pages, with .meta.totalCount
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* ```ts
|
|
188
|
+
* const result = await client.everything.everythingOpenCards();
|
|
189
|
+
* ```
|
|
190
|
+
*/
|
|
191
|
+
everythingOpenCards(options?: EverythingOpenCardsEverythingOptions): Promise<ListResult<BucketCardsGroup>>;
|
|
192
|
+
/**
|
|
193
|
+
* Get every overdue card across all accessible projects, oldest-due-date-first.
|
|
194
|
+
* @returns Array of Card
|
|
195
|
+
*
|
|
196
|
+
* @example
|
|
197
|
+
* ```ts
|
|
198
|
+
* const result = await client.everything.everythingOverdueCards();
|
|
199
|
+
* ```
|
|
200
|
+
*/
|
|
201
|
+
everythingOverdueCards(): Promise<Card[]>;
|
|
202
|
+
/**
|
|
203
|
+
* Open, unassigned cards across all accessible projects, grouped by project (paginated).
|
|
204
|
+
* @param options - Optional query parameters
|
|
205
|
+
* @returns All BucketCardsGroup across all pages, with .meta.totalCount
|
|
206
|
+
*
|
|
207
|
+
* @example
|
|
208
|
+
* ```ts
|
|
209
|
+
* const result = await client.everything.everythingUnassignedCards();
|
|
210
|
+
* ```
|
|
211
|
+
*/
|
|
212
|
+
everythingUnassignedCards(options?: EverythingUnassignedCardsEverythingOptions): Promise<ListResult<BucketCardsGroup>>;
|
|
213
|
+
/**
|
|
214
|
+
* Get every automatic check-in answer across all accessible projects, newest-first.
|
|
215
|
+
* @param options - Optional query parameters
|
|
216
|
+
* @returns All Recording across all pages, with .meta.totalCount
|
|
217
|
+
*
|
|
218
|
+
* @example
|
|
219
|
+
* ```ts
|
|
220
|
+
* const result = await client.everything.everythingCheckins();
|
|
221
|
+
* ```
|
|
222
|
+
*/
|
|
223
|
+
everythingCheckins(options?: EverythingCheckinsEverythingOptions): Promise<ListResult<Recording>>;
|
|
224
|
+
/**
|
|
225
|
+
* Get every comment across all accessible projects, newest-first (paginated).
|
|
226
|
+
* @param options - Optional query parameters
|
|
227
|
+
* @returns All Recording across all pages, with .meta.totalCount
|
|
228
|
+
*
|
|
229
|
+
* @example
|
|
230
|
+
* ```ts
|
|
231
|
+
* const result = await client.everything.everythingComments();
|
|
232
|
+
* ```
|
|
233
|
+
*/
|
|
234
|
+
everythingComments(options?: EverythingCommentsEverythingOptions): Promise<ListResult<Recording>>;
|
|
235
|
+
/**
|
|
236
|
+
* Get every file recording across all accessible projects, newest-first (paginated).
|
|
237
|
+
* @param options - Optional query parameters
|
|
238
|
+
* @returns All EverythingFile across all pages, with .meta.totalCount
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* ```ts
|
|
242
|
+
* const result = await client.everything.everythingFiles();
|
|
243
|
+
* ```
|
|
244
|
+
*/
|
|
245
|
+
everythingFiles(options?: EverythingFilesEverythingOptions): Promise<ListResult<EverythingFile>>;
|
|
246
|
+
/**
|
|
247
|
+
* Get every inbox forward across all accessible projects, newest-first (paginated).
|
|
248
|
+
* @param options - Optional query parameters
|
|
249
|
+
* @returns All Recording across all pages, with .meta.totalCount
|
|
250
|
+
*
|
|
251
|
+
* @example
|
|
252
|
+
* ```ts
|
|
253
|
+
* const result = await client.everything.everythingForwards();
|
|
254
|
+
* ```
|
|
255
|
+
*/
|
|
256
|
+
everythingForwards(options?: EverythingForwardsEverythingOptions): Promise<ListResult<Recording>>;
|
|
257
|
+
/**
|
|
258
|
+
* Get every message across all accessible projects, newest-first (paginated).
|
|
259
|
+
* @param options - Optional query parameters
|
|
260
|
+
* @returns All Recording across all pages, with .meta.totalCount
|
|
261
|
+
*
|
|
262
|
+
* @example
|
|
263
|
+
* ```ts
|
|
264
|
+
* const result = await client.everything.everythingMessages();
|
|
265
|
+
* ```
|
|
266
|
+
*/
|
|
267
|
+
everythingMessages(options?: EverythingMessagesEverythingOptions): Promise<ListResult<Recording>>;
|
|
268
|
+
/**
|
|
269
|
+
* Completed to-dos across all accessible projects, grouped by project (paginated).
|
|
270
|
+
* @param options - Optional query parameters
|
|
271
|
+
* @returns All BucketTodosGroup across all pages, with .meta.totalCount
|
|
272
|
+
*
|
|
273
|
+
* @example
|
|
274
|
+
* ```ts
|
|
275
|
+
* const result = await client.everything.everythingCompletedTodos();
|
|
276
|
+
* ```
|
|
277
|
+
*/
|
|
278
|
+
everythingCompletedTodos(options?: EverythingCompletedTodosEverythingOptions): Promise<ListResult<BucketTodosGroup>>;
|
|
279
|
+
/**
|
|
280
|
+
* Open to-dos with no due date across all accessible projects, grouped by project (paginated).
|
|
281
|
+
* @param options - Optional query parameters
|
|
282
|
+
* @returns All BucketTodosGroup across all pages, with .meta.totalCount
|
|
283
|
+
*
|
|
284
|
+
* @example
|
|
285
|
+
* ```ts
|
|
286
|
+
* const result = await client.everything.everythingNoDueDateTodos();
|
|
287
|
+
* ```
|
|
288
|
+
*/
|
|
289
|
+
everythingNoDueDateTodos(options?: EverythingNoDueDateTodosEverythingOptions): Promise<ListResult<BucketTodosGroup>>;
|
|
290
|
+
/**
|
|
291
|
+
* Active, incomplete to-dos across all accessible projects, grouped by project (paginated).
|
|
292
|
+
* @param options - Optional query parameters
|
|
293
|
+
* @returns All BucketTodosGroup across all pages, with .meta.totalCount
|
|
294
|
+
*
|
|
295
|
+
* @example
|
|
296
|
+
* ```ts
|
|
297
|
+
* const result = await client.everything.everythingOpenTodos();
|
|
298
|
+
* ```
|
|
299
|
+
*/
|
|
300
|
+
everythingOpenTodos(options?: EverythingOpenTodosEverythingOptions): Promise<ListResult<BucketTodosGroup>>;
|
|
301
|
+
/**
|
|
302
|
+
* Get every overdue to-do across all accessible projects, oldest-due-date-first.
|
|
303
|
+
* @returns Array of Todo
|
|
304
|
+
*
|
|
305
|
+
* @example
|
|
306
|
+
* ```ts
|
|
307
|
+
* const result = await client.everything.everythingOverdueTodos();
|
|
308
|
+
* ```
|
|
309
|
+
*/
|
|
310
|
+
everythingOverdueTodos(): Promise<Todo[]>;
|
|
311
|
+
/**
|
|
312
|
+
* Open, unassigned to-dos across all accessible projects, grouped by project (paginated).
|
|
313
|
+
* @param options - Optional query parameters
|
|
314
|
+
* @returns All BucketTodosGroup across all pages, with .meta.totalCount
|
|
315
|
+
*
|
|
316
|
+
* @example
|
|
317
|
+
* ```ts
|
|
318
|
+
* const result = await client.everything.everythingUnassignedTodos();
|
|
319
|
+
* ```
|
|
320
|
+
*/
|
|
321
|
+
everythingUnassignedTodos(options?: EverythingUnassignedTodosEverythingOptions): Promise<ListResult<BucketTodosGroup>>;
|
|
322
|
+
}
|
|
323
|
+
//# sourceMappingURL=everything.d.ts.map
|