@salesforce/lds-adapters-sales-enablement-program 0.1.0-dev1

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.
Files changed (55) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/sales-enablement-program.js +1693 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  4. package/dist/es/es2018/types/src/generated/adapters/getProgramTemplate.d.ts +28 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getProgramTemplates.d.ts +27 -0
  6. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +2 -0
  7. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +5 -0
  8. package/dist/es/es2018/types/src/generated/resources/deleteConnectEnablementMeasure.d.ts +8 -0
  9. package/dist/es/es2018/types/src/generated/resources/deleteConnectEnablementMeasureByMeasureId.d.ts +11 -0
  10. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementMeasure.d.ts +12 -0
  11. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementMeasureByMeasureId.d.ts +15 -0
  12. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementMeasureCloneActionBySourceMeasureId.d.ts +15 -0
  13. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramByEnablementProgramId.d.ts +15 -0
  14. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramDescribeByEnablementProgramId.d.ts +15 -0
  15. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramSummaryAssigned.d.ts +12 -0
  16. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramSummaryByEnablementProgramId.d.ts +15 -0
  17. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramTemplate.d.ts +15 -0
  18. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramTemplateByProgramTemplateName.d.ts +18 -0
  19. package/dist/es/es2018/types/src/generated/resources/getConnectEnablementProgramsDescribeByEnablementProgramId.d.ts +15 -0
  20. package/dist/es/es2018/types/src/generated/types/AbstractEnablementProgramRepresentation.d.ts +48 -0
  21. package/dist/es/es2018/types/src/generated/types/AbstractEnablementProgramTaskRepresentation.d.ts +98 -0
  22. package/dist/es/es2018/types/src/generated/types/EnablementMeasureFilterInputRepresentation.d.ts +40 -0
  23. package/dist/es/es2018/types/src/generated/types/EnablementMeasureFilterRepresentation.d.ts +40 -0
  24. package/dist/es/es2018/types/src/generated/types/EnablementMeasureIdRepresentation.d.ts +28 -0
  25. package/dist/es/es2018/types/src/generated/types/EnablementMeasureInputRepresentation.d.ts +52 -0
  26. package/dist/es/es2018/types/src/generated/types/EnablementMeasureObjectInputRepresentation.d.ts +49 -0
  27. package/dist/es/es2018/types/src/generated/types/EnablementMeasureObjectRepresentation.d.ts +50 -0
  28. package/dist/es/es2018/types/src/generated/types/EnablementMeasureRepresentation.d.ts +62 -0
  29. package/dist/es/es2018/types/src/generated/types/EnablementMeasureStatusInputRepresentation.d.ts +31 -0
  30. package/dist/es/es2018/types/src/generated/types/EnablementProgramInputRepresentation.d.ts +43 -0
  31. package/dist/es/es2018/types/src/generated/types/EnablementProgramRepresentation.d.ts +55 -0
  32. package/dist/es/es2018/types/src/generated/types/EnablementProgramRuntimeRepresentation.d.ts +63 -0
  33. package/dist/es/es2018/types/src/generated/types/EnablementProgramRuntimeTaskRepresentation.d.ts +106 -0
  34. package/dist/es/es2018/types/src/generated/types/EnablementProgramSectionInputRepresentation.d.ts +43 -0
  35. package/dist/es/es2018/types/src/generated/types/EnablementProgramSectionRepresentation.d.ts +41 -0
  36. package/dist/es/es2018/types/src/generated/types/EnablementProgramStatusRepresentation.d.ts +31 -0
  37. package/dist/es/es2018/types/src/generated/types/EnablementProgramStatusUpdateInputRepresentation.d.ts +31 -0
  38. package/dist/es/es2018/types/src/generated/types/EnablementProgramSummaryItemRepresentation.d.ts +46 -0
  39. package/dist/es/es2018/types/src/generated/types/EnablementProgramSummaryListRepresentation.d.ts +29 -0
  40. package/dist/es/es2018/types/src/generated/types/EnablementProgramSummaryRepresentation.d.ts +51 -0
  41. package/dist/es/es2018/types/src/generated/types/EnablementProgramSummarySectionRepresentation.d.ts +31 -0
  42. package/dist/es/es2018/types/src/generated/types/EnablementProgramSummaryTaskRepresentation.d.ts +63 -0
  43. package/dist/es/es2018/types/src/generated/types/EnablementProgramTaskInputRepresentation.d.ts +80 -0
  44. package/dist/es/es2018/types/src/generated/types/EnablementProgramTaskMeasureInputRepresentation.d.ts +37 -0
  45. package/dist/es/es2018/types/src/generated/types/EnablementProgramTaskMeasureRepresentation.d.ts +34 -0
  46. package/dist/es/es2018/types/src/generated/types/EnablementProgramTaskRepresentation.d.ts +99 -0
  47. package/dist/es/es2018/types/src/generated/types/ProgramTaskWarningRepresentation.d.ts +34 -0
  48. package/dist/es/es2018/types/src/generated/types/ProgramTemplateInfoRepresentation.d.ts +34 -0
  49. package/dist/es/es2018/types/src/generated/types/ProgramTemplateListRepresentation.d.ts +30 -0
  50. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  51. package/package.json +75 -0
  52. package/sfdc/index.d.ts +1 -0
  53. package/sfdc/index.js +1743 -0
  54. package/src/raml/api.raml +1487 -0
  55. package/src/raml/luvio.raml +25 -0
@@ -0,0 +1,1487 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '58.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v66.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ AbstractEnablementProgramRepresentation:
29
+ description: Common Enablement Program representation
30
+ type: object
31
+ properties:
32
+ description:
33
+ description: Description of the enablement program
34
+ type: string
35
+ id:
36
+ description: Id of the enablement program
37
+ type: string
38
+ isOutcomeBased:
39
+ description: True if and only if this enablement program is an outcome based
40
+ one
41
+ type: boolean
42
+ name:
43
+ description: Name of the enablement program
44
+ type: string
45
+ sections:
46
+ description: List of sections for the enablement program
47
+ type: array
48
+ items:
49
+ type: EnablementProgramSectionRepresentation
50
+ status:
51
+ description: Status of the enablement program
52
+ type: string
53
+ enum:
54
+ - Archived
55
+ - Draft
56
+ - Published
57
+ tasks:
58
+ description: List of tasks for the enablement program
59
+ type: array
60
+ items:
61
+ type: AbstractEnablementProgramTaskRepresentation
62
+ AbstractEnablementProgramTaskRepresentation:
63
+ description: Common Enablement Program item representation
64
+ type: object
65
+ properties:
66
+ compositeMilestoneType:
67
+ description: Composite milestone type for the enablement task
68
+ type: string | nil
69
+ enum:
70
+ - Percentage
71
+ - Division
72
+ - Addition
73
+ contentType:
74
+ description: Content type for the enablement task
75
+ type: string | nil # TODO hand rolled. W-11194242
76
+ enum:
77
+ - CmsLink
78
+ - CmsTextLesson
79
+ - CmsVideoLink
80
+ - EnablementRoom
81
+ - Link
82
+ - Measure
83
+ - TrailheadModule
84
+ - TrailheadTextLesson
85
+ - TrailheadVideoLesson
86
+ - VideoLink
87
+ description:
88
+ description: Description of the enablement task
89
+ type: string
90
+ developerName:
91
+ description: DeveloperName of the enablement task
92
+ type: string
93
+ durationCount:
94
+ description: The estimated duration, in minutes, of the task.
95
+ type: integer | nil # TODO hand rolled. W-11194242
96
+ enablementProgramSectionId:
97
+ description: Program Section Id of the enablement task
98
+ type: string | nil # TODO hand rolled. W-11194242
99
+ enablementRoomId:
100
+ description: Enablement Room Id of the enablement task
101
+ type: string | nil # TODO hand rolled. W-11194242
102
+ id:
103
+ description: Id of the enablement task
104
+ type: string | nil # TODO hand rolled. W-11194242
105
+ isMilestoneAnOutcome:
106
+ description: True if and only if this task is an outcome milestone
107
+ type: boolean | nil # TODO hand rolled. W-11194242
108
+ learningItemDescription:
109
+ description: Description of the associated learning item
110
+ type: string | nil # TODO hand rolled. W-11194242
111
+ learningItemIconUrl:
112
+ description: The learning item icon url.
113
+ type: string | nil # TODO hand rolled. W-11194242
114
+ learningItemId:
115
+ description: Learning Item Id of the enablement task
116
+ type: string | nil # TODO hand rolled. W-11194242
117
+ learningItemRelatedContentId:
118
+ description: Related content id for the associated learning item
119
+ type: string | nil # TODO hand rolled. W-11194242
120
+ learningItemTitle:
121
+ description: Title of the associated learning item
122
+ type: string | nil # TODO hand rolled. W-11194242
123
+ learningItemUrl:
124
+ description: Url for the associated learning item
125
+ type: string | nil # TODO hand rolled. W-11194242
126
+ milestoneTarget:
127
+ description: Milestone Target of the enablement task
128
+ format: double
129
+ type: number
130
+ minimumSampleSize:
131
+ description: Minimum Sample Size of the enablement measure with aggregation
132
+ type average
133
+ type: integer | nil # TODO hand rolled. W-11194242
134
+ name:
135
+ description: Name of the enablement task
136
+ type: string
137
+ programDay:
138
+ description: The day the program task is due
139
+ type: integer
140
+ sequenceNumber:
141
+ description: Sequence Number of the enablement task
142
+ type: integer
143
+ taskCategory:
144
+ description: Category Type of the enablement task
145
+ type: string
146
+ enum:
147
+ - Exercise
148
+ - Milestone
149
+ taskMeasures:
150
+ description: Related task measure details for the enablement task
151
+ type: array
152
+ items:
153
+ type: EnablementProgramTaskMeasureRepresentation
154
+ taskSubCategory:
155
+ description: Sub Category Type of the enablement task
156
+ type: string
157
+ enum:
158
+ - AudioRecording
159
+ - Document
160
+ - Other
161
+ - OtherExercise
162
+ - ScheduledEvent
163
+ - TextLesson
164
+ - Trailhead
165
+ - Video
166
+ warnings: # TODO hand rolled. W-11194242
167
+ description: additional property in connect API
168
+ type: any
169
+ EnablementMeasureFilterInputRepresentation:
170
+ description: Enablement Measure Filter Input Representation
171
+ type: object
172
+ properties:
173
+ fieldApiName:
174
+ description: Enablement Measure Filter Field Api Name
175
+ type: string
176
+ fieldValue:
177
+ description: Enablement Measure Filter Field Value
178
+ type: string
179
+ measureFilterId:
180
+ description: Enablement Measure Filter Id
181
+ type: string
182
+ operator:
183
+ description: Enablement Measure Filter Operator Name
184
+ type: string
185
+ enum:
186
+ - Contains
187
+ - DoesNotEqual
188
+ - EndsWith
189
+ - Equals
190
+ - GreaterThan
191
+ - GreaterThanOrEqual
192
+ - In
193
+ - IsNull
194
+ - LessThan
195
+ - LessThanOrEqual
196
+ - NotIn
197
+ - StartsWith
198
+ sequenceNumber:
199
+ description: 'Enablement Measure Filter Sequence Number '
200
+ type: integer
201
+ EnablementMeasureFilterRepresentation:
202
+ description: Enablement Measure Filter Output Representation
203
+ type: object
204
+ properties:
205
+ fieldApiName:
206
+ description: Enablement Measure Filter Field Api Name
207
+ type: string
208
+ fieldValue:
209
+ description: Enablement Measure Filter Field Value
210
+ type: string
211
+ measureFilterId:
212
+ description: Enablement Measure Filter Id
213
+ type: string
214
+ operator:
215
+ description: Enablement Measure Filter Operator Name
216
+ type: string
217
+ enum:
218
+ - Contains
219
+ - DoesNotEqual
220
+ - EndsWith
221
+ - Equals
222
+ - GreaterThan
223
+ - GreaterThanOrEqual
224
+ - In
225
+ - IsNull
226
+ - LessThan
227
+ - LessThanOrEqual
228
+ - NotIn
229
+ - StartsWith
230
+ sequenceNumber:
231
+ description: Enablement Measure Filter Sequence Number
232
+ type: integer
233
+ EnablementMeasureIdRepresentation:
234
+ description: Enablement Measure Id Output Representation
235
+ type: object
236
+ properties:
237
+ enablementMeasureId:
238
+ description: Record Id of Enablement Measure
239
+ type: string
240
+ EnablementMeasureInputRepresentation:
241
+ description: Enablement Measure Input Representation
242
+ type: object
243
+ properties:
244
+ aggregateFieldApiName:
245
+ description: Enablement Measure Aggregate Field Api Name
246
+ type: string
247
+ aggregationFunction:
248
+ description: Enablement Measure Aggregation Function
249
+ type: string
250
+ enum:
251
+ - Average
252
+ - Count
253
+ - Sum
254
+ description:
255
+ description: Enablement Measure Description
256
+ type: string
257
+ displayFieldApiName:
258
+ description: Enablement Measure Display Field Api Name
259
+ type: string
260
+ measureId:
261
+ description: Enablement Measure Id
262
+ type: string
263
+ name:
264
+ description: Enablement Measure Name
265
+ type: string
266
+ sourceMeasureObject:
267
+ description: Source Enablement Measure Object
268
+ type: object
269
+ sourceMeasureObjectName:
270
+ description: Enablement Source Measure Object Name
271
+ type: string
272
+ status:
273
+ description: Enablement Measure Status
274
+ type: string
275
+ enum:
276
+ - Archived
277
+ - Draft
278
+ - Published
279
+ EnablementMeasureObjectInputRepresentation:
280
+ description: Enablement Measure Object Input Representation
281
+ type: object
282
+ properties:
283
+ childIdFieldApiName:
284
+ description: Child Id Field Api Name
285
+ type: string
286
+ childMeasureObjects:
287
+ description: Child Enablement Measure Objects
288
+ type: array
289
+ items:
290
+ type: object
291
+ filterLogic:
292
+ description: Enablement Measure Filter Logic
293
+ type: string
294
+ measureFilters:
295
+ description: Enablement Measure Filters
296
+ type: array
297
+ items:
298
+ type: object
299
+ measureObjectId:
300
+ description: Enablement Measure Object Id
301
+ type: string
302
+ objectApiName:
303
+ description: Enablement Measure Object Api Name
304
+ type: string
305
+ parentIdFieldApiName:
306
+ description: Parent Id Field Api Name
307
+ type: string
308
+ sequenceNumber:
309
+ description: 'Enablement Measure Object Sequence Number '
310
+ type: integer
311
+ EnablementMeasureObjectRepresentation:
312
+ description: Enablement Measure Object Output Representation
313
+ type: object
314
+ properties:
315
+ childIdFieldApiName:
316
+ description: Child Id Field Api Name
317
+ type: string
318
+ childMeasureObjects:
319
+ description: Child Enablement Measure Objects
320
+ type: array
321
+ items:
322
+ type: EnablementMeasureObjectRepresentation
323
+ filterLogic:
324
+ description: Enablement Measure Filter Logic
325
+ type: string
326
+ measureFilters:
327
+ description: Enablement Measure Filters
328
+ type: array
329
+ items:
330
+ type: EnablementMeasureFilterRepresentation
331
+ measureObjectId:
332
+ description: Enablement Measure Object Id
333
+ type: string
334
+ objectApiName:
335
+ description: Enablement Measure Object Api Name
336
+ type: string
337
+ parentIdFieldApiName:
338
+ description: Parent Id Field Api Name
339
+ type: string
340
+ sequenceNumber:
341
+ description: Enablement Measure Object Sequence Number
342
+ type: integer
343
+ EnablementMeasureRepresentation:
344
+ description: Enablement Measure Output Representation
345
+ type: object
346
+ properties:
347
+ aggregateFieldApiName:
348
+ description: Enablement Measure Aggregate Field Api Name
349
+ type: string
350
+ aggregationFunction:
351
+ description: Enablement Measure Aggregation Function
352
+ type: string
353
+ enum:
354
+ - Average
355
+ - Count
356
+ - Sum
357
+ description:
358
+ description: Enablement Measure Description
359
+ type: string
360
+ displayFieldApiName:
361
+ description: Enablement Measure Display Field Api Name
362
+ type: string
363
+ isValid:
364
+ description: Flag to indicate whether or not the measure is valid
365
+ type: boolean
366
+ measureId:
367
+ description: Enablement Measure Id
368
+ type: string
369
+ name:
370
+ description: Enablement Measure Name
371
+ type: string
372
+ sourceMeasureObject:
373
+ description: Source Enablement Measure Object
374
+ type: EnablementMeasureObjectRepresentation
375
+ sourceMeasureObjectName:
376
+ description: Enablement Source Measure Object Name
377
+ type: string
378
+ sourceObjectDateField:
379
+ description: Enablement Measure Source Object Date Field Api Name
380
+ type: string
381
+ sourceObjectUserField:
382
+ description: Enablement Measure Source Object User Field Api Name
383
+ type: string
384
+ status:
385
+ description: Enablement Measure Status
386
+ type: string
387
+ enum:
388
+ - Archived
389
+ - Draft
390
+ - Published
391
+ EnablementMeasureStatusInputRepresentation:
392
+ description: Enablement Measure Status Input Representation
393
+ type: object
394
+ properties:
395
+ measureId:
396
+ description: Enablement Measure Id
397
+ type: string
398
+ measureStatus:
399
+ description: Enablement Measure Status
400
+ type: string
401
+ enum:
402
+ - Archived
403
+ - Draft
404
+ - Published
405
+ EnablementProgramInputRepresentation:
406
+ description: Enablement representation of an enablement program. Contains program
407
+ details.
408
+ type: object
409
+ properties:
410
+ description:
411
+ description: Description of the enablement program
412
+ type: string
413
+ id:
414
+ description: Id of the enablement program
415
+ type: string
416
+ items:
417
+ description: List of items for the enablement program
418
+ type: array
419
+ items:
420
+ type: object
421
+ name:
422
+ description: Name of the enablement program
423
+ type: string
424
+ sections:
425
+ description: List of sections for the enablement program
426
+ type: array
427
+ items:
428
+ type: object
429
+ templateId:
430
+ description: Id of Program template
431
+ type: string
432
+ EnablementProgramRepresentation:
433
+ description: Runtime representation of an enablement program. Contains only program
434
+ details
435
+ type: object
436
+ properties:
437
+ description:
438
+ description: Description of the enablement program
439
+ type: string
440
+ id:
441
+ description: Id of the enablement program
442
+ type: string | nil # TODO hand rolled. W-11194446
443
+ isOutcomeBased:
444
+ description: True if and only if this enablement program is an outcome based
445
+ one
446
+ type: boolean
447
+ name:
448
+ description: Name of the enablement program
449
+ type: string
450
+ sections:
451
+ description: List of sections for the enablement program
452
+ type: array
453
+ items:
454
+ type: EnablementProgramSectionRepresentation
455
+ status:
456
+ description: Status of the enablement program
457
+ type: string
458
+ enum:
459
+ - Archived
460
+ - Draft
461
+ - Published
462
+ tasks:
463
+ description: List of tasks for the enablement program
464
+ type: array
465
+ items:
466
+ type: AbstractEnablementProgramTaskRepresentation
467
+ isTemplate:
468
+ description: True if and only if this enablement program is a template definition
469
+ type: boolean
470
+ systemModStamp:
471
+ description: SystemModStamp of the enablement program
472
+ type: string
473
+ EnablementProgramRuntimeRepresentation:
474
+ description: Runtime representation of an enablement program. Contains program
475
+ details as well as progress for the current user.
476
+ type: object
477
+ properties:
478
+ description:
479
+ description: Description of the enablement program
480
+ type: string
481
+ id:
482
+ description: Id of the enablement program
483
+ type: string
484
+ isOutcomeBased:
485
+ description: True if and only if this enablement program is an outcome based
486
+ one
487
+ type: boolean
488
+ name:
489
+ description: Name of the enablement program
490
+ type: string
491
+ sections:
492
+ description: List of sections for the enablement program
493
+ type: array
494
+ items:
495
+ type: EnablementProgramSectionRepresentation
496
+ status:
497
+ description: Status of the enablement program
498
+ type: string
499
+ enum:
500
+ - Archived
501
+ - Draft
502
+ - Published
503
+ tasks:
504
+ description: List of tasks for the enablement program
505
+ type: array
506
+ items:
507
+ type: AbstractEnablementProgramTaskRepresentation
508
+ completedDate:
509
+ description: Completed date of the enablement program for the current user
510
+ type: string
511
+ completedPercent:
512
+ description: Percent complete of the enablement program for the current user
513
+ format: double
514
+ type: number
515
+ dueDate:
516
+ description: Due date of the enablement program for the current user
517
+ type: string
518
+ isCompleted:
519
+ description: Indicates if the current user has completed the enablement program
520
+ type: boolean
521
+ isOverdue:
522
+ description: Indicates if the current user is overdue on the enablement program
523
+ type: boolean
524
+ EnablementProgramRuntimeTaskRepresentation:
525
+ description: Runtime representation of an enablement program task. Contains task
526
+ details as well as user progress.
527
+ type: object
528
+ properties:
529
+ contentType:
530
+ description: Content type for the enablement task
531
+ type: string
532
+ enum:
533
+ - CmsLink
534
+ - CmsTextLesson
535
+ - CmsVideoLink
536
+ - EnablementRoom
537
+ - Link
538
+ - Measure
539
+ - TrailheadModule
540
+ - TrailheadTextLesson
541
+ - TrailheadVideoLesson
542
+ - VideoLink
543
+ description:
544
+ description: Description of the enablement task
545
+ type: string
546
+ developerName:
547
+ description: DeveloperName of the enablement task
548
+ type: string
549
+ durationCount:
550
+ description: The estimated duration, in minutes, of the task.
551
+ type: integer
552
+ enablementProgramSectionId:
553
+ description: Program Section Id of the enablement task
554
+ type: string
555
+ enablementRoomId:
556
+ description: Enablement Room Id of the enablement task
557
+ type: string
558
+ id:
559
+ description: Id of the enablement task
560
+ type: string
561
+ required: false # TODO hand rolled. W-11194242
562
+ isMilestoneAnOutcome:
563
+ description: True if and only if this task is an outcome milestone
564
+ type: boolean
565
+ learningItemDescription:
566
+ description: Description of the associated learning item
567
+ type: string
568
+ learningItemIconUrl:
569
+ description: The learning item icon url.
570
+ type: string
571
+ learningItemId:
572
+ description: Learning Item Id of the enablement task
573
+ type: string
574
+ learningItemRelatedContentId:
575
+ description: Related content id for the associated learning item
576
+ type: string
577
+ learningItemTitle:
578
+ description: Title of the associated learning item
579
+ type: string
580
+ learningItemUrl:
581
+ description: Url for the associated learning item
582
+ type: string
583
+ milestoneTarget:
584
+ description: Milestone Target of the enablement task
585
+ format: double
586
+ type: number
587
+ minimumSampleSize:
588
+ description: Minimum Sample Size of the enablement measure with aggregation
589
+ type average
590
+ type: integer
591
+ name:
592
+ description: Name of the enablement task
593
+ type: string
594
+ programDay:
595
+ description: The day the program task is due
596
+ type: integer
597
+ sequenceNumber:
598
+ description: Sequence Number of the enablement task
599
+ type: integer
600
+ taskCategory:
601
+ description: Category Type of the enablement task
602
+ type: string
603
+ enum:
604
+ - Exercise
605
+ - Milestone
606
+ taskSubCategory:
607
+ description: Sub Category Type of the enablement task
608
+ type: string
609
+ enum:
610
+ - AudioRecording
611
+ - Document
612
+ - Other
613
+ - OtherExercise
614
+ - ScheduledEvent
615
+ - TextLesson
616
+ - Trailhead
617
+ - Video
618
+ completedDate:
619
+ description: The date the item was completed
620
+ type: string
621
+ completedPercent:
622
+ description: Percent complete for the current user
623
+ format: double
624
+ type: number
625
+ dueDate:
626
+ description: Due date for the current assignment
627
+ type: string
628
+ isCompleted:
629
+ description: Indicates if the item is complete or not
630
+ type: boolean
631
+ isOverdue:
632
+ description: Indicates if the item is overdue or not
633
+ type: boolean
634
+ milestoneResult:
635
+ description: The result value of if the task is of measure type
636
+ format: double
637
+ type: number
638
+ EnablementProgramSectionInputRepresentation:
639
+ description: Builder representation of an enablement program section. Contains
640
+ section details for a enablement Program.
641
+ type: object
642
+ properties:
643
+ description:
644
+ description: Description of the enablement program section
645
+ type: string
646
+ enablementProgram:
647
+ description: Enablement Program for the enablement program section
648
+ type: string
649
+ id:
650
+ description: Id of the enablement program section
651
+ type: string
652
+ items:
653
+ description: List of items for the enablement program section
654
+ type: array
655
+ items:
656
+ type: object
657
+ name:
658
+ description: Name of the enablement program section
659
+ type: string
660
+ sequenceNumber:
661
+ description: Sequence Number of the enablement program section
662
+ type: integer
663
+ EnablementProgramSectionRepresentation:
664
+ description: Runtime representation of an enablement program section.
665
+ type: object
666
+ properties:
667
+ description:
668
+ description: Description of the enablement program section
669
+ type: string | nil # TODO hand rolled. W-11194242
670
+ id:
671
+ description: Id of the enablement program section
672
+ type: string | nil # TODO hand rolled. W-11194242
673
+ name:
674
+ description: Name of the enablement program section
675
+ type: string
676
+ sequenceNumber:
677
+ description: Sequence number of the enablement program section
678
+ type: integer
679
+ tasks:
680
+ description: List of items for the enablement program section
681
+ type: array
682
+ items:
683
+ type: AbstractEnablementProgramTaskRepresentation
684
+ EnablementProgramStatusRepresentation:
685
+ description: Enablement Program Status Output Representation
686
+ type: object
687
+ properties:
688
+ enablementProgramId:
689
+ description: Record Id of Enablement Program
690
+ type: string
691
+ enablementProgramStatus:
692
+ description: Status of the enablement program
693
+ type: string
694
+ enum:
695
+ - Archived
696
+ - Draft
697
+ - Published
698
+ EnablementProgramStatusUpdateInputRepresentation:
699
+ description: Enablement Program Status Input Representation
700
+ type: object
701
+ properties:
702
+ programId:
703
+ description: Enablement Program Id
704
+ type: string
705
+ programStatus:
706
+ description: Enablement Program Status
707
+ type: string
708
+ enum:
709
+ - Archived
710
+ - Draft
711
+ - Published
712
+ EnablementProgramSummaryItemRepresentation:
713
+ description: Common Enablement Program Summary item representation
714
+ discriminator: type
715
+ type: object
716
+ properties:
717
+ description:
718
+ description: Description of the enablement program summary item
719
+ type: string
720
+ id:
721
+ description: Id of the enablement program summary item
722
+ type: string
723
+ sequenceNumber:
724
+ description: Sequence Number of the enablement task
725
+ type: integer
726
+ title:
727
+ description: Title of the enablement program summary item
728
+ type: string
729
+ type:
730
+ description: Type of enablement program summary item
731
+ type: string
732
+ enum:
733
+ - Section
734
+ - Task
735
+ EnablementProgramSummaryListRepresentation:
736
+ description: List of Enablement Program Summary Representations
737
+ type: object
738
+ properties:
739
+ programSummaryList:
740
+ description: List of enablement program summaries
741
+ type: array
742
+ items:
743
+ type: EnablementProgramSummaryRepresentation
744
+ EnablementProgramSummaryRepresentation:
745
+ description: Enablement Program Summary Representation
746
+ type: object
747
+ properties:
748
+ description:
749
+ description: Description of the enablement program
750
+ type: string
751
+ dueDate:
752
+ description: Due date for enablement program.
753
+ type: string
754
+ id:
755
+ description: Id of the enablement program
756
+ type: string
757
+ items:
758
+ description: List of items for the enablement program
759
+ type: array
760
+ items:
761
+ type: EnablementProgramSummaryItemRepresentation
762
+ learningItemId:
763
+ description: Learning Item Id of the enablement program
764
+ type: string
765
+ outcome:
766
+ description: Outcome of the enablement program
767
+ type: EnablementProgramSummaryTaskRepresentation
768
+ status:
769
+ description: Status of the enablement program
770
+ type: string
771
+ enum:
772
+ - Archived
773
+ - Draft
774
+ - Published
775
+ title:
776
+ description: Name of the enablement program
777
+ type: string
778
+ EnablementProgramSummarySectionRepresentation:
779
+ description: Runtime representation of enablement program section.
780
+ discriminatorValue: Section
781
+ type: EnablementProgramSummaryItemRepresentation
782
+ properties:
783
+ tasks:
784
+ description: List of tasks for the enablement program section
785
+ type: array
786
+ items:
787
+ type: EnablementProgramSummaryTaskRepresentation
788
+ EnablementProgramSummaryTaskRepresentation:
789
+ description: Runtime representation of enablement program task.
790
+ discriminatorValue: Task
791
+ type: EnablementProgramSummaryItemRepresentation
792
+ properties:
793
+ completedDate:
794
+ description: The date the item was completed
795
+ type: string
796
+ completedPercent:
797
+ description: Percent complete for the current user
798
+ format: double
799
+ type: number
800
+ dueDate:
801
+ description: Due date for the current assignment
802
+ type: string
803
+ enablementProgramSectionId:
804
+ description: Program Section Id of the enablement task
805
+ type: string
806
+ isCompleted:
807
+ description: Indicates if the item is complete or not
808
+ type: boolean
809
+ isOverdue:
810
+ description: Indicates if the item is overdue or not
811
+ type: boolean
812
+ learningItemId:
813
+ description: Learning Item Id of the enablement task
814
+ type: string
815
+ milestoneResult:
816
+ description: The result value of if the task is of measure type
817
+ format: double
818
+ type: number
819
+ milestoneTarget:
820
+ description: Milestone Target of the enablement task
821
+ format: double
822
+ type: number
823
+ programDay:
824
+ description: The day the program task is due
825
+ type: integer
826
+ taskCategory:
827
+ description: Category Type of the enablement task
828
+ type: string
829
+ enum:
830
+ - Exercise
831
+ - Milestone
832
+ taskSubCategory:
833
+ description: Sub Category Type of the enablement task
834
+ type: string
835
+ enum:
836
+ - AudioRecording
837
+ - Document
838
+ - Other
839
+ - OtherExercise
840
+ - ScheduledEvent
841
+ - TextLesson
842
+ - Trailhead
843
+ - Video
844
+ EnablementProgramTaskInputRepresentation:
845
+ description: Builder representation of an enablement program item. Contains item
846
+ details for a enablement Program.
847
+ type: object
848
+ properties:
849
+ compositeMilestoneType:
850
+ description: Composite milestone type of the enablement task definition
851
+ type: string
852
+ enum:
853
+ - Percentage
854
+ - Division
855
+ - Addition
856
+ day:
857
+ description: Day of the enablement task definition
858
+ type: integer
859
+ description:
860
+ description: Description of the enablement task definition
861
+ type: string
862
+ developerName:
863
+ description: DeveloperName of the enablement task definition
864
+ type: string
865
+ enablementProgram:
866
+ description: Enablement Program of the enablement task definition
867
+ type: string
868
+ enablementProgramSection:
869
+ description: Enablement Program Section of the enablement task definition
870
+ type: string
871
+ enablementRoom:
872
+ description: Enablement Room of the enablement task definition
873
+ type: string
874
+ id:
875
+ description: Id of the enablement task definition
876
+ type: string
877
+ isMilestoneAnOutcome:
878
+ description: Boolean flag to specify if the task is Outcome
879
+ type: boolean
880
+ learningContent:
881
+ description: Learning Content of the enablement task definition
882
+ type: string
883
+ learningItem:
884
+ description: Learning Item of the enablement task definition
885
+ type: string
886
+ milestoneTarget:
887
+ description: Milestone Target of the enablement task definition
888
+ format: double
889
+ type: number
890
+ minimumSampleSize:
891
+ description: Minimum Sample Size of the enablement task definition
892
+ type: integer
893
+ name:
894
+ description: Name of the enablement task definition
895
+ type: string
896
+ sequenceNumber:
897
+ description: Sequence Number of the enablement task definition
898
+ type: integer
899
+ taskCategory:
900
+ description: Task Category of the enablement task definition
901
+ type: string
902
+ enum:
903
+ - Exercise
904
+ - Milestone
905
+ taskMeasures:
906
+ description: Task measure details of the enablement task definition
907
+ type: array
908
+ items:
909
+ type: EnablementProgramTaskMeasureInputRepresentation
910
+ taskSubCategory:
911
+ description: Task SubCategory of the enablement task definition
912
+ type: string
913
+ enum:
914
+ - AudioRecording
915
+ - Document
916
+ - Other
917
+ - OtherExercise
918
+ - ScheduledEvent
919
+ - TextLesson
920
+ - Trailhead
921
+ - Video
922
+ EnablementProgramTaskMeasureInputRepresentation:
923
+ description: Builder representation of an enablement task measure
924
+ type: object
925
+ properties:
926
+ enablementProgramTask:
927
+ description: Enablement Program Task of the enablement Measure
928
+ type: string | nil
929
+ id:
930
+ description: Id of the enablement task measure
931
+ type: string | nil
932
+ measureId:
933
+ description: Measure Id of the enablement task measure
934
+ type: string | nil
935
+ sequenceNumber:
936
+ description: SequenceNumber of enablement task measure
937
+ type: integer | nil
938
+ EnablementProgramTaskRepresentation:
939
+ description: Runtime representation of an enablement program item. Contains item
940
+ details as well as progress for the current user.
941
+ type: object
942
+ properties:
943
+ compositeMilestoneType:
944
+ description: Composite milestone type for the enablement task
945
+ type: string
946
+ enum:
947
+ - Percentage
948
+ - Division
949
+ - Addition
950
+ contentType:
951
+ description: Content type for the enablement task
952
+ type: string
953
+ enum:
954
+ - CmsLink
955
+ - CmsTextLesson
956
+ - CmsVideoLink
957
+ - EnablementRoom
958
+ - Link
959
+ - Measure
960
+ - TrailheadModule
961
+ - TrailheadTextLesson
962
+ - TrailheadVideoLesson
963
+ - VideoLink
964
+ description:
965
+ description: Description of the enablement task
966
+ type: string
967
+ developerName:
968
+ description: DeveloperName of the enablement task
969
+ type: string
970
+ durationCount:
971
+ description: The estimated duration, in minutes, of the task.
972
+ type: integer
973
+ enablementProgramSectionId:
974
+ description: Program Section Id of the enablement task
975
+ type: string
976
+ enablementRoomId:
977
+ description: Enablement Room Id of the enablement task
978
+ type: string
979
+ id:
980
+ description: Id of the enablement task
981
+ type: string
982
+ required: false # TODO hand rolled. W-11194242
983
+ isMilestoneAnOutcome:
984
+ description: True if and only if this task is an outcome milestone
985
+ type: boolean
986
+ learningItemDescription:
987
+ description: Description of the associated learning item
988
+ type: string
989
+ learningItemIconUrl:
990
+ description: The learning item icon url.
991
+ type: string
992
+ learningItemId:
993
+ description: Learning Item Id of the enablement task
994
+ type: string
995
+ learningItemRelatedContentId:
996
+ description: Related content id for the associated learning item
997
+ type: string
998
+ learningItemTitle:
999
+ description: Title of the associated learning item
1000
+ type: string
1001
+ learningItemUrl:
1002
+ description: Url for the associated learning item
1003
+ type: string
1004
+ milestoneTarget:
1005
+ description: Milestone Target of the enablement task
1006
+ format: double
1007
+ type: number
1008
+ minimumSampleSize:
1009
+ description: Minimum Sample Size of the enablement measure with aggregation
1010
+ type average
1011
+ type: integer
1012
+ name:
1013
+ description: Name of the enablement task
1014
+ type: string
1015
+ programDay:
1016
+ description: The day the program task is due
1017
+ type: integer
1018
+ sequenceNumber:
1019
+ description: Sequence Number of the enablement task
1020
+ type: integer
1021
+ taskCategory:
1022
+ description: Category Type of the enablement task
1023
+ type: string
1024
+ enum:
1025
+ - Exercise
1026
+ - Milestone
1027
+ taskSubCategory:
1028
+ description: Sub Category Type of the enablement task
1029
+ type: string
1030
+ enum:
1031
+ - AudioRecording
1032
+ - Document
1033
+ - Other
1034
+ - OtherExercise
1035
+ - ScheduledEvent
1036
+ - TextLesson
1037
+ - Trailhead
1038
+ - Video
1039
+ taskMeasures:
1040
+ description: Related task measure details for the enablement task
1041
+ type: array
1042
+ items:
1043
+ type: EnablementProgramTaskMeasureRepresentation
1044
+ warnings:
1045
+ description: Related Warnings for the enablement task
1046
+ type: array
1047
+ items:
1048
+ type: ProgramTaskWarningRepresentation
1049
+ EnablementProgramTaskMeasureRepresentation:
1050
+ description: Runtime representation of an enablement measure details
1051
+ type: object
1052
+ properties:
1053
+ id:
1054
+ description: Id of the enablement task measure
1055
+ type: string | nil
1056
+ measureId:
1057
+ description: Measure Id of the enablement task measure
1058
+ type: string | nil
1059
+ sequenceNumber:
1060
+ description: Sequence Number of enablement task measure
1061
+ type: integer | nil
1062
+ ProgramTaskWarningRepresentation:
1063
+ description: Program Task Warning Representation
1064
+ type: object
1065
+ properties:
1066
+ message:
1067
+ description: Message of the error
1068
+ type: string
1069
+ warningSource:
1070
+ description: Id or developer name of the enablement task (measure, TH) that
1071
+ failed
1072
+ type: string
1073
+ warningType:
1074
+ description: Warning type for the enablement task
1075
+ type: string
1076
+ enum:
1077
+ - NotFound
1078
+ - NotValid
1079
+ ProgramTemplateInfoRepresentation:
1080
+ description: Enablement Program Template Info Representation
1081
+ type: object
1082
+ properties:
1083
+ developerName:
1084
+ description: 'DeveloperName that uniquely identifies the program template '
1085
+ type: string
1086
+ iconUrl:
1087
+ description: The relative path to the icon to use for the program template
1088
+ type: string
1089
+ label:
1090
+ description: The localized label for this program template
1091
+ type: string
1092
+ ProgramTemplateListRepresentation:
1093
+ description: List of Program Templates
1094
+ type: object
1095
+ properties:
1096
+ programTemplateList:
1097
+ description: List of Program Definition Templates
1098
+ type: array
1099
+ items:
1100
+ type: ProgramTemplateInfoRepresentation
1101
+ /connect/enablement:
1102
+ /measure:
1103
+ delete:
1104
+ description: HTTP DELETE method to delete an existing Enablement Measure
1105
+ responses:
1106
+ '200':
1107
+ description: Success
1108
+ get:
1109
+ description: HTTP GET method to retrieve an existing Enablement Measure
1110
+ responses:
1111
+ '200':
1112
+ description: Success
1113
+ body:
1114
+ application/json:
1115
+ type: EnablementMeasureRepresentation
1116
+ # TODO: Hand rolled
1117
+ # patch:
1118
+ # description: HTTP PATCH method to update existing Enablement Measure's Status
1119
+ # responses:
1120
+ # '200':
1121
+ # description: Success
1122
+ # body:
1123
+ # application/json:
1124
+ # type: EnablementMeasureIdRepresentation
1125
+ # body:
1126
+ # application/json:
1127
+ # type: EnablementMeasureStatusInputRepresentation
1128
+ # #required: false # TODO hand rolled. W-11194242
1129
+ # (oas-body-name): measureStatus
1130
+ # post:
1131
+ # description: HTTP POST method to create a new Enablement Measure
1132
+ # responses:
1133
+ # '200':
1134
+ # description: Success
1135
+ # body:
1136
+ # application/json:
1137
+ # type: EnablementMeasureIdRepresentation
1138
+ # body:
1139
+ # application/json:
1140
+ # type: EnablementMeasureInputRepresentation
1141
+ # #required: false # TODO hand rolled. W-11194242
1142
+ # (oas-body-name): measure
1143
+ # put:
1144
+ # description: HTTP PUT method to update existing Enablement Measure
1145
+ # responses:
1146
+ # '200':
1147
+ # description: Success
1148
+ # body:
1149
+ # application/json:
1150
+ # type: EnablementMeasureIdRepresentation
1151
+ # body:
1152
+ # application/json:
1153
+ # type: EnablementMeasureInputRepresentation
1154
+ # #required: false # TODO hand rolled. W-11194242
1155
+ # (oas-body-name): measure
1156
+ /cloneAction/{sourceMeasureId}:
1157
+ get:
1158
+ description: HTTP GET method to get measure representation for cloning an
1159
+ existing Enablement Measure
1160
+ responses:
1161
+ '200':
1162
+ description: Success
1163
+ body:
1164
+ application/json:
1165
+ type: EnablementMeasureRepresentation
1166
+ uriParameters:
1167
+ sourceMeasureId:
1168
+ type: string
1169
+ required: true
1170
+ /{measureId}:
1171
+ delete:
1172
+ description: HTTP DELETE method to delete an existing Enablement Measure
1173
+ responses:
1174
+ '200':
1175
+ description: Success
1176
+ get:
1177
+ description: HTTP GET method to retrieve an existing Enablement Measure
1178
+ responses:
1179
+ '200':
1180
+ description: Success
1181
+ body:
1182
+ application/json:
1183
+ type: EnablementMeasureRepresentation
1184
+ # TODO: Hand rolled
1185
+ # patch:
1186
+ # description: HTTP PATCH method to update existing Enablement Measure's Status
1187
+ # responses:
1188
+ # '200':
1189
+ # description: Success
1190
+ # body:
1191
+ # application/json:
1192
+ # type: EnablementMeasureIdRepresentation
1193
+ # body:
1194
+ # application/json:
1195
+ # type: EnablementMeasureStatusInputRepresentation
1196
+ # #required: false # TODO hand rolled. W-11194242
1197
+ # (oas-body-name): measureStatus
1198
+ # post:
1199
+ # description: HTTP POST method to create a new Enablement Measure
1200
+ # responses:
1201
+ # '200':
1202
+ # description: Success
1203
+ # body:
1204
+ # application/json:
1205
+ # type: EnablementMeasureIdRepresentation
1206
+ # body:
1207
+ # application/json:
1208
+ # type: EnablementMeasureInputRepresentation
1209
+ # #required: false # TODO hand rolled. W-11194242
1210
+ # (oas-body-name): measure
1211
+ # put:
1212
+ # description: HTTP PUT method to update existing Enablement Measure
1213
+ # responses:
1214
+ # '200':
1215
+ # description: Success
1216
+ # body:
1217
+ # application/json:
1218
+ # type: EnablementMeasureIdRepresentation
1219
+ # body:
1220
+ # application/json:
1221
+ # type: EnablementMeasureInputRepresentation
1222
+ # #required: false # TODO hand rolled. W-11194242
1223
+ # (oas-body-name): measure
1224
+ uriParameters:
1225
+ measureId:
1226
+ type: string
1227
+ required: true
1228
+ /program:
1229
+ # TODO: Hand rolled
1230
+ # patch:
1231
+ # description: Update enablement program and task definition
1232
+ # responses:
1233
+ # '200':
1234
+ # description: Success
1235
+ # body:
1236
+ # application/json:
1237
+ # type: EnablementProgramRepresentation
1238
+ # body:
1239
+ # application/json:
1240
+ # type: EnablementProgramInputRepresentation
1241
+ # #required: false # TODO hand rolled. W-11194242
1242
+ # (oas-body-name): enablementProgram
1243
+ # post:
1244
+ # description: Creates Enablement Program and Enablement Task Definition
1245
+ # responses:
1246
+ # '200':
1247
+ # description: Success
1248
+ # body:
1249
+ # application/json:
1250
+ # type: EnablementProgramRepresentation
1251
+ # body:
1252
+ # application/json:
1253
+ # type: EnablementProgramInputRepresentation
1254
+ # #required: false # TODO hand rolled. W-11194242
1255
+ # (oas-body-name): enablementProgram
1256
+ /status:
1257
+ # TODO: Hand rolled
1258
+ # post:
1259
+ # description: HTTP POST method to update existing Enablement Program's Status
1260
+ # and Creates Learning Item
1261
+ # responses:
1262
+ # '200':
1263
+ # description: Success
1264
+ # body:
1265
+ # application/json:
1266
+ # type: EnablementProgramStatusRepresentation
1267
+ # body:
1268
+ # application/json:
1269
+ # type: EnablementProgramStatusUpdateInputRepresentation
1270
+ # #required: false # TODO hand rolled. W-11194242
1271
+ # (oas-body-name): enablementProgramStatus
1272
+ /status/{enablementProgramId}:
1273
+ # TODO: Hand rolled
1274
+ # post:
1275
+ # description: HTTP POST method to update existing Enablement Program's Status
1276
+ # and Creates Learning Item
1277
+ # responses:
1278
+ # '200':
1279
+ # description: Success
1280
+ # body:
1281
+ # application/json:
1282
+ # type: EnablementProgramStatusRepresentation
1283
+ # body:
1284
+ # application/json:
1285
+ # type: EnablementProgramStatusUpdateInputRepresentation
1286
+ # #required: false # TODO hand rolled. W-11194242
1287
+ # (oas-body-name): enablementProgramStatus
1288
+ uriParameters:
1289
+ enablementProgramId:
1290
+ type: string
1291
+ required: true
1292
+ /summary:
1293
+ /assigned:
1294
+ get:
1295
+ description: Assigned Enablement Program Summary
1296
+ responses:
1297
+ '200':
1298
+ description: Success
1299
+ body:
1300
+ application/json:
1301
+ type: EnablementProgramSummaryListRepresentation
1302
+ /{enablementProgramId}:
1303
+ get:
1304
+ description: Enablement Program Summary
1305
+ responses:
1306
+ '200':
1307
+ description: Success
1308
+ body:
1309
+ application/json:
1310
+ type: EnablementProgramSummaryRepresentation
1311
+ uriParameters:
1312
+ enablementProgramId:
1313
+ type: string
1314
+ required: true
1315
+ /{enablementProgramId}:
1316
+ get:
1317
+ description: Retrieve Enablement Program
1318
+ responses:
1319
+ '200':
1320
+ description: Success
1321
+ body:
1322
+ application/json:
1323
+ type: EnablementProgramRuntimeRepresentation
1324
+ uriParameters:
1325
+ enablementProgramId:
1326
+ type: string
1327
+ required: true
1328
+ /{enablementProgramId}/describe:
1329
+ get:
1330
+ description: Describe Enablement Program
1331
+ responses:
1332
+ '200':
1333
+ description: Success
1334
+ body:
1335
+ application/json:
1336
+ type: EnablementProgramRepresentation
1337
+ uriParameters:
1338
+ enablementProgramId:
1339
+ type: string
1340
+ required: true
1341
+ /programTemplate:
1342
+ get:
1343
+ description: Get Enablement Program Templates
1344
+ responses:
1345
+ '200':
1346
+ description: Success
1347
+ body:
1348
+ application/json:
1349
+ type: ProgramTemplateListRepresentation
1350
+ queryParameters:
1351
+ programType:
1352
+ type: string
1353
+ required: false
1354
+ enum:
1355
+ - EmployeeServiceEnablement
1356
+ - Enablement
1357
+ - PtnrEnablement
1358
+ /programTemplate/{programTemplateName}:
1359
+ get:
1360
+ description: Get Enablement Program Template Details
1361
+ responses:
1362
+ '200':
1363
+ description: Success
1364
+ body:
1365
+ application/json:
1366
+ type: EnablementProgramRepresentation
1367
+ queryParameters:
1368
+ programType:
1369
+ type: string
1370
+ required: false
1371
+ enum:
1372
+ - EmployeeServiceEnablement
1373
+ - Enablement
1374
+ - PtnrEnablement
1375
+ uriParameters:
1376
+ programTemplateName:
1377
+ type: string
1378
+ required: true
1379
+ /programs:
1380
+ # TODO: Hand rolled
1381
+ # patch:
1382
+ # description: Update enablement program and task definition
1383
+ # responses:
1384
+ # '200':
1385
+ # description: Success
1386
+ # body:
1387
+ # application/json:
1388
+ # type: EnablementProgramRepresentation
1389
+ # body:
1390
+ # application/json:
1391
+ # type: EnablementProgramInputRepresentation
1392
+ # #required: false # TODO hand rolled. W-11194242
1393
+ # (oas-body-name): enablementProgram
1394
+ # post:
1395
+ # description: Creates Enablement Program and Enablement Task Definition
1396
+ # responses:
1397
+ # '200':
1398
+ # description: Success
1399
+ # body:
1400
+ # application/json:
1401
+ # type: EnablementProgramRepresentation
1402
+ # body:
1403
+ # application/json:
1404
+ # type: EnablementProgramInputRepresentation
1405
+ # #required: false # TODO hand rolled. W-11194242
1406
+ # (oas-body-name): enablementProgram
1407
+ /status:
1408
+ # TODO: Hand rolled
1409
+ # post:
1410
+ # description: HTTP POST method to update existing Enablement Program's Status
1411
+ # and Creates Learning Item
1412
+ # responses:
1413
+ # '200':
1414
+ # description: Success
1415
+ # body:
1416
+ # application/json:
1417
+ # type: EnablementProgramStatusRepresentation
1418
+ # body:
1419
+ # application/json:
1420
+ # type: EnablementProgramStatusUpdateInputRepresentation
1421
+ # #required: false # TODO hand rolled. W-11194242
1422
+ # (oas-body-name): enablementProgramStatus
1423
+ /status/{enablementProgramId}:
1424
+ # TODO: Hand rolled
1425
+ # post:
1426
+ # description: HTTP POST method to update existing Enablement Program's Status
1427
+ # and Creates Learning Item
1428
+ # responses:
1429
+ # '200':
1430
+ # description: Success
1431
+ # body:
1432
+ # application/json:
1433
+ # type: EnablementProgramStatusRepresentation
1434
+ # body:
1435
+ # application/json:
1436
+ # type: EnablementProgramStatusUpdateInputRepresentation
1437
+ # #required: false # TODO hand rolled. W-11194242
1438
+ # (oas-body-name): enablementProgramStatus
1439
+ uriParameters:
1440
+ enablementProgramId:
1441
+ type: string
1442
+ required: true
1443
+ /{enablementProgramId}:
1444
+ # TODO: Hand rolled
1445
+ # patch:
1446
+ # description: Update enablement program and task definition
1447
+ # responses:
1448
+ # '200':
1449
+ # description: Success
1450
+ # body:
1451
+ # application/json:
1452
+ # type: EnablementProgramRepresentation
1453
+ # body:
1454
+ # application/json:
1455
+ # type: EnablementProgramInputRepresentation
1456
+ # #required: false # TODO hand rolled. W-11194242
1457
+ # (oas-body-name): enablementProgram
1458
+ # post:
1459
+ # description: Creates Enablement Program and Enablement Task Definition
1460
+ # responses:
1461
+ # '200':
1462
+ # description: Success
1463
+ # body:
1464
+ # application/json:
1465
+ # type: EnablementProgramRepresentation
1466
+ # body:
1467
+ # application/json:
1468
+ # type: EnablementProgramInputRepresentation
1469
+ # #required: false # TODO hand rolled. W-11194242
1470
+ # (oas-body-name): enablementProgram
1471
+ uriParameters:
1472
+ enablementProgramId:
1473
+ type: string
1474
+ required: true
1475
+ /{enablementProgramId}/describe:
1476
+ get:
1477
+ description: Describe Enablement Program
1478
+ responses:
1479
+ '200':
1480
+ description: Success
1481
+ body:
1482
+ application/json:
1483
+ type: EnablementProgramRepresentation
1484
+ uriParameters:
1485
+ enablementProgramId:
1486
+ type: string
1487
+ required: true