@37signals/basecamp 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +600 -0
- package/dist/auth-strategy.d.ts +36 -0
- package/dist/auth-strategy.d.ts.map +1 -0
- package/dist/auth-strategy.js +33 -0
- package/dist/auth-strategy.js.map +1 -0
- package/dist/client.d.ts +224 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +715 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +137 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +269 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/metadata.json +2281 -0
- package/dist/generated/openapi-stripped.json +21268 -0
- package/dist/generated/path-mapping.d.ts +8 -0
- package/dist/generated/path-mapping.d.ts.map +1 -0
- package/dist/generated/path-mapping.js +192 -0
- package/dist/generated/path-mapping.js.map +1 -0
- package/dist/generated/path-mapping.ts +199 -0
- package/dist/generated/schema.d.ts +14883 -0
- package/dist/generated/services/attachments.d.ts +27 -0
- package/dist/generated/services/attachments.d.ts.map +1 -0
- package/dist/generated/services/attachments.js +49 -0
- package/dist/generated/services/attachments.js.map +1 -0
- package/dist/generated/services/attachments.ts +59 -0
- package/dist/generated/services/boosts.d.ts +114 -0
- package/dist/generated/services/boosts.d.ts.map +1 -0
- package/dist/generated/services/boosts.js +179 -0
- package/dist/generated/services/boosts.js.map +1 -0
- package/dist/generated/services/boosts.ts +250 -0
- package/dist/generated/services/campfires.d.ts +202 -0
- package/dist/generated/services/campfires.d.ts.map +1 -0
- package/dist/generated/services/campfires.js +309 -0
- package/dist/generated/services/campfires.js.map +1 -0
- package/dist/generated/services/campfires.ts +433 -0
- package/dist/generated/services/card-columns.d.ts +163 -0
- package/dist/generated/services/card-columns.d.ts.map +1 -0
- package/dist/generated/services/card-columns.js +264 -0
- package/dist/generated/services/card-columns.js.map +1 -0
- package/dist/generated/services/card-columns.ts +360 -0
- package/dist/generated/services/card-steps.d.ts +105 -0
- package/dist/generated/services/card-steps.d.ts.map +1 -0
- package/dist/generated/services/card-steps.js +148 -0
- package/dist/generated/services/card-steps.js.map +1 -0
- package/dist/generated/services/card-steps.ts +221 -0
- package/dist/generated/services/card-tables.d.ts +27 -0
- package/dist/generated/services/card-tables.d.ts.map +1 -0
- package/dist/generated/services/card-tables.js +40 -0
- package/dist/generated/services/card-tables.js.map +1 -0
- package/dist/generated/services/card-tables.ts +55 -0
- package/dist/generated/services/cards.d.ts +118 -0
- package/dist/generated/services/cards.d.ts.map +1 -0
- package/dist/generated/services/cards.js +166 -0
- package/dist/generated/services/cards.js.map +1 -0
- package/dist/generated/services/cards.ts +247 -0
- package/dist/generated/services/checkins.d.ts +278 -0
- package/dist/generated/services/checkins.d.ts.map +1 -0
- package/dist/generated/services/checkins.js +420 -0
- package/dist/generated/services/checkins.js.map +1 -0
- package/dist/generated/services/checkins.ts +600 -0
- package/dist/generated/services/client-approvals.d.ts +45 -0
- package/dist/generated/services/client-approvals.d.ts.map +1 -0
- package/dist/generated/services/client-approvals.js +58 -0
- package/dist/generated/services/client-approvals.js.map +1 -0
- package/dist/generated/services/client-approvals.ts +89 -0
- package/dist/generated/services/client-correspondences.d.ts +45 -0
- package/dist/generated/services/client-correspondences.d.ts.map +1 -0
- package/dist/generated/services/client-correspondences.js +58 -0
- package/dist/generated/services/client-correspondences.js.map +1 -0
- package/dist/generated/services/client-correspondences.ts +89 -0
- package/dist/generated/services/client-replies.d.ts +47 -0
- package/dist/generated/services/client-replies.d.ts.map +1 -0
- package/dist/generated/services/client-replies.js +65 -0
- package/dist/generated/services/client-replies.js.map +1 -0
- package/dist/generated/services/client-replies.ts +95 -0
- package/dist/generated/services/client-visibility.d.ts +35 -0
- package/dist/generated/services/client-visibility.d.ts.map +1 -0
- package/dist/generated/services/client-visibility.js +44 -0
- package/dist/generated/services/client-visibility.js.map +1 -0
- package/dist/generated/services/client-visibility.ts +68 -0
- package/dist/generated/services/comments.d.ts +86 -0
- package/dist/generated/services/comments.d.ts.map +1 -0
- package/dist/generated/services/comments.js +129 -0
- package/dist/generated/services/comments.js.map +1 -0
- package/dist/generated/services/comments.ts +185 -0
- package/dist/generated/services/documents.d.ts +92 -0
- package/dist/generated/services/documents.d.ts.map +1 -0
- package/dist/generated/services/documents.js +129 -0
- package/dist/generated/services/documents.js.map +1 -0
- package/dist/generated/services/documents.ts +191 -0
- package/dist/generated/services/events.d.ts +34 -0
- package/dist/generated/services/events.d.ts.map +1 -0
- package/dist/generated/services/events.js +39 -0
- package/dist/generated/services/events.js.map +1 -0
- package/dist/generated/services/events.ts +64 -0
- package/dist/generated/services/forwards.d.ts +112 -0
- package/dist/generated/services/forwards.d.ts.map +1 -0
- package/dist/generated/services/forwards.js +172 -0
- package/dist/generated/services/forwards.js.map +1 -0
- package/dist/generated/services/forwards.ts +241 -0
- package/dist/generated/services/index.d.ts +39 -0
- package/dist/generated/services/index.d.ts.map +1 -0
- package/dist/generated/services/index.js +39 -0
- package/dist/generated/services/index.js.map +1 -0
- package/dist/generated/services/index.ts +38 -0
- package/dist/generated/services/lineup.d.ts +67 -0
- package/dist/generated/services/lineup.d.ts.map +1 -0
- package/dist/generated/services/lineup.js +99 -0
- package/dist/generated/services/lineup.js.map +1 -0
- package/dist/generated/services/lineup.ts +143 -0
- package/dist/generated/services/message-boards.d.ts +27 -0
- package/dist/generated/services/message-boards.d.ts.map +1 -0
- package/dist/generated/services/message-boards.js +40 -0
- package/dist/generated/services/message-boards.js.map +1 -0
- package/dist/generated/services/message-boards.ts +55 -0
- package/dist/generated/services/message-types.d.ts +100 -0
- package/dist/generated/services/message-types.d.ts.map +1 -0
- package/dist/generated/services/message-types.js +144 -0
- package/dist/generated/services/message-types.js.map +1 -0
- package/dist/generated/services/message-types.ts +210 -0
- package/dist/generated/services/messages.d.ts +122 -0
- package/dist/generated/services/messages.d.ts.map +1 -0
- package/dist/generated/services/messages.js +180 -0
- package/dist/generated/services/messages.js.map +1 -0
- package/dist/generated/services/messages.ts +258 -0
- package/dist/generated/services/people.d.ts +122 -0
- package/dist/generated/services/people.d.ts.map +1 -0
- package/dist/generated/services/people.js +167 -0
- package/dist/generated/services/people.js.map +1 -0
- package/dist/generated/services/people.ts +252 -0
- package/dist/generated/services/projects.d.ts +109 -0
- package/dist/generated/services/projects.d.ts.map +1 -0
- package/dist/generated/services/projects.js +153 -0
- package/dist/generated/services/projects.js.map +1 -0
- package/dist/generated/services/projects.ts +224 -0
- package/dist/generated/services/recordings.d.ts +93 -0
- package/dist/generated/services/recordings.d.ts.map +1 -0
- package/dist/generated/services/recordings.js +138 -0
- package/dist/generated/services/recordings.js.map +1 -0
- package/dist/generated/services/recordings.ts +191 -0
- package/dist/generated/services/reports.d.ts +90 -0
- package/dist/generated/services/reports.d.ts.map +1 -0
- package/dist/generated/services/reports.js +124 -0
- package/dist/generated/services/reports.js.map +1 -0
- package/dist/generated/services/reports.ts +187 -0
- package/dist/generated/services/schedules.d.ts +162 -0
- package/dist/generated/services/schedules.d.ts.map +1 -0
- package/dist/generated/services/schedules.js +228 -0
- package/dist/generated/services/schedules.js.map +1 -0
- package/dist/generated/services/schedules.ts +335 -0
- package/dist/generated/services/search.d.ts +45 -0
- package/dist/generated/services/search.d.ts.map +1 -0
- package/dist/generated/services/search.js +56 -0
- package/dist/generated/services/search.js.map +1 -0
- package/dist/generated/services/search.ts +89 -0
- package/dist/generated/services/subscriptions.d.ts +73 -0
- package/dist/generated/services/subscriptions.d.ts.map +1 -0
- package/dist/generated/services/subscriptions.js +119 -0
- package/dist/generated/services/subscriptions.js.map +1 -0
- package/dist/generated/services/subscriptions.ts +160 -0
- package/dist/generated/services/templates.d.ts +140 -0
- package/dist/generated/services/templates.d.ts.map +1 -0
- package/dist/generated/services/templates.js +207 -0
- package/dist/generated/services/templates.js.map +1 -0
- package/dist/generated/services/templates.ts +294 -0
- package/dist/generated/services/timeline.d.ts +31 -0
- package/dist/generated/services/timeline.d.ts.map +1 -0
- package/dist/generated/services/timeline.js +39 -0
- package/dist/generated/services/timeline.js.map +1 -0
- package/dist/generated/services/timeline.ts +62 -0
- package/dist/generated/services/timesheets.d.ts +145 -0
- package/dist/generated/services/timesheets.d.ts.map +1 -0
- package/dist/generated/services/timesheets.js +186 -0
- package/dist/generated/services/timesheets.js.map +1 -0
- package/dist/generated/services/timesheets.ts +289 -0
- package/dist/generated/services/todolist-groups.d.ts +74 -0
- package/dist/generated/services/todolist-groups.d.ts.map +1 -0
- package/dist/generated/services/todolist-groups.js +100 -0
- package/dist/generated/services/todolist-groups.js.map +1 -0
- package/dist/generated/services/todolist-groups.ts +151 -0
- package/dist/generated/services/todolists.d.ts +95 -0
- package/dist/generated/services/todolists.d.ts.map +1 -0
- package/dist/generated/services/todolists.js +130 -0
- package/dist/generated/services/todolists.js.map +1 -0
- package/dist/generated/services/todolists.ts +192 -0
- package/dist/generated/services/todos.d.ts +175 -0
- package/dist/generated/services/todos.d.ts.map +1 -0
- package/dist/generated/services/todos.js +255 -0
- package/dist/generated/services/todos.js.map +1 -0
- package/dist/generated/services/todos.ts +369 -0
- package/dist/generated/services/todosets.d.ts +27 -0
- package/dist/generated/services/todosets.d.ts.map +1 -0
- package/dist/generated/services/todosets.js +40 -0
- package/dist/generated/services/todosets.js.map +1 -0
- package/dist/generated/services/todosets.ts +55 -0
- package/dist/generated/services/tools.d.ts +122 -0
- package/dist/generated/services/tools.d.ts.map +1 -0
- package/dist/generated/services/tools.js +197 -0
- package/dist/generated/services/tools.js.map +1 -0
- package/dist/generated/services/tools.ts +267 -0
- package/dist/generated/services/uploads.d.ts +109 -0
- package/dist/generated/services/uploads.d.ts.map +1 -0
- package/dist/generated/services/uploads.js +153 -0
- package/dist/generated/services/uploads.js.map +1 -0
- package/dist/generated/services/uploads.ts +227 -0
- package/dist/generated/services/vaults.d.ts +86 -0
- package/dist/generated/services/vaults.d.ts.map +1 -0
- package/dist/generated/services/vaults.js +126 -0
- package/dist/generated/services/vaults.js.map +1 -0
- package/dist/generated/services/vaults.ts +182 -0
- package/dist/generated/services/webhooks.d.ts +106 -0
- package/dist/generated/services/webhooks.d.ts.map +1 -0
- package/dist/generated/services/webhooks.js +157 -0
- package/dist/generated/services/webhooks.js.map +1 -0
- package/dist/generated/services/webhooks.ts +226 -0
- package/dist/hooks/otel.d.ts +136 -0
- package/dist/hooks/otel.d.ts.map +1 -0
- package/dist/hooks/otel.js +240 -0
- package/dist/hooks/otel.js.map +1 -0
- package/dist/hooks.d.ts +171 -0
- package/dist/hooks.d.ts.map +1 -0
- package/dist/hooks.js +196 -0
- package/dist/hooks.js.map +1 -0
- package/dist/index.d.ts +90 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +122 -0
- package/dist/index.js.map +1 -0
- package/dist/oauth/authorize.d.ts +48 -0
- package/dist/oauth/authorize.d.ts.map +1 -0
- package/dist/oauth/authorize.js +56 -0
- package/dist/oauth/authorize.js.map +1 -0
- package/dist/oauth/callback-server.d.ts +56 -0
- package/dist/oauth/callback-server.d.ts.map +1 -0
- package/dist/oauth/callback-server.js +150 -0
- package/dist/oauth/callback-server.js.map +1 -0
- package/dist/oauth/discovery.d.ts +54 -0
- package/dist/oauth/discovery.d.ts.map +1 -0
- package/dist/oauth/discovery.js +116 -0
- package/dist/oauth/discovery.js.map +1 -0
- package/dist/oauth/exchange.d.ts +96 -0
- package/dist/oauth/exchange.d.ts.map +1 -0
- package/dist/oauth/exchange.js +324 -0
- package/dist/oauth/exchange.js.map +1 -0
- package/dist/oauth/identity.d.ts +30 -0
- package/dist/oauth/identity.d.ts.map +1 -0
- package/dist/oauth/identity.js +82 -0
- package/dist/oauth/identity.js.map +1 -0
- package/dist/oauth/index.d.ts +50 -0
- package/dist/oauth/index.d.ts.map +1 -0
- package/dist/oauth/index.js +58 -0
- package/dist/oauth/index.js.map +1 -0
- package/dist/oauth/interactive-login.d.ts +62 -0
- package/dist/oauth/interactive-login.d.ts.map +1 -0
- package/dist/oauth/interactive-login.js +106 -0
- package/dist/oauth/interactive-login.js.map +1 -0
- package/dist/oauth/pkce.d.ts +68 -0
- package/dist/oauth/pkce.d.ts.map +1 -0
- package/dist/oauth/pkce.js +80 -0
- package/dist/oauth/pkce.js.map +1 -0
- package/dist/oauth/token-manager.d.ts +92 -0
- package/dist/oauth/token-manager.d.ts.map +1 -0
- package/dist/oauth/token-manager.js +126 -0
- package/dist/oauth/token-manager.js.map +1 -0
- package/dist/oauth/token-store.d.ts +45 -0
- package/dist/oauth/token-store.d.ts.map +1 -0
- package/dist/oauth/token-store.js +105 -0
- package/dist/oauth/token-store.js.map +1 -0
- package/dist/oauth/types.d.ts +98 -0
- package/dist/oauth/types.d.ts.map +1 -0
- package/dist/oauth/types.js +8 -0
- package/dist/oauth/types.js.map +1 -0
- package/dist/pagination-utils.d.ts +27 -0
- package/dist/pagination-utils.d.ts.map +1 -0
- package/dist/pagination-utils.js +54 -0
- package/dist/pagination-utils.js.map +1 -0
- package/dist/pagination.d.ts +56 -0
- package/dist/pagination.d.ts.map +1 -0
- package/dist/pagination.js +57 -0
- package/dist/pagination.js.map +1 -0
- package/dist/security.d.ts +68 -0
- package/dist/security.d.ts.map +1 -0
- package/dist/security.js +107 -0
- package/dist/security.js.map +1 -0
- package/dist/services/authorization.d.ts +124 -0
- package/dist/services/authorization.d.ts.map +1 -0
- package/dist/services/authorization.js +117 -0
- package/dist/services/authorization.js.map +1 -0
- package/dist/services/base.d.ts +102 -0
- package/dist/services/base.d.ts.map +1 -0
- package/dist/services/base.js +230 -0
- package/dist/services/base.js.map +1 -0
- package/dist/webhooks/adapters/node-http.d.ts +14 -0
- package/dist/webhooks/adapters/node-http.d.ts.map +1 -0
- package/dist/webhooks/adapters/node-http.js +60 -0
- package/dist/webhooks/adapters/node-http.js.map +1 -0
- package/dist/webhooks/events.d.ts +52 -0
- package/dist/webhooks/events.d.ts.map +1 -0
- package/dist/webhooks/events.js +52 -0
- package/dist/webhooks/events.js.map +1 -0
- package/dist/webhooks/handler.d.ts +62 -0
- package/dist/webhooks/handler.d.ts.map +1 -0
- package/dist/webhooks/handler.js +226 -0
- package/dist/webhooks/handler.js.map +1 -0
- package/dist/webhooks/index.d.ts +5 -0
- package/dist/webhooks/index.d.ts.map +1 -0
- package/dist/webhooks/index.js +5 -0
- package/dist/webhooks/index.js.map +1 -0
- package/dist/webhooks/verify.d.ts +11 -0
- package/dist/webhooks/verify.d.ts.map +1 -0
- package/dist/webhooks/verify.js +25 -0
- package/dist/webhooks/verify.js.map +1 -0
- package/package.json +70 -0
- package/src/generated/metadata.json +2281 -0
- package/src/generated/openapi-stripped.json +21268 -0
- package/src/generated/path-mapping.ts +199 -0
- package/src/generated/schema.d.ts +14883 -0
- package/src/generated/services/attachments.ts +59 -0
- package/src/generated/services/boosts.ts +250 -0
- package/src/generated/services/campfires.ts +433 -0
- package/src/generated/services/card-columns.ts +360 -0
- package/src/generated/services/card-steps.ts +221 -0
- package/src/generated/services/card-tables.ts +55 -0
- package/src/generated/services/cards.ts +247 -0
- package/src/generated/services/checkins.ts +600 -0
- package/src/generated/services/client-approvals.ts +89 -0
- package/src/generated/services/client-correspondences.ts +89 -0
- package/src/generated/services/client-replies.ts +95 -0
- package/src/generated/services/client-visibility.ts +68 -0
- package/src/generated/services/comments.ts +185 -0
- package/src/generated/services/documents.ts +191 -0
- package/src/generated/services/events.ts +64 -0
- package/src/generated/services/forwards.ts +241 -0
- package/src/generated/services/index.ts +38 -0
- package/src/generated/services/lineup.ts +143 -0
- package/src/generated/services/message-boards.ts +55 -0
- package/src/generated/services/message-types.ts +210 -0
- package/src/generated/services/messages.ts +258 -0
- package/src/generated/services/people.ts +252 -0
- package/src/generated/services/projects.ts +224 -0
- package/src/generated/services/recordings.ts +191 -0
- package/src/generated/services/reports.ts +187 -0
- package/src/generated/services/schedules.ts +335 -0
- package/src/generated/services/search.ts +89 -0
- package/src/generated/services/subscriptions.ts +160 -0
- package/src/generated/services/templates.ts +294 -0
- package/src/generated/services/timeline.ts +62 -0
- package/src/generated/services/timesheets.ts +289 -0
- package/src/generated/services/todolist-groups.ts +151 -0
- package/src/generated/services/todolists.ts +192 -0
- package/src/generated/services/todos.ts +369 -0
- package/src/generated/services/todosets.ts +55 -0
- package/src/generated/services/tools.ts +267 -0
- package/src/generated/services/uploads.ts +227 -0
- package/src/generated/services/vaults.ts +182 -0
- package/src/generated/services/webhooks.ts +226 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardSteps 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
|
+
/** CardStep entity from the Basecamp API. */
|
|
9
|
+
export type CardStep = components["schemas"]["CardStep"];
|
|
10
|
+
/**
|
|
11
|
+
* Request parameters for reposition.
|
|
12
|
+
*/
|
|
13
|
+
export interface RepositionCardStepRequest {
|
|
14
|
+
/** Source id */
|
|
15
|
+
sourceId: number;
|
|
16
|
+
/** 0-indexed position */
|
|
17
|
+
position: number;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Request parameters for create.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateCardStepRequest {
|
|
23
|
+
/** Title */
|
|
24
|
+
title: string;
|
|
25
|
+
/** Due date (YYYY-MM-DD) */
|
|
26
|
+
dueOn?: string;
|
|
27
|
+
/** Assignees */
|
|
28
|
+
assignees?: number[];
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Request parameters for update.
|
|
32
|
+
*/
|
|
33
|
+
export interface UpdateCardStepRequest {
|
|
34
|
+
/** Title */
|
|
35
|
+
title?: string;
|
|
36
|
+
/** Due date (YYYY-MM-DD) */
|
|
37
|
+
dueOn?: string;
|
|
38
|
+
/** Assignees */
|
|
39
|
+
assignees?: number[];
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Request parameters for setCompletion.
|
|
43
|
+
*/
|
|
44
|
+
export interface SetCompletionCardStepRequest {
|
|
45
|
+
/** Set to "on" to complete the step, "" (empty) to uncomplete */
|
|
46
|
+
completion: string;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Service for CardSteps operations.
|
|
50
|
+
*/
|
|
51
|
+
export declare class CardStepsService extends BaseService {
|
|
52
|
+
/**
|
|
53
|
+
* Reposition a step within a card
|
|
54
|
+
* @param cardId - The card ID
|
|
55
|
+
* @param req - Card_step request parameters
|
|
56
|
+
* @returns void
|
|
57
|
+
* @throws {BasecampError} If the request fails
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* await client.cardSteps.reposition(123, { sourceId: 1, position: 1 });
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
reposition(cardId: number, req: RepositionCardStepRequest): Promise<void>;
|
|
65
|
+
/**
|
|
66
|
+
* Create a step on a card
|
|
67
|
+
* @param cardId - The card ID
|
|
68
|
+
* @param req - Card_step creation parameters
|
|
69
|
+
* @returns The CardStep
|
|
70
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* const result = await client.cardSteps.create(123, { title: "example" });
|
|
75
|
+
* ```
|
|
76
|
+
*/
|
|
77
|
+
create(cardId: number, req: CreateCardStepRequest): Promise<CardStep>;
|
|
78
|
+
/**
|
|
79
|
+
* Update an existing step
|
|
80
|
+
* @param stepId - The step ID
|
|
81
|
+
* @param req - Card_step update parameters
|
|
82
|
+
* @returns The CardStep
|
|
83
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const result = await client.cardSteps.update(123, { });
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
update(stepId: number, req: UpdateCardStepRequest): Promise<CardStep>;
|
|
91
|
+
/**
|
|
92
|
+
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
93
|
+
* @param stepId - The step ID
|
|
94
|
+
* @param req - Card_step_completion request parameters
|
|
95
|
+
* @returns The CardStep
|
|
96
|
+
* @throws {BasecampError} If the request fails
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* ```ts
|
|
100
|
+
* const result = await client.cardSteps.setCompletion(123, { completion: "example" });
|
|
101
|
+
* ```
|
|
102
|
+
*/
|
|
103
|
+
setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<CardStep>;
|
|
104
|
+
}
|
|
105
|
+
//# sourceMappingURL=card-steps.d.ts.map
|
|
@@ -0,0 +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,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,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,gBAAgB;IAChB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB;IAChB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;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,QAAQ,CAAC;IA8B3E;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IA2B3E;;;;;;;;;;;OAWG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,QAAQ,CAAC;CAwB1F"}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardSteps 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 { Errors } from "../../errors.js";
|
|
8
|
+
// =============================================================================
|
|
9
|
+
// Service
|
|
10
|
+
// =============================================================================
|
|
11
|
+
/**
|
|
12
|
+
* Service for CardSteps operations.
|
|
13
|
+
*/
|
|
14
|
+
export class CardStepsService extends BaseService {
|
|
15
|
+
/**
|
|
16
|
+
* Reposition a step within a card
|
|
17
|
+
* @param cardId - The card ID
|
|
18
|
+
* @param req - Card_step request parameters
|
|
19
|
+
* @returns void
|
|
20
|
+
* @throws {BasecampError} If the request fails
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* await client.cardSteps.reposition(123, { sourceId: 1, position: 1 });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
async reposition(cardId, req) {
|
|
28
|
+
await this.request({
|
|
29
|
+
service: "CardSteps",
|
|
30
|
+
operation: "RepositionCardStep",
|
|
31
|
+
resourceType: "card_step",
|
|
32
|
+
isMutation: true,
|
|
33
|
+
resourceId: cardId,
|
|
34
|
+
}, () => this.client.POST("/card_tables/cards/{cardId}/positions.json", {
|
|
35
|
+
params: {
|
|
36
|
+
path: { cardId },
|
|
37
|
+
},
|
|
38
|
+
body: {
|
|
39
|
+
source_id: req.sourceId,
|
|
40
|
+
position: req.position,
|
|
41
|
+
},
|
|
42
|
+
}));
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Create a step on a card
|
|
46
|
+
* @param cardId - The card ID
|
|
47
|
+
* @param req - Card_step creation parameters
|
|
48
|
+
* @returns The CardStep
|
|
49
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const result = await client.cardSteps.create(123, { title: "example" });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
async create(cardId, req) {
|
|
57
|
+
if (!req.title) {
|
|
58
|
+
throw Errors.validation("Title is required");
|
|
59
|
+
}
|
|
60
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
61
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
62
|
+
}
|
|
63
|
+
const response = await this.request({
|
|
64
|
+
service: "CardSteps",
|
|
65
|
+
operation: "CreateCardStep",
|
|
66
|
+
resourceType: "card_step",
|
|
67
|
+
isMutation: true,
|
|
68
|
+
resourceId: cardId,
|
|
69
|
+
}, () => this.client.POST("/card_tables/cards/{cardId}/steps.json", {
|
|
70
|
+
params: {
|
|
71
|
+
path: { cardId },
|
|
72
|
+
},
|
|
73
|
+
body: {
|
|
74
|
+
title: req.title,
|
|
75
|
+
due_on: req.dueOn,
|
|
76
|
+
assignees: req.assignees,
|
|
77
|
+
},
|
|
78
|
+
}));
|
|
79
|
+
return response;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Update an existing step
|
|
83
|
+
* @param stepId - The step ID
|
|
84
|
+
* @param req - Card_step update parameters
|
|
85
|
+
* @returns The CardStep
|
|
86
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const result = await client.cardSteps.update(123, { });
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
async update(stepId, req) {
|
|
94
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
95
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
96
|
+
}
|
|
97
|
+
const response = await this.request({
|
|
98
|
+
service: "CardSteps",
|
|
99
|
+
operation: "UpdateCardStep",
|
|
100
|
+
resourceType: "card_step",
|
|
101
|
+
isMutation: true,
|
|
102
|
+
resourceId: stepId,
|
|
103
|
+
}, () => this.client.PUT("/card_tables/steps/{stepId}", {
|
|
104
|
+
params: {
|
|
105
|
+
path: { stepId },
|
|
106
|
+
},
|
|
107
|
+
body: {
|
|
108
|
+
title: req.title,
|
|
109
|
+
due_on: req.dueOn,
|
|
110
|
+
assignees: req.assignees,
|
|
111
|
+
},
|
|
112
|
+
}));
|
|
113
|
+
return response;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
117
|
+
* @param stepId - The step ID
|
|
118
|
+
* @param req - Card_step_completion request parameters
|
|
119
|
+
* @returns The CardStep
|
|
120
|
+
* @throws {BasecampError} If the request fails
|
|
121
|
+
*
|
|
122
|
+
* @example
|
|
123
|
+
* ```ts
|
|
124
|
+
* const result = await client.cardSteps.setCompletion(123, { completion: "example" });
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
async setCompletion(stepId, req) {
|
|
128
|
+
if (!req.completion) {
|
|
129
|
+
throw Errors.validation("Completion is required");
|
|
130
|
+
}
|
|
131
|
+
const response = await this.request({
|
|
132
|
+
service: "CardSteps",
|
|
133
|
+
operation: "SetCardStepCompletion",
|
|
134
|
+
resourceType: "card_step_completion",
|
|
135
|
+
isMutation: true,
|
|
136
|
+
resourceId: stepId,
|
|
137
|
+
}, () => this.client.PUT("/card_tables/steps/{stepId}/completions.json", {
|
|
138
|
+
params: {
|
|
139
|
+
path: { stepId },
|
|
140
|
+
},
|
|
141
|
+
body: {
|
|
142
|
+
completion: req.completion,
|
|
143
|
+
},
|
|
144
|
+
}));
|
|
145
|
+
return response;
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
//# sourceMappingURL=card-steps.js.map
|
|
@@ -0,0 +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;AAoDzC,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,SAAS,EAAE,GAAG,CAAC,SAAS;aACzB;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,SAAS,EAAE,GAAG,CAAC,SAAS;aACzB;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"}
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardSteps service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BaseService } from "../../services/base.js";
|
|
8
|
+
import type { components } from "../schema.js";
|
|
9
|
+
import { Errors } from "../../errors.js";
|
|
10
|
+
|
|
11
|
+
// =============================================================================
|
|
12
|
+
// Types
|
|
13
|
+
// =============================================================================
|
|
14
|
+
|
|
15
|
+
/** CardStep entity from the Basecamp API. */
|
|
16
|
+
export type CardStep = components["schemas"]["CardStep"];
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Request parameters for reposition.
|
|
20
|
+
*/
|
|
21
|
+
export interface RepositionCardStepRequest {
|
|
22
|
+
/** Source id */
|
|
23
|
+
sourceId: number;
|
|
24
|
+
/** 0-indexed position */
|
|
25
|
+
position: number;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Request parameters for create.
|
|
30
|
+
*/
|
|
31
|
+
export interface CreateCardStepRequest {
|
|
32
|
+
/** Title */
|
|
33
|
+
title: string;
|
|
34
|
+
/** Due date (YYYY-MM-DD) */
|
|
35
|
+
dueOn?: string;
|
|
36
|
+
/** Assignees */
|
|
37
|
+
assignees?: number[];
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Request parameters for update.
|
|
42
|
+
*/
|
|
43
|
+
export interface UpdateCardStepRequest {
|
|
44
|
+
/** Title */
|
|
45
|
+
title?: string;
|
|
46
|
+
/** Due date (YYYY-MM-DD) */
|
|
47
|
+
dueOn?: string;
|
|
48
|
+
/** Assignees */
|
|
49
|
+
assignees?: number[];
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Request parameters for setCompletion.
|
|
54
|
+
*/
|
|
55
|
+
export interface SetCompletionCardStepRequest {
|
|
56
|
+
/** Set to "on" to complete the step, "" (empty) to uncomplete */
|
|
57
|
+
completion: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
// =============================================================================
|
|
62
|
+
// Service
|
|
63
|
+
// =============================================================================
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Service for CardSteps operations.
|
|
67
|
+
*/
|
|
68
|
+
export class CardStepsService extends BaseService {
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Reposition a step within a card
|
|
72
|
+
* @param cardId - The card ID
|
|
73
|
+
* @param req - Card_step request parameters
|
|
74
|
+
* @returns void
|
|
75
|
+
* @throws {BasecampError} If the request fails
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* await client.cardSteps.reposition(123, { sourceId: 1, position: 1 });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
async reposition(cardId: number, req: RepositionCardStepRequest): Promise<void> {
|
|
83
|
+
await this.request(
|
|
84
|
+
{
|
|
85
|
+
service: "CardSteps",
|
|
86
|
+
operation: "RepositionCardStep",
|
|
87
|
+
resourceType: "card_step",
|
|
88
|
+
isMutation: true,
|
|
89
|
+
resourceId: cardId,
|
|
90
|
+
},
|
|
91
|
+
() =>
|
|
92
|
+
this.client.POST("/card_tables/cards/{cardId}/positions.json", {
|
|
93
|
+
params: {
|
|
94
|
+
path: { cardId },
|
|
95
|
+
},
|
|
96
|
+
body: {
|
|
97
|
+
source_id: req.sourceId,
|
|
98
|
+
position: req.position,
|
|
99
|
+
},
|
|
100
|
+
})
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Create a step on a card
|
|
106
|
+
* @param cardId - The card ID
|
|
107
|
+
* @param req - Card_step creation parameters
|
|
108
|
+
* @returns The CardStep
|
|
109
|
+
* @throws {BasecampError} If required fields are missing or invalid
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```ts
|
|
113
|
+
* const result = await client.cardSteps.create(123, { title: "example" });
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
async create(cardId: number, req: CreateCardStepRequest): Promise<CardStep> {
|
|
117
|
+
if (!req.title) {
|
|
118
|
+
throw Errors.validation("Title is required");
|
|
119
|
+
}
|
|
120
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
121
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
122
|
+
}
|
|
123
|
+
const response = await this.request(
|
|
124
|
+
{
|
|
125
|
+
service: "CardSteps",
|
|
126
|
+
operation: "CreateCardStep",
|
|
127
|
+
resourceType: "card_step",
|
|
128
|
+
isMutation: true,
|
|
129
|
+
resourceId: cardId,
|
|
130
|
+
},
|
|
131
|
+
() =>
|
|
132
|
+
this.client.POST("/card_tables/cards/{cardId}/steps.json", {
|
|
133
|
+
params: {
|
|
134
|
+
path: { cardId },
|
|
135
|
+
},
|
|
136
|
+
body: {
|
|
137
|
+
title: req.title,
|
|
138
|
+
due_on: req.dueOn,
|
|
139
|
+
assignees: req.assignees,
|
|
140
|
+
},
|
|
141
|
+
})
|
|
142
|
+
);
|
|
143
|
+
return response;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* Update an existing step
|
|
148
|
+
* @param stepId - The step ID
|
|
149
|
+
* @param req - Card_step update parameters
|
|
150
|
+
* @returns The CardStep
|
|
151
|
+
* @throws {BasecampError} If the resource is not found or fields are invalid
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* ```ts
|
|
155
|
+
* const result = await client.cardSteps.update(123, { });
|
|
156
|
+
* ```
|
|
157
|
+
*/
|
|
158
|
+
async update(stepId: number, req: UpdateCardStepRequest): Promise<CardStep> {
|
|
159
|
+
if (req.dueOn && !/^\d{4}-\d{2}-\d{2}$/.test(req.dueOn)) {
|
|
160
|
+
throw Errors.validation("Due on must be in YYYY-MM-DD format");
|
|
161
|
+
}
|
|
162
|
+
const response = await this.request(
|
|
163
|
+
{
|
|
164
|
+
service: "CardSteps",
|
|
165
|
+
operation: "UpdateCardStep",
|
|
166
|
+
resourceType: "card_step",
|
|
167
|
+
isMutation: true,
|
|
168
|
+
resourceId: stepId,
|
|
169
|
+
},
|
|
170
|
+
() =>
|
|
171
|
+
this.client.PUT("/card_tables/steps/{stepId}", {
|
|
172
|
+
params: {
|
|
173
|
+
path: { stepId },
|
|
174
|
+
},
|
|
175
|
+
body: {
|
|
176
|
+
title: req.title,
|
|
177
|
+
due_on: req.dueOn,
|
|
178
|
+
assignees: req.assignees,
|
|
179
|
+
},
|
|
180
|
+
})
|
|
181
|
+
);
|
|
182
|
+
return response;
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)
|
|
187
|
+
* @param stepId - The step ID
|
|
188
|
+
* @param req - Card_step_completion request parameters
|
|
189
|
+
* @returns The CardStep
|
|
190
|
+
* @throws {BasecampError} If the request fails
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```ts
|
|
194
|
+
* const result = await client.cardSteps.setCompletion(123, { completion: "example" });
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
197
|
+
async setCompletion(stepId: number, req: SetCompletionCardStepRequest): Promise<CardStep> {
|
|
198
|
+
if (!req.completion) {
|
|
199
|
+
throw Errors.validation("Completion is required");
|
|
200
|
+
}
|
|
201
|
+
const response = await this.request(
|
|
202
|
+
{
|
|
203
|
+
service: "CardSteps",
|
|
204
|
+
operation: "SetCardStepCompletion",
|
|
205
|
+
resourceType: "card_step_completion",
|
|
206
|
+
isMutation: true,
|
|
207
|
+
resourceId: stepId,
|
|
208
|
+
},
|
|
209
|
+
() =>
|
|
210
|
+
this.client.PUT("/card_tables/steps/{stepId}/completions.json", {
|
|
211
|
+
params: {
|
|
212
|
+
path: { stepId },
|
|
213
|
+
},
|
|
214
|
+
body: {
|
|
215
|
+
completion: req.completion,
|
|
216
|
+
},
|
|
217
|
+
})
|
|
218
|
+
);
|
|
219
|
+
return response;
|
|
220
|
+
}
|
|
221
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardTables 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
|
+
/** CardTable entity from the Basecamp API. */
|
|
9
|
+
export type CardTable = components["schemas"]["CardTable"];
|
|
10
|
+
/**
|
|
11
|
+
* Service for CardTables operations.
|
|
12
|
+
*/
|
|
13
|
+
export declare class CardTablesService extends BaseService {
|
|
14
|
+
/**
|
|
15
|
+
* Get a card table by ID
|
|
16
|
+
* @param cardTableId - The card table ID
|
|
17
|
+
* @returns The CardTable
|
|
18
|
+
* @throws {BasecampError} If the resource is not found
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const result = await client.cardTables.get(123);
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
get(cardTableId: number): Promise<CardTable>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=card-tables.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"card-tables.d.ts","sourceRoot":"","sources":["../../../src/generated/services/card-tables.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAM/C,8CAA8C;AAC9C,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAM3D;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAEhD;;;;;;;;;;OAUG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAkBnD"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardTables service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
import { BaseService } from "../../services/base.js";
|
|
7
|
+
// =============================================================================
|
|
8
|
+
// Service
|
|
9
|
+
// =============================================================================
|
|
10
|
+
/**
|
|
11
|
+
* Service for CardTables operations.
|
|
12
|
+
*/
|
|
13
|
+
export class CardTablesService extends BaseService {
|
|
14
|
+
/**
|
|
15
|
+
* Get a card table by ID
|
|
16
|
+
* @param cardTableId - The card table ID
|
|
17
|
+
* @returns The CardTable
|
|
18
|
+
* @throws {BasecampError} If the resource is not found
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* const result = await client.cardTables.get(123);
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
async get(cardTableId) {
|
|
26
|
+
const response = await this.request({
|
|
27
|
+
service: "CardTables",
|
|
28
|
+
operation: "GetCardTable",
|
|
29
|
+
resourceType: "card_table",
|
|
30
|
+
isMutation: false,
|
|
31
|
+
resourceId: cardTableId,
|
|
32
|
+
}, () => this.client.GET("/card_tables/{cardTableId}", {
|
|
33
|
+
params: {
|
|
34
|
+
path: { cardTableId },
|
|
35
|
+
},
|
|
36
|
+
}));
|
|
37
|
+
return response;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=card-tables.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"card-tables.js","sourceRoot":"","sources":["../../../src/generated/services/card-tables.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAUrD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAEhD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,CAAC,WAAmB;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,OAAO,EAAE,YAAY;YACrB,SAAS,EAAE,cAAc;YACzB,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,WAAW;SACxB,EACD,GAAG,EAAE,CACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE;YAC5C,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,WAAW,EAAE;aACtB;SACF,CAAC,CACL,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CardTables service for the Basecamp API.
|
|
3
|
+
*
|
|
4
|
+
* @generated from OpenAPI spec - do not edit directly
|
|
5
|
+
*/
|
|
6
|
+
|
|
7
|
+
import { BaseService } from "../../services/base.js";
|
|
8
|
+
import type { components } from "../schema.js";
|
|
9
|
+
|
|
10
|
+
// =============================================================================
|
|
11
|
+
// Types
|
|
12
|
+
// =============================================================================
|
|
13
|
+
|
|
14
|
+
/** CardTable entity from the Basecamp API. */
|
|
15
|
+
export type CardTable = components["schemas"]["CardTable"];
|
|
16
|
+
|
|
17
|
+
// =============================================================================
|
|
18
|
+
// Service
|
|
19
|
+
// =============================================================================
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Service for CardTables operations.
|
|
23
|
+
*/
|
|
24
|
+
export class CardTablesService extends BaseService {
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Get a card table by ID
|
|
28
|
+
* @param cardTableId - The card table ID
|
|
29
|
+
* @returns The CardTable
|
|
30
|
+
* @throws {BasecampError} If the resource is not found
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const result = await client.cardTables.get(123);
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
async get(cardTableId: number): Promise<CardTable> {
|
|
38
|
+
const response = await this.request(
|
|
39
|
+
{
|
|
40
|
+
service: "CardTables",
|
|
41
|
+
operation: "GetCardTable",
|
|
42
|
+
resourceType: "card_table",
|
|
43
|
+
isMutation: false,
|
|
44
|
+
resourceId: cardTableId,
|
|
45
|
+
},
|
|
46
|
+
() =>
|
|
47
|
+
this.client.GET("/card_tables/{cardTableId}", {
|
|
48
|
+
params: {
|
|
49
|
+
path: { cardTableId },
|
|
50
|
+
},
|
|
51
|
+
})
|
|
52
|
+
);
|
|
53
|
+
return response;
|
|
54
|
+
}
|
|
55
|
+
}
|