@37signals/basecamp 0.20.0 → 0.21.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 -0
- package/dist/client.d.ts +5 -2
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +5 -2
- package/dist/client.js.map +1 -1
- package/dist/generated/metadata.d.ts.map +1 -1
- package/dist/generated/metadata.js +165 -2
- package/dist/generated/metadata.js.map +1 -1
- package/dist/generated/metadata.ts +165 -2
- package/dist/generated/openapi-stripped.json +2747 -1259
- package/dist/generated/path-mapping.d.ts.map +1 -1
- package/dist/generated/path-mapping.js +14 -1
- package/dist/generated/path-mapping.js.map +1 -1
- package/dist/generated/path-mapping.ts +14 -1
- package/dist/generated/person-id-sites.d.ts.map +1 -1
- package/dist/generated/person-id-sites.js +61 -2
- package/dist/generated/person-id-sites.js.map +1 -1
- package/dist/generated/person-id-sites.ts +61 -2
- package/dist/generated/schema.d.ts +1312 -129
- package/dist/generated/services/bookmarks.d.ts +1 -1
- package/dist/generated/services/bookmarks.js +1 -1
- package/dist/generated/services/bookmarks.ts +1 -1
- package/dist/generated/services/boosts.d.ts +2 -2
- package/dist/generated/services/boosts.js +2 -2
- package/dist/generated/services/boosts.ts +2 -2
- package/dist/generated/services/campfires.d.ts +4 -4
- package/dist/generated/services/campfires.js +4 -4
- package/dist/generated/services/campfires.ts +4 -4
- package/dist/generated/services/card-steps.d.ts +15 -11
- package/dist/generated/services/card-steps.d.ts.map +1 -1
- package/dist/generated/services/card-steps.js +4 -4
- package/dist/generated/services/card-steps.js.map +1 -1
- package/dist/generated/services/card-steps.ts +15 -11
- package/dist/generated/services/cards.d.ts +1 -1
- package/dist/generated/services/cards.js +1 -1
- package/dist/generated/services/cards.ts +1 -1
- package/dist/generated/services/checkins.d.ts +4 -4
- package/dist/generated/services/checkins.js +4 -4
- package/dist/generated/services/checkins.ts +4 -4
- package/dist/generated/services/client-approvals.d.ts +1 -1
- package/dist/generated/services/client-approvals.js +1 -1
- package/dist/generated/services/client-approvals.ts +1 -1
- package/dist/generated/services/client-correspondences.d.ts +1 -1
- package/dist/generated/services/client-correspondences.js +1 -1
- package/dist/generated/services/client-correspondences.ts +1 -1
- package/dist/generated/services/client-replies.d.ts +1 -1
- package/dist/generated/services/client-replies.js +1 -1
- package/dist/generated/services/client-replies.ts +1 -1
- package/dist/generated/services/comments.d.ts +1 -1
- package/dist/generated/services/comments.js +1 -1
- package/dist/generated/services/comments.ts +1 -1
- package/dist/generated/services/documents.d.ts +1 -1
- package/dist/generated/services/documents.js +1 -1
- package/dist/generated/services/documents.ts +1 -1
- package/dist/generated/services/drafts.d.ts +1 -1
- package/dist/generated/services/drafts.js +1 -1
- package/dist/generated/services/drafts.ts +1 -1
- package/dist/generated/services/events.d.ts +1 -1
- package/dist/generated/services/events.js +1 -1
- package/dist/generated/services/events.ts +1 -1
- package/dist/generated/services/everything.d.ts +14 -14
- package/dist/generated/services/everything.js +14 -14
- package/dist/generated/services/everything.ts +14 -14
- package/dist/generated/services/forwards.d.ts +2 -2
- package/dist/generated/services/forwards.js +2 -2
- package/dist/generated/services/forwards.ts +2 -2
- 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 +1 -1
- package/dist/generated/services/message-types.js +1 -1
- package/dist/generated/services/message-types.ts +1 -1
- package/dist/generated/services/messages.d.ts +1 -1
- package/dist/generated/services/messages.js +1 -1
- package/dist/generated/services/messages.ts +1 -1
- package/dist/generated/services/my-notifications.d.ts +3 -2
- package/dist/generated/services/my-notifications.d.ts.map +1 -1
- package/dist/generated/services/my-notifications.js +1 -1
- package/dist/generated/services/my-notifications.js.map +1 -1
- package/dist/generated/services/my-notifications.ts +3 -2
- package/dist/generated/services/people.d.ts +3 -3
- package/dist/generated/services/people.js +3 -3
- package/dist/generated/services/people.ts +3 -3
- package/dist/generated/services/projects.d.ts +1 -1
- package/dist/generated/services/projects.js +1 -1
- package/dist/generated/services/projects.ts +1 -1
- package/dist/generated/services/recordings.d.ts +3 -3
- package/dist/generated/services/recordings.js +3 -3
- package/dist/generated/services/recordings.ts +3 -3
- package/dist/generated/services/reports.d.ts +1 -1
- package/dist/generated/services/reports.js +1 -1
- package/dist/generated/services/reports.ts +1 -1
- package/dist/generated/services/schedules.d.ts +1 -1
- package/dist/generated/services/schedules.js +1 -1
- package/dist/generated/services/schedules.ts +1 -1
- package/dist/generated/services/subtasks.d.ts +157 -0
- package/dist/generated/services/subtasks.d.ts.map +1 -0
- package/dist/generated/services/subtasks.js +240 -0
- package/dist/generated/services/subtasks.js.map +1 -0
- package/dist/generated/services/subtasks.ts +336 -0
- package/dist/generated/services/templates.d.ts +114 -10
- package/dist/generated/services/templates.d.ts.map +1 -1
- package/dist/generated/services/templates.js +147 -10
- package/dist/generated/services/templates.js.map +1 -1
- package/dist/generated/services/templates.ts +220 -13
- package/dist/generated/services/timeline.d.ts +1 -1
- package/dist/generated/services/timeline.js +1 -1
- package/dist/generated/services/timeline.ts +1 -1
- package/dist/generated/services/timesheets.d.ts +3 -3
- package/dist/generated/services/timesheets.js +3 -3
- package/dist/generated/services/timesheets.ts +3 -3
- package/dist/generated/services/todolist-groups.d.ts +1 -1
- package/dist/generated/services/todolist-groups.js +1 -1
- package/dist/generated/services/todolist-groups.ts +1 -1
- package/dist/generated/services/todolists.d.ts +1 -1
- package/dist/generated/services/todolists.js +1 -1
- package/dist/generated/services/todolists.ts +1 -1
- package/dist/generated/services/todos.d.ts +1 -1
- package/dist/generated/services/todos.js +1 -1
- package/dist/generated/services/todos.ts +1 -1
- package/dist/generated/services/uploads.d.ts +2 -2
- package/dist/generated/services/uploads.js +2 -2
- package/dist/generated/services/uploads.ts +2 -2
- package/dist/generated/services/vaults.d.ts +1 -1
- package/dist/generated/services/vaults.js +1 -1
- package/dist/generated/services/vaults.ts +1 -1
- package/dist/generated/services/webhooks.d.ts +1 -1
- package/dist/generated/services/webhooks.js +1 -1
- package/dist/generated/services/webhooks.ts +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/generated/metadata.ts +165 -2
- package/src/generated/openapi-stripped.json +2747 -1259
- package/src/generated/path-mapping.ts +14 -1
- package/src/generated/person-id-sites.ts +61 -2
- package/src/generated/schema.d.ts +1312 -129
- package/src/generated/services/bookmarks.ts +1 -1
- package/src/generated/services/boosts.ts +2 -2
- package/src/generated/services/campfires.ts +4 -4
- package/src/generated/services/card-steps.ts +15 -11
- package/src/generated/services/cards.ts +1 -1
- package/src/generated/services/checkins.ts +4 -4
- package/src/generated/services/client-approvals.ts +1 -1
- package/src/generated/services/client-correspondences.ts +1 -1
- package/src/generated/services/client-replies.ts +1 -1
- package/src/generated/services/comments.ts +1 -1
- package/src/generated/services/documents.ts +1 -1
- package/src/generated/services/drafts.ts +1 -1
- package/src/generated/services/events.ts +1 -1
- package/src/generated/services/everything.ts +14 -14
- package/src/generated/services/forwards.ts +2 -2
- package/src/generated/services/index.ts +2 -1
- package/src/generated/services/message-types.ts +1 -1
- package/src/generated/services/messages.ts +1 -1
- package/src/generated/services/my-notifications.ts +3 -2
- package/src/generated/services/people.ts +3 -3
- package/src/generated/services/projects.ts +1 -1
- package/src/generated/services/recordings.ts +3 -3
- package/src/generated/services/reports.ts +1 -1
- package/src/generated/services/schedules.ts +1 -1
- package/src/generated/services/subtasks.ts +336 -0
- package/src/generated/services/templates.ts +220 -13
- package/src/generated/services/timeline.ts +1 -1
- package/src/generated/services/timesheets.ts +3 -3
- package/src/generated/services/todolist-groups.ts +1 -1
- package/src/generated/services/todolists.ts +1 -1
- package/src/generated/services/todos.ts +1 -1
- package/src/generated/services/uploads.ts +2 -2
- package/src/generated/services/vaults.ts +1 -1
- package/src/generated/services/webhooks.ts +1 -1
|
@@ -25,7 +25,7 @@ export declare class BookmarksService extends BaseService {
|
|
|
25
25
|
/**
|
|
26
26
|
* List the current user's bookmarks, most recently bookmarked first (paginated).
|
|
27
27
|
* @param options - Optional query parameters
|
|
28
|
-
* @returns
|
|
28
|
+
* @returns Every Bookmark across all pages, with .meta.totalCount
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
31
|
* ```ts
|
|
@@ -14,7 +14,7 @@ export class BookmarksService extends BaseService {
|
|
|
14
14
|
/**
|
|
15
15
|
* List the current user's bookmarks, most recently bookmarked first (paginated).
|
|
16
16
|
* @param options - Optional query parameters
|
|
17
|
-
* @returns
|
|
17
|
+
* @returns Every Bookmark across all pages, with .meta.totalCount
|
|
18
18
|
*
|
|
19
19
|
* @example
|
|
20
20
|
* ```ts
|
|
@@ -39,7 +39,7 @@ export class BookmarksService extends BaseService {
|
|
|
39
39
|
/**
|
|
40
40
|
* List the current user's bookmarks, most recently bookmarked first (paginated).
|
|
41
41
|
* @param options - Optional query parameters
|
|
42
|
-
* @returns
|
|
42
|
+
* @returns Every Bookmark across all pages, with .meta.totalCount
|
|
43
43
|
*
|
|
44
44
|
* @example
|
|
45
45
|
* ```ts
|
|
@@ -69,7 +69,7 @@ export declare class BoostsService extends BaseService {
|
|
|
69
69
|
* List boosts on a recording
|
|
70
70
|
* @param recordingId - The recording ID
|
|
71
71
|
* @param options - Optional query parameters
|
|
72
|
-
* @returns
|
|
72
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
75
|
* ```ts
|
|
@@ -98,7 +98,7 @@ export declare class BoostsService extends BaseService {
|
|
|
98
98
|
* @param recordingId - The recording ID
|
|
99
99
|
* @param eventId - The event ID
|
|
100
100
|
* @param options - Optional query parameters
|
|
101
|
-
* @returns
|
|
101
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
102
102
|
*
|
|
103
103
|
* @example
|
|
104
104
|
* ```ts
|
|
@@ -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
|
|
68
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* ```ts
|
|
@@ -126,7 +126,7 @@ export class BoostsService extends BaseService {
|
|
|
126
126
|
* @param recordingId - The recording ID
|
|
127
127
|
* @param eventId - The event ID
|
|
128
128
|
* @param options - Optional query parameters
|
|
129
|
-
* @returns
|
|
129
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
130
130
|
*
|
|
131
131
|
* @example
|
|
132
132
|
* ```ts
|
|
@@ -122,7 +122,7 @@ export class BoostsService extends BaseService {
|
|
|
122
122
|
* List boosts on a recording
|
|
123
123
|
* @param recordingId - The recording ID
|
|
124
124
|
* @param options - Optional query parameters
|
|
125
|
-
* @returns
|
|
125
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
126
126
|
*
|
|
127
127
|
* @example
|
|
128
128
|
* ```ts
|
|
@@ -194,7 +194,7 @@ export class BoostsService extends BaseService {
|
|
|
194
194
|
* @param recordingId - The recording ID
|
|
195
195
|
* @param eventId - The event ID
|
|
196
196
|
* @param options - Optional query parameters
|
|
197
|
-
* @returns
|
|
197
|
+
* @returns Every Boost across all pages, with .meta.totalCount
|
|
198
198
|
*
|
|
199
199
|
* @example
|
|
200
200
|
* ```ts
|
|
@@ -90,7 +90,7 @@ export declare class CampfiresService extends BaseService {
|
|
|
90
90
|
* @param bucketId - The bucket ID
|
|
91
91
|
* @param campfireId - The campfire ID
|
|
92
92
|
* @param options - Optional query parameters
|
|
93
|
-
* @returns
|
|
93
|
+
* @returns Every Chatbot across all pages, with .meta.totalCount
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
96
96
|
* ```ts
|
|
@@ -158,7 +158,7 @@ export declare class CampfiresService extends BaseService {
|
|
|
158
158
|
/**
|
|
159
159
|
* List all campfires across the account
|
|
160
160
|
* @param options - Optional query parameters
|
|
161
|
-
* @returns
|
|
161
|
+
* @returns Every Campfire across all pages, with .meta.totalCount
|
|
162
162
|
*
|
|
163
163
|
* @example
|
|
164
164
|
* ```ts
|
|
@@ -185,7 +185,7 @@ export declare class CampfiresService extends BaseService {
|
|
|
185
185
|
* List all lines (messages) in a campfire
|
|
186
186
|
* @param campfireId - The campfire ID
|
|
187
187
|
* @param options - Optional query parameters
|
|
188
|
-
* @returns
|
|
188
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
189
189
|
*
|
|
190
190
|
* @example
|
|
191
191
|
* ```ts
|
|
@@ -253,7 +253,7 @@ export declare class CampfiresService extends BaseService {
|
|
|
253
253
|
* List uploaded files in a campfire
|
|
254
254
|
* @param campfireId - The campfire ID
|
|
255
255
|
* @param options - Optional query parameters
|
|
256
|
-
* @returns
|
|
256
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
257
257
|
*
|
|
258
258
|
* @example
|
|
259
259
|
* ```ts
|
|
@@ -17,7 +17,7 @@ export class CampfiresService extends BaseService {
|
|
|
17
17
|
* @param bucketId - The bucket ID
|
|
18
18
|
* @param campfireId - The campfire ID
|
|
19
19
|
* @param options - Optional query parameters
|
|
20
|
-
* @returns
|
|
20
|
+
* @returns Every Chatbot across all pages, with .meta.totalCount
|
|
21
21
|
*
|
|
22
22
|
* @example
|
|
23
23
|
* ```ts
|
|
@@ -167,7 +167,7 @@ export class CampfiresService extends BaseService {
|
|
|
167
167
|
/**
|
|
168
168
|
* List all campfires across the account
|
|
169
169
|
* @param options - Optional query parameters
|
|
170
|
-
* @returns
|
|
170
|
+
* @returns Every Campfire across all pages, with .meta.totalCount
|
|
171
171
|
*
|
|
172
172
|
* @example
|
|
173
173
|
* ```ts
|
|
@@ -218,7 +218,7 @@ export class CampfiresService extends BaseService {
|
|
|
218
218
|
* List all lines (messages) in a campfire
|
|
219
219
|
* @param campfireId - The campfire ID
|
|
220
220
|
* @param options - Optional query parameters
|
|
221
|
-
* @returns
|
|
221
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
222
222
|
*
|
|
223
223
|
* @example
|
|
224
224
|
* ```ts
|
|
@@ -362,7 +362,7 @@ export class CampfiresService extends BaseService {
|
|
|
362
362
|
* List uploaded files in a campfire
|
|
363
363
|
* @param campfireId - The campfire ID
|
|
364
364
|
* @param options - Optional query parameters
|
|
365
|
-
* @returns
|
|
365
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
366
366
|
*
|
|
367
367
|
* @example
|
|
368
368
|
* ```ts
|
|
@@ -112,7 +112,7 @@ export class CampfiresService extends BaseService {
|
|
|
112
112
|
* @param bucketId - The bucket ID
|
|
113
113
|
* @param campfireId - The campfire ID
|
|
114
114
|
* @param options - Optional query parameters
|
|
115
|
-
* @returns
|
|
115
|
+
* @returns Every Chatbot across all pages, with .meta.totalCount
|
|
116
116
|
*
|
|
117
117
|
* @example
|
|
118
118
|
* ```ts
|
|
@@ -288,7 +288,7 @@ export class CampfiresService extends BaseService {
|
|
|
288
288
|
/**
|
|
289
289
|
* List all campfires across the account
|
|
290
290
|
* @param options - Optional query parameters
|
|
291
|
-
* @returns
|
|
291
|
+
* @returns Every Campfire across all pages, with .meta.totalCount
|
|
292
292
|
*
|
|
293
293
|
* @example
|
|
294
294
|
* ```ts
|
|
@@ -350,7 +350,7 @@ export class CampfiresService extends BaseService {
|
|
|
350
350
|
* List all lines (messages) in a campfire
|
|
351
351
|
* @param campfireId - The campfire ID
|
|
352
352
|
* @param options - Optional query parameters
|
|
353
|
-
* @returns
|
|
353
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
354
354
|
*
|
|
355
355
|
* @example
|
|
356
356
|
* ```ts
|
|
@@ -520,7 +520,7 @@ export class CampfiresService extends BaseService {
|
|
|
520
520
|
* List uploaded files in a campfire
|
|
521
521
|
* @param campfireId - The campfire ID
|
|
522
522
|
* @param options - Optional query parameters
|
|
523
|
-
* @returns
|
|
523
|
+
* @returns Every CampfireLine across all pages, with .meta.totalCount
|
|
524
524
|
*
|
|
525
525
|
* @example
|
|
526
526
|
* ```ts
|
|
@@ -5,15 +5,19 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { BaseService } from "../../services/base.js";
|
|
7
7
|
import type { components } from "../schema.js";
|
|
8
|
-
/**
|
|
9
|
-
export type
|
|
8
|
+
/** Subtask entity from the Basecamp API. */
|
|
9
|
+
export type Subtask = components["schemas"]["Subtask"];
|
|
10
|
+
/** @deprecated renamed to Subtask, the same Kanban::Step record. */
|
|
11
|
+
export type CardStep = Subtask;
|
|
10
12
|
/**
|
|
11
13
|
* Request parameters for reposition.
|
|
12
14
|
*/
|
|
13
15
|
export interface RepositionCardStepRequest {
|
|
14
16
|
/** Source id */
|
|
15
17
|
sourceId: number;
|
|
16
|
-
/**
|
|
18
|
+
/** The 1-based position to move it to (1 = top), the same `reposition_to`
|
|
19
|
+
a to-do uses. bc3's doc said "Zero indexed" until BC3 #12659 corrected
|
|
20
|
+
it; the server never was. */
|
|
17
21
|
position: number;
|
|
18
22
|
}
|
|
19
23
|
/**
|
|
@@ -66,7 +70,7 @@ export declare class CardStepsService extends BaseService {
|
|
|
66
70
|
* Create a step on a card
|
|
67
71
|
* @param cardId - The card ID
|
|
68
72
|
* @param req - Card_step creation parameters
|
|
69
|
-
* @returns The
|
|
73
|
+
* @returns The Subtask
|
|
70
74
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
71
75
|
*
|
|
72
76
|
* @example
|
|
@@ -74,11 +78,11 @@ export declare class CardStepsService extends BaseService {
|
|
|
74
78
|
* const result = await client.cardSteps.create(123, { title: "example" });
|
|
75
79
|
* ```
|
|
76
80
|
*/
|
|
77
|
-
create(cardId: number, req: CreateCardStepRequest): Promise<
|
|
81
|
+
create(cardId: number, req: CreateCardStepRequest): Promise<Subtask>;
|
|
78
82
|
/**
|
|
79
83
|
* Get a step by ID
|
|
80
84
|
* @param stepId - The step ID
|
|
81
|
-
* @returns The
|
|
85
|
+
* @returns The Subtask
|
|
82
86
|
* @throws {BasecampError} If the resource is not found
|
|
83
87
|
*
|
|
84
88
|
* @example
|
|
@@ -86,12 +90,12 @@ export declare class CardStepsService extends BaseService {
|
|
|
86
90
|
* const result = await client.cardSteps.get(123);
|
|
87
91
|
* ```
|
|
88
92
|
*/
|
|
89
|
-
get(stepId: number): Promise<
|
|
93
|
+
get(stepId: number): Promise<Subtask>;
|
|
90
94
|
/**
|
|
91
95
|
* Update an existing step
|
|
92
96
|
* @param stepId - The step ID
|
|
93
97
|
* @param req - Card_step update parameters
|
|
94
|
-
* @returns The
|
|
98
|
+
* @returns The Subtask
|
|
95
99
|
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
96
100
|
*
|
|
97
101
|
* @example
|
|
@@ -99,12 +103,12 @@ export declare class CardStepsService extends BaseService {
|
|
|
99
103
|
* const result = await client.cardSteps.update(123, { });
|
|
100
104
|
* ```
|
|
101
105
|
*/
|
|
102
|
-
update(stepId: number, req: UpdateCardStepRequest): Promise<
|
|
106
|
+
update(stepId: number, req: UpdateCardStepRequest): Promise<Subtask>;
|
|
103
107
|
/**
|
|
104
108
|
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
105
109
|
* @param stepId - The step ID
|
|
106
110
|
* @param req - Card_step_completion request parameters
|
|
107
|
-
* @returns The
|
|
111
|
+
* @returns The Subtask
|
|
108
112
|
* @throws {BasecampError} If the request fails
|
|
109
113
|
*
|
|
110
114
|
* @example
|
|
@@ -112,6 +116,6 @@ export declare class CardStepsService extends BaseService {
|
|
|
112
116
|
* const result = await client.cardSteps.setCompletion(123, { completion: "example" });
|
|
113
117
|
* ```
|
|
114
118
|
*/
|
|
115
|
-
setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<
|
|
119
|
+
setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<Subtask>;
|
|
116
120
|
}
|
|
117
121
|
//# sourceMappingURL=card-steps.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"card-steps.d.ts","sourceRoot":"","sources":["../../../src/generated/services/card-steps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAO/C,
|
|
1
|
+
{"version":3,"file":"card-steps.d.ts","sourceRoot":"","sources":["../../../src/generated/services/card-steps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAO/C,4CAA4C;AAC5C,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC;AACvD,oEAAoE;AACpE,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB;;8BAE0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;CACpB;AAOD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB/E;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B1E;;;;;;;;;;OAUG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB3C;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC;IA2B1E;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,OAAO,CAAC;CAwBzF"}
|
|
@@ -45,7 +45,7 @@ export class CardStepsService extends BaseService {
|
|
|
45
45
|
* Create a step on a card
|
|
46
46
|
* @param cardId - The card ID
|
|
47
47
|
* @param req - Card_step creation parameters
|
|
48
|
-
* @returns The
|
|
48
|
+
* @returns The Subtask
|
|
49
49
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
50
50
|
*
|
|
51
51
|
* @example
|
|
@@ -81,7 +81,7 @@ export class CardStepsService extends BaseService {
|
|
|
81
81
|
/**
|
|
82
82
|
* Get a step by ID
|
|
83
83
|
* @param stepId - The step ID
|
|
84
|
-
* @returns The
|
|
84
|
+
* @returns The Subtask
|
|
85
85
|
* @throws {BasecampError} If the resource is not found
|
|
86
86
|
*
|
|
87
87
|
* @example
|
|
@@ -107,7 +107,7 @@ export class CardStepsService extends BaseService {
|
|
|
107
107
|
* Update an existing step
|
|
108
108
|
* @param stepId - The step ID
|
|
109
109
|
* @param req - Card_step update parameters
|
|
110
|
-
* @returns The
|
|
110
|
+
* @returns The Subtask
|
|
111
111
|
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
112
112
|
*
|
|
113
113
|
* @example
|
|
@@ -141,7 +141,7 @@ export class CardStepsService extends BaseService {
|
|
|
141
141
|
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
142
142
|
* @param stepId - The step ID
|
|
143
143
|
* @param req - Card_step_completion request parameters
|
|
144
|
-
* @returns The
|
|
144
|
+
* @returns The Subtask
|
|
145
145
|
* @throws {BasecampError} If the request fails
|
|
146
146
|
*
|
|
147
147
|
* @example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"card-steps.js","sourceRoot":"","sources":["../../../src/generated/services/card-steps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"card-steps.js","sourceRoot":"","sources":["../../../src/generated/services/card-steps.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAwDzC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAE/C;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,GAA8B;QAC7D,MAAM,IAAI,CAAC,OAAO,CAChB;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,oBAAoB;YAC/B,YAAY,EAAE,WAAW;YACzB,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4CAA4C,EAAE;YAC7D,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;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,GAA0B;QACrD,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,WAAW;YACpB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,WAAW;YACzB,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,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,MAAM,EAAE,GAAG,CAAC,KAAK;gBACjB,YAAY,EAAE,GAAG,CAAC,WAAW;aAC9B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,aAAa;YACxB,YAAY,EAAE,WAAW;YACzB,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,MAAM,CAAC,MAAc,EAAE,GAA0B;QACrD,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,WAAW;YACpB,SAAS,EAAE,gBAAgB;YAC3B,YAAY,EAAE,WAAW;YACzB,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,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,aAAa,CAAC,MAAc,EAAE,GAAiC;QACnE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,uBAAuB;YAClC,YAAY,EAAE,sBAAsB;YACpC,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,MAAM;SACnB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8CAA8C,EAAE;YAC9D,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,MAAM,EAAE;aACjB;YACD,IAAI,EAAE;gBACJ,UAAU,EAAE,GAAG,CAAC,UAAU;aAC3B;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -12,8 +12,10 @@ import { Errors } from "../../errors.js";
|
|
|
12
12
|
// Types
|
|
13
13
|
// =============================================================================
|
|
14
14
|
|
|
15
|
-
/**
|
|
16
|
-
export type
|
|
15
|
+
/** Subtask entity from the Basecamp API. */
|
|
16
|
+
export type Subtask = components["schemas"]["Subtask"];
|
|
17
|
+
/** @deprecated renamed to Subtask, the same Kanban::Step record. */
|
|
18
|
+
export type CardStep = Subtask;
|
|
17
19
|
|
|
18
20
|
/**
|
|
19
21
|
* Request parameters for reposition.
|
|
@@ -21,7 +23,9 @@ export type CardStep = components["schemas"]["CardStep"];
|
|
|
21
23
|
export interface RepositionCardStepRequest {
|
|
22
24
|
/** Source id */
|
|
23
25
|
sourceId: number;
|
|
24
|
-
/**
|
|
26
|
+
/** The 1-based position to move it to (1 = top), the same `reposition_to`
|
|
27
|
+
a to-do uses. bc3's doc said "Zero indexed" until BC3 #12659 corrected
|
|
28
|
+
it; the server never was. */
|
|
25
29
|
position: number;
|
|
26
30
|
}
|
|
27
31
|
|
|
@@ -105,7 +109,7 @@ export class CardStepsService extends BaseService {
|
|
|
105
109
|
* Create a step on a card
|
|
106
110
|
* @param cardId - The card ID
|
|
107
111
|
* @param req - Card_step creation parameters
|
|
108
|
-
* @returns The
|
|
112
|
+
* @returns The Subtask
|
|
109
113
|
* @throws {BasecampError} If required fields are missing or invalid
|
|
110
114
|
*
|
|
111
115
|
* @example
|
|
@@ -113,7 +117,7 @@ export class CardStepsService extends BaseService {
|
|
|
113
117
|
* const result = await client.cardSteps.create(123, { title: "example" });
|
|
114
118
|
* ```
|
|
115
119
|
*/
|
|
116
|
-
async create(cardId: number, req: CreateCardStepRequest): Promise<
|
|
120
|
+
async create(cardId: number, req: CreateCardStepRequest): Promise<Subtask> {
|
|
117
121
|
if (!req.title) {
|
|
118
122
|
throw Errors.validation("Title is required");
|
|
119
123
|
}
|
|
@@ -146,7 +150,7 @@ export class CardStepsService extends BaseService {
|
|
|
146
150
|
/**
|
|
147
151
|
* Get a step by ID
|
|
148
152
|
* @param stepId - The step ID
|
|
149
|
-
* @returns The
|
|
153
|
+
* @returns The Subtask
|
|
150
154
|
* @throws {BasecampError} If the resource is not found
|
|
151
155
|
*
|
|
152
156
|
* @example
|
|
@@ -154,7 +158,7 @@ export class CardStepsService extends BaseService {
|
|
|
154
158
|
* const result = await client.cardSteps.get(123);
|
|
155
159
|
* ```
|
|
156
160
|
*/
|
|
157
|
-
async get(stepId: number): Promise<
|
|
161
|
+
async get(stepId: number): Promise<Subtask> {
|
|
158
162
|
const response = await this.request(
|
|
159
163
|
{
|
|
160
164
|
service: "CardSteps",
|
|
@@ -177,7 +181,7 @@ export class CardStepsService extends BaseService {
|
|
|
177
181
|
* Update an existing step
|
|
178
182
|
* @param stepId - The step ID
|
|
179
183
|
* @param req - Card_step update parameters
|
|
180
|
-
* @returns The
|
|
184
|
+
* @returns The Subtask
|
|
181
185
|
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
182
186
|
*
|
|
183
187
|
* @example
|
|
@@ -185,7 +189,7 @@ export class CardStepsService extends BaseService {
|
|
|
185
189
|
* const result = await client.cardSteps.update(123, { });
|
|
186
190
|
* ```
|
|
187
191
|
*/
|
|
188
|
-
async update(stepId: number, req: UpdateCardStepRequest): Promise<
|
|
192
|
+
async update(stepId: number, req: UpdateCardStepRequest): Promise<Subtask> {
|
|
189
193
|
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
190
194
|
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
191
195
|
}
|
|
@@ -216,7 +220,7 @@ export class CardStepsService extends BaseService {
|
|
|
216
220
|
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
217
221
|
* @param stepId - The step ID
|
|
218
222
|
* @param req - Card_step_completion request parameters
|
|
219
|
-
* @returns The
|
|
223
|
+
* @returns The Subtask
|
|
220
224
|
* @throws {BasecampError} If the request fails
|
|
221
225
|
*
|
|
222
226
|
* @example
|
|
@@ -224,7 +228,7 @@ export class CardStepsService extends BaseService {
|
|
|
224
228
|
* const result = await client.cardSteps.setCompletion(123, { completion: "example" });
|
|
225
229
|
* ```
|
|
226
230
|
*/
|
|
227
|
-
async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<
|
|
231
|
+
async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<Subtask> {
|
|
228
232
|
if (!req.completion) {
|
|
229
233
|
throw Errors.validation("Completion is required");
|
|
230
234
|
}
|
|
@@ -97,7 +97,7 @@ export declare class CardsService extends BaseService {
|
|
|
97
97
|
* List cards in a column
|
|
98
98
|
* @param columnId - The column ID
|
|
99
99
|
* @param options - Optional query parameters
|
|
100
|
-
* @returns
|
|
100
|
+
* @returns Every Card across all pages, with .meta.totalCount
|
|
101
101
|
*
|
|
102
102
|
* @example
|
|
103
103
|
* ```ts
|
|
@@ -105,7 +105,7 @@ export class CardsService extends BaseService {
|
|
|
105
105
|
* List cards in a column
|
|
106
106
|
* @param columnId - The column ID
|
|
107
107
|
* @param options - Optional query parameters
|
|
108
|
-
* @returns
|
|
108
|
+
* @returns Every Card across all pages, with .meta.totalCount
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* ```ts
|
|
@@ -181,7 +181,7 @@ export class CardsService extends BaseService {
|
|
|
181
181
|
* List cards in a column
|
|
182
182
|
* @param columnId - The column ID
|
|
183
183
|
* @param options - Optional query parameters
|
|
184
|
-
* @returns
|
|
184
|
+
* @returns Every Card across all pages, with .meta.totalCount
|
|
185
185
|
*
|
|
186
186
|
* @example
|
|
187
187
|
* ```ts
|
|
@@ -153,7 +153,7 @@ export declare class CheckinsService extends BaseService {
|
|
|
153
153
|
* List all questions in a questionnaire
|
|
154
154
|
* @param questionnaireId - The questionnaire ID
|
|
155
155
|
* @param options - Optional query parameters
|
|
156
|
-
* @returns
|
|
156
|
+
* @returns Every Question across all pages, with .meta.totalCount
|
|
157
157
|
*
|
|
158
158
|
* @example
|
|
159
159
|
* ```ts
|
|
@@ -206,7 +206,7 @@ export declare class CheckinsService extends BaseService {
|
|
|
206
206
|
* List all answers for a question
|
|
207
207
|
* @param questionId - The question ID
|
|
208
208
|
* @param options - Optional query parameters
|
|
209
|
-
* @returns
|
|
209
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
210
210
|
*
|
|
211
211
|
* @example
|
|
212
212
|
* ```ts
|
|
@@ -234,7 +234,7 @@ export declare class CheckinsService extends BaseService {
|
|
|
234
234
|
* List all people who have answered a question (answerers)
|
|
235
235
|
* @param questionId - The question ID
|
|
236
236
|
* @param options - Optional query parameters
|
|
237
|
-
* @returns
|
|
237
|
+
* @returns Every Person across all pages, with .meta.totalCount
|
|
238
238
|
*
|
|
239
239
|
* @example
|
|
240
240
|
* ```ts
|
|
@@ -247,7 +247,7 @@ export declare class CheckinsService extends BaseService {
|
|
|
247
247
|
* @param questionId - The question ID
|
|
248
248
|
* @param personId - The person ID
|
|
249
249
|
* @param options - Optional query parameters
|
|
250
|
-
* @returns
|
|
250
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
251
251
|
*
|
|
252
252
|
* @example
|
|
253
253
|
* ```ts
|
|
@@ -123,7 +123,7 @@ export class CheckinsService extends BaseService {
|
|
|
123
123
|
* List all questions in a questionnaire
|
|
124
124
|
* @param questionnaireId - The questionnaire ID
|
|
125
125
|
* @param options - Optional query parameters
|
|
126
|
-
* @returns
|
|
126
|
+
* @returns Every Question across all pages, with .meta.totalCount
|
|
127
127
|
*
|
|
128
128
|
* @example
|
|
129
129
|
* ```ts
|
|
@@ -244,7 +244,7 @@ export class CheckinsService extends BaseService {
|
|
|
244
244
|
* List all answers for a question
|
|
245
245
|
* @param questionId - The question ID
|
|
246
246
|
* @param options - Optional query parameters
|
|
247
|
-
* @returns
|
|
247
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
248
248
|
*
|
|
249
249
|
* @example
|
|
250
250
|
* ```ts
|
|
@@ -308,7 +308,7 @@ export class CheckinsService extends BaseService {
|
|
|
308
308
|
* List all people who have answered a question (answerers)
|
|
309
309
|
* @param questionId - The question ID
|
|
310
310
|
* @param options - Optional query parameters
|
|
311
|
-
* @returns
|
|
311
|
+
* @returns Every Person across all pages, with .meta.totalCount
|
|
312
312
|
*
|
|
313
313
|
* @example
|
|
314
314
|
* ```ts
|
|
@@ -333,7 +333,7 @@ export class CheckinsService extends BaseService {
|
|
|
333
333
|
* @param questionId - The question ID
|
|
334
334
|
* @param personId - The person ID
|
|
335
335
|
* @param options - Optional query parameters
|
|
336
|
-
* @returns
|
|
336
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
337
337
|
*
|
|
338
338
|
* @example
|
|
339
339
|
* ```ts
|
|
@@ -257,7 +257,7 @@ export class CheckinsService extends BaseService {
|
|
|
257
257
|
* List all questions in a questionnaire
|
|
258
258
|
* @param questionnaireId - The questionnaire ID
|
|
259
259
|
* @param options - Optional query parameters
|
|
260
|
-
* @returns
|
|
260
|
+
* @returns Every Question across all pages, with .meta.totalCount
|
|
261
261
|
*
|
|
262
262
|
* @example
|
|
263
263
|
* ```ts
|
|
@@ -399,7 +399,7 @@ export class CheckinsService extends BaseService {
|
|
|
399
399
|
* List all answers for a question
|
|
400
400
|
* @param questionId - The question ID
|
|
401
401
|
* @param options - Optional query parameters
|
|
402
|
-
* @returns
|
|
402
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
403
403
|
*
|
|
404
404
|
* @example
|
|
405
405
|
* ```ts
|
|
@@ -474,7 +474,7 @@ export class CheckinsService extends BaseService {
|
|
|
474
474
|
* List all people who have answered a question (answerers)
|
|
475
475
|
* @param questionId - The question ID
|
|
476
476
|
* @param options - Optional query parameters
|
|
477
|
-
* @returns
|
|
477
|
+
* @returns Every Person across all pages, with .meta.totalCount
|
|
478
478
|
*
|
|
479
479
|
* @example
|
|
480
480
|
* ```ts
|
|
@@ -505,7 +505,7 @@ export class CheckinsService extends BaseService {
|
|
|
505
505
|
* @param questionId - The question ID
|
|
506
506
|
* @param personId - The person ID
|
|
507
507
|
* @param options - Optional query parameters
|
|
508
|
-
* @returns
|
|
508
|
+
* @returns Every Answer across all pages, with .meta.totalCount
|
|
509
509
|
*
|
|
510
510
|
* @example
|
|
511
511
|
* ```ts
|
|
@@ -28,7 +28,7 @@ export declare class ClientApprovalsService extends BaseService {
|
|
|
28
28
|
* List all client approvals in a project
|
|
29
29
|
* @param bucketId - The bucket ID
|
|
30
30
|
* @param options - Optional query parameters
|
|
31
|
-
* @returns
|
|
31
|
+
* @returns Every ClientApproval across all pages, with .meta.totalCount
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* ```ts
|
|
@@ -15,7 +15,7 @@ export class ClientApprovalsService extends BaseService {
|
|
|
15
15
|
* List all client approvals in a project
|
|
16
16
|
* @param bucketId - The bucket ID
|
|
17
17
|
* @param options - Optional query parameters
|
|
18
|
-
* @returns
|
|
18
|
+
* @returns Every ClientApproval across all pages, with .meta.totalCount
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
21
|
* ```ts
|
|
@@ -42,7 +42,7 @@ export class ClientApprovalsService extends BaseService {
|
|
|
42
42
|
* List all client approvals in a project
|
|
43
43
|
* @param bucketId - The bucket ID
|
|
44
44
|
* @param options - Optional query parameters
|
|
45
|
-
* @returns
|
|
45
|
+
* @returns Every ClientApproval across all pages, with .meta.totalCount
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* ```ts
|
|
@@ -28,7 +28,7 @@ export declare class ClientCorrespondencesService extends BaseService {
|
|
|
28
28
|
* List all client correspondences in a project
|
|
29
29
|
* @param bucketId - The bucket ID
|
|
30
30
|
* @param options - Optional query parameters
|
|
31
|
-
* @returns
|
|
31
|
+
* @returns Every ClientCorrespondence across all pages, with .meta.totalCount
|
|
32
32
|
*
|
|
33
33
|
* @example
|
|
34
34
|
* ```ts
|
|
@@ -15,7 +15,7 @@ export class ClientCorrespondencesService extends BaseService {
|
|
|
15
15
|
* List all client correspondences in a project
|
|
16
16
|
* @param bucketId - The bucket ID
|
|
17
17
|
* @param options - Optional query parameters
|
|
18
|
-
* @returns
|
|
18
|
+
* @returns Every ClientCorrespondence across all pages, with .meta.totalCount
|
|
19
19
|
*
|
|
20
20
|
* @example
|
|
21
21
|
* ```ts
|
|
@@ -42,7 +42,7 @@ export class ClientCorrespondencesService extends BaseService {
|
|
|
42
42
|
* List all client correspondences in a project
|
|
43
43
|
* @param bucketId - The bucket ID
|
|
44
44
|
* @param options - Optional query parameters
|
|
45
|
-
* @returns
|
|
45
|
+
* @returns Every ClientCorrespondence across all pages, with .meta.totalCount
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* ```ts
|
|
@@ -25,7 +25,7 @@ export declare class ClientRepliesService extends BaseService {
|
|
|
25
25
|
* @param bucketId - The bucket ID
|
|
26
26
|
* @param recordingId - The recording ID
|
|
27
27
|
* @param options - Optional query parameters
|
|
28
|
-
* @returns
|
|
28
|
+
* @returns Every ClientReply across all pages, with .meta.totalCount
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
31
|
* ```ts
|