@gpt-platform/client 0.10.4 → 0.11.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/dist/_internal/client/client.gen.d.ts +3 -0
- package/dist/_internal/client/client.gen.d.ts.map +1 -0
- package/dist/_internal/client/index.d.ts +9 -0
- package/dist/_internal/client/index.d.ts.map +1 -0
- package/dist/_internal/client/types.gen.d.ts +118 -0
- package/dist/_internal/client/types.gen.d.ts.map +1 -0
- package/dist/_internal/client/utils.gen.d.ts +34 -0
- package/dist/_internal/client/utils.gen.d.ts.map +1 -0
- package/dist/_internal/client.gen.d.ts +13 -0
- package/dist/_internal/client.gen.d.ts.map +1 -0
- package/dist/_internal/core/auth.gen.d.ts +19 -0
- package/dist/_internal/core/auth.gen.d.ts.map +1 -0
- package/dist/_internal/core/bodySerializer.gen.d.ts +26 -0
- package/dist/_internal/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/params.gen.d.ts +44 -0
- package/dist/_internal/core/params.gen.d.ts.map +1 -0
- package/dist/_internal/core/pathSerializer.gen.d.ts +34 -0
- package/dist/_internal/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/_internal/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/_internal/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/_internal/core/types.gen.d.ts +79 -0
- package/dist/_internal/core/types.gen.d.ts.map +1 -0
- package/dist/_internal/core/utils.gen.d.ts +20 -0
- package/dist/_internal/core/utils.gen.d.ts.map +1 -0
- package/dist/_internal/index.d.ts +3 -0
- package/dist/_internal/index.d.ts.map +1 -0
- package/dist/_internal/sdk.gen.d.ts +7053 -0
- package/dist/_internal/sdk.gen.d.ts.map +1 -0
- package/dist/_internal/types.gen.d.ts +146633 -0
- package/dist/_internal/types.gen.d.ts.map +1 -0
- package/dist/base-client.d.ts +199 -0
- package/dist/base-client.d.ts.map +1 -0
- package/dist/errors/index.d.ts +128 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/events.d.ts +69 -0
- package/dist/events.d.ts.map +1 -0
- package/dist/execution-events.d.ts +95 -0
- package/dist/execution-events.d.ts.map +1 -0
- package/dist/gpt-client.d.ts +2175 -0
- package/dist/gpt-client.d.ts.map +1 -0
- package/dist/index.d.ts +51 -30308
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +775 -14
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +775 -14
- package/dist/index.mjs.map +1 -1
- package/dist/json-api.d.ts +26 -0
- package/dist/json-api.d.ts.map +1 -0
- package/dist/logging.d.ts +22 -0
- package/dist/logging.d.ts.map +1 -0
- package/dist/namespace-types.d.ts +79 -0
- package/dist/namespace-types.d.ts.map +1 -0
- package/dist/namespaces/access-grants.d.ts +71 -0
- package/dist/namespaces/access-grants.d.ts.map +1 -0
- package/dist/namespaces/agents.d.ts +1406 -0
- package/dist/namespaces/agents.d.ts.map +1 -0
- package/dist/namespaces/ai.d.ts +407 -0
- package/dist/namespaces/ai.d.ts.map +1 -0
- package/dist/namespaces/audit.d.ts +83 -0
- package/dist/namespaces/audit.d.ts.map +1 -0
- package/dist/namespaces/billing.d.ts +854 -0
- package/dist/namespaces/billing.d.ts.map +1 -0
- package/dist/namespaces/campaigns.d.ts +973 -0
- package/dist/namespaces/campaigns.d.ts.map +1 -0
- package/dist/namespaces/catalog.d.ts +964 -0
- package/dist/namespaces/catalog.d.ts.map +1 -0
- package/dist/namespaces/channels.d.ts +162 -0
- package/dist/namespaces/channels.d.ts.map +1 -0
- package/dist/namespaces/clinical.d.ts +2443 -0
- package/dist/namespaces/clinical.d.ts.map +1 -0
- package/dist/namespaces/communication.d.ts +439 -0
- package/dist/namespaces/communication.d.ts.map +1 -0
- package/dist/namespaces/compliance.d.ts +2310 -0
- package/dist/namespaces/compliance.d.ts.map +1 -0
- package/dist/namespaces/connectors.d.ts +1368 -0
- package/dist/namespaces/connectors.d.ts.map +1 -0
- package/dist/namespaces/content.d.ts +188 -0
- package/dist/namespaces/content.d.ts.map +1 -0
- package/dist/namespaces/crawler.d.ts +408 -0
- package/dist/namespaces/crawler.d.ts.map +1 -0
- package/dist/namespaces/crm-clusters.d.ts +31 -0
- package/dist/namespaces/crm-clusters.d.ts.map +1 -0
- package/dist/namespaces/crm.d.ts +1539 -0
- package/dist/namespaces/crm.d.ts.map +1 -0
- package/dist/namespaces/documents.d.ts +136 -0
- package/dist/namespaces/documents.d.ts.map +1 -0
- package/dist/namespaces/email.d.ts +550 -0
- package/dist/namespaces/email.d.ts.map +1 -0
- package/dist/namespaces/extraction.d.ts +1249 -0
- package/dist/namespaces/extraction.d.ts.map +1 -0
- package/dist/namespaces/identity.d.ts +411 -0
- package/dist/namespaces/identity.d.ts.map +1 -0
- package/dist/namespaces/imports.d.ts +177 -0
- package/dist/namespaces/imports.d.ts.map +1 -0
- package/dist/namespaces/index.d.ts +119 -0
- package/dist/namespaces/index.d.ts.map +1 -0
- package/dist/namespaces/memory.d.ts +105 -0
- package/dist/namespaces/memory.d.ts.map +1 -0
- package/dist/namespaces/models.d.ts +75 -0
- package/dist/namespaces/models.d.ts.map +1 -0
- package/dist/namespaces/permissions.d.ts +75 -0
- package/dist/namespaces/permissions.d.ts.map +1 -0
- package/dist/namespaces/pipeline-executions.d.ts +130 -0
- package/dist/namespaces/pipeline-executions.d.ts.map +1 -0
- package/dist/namespaces/pipelines.d.ts +120 -0
- package/dist/namespaces/pipelines.d.ts.map +1 -0
- package/dist/namespaces/platform.d.ts +1430 -0
- package/dist/namespaces/platform.d.ts.map +1 -0
- package/dist/namespaces/portal.d.ts +198 -0
- package/dist/namespaces/portal.d.ts.map +1 -0
- package/dist/namespaces/projects.d.ts +553 -0
- package/dist/namespaces/projects.d.ts.map +1 -0
- package/dist/namespaces/roles.d.ts +65 -0
- package/dist/namespaces/roles.d.ts.map +1 -0
- package/dist/namespaces/scheduling.d.ts +944 -0
- package/dist/namespaces/scheduling.d.ts.map +1 -0
- package/dist/namespaces/search.d.ts +224 -0
- package/dist/namespaces/search.d.ts.map +1 -0
- package/dist/namespaces/session-notes.d.ts +67 -0
- package/dist/namespaces/session-notes.d.ts.map +1 -0
- package/dist/namespaces/social.d.ts +330 -0
- package/dist/namespaces/social.d.ts.map +1 -0
- package/dist/namespaces/storage.d.ts +378 -0
- package/dist/namespaces/storage.d.ts.map +1 -0
- package/dist/namespaces/support.d.ts +427 -0
- package/dist/namespaces/support.d.ts.map +1 -0
- package/dist/namespaces/threads.d.ts +596 -0
- package/dist/namespaces/threads.d.ts.map +1 -0
- package/dist/namespaces/training.d.ts +358 -0
- package/dist/namespaces/training.d.ts.map +1 -0
- package/dist/namespaces/voice.d.ts +752 -0
- package/dist/namespaces/voice.d.ts.map +1 -0
- package/dist/namespaces/watcher.d.ts +425 -0
- package/dist/namespaces/watcher.d.ts.map +1 -0
- package/dist/namespaces/webhooks-ns.d.ts +3 -0
- package/dist/namespaces/webhooks-ns.d.ts.map +1 -0
- package/dist/pagination.d.ts +57 -0
- package/dist/pagination.d.ts.map +1 -0
- package/dist/request-builder.d.ts +95 -0
- package/dist/request-builder.d.ts.map +1 -0
- package/dist/security.d.ts +32 -0
- package/dist/security.d.ts.map +1 -0
- package/dist/streaming.d.ts +135 -0
- package/dist/streaming.d.ts.map +1 -0
- package/dist/utils/retry.d.ts +63 -0
- package/dist/utils/retry.d.ts.map +1 -0
- package/dist/version.d.ts +5 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/webhook-signature.d.ts +109 -0
- package/dist/webhook-signature.d.ts.map +1 -0
- package/llms.txt +40 -1
- package/package.json +286 -36
- package/dist/index.d.mts +0 -30308
|
@@ -0,0 +1,553 @@
|
|
|
1
|
+
/** @public A project record. */
|
|
2
|
+
export interface Project {
|
|
3
|
+
id: string;
|
|
4
|
+
type: string;
|
|
5
|
+
attributes?: {
|
|
6
|
+
name?: string;
|
|
7
|
+
description?: string;
|
|
8
|
+
status?: string;
|
|
9
|
+
workspace_id?: string;
|
|
10
|
+
template_id?: string;
|
|
11
|
+
archived_at?: string | null;
|
|
12
|
+
inserted_at?: string;
|
|
13
|
+
updated_at?: string;
|
|
14
|
+
[key: string]: unknown;
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
/** @public A project milestone record. */
|
|
18
|
+
export interface Milestone {
|
|
19
|
+
id: string;
|
|
20
|
+
type: string;
|
|
21
|
+
attributes?: {
|
|
22
|
+
name?: string;
|
|
23
|
+
description?: string;
|
|
24
|
+
due_date?: string | null;
|
|
25
|
+
project_id?: string;
|
|
26
|
+
inserted_at?: string;
|
|
27
|
+
updated_at?: string;
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
/** @public A project task record. */
|
|
32
|
+
export interface Task {
|
|
33
|
+
id: string;
|
|
34
|
+
type: string;
|
|
35
|
+
attributes?: {
|
|
36
|
+
name?: string;
|
|
37
|
+
description?: string;
|
|
38
|
+
status?: string;
|
|
39
|
+
project_id?: string;
|
|
40
|
+
milestone_id?: string | null;
|
|
41
|
+
assignee_id?: string | null;
|
|
42
|
+
inserted_at?: string;
|
|
43
|
+
updated_at?: string;
|
|
44
|
+
[key: string]: unknown;
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
/** @public A project member record. */
|
|
48
|
+
export interface ProjectMember {
|
|
49
|
+
id: string;
|
|
50
|
+
type: string;
|
|
51
|
+
attributes?: {
|
|
52
|
+
user_id?: string;
|
|
53
|
+
role?: string;
|
|
54
|
+
inserted_at?: string;
|
|
55
|
+
[key: string]: unknown;
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
/** @public A project risk record. */
|
|
59
|
+
export interface ProjectRisk {
|
|
60
|
+
id: string;
|
|
61
|
+
type: string;
|
|
62
|
+
attributes?: {
|
|
63
|
+
title?: string;
|
|
64
|
+
description?: string;
|
|
65
|
+
severity?: string;
|
|
66
|
+
status?: string;
|
|
67
|
+
project_id?: string;
|
|
68
|
+
[key: string]: unknown;
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
/** @public A project activity log entry. */
|
|
72
|
+
export interface ProjectActivity {
|
|
73
|
+
id: string;
|
|
74
|
+
type: string;
|
|
75
|
+
attributes?: {
|
|
76
|
+
action?: string;
|
|
77
|
+
actor_id?: string;
|
|
78
|
+
project_id?: string;
|
|
79
|
+
inserted_at?: string;
|
|
80
|
+
[key: string]: unknown;
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
/** @public A project status update record. */
|
|
84
|
+
export interface ProjectUpdate {
|
|
85
|
+
id: string;
|
|
86
|
+
type: string;
|
|
87
|
+
attributes?: {
|
|
88
|
+
body?: string;
|
|
89
|
+
author_id?: string;
|
|
90
|
+
project_id?: string;
|
|
91
|
+
inserted_at?: string;
|
|
92
|
+
[key: string]: unknown;
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
/** @public A project template record. */
|
|
96
|
+
export interface ProjectTemplate {
|
|
97
|
+
id: string;
|
|
98
|
+
type: string;
|
|
99
|
+
attributes?: {
|
|
100
|
+
name?: string;
|
|
101
|
+
description?: string;
|
|
102
|
+
[key: string]: unknown;
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
/** @public A time entry record. */
|
|
106
|
+
export interface TimeEntry {
|
|
107
|
+
id: string;
|
|
108
|
+
type: string;
|
|
109
|
+
attributes?: {
|
|
110
|
+
task_id?: string;
|
|
111
|
+
hours?: number;
|
|
112
|
+
description?: string;
|
|
113
|
+
logged_at?: string;
|
|
114
|
+
[key: string]: unknown;
|
|
115
|
+
};
|
|
116
|
+
}
|
|
117
|
+
/** @public A task label record. */
|
|
118
|
+
export interface TaskLabel {
|
|
119
|
+
id: string;
|
|
120
|
+
type: string;
|
|
121
|
+
attributes?: {
|
|
122
|
+
name?: string;
|
|
123
|
+
color?: string;
|
|
124
|
+
[key: string]: unknown;
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
import type { RequestBuilder } from "../request-builder";
|
|
128
|
+
/** @public Input for creating a project. */
|
|
129
|
+
export interface CreateProjectInput {
|
|
130
|
+
name: string;
|
|
131
|
+
workspace_id: string;
|
|
132
|
+
description?: string;
|
|
133
|
+
status?: string;
|
|
134
|
+
template_id?: string;
|
|
135
|
+
}
|
|
136
|
+
/** @public Input for updating a project. */
|
|
137
|
+
export interface UpdateProjectInput {
|
|
138
|
+
name?: string;
|
|
139
|
+
description?: string;
|
|
140
|
+
status?: string;
|
|
141
|
+
}
|
|
142
|
+
/** @public Input for creating a milestone. */
|
|
143
|
+
export interface CreateMilestoneInput {
|
|
144
|
+
name: string;
|
|
145
|
+
project_id: string;
|
|
146
|
+
due_date?: string;
|
|
147
|
+
description?: string;
|
|
148
|
+
}
|
|
149
|
+
/** @public Input for creating a task. */
|
|
150
|
+
export interface CreateTaskInput {
|
|
151
|
+
name: string;
|
|
152
|
+
project_id: string;
|
|
153
|
+
milestone_id?: string;
|
|
154
|
+
description?: string;
|
|
155
|
+
status?: string;
|
|
156
|
+
assignee_id?: string;
|
|
157
|
+
}
|
|
158
|
+
/** @public Input for logging a time entry. */
|
|
159
|
+
export interface CreateTimeEntryInput {
|
|
160
|
+
task_id: string;
|
|
161
|
+
hours: number;
|
|
162
|
+
description?: string;
|
|
163
|
+
logged_at?: string;
|
|
164
|
+
}
|
|
165
|
+
/** @public Input for adding a project member. */
|
|
166
|
+
export interface AddMemberInput {
|
|
167
|
+
user_id: string;
|
|
168
|
+
role?: string;
|
|
169
|
+
}
|
|
170
|
+
/** @public Input for updating a project member's role. */
|
|
171
|
+
export interface UpdateMemberInput {
|
|
172
|
+
role: string;
|
|
173
|
+
}
|
|
174
|
+
/** @public Input for creating a task label. */
|
|
175
|
+
export interface CreateLabelInput {
|
|
176
|
+
name: string;
|
|
177
|
+
color?: string;
|
|
178
|
+
}
|
|
179
|
+
/** @public AI-decomposed project plan. */
|
|
180
|
+
export interface DecomposedPlan {
|
|
181
|
+
milestones: Array<{
|
|
182
|
+
name: string;
|
|
183
|
+
tasks: Array<{
|
|
184
|
+
name: string;
|
|
185
|
+
description?: string;
|
|
186
|
+
}>;
|
|
187
|
+
}>;
|
|
188
|
+
summary: string;
|
|
189
|
+
}
|
|
190
|
+
/** @public AI-suggested assignee for a task. */
|
|
191
|
+
export interface AssigneeSuggestion {
|
|
192
|
+
user_id: string;
|
|
193
|
+
name: string;
|
|
194
|
+
confidence: number;
|
|
195
|
+
reason: string;
|
|
196
|
+
}
|
|
197
|
+
/** @public AI-estimated completion for a project. */
|
|
198
|
+
export interface CompletionEstimate {
|
|
199
|
+
estimated_date: string;
|
|
200
|
+
confidence: number;
|
|
201
|
+
blockers: string[];
|
|
202
|
+
}
|
|
203
|
+
/** @public Parameters for listing projects. */
|
|
204
|
+
export interface ListProjectsParams {
|
|
205
|
+
/** Filter by project status (e.g., "active", "archived"). */
|
|
206
|
+
status?: string;
|
|
207
|
+
/** Sort field (e.g., "name", "-inserted_at"). */
|
|
208
|
+
sort?: string;
|
|
209
|
+
/** Page number (1-based). */
|
|
210
|
+
page?: number;
|
|
211
|
+
/** Number of results per page. */
|
|
212
|
+
page_size?: number;
|
|
213
|
+
}
|
|
214
|
+
/** @public Type of the projects namespace returned by createProjectsNamespace. */
|
|
215
|
+
export type ProjectsNamespace = ReturnType<typeof createProjectsNamespace>;
|
|
216
|
+
/**
|
|
217
|
+
* Projects namespace — project management, milestones, tasks, time tracking, risks, and AI.
|
|
218
|
+
*
|
|
219
|
+
* @param rb - The request builder used for API communication.
|
|
220
|
+
* @returns Projects namespace with sub-namespaces for projects, milestones, tasks, timeEntries,
|
|
221
|
+
* members, risks, activity, updates, ai, templates, labels, and tags.
|
|
222
|
+
*
|
|
223
|
+
* @example
|
|
224
|
+
* ```typescript
|
|
225
|
+
* const client = new GptClient({ apiKey: 'sk_app_...' });
|
|
226
|
+
*
|
|
227
|
+
* // List active projects
|
|
228
|
+
* const projects = await client.projects.list();
|
|
229
|
+
*
|
|
230
|
+
* // Create a project
|
|
231
|
+
* const project = await client.projects.create({
|
|
232
|
+
* name: 'Q2 Launch',
|
|
233
|
+
* workspace_id: 'ws-uuid',
|
|
234
|
+
* });
|
|
235
|
+
*
|
|
236
|
+
* // Add a task
|
|
237
|
+
* const task = await client.projects.tasks.create({
|
|
238
|
+
* name: 'Design review',
|
|
239
|
+
* project_id: project.id,
|
|
240
|
+
* });
|
|
241
|
+
*
|
|
242
|
+
* // Log time
|
|
243
|
+
* await client.projects.timeEntries.create({
|
|
244
|
+
* task_id: task.id,
|
|
245
|
+
* hours: 2.5,
|
|
246
|
+
* });
|
|
247
|
+
* ```
|
|
248
|
+
*/
|
|
249
|
+
export declare function createProjectsNamespace(rb: RequestBuilder): {
|
|
250
|
+
/**
|
|
251
|
+
* List projects in the current workspace.
|
|
252
|
+
*
|
|
253
|
+
* @param params - Optional filter parameters.
|
|
254
|
+
* @param options - Optional request options.
|
|
255
|
+
* @returns Array of Project records.
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* ```typescript
|
|
259
|
+
* const projects = await client.projects.list({ status: 'active' });
|
|
260
|
+
* ```
|
|
261
|
+
*/
|
|
262
|
+
list(params?: ListProjectsParams, options?: import("../base-client").RequestOptions): Promise<Project[]>;
|
|
263
|
+
/**
|
|
264
|
+
* Get a project by ID.
|
|
265
|
+
*
|
|
266
|
+
* @param id - The project UUID.
|
|
267
|
+
* @param options - Optional request options.
|
|
268
|
+
* @returns The Project record.
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```typescript
|
|
272
|
+
* const project = await client.projects.get('project-uuid');
|
|
273
|
+
* ```
|
|
274
|
+
*/
|
|
275
|
+
get(id: string, options?: import("../base-client").RequestOptions): Promise<Project>;
|
|
276
|
+
/**
|
|
277
|
+
* Create a new project.
|
|
278
|
+
*
|
|
279
|
+
* @param data - Project creation input.
|
|
280
|
+
* @param options - Optional request options.
|
|
281
|
+
* @returns The created Project.
|
|
282
|
+
*
|
|
283
|
+
* @example
|
|
284
|
+
* ```typescript
|
|
285
|
+
* const project = await client.projects.create({
|
|
286
|
+
* name: 'Q2 Launch',
|
|
287
|
+
* workspace_id: 'ws-uuid',
|
|
288
|
+
* });
|
|
289
|
+
* ```
|
|
290
|
+
*/
|
|
291
|
+
create(data: CreateProjectInput, options?: import("../base-client").RequestOptions): Promise<Project>;
|
|
292
|
+
/**
|
|
293
|
+
* Update a project.
|
|
294
|
+
*
|
|
295
|
+
* @param id - The project UUID.
|
|
296
|
+
* @param data - Update input.
|
|
297
|
+
* @param options - Optional request options.
|
|
298
|
+
* @returns The updated Project.
|
|
299
|
+
*/
|
|
300
|
+
update(id: string, data: UpdateProjectInput, options?: import("../base-client").RequestOptions): Promise<Project>;
|
|
301
|
+
/**
|
|
302
|
+
* Archive a project (soft delete).
|
|
303
|
+
*
|
|
304
|
+
* @param id - The project UUID.
|
|
305
|
+
* @param options - Optional request options.
|
|
306
|
+
*/
|
|
307
|
+
archive(id: string, options?: import("../base-client").RequestOptions): Promise<void>;
|
|
308
|
+
/**
|
|
309
|
+
* Milestone management sub-namespace.
|
|
310
|
+
*/
|
|
311
|
+
milestones: {
|
|
312
|
+
/**
|
|
313
|
+
* List milestones for a project.
|
|
314
|
+
*
|
|
315
|
+
* @param projectId - The project UUID.
|
|
316
|
+
* @param options - Optional request options.
|
|
317
|
+
* @returns Array of Milestone records.
|
|
318
|
+
*/
|
|
319
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<Milestone[]>;
|
|
320
|
+
/**
|
|
321
|
+
* Create a milestone in a project.
|
|
322
|
+
*
|
|
323
|
+
* @param projectId - The project UUID.
|
|
324
|
+
* @param data - Milestone creation input.
|
|
325
|
+
* @param options - Optional request options.
|
|
326
|
+
* @returns The created Milestone.
|
|
327
|
+
*
|
|
328
|
+
* @example
|
|
329
|
+
* ```typescript
|
|
330
|
+
* const milestone = await client.projects.milestones.create('proj-uuid', {
|
|
331
|
+
* name: 'MVP Release',
|
|
332
|
+
* project_id: 'proj-uuid',
|
|
333
|
+
* });
|
|
334
|
+
* ```
|
|
335
|
+
*/
|
|
336
|
+
create(projectId: string, data: CreateMilestoneInput, options?: import("../base-client").RequestOptions): Promise<Milestone>;
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* Task management sub-namespace.
|
|
340
|
+
*/
|
|
341
|
+
tasks: {
|
|
342
|
+
/**
|
|
343
|
+
* List tasks in a project.
|
|
344
|
+
*
|
|
345
|
+
* @param projectId - The project UUID.
|
|
346
|
+
* @param options - Optional request options.
|
|
347
|
+
* @returns Array of Task records.
|
|
348
|
+
*/
|
|
349
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<Task[]>;
|
|
350
|
+
/**
|
|
351
|
+
* Create a task in a project.
|
|
352
|
+
*
|
|
353
|
+
* @param data - Task creation input.
|
|
354
|
+
* @param options - Optional request options.
|
|
355
|
+
* @returns The created Task.
|
|
356
|
+
*
|
|
357
|
+
* @example
|
|
358
|
+
* ```typescript
|
|
359
|
+
* const task = await client.projects.tasks.create({
|
|
360
|
+
* name: 'Design review',
|
|
361
|
+
* project_id: 'proj-uuid',
|
|
362
|
+
* });
|
|
363
|
+
* ```
|
|
364
|
+
*/
|
|
365
|
+
create(data: CreateTaskInput, options?: import("../base-client").RequestOptions): Promise<Task>;
|
|
366
|
+
/**
|
|
367
|
+
* Get AI-suggested assignees for a task.
|
|
368
|
+
*
|
|
369
|
+
* @param taskId - The task UUID.
|
|
370
|
+
* @param options - Optional request options.
|
|
371
|
+
* @returns Array of AssigneeSuggestion records.
|
|
372
|
+
*/
|
|
373
|
+
suggestAssignee(taskId: string, options?: import("../base-client").RequestOptions): Promise<AssigneeSuggestion[]>;
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* Time entry management sub-namespace.
|
|
377
|
+
*/
|
|
378
|
+
timeEntries: {
|
|
379
|
+
/**
|
|
380
|
+
* List time entries for a project.
|
|
381
|
+
*
|
|
382
|
+
* @param projectId - The project UUID.
|
|
383
|
+
* @param options - Optional request options.
|
|
384
|
+
* @returns Array of TimeEntry records.
|
|
385
|
+
*/
|
|
386
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<TimeEntry[]>;
|
|
387
|
+
/**
|
|
388
|
+
* Log a time entry.
|
|
389
|
+
*
|
|
390
|
+
* @param data - Time entry creation input.
|
|
391
|
+
* @param options - Optional request options.
|
|
392
|
+
* @returns The created TimeEntry.
|
|
393
|
+
*
|
|
394
|
+
* @example
|
|
395
|
+
* ```typescript
|
|
396
|
+
* await client.projects.timeEntries.create({
|
|
397
|
+
* task_id: 'task-uuid',
|
|
398
|
+
* hours: 2.5,
|
|
399
|
+
* });
|
|
400
|
+
* ```
|
|
401
|
+
*/
|
|
402
|
+
create(data: CreateTimeEntryInput, options?: import("../base-client").RequestOptions): Promise<TimeEntry>;
|
|
403
|
+
};
|
|
404
|
+
/**
|
|
405
|
+
* Project member management sub-namespace.
|
|
406
|
+
*/
|
|
407
|
+
members: {
|
|
408
|
+
/**
|
|
409
|
+
* List members of a project.
|
|
410
|
+
*
|
|
411
|
+
* @param projectId - The project UUID.
|
|
412
|
+
* @param options - Optional request options.
|
|
413
|
+
* @returns Array of ProjectMember records.
|
|
414
|
+
*/
|
|
415
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<ProjectMember[]>;
|
|
416
|
+
/**
|
|
417
|
+
* Add a member to a project.
|
|
418
|
+
*
|
|
419
|
+
* @param projectId - The project UUID.
|
|
420
|
+
* @param data - Member addition input.
|
|
421
|
+
* @param options - Optional request options.
|
|
422
|
+
* @returns The created ProjectMember.
|
|
423
|
+
*/
|
|
424
|
+
add(projectId: string, data: AddMemberInput, options?: import("../base-client").RequestOptions): Promise<ProjectMember>;
|
|
425
|
+
/**
|
|
426
|
+
* Remove a member from a project.
|
|
427
|
+
*
|
|
428
|
+
* @param projectId - The project UUID.
|
|
429
|
+
* @param memberId - The member UUID.
|
|
430
|
+
* @param options - Optional request options.
|
|
431
|
+
*/
|
|
432
|
+
remove(projectId: string, memberId: string, options?: import("../base-client").RequestOptions): Promise<void>;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* Risk management sub-namespace.
|
|
436
|
+
*/
|
|
437
|
+
risks: {
|
|
438
|
+
/**
|
|
439
|
+
* List risks for a project.
|
|
440
|
+
*
|
|
441
|
+
* @param projectId - The project UUID.
|
|
442
|
+
* @param options - Optional request options.
|
|
443
|
+
* @returns Array of ProjectRisk records.
|
|
444
|
+
*/
|
|
445
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<ProjectRisk[]>;
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* Activity feed sub-namespace.
|
|
449
|
+
*/
|
|
450
|
+
activity: {
|
|
451
|
+
/**
|
|
452
|
+
* List activity records for a project (append-only log).
|
|
453
|
+
*
|
|
454
|
+
* @param projectId - The project UUID.
|
|
455
|
+
* @param options - Optional request options.
|
|
456
|
+
* @returns Array of ProjectActivity records.
|
|
457
|
+
*/
|
|
458
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<ProjectActivity[]>;
|
|
459
|
+
};
|
|
460
|
+
/**
|
|
461
|
+
* Status update sub-namespace.
|
|
462
|
+
*/
|
|
463
|
+
updates: {
|
|
464
|
+
/**
|
|
465
|
+
* List status updates for a project.
|
|
466
|
+
*
|
|
467
|
+
* @param projectId - The project UUID.
|
|
468
|
+
* @param options - Optional request options.
|
|
469
|
+
* @returns Array of ProjectUpdate records.
|
|
470
|
+
*/
|
|
471
|
+
list(projectId: string, options?: import("../base-client").RequestOptions): Promise<ProjectUpdate[]>;
|
|
472
|
+
};
|
|
473
|
+
/**
|
|
474
|
+
* AI-powered project management sub-namespace.
|
|
475
|
+
*/
|
|
476
|
+
ai: {
|
|
477
|
+
/**
|
|
478
|
+
* Decompose a project goal into milestones and tasks using AI.
|
|
479
|
+
*
|
|
480
|
+
* @param projectId - The project UUID.
|
|
481
|
+
* @param options - Optional request options.
|
|
482
|
+
* @returns A DecomposedPlan with AI-generated structure.
|
|
483
|
+
*
|
|
484
|
+
* @example
|
|
485
|
+
* ```typescript
|
|
486
|
+
* const plan = await client.projects.ai.decompose('proj-uuid');
|
|
487
|
+
* plan.milestones.forEach(m => console.log(m.name));
|
|
488
|
+
* ```
|
|
489
|
+
*/
|
|
490
|
+
decompose(projectId: string, options?: import("../base-client").RequestOptions): Promise<DecomposedPlan>;
|
|
491
|
+
/**
|
|
492
|
+
* Get AI-estimated completion date for a project.
|
|
493
|
+
*
|
|
494
|
+
* @param projectId - The project UUID.
|
|
495
|
+
* @param options - Optional request options.
|
|
496
|
+
* @returns CompletionEstimate with date, confidence, and blockers.
|
|
497
|
+
*/
|
|
498
|
+
estimateCompletion(projectId: string, options?: import("../base-client").RequestOptions): Promise<CompletionEstimate>;
|
|
499
|
+
/**
|
|
500
|
+
* Get AI-generated summary for a project.
|
|
501
|
+
*
|
|
502
|
+
* @param projectId - The project UUID.
|
|
503
|
+
* @param options - Optional request options.
|
|
504
|
+
* @returns The project AI summary as a string.
|
|
505
|
+
*/
|
|
506
|
+
getSummary(projectId: string, options?: import("../base-client").RequestOptions): Promise<string>;
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* Template management sub-namespace (client surface — read-only).
|
|
510
|
+
*/
|
|
511
|
+
templates: {
|
|
512
|
+
/**
|
|
513
|
+
* List available project templates.
|
|
514
|
+
*
|
|
515
|
+
* @param options - Optional request options.
|
|
516
|
+
* @returns Array of ProjectTemplate records.
|
|
517
|
+
*/
|
|
518
|
+
list(options?: import("../base-client").RequestOptions): Promise<ProjectTemplate[]>;
|
|
519
|
+
};
|
|
520
|
+
/**
|
|
521
|
+
* Task label management sub-namespace.
|
|
522
|
+
*/
|
|
523
|
+
labels: {
|
|
524
|
+
/**
|
|
525
|
+
* List task labels in the workspace.
|
|
526
|
+
*
|
|
527
|
+
* @param options - Optional request options.
|
|
528
|
+
* @returns Array of TaskLabel records.
|
|
529
|
+
*/
|
|
530
|
+
list(options?: import("../base-client").RequestOptions): Promise<TaskLabel[]>;
|
|
531
|
+
/**
|
|
532
|
+
* Create a task label.
|
|
533
|
+
*
|
|
534
|
+
* @param data - Label creation input.
|
|
535
|
+
* @param options - Optional request options.
|
|
536
|
+
* @returns The created TaskLabel.
|
|
537
|
+
*/
|
|
538
|
+
create(data: CreateLabelInput, options?: import("../base-client").RequestOptions): Promise<TaskLabel>;
|
|
539
|
+
};
|
|
540
|
+
/**
|
|
541
|
+
* Project tag management sub-namespace.
|
|
542
|
+
*/
|
|
543
|
+
tags: {
|
|
544
|
+
/**
|
|
545
|
+
* List project tags in the workspace.
|
|
546
|
+
*
|
|
547
|
+
* @param options - Optional request options.
|
|
548
|
+
* @returns Array of tag records.
|
|
549
|
+
*/
|
|
550
|
+
list(options?: import("../base-client").RequestOptions): Promise<unknown[]>;
|
|
551
|
+
};
|
|
552
|
+
};
|
|
553
|
+
//# sourceMappingURL=projects.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"projects.d.ts","sourceRoot":"","sources":["../../src/namespaces/projects.ts"],"names":[],"mappings":"AAOA,gCAAgC;AAChC,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,0CAA0C;AAC1C,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,qCAAqC;AACrC,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,uCAAuC;AACvC,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,qCAAqC;AACrC,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,8CAA8C;AAC9C,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,mCAAmC;AACnC,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,mCAAmC;AACnC,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIzD,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,8CAA8C;AAC9C,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,8CAA8C;AAC9C,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,+CAA+C;AAC/C,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAID,0CAA0C;AAC1C,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,KAAK,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACtD,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gDAAgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,qDAAqD;AACrD,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,+CAA+C;AAC/C,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID,kFAAkF;AAClF,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAI3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,cAAc;IAEtD;;;;;;;;;;;OAWG;kBAEQ,kBAAkB,YACjB,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,OAAO,EAAE,CAAC;IAcrB;;;;;;;;;;;OAWG;YAEG,MAAM,YACA,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;;;;;;OAcG;iBAEK,kBAAkB,YACd,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;OAOG;eAEG,MAAM,QACJ,kBAAkB,YACd,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;OAKG;gBAEG,MAAM,YACA,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,IAAI,CAAC;IAQhB;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,EAAE,CAAC;QAOvB;;;;;;;;;;;;;;;WAeG;0BAEU,MAAM,QACX,oBAAoB,YAChB,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,CAAC;;IASvB;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,IAAI,EAAE,CAAC;QAOlB;;;;;;;;;;;;;;WAcG;qBAEK,eAAe,YACX,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,IAAI,CAAC;QAIhB;;;;;;WAMG;gCAEO,MAAM,YACJ,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,kBAAkB,EAAE,CAAC;;IAQlC;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,EAAE,CAAC;QAOvB;;;;;;;;;;;;;;WAcG;qBAEK,oBAAoB,YAChB,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,CAAC;;IAKvB;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,aAAa,EAAE,CAAC;QAO3B;;;;;;;WAOG;uBAEU,MAAM,QACX,cAAc,YACV,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,aAAa,CAAC;QAQzB;;;;;;WAMG;0BAEU,MAAM,YACP,MAAM,YACN,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,IAAI,CAAC;;IASlB;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,WAAW,EAAE,CAAC;;IAQ3B;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,eAAe,EAAE,CAAC;;IAQ/B;;OAEG;;QAED;;;;;;WAMG;wBAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,aAAa,EAAE,CAAC;;IAQ7B;;OAEG;;QAED;;;;;;;;;;;;WAYG;6BAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,cAAc,CAAC;QAQ1B;;;;;;WAMG;sCAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,kBAAkB,CAAC;QAO9B;;;;;;WAMG;8BAEU,MAAM,YACP,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,MAAM,CAAC;;IAQpB;;OAEG;;QAED;;;;;WAKG;uBAES,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,eAAe,EAAE,CAAC;;IAK/B;;OAEG;;QAED;;;;;WAKG;uBAES,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,EAAE,CAAC;QAIvB;;;;;;WAMG;qBAEK,gBAAgB,YACZ,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,SAAS,CAAC;;IAKvB;;OAEG;;QAED;;;;;WAKG;uBAES,OAAO,gBAAgB,EAAE,cAAc,GAChD,OAAO,CAAC,OAAO,EAAE,CAAC;;EAK1B"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { RequestBuilder } from "../request-builder";
|
|
2
|
+
import type { Role, PostRolesData, PatchRolesByIdData } from "../_internal/types.gen";
|
|
3
|
+
export type { Role };
|
|
4
|
+
export interface RoleListResult {
|
|
5
|
+
data: Role[];
|
|
6
|
+
meta?: {
|
|
7
|
+
total?: number;
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
export interface RoleResult {
|
|
11
|
+
data: Role;
|
|
12
|
+
}
|
|
13
|
+
export declare function createRolesNamespace(rb: RequestBuilder): {
|
|
14
|
+
/**
|
|
15
|
+
* List roles available in the current context (system defaults + application roles).
|
|
16
|
+
*
|
|
17
|
+
* @param params - Optional filter parameters
|
|
18
|
+
* @returns Paginated list of roles
|
|
19
|
+
* @example
|
|
20
|
+
* const roles = await client.roles.list();
|
|
21
|
+
*/
|
|
22
|
+
list(params?: Record<string, string>): Promise<RoleListResult>;
|
|
23
|
+
/**
|
|
24
|
+
* Get a single role by ID.
|
|
25
|
+
*
|
|
26
|
+
* @param id - Role UUID
|
|
27
|
+
* @returns The role record
|
|
28
|
+
* @example
|
|
29
|
+
* const role = await client.roles.get("role-uuid");
|
|
30
|
+
*/
|
|
31
|
+
get(id: string): Promise<RoleResult>;
|
|
32
|
+
/**
|
|
33
|
+
* Create a new custom role (permission bundle) for the application.
|
|
34
|
+
*
|
|
35
|
+
* @param attrs - Role attributes (name, description, permissions, application_id)
|
|
36
|
+
* @returns The created role
|
|
37
|
+
* @example
|
|
38
|
+
* const role = await client.roles.create({
|
|
39
|
+
* data: {
|
|
40
|
+
* type: "role",
|
|
41
|
+
* attributes: { name: "Content Editor", permissions: ["extract:document:read:all"] },
|
|
42
|
+
* },
|
|
43
|
+
* });
|
|
44
|
+
*/
|
|
45
|
+
create(attrs: PostRolesData["body"]): Promise<RoleResult>;
|
|
46
|
+
/**
|
|
47
|
+
* Update a role's name, description, or permissions.
|
|
48
|
+
*
|
|
49
|
+
* @param id - Role UUID
|
|
50
|
+
* @param attrs - Attributes to update
|
|
51
|
+
* @returns The updated role
|
|
52
|
+
* @example
|
|
53
|
+
* const updated = await client.roles.update("role-uuid", { data: { ... } });
|
|
54
|
+
*/
|
|
55
|
+
update(id: string, attrs: PatchRolesByIdData["body"]): Promise<RoleResult>;
|
|
56
|
+
/**
|
|
57
|
+
* Delete a custom role. System default roles cannot be deleted.
|
|
58
|
+
*
|
|
59
|
+
* @param id - Role UUID
|
|
60
|
+
* @example
|
|
61
|
+
* await client.roles.delete("role-uuid");
|
|
62
|
+
*/
|
|
63
|
+
delete(id: string): Promise<void>;
|
|
64
|
+
};
|
|
65
|
+
//# sourceMappingURL=roles.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/namespaces/roles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EACV,IAAI,EACJ,aAAa,EACb,kBAAkB,EACnB,MAAM,wBAAwB,CAAC;AAEhC,YAAY,EAAE,IAAI,EAAE,CAAC;AAErB,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,cAAc;IAEnD;;;;;;;OAOG;kBACiB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAKpE;;;;;;;OAOG;YACW,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAI1C;;;;;;;;;;;;OAYG;kBACiB,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IAI/D;;;;;;;;OAQG;eAEG,MAAM,SACH,kBAAkB,CAAC,MAAM,CAAC,GAChC,OAAO,CAAC,UAAU,CAAC;IAItB;;;;;;OAMG;eACc,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;EAI1C"}
|