@scalepad/sdk-lm 0.1.0 → 0.1.1
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 +90 -0
- package/package.json +9 -1
- package/src/catalog.ts +0 -1161
- package/src/generated.ts +0 -1288
- package/src/index.ts +0 -63
- package/src/runtime.ts +0 -132
- package/src/schema.ts +0 -8768
- package/tsconfig.json +0 -9
package/src/catalog.ts
DELETED
|
@@ -1,1161 +0,0 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
export interface GeneratedOperation {
|
|
3
|
-
methodName: string;
|
|
4
|
-
method: "get" | "post" | "put" | "delete";
|
|
5
|
-
path: string;
|
|
6
|
-
action: "list" | "get" | "create" | "update" | "delete";
|
|
7
|
-
commandPath: readonly string[];
|
|
8
|
-
pathParams: readonly string[];
|
|
9
|
-
queryParams: readonly string[];
|
|
10
|
-
hasBody: boolean;
|
|
11
|
-
output: "list" | "object";
|
|
12
|
-
summary: string;
|
|
13
|
-
description: string;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
export const lifecycleManagerOperations: readonly GeneratedOperation[] = [
|
|
17
|
-
{
|
|
18
|
-
methodName: "getNotesById",
|
|
19
|
-
method: "get",
|
|
20
|
-
path: "/lifecycle-manager/v1/notes/{id}",
|
|
21
|
-
action: "get",
|
|
22
|
-
commandPath: ["notes"],
|
|
23
|
-
pathParams: ["id"],
|
|
24
|
-
queryParams: [],
|
|
25
|
-
hasBody: false,
|
|
26
|
-
output: "object",
|
|
27
|
-
summary: "Get Notes",
|
|
28
|
-
description: "Gets a note's full details."
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
methodName: "updateNotesById",
|
|
32
|
-
method: "put",
|
|
33
|
-
path: "/lifecycle-manager/v1/notes/{id}",
|
|
34
|
-
action: "update",
|
|
35
|
-
commandPath: ["notes"],
|
|
36
|
-
pathParams: ["id"],
|
|
37
|
-
queryParams: [],
|
|
38
|
-
hasBody: true,
|
|
39
|
-
output: "object",
|
|
40
|
-
summary: "Update Notes",
|
|
41
|
-
description: "Update title and description of a note."
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
methodName: "deleteNotesById",
|
|
45
|
-
method: "delete",
|
|
46
|
-
path: "/lifecycle-manager/v1/notes/{id}",
|
|
47
|
-
action: "delete",
|
|
48
|
-
commandPath: ["notes"],
|
|
49
|
-
pathParams: ["id"],
|
|
50
|
-
queryParams: [],
|
|
51
|
-
hasBody: false,
|
|
52
|
-
output: "object",
|
|
53
|
-
summary: "Delete Notes",
|
|
54
|
-
description: "Deletes a note."
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
methodName: "listNotes",
|
|
58
|
-
method: "get",
|
|
59
|
-
path: "/lifecycle-manager/v1/notes",
|
|
60
|
-
action: "list",
|
|
61
|
-
commandPath: ["notes"],
|
|
62
|
-
pathParams: [],
|
|
63
|
-
queryParams: ["filter[client.id]","filter[is_archived]","page_size","cursor"],
|
|
64
|
-
hasBody: false,
|
|
65
|
-
output: "list",
|
|
66
|
-
summary: "List Notes",
|
|
67
|
-
description: "Retrieve a comprehensive list of all notes with filtering options."
|
|
68
|
-
},
|
|
69
|
-
{
|
|
70
|
-
methodName: "createNotes",
|
|
71
|
-
method: "post",
|
|
72
|
-
path: "/lifecycle-manager/v1/notes",
|
|
73
|
-
action: "create",
|
|
74
|
-
commandPath: ["notes"],
|
|
75
|
-
pathParams: [],
|
|
76
|
-
queryParams: [],
|
|
77
|
-
hasBody: true,
|
|
78
|
-
output: "object",
|
|
79
|
-
summary: "Create Notes",
|
|
80
|
-
description: "Create a new note for a client."
|
|
81
|
-
},
|
|
82
|
-
{
|
|
83
|
-
methodName: "updateNotesArchiveStatusById",
|
|
84
|
-
method: "put",
|
|
85
|
-
path: "/lifecycle-manager/v1/notes/{id}/archive-status",
|
|
86
|
-
action: "update",
|
|
87
|
-
commandPath: ["notes","archive-status"],
|
|
88
|
-
pathParams: ["id"],
|
|
89
|
-
queryParams: [],
|
|
90
|
-
hasBody: true,
|
|
91
|
-
output: "object",
|
|
92
|
-
summary: "Update Notes Archive Status",
|
|
93
|
-
description: "Mark the notes as archive or bring an archived notes back to active."
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
methodName: "updateV2MeetingsById",
|
|
97
|
-
method: "put",
|
|
98
|
-
path: "/lifecycle-manager/v2/meetings/{id}",
|
|
99
|
-
action: "update",
|
|
100
|
-
commandPath: ["v2","meetings"],
|
|
101
|
-
pathParams: ["id"],
|
|
102
|
-
queryParams: [],
|
|
103
|
-
hasBody: true,
|
|
104
|
-
output: "object",
|
|
105
|
-
summary: "Update Meeting",
|
|
106
|
-
description: "Update core information about a meeting."
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
methodName: "updateMeetingTypesByMeetingTypeId",
|
|
110
|
-
method: "put",
|
|
111
|
-
path: "/lifecycle-manager/v1/meeting-types/{meeting_type_id}",
|
|
112
|
-
action: "update",
|
|
113
|
-
commandPath: ["meeting-types"],
|
|
114
|
-
pathParams: ["meeting_type_id"],
|
|
115
|
-
queryParams: [],
|
|
116
|
-
hasBody: true,
|
|
117
|
-
output: "object",
|
|
118
|
-
summary: "Update Meeting type",
|
|
119
|
-
description: "Update a Meeting type's label."
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
methodName: "deleteMeetingTypesByMeetingTypeId",
|
|
123
|
-
method: "delete",
|
|
124
|
-
path: "/lifecycle-manager/v1/meeting-types/{meeting_type_id}",
|
|
125
|
-
action: "delete",
|
|
126
|
-
commandPath: ["meeting-types"],
|
|
127
|
-
pathParams: ["meeting_type_id"],
|
|
128
|
-
queryParams: [],
|
|
129
|
-
hasBody: false,
|
|
130
|
-
output: "object",
|
|
131
|
-
summary: "Delete Meeting type",
|
|
132
|
-
description: "Deletes a Meeting type that is no longer relevant to business operations."
|
|
133
|
-
},
|
|
134
|
-
{
|
|
135
|
-
methodName: "listMeetingTypes",
|
|
136
|
-
method: "get",
|
|
137
|
-
path: "/lifecycle-manager/v1/meeting-types",
|
|
138
|
-
action: "list",
|
|
139
|
-
commandPath: ["meeting-types"],
|
|
140
|
-
pathParams: [],
|
|
141
|
-
queryParams: [],
|
|
142
|
-
hasBody: false,
|
|
143
|
-
output: "list",
|
|
144
|
-
summary: "List Meeting types",
|
|
145
|
-
description: "List all Meeting types currently available."
|
|
146
|
-
},
|
|
147
|
-
{
|
|
148
|
-
methodName: "createMeetingTypes",
|
|
149
|
-
method: "post",
|
|
150
|
-
path: "/lifecycle-manager/v1/meeting-types",
|
|
151
|
-
action: "create",
|
|
152
|
-
commandPath: ["meeting-types"],
|
|
153
|
-
pathParams: [],
|
|
154
|
-
queryParams: [],
|
|
155
|
-
hasBody: true,
|
|
156
|
-
output: "object",
|
|
157
|
-
summary: "Create Meeting type",
|
|
158
|
-
description: "Create a new Meeting type with a label."
|
|
159
|
-
},
|
|
160
|
-
{
|
|
161
|
-
methodName: "listMeetingsInitiativesByMeetingId",
|
|
162
|
-
method: "get",
|
|
163
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/initiatives",
|
|
164
|
-
action: "list",
|
|
165
|
-
commandPath: ["meetings","initiatives"],
|
|
166
|
-
pathParams: ["meeting_id"],
|
|
167
|
-
queryParams: [],
|
|
168
|
-
hasBody: false,
|
|
169
|
-
output: "list",
|
|
170
|
-
summary: "List Meeting Initiatives",
|
|
171
|
-
description: "Retrieve all initiatives that have been attached to a meeting, showing which projects will be discussed."
|
|
172
|
-
},
|
|
173
|
-
{
|
|
174
|
-
methodName: "updateMeetingsInitiativesByMeetingIdAndInitiativeId",
|
|
175
|
-
method: "put",
|
|
176
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/initiatives/{initiative_id}",
|
|
177
|
-
action: "update",
|
|
178
|
-
commandPath: ["meetings","initiatives"],
|
|
179
|
-
pathParams: ["meeting_id","initiative_id"],
|
|
180
|
-
queryParams: [],
|
|
181
|
-
hasBody: false,
|
|
182
|
-
output: "object",
|
|
183
|
-
summary: "Attach Initiative to Meeting",
|
|
184
|
-
description: "Attach an existing initiative to a meeting to include it as a discussion topic on the meeting agenda."
|
|
185
|
-
},
|
|
186
|
-
{
|
|
187
|
-
methodName: "deleteMeetingsInitiativesByMeetingIdAndInitiativeId",
|
|
188
|
-
method: "delete",
|
|
189
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/initiatives/{initiative_id}",
|
|
190
|
-
action: "delete",
|
|
191
|
-
commandPath: ["meetings","initiatives"],
|
|
192
|
-
pathParams: ["meeting_id","initiative_id"],
|
|
193
|
-
queryParams: [],
|
|
194
|
-
hasBody: false,
|
|
195
|
-
output: "object",
|
|
196
|
-
summary: "Detach Initiative from Meeting",
|
|
197
|
-
description: "Detach an initiative and a meeting without deleting the initiative itself, removing it from the meeting agenda."
|
|
198
|
-
},
|
|
199
|
-
{
|
|
200
|
-
methodName: "listMeetingsGoalsByMeetingId",
|
|
201
|
-
method: "get",
|
|
202
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/goals",
|
|
203
|
-
action: "list",
|
|
204
|
-
commandPath: ["meetings","goals"],
|
|
205
|
-
pathParams: ["meeting_id"],
|
|
206
|
-
queryParams: [],
|
|
207
|
-
hasBody: false,
|
|
208
|
-
output: "list",
|
|
209
|
-
summary: "List Meeting Goals",
|
|
210
|
-
description: "Retrieve all goals that have been attached to a meeting, showing which business objectives will be discussed or reviewed."
|
|
211
|
-
},
|
|
212
|
-
{
|
|
213
|
-
methodName: "updateMeetingsGoalsByMeetingIdAndGoalId",
|
|
214
|
-
method: "put",
|
|
215
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/goals/{goal_id}",
|
|
216
|
-
action: "update",
|
|
217
|
-
commandPath: ["meetings","goals"],
|
|
218
|
-
pathParams: ["meeting_id","goal_id"],
|
|
219
|
-
queryParams: [],
|
|
220
|
-
hasBody: false,
|
|
221
|
-
output: "object",
|
|
222
|
-
summary: "Attach Goal to Meeting",
|
|
223
|
-
description: "Attach an existing goal to a meeting to include it as a discussion topic on the meeting agenda."
|
|
224
|
-
},
|
|
225
|
-
{
|
|
226
|
-
methodName: "deleteMeetingsGoalsByMeetingIdAndGoalId",
|
|
227
|
-
method: "delete",
|
|
228
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/goals/{goal_id}",
|
|
229
|
-
action: "delete",
|
|
230
|
-
commandPath: ["meetings","goals"],
|
|
231
|
-
pathParams: ["meeting_id","goal_id"],
|
|
232
|
-
queryParams: [],
|
|
233
|
-
hasBody: false,
|
|
234
|
-
output: "object",
|
|
235
|
-
summary: "Detach Goal from Meeting",
|
|
236
|
-
description: "Detach a goal and a meeting without deleting the goal itself, removing it from the meeting agenda."
|
|
237
|
-
},
|
|
238
|
-
{
|
|
239
|
-
methodName: "getMeetingsById",
|
|
240
|
-
method: "get",
|
|
241
|
-
path: "/lifecycle-manager/v1/meetings/{id}",
|
|
242
|
-
action: "get",
|
|
243
|
-
commandPath: ["meetings"],
|
|
244
|
-
pathParams: ["id"],
|
|
245
|
-
queryParams: [],
|
|
246
|
-
hasBody: false,
|
|
247
|
-
output: "object",
|
|
248
|
-
summary: "Get Meeting",
|
|
249
|
-
description: "Access complete details of a specific meeting."
|
|
250
|
-
},
|
|
251
|
-
{
|
|
252
|
-
methodName: "updateMeetingsById",
|
|
253
|
-
method: "put",
|
|
254
|
-
path: "/lifecycle-manager/v1/meetings/{id}",
|
|
255
|
-
action: "update",
|
|
256
|
-
commandPath: ["meetings"],
|
|
257
|
-
pathParams: ["id"],
|
|
258
|
-
queryParams: [],
|
|
259
|
-
hasBody: true,
|
|
260
|
-
output: "object",
|
|
261
|
-
summary: "Update Meeting v1",
|
|
262
|
-
description: "Update core information about a meeting.\nScheduled for removal on March 1, 2027"
|
|
263
|
-
},
|
|
264
|
-
{
|
|
265
|
-
methodName: "deleteMeetingsById",
|
|
266
|
-
method: "delete",
|
|
267
|
-
path: "/lifecycle-manager/v1/meetings/{id}",
|
|
268
|
-
action: "delete",
|
|
269
|
-
commandPath: ["meetings"],
|
|
270
|
-
pathParams: ["id"],
|
|
271
|
-
queryParams: [],
|
|
272
|
-
hasBody: false,
|
|
273
|
-
output: "object",
|
|
274
|
-
summary: "Delete Meeting",
|
|
275
|
-
description: "Remove a meeting that is no longer needed."
|
|
276
|
-
},
|
|
277
|
-
{
|
|
278
|
-
methodName: "createV2Meetings",
|
|
279
|
-
method: "post",
|
|
280
|
-
path: "/lifecycle-manager/v2/meetings",
|
|
281
|
-
action: "create",
|
|
282
|
-
commandPath: ["v2","meetings"],
|
|
283
|
-
pathParams: [],
|
|
284
|
-
queryParams: [],
|
|
285
|
-
hasBody: true,
|
|
286
|
-
output: "object",
|
|
287
|
-
summary: "Create Meeting",
|
|
288
|
-
description: "Schedule a new client meeting."
|
|
289
|
-
},
|
|
290
|
-
{
|
|
291
|
-
methodName: "listMeetings",
|
|
292
|
-
method: "get",
|
|
293
|
-
path: "/lifecycle-manager/v1/meetings",
|
|
294
|
-
action: "list",
|
|
295
|
-
commandPath: ["meetings"],
|
|
296
|
-
pathParams: [],
|
|
297
|
-
queryParams: ["filter[client.id]","page_size","cursor"],
|
|
298
|
-
hasBody: false,
|
|
299
|
-
output: "list",
|
|
300
|
-
summary: "List Meetings",
|
|
301
|
-
description: "Retrieve a comprehensive list of all client meetings with filtering options."
|
|
302
|
-
},
|
|
303
|
-
{
|
|
304
|
-
methodName: "createMeetings",
|
|
305
|
-
method: "post",
|
|
306
|
-
path: "/lifecycle-manager/v1/meetings",
|
|
307
|
-
action: "create",
|
|
308
|
-
commandPath: ["meetings"],
|
|
309
|
-
pathParams: [],
|
|
310
|
-
queryParams: [],
|
|
311
|
-
hasBody: true,
|
|
312
|
-
output: "object",
|
|
313
|
-
summary: "Create Meeting v1",
|
|
314
|
-
description: "Schedule a new client meeting.\nScheduled for removal on March 1, 2027"
|
|
315
|
-
},
|
|
316
|
-
{
|
|
317
|
-
methodName: "updateMeetingsCompletionStatusById",
|
|
318
|
-
method: "put",
|
|
319
|
-
path: "/lifecycle-manager/v1/meetings/{id}/completion-status",
|
|
320
|
-
action: "update",
|
|
321
|
-
commandPath: ["meetings","completion-status"],
|
|
322
|
-
pathParams: ["id"],
|
|
323
|
-
queryParams: [],
|
|
324
|
-
hasBody: true,
|
|
325
|
-
output: "object",
|
|
326
|
-
summary: "Update Meeting Completion Status",
|
|
327
|
-
description: "Update the completion status of a meeting."
|
|
328
|
-
},
|
|
329
|
-
{
|
|
330
|
-
methodName: "createMeetingsAttendeesUsersById",
|
|
331
|
-
method: "post",
|
|
332
|
-
path: "/lifecycle-manager/v1/meetings/{id}/attendees/users",
|
|
333
|
-
action: "create",
|
|
334
|
-
commandPath: ["meetings","attendees","users"],
|
|
335
|
-
pathParams: ["id"],
|
|
336
|
-
queryParams: [],
|
|
337
|
-
hasBody: true,
|
|
338
|
-
output: "object",
|
|
339
|
-
summary: "Add Meeting User Attendees",
|
|
340
|
-
description: "Add users as meeting attendees."
|
|
341
|
-
},
|
|
342
|
-
{
|
|
343
|
-
methodName: "deleteMeetingsAttendeesUsersById",
|
|
344
|
-
method: "delete",
|
|
345
|
-
path: "/lifecycle-manager/v1/meetings/{id}/attendees/users",
|
|
346
|
-
action: "delete",
|
|
347
|
-
commandPath: ["meetings","attendees","users"],
|
|
348
|
-
pathParams: ["id"],
|
|
349
|
-
queryParams: [],
|
|
350
|
-
hasBody: true,
|
|
351
|
-
output: "object",
|
|
352
|
-
summary: "Remove Meeting User Attendees",
|
|
353
|
-
description: "Remove user attendees from the meeting."
|
|
354
|
-
},
|
|
355
|
-
{
|
|
356
|
-
methodName: "createMeetingsAttendeesContactsById",
|
|
357
|
-
method: "post",
|
|
358
|
-
path: "/lifecycle-manager/v1/meetings/{id}/attendees/contacts",
|
|
359
|
-
action: "create",
|
|
360
|
-
commandPath: ["meetings","attendees","contacts"],
|
|
361
|
-
pathParams: ["id"],
|
|
362
|
-
queryParams: [],
|
|
363
|
-
hasBody: true,
|
|
364
|
-
output: "object",
|
|
365
|
-
summary: "Add Meeting Contact Attendees",
|
|
366
|
-
description: "Add one or more client contacts as attendees."
|
|
367
|
-
},
|
|
368
|
-
{
|
|
369
|
-
methodName: "deleteMeetingsAttendeesContactsById",
|
|
370
|
-
method: "delete",
|
|
371
|
-
path: "/lifecycle-manager/v1/meetings/{id}/attendees/contacts",
|
|
372
|
-
action: "delete",
|
|
373
|
-
commandPath: ["meetings","attendees","contacts"],
|
|
374
|
-
pathParams: ["id"],
|
|
375
|
-
queryParams: [],
|
|
376
|
-
hasBody: true,
|
|
377
|
-
output: "object",
|
|
378
|
-
summary: "Remove Meeting Contact Attendees",
|
|
379
|
-
description: "Remove client contact attendees from the meeting."
|
|
380
|
-
},
|
|
381
|
-
{
|
|
382
|
-
methodName: "listMeetingsActionItemsByMeetingId",
|
|
383
|
-
method: "get",
|
|
384
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/action-items",
|
|
385
|
-
action: "list",
|
|
386
|
-
commandPath: ["meetings","action-items"],
|
|
387
|
-
pathParams: ["meeting_id"],
|
|
388
|
-
queryParams: [],
|
|
389
|
-
hasBody: false,
|
|
390
|
-
output: "list",
|
|
391
|
-
summary: "List Meeting Action Items",
|
|
392
|
-
description: "Retrieve all action items created during or linked to a specific meeting, enabling MSPs to track follow-ups and tasks resulting from client discussions."
|
|
393
|
-
},
|
|
394
|
-
{
|
|
395
|
-
methodName: "updateMeetingsActionItemsByMeetingIdAndActionItemId",
|
|
396
|
-
method: "put",
|
|
397
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/action-items/{action_item_id}",
|
|
398
|
-
action: "update",
|
|
399
|
-
commandPath: ["meetings","action-items"],
|
|
400
|
-
pathParams: ["meeting_id","action_item_id"],
|
|
401
|
-
queryParams: [],
|
|
402
|
-
hasBody: false,
|
|
403
|
-
output: "object",
|
|
404
|
-
summary: "Attach Action Item to Meeting",
|
|
405
|
-
description: "Attach an existing action item to a meeting to include it as a discussion topic or tracked deliverable from the meeting."
|
|
406
|
-
},
|
|
407
|
-
{
|
|
408
|
-
methodName: "deleteMeetingsActionItemsByMeetingIdAndActionItemId",
|
|
409
|
-
method: "delete",
|
|
410
|
-
path: "/lifecycle-manager/v1/meetings/{meeting_id}/action-items/{action_item_id}",
|
|
411
|
-
action: "delete",
|
|
412
|
-
commandPath: ["meetings","action-items"],
|
|
413
|
-
pathParams: ["meeting_id","action_item_id"],
|
|
414
|
-
queryParams: [],
|
|
415
|
-
hasBody: false,
|
|
416
|
-
output: "object",
|
|
417
|
-
summary: "Detach Action Item from Meeting",
|
|
418
|
-
description: "Detach an action item and a meeting without deleting the action item itself, allowing the task to exist independently."
|
|
419
|
-
},
|
|
420
|
-
{
|
|
421
|
-
methodName: "updateInitiativesStatusById",
|
|
422
|
-
method: "put",
|
|
423
|
-
path: "/lifecycle-manager/v1/initiatives/{id}/status",
|
|
424
|
-
action: "update",
|
|
425
|
-
commandPath: ["initiatives","status"],
|
|
426
|
-
pathParams: ["id"],
|
|
427
|
-
queryParams: [],
|
|
428
|
-
hasBody: true,
|
|
429
|
-
output: "object",
|
|
430
|
-
summary: "Update Initiative Status",
|
|
431
|
-
description: "Change the current status of an initiative to reflect its progress in the business workflow."
|
|
432
|
-
},
|
|
433
|
-
{
|
|
434
|
-
methodName: "updateInitiativesScheduleById",
|
|
435
|
-
method: "put",
|
|
436
|
-
path: "/lifecycle-manager/v1/initiatives/{id}/schedule",
|
|
437
|
-
action: "update",
|
|
438
|
-
commandPath: ["initiatives","schedule"],
|
|
439
|
-
pathParams: ["id"],
|
|
440
|
-
queryParams: [],
|
|
441
|
-
hasBody: true,
|
|
442
|
-
output: "object",
|
|
443
|
-
summary: "Schedule Initiative Fiscal Quarter",
|
|
444
|
-
description: "Update the fiscal planning timeline for when resources will be allocated to this initiative."
|
|
445
|
-
},
|
|
446
|
-
{
|
|
447
|
-
methodName: "updateInitiativesRecurringById",
|
|
448
|
-
method: "put",
|
|
449
|
-
path: "/lifecycle-manager/v1/initiatives/{id}/recurring",
|
|
450
|
-
action: "update",
|
|
451
|
-
commandPath: ["initiatives","recurring"],
|
|
452
|
-
pathParams: ["id"],
|
|
453
|
-
queryParams: [],
|
|
454
|
-
hasBody: true,
|
|
455
|
-
output: "object",
|
|
456
|
-
summary: "Update Initiative Recurring Investments",
|
|
457
|
-
description: "Manage the ongoing financial commitments of an initiative by updating the complete set of monthly or yearly recurring expenses."
|
|
458
|
-
},
|
|
459
|
-
{
|
|
460
|
-
methodName: "updateInitiativesPriorityById",
|
|
461
|
-
method: "put",
|
|
462
|
-
path: "/lifecycle-manager/v1/initiatives/{id}/priority",
|
|
463
|
-
action: "update",
|
|
464
|
-
commandPath: ["initiatives","priority"],
|
|
465
|
-
pathParams: ["id"],
|
|
466
|
-
queryParams: [],
|
|
467
|
-
hasBody: true,
|
|
468
|
-
output: "object",
|
|
469
|
-
summary: "Update Initiative Priority",
|
|
470
|
-
description: "Adjust the business priority level of an initiative to reflect its strategic importance."
|
|
471
|
-
},
|
|
472
|
-
{
|
|
473
|
-
methodName: "updateInitiativesBudgetById",
|
|
474
|
-
method: "put",
|
|
475
|
-
path: "/lifecycle-manager/v1/initiatives/{id}/budget",
|
|
476
|
-
action: "update",
|
|
477
|
-
commandPath: ["initiatives","budget"],
|
|
478
|
-
pathParams: ["id"],
|
|
479
|
-
queryParams: [],
|
|
480
|
-
hasBody: true,
|
|
481
|
-
output: "object",
|
|
482
|
-
summary: "Update Initiative One-Time Investments",
|
|
483
|
-
description: "Revise the complete financial plan for an initiative by providing a comprehensive breakdown of all one-time costs and investments."
|
|
484
|
-
},
|
|
485
|
-
{
|
|
486
|
-
methodName: "listInitiativesMeetingsByInitiativeId",
|
|
487
|
-
method: "get",
|
|
488
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/meetings",
|
|
489
|
-
action: "list",
|
|
490
|
-
commandPath: ["initiatives","meetings"],
|
|
491
|
-
pathParams: ["initiative_id"],
|
|
492
|
-
queryParams: [],
|
|
493
|
-
hasBody: false,
|
|
494
|
-
output: "list",
|
|
495
|
-
summary: "List Initiative Meetings",
|
|
496
|
-
description: "Retrieve the meetings that are aligned with a specific initiative, enabling MSPs to track discussions and reviews related to the initiative."
|
|
497
|
-
},
|
|
498
|
-
{
|
|
499
|
-
methodName: "updateInitiativesMeetingsByInitiativeIdAndMeetingId",
|
|
500
|
-
method: "put",
|
|
501
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/meetings/{meeting_id}",
|
|
502
|
-
action: "update",
|
|
503
|
-
commandPath: ["initiatives","meetings"],
|
|
504
|
-
pathParams: ["initiative_id","meeting_id"],
|
|
505
|
-
queryParams: [],
|
|
506
|
-
hasBody: false,
|
|
507
|
-
output: "object",
|
|
508
|
-
summary: "Attach Meeting to Initiative",
|
|
509
|
-
description: "Attach an existing meeting to an initiative to establish alignment between client discussions and implementation efforts."
|
|
510
|
-
},
|
|
511
|
-
{
|
|
512
|
-
methodName: "deleteInitiativesMeetingsByInitiativeIdAndMeetingId",
|
|
513
|
-
method: "delete",
|
|
514
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/meetings/{meeting_id}",
|
|
515
|
-
action: "delete",
|
|
516
|
-
commandPath: ["initiatives","meetings"],
|
|
517
|
-
pathParams: ["initiative_id","meeting_id"],
|
|
518
|
-
queryParams: [],
|
|
519
|
-
hasBody: false,
|
|
520
|
-
output: "object",
|
|
521
|
-
summary: "Detach Meeting from Initiative",
|
|
522
|
-
description: "Detach a meeting and an initiative, without deleting either entity."
|
|
523
|
-
},
|
|
524
|
-
{
|
|
525
|
-
methodName: "listInitiativesGoalsByInitiativeId",
|
|
526
|
-
method: "get",
|
|
527
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/goals",
|
|
528
|
-
action: "list",
|
|
529
|
-
commandPath: ["initiatives","goals"],
|
|
530
|
-
pathParams: ["initiative_id"],
|
|
531
|
-
queryParams: [],
|
|
532
|
-
hasBody: false,
|
|
533
|
-
output: "list",
|
|
534
|
-
summary: "List Initiative Goals",
|
|
535
|
-
description: "Retrieve all goals that are aligned with a specific initiative, enabling visibility into how initiatives support broader business objectives."
|
|
536
|
-
},
|
|
537
|
-
{
|
|
538
|
-
methodName: "updateInitiativesGoalsByInitiativeIdAndGoalId",
|
|
539
|
-
method: "put",
|
|
540
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/goals/{goal_id}",
|
|
541
|
-
action: "update",
|
|
542
|
-
commandPath: ["initiatives","goals"],
|
|
543
|
-
pathParams: ["initiative_id","goal_id"],
|
|
544
|
-
queryParams: [],
|
|
545
|
-
hasBody: false,
|
|
546
|
-
output: "object",
|
|
547
|
-
summary: "Attach Goal to Initiative",
|
|
548
|
-
description: "Attach an existing goal to an initiative to establish alignment between strategic objectives and implementation efforts."
|
|
549
|
-
},
|
|
550
|
-
{
|
|
551
|
-
methodName: "deleteInitiativesGoalsByInitiativeIdAndGoalId",
|
|
552
|
-
method: "delete",
|
|
553
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/goals/{goal_id}",
|
|
554
|
-
action: "delete",
|
|
555
|
-
commandPath: ["initiatives","goals"],
|
|
556
|
-
pathParams: ["initiative_id","goal_id"],
|
|
557
|
-
queryParams: [],
|
|
558
|
-
hasBody: false,
|
|
559
|
-
output: "object",
|
|
560
|
-
summary: "Detach Goal from Initiative",
|
|
561
|
-
description: "Detach a goal and an initiative, without deleting either entity."
|
|
562
|
-
},
|
|
563
|
-
{
|
|
564
|
-
methodName: "getInitiativesById",
|
|
565
|
-
method: "get",
|
|
566
|
-
path: "/lifecycle-manager/v1/initiatives/{id}",
|
|
567
|
-
action: "get",
|
|
568
|
-
commandPath: ["initiatives"],
|
|
569
|
-
pathParams: ["id"],
|
|
570
|
-
queryParams: [],
|
|
571
|
-
hasBody: false,
|
|
572
|
-
output: "object",
|
|
573
|
-
summary: "Get Initiative",
|
|
574
|
-
description: "Access complete details of a specific initiative including its budget, recurring costs, status, and all associated resources."
|
|
575
|
-
},
|
|
576
|
-
{
|
|
577
|
-
methodName: "updateInitiativesById",
|
|
578
|
-
method: "put",
|
|
579
|
-
path: "/lifecycle-manager/v1/initiatives/{id}",
|
|
580
|
-
action: "update",
|
|
581
|
-
commandPath: ["initiatives"],
|
|
582
|
-
pathParams: ["id"],
|
|
583
|
-
queryParams: [],
|
|
584
|
-
hasBody: true,
|
|
585
|
-
output: "object",
|
|
586
|
-
summary: "Update Initiative",
|
|
587
|
-
description: "Update initiative details including name, description, and other essential metadata."
|
|
588
|
-
},
|
|
589
|
-
{
|
|
590
|
-
methodName: "deleteInitiativesById",
|
|
591
|
-
method: "delete",
|
|
592
|
-
path: "/lifecycle-manager/v1/initiatives/{id}",
|
|
593
|
-
action: "delete",
|
|
594
|
-
commandPath: ["initiatives"],
|
|
595
|
-
pathParams: ["id"],
|
|
596
|
-
queryParams: [],
|
|
597
|
-
hasBody: false,
|
|
598
|
-
output: "object",
|
|
599
|
-
summary: "Delete Initiative",
|
|
600
|
-
description: "Permanently remove an initiative that is no longer relevant to business operations."
|
|
601
|
-
},
|
|
602
|
-
{
|
|
603
|
-
methodName: "listInitiatives",
|
|
604
|
-
method: "get",
|
|
605
|
-
path: "/lifecycle-manager/v1/initiatives",
|
|
606
|
-
action: "list",
|
|
607
|
-
commandPath: ["initiatives"],
|
|
608
|
-
pathParams: [],
|
|
609
|
-
queryParams: ["filter[client.id]","page_size","cursor"],
|
|
610
|
-
hasBody: false,
|
|
611
|
-
output: "list",
|
|
612
|
-
summary: "List Initiatives",
|
|
613
|
-
description: "Retrieve a comprehensive list of all strategic initiatives with filtering options."
|
|
614
|
-
},
|
|
615
|
-
{
|
|
616
|
-
methodName: "createInitiatives",
|
|
617
|
-
method: "post",
|
|
618
|
-
path: "/lifecycle-manager/v1/initiatives",
|
|
619
|
-
action: "create",
|
|
620
|
-
commandPath: ["initiatives"],
|
|
621
|
-
pathParams: [],
|
|
622
|
-
queryParams: [],
|
|
623
|
-
hasBody: true,
|
|
624
|
-
output: "object",
|
|
625
|
-
summary: "Create Initiative",
|
|
626
|
-
description: "Create a new strategic initiative with all necessary details to establish a program, project, or operational effort aligned with business goals."
|
|
627
|
-
},
|
|
628
|
-
{
|
|
629
|
-
methodName: "listInitiativesActionItemsByInitiativeId",
|
|
630
|
-
method: "get",
|
|
631
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/action-items",
|
|
632
|
-
action: "list",
|
|
633
|
-
commandPath: ["initiatives","action-items"],
|
|
634
|
-
pathParams: ["initiative_id"],
|
|
635
|
-
queryParams: [],
|
|
636
|
-
hasBody: false,
|
|
637
|
-
output: "list",
|
|
638
|
-
summary: "List Initiative Action Items",
|
|
639
|
-
description: "Retrieve all action items that are aligned with a specific initiative, enabling MSPs to track the tasks required to complete the initiative."
|
|
640
|
-
},
|
|
641
|
-
{
|
|
642
|
-
methodName: "updateInitiativesActionItemsByInitiativeIdAndActionItemId",
|
|
643
|
-
method: "put",
|
|
644
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/action-items/{action_item_id}",
|
|
645
|
-
action: "update",
|
|
646
|
-
commandPath: ["initiatives","action-items"],
|
|
647
|
-
pathParams: ["initiative_id","action_item_id"],
|
|
648
|
-
queryParams: [],
|
|
649
|
-
hasBody: false,
|
|
650
|
-
output: "object",
|
|
651
|
-
summary: "Attach Action Item to Initiative",
|
|
652
|
-
description: "Attach an existing action item to an initiative to establish alignment between tasks and implementation efforts."
|
|
653
|
-
},
|
|
654
|
-
{
|
|
655
|
-
methodName: "deleteInitiativesActionItemsByInitiativeIdAndActionItemId",
|
|
656
|
-
method: "delete",
|
|
657
|
-
path: "/lifecycle-manager/v1/initiatives/{initiative_id}/action-items/{action_item_id}",
|
|
658
|
-
action: "delete",
|
|
659
|
-
commandPath: ["initiatives","action-items"],
|
|
660
|
-
pathParams: ["initiative_id","action_item_id"],
|
|
661
|
-
queryParams: [],
|
|
662
|
-
hasBody: false,
|
|
663
|
-
output: "object",
|
|
664
|
-
summary: "Detach Action Item from Initiative",
|
|
665
|
-
description: "Detach an action item and an initiative, without deleting either entity."
|
|
666
|
-
},
|
|
667
|
-
{
|
|
668
|
-
methodName: "updateGoalsStatusById",
|
|
669
|
-
method: "put",
|
|
670
|
-
path: "/lifecycle-manager/v1/goals/{id}/status",
|
|
671
|
-
action: "update",
|
|
672
|
-
commandPath: ["goals","status"],
|
|
673
|
-
pathParams: ["id"],
|
|
674
|
-
queryParams: [],
|
|
675
|
-
hasBody: true,
|
|
676
|
-
output: "object",
|
|
677
|
-
summary: "Update Goal Status",
|
|
678
|
-
description: "Change goal status to reflect its current state in the business workflow."
|
|
679
|
-
},
|
|
680
|
-
{
|
|
681
|
-
methodName: "updateGoalsScheduleById",
|
|
682
|
-
method: "put",
|
|
683
|
-
path: "/lifecycle-manager/v1/goals/{id}/schedule",
|
|
684
|
-
action: "update",
|
|
685
|
-
commandPath: ["goals","schedule"],
|
|
686
|
-
pathParams: ["id"],
|
|
687
|
-
queryParams: [],
|
|
688
|
-
hasBody: true,
|
|
689
|
-
output: "object",
|
|
690
|
-
summary: "Update Goal Schedule",
|
|
691
|
-
description: "Update goal target period to reflect its current state in the business workflow."
|
|
692
|
-
},
|
|
693
|
-
{
|
|
694
|
-
methodName: "listGoalsMeetingsByGoalId",
|
|
695
|
-
method: "get",
|
|
696
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/meetings",
|
|
697
|
-
action: "list",
|
|
698
|
-
commandPath: ["goals","meetings"],
|
|
699
|
-
pathParams: ["goal_id"],
|
|
700
|
-
queryParams: [],
|
|
701
|
-
hasBody: false,
|
|
702
|
-
output: "list",
|
|
703
|
-
summary: "List Goal Meetings",
|
|
704
|
-
description: "Retrieve all meetings that is aligned with this goal, tracking client engagement around this strategic objective."
|
|
705
|
-
},
|
|
706
|
-
{
|
|
707
|
-
methodName: "updateGoalsMeetingsByGoalIdAndMeetingId",
|
|
708
|
-
method: "put",
|
|
709
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/meetings/{meeting_id}",
|
|
710
|
-
action: "update",
|
|
711
|
-
commandPath: ["goals","meetings"],
|
|
712
|
-
pathParams: ["goal_id","meeting_id"],
|
|
713
|
-
queryParams: [],
|
|
714
|
-
hasBody: false,
|
|
715
|
-
output: "object",
|
|
716
|
-
summary: "Attach Meeting to Goal",
|
|
717
|
-
description: "Attach an existing meeting to a goal to establish that this strategic objective will be discussed or reviewed during the meeting."
|
|
718
|
-
},
|
|
719
|
-
{
|
|
720
|
-
methodName: "deleteGoalsMeetingsByGoalIdAndMeetingId",
|
|
721
|
-
method: "delete",
|
|
722
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/meetings/{meeting_id}",
|
|
723
|
-
action: "delete",
|
|
724
|
-
commandPath: ["goals","meetings"],
|
|
725
|
-
pathParams: ["goal_id","meeting_id"],
|
|
726
|
-
queryParams: [],
|
|
727
|
-
hasBody: false,
|
|
728
|
-
output: "object",
|
|
729
|
-
summary: "Detach Meeting from Goal",
|
|
730
|
-
description: "Detach a meeting and a goal without deleting the meeting itself, removing the goal from the meeting agenda."
|
|
731
|
-
},
|
|
732
|
-
{
|
|
733
|
-
methodName: "listGoalsInitiativesByGoalId",
|
|
734
|
-
method: "get",
|
|
735
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/initiatives",
|
|
736
|
-
action: "list",
|
|
737
|
-
commandPath: ["goals","initiatives"],
|
|
738
|
-
pathParams: ["goal_id"],
|
|
739
|
-
queryParams: [],
|
|
740
|
-
hasBody: false,
|
|
741
|
-
output: "list",
|
|
742
|
-
summary: "List Goal Initiatives",
|
|
743
|
-
description: "Retrieve all initiatives that are aligned with this goal, showing the projects that contribute to achieving this objective."
|
|
744
|
-
},
|
|
745
|
-
{
|
|
746
|
-
methodName: "updateGoalsInitiativesByGoalIdAndInitiativeId",
|
|
747
|
-
method: "put",
|
|
748
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/initiatives/{initiative_id}",
|
|
749
|
-
action: "update",
|
|
750
|
-
commandPath: ["goals","initiatives"],
|
|
751
|
-
pathParams: ["goal_id","initiative_id"],
|
|
752
|
-
queryParams: [],
|
|
753
|
-
hasBody: false,
|
|
754
|
-
output: "object",
|
|
755
|
-
summary: "Attach Initiative to Goal",
|
|
756
|
-
description: "Attach an existing initiative to a goal to establish a relationship between the strategic objective and the project that contributes to achieving it."
|
|
757
|
-
},
|
|
758
|
-
{
|
|
759
|
-
methodName: "deleteGoalsInitiativesByGoalIdAndInitiativeId",
|
|
760
|
-
method: "delete",
|
|
761
|
-
path: "/lifecycle-manager/v1/goals/{goal_id}/initiatives/{initiative_id}",
|
|
762
|
-
action: "delete",
|
|
763
|
-
commandPath: ["goals","initiatives"],
|
|
764
|
-
pathParams: ["goal_id","initiative_id"],
|
|
765
|
-
queryParams: [],
|
|
766
|
-
hasBody: false,
|
|
767
|
-
output: "object",
|
|
768
|
-
summary: "Detach Initiative from Goal",
|
|
769
|
-
description: "Detach an initiative and a goal without deleting the initiative itself, so it no longer contributes to this objective."
|
|
770
|
-
},
|
|
771
|
-
{
|
|
772
|
-
methodName: "getGoalsById",
|
|
773
|
-
method: "get",
|
|
774
|
-
path: "/lifecycle-manager/v1/goals/{id}",
|
|
775
|
-
action: "get",
|
|
776
|
-
commandPath: ["goals"],
|
|
777
|
-
pathParams: ["id"],
|
|
778
|
-
queryParams: [],
|
|
779
|
-
hasBody: false,
|
|
780
|
-
output: "object",
|
|
781
|
-
summary: "Get Goal",
|
|
782
|
-
description: "Gets a goal record in Lifecycle Manager by the goal's id."
|
|
783
|
-
},
|
|
784
|
-
{
|
|
785
|
-
methodName: "updateGoalsById",
|
|
786
|
-
method: "put",
|
|
787
|
-
path: "/lifecycle-manager/v1/goals/{id}",
|
|
788
|
-
action: "update",
|
|
789
|
-
commandPath: ["goals"],
|
|
790
|
-
pathParams: ["id"],
|
|
791
|
-
queryParams: [],
|
|
792
|
-
hasBody: true,
|
|
793
|
-
output: "object",
|
|
794
|
-
summary: "Update Goal",
|
|
795
|
-
description: "Update goal details including title, description, status, and target period."
|
|
796
|
-
},
|
|
797
|
-
{
|
|
798
|
-
methodName: "deleteGoalsById",
|
|
799
|
-
method: "delete",
|
|
800
|
-
path: "/lifecycle-manager/v1/goals/{id}",
|
|
801
|
-
action: "delete",
|
|
802
|
-
commandPath: ["goals"],
|
|
803
|
-
pathParams: ["id"],
|
|
804
|
-
queryParams: [],
|
|
805
|
-
hasBody: false,
|
|
806
|
-
output: "object",
|
|
807
|
-
summary: "Delete Goal",
|
|
808
|
-
description: "Deletes a goal that is no longer relevant to business operations."
|
|
809
|
-
},
|
|
810
|
-
{
|
|
811
|
-
methodName: "listGoals",
|
|
812
|
-
method: "get",
|
|
813
|
-
path: "/lifecycle-manager/v1/goals",
|
|
814
|
-
action: "list",
|
|
815
|
-
commandPath: ["goals"],
|
|
816
|
-
pathParams: [],
|
|
817
|
-
queryParams: ["filter[client.id]","filter[title]","filter[status]","filter[period.year]","filter[period.half]","filter[period.quarter]","sort","page_size","cursor"],
|
|
818
|
-
hasBody: false,
|
|
819
|
-
output: "list",
|
|
820
|
-
summary: "List Goals",
|
|
821
|
-
description: "List all goals to help you quickly find relevant objectives with filtering options."
|
|
822
|
-
},
|
|
823
|
-
{
|
|
824
|
-
methodName: "createGoals",
|
|
825
|
-
method: "post",
|
|
826
|
-
path: "/lifecycle-manager/v1/goals",
|
|
827
|
-
action: "create",
|
|
828
|
-
commandPath: ["goals"],
|
|
829
|
-
pathParams: [],
|
|
830
|
-
queryParams: [],
|
|
831
|
-
hasBody: true,
|
|
832
|
-
output: "object",
|
|
833
|
-
summary: "Create Goal",
|
|
834
|
-
description: "Create a new goal with all necessary details to establish a measurable objective."
|
|
835
|
-
},
|
|
836
|
-
{
|
|
837
|
-
methodName: "updateActionItemsCompletionStatusById",
|
|
838
|
-
method: "put",
|
|
839
|
-
path: "/lifecycle-manager/v1/action-items/{id}/completion-status",
|
|
840
|
-
action: "update",
|
|
841
|
-
commandPath: ["action-items","completion-status"],
|
|
842
|
-
pathParams: ["id"],
|
|
843
|
-
queryParams: [],
|
|
844
|
-
hasBody: true,
|
|
845
|
-
output: "object",
|
|
846
|
-
summary: "Update Action Item Completion Status",
|
|
847
|
-
description: "Mark an action item as incomplete or completed to reflect the status of an action item."
|
|
848
|
-
},
|
|
849
|
-
{
|
|
850
|
-
methodName: "getActionItemsById",
|
|
851
|
-
method: "get",
|
|
852
|
-
path: "/lifecycle-manager/v1/action-items/{id}",
|
|
853
|
-
action: "get",
|
|
854
|
-
commandPath: ["action-items"],
|
|
855
|
-
pathParams: ["id"],
|
|
856
|
-
queryParams: [],
|
|
857
|
-
hasBody: false,
|
|
858
|
-
output: "object",
|
|
859
|
-
summary: "Get Action Item",
|
|
860
|
-
description: "Get an action item by the item's id. The returned data includes Action item details and linked entities."
|
|
861
|
-
},
|
|
862
|
-
{
|
|
863
|
-
methodName: "updateActionItemsById",
|
|
864
|
-
method: "put",
|
|
865
|
-
path: "/lifecycle-manager/v1/action-items/{id}",
|
|
866
|
-
action: "update",
|
|
867
|
-
commandPath: ["action-items"],
|
|
868
|
-
pathParams: ["id"],
|
|
869
|
-
queryParams: [],
|
|
870
|
-
hasBody: true,
|
|
871
|
-
output: "object",
|
|
872
|
-
summary: "Update Action Item",
|
|
873
|
-
description: "Update an existing action item with all necessary details for an action."
|
|
874
|
-
},
|
|
875
|
-
{
|
|
876
|
-
methodName: "deleteActionItemsById",
|
|
877
|
-
method: "delete",
|
|
878
|
-
path: "/lifecycle-manager/v1/action-items/{id}",
|
|
879
|
-
action: "delete",
|
|
880
|
-
commandPath: ["action-items"],
|
|
881
|
-
pathParams: ["id"],
|
|
882
|
-
queryParams: [],
|
|
883
|
-
hasBody: false,
|
|
884
|
-
output: "object",
|
|
885
|
-
summary: "Delete Action Item",
|
|
886
|
-
description: "Deletes an action item that is no longer relevant to business operations."
|
|
887
|
-
},
|
|
888
|
-
{
|
|
889
|
-
methodName: "listActionItems",
|
|
890
|
-
method: "get",
|
|
891
|
-
path: "/lifecycle-manager/v1/action-items",
|
|
892
|
-
action: "list",
|
|
893
|
-
commandPath: ["action-items"],
|
|
894
|
-
pathParams: [],
|
|
895
|
-
queryParams: ["filter[client.id]","filter[is_completed]","filter[is_overdue]","page_size","cursor"],
|
|
896
|
-
hasBody: false,
|
|
897
|
-
output: "list",
|
|
898
|
-
summary: "List Action Items",
|
|
899
|
-
description: "Get a list of action items. The returned data includes Action item details and linked entities."
|
|
900
|
-
},
|
|
901
|
-
{
|
|
902
|
-
methodName: "createActionItems",
|
|
903
|
-
method: "post",
|
|
904
|
-
path: "/lifecycle-manager/v1/action-items",
|
|
905
|
-
action: "create",
|
|
906
|
-
commandPath: ["action-items"],
|
|
907
|
-
pathParams: [],
|
|
908
|
-
queryParams: [],
|
|
909
|
-
hasBody: true,
|
|
910
|
-
output: "object",
|
|
911
|
-
summary: "Create Action Item",
|
|
912
|
-
description: "Create a new action item with all necessary details to establish a measurable objective."
|
|
913
|
-
},
|
|
914
|
-
{
|
|
915
|
-
methodName: "getContractsById",
|
|
916
|
-
method: "get",
|
|
917
|
-
path: "/lifecycle-manager/v1/contracts/{id}",
|
|
918
|
-
action: "get",
|
|
919
|
-
commandPath: ["contracts"],
|
|
920
|
-
pathParams: ["id"],
|
|
921
|
-
queryParams: [],
|
|
922
|
-
hasBody: false,
|
|
923
|
-
output: "object",
|
|
924
|
-
summary: "Get Contract",
|
|
925
|
-
description: "Access complete details of a specific contract."
|
|
926
|
-
},
|
|
927
|
-
{
|
|
928
|
-
methodName: "updateContractsById",
|
|
929
|
-
method: "put",
|
|
930
|
-
path: "/lifecycle-manager/v1/contracts/{id}",
|
|
931
|
-
action: "update",
|
|
932
|
-
commandPath: ["contracts"],
|
|
933
|
-
pathParams: ["id"],
|
|
934
|
-
queryParams: [],
|
|
935
|
-
hasBody: true,
|
|
936
|
-
output: "object",
|
|
937
|
-
summary: "Update Contract",
|
|
938
|
-
description: "Update a contract with full details."
|
|
939
|
-
},
|
|
940
|
-
{
|
|
941
|
-
methodName: "deleteContractsById",
|
|
942
|
-
method: "delete",
|
|
943
|
-
path: "/lifecycle-manager/v1/contracts/{id}",
|
|
944
|
-
action: "delete",
|
|
945
|
-
commandPath: ["contracts"],
|
|
946
|
-
pathParams: ["id"],
|
|
947
|
-
queryParams: [],
|
|
948
|
-
hasBody: false,
|
|
949
|
-
output: "object",
|
|
950
|
-
summary: "Delete Contract",
|
|
951
|
-
description: "Permanently remove an contract that is no longer relevant to business operations."
|
|
952
|
-
},
|
|
953
|
-
{
|
|
954
|
-
methodName: "listContracts",
|
|
955
|
-
method: "get",
|
|
956
|
-
path: "/lifecycle-manager/v1/contracts",
|
|
957
|
-
action: "list",
|
|
958
|
-
commandPath: ["contracts"],
|
|
959
|
-
pathParams: [],
|
|
960
|
-
queryParams: ["filter[client.id]","filter[expiry_status]","page_size","cursor"],
|
|
961
|
-
hasBody: false,
|
|
962
|
-
output: "list",
|
|
963
|
-
summary: "List Contracts",
|
|
964
|
-
description: "Retrieve a comprehensive list of all contracts overview with filtering options."
|
|
965
|
-
},
|
|
966
|
-
{
|
|
967
|
-
methodName: "createContracts",
|
|
968
|
-
method: "post",
|
|
969
|
-
path: "/lifecycle-manager/v1/contracts",
|
|
970
|
-
action: "create",
|
|
971
|
-
commandPath: ["contracts"],
|
|
972
|
-
pathParams: [],
|
|
973
|
-
queryParams: [],
|
|
974
|
-
hasBody: true,
|
|
975
|
-
output: "object",
|
|
976
|
-
summary: "Create Contract",
|
|
977
|
-
description: "Create a new contract."
|
|
978
|
-
},
|
|
979
|
-
{
|
|
980
|
-
methodName: "listAssetsHardwareLifecycles",
|
|
981
|
-
method: "get",
|
|
982
|
-
path: "/lifecycle-manager/v1/assets/hardware/lifecycles",
|
|
983
|
-
action: "list",
|
|
984
|
-
commandPath: ["assets","hardware","lifecycles"],
|
|
985
|
-
pathParams: [],
|
|
986
|
-
queryParams: ["filter[client_id]","filter[serial_number]","page_size","cursor"],
|
|
987
|
-
hasBody: false,
|
|
988
|
-
output: "list",
|
|
989
|
-
summary: "List active hardware lifecycle records",
|
|
990
|
-
description: "Retrieves a list of active hardware lifecycle records from Lifecycle Manager.\r\nThe returned data includes basic device information, such as model and serial number, as well as purchase date and warranty expiry metadata.\r\nSupports optional filtering by client ID and serial number to narrow down results."
|
|
991
|
-
},
|
|
992
|
-
{
|
|
993
|
-
methodName: "getAssessmentTemplatesByAssessmentTemplateId",
|
|
994
|
-
method: "get",
|
|
995
|
-
path: "/lifecycle-manager/v1/assessment-templates/{assessment_template_id}",
|
|
996
|
-
action: "get",
|
|
997
|
-
commandPath: ["assessment-templates"],
|
|
998
|
-
pathParams: ["assessment_template_id"],
|
|
999
|
-
queryParams: [],
|
|
1000
|
-
hasBody: false,
|
|
1001
|
-
output: "object",
|
|
1002
|
-
summary: "Get Assessment Template",
|
|
1003
|
-
description: "Retrieve comprehensive details of a specific assessment template including all categories, questions, and criteria."
|
|
1004
|
-
},
|
|
1005
|
-
{
|
|
1006
|
-
methodName: "updateAssessmentTemplatesByAssessmentTemplateId",
|
|
1007
|
-
method: "put",
|
|
1008
|
-
path: "/lifecycle-manager/v1/assessment-templates/{assessment_template_id}",
|
|
1009
|
-
action: "update",
|
|
1010
|
-
commandPath: ["assessment-templates"],
|
|
1011
|
-
pathParams: ["assessment_template_id"],
|
|
1012
|
-
queryParams: [],
|
|
1013
|
-
hasBody: true,
|
|
1014
|
-
output: "object",
|
|
1015
|
-
summary: "Update Assessment Template",
|
|
1016
|
-
description: "Modify an existing assessment template including its structure, categories, questions, and criteria."
|
|
1017
|
-
},
|
|
1018
|
-
{
|
|
1019
|
-
methodName: "deleteAssessmentTemplatesByAssessmentTemplateId",
|
|
1020
|
-
method: "delete",
|
|
1021
|
-
path: "/lifecycle-manager/v1/assessment-templates/{assessment_template_id}",
|
|
1022
|
-
action: "delete",
|
|
1023
|
-
commandPath: ["assessment-templates"],
|
|
1024
|
-
pathParams: ["assessment_template_id"],
|
|
1025
|
-
queryParams: [],
|
|
1026
|
-
hasBody: false,
|
|
1027
|
-
output: "object",
|
|
1028
|
-
summary: "Delete Assessment Template",
|
|
1029
|
-
description: "Permanently remove an assessment template that is no longer needed."
|
|
1030
|
-
},
|
|
1031
|
-
{
|
|
1032
|
-
methodName: "listAssessmentTemplates",
|
|
1033
|
-
method: "get",
|
|
1034
|
-
path: "/lifecycle-manager/v1/assessment-templates",
|
|
1035
|
-
action: "list",
|
|
1036
|
-
commandPath: ["assessment-templates"],
|
|
1037
|
-
pathParams: [],
|
|
1038
|
-
queryParams: [],
|
|
1039
|
-
hasBody: false,
|
|
1040
|
-
output: "list",
|
|
1041
|
-
summary: "List Assessment Templates",
|
|
1042
|
-
description: "Retrieve a comprehensive list of all assessment template overviews for the account."
|
|
1043
|
-
},
|
|
1044
|
-
{
|
|
1045
|
-
methodName: "createAssessmentTemplates",
|
|
1046
|
-
method: "post",
|
|
1047
|
-
path: "/lifecycle-manager/v1/assessment-templates",
|
|
1048
|
-
action: "create",
|
|
1049
|
-
commandPath: ["assessment-templates"],
|
|
1050
|
-
pathParams: [],
|
|
1051
|
-
queryParams: [],
|
|
1052
|
-
hasBody: true,
|
|
1053
|
-
output: "object",
|
|
1054
|
-
summary: "Create Assessment Template",
|
|
1055
|
-
description: "Create a new assessment template with custom categories, questions, and criteria."
|
|
1056
|
-
},
|
|
1057
|
-
{
|
|
1058
|
-
methodName: "updateAssessmentsInternalCommentById",
|
|
1059
|
-
method: "put",
|
|
1060
|
-
path: "/lifecycle-manager/v1/assessments/{id}/internal-comment",
|
|
1061
|
-
action: "update",
|
|
1062
|
-
commandPath: ["assessments","internal-comment"],
|
|
1063
|
-
pathParams: ["id"],
|
|
1064
|
-
queryParams: [],
|
|
1065
|
-
hasBody: true,
|
|
1066
|
-
output: "object",
|
|
1067
|
-
summary: "Update Assessment Internal Comment",
|
|
1068
|
-
description: "Leave an internal comment for an existing assessment. This note is private and is only visible to the MSP."
|
|
1069
|
-
},
|
|
1070
|
-
{
|
|
1071
|
-
methodName: "updateAssessmentsEvaluateById",
|
|
1072
|
-
method: "put",
|
|
1073
|
-
path: "/lifecycle-manager/v1/assessments/{id}/evaluate",
|
|
1074
|
-
action: "update",
|
|
1075
|
-
commandPath: ["assessments","evaluate"],
|
|
1076
|
-
pathParams: ["id"],
|
|
1077
|
-
queryParams: [],
|
|
1078
|
-
hasBody: true,
|
|
1079
|
-
output: "object",
|
|
1080
|
-
summary: "Evaluate Assessment",
|
|
1081
|
-
description: "Evaluate an assessment by selecting criteria for multiple questions."
|
|
1082
|
-
},
|
|
1083
|
-
{
|
|
1084
|
-
methodName: "getAssessmentsById",
|
|
1085
|
-
method: "get",
|
|
1086
|
-
path: "/lifecycle-manager/v1/assessments/{id}",
|
|
1087
|
-
action: "get",
|
|
1088
|
-
commandPath: ["assessments"],
|
|
1089
|
-
pathParams: ["id"],
|
|
1090
|
-
queryParams: [],
|
|
1091
|
-
hasBody: false,
|
|
1092
|
-
output: "object",
|
|
1093
|
-
summary: "Get Assessment",
|
|
1094
|
-
description: "Access complete details of a specific assessment including its evaluation."
|
|
1095
|
-
},
|
|
1096
|
-
{
|
|
1097
|
-
methodName: "updateAssessmentsById",
|
|
1098
|
-
method: "put",
|
|
1099
|
-
path: "/lifecycle-manager/v1/assessments/{id}",
|
|
1100
|
-
action: "update",
|
|
1101
|
-
commandPath: ["assessments"],
|
|
1102
|
-
pathParams: ["id"],
|
|
1103
|
-
queryParams: [],
|
|
1104
|
-
hasBody: true,
|
|
1105
|
-
output: "object",
|
|
1106
|
-
summary: "Update Assessment",
|
|
1107
|
-
description: "Update assessment details including title, evaluate user and datetime."
|
|
1108
|
-
},
|
|
1109
|
-
{
|
|
1110
|
-
methodName: "deleteAssessmentsById",
|
|
1111
|
-
method: "delete",
|
|
1112
|
-
path: "/lifecycle-manager/v1/assessments/{id}",
|
|
1113
|
-
action: "delete",
|
|
1114
|
-
commandPath: ["assessments"],
|
|
1115
|
-
pathParams: ["id"],
|
|
1116
|
-
queryParams: [],
|
|
1117
|
-
hasBody: false,
|
|
1118
|
-
output: "object",
|
|
1119
|
-
summary: "Delete Assessment",
|
|
1120
|
-
description: "Permanently remove an assessment that is no longer relevant to business operations."
|
|
1121
|
-
},
|
|
1122
|
-
{
|
|
1123
|
-
methodName: "listAssessments",
|
|
1124
|
-
method: "get",
|
|
1125
|
-
path: "/lifecycle-manager/v1/assessments",
|
|
1126
|
-
action: "list",
|
|
1127
|
-
commandPath: ["assessments"],
|
|
1128
|
-
pathParams: [],
|
|
1129
|
-
queryParams: ["filter[client.id]","filter[status]","filter[assessment_template_id]","page_size","cursor"],
|
|
1130
|
-
hasBody: false,
|
|
1131
|
-
output: "list",
|
|
1132
|
-
summary: "List Assessments",
|
|
1133
|
-
description: "Retrieve a comprehensive list of all assessments overview with filtering options."
|
|
1134
|
-
},
|
|
1135
|
-
{
|
|
1136
|
-
methodName: "createAssessments",
|
|
1137
|
-
method: "post",
|
|
1138
|
-
path: "/lifecycle-manager/v1/assessments",
|
|
1139
|
-
action: "create",
|
|
1140
|
-
commandPath: ["assessments"],
|
|
1141
|
-
pathParams: [],
|
|
1142
|
-
queryParams: [],
|
|
1143
|
-
hasBody: true,
|
|
1144
|
-
output: "object",
|
|
1145
|
-
summary: "Create Assessment",
|
|
1146
|
-
description: "Create a new assessment based on a assessment template."
|
|
1147
|
-
},
|
|
1148
|
-
{
|
|
1149
|
-
methodName: "updateAssessmentsCompletionStatusById",
|
|
1150
|
-
method: "put",
|
|
1151
|
-
path: "/lifecycle-manager/v1/assessments/{id}/completion-status",
|
|
1152
|
-
action: "update",
|
|
1153
|
-
commandPath: ["assessments","completion-status"],
|
|
1154
|
-
pathParams: ["id"],
|
|
1155
|
-
queryParams: [],
|
|
1156
|
-
hasBody: true,
|
|
1157
|
-
output: "object",
|
|
1158
|
-
summary: "Update Assessment Completion Status",
|
|
1159
|
-
description: "Toggle an assessment's complete status."
|
|
1160
|
-
}
|
|
1161
|
-
];
|