@salesforce/lds-adapters-industries-public-sector 1.100.2

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 (93) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/industries-public-sector.js +4434 -0
  3. package/dist/types/src/generated/adapters/adapter-utils.d.ts +66 -0
  4. package/dist/types/src/generated/adapters/createBenefitDisbursements.d.ts +15 -0
  5. package/dist/types/src/generated/adapters/createCarePlanTasks.d.ts +16 -0
  6. package/dist/types/src/generated/adapters/getCarePlanBenefitSessionDetails.d.ts +26 -0
  7. package/dist/types/src/generated/adapters/getCarePlanDefinition.d.ts +27 -0
  8. package/dist/types/src/generated/adapters/getCarePlanDetails.d.ts +27 -0
  9. package/dist/types/src/generated/adapters/getCarePlanTasks.d.ts +27 -0
  10. package/dist/types/src/generated/adapters/getCarePlanTemplateDetails.d.ts +27 -0
  11. package/dist/types/src/generated/adapters/postCarePlanDetails.d.ts +15 -0
  12. package/dist/types/src/generated/adapters/postCarePlanTemplateDetails.d.ts +17 -0
  13. package/dist/types/src/generated/adapters/updateCarePlanDetails.d.ts +16 -0
  14. package/dist/types/src/generated/adapters/updateCarePlanTasks.d.ts +16 -0
  15. package/dist/types/src/generated/artifacts/main.d.ts +11 -0
  16. package/dist/types/src/generated/artifacts/sfdc.d.ts +20 -0
  17. package/dist/types/src/generated/resources/getConnectCareplanBenefitSessionInfoByCarePlanId.d.ts +15 -0
  18. package/dist/types/src/generated/resources/getConnectCareplanCarePlansByCarePlanId.d.ts +16 -0
  19. package/dist/types/src/generated/resources/getConnectCareplanCarePlansTasksByCarePlanId.d.ts +18 -0
  20. package/dist/types/src/generated/resources/getConnectCareplanCareplanTemplatesByCarePlanTemplateId.d.ts +16 -0
  21. package/dist/types/src/generated/resources/getConnectCareplanDefinitionsByDefinitionId.d.ts +16 -0
  22. package/dist/types/src/generated/resources/patchConnectCareplanCarePlansByCarePlanId.d.ts +16 -0
  23. package/dist/types/src/generated/resources/patchConnectCareplanCarePlansTasksByCarePlanId.d.ts +16 -0
  24. package/dist/types/src/generated/resources/postConnectBenefitDisbursements.d.ts +13 -0
  25. package/dist/types/src/generated/resources/postConnectCareplanCarePlans.d.ts +13 -0
  26. package/dist/types/src/generated/resources/postConnectCareplanCarePlansTasksByCarePlanId.d.ts +16 -0
  27. package/dist/types/src/generated/resources/postConnectCareplanCareplanTemplatesActionsByActionTypeAndCarePlanTemplateId.d.ts +17 -0
  28. package/dist/types/src/generated/types/ActionPlanTemplateItemRepresentation.d.ts +44 -0
  29. package/dist/types/src/generated/types/ActionPlanTemplateItemsRepresentation.d.ts +30 -0
  30. package/dist/types/src/generated/types/ActionPlanTemplateListRepresentation.d.ts +30 -0
  31. package/dist/types/src/generated/types/ActionPlanTemplateRepresentation.d.ts +36 -0
  32. package/dist/types/src/generated/types/AdhocCarePlanTaskListInputRepresentation.d.ts +30 -0
  33. package/dist/types/src/generated/types/BenefitAssignmentInputRepresentation.d.ts +71 -0
  34. package/dist/types/src/generated/types/BenefitAssignmentListInputRepresentation.d.ts +30 -0
  35. package/dist/types/src/generated/types/BenefitAssignmentListRepresentation.d.ts +30 -0
  36. package/dist/types/src/generated/types/BenefitAssignmentRepresentation.d.ts +80 -0
  37. package/dist/types/src/generated/types/BenefitDisbursementForBenefitSessionInputRepresentation.d.ts +47 -0
  38. package/dist/types/src/generated/types/BenefitDisbursementListInputRepresentation.d.ts +30 -0
  39. package/dist/types/src/generated/types/BenefitDisbursementsForBenefitSessionInputRepresentation.d.ts +33 -0
  40. package/dist/types/src/generated/types/BenefitDisbursementsForBenefitSessionInputRepresentationWrapper.d.ts +29 -0
  41. package/dist/types/src/generated/types/BenefitListRepresentation.d.ts +30 -0
  42. package/dist/types/src/generated/types/BenefitOutputRepresentation.d.ts +57 -0
  43. package/dist/types/src/generated/types/CarePlanBenefitSessionInfoListRepresentation.d.ts +30 -0
  44. package/dist/types/src/generated/types/CarePlanBenefitSessionInfoRepresentation.d.ts +38 -0
  45. package/dist/types/src/generated/types/CarePlanBenefitSessionOutputRepresentation.d.ts +34 -0
  46. package/dist/types/src/generated/types/CarePlanDefinitionOutputRepresentation.d.ts +46 -0
  47. package/dist/types/src/generated/types/CarePlanInputRepresentation.d.ts +69 -0
  48. package/dist/types/src/generated/types/CarePlanInputRepresentationWrapper.d.ts +29 -0
  49. package/dist/types/src/generated/types/CarePlanRepresentation.d.ts +92 -0
  50. package/dist/types/src/generated/types/CarePlanSessionEnrolleeInfoListRepresentation.d.ts +30 -0
  51. package/dist/types/src/generated/types/CarePlanSessionEnrolleeInfoRepresentation.d.ts +44 -0
  52. package/dist/types/src/generated/types/CarePlanTaskInputRepresentation.d.ts +50 -0
  53. package/dist/types/src/generated/types/CarePlanTaskListInputRepresentation.d.ts +30 -0
  54. package/dist/types/src/generated/types/CarePlanTaskListRepresentation.d.ts +30 -0
  55. package/dist/types/src/generated/types/CarePlanTaskRepresentation.d.ts +60 -0
  56. package/dist/types/src/generated/types/CarePlanTasksInputRepresentation.d.ts +37 -0
  57. package/dist/types/src/generated/types/CarePlanTasksMapInputRepresentation.d.ts +34 -0
  58. package/dist/types/src/generated/types/CarePlanTasksMapInputRepresentationWrapper.d.ts +29 -0
  59. package/dist/types/src/generated/types/CarePlanTasksMapRepresentation.d.ts +35 -0
  60. package/dist/types/src/generated/types/CarePlanTasksRepresentation.d.ts +30 -0
  61. package/dist/types/src/generated/types/CarePlanTemplateAssociationsInputRepresentation.d.ts +32 -0
  62. package/dist/types/src/generated/types/CarePlanTemplateAssociationsInputRepresentationWrapper.d.ts +29 -0
  63. package/dist/types/src/generated/types/CarePlanTemplateBenefitInputRepresentation.d.ts +32 -0
  64. package/dist/types/src/generated/types/CarePlanTemplateBenefitListInputRepresentation.d.ts +30 -0
  65. package/dist/types/src/generated/types/CarePlanTemplateBenefitListRepresentation.d.ts +30 -0
  66. package/dist/types/src/generated/types/CarePlanTemplateBenefitRepresentation.d.ts +36 -0
  67. package/dist/types/src/generated/types/CarePlanTemplateGoalInputRepresentation.d.ts +32 -0
  68. package/dist/types/src/generated/types/CarePlanTemplateGoalListInputRepresentation.d.ts +30 -0
  69. package/dist/types/src/generated/types/CarePlanTemplateGoalListRepresentation.d.ts +30 -0
  70. package/dist/types/src/generated/types/CarePlanTemplateGoalRepresentation.d.ts +35 -0
  71. package/dist/types/src/generated/types/CarePlanTemplateRepresentation.d.ts +58 -0
  72. package/dist/types/src/generated/types/CustomFieldInputRepresentation.d.ts +35 -0
  73. package/dist/types/src/generated/types/CustomFieldListInputRepresentation.d.ts +30 -0
  74. package/dist/types/src/generated/types/CustomFieldListRepresentation.d.ts +30 -0
  75. package/dist/types/src/generated/types/CustomFieldRepresentation.d.ts +35 -0
  76. package/dist/types/src/generated/types/ExcludedCarePlanTaskInputRepresentation.d.ts +29 -0
  77. package/dist/types/src/generated/types/GenericOutputRepresentation.d.ts +47 -0
  78. package/dist/types/src/generated/types/GoalAssignmentInputRepresentation.d.ts +71 -0
  79. package/dist/types/src/generated/types/GoalAssignmentListInputRepresentation.d.ts +30 -0
  80. package/dist/types/src/generated/types/GoalAssignmentListRepresentation.d.ts +30 -0
  81. package/dist/types/src/generated/types/GoalAssignmentRepresentation.d.ts +87 -0
  82. package/dist/types/src/generated/types/GoalDefinitionListRepresentation.d.ts +30 -0
  83. package/dist/types/src/generated/types/GoalDefinitionOutputRepresentation.d.ts +53 -0
  84. package/dist/types/src/generated/types/type-utils.d.ts +39 -0
  85. package/dist/types/src/main.d.ts +3 -0
  86. package/dist/types/src/sfdc.d.ts +3 -0
  87. package/dist/umd/es2018/industries-public-sector.js +4454 -0
  88. package/dist/umd/es5/industries-public-sector.js +4506 -0
  89. package/package.json +73 -0
  90. package/sfdc/index.d.ts +1 -0
  91. package/sfdc/index.js +4645 -0
  92. package/src/raml/api.raml +1341 -0
  93. package/src/raml/luvio.raml +123 -0
@@ -0,0 +1,1341 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '56.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v58.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
+ ActionPlanTemplateItemRepresentation:
29
+ description: Representation of Action Plan Tempate Item
30
+ type: object
31
+ properties:
32
+ displayOrder:
33
+ description: isRequired of the Action Plan template Item
34
+ type: integer
35
+ required: false
36
+ id:
37
+ description: ID of the Action Plan template Item
38
+ type: string
39
+ isRequired:
40
+ description: isRequired of the Action Plan template Item
41
+ type: boolean
42
+ required: false
43
+ itemEntityType:
44
+ description: itemEntityType of the Action Plan template Item
45
+ type: string
46
+ name:
47
+ description: Name of the Action Plan template Item
48
+ type: string
49
+ actionPlanTemplateVersion:
50
+ description: actionPlanTemplateVersion of the Action Plan template Item
51
+ type: string
52
+ required: false
53
+ ActionPlanTemplateItemsRepresentation:
54
+ description: Representation for list of Action Plan template Items
55
+ type: object
56
+ properties:
57
+ records:
58
+ description: List of action plan items
59
+ type: array
60
+ items:
61
+ type: ActionPlanTemplateItemRepresentation
62
+ ActionPlanTemplateListRepresentation:
63
+ description: Output Representation for List of Action Plan Templates
64
+ type: object
65
+ properties:
66
+ records:
67
+ description: list of Associated Action Plan Template records
68
+ type: array
69
+ items:
70
+ type: ActionPlanTemplateRepresentation
71
+ ActionPlanTemplateRepresentation:
72
+ description: Output Representation for Action Plan Template Record and it's items
73
+ type: object
74
+ properties:
75
+ actionPlanTemplateItems:
76
+ description: List of Action Plan Template Items
77
+ type: ActionPlanTemplateItemsRepresentation
78
+ required: false # TODO Hand-rolled W-9314597
79
+ id:
80
+ description: Id of Action Plan Template Record
81
+ type: string
82
+ status:
83
+ description: Status of Action Plan Template Record
84
+ type: string
85
+ AdhocCarePlanTaskListInputRepresentation:
86
+ description: Input representation for List of Adhoc Care Plan Tasks
87
+ type: object
88
+ properties:
89
+ records:
90
+ description: List of Adhoc Care Plan Tasks
91
+ type: array
92
+ items:
93
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
94
+ type: CarePlanTaskInputRepresentation
95
+ BenefitAssignmentInputRepresentation:
96
+ description: Input representation for BenefitAssignment
97
+ type: object
98
+ properties:
99
+ benefitAssignmentTasks:
100
+ description: Tasks for Benefit Assignment
101
+ type: CarePlanTaskInputRepresentation
102
+ required: false # TODO Hand-rolled W-9314597
103
+ benefitDisbursements:
104
+ description: Benefit disbursements of the Benefit Assignment
105
+ type: BenefitDisbursementListInputRepresentation
106
+ required: false # TODO Hand-rolled W-9314597
107
+ benefitFrequency:
108
+ description: BenefitFrequency of the BenefitAssignment
109
+ type: string
110
+ required: false # TODO Hand-rolled W-9314597
111
+ benefitId:
112
+ description: Benefit Id of the Benefit
113
+ type: string
114
+ customFields:
115
+ description: CustomFields of the BenefitAssignment
116
+ type: CustomFieldListInputRepresentation
117
+ required: false # TODO Hand-rolled W-9314597
118
+ endDate:
119
+ description: EndDate of the BenefitAssignment
120
+ type: string
121
+ required: false # TODO Hand-rolled W-9314597
122
+ enrollmentCount:
123
+ description: EnrollmentCount of the BenefitAssignment
124
+ type: integer
125
+ required: false # TODO Hand-rolled W-9314597
126
+ entitlementAmount:
127
+ description: EntitlementAmount of the BenefitAssignment
128
+ format: double
129
+ type: number
130
+ required: false # TODO Hand-rolled W-9314597
131
+ id:
132
+ description: Id of the BenefitAssignment
133
+ type: string
134
+ required: false # TODO Hand-rolled W-9314597
135
+ maximumAmount:
136
+ description: MaximumAmount of the BenefitAssignment
137
+ format: double
138
+ type: number
139
+ required: false # TODO Hand-rolled W-9314597
140
+ participantId:
141
+ description: ParticipantId of the BenefitAssignment
142
+ type: string
143
+ payoutFrequency:
144
+ description: PayoutFrequency of the BenefitAssignment
145
+ type: string
146
+ required: false # TODO Hand-rolled W-9314597
147
+ priority:
148
+ description: Priority of the BenefitAssignment
149
+ type: string
150
+ required: false # TODO Hand-rolled W-9314597
151
+ startDate:
152
+ description: StartDate of BenefitAssignment
153
+ type: string
154
+ required: false # TODO Hand-rolled W-9314597
155
+ status:
156
+ description: Status of the BenefitAssignment
157
+ type: string
158
+ required: false # TODO Hand-rolled W-9314597
159
+ BenefitAssignmentListInputRepresentation:
160
+ description: Input representation for List of BenefitAssignments
161
+ type: object
162
+ properties:
163
+ records:
164
+ description: List of BenefitAssignments
165
+ type: array
166
+ items:
167
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
168
+ type: BenefitAssignmentInputRepresentation
169
+ BenefitAssignmentListRepresentation:
170
+ description: List Representation of BenefitAssignment
171
+ type: object
172
+ properties:
173
+ records:
174
+ description: list of BenefitAssignment records
175
+ type: array
176
+ items:
177
+ type: BenefitAssignmentRepresentation
178
+ BenefitAssignmentRepresentation:
179
+ description: Output Representation of BenefitAssignment record
180
+ type: object
181
+ properties:
182
+ benefitAssignmentTasks:
183
+ description: Tasks for Benefit Assignment
184
+ type: CarePlanTasksRepresentation
185
+ required: false
186
+ benefitFrequency:
187
+ description: Frequency by which participant will get this benefit
188
+ type: string
189
+ required: false
190
+ benefitId:
191
+ description: Id of Benefit Record associated with this record
192
+ type: string
193
+ benefitName:
194
+ description: Name of Benefit Record associated with this record
195
+ type: string
196
+ customFields:
197
+ description: List of customFields associated with this BenefitAssignment record
198
+ type: CustomFieldListRepresentation
199
+ required: false
200
+ endDate:
201
+ description: End Date of BenefitAssignment record
202
+ type: string
203
+ required: false
204
+ enrollmentCount:
205
+ description: Enrollment count for this Benefit
206
+ type: integer
207
+ required: false
208
+ entitlementAmount:
209
+ description: Entitlement amount a participant will get from this benefit
210
+ format: double
211
+ type: number
212
+ required: false
213
+ id:
214
+ description: Id of BenefitAssignment record
215
+ type: string
216
+ maximumAmount:
217
+ description: Maximum amount a participant will get from this benefit
218
+ format: double
219
+ type: number
220
+ required: false
221
+ participantId:
222
+ description: Id of participant to whom this BenefitAssignment is assigned
223
+ type: string
224
+ participantName:
225
+ description: Name of participant to whom this BenefitAssignment is assigned
226
+ type: string
227
+ required: false
228
+ payoutFrequency:
229
+ description: Frequency by which participant will get this Payout
230
+ type: string
231
+ required: false
232
+ priority:
233
+ description: Priority of BenefitAssignment record
234
+ type: string
235
+ required: false
236
+ startDate:
237
+ description: Start Date of BenefitAssignment record
238
+ type: string
239
+ required: false
240
+ status:
241
+ description: Status of BenefitAssignment record
242
+ type: string
243
+ required: false
244
+ taskJobStatus:
245
+ description: TaskJobStatus of BenefitAssignment
246
+ type: string
247
+ required: false
248
+ taskJobStatusReason:
249
+ description: TaskJobStatusReason of BenefitAssignment
250
+ type: string
251
+ required: false
252
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
253
+ BenefitDisbursementsForBenefitSessionInputRepresentationWrapper:
254
+ description: Wrapper for BenefitDisbursementsForBenefitSessionInputRepresentation
255
+ type: object
256
+ properties:
257
+ benefitDisbursementRecord:
258
+ type: BenefitDisbursementsForBenefitSessionInputRepresentation
259
+ description: Benefit Disbursements For BenefitSession Input Representation
260
+ BenefitDisbursementForBenefitSessionInputRepresentation:
261
+ description: Input representation for Benefit Disbursement
262
+ type: object
263
+ properties:
264
+ actualCompletionDate:
265
+ description: date at which disbursement happened
266
+ type: string
267
+ benefitCategory:
268
+ description: Category of Benefit
269
+ type: string
270
+ required: false # TODO Hand-rolled W-9314597
271
+ benefitSessionId:
272
+ description: Benefit Session Id
273
+ type: string
274
+ description:
275
+ description: Description for Benefit Disbursement
276
+ type: string
277
+ required: false # TODO Hand-rolled W-9314597
278
+ disbursementStatus:
279
+ description: Benefit Disbursement Status
280
+ type: string
281
+ required: false # TODO Hand-rolled W-9314597
282
+ endDate:
283
+ description: date at which disbursement Ends
284
+ type: string
285
+ required: false # TODO Hand-rolled W-9314597
286
+ startDate:
287
+ description: date at which disbursement Starts
288
+ type: string
289
+ required: false # TODO Hand-rolled W-9314597
290
+ BenefitDisbursementListInputRepresentation:
291
+ description: Input representation for List of BenefitDisbursements
292
+ type: object
293
+ properties:
294
+ records:
295
+ description: List of Benefit Disbursements
296
+ type: array
297
+ items:
298
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
299
+ type: BenefitDisbursementForBenefitSessionInputRepresentation
300
+ BenefitDisbursementsForBenefitSessionInputRepresentation:
301
+ description: API to create Benefit Disbursements
302
+ type: object
303
+ properties:
304
+ benefitAssignmentId:
305
+ description: Benefit Assignment Id
306
+ type: string
307
+ benefitDisbursements:
308
+ description: Benefit Assignment Id
309
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
310
+ type: BenefitDisbursementListInputRepresentation
311
+ BenefitListRepresentation:
312
+ description: List of Records of Benefit
313
+ type: object
314
+ properties:
315
+ records:
316
+ description: List of Records of Benefit
317
+ type: array
318
+ items:
319
+ type: BenefitOutputRepresentation
320
+ BenefitOutputRepresentation:
321
+ description: Output Representation of Benefit
322
+ type: object
323
+ properties:
324
+ associatedActionPlanTemplates:
325
+ description: List of Associated Action Plan Template Records
326
+ type: ActionPlanTemplateListRepresentation
327
+ required: false
328
+ benefitFrequency:
329
+ description: Frequency of the Benefit
330
+ type: string
331
+ required: false
332
+ enrollmentCount:
333
+ description: EnrollmentCount of the Benefit
334
+ type: integer
335
+ required: false
336
+ id:
337
+ description: Id of the Benefit record
338
+ type: string
339
+ isActive:
340
+ description: Boolean value representing whether this benefit record is active
341
+ or not
342
+ type: boolean
343
+ maximumAmount:
344
+ description: Maximum allocated amount for the Benefit
345
+ format: double
346
+ type: number
347
+ required: false
348
+ name:
349
+ description: Name of the Benefit
350
+ type: string
351
+ payoutFrequency:
352
+ description: Frequency of the Payout
353
+ type: string
354
+ required: false
355
+ status:
356
+ description: Status of the Benefit
357
+ type: string
358
+ required: false
359
+ programId:
360
+ description: Associated Program attached to the benefit
361
+ type: string
362
+ required: false
363
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
364
+ CarePlanInputRepresentationWrapper:
365
+ description: Wrapper for CarePlanInputRepresentation
366
+ type: object
367
+ properties:
368
+ carePlanRecord:
369
+ type: CarePlanInputRepresentation
370
+ description: Care Plan Input Representation
371
+ CarePlanBenefitSessionInfoListRepresentation:
372
+ description: Benefit and Session Info List
373
+ type: object
374
+ properties:
375
+ records:
376
+ description: Benefit and Session Info List
377
+ type: array
378
+ required: false
379
+ items:
380
+ type: CarePlanBenefitSessionInfoRepresentation
381
+ CarePlanBenefitSessionInfoRepresentation:
382
+ description: Benefit and Session details
383
+ type: object
384
+ properties:
385
+ assignmentCount:
386
+ description: Enrollee count of the benefit
387
+ type: integer
388
+ required: false
389
+ benefitId:
390
+ description: Id of Benefit record
391
+ type: string
392
+ required: false
393
+ benefitName:
394
+ description: Name of the Benefit
395
+ type: string
396
+ required: false
397
+ sessionEnrolleeInfo:
398
+ description: Associated GoalDefinition Record
399
+ type: CarePlanSessionEnrolleeInfoListRepresentation
400
+ required: false
401
+ CarePlanBenefitSessionOutputRepresentation:
402
+ description: 'CarePlan Benefit and Session information representation '
403
+ type: object
404
+ properties:
405
+ benefitSessionInfo:
406
+ description: Benefit and Session Information list
407
+ type: CarePlanBenefitSessionInfoListRepresentation
408
+ required: false
409
+ carePlanId:
410
+ description: Id of CarePlan
411
+ type: string
412
+ required: false
413
+ CarePlanDefinitionOutputRepresentation:
414
+ description: "CarePlan Definition record and it's related representation items "
415
+ type: object
416
+ properties:
417
+ benefitDefinition:
418
+ description: respective benefit Definition Record
419
+ type: BenefitOutputRepresentation
420
+ required: false
421
+ goalDefinition:
422
+ description: respective goal definition Record
423
+ type: GoalDefinitionOutputRepresentation
424
+ required: false
425
+ id:
426
+ description: Id of CarePan Definition Record
427
+ type: string
428
+ CarePlanInputRepresentation:
429
+ description: Input representation for Care Plan
430
+ type: object
431
+ properties:
432
+ benefitAssignments:
433
+ description: BenefitAssignments of the CarePlan
434
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
435
+ type: BenefitAssignmentListInputRepresentation
436
+ required: false # TODO Hand-rolled W-9314597
437
+ carePlanTasks:
438
+ description: Tasks for a Care Plan
439
+ type: CarePlanTaskInputRepresentation
440
+ required: false # TODO Hand-rolled W-9314597
441
+ carePlanTemplateId:
442
+ description: CarePlanTemplateId of the CarePlan
443
+ type: string
444
+ required: false # TODO Hand-rolled W-9314597
445
+ caseId:
446
+ description: CaseId of the CarePlan
447
+ type: string
448
+ customFields:
449
+ description: CustomFields of the CarePlan
450
+ type: CustomFieldListInputRepresentation
451
+ required: false # TODO Hand-rolled W-9314597
452
+ description:
453
+ description: Description of the CarePlan
454
+ type: string
455
+ required: false # TODO Hand-rolled W-9314597
456
+ endDate:
457
+ description: EndDate of the CarePlan
458
+ type: string
459
+ required: false # TODO Hand-rolled W-9314597
460
+ goalAssignments:
461
+ description: GoalAssignments of the CarePlan
462
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
463
+ type: GoalAssignmentListInputRepresentation
464
+ required: false # TODO Hand-rolled W-9314597
465
+ id:
466
+ description: Id of the CarePlan
467
+ type: string
468
+ required: false # TODO Hand-rolled W-9314597
469
+ medicationTherapyReview:
470
+ description: MedicationTherapyReview of the CarePlan
471
+ type: string
472
+ required: false # TODO Hand-rolled W-9314597
473
+ name:
474
+ description: Name of the CarePlan
475
+ type: string
476
+ participantId:
477
+ description: Participant of the CarePlan
478
+ type: string
479
+ startDate:
480
+ description: StartDate of the CarePlan
481
+ type: string
482
+ required: false # TODO Hand-rolled W-9314597
483
+ status:
484
+ description: Status of the CarePlan
485
+ type: string
486
+ CarePlanRepresentation:
487
+ description: Output Representation of CarePlan and it's related records
488
+ type: object
489
+ properties:
490
+ benefitAssignments:
491
+ description: List of BenefitAssignment associated with this CarePlan record
492
+ type: BenefitAssignmentListRepresentation
493
+ required: false
494
+ carePlanTasks:
495
+ description: List of Tasks associated with CarePlan Record
496
+ type: CarePlanTasksRepresentation
497
+ required: false
498
+ carePlanTemplateId:
499
+ description: Care Plan Template Id for this CarePlan
500
+ type: string
501
+ required: false
502
+ carePlanTemplateName:
503
+ description: Name of Care Plan Template associated with this CarePlan
504
+ type: string
505
+ required: false
506
+ caseId:
507
+ description: Case Record Id for this CarePlan
508
+ type: string
509
+ customFields:
510
+ description: List of customFields associated with this CarePlan record
511
+ type: CustomFieldListRepresentation
512
+ required: false
513
+ description:
514
+ description: Description of CarePlan record
515
+ type: string
516
+ required: false
517
+ endDate:
518
+ description: End Date of CarePlan record
519
+ type: string
520
+ required: false
521
+ goalAssignments:
522
+ description: List of GoalAssignment associated with this CarePlan record
523
+ type: GoalAssignmentListRepresentation
524
+ required: false
525
+ id:
526
+ description: Id of CarePlan record
527
+ type: string
528
+ medicationTherapyReview:
529
+ description: MedicationTherapyReview of CarePlan record
530
+ type: string
531
+ required: false
532
+ name:
533
+ description: Name of CarePlan record
534
+ type: string
535
+ participantId:
536
+ description: ParticipantId of CarePlan record
537
+ type: string
538
+ participantName:
539
+ description: ParticipantName of CarePlan record
540
+ type: string
541
+ required: false
542
+ startDate:
543
+ description: Start Date of CarePlan record
544
+ type: string
545
+ required: false
546
+ status:
547
+ description: Status of CarePlan record
548
+ type: string
549
+ taskJobStatus:
550
+ description: TaskJobStatus of CarePlan record
551
+ type: string
552
+ required: false
553
+ taskJobStatusReason:
554
+ description: TaskJobStatusReason of CarePlan record
555
+ type: string
556
+ required: false
557
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
558
+ CarePlanTemplateAssociationsInputRepresentationWrapper:
559
+ description: Wrapper for CarePlanTemplateAssociationsInputRepresentation
560
+ type: object
561
+ properties:
562
+ carePlanTemplateRecord:
563
+ type: CarePlanTemplateAssociationsInputRepresentation
564
+ description: Care Plan Template Associations Input Representation
565
+ CarePlanSessionEnrolleeInfoListRepresentation:
566
+ description: List of Records of Enrollee Info of a Benefit assignment
567
+ type: object
568
+ properties:
569
+ records:
570
+ description: Session Enrollee info list
571
+ type: array
572
+ required: false
573
+ items:
574
+ type: CarePlanSessionEnrolleeInfoRepresentation
575
+ CarePlanSessionEnrolleeInfoRepresentation:
576
+ description: Benefit and session details of a an enrollee
577
+ type: object
578
+ properties:
579
+ benefitAssignmentId:
580
+ description: Id of Benefit Assignment
581
+ type: string
582
+ required: false
583
+ benefitEndDate:
584
+ description: End date of the Benefit Enrolled
585
+ type: string
586
+ required: false
587
+ benefitStartDate:
588
+ description: Start date of the Benefit Enrolled
589
+ type: string
590
+ required: false
591
+ enrolleeId:
592
+ description: Id of the Benefit Enrollee
593
+ type: string
594
+ enrolleeName:
595
+ description: Name of the Enrollee
596
+ type: string
597
+ sessionsEnrolled:
598
+ description: Sessions enrolled by an Enrollee
599
+ type: integer
600
+ required: false
601
+ CarePlanTaskInputRepresentation:
602
+ description: Input representation for Care Plan Task
603
+ type: object
604
+ properties:
605
+ assignedTo:
606
+ description: Care Plan Task assignee
607
+ type: string
608
+ required: false # TODO Hand-rolled W-9314597
609
+ comment:
610
+ description: Care Plan Task comment
611
+ type: string
612
+ required: false # TODO Hand-rolled W-9314597
613
+ dueDate:
614
+ description: Care Plan Task due date
615
+ type: string
616
+ required: false # TODO Hand-rolled W-9314597
617
+ id:
618
+ description: Id of the Task
619
+ type: string
620
+ required: false # TODO Hand-rolled W-9314597
621
+ priority:
622
+ description: Care Plan Task priority
623
+ type: string
624
+ required: false # TODO Hand-rolled W-9314597
625
+ status:
626
+ description: Care Plan Task Status
627
+ type: string
628
+ required: false # TODO Hand-rolled W-9314597
629
+ subject:
630
+ description: Care Plan Task subject
631
+ type: string
632
+ required: false # TODO Hand-rolled W-9314597
633
+ isRequired:
634
+ description: isRequired field for Task record
635
+ type: boolean
636
+ required: false
637
+ CarePlanTaskListInputRepresentation:
638
+ description: Input representation for List of Care Plan Tasks
639
+ type: object
640
+ properties:
641
+ records:
642
+ description: List of Care Plan Tasks
643
+ type: array
644
+ items:
645
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
646
+ type: CarePlanTaskInputRepresentation
647
+ CarePlanTaskListRepresentation:
648
+ description: Output Representation for List of Care Plan Tasks
649
+ type: object
650
+ properties:
651
+ records:
652
+ description: List of Care Plan Tasks
653
+ type: array
654
+ required: false
655
+ items:
656
+ type: CarePlanTaskRepresentation
657
+ CarePlanTaskRepresentation:
658
+ description: Output Representation for Care Plan Task
659
+ type: object
660
+ properties:
661
+ assignedTo:
662
+ description: Care Plan Task Assignee
663
+ type: string
664
+ required: false
665
+ comment:
666
+ description: Care Plan Task comment
667
+ type: string
668
+ required: false
669
+ dueDate:
670
+ description: Care Plan Task due date
671
+ type: string
672
+ required: false
673
+ id:
674
+ description: Id of Task record
675
+ type: string
676
+ priority:
677
+ description: Care Plan Task priority
678
+ type: string
679
+ required: false
680
+ relatedTo:
681
+ description: Care Plan Task related to
682
+ type: string
683
+ required: false
684
+ status:
685
+ description: Care Plan Task status
686
+ type: string
687
+ required: false
688
+ subject:
689
+ description: Care Plan Task subject
690
+ type: string
691
+ required: false
692
+ dependentTasks:
693
+ description: Dependent tasks list
694
+ type: CarePlanTaskListRepresentation
695
+ required: false
696
+ displayOrder:
697
+ description: Dependent tasks display order
698
+ type: integer
699
+ required: false
700
+ isRequired:
701
+ description: isRequired field for Task record
702
+ type: boolean
703
+ required: false
704
+ CarePlanTasksInputRepresentation:
705
+ description: Input representation for Care Plan Tasks
706
+ type: object
707
+ properties:
708
+ adhocTasks:
709
+ description: Adhoc Tasks for a Care Plan
710
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
711
+ type: AdhocCarePlanTaskListInputRepresentation
712
+ excludedTasks:
713
+ description: Excluded Tasks for a Care Plan
714
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
715
+ type: ExcludedCarePlanTaskInputRepresentation
716
+ tasks:
717
+ description: Care Plan Tasks
718
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
719
+ type: CarePlanTaskListInputRepresentation
720
+ CarePlanTasksMapInputRepresentationWrapper:
721
+ description: Input representation for Care Plan Tasks Map
722
+ type: object
723
+ properties:
724
+ carePlanRecord:
725
+ description: Care Plan Tasks Map
726
+ type: CarePlanTasksMapInputRepresentation
727
+ CarePlanTasksMapInputRepresentation:
728
+ description: Input representation for Care Plan Tasks Map
729
+ type: object
730
+ properties:
731
+ parentEntityTasks:
732
+ description: Care Plan Tasks Map
733
+ type: object
734
+ properties:
735
+ //:
736
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
737
+ type: CarePlanTasksInputRepresentation
738
+ CarePlanTasksMapRepresentation:
739
+ description: Output Representation for Care Plan Tasks Map
740
+ type: object
741
+ properties:
742
+ parentEntityTasks:
743
+ description: Care Plan Tasks Map
744
+ type: object
745
+ properties:
746
+ //:
747
+ type: CarePlanTasksRepresentation
748
+ CarePlanTasksRepresentation:
749
+ description: Output Representation for Care Plan Tasks
750
+ type: object
751
+ properties:
752
+ tasks:
753
+ description: Care Plan Tasks
754
+ type: CarePlanTaskListRepresentation
755
+ CarePlanTemplateAssociationsInputRepresentation:
756
+ description: Input Representation for associating Care Plan Template benefit and
757
+ Care Plan Template Goal records to Care Plan Template
758
+ type: object
759
+ properties:
760
+ carePlanTemplateBenefits:
761
+ description: Object containing list of Benefits to be added to Care Plan template
762
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
763
+ type: CarePlanTemplateBenefitListInputRepresentation
764
+ required: false # TODO Hand-rolled W-9314597
765
+ carePlanTemplateGoals:
766
+ description: Object containing list of Goals to be added to Care Plan Template
767
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
768
+ type: CarePlanTemplateGoalListInputRepresentation
769
+ required: false # TODO Hand-rolled W-9314597
770
+ CarePlanTemplateBenefitInputRepresentation:
771
+ description: Input Representation for Care Plan Template Benefit Object
772
+ type: object
773
+ properties:
774
+ benefitId:
775
+ description: Benefit ID
776
+ type: string
777
+ priority:
778
+ description: Priority of the Benefit
779
+ type: string
780
+ required: false # TODO Hand-rolled W-9314597
781
+ CarePlanTemplateBenefitListInputRepresentation:
782
+ description: Input Representation for list of Care Plan Template benefit records
783
+ type: object
784
+ properties:
785
+ records:
786
+ description: List of Goals to be added to Care Plan Template
787
+ type: array
788
+ items:
789
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
790
+ type: CarePlanTemplateBenefitInputRepresentation
791
+ CarePlanTemplateBenefitListRepresentation:
792
+ description: List of Records of CarePlanTemplateBenefit
793
+ type: object
794
+ properties:
795
+ records:
796
+ description: List of Records of CarePlanTemplateBenefit
797
+ type: array
798
+ items:
799
+ type: CarePlanTemplateBenefitRepresentation
800
+ CarePlanTemplateBenefitRepresentation:
801
+ description: Record Representation of CarePlanTemplateBenefit
802
+ type: object
803
+ properties:
804
+ associatedBenefit:
805
+ description: Associated Benefit record CarePlanTemplateBenefit
806
+ type: BenefitOutputRepresentation
807
+ id:
808
+ description: Id of CarePlanTemplateBenefit Record
809
+ type: string
810
+ priority:
811
+ description: Priority of CarePlanTemplateBenefit Record
812
+ type: string
813
+ required: false
814
+ CarePlanTemplateGoalInputRepresentation:
815
+ description: Input Representation for Care Plan Template Goal Object
816
+ type: object
817
+ properties:
818
+ goalDefinitionId:
819
+ description: Goal Definition ID
820
+ type: string
821
+ priority:
822
+ description: Priority of the Goal
823
+ type: string
824
+ required: false # TODO Hand-rolled W-9314597
825
+ CarePlanTemplateGoalListInputRepresentation:
826
+ description: Input Representation for list of Care Plan Template benefit records
827
+ type: object
828
+ properties:
829
+ records:
830
+ description: List of Benefits to be added to Care Plan template
831
+ type: array
832
+ items:
833
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
834
+ type: CarePlanTemplateGoalInputRepresentation
835
+ CarePlanTemplateGoalListRepresentation:
836
+ description: List of Records of CarePlanTemplateGoal
837
+ type: object
838
+ properties:
839
+ records:
840
+ description: List of Records of CarePlanTemplateGoal
841
+ type: array
842
+ items:
843
+ type: CarePlanTemplateGoalRepresentation
844
+ CarePlanTemplateGoalRepresentation:
845
+ description: Record Representation of CarePlanTemplateGoal
846
+ type: object
847
+ properties:
848
+ associatedGoalDefinition:
849
+ description: Associated GoalDefinition Record
850
+ type: GoalDefinitionOutputRepresentation
851
+ id:
852
+ description: Id of CarePlanTemplateGoal Record
853
+ type: string
854
+ priority:
855
+ description: Priority of CarePlanTemplateGoal Record
856
+ type: string
857
+ required: false
858
+ CarePlanTemplateRepresentation:
859
+ description: CarePlanTemplate record and it's related CarePlanTemplateGoals and
860
+ CarePlanTemplateBenefits
861
+ type: object
862
+ properties:
863
+ associatedActionPlanTemplates:
864
+ description: List of Associated Action Plan Template Records
865
+ type: ActionPlanTemplateListRepresentation
866
+ required: false
867
+ carePlanTemplateBenefits:
868
+ description: List of Associated CarePlanTemplateBenefit Records
869
+ type: CarePlanTemplateBenefitListRepresentation
870
+ required: false
871
+ carePlanTemplateGoals:
872
+ description: List of Associated CarePlanTemplateGoal Records
873
+ type: CarePlanTemplateGoalListRepresentation
874
+ required: false
875
+ id:
876
+ description: Id of CarePanTemplate Record
877
+ type: string
878
+ name:
879
+ description: Name of CarePanTemplate Record
880
+ type: string
881
+ status:
882
+ description: Status of CarePanTemplate Record
883
+ type: string
884
+ CustomFieldInputRepresentation:
885
+ description: Input representation for Custom Field
886
+ type: object
887
+ properties:
888
+ dataType:
889
+ description: Data Type of custom field
890
+ type: string
891
+ required: false # TODO Hand-rolled W-9314597
892
+ enum:
893
+ - Boolean
894
+ - DateOnly
895
+ - DateTime
896
+ - MultiEnum
897
+ - Number
898
+ - String
899
+ - TimeOnly
900
+ fieldName:
901
+ description: Field Name of custom field
902
+ type: string
903
+ fieldValue:
904
+ description: Field Value of custom field
905
+ type: any
906
+ CustomFieldListInputRepresentation:
907
+ description: Input representation for List of CustomFields
908
+ type: object
909
+ properties:
910
+ records:
911
+ description: List of CustomFields
912
+ type: array
913
+ items:
914
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
915
+ type: CustomFieldInputRepresentation
916
+ CustomFieldListRepresentation:
917
+ description: Output Representation of custom field
918
+ type: object
919
+ properties:
920
+ records:
921
+ description: list of Custom Fields
922
+ type: array
923
+ items:
924
+ type: CustomFieldRepresentation
925
+ CustomFieldRepresentation:
926
+ description: Output Representation of CustomField
927
+ type: object
928
+ properties:
929
+ dataType:
930
+ description: DataType of Custom Field
931
+ type: string
932
+ required: false
933
+ fieldName:
934
+ description: Name of Custom Field
935
+ type: string
936
+ fieldValue:
937
+ description: Value of Custom Field
938
+ type: any
939
+ ExcludedCarePlanTaskInputRepresentation:
940
+ description: Input representation for Excluded Care Plan Tasks
941
+ type: object
942
+ properties:
943
+ tasks:
944
+ description: Excluded Sfdc Tasks for a Care Plan
945
+ type: array
946
+ items:
947
+ type: string
948
+ GenericOutputRepresentation:
949
+ description: Generic Output Representation
950
+ type: object
951
+ properties:
952
+ code:
953
+ description: API code
954
+ type: string
955
+ required: false
956
+ id:
957
+ description: id
958
+ type: string
959
+ isSuccess:
960
+ description: API success status
961
+ type: boolean
962
+ required: false
963
+ message:
964
+ description: API message
965
+ type: string
966
+ required: false
967
+ GoalAssignmentInputRepresentation:
968
+ description: Input representation for GoalAssignment
969
+ type: object
970
+ properties:
971
+ completionDate:
972
+ description: CompletionDate of the GoalAssignment
973
+ type: string
974
+ required: false # TODO Hand-rolled W-9314597
975
+ completionPercentage:
976
+ description: CompletionPercentage of the GoalAssignment
977
+ format: double
978
+ type: number
979
+ required: false # TODO Hand-rolled W-9314597
980
+ customFields:
981
+ description: CustomFields of the GoalAssignment
982
+ type: CustomFieldListInputRepresentation
983
+ required: false # TODO Hand-rolled W-9314597
984
+ description:
985
+ description: Description of the Goal Assignment
986
+ type: string
987
+ required: false # TODO Hand-rolled W-9314597
988
+ goalAssigneeId:
989
+ description: GoalAssigneeId of the GoalAssignment
990
+ type: string
991
+ required: false # TODO Hand-rolled W-9314597
992
+ goalAssignmentTasks:
993
+ description: Tasks for Goal Assignment
994
+ type: CarePlanTaskInputRepresentation
995
+ required: false # TODO Hand-rolled W-9314597
996
+ goalDefinitionId:
997
+ description: GoalDefinitionId of the GoalAssignment
998
+ type: string
999
+ id:
1000
+ description: Id of the GoalAssignment
1001
+ type: string
1002
+ required: false # TODO Hand-rolled W-9314597
1003
+ priority:
1004
+ description: Priority of the GoalAssignment
1005
+ type: string
1006
+ required: false # TODO Hand-rolled W-9314597
1007
+ startDate:
1008
+ description: StartDate of the GoalAssignment
1009
+ type: string
1010
+ required: false # TODO Hand-rolled W-9314597
1011
+ status:
1012
+ description: Status of the GoalAssignment
1013
+ type: string
1014
+ required: false # TODO Hand-rolled W-9314597
1015
+ targetCompletionDate:
1016
+ description: TargetCompletionDate of the GoalAssignment
1017
+ type: string
1018
+ required: false # TODO Hand-rolled W-9314597
1019
+ associatedBenefitAssignments:
1020
+ description: Associated SubBenefit Assignments
1021
+ type: BenefitAssignmentListInputRepresentation
1022
+ required: false
1023
+ associatedSubGoalAssignments:
1024
+ description: Associated Sub Goal Assignments
1025
+ type: GoalAssignmentListInputRepresentation
1026
+ required: false
1027
+ GoalAssignmentListInputRepresentation:
1028
+ description: Input representation for List of GoalAssignment
1029
+ type: object
1030
+ properties:
1031
+ records:
1032
+ description: List of GoalAssignments
1033
+ type: array
1034
+ items:
1035
+ # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1036
+ type: GoalAssignmentInputRepresentation
1037
+ GoalAssignmentListRepresentation:
1038
+ description: List Representation of GoalAssignment
1039
+ type: object
1040
+ properties:
1041
+ records:
1042
+ description: list of GoalAssignment records
1043
+ type: array
1044
+ items:
1045
+ type: GoalAssignmentRepresentation
1046
+ GoalAssignmentRepresentation:
1047
+ description: Output Representation of GoalAssignment
1048
+ type: object
1049
+ properties:
1050
+ completionDate:
1051
+ description: Completion Date of GoalAssignment record
1052
+ type: string
1053
+ required: false
1054
+ completionPercentage:
1055
+ description: Completion Percentage of GoalAssignment record
1056
+ format: double
1057
+ type: number
1058
+ required: false
1059
+ customFields:
1060
+ description: List of customFields associated with this GoalAssignment record
1061
+ type: CustomFieldListRepresentation
1062
+ required: false
1063
+ description:
1064
+ description: description of a Goal Assignment
1065
+ type: string
1066
+ required: false
1067
+ goalAssigneeId:
1068
+ description: Id of Goal Assignee of this GoalAssignment record
1069
+ type: string
1070
+ required: false
1071
+ goalAssigneeName:
1072
+ description: Name of Goal Assignee of this GoalAssignment record
1073
+ type: string
1074
+ required: false
1075
+ goalAssignmentTasks:
1076
+ description: Task records for Goal Assignment
1077
+ type: CarePlanTasksRepresentation
1078
+ required: false # TODO Hand-rolled W-9314597
1079
+ goalDefinitionId:
1080
+ description: GoalDefinition Id for this GoalAssignment
1081
+ type: string
1082
+ goalDefinitionName:
1083
+ description: Name of Associated GoalDefinition with this record
1084
+ type: string
1085
+ goalType:
1086
+ description: Goal type of this record
1087
+ type: string
1088
+ required: false
1089
+ id:
1090
+ description: Id of GoalAssignment record
1091
+ type: string
1092
+ priority:
1093
+ description: Priority of GoalAssignment
1094
+ type: string
1095
+ required: false
1096
+ startDate:
1097
+ description: Start Date of GoalAssignment record
1098
+ type: string
1099
+ required: false
1100
+ status:
1101
+ description: Status of GoalAssignment record
1102
+ type: string
1103
+ required: false
1104
+ targetCompletionDate:
1105
+ description: Target Completion Date of GoalAssignment record
1106
+ type: string
1107
+ required: false
1108
+ taskJobStatus:
1109
+ description: TaskJobStatus of GoalAssignment
1110
+ type: string
1111
+ required: false
1112
+ taskJobStatusReason:
1113
+ description: TaskJobStatusReason of GoalAssignment
1114
+ type: string
1115
+ required: false
1116
+ associatedBenefitAssignments:
1117
+ description: Associated benefit assignments for Goal Assignment
1118
+ type: BenefitAssignmentListRepresentation
1119
+ required: false
1120
+ associatedSubGoalAssignments:
1121
+ description: Associated sub goals for Goal Assignment
1122
+ type: GoalAssignmentListRepresentation
1123
+ required: false
1124
+ GoalDefinitionListRepresentation:
1125
+ description: List of Records of GoalDefinition
1126
+ type: object
1127
+ properties:
1128
+ records:
1129
+ description: List of Records of GoalDefinition
1130
+ type: array
1131
+ items:
1132
+ type: GoalDefinitionOutputRepresentation
1133
+ GoalDefinitionOutputRepresentation:
1134
+ description: Output Representation of Goal Definition
1135
+ type: object
1136
+ properties:
1137
+ associatedActionPlanTemplates:
1138
+ description: List of Associated Action Plan Template Records
1139
+ type: ActionPlanTemplateListRepresentation
1140
+ required: false
1141
+ id:
1142
+ description: Record Id of goal Definition
1143
+ type: string
1144
+ name:
1145
+ description: Name of Goal Definition
1146
+ type: string
1147
+ status:
1148
+ description: Status of Goal Definition
1149
+ type: string
1150
+ required: false
1151
+ type:
1152
+ description: Type of Goal Definition
1153
+ type: string
1154
+ required: false
1155
+ associatedBenefits:
1156
+ description: List of Associated Action Plan Template Records
1157
+ type: BenefitListRepresentation
1158
+ required: false
1159
+ associatedSubGoals:
1160
+ description: List of Associated Action Plan Template Records
1161
+ type: GoalDefinitionListRepresentation
1162
+ required: false
1163
+ usageType:
1164
+ description: Usage Type of Goal Definition
1165
+ type: string
1166
+ required: false
1167
+ /connect:
1168
+ /benefit-disbursements:
1169
+ post:
1170
+ description: API to create BenefitDisbursement
1171
+ responses:
1172
+ '200':
1173
+ description: Success
1174
+ body:
1175
+ application/json:
1176
+ type: GenericOutputRepresentation
1177
+ body:
1178
+ application/json:
1179
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1180
+ type: BenefitDisbursementsForBenefitSessionInputRepresentationWrapper
1181
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1182
+ #required: false
1183
+ (oas-body-name): benefitDisbursementRecord
1184
+ /careplan:
1185
+ /benefit-session-info/{carePlanId}:
1186
+ get:
1187
+ description: API to fetch data of CarePlanBenefitSessions
1188
+ responses:
1189
+ '200':
1190
+ description: Success
1191
+ body:
1192
+ application/json:
1193
+ type: CarePlanBenefitSessionOutputRepresentation
1194
+ uriParameters:
1195
+ carePlanId:
1196
+ type: string
1197
+ required: true
1198
+ /care-plans:
1199
+ post:
1200
+ description: API to create/update Care Plan
1201
+ responses:
1202
+ '200':
1203
+ description: Success
1204
+ body:
1205
+ application/json:
1206
+ type: GenericOutputRepresentation
1207
+ body:
1208
+ application/json:
1209
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1210
+ type: CarePlanInputRepresentationWrapper
1211
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1212
+ # required: false
1213
+ (oas-body-name): carePlanRecord
1214
+ /care-plans/{carePlanId}:
1215
+ get:
1216
+ description: API to fetch data of CarePlan and it's related record
1217
+ responses:
1218
+ '200':
1219
+ description: Success
1220
+ body:
1221
+ application/json:
1222
+ type: CarePlanRepresentation
1223
+ patch:
1224
+ description: API to update data of CarePlan and it's related record
1225
+ responses:
1226
+ '200':
1227
+ description: Success
1228
+ body:
1229
+ application/json:
1230
+ type: GenericOutputRepresentation
1231
+ body:
1232
+ application/json:
1233
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1234
+ type: CarePlanInputRepresentationWrapper
1235
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1236
+ # required: false
1237
+ (oas-body-name): carePlanRecord
1238
+ uriParameters:
1239
+ carePlanId:
1240
+ type: string
1241
+ required: true
1242
+ /care-plans/{carePlanId}/tasks:
1243
+ get:
1244
+ description: API to fetch Tasks for a Care Plan
1245
+ responses:
1246
+ '200':
1247
+ description: Success
1248
+ body:
1249
+ application/json:
1250
+ type: CarePlanTasksMapRepresentation
1251
+ queryParameters:
1252
+ pageOffset:
1253
+ description: Offset for the current page default value is 0
1254
+ type: integer
1255
+ required: false
1256
+ default: 0
1257
+ patch:
1258
+ description: API to update task for a care plan
1259
+ responses:
1260
+ '200':
1261
+ description: Success
1262
+ body:
1263
+ application/json:
1264
+ type: GenericOutputRepresentation
1265
+ body:
1266
+ application/json:
1267
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1268
+ type: CarePlanTasksMapInputRepresentationWrapper
1269
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1270
+ # required: false
1271
+ (oas-body-name): carePlanRecord
1272
+ post:
1273
+ description: API to create task for a care plan
1274
+ responses:
1275
+ '200':
1276
+ description: Success
1277
+ body:
1278
+ application/json:
1279
+ type: GenericOutputRepresentation
1280
+ body:
1281
+ application/json:
1282
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1283
+ type: CarePlanTasksMapInputRepresentationWrapper
1284
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1285
+ # required: false
1286
+ (oas-body-name): carePlanRecord
1287
+ uriParameters:
1288
+ carePlanId:
1289
+ type: string
1290
+ required: true
1291
+ /careplan-templates/{carePlanTemplateId}:
1292
+ get:
1293
+ description: API to fetch data of CarePlanTemplateId and it's related record
1294
+ responses:
1295
+ '200':
1296
+ description: Success
1297
+ body:
1298
+ application/json:
1299
+ type: CarePlanTemplateRepresentation
1300
+ uriParameters:
1301
+ carePlanTemplateId:
1302
+ type: string
1303
+ required: true
1304
+ /careplan-templates/{carePlanTemplateId}/actions/{actionType}:
1305
+ post:
1306
+ description: Create Care Plan Template Benefit and Care Plan Template Goal records
1307
+ for specified Care Plan Template ID
1308
+ responses:
1309
+ '200':
1310
+ description: Success
1311
+ body:
1312
+ application/json:
1313
+ type: GenericOutputRepresentation
1314
+ body:
1315
+ application/json:
1316
+ # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
1317
+ type: CarePlanTemplateAssociationsInputRepresentationWrapper
1318
+ # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
1319
+ # required: false
1320
+ (oas-body-name): carePlanTemplateRecord
1321
+ uriParameters:
1322
+ actionType:
1323
+ type: string
1324
+ required: true
1325
+ carePlanTemplateId:
1326
+ type: string
1327
+ required: true
1328
+ /definitions/{definitionId}:
1329
+ get:
1330
+ description: API to fetch definition data of careplan design time entites and
1331
+ it's related taskdefinitions
1332
+ responses:
1333
+ '200':
1334
+ description: Success
1335
+ body:
1336
+ application/json:
1337
+ type: CarePlanDefinitionOutputRepresentation
1338
+ uriParameters:
1339
+ definitionId:
1340
+ type: string
1341
+ required: true