@salesforce/lds-adapters-industries-actionablelist 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 (75) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/industries-actionablelist.js +5762 -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/createActionableListDefinition.d.ts +16 -0
  5. package/dist/es/es2018/types/src/generated/adapters/createBulkActionPlans.d.ts +25 -0
  6. package/dist/es/es2018/types/src/generated/adapters/deleteFilterTemplate.d.ts +14 -0
  7. package/dist/es/es2018/types/src/generated/adapters/getActionableListDatasetInfo.d.ts +28 -0
  8. package/dist/es/es2018/types/src/generated/adapters/getActionableListDefinitions.d.ts +30 -0
  9. package/dist/es/es2018/types/src/generated/adapters/getActionableListMembers.d.ts +27 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getDatasetColumnValues.d.ts +28 -0
  11. package/dist/es/es2018/types/src/generated/adapters/getFilterTemplate.d.ts +28 -0
  12. package/dist/es/es2018/types/src/generated/adapters/getFilterTemplatesForListDefinition.d.ts +27 -0
  13. package/dist/es/es2018/types/src/generated/adapters/upsertActionableList.d.ts +16 -0
  14. package/dist/es/es2018/types/src/generated/adapters/upsertActionableListDatasetColumnUser.d.ts +16 -0
  15. package/dist/es/es2018/types/src/generated/adapters/upsertActionableListFilterTemplate.d.ts +23 -0
  16. package/dist/es/es2018/types/src/generated/adapters/upsertActionableListRefreshFilter.d.ts +16 -0
  17. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +13 -0
  18. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +21 -0
  19. package/dist/es/es2018/types/src/generated/resources/deleteConnectActionableListDefFilterByActionableListDefinitionFilterId.d.ts +12 -0
  20. package/dist/es/es2018/types/src/generated/resources/getConnectActionableListDefFilterByActionableListDefinitionFilterId.d.ts +16 -0
  21. package/dist/es/es2018/types/src/generated/resources/getConnectActionableListDefinition.d.ts +18 -0
  22. package/dist/es/es2018/types/src/generated/resources/getConnectActionableListDefinitionColumnValuesByAldcId.d.ts +18 -0
  23. package/dist/es/es2018/types/src/generated/resources/getConnectActionableListMembersById.d.ts +15 -0
  24. package/dist/es/es2018/types/src/generated/resources/getConnectGetActionableListDefFilters.d.ts +15 -0
  25. package/dist/es/es2018/types/src/generated/resources/postConnectActionableList.d.ts +13 -0
  26. package/dist/es/es2018/types/src/generated/resources/postConnectActionableListDatasetColumnUserAssignment.d.ts +13 -0
  27. package/dist/es/es2018/types/src/generated/resources/postConnectActionableListDefFilter.d.ts +20 -0
  28. package/dist/es/es2018/types/src/generated/resources/postConnectActionableListDefinition.d.ts +13 -0
  29. package/dist/es/es2018/types/src/generated/resources/postConnectActionableListDefinitionRows.d.ts +16 -0
  30. package/dist/es/es2018/types/src/generated/resources/postConnectActionableListRefreshCount.d.ts +13 -0
  31. package/dist/es/es2018/types/src/generated/resources/postConnectBulkActionCreateBulkActionplans.d.ts +22 -0
  32. package/dist/es/es2018/types/src/generated/types/ALDDatasetColumnOutputRepresentation.d.ts +56 -0
  33. package/dist/es/es2018/types/src/generated/types/ALDMemberStatusOutputRepresentation.d.ts +35 -0
  34. package/dist/es/es2018/types/src/generated/types/ActionableListColumnUserInputRepresentation.d.ts +34 -0
  35. package/dist/es/es2018/types/src/generated/types/ActionableListColumnsUserOutputRepresentation.d.ts +44 -0
  36. package/dist/es/es2018/types/src/generated/types/ActionableListColumnsUserUpsertInputRepresentation.d.ts +29 -0
  37. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetByDefinitionRepresentation.d.ts +47 -0
  38. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetColumnRepresentation.d.ts +52 -0
  39. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetColumnUserWrapperInputRepresentation.d.ts +29 -0
  40. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetColumnValuesOutputRepresentation.d.ts +30 -0
  41. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetInputRepresentation.d.ts +55 -0
  42. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetRowRepresentation.d.ts +32 -0
  43. package/dist/es/es2018/types/src/generated/types/ActionableListDatasetWrapperInputRepresentation.d.ts +29 -0
  44. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionCreateInputRepresentation.d.ts +40 -0
  45. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionCreateOutputRepresentation.d.ts +41 -0
  46. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionGetAllOutputRepresentation.d.ts +30 -0
  47. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionOutputRepresentation.d.ts +61 -0
  48. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionStatusOutputRepresentation.d.ts +32 -0
  49. package/dist/es/es2018/types/src/generated/types/ActionableListDefinitionWrapperInputRepresentation.d.ts +29 -0
  50. package/dist/es/es2018/types/src/generated/types/ActionableListFilterInputRepresentation.d.ts +40 -0
  51. package/dist/es/es2018/types/src/generated/types/ActionableListFilterInputRepresentationList.d.ts +28 -0
  52. package/dist/es/es2018/types/src/generated/types/ActionableListFilterTemplateInputRepresentation.d.ts +50 -0
  53. package/dist/es/es2018/types/src/generated/types/ActionableListFilterTemplateListOutputRepresentation.d.ts +42 -0
  54. package/dist/es/es2018/types/src/generated/types/ActionableListFilterTemplateOutputRepresentation.d.ts +60 -0
  55. package/dist/es/es2018/types/src/generated/types/ActionableListFilterTemplateUpsertOutputRepresentation.d.ts +44 -0
  56. package/dist/es/es2018/types/src/generated/types/ActionableListMemberInputRepresentation.d.ts +31 -0
  57. package/dist/es/es2018/types/src/generated/types/ActionableListMemberStatusRepresentation.d.ts +34 -0
  58. package/dist/es/es2018/types/src/generated/types/ActionableListMembersOutputRepresentation.d.ts +29 -0
  59. package/dist/es/es2018/types/src/generated/types/ActionableListRefreshFilterConditionOutputRepresentation.d.ts +41 -0
  60. package/dist/es/es2018/types/src/generated/types/ActionableListRefreshFilterListOutputRepresentation.d.ts +33 -0
  61. package/dist/es/es2018/types/src/generated/types/ActionableListRefreshInputRepresentation.d.ts +31 -0
  62. package/dist/es/es2018/types/src/generated/types/ActionableListRefreshOutputRepresentation.d.ts +57 -0
  63. package/dist/es/es2018/types/src/generated/types/ActionableListRefreshWrapperInputRepresentation.d.ts +29 -0
  64. package/dist/es/es2018/types/src/generated/types/ActionableListUpsertInputRepresentation.d.ts +61 -0
  65. package/dist/es/es2018/types/src/generated/types/ActionableListUpsertOutputRepresentation.d.ts +44 -0
  66. package/dist/es/es2018/types/src/generated/types/ActionableListWrapperInputRepresentation.d.ts +29 -0
  67. package/dist/es/es2018/types/src/generated/types/AdditionalContextRepresentation.d.ts +28 -0
  68. package/dist/es/es2018/types/src/generated/types/CreateBulkActionPlanInputRepresentation.d.ts +56 -0
  69. package/dist/es/es2018/types/src/generated/types/CreateBulkActionPlanOutputRepresentation.d.ts +41 -0
  70. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  71. package/package.json +74 -0
  72. package/sfdc/index.d.ts +1 -0
  73. package/sfdc/index.js +5928 -0
  74. package/src/raml/api.raml +917 -0
  75. package/src/raml/luvio.raml +126 -0
@@ -0,0 +1,917 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '59.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
+ ALDDatasetColumnOutputRepresentation:
29
+ description: Output representation of dataset column for particular actionable
30
+ list definition
31
+ type: object
32
+ properties:
33
+ actionableListDefinitionId:
34
+ description: The actionable list definition that is mapped to the dataset
35
+ column
36
+ type: string
37
+ dataDomain:
38
+ description: The data domain that is mapped to the data type of the dataset
39
+ column
40
+ type: string | nil
41
+ dataType:
42
+ description: The data type used for formatting
43
+ type: string | nil
44
+ id:
45
+ description: Id of actionable list definition dataset column
46
+ type: string
47
+ isDefault:
48
+ description: Flag to denote if this particular column has been made available
49
+ or not
50
+ type: boolean
51
+ isGroupedByListDefObj:
52
+ description: Indicates whether the dataset column is grouped by the object
53
+ defined in the actionable list definition (true) or not (false).
54
+ type: boolean
55
+ objectName:
56
+ description: The object name that is mapped to the dataset column
57
+ type: string | nil
58
+ sourceColumnApiName:
59
+ description: The column api information from tcrm side
60
+ type: string | nil
61
+ sourceFieldName:
62
+ description: Source field name of actionable list definition dataset column
63
+ type: string | nil
64
+ isTypeAheadSearchEnabled:
65
+ description: Indicates whether the dataset column is configured (true) or
66
+ not (false) for searching in filter panel.
67
+ type: boolean
68
+ ALDMemberStatusOutputRepresentation:
69
+ description: Output representation of member status for particular actionable
70
+ list definition
71
+ type: object
72
+ properties:
73
+ iconName:
74
+ description: Icon name of actionable list definition member status
75
+ type: string
76
+ id:
77
+ description: Id of actionable list definition member status
78
+ type: string
79
+ status:
80
+ description: Status for particular actionable list definition member
81
+ type: string
82
+ ActionableListDefinitionCreateInputRepresentation:
83
+ description: Input representation for create actionable list definition API
84
+ type: object
85
+ properties:
86
+ batchCalcJobDefinitionId:
87
+ description: Set batchCalcJobDefinition id for create actionable list definition
88
+ type: string | nil
89
+ required: false # TODO handrolled W-9314597
90
+ developerName:
91
+ description: Set developer name for create actionable list definition
92
+ type: string
93
+ label:
94
+ description: Set label for create actionable list definition
95
+ type: string
96
+ objectName:
97
+ description: Set anchor entity for create actionable list definition
98
+ type: string
99
+ type:
100
+ description: The type of the actionable list that can be created from the actionable list definition.
101
+ type: string
102
+ required: false
103
+ ActionableListDefinitionCreateOutputRepresentation:
104
+ description: Output representation for create actionable list definition API
105
+ type: object
106
+ properties:
107
+ actionableListDefinition:
108
+ description: Created actionable list definition
109
+ type: ActionableListDefinitionOutputRepresentation
110
+ status:
111
+ description: Status of create actionable list definition API
112
+ type: ActionableListDefinitionStatusOutputRepresentation
113
+ ActionableListDefinitionGetAllOutputRepresentation:
114
+ description: Output representation for get actionable list definition API
115
+ type: object
116
+ properties:
117
+ aldList:
118
+ description: List of all actionable list definitions
119
+ type: array
120
+ items:
121
+ type: ActionableListDefinitionOutputRepresentation
122
+ ActionableListDefinitionOutputRepresentation:
123
+ description: Output representation of single object for get actionable list definition
124
+ API
125
+ type: object
126
+ properties:
127
+ aldDatasetColumnOutputRepresentation:
128
+ description: Information about all dataset columns for this actionable list
129
+ definition
130
+ type: array
131
+ items:
132
+ type: ALDDatasetColumnOutputRepresentation
133
+ aldMemberStatusOutputRepresentation:
134
+ description: Information about all member status for this actionable list
135
+ definition
136
+ type: array
137
+ items:
138
+ type: ALDMemberStatusOutputRepresentation
139
+ batchCalcJobDefinitionId:
140
+ description: BatchCalcJobDefinitionId of DPE definition
141
+ type: string | nil
142
+ fullName:
143
+ description: Full Name of actionable list definition
144
+ type: string
145
+ id:
146
+ description: Id of actionable list definition
147
+ type: string
148
+ isActive:
149
+ description: Flag to determine whether the actionable list definition is active
150
+ or not
151
+ type: boolean
152
+ objectName:
153
+ description: Anchor object name of actionable list definition
154
+ type: string
155
+ status:
156
+ description: Status of actionable list definition on DPE side
157
+ type: string
158
+ tcrmDatasetId:
159
+ description: TCRM dataset id of dataset created on tcrm side
160
+ type: string | nil
161
+ tcrmDatasetName:
162
+ description: TCRM dataset name of dataset created on tcrm side
163
+ type: string
164
+ type:
165
+ description: The type of the actionable list that can be created from the actionable list definition.
166
+ type: string | nil
167
+ required: false
168
+ ActionableListDefinitionStatusOutputRepresentation:
169
+ description: Output representation to display the status of an API request
170
+ type: object
171
+ properties:
172
+ code:
173
+ description: get status code
174
+ type: integer
175
+ message:
176
+ description: get status message
177
+ type: string
178
+ ActionableListMembersOutputRepresentation:
179
+ description: Fetch existing members from Actionable List
180
+ type: object
181
+ properties:
182
+ memberIds:
183
+ description: A list of Ids of members in a actionableList
184
+ type: array
185
+ items:
186
+ type: string
187
+ ActionableListColumnUserInputRepresentation:
188
+ description: Input representation to upsert dataset columns preferences for user
189
+ type: object
190
+ properties:
191
+ actionableListDatasetColumnId:
192
+ description: Id of the actionable list dataset column
193
+ type: string
194
+ displayOrder:
195
+ description: display order for dataset columns
196
+ type: integer | nil
197
+ required: false # TODO handrolled W-9314597
198
+ isVisible:
199
+ description: dataset column is visible on builder page or not
200
+ type: boolean
201
+ ActionableListColumnsUserOutputRepresentation:
202
+ description: Output representation to upsert dataset columns preferences for user
203
+ type: object
204
+ properties:
205
+ errorMessage:
206
+ description: Error message while upserting actionable list dataset columns
207
+ user preferences
208
+ type: string | nil
209
+ id:
210
+ description: Id of actionable list dataset columns user preferences
211
+ type: string | nil
212
+ isSuccess:
213
+ description: Flag to represent that actionable list dataset column user preferences
214
+ successfully upserted
215
+ type: string | nil
216
+ ActionableListColumnsUserUpsertInputRepresentation:
217
+ description: Input representation to upsert dataset columns preferences for user
218
+ type: object
219
+ properties:
220
+ actionableListDatasetColumnUserPrefList:
221
+ description: List of ActionableList Dataset Column User Preference
222
+ type: array
223
+ items:
224
+ type: ActionableListColumnUserInputRepresentation
225
+ ActionableListDatasetByDefinitionRepresentation:
226
+ description: Fetch rows from dataset
227
+ type: object
228
+ properties:
229
+ count:
230
+ description: Count of records in query result
231
+ type: integer | nil
232
+ currencyCode:
233
+ description: Currency code of the currency fields in dataset
234
+ type: string | nil
235
+ datasetColumns:
236
+ description: A list of dataset columns information in a actionableList
237
+ type: array
238
+ items:
239
+ type: ActionableListDatasetColumnRepresentation
240
+ datasetRows:
241
+ description: A list of dataset rows with column information in a actionableList
242
+ type: array
243
+ items:
244
+ type: ActionableListDatasetRowRepresentation
245
+ memberStatuses:
246
+ description: A list of member status in a actionableList
247
+ type: array
248
+ items:
249
+ type: ActionableListMemberStatusRepresentation
250
+ responseId:
251
+ description: Stores the response Id of the TCRM result set
252
+ type: string
253
+ ActionableListDatasetColumnRepresentation:
254
+ description: Output representation to display actionable List dataset columns
255
+ type: object
256
+ properties:
257
+ dataDomain:
258
+ description: get data domain
259
+ type: string | nil
260
+ dataType:
261
+ description: The data type used for formatting
262
+ type: string | nil
263
+ id:
264
+ description: Id of actionable list definition dataset column
265
+ type: string
266
+ isDefault:
267
+ description: flag to denote if this particular column has been made available
268
+ or not
269
+ type: boolean | nil
270
+ isGroupedByListDefObj:
271
+ description: Indicates whether the dataset column is grouped by the object
272
+ defined in the actionable list definition (true) or not (false).
273
+ type: boolean | nil
274
+ objectName:
275
+ description: get Object Name
276
+ type: string | nil
277
+ sourceColumnApiName:
278
+ description: get source Column Api name
279
+ type: string | nil
280
+ sourceFieldName:
281
+ description: get soureField name
282
+ type: string | nil
283
+ isTypeAheadSearchEnabled:
284
+ description: Indicates whether the dataset column is configured (true) or
285
+ not (false) for searching in filter panel.
286
+ type: boolean
287
+ ActionableListDatasetInputRepresentation:
288
+ description: Input representation to fetch dataset rows and columns of Actionable
289
+ List
290
+ type: object
291
+ properties:
292
+ actionableListDefinitionId:
293
+ description: Id of the actionable list definition record
294
+ type: string | nil
295
+ required: false # TODO handrolled W-9314597
296
+ filterLogic:
297
+ description: Filter Logic that is used to create the dataset query
298
+ required: false # TODO handrolled W-9314597
299
+ type: string
300
+ filterTemplateId:
301
+ description: Filter template from which filters are applied
302
+ required: false # TODO handrolled W-9314597
303
+ type: string
304
+ filters:
305
+ description: filter by clause list
306
+ required: false # TODO handrolled W-9314597
307
+ type: object
308
+ offset:
309
+ description: Offset of dataset rows
310
+ type: integer | nil
311
+ required: false # TODO handrolled W-9314597
312
+ orderBy:
313
+ description: order by clause in query while fetching dataset rows
314
+ type: string | nil
315
+ required: false # TODO handrolled W-9314597
316
+ queryType:
317
+ description: Query type decides if this is a count query or records query
318
+ etc
319
+ type: string | nil
320
+ required: false # TODO handrolled W-9314597
321
+ rowLimit:
322
+ description: Limit of dataset rows
323
+ type: integer | nil
324
+ required: false # TODO handrolled W-9314597
325
+ shouldReturnCurrencyCode:
326
+ description: Should the API return Currency Code used for formatting
327
+ type: boolean
328
+ required: false # TODO handrolled W-9314597
329
+ sortOrder:
330
+ description: ASC or DESC order while fetching dataset rows
331
+ type: string | nil
332
+ required: false # TODO handrolled W-9314597
333
+ ActionableListDatasetRowRepresentation:
334
+ description: Output representation to display actionable List dataset rows
335
+ type: object
336
+ properties:
337
+ rowMap:
338
+ description: get row Map to fetch Id
339
+ type: object
340
+ properties:
341
+ //:
342
+ type: string
343
+ ActionableListFilterInputRepresentation:
344
+ description: Input representation for actionable list Filters.
345
+ type: object
346
+ properties:
347
+ columnId:
348
+ description: Id of Column to be filtered
349
+ type: string | nil
350
+ required: false # TODO handrolled W-9314597
351
+ columnName:
352
+ description: Name of Column to be filtered
353
+ type: string | nil
354
+ required: false # TODO handrolled W-9314597
355
+ dataDomain:
356
+ description: data domain of filter column
357
+ type: string | nil
358
+ required: false # TODO handrolled W-9314597
359
+ operator:
360
+ description: operator for filter
361
+ type: string | nil
362
+ required: false # TODO handrolled W-9314597
363
+ value:
364
+ description: value for filter
365
+ type: string | nil
366
+ required: false # TODO handrolled W-9314597
367
+ ActionableListFilterInputRepresentationList:
368
+ description: Input representation for a list of filters
369
+ type: object
370
+ properties:
371
+ actionableListFilterList:
372
+ description: filter clauses list
373
+ required: false # TODO handrolled W-9314597
374
+ type: array
375
+ items:
376
+ type: object
377
+ ActionableListMemberStatusRepresentation:
378
+ description: Output representation to display actionable List member status
379
+ type: object
380
+ properties:
381
+ iconName:
382
+ description: get icon name
383
+ type: string | nil
384
+ id:
385
+ description: get id
386
+ type: string | nil
387
+ status:
388
+ description: get status
389
+ type: string | nil
390
+ ActionableListRefreshFilterConditionOutputRepresentation:
391
+ description: Output response for the Actionable List refresh filter condition
392
+ type: object
393
+ properties:
394
+ columnName:
395
+ description: Name of Column to be filtered
396
+ type: string | nil
397
+ operator:
398
+ description: operator for filter
399
+ type: string | nil
400
+ value:
401
+ description: value for filter
402
+ type: string | nil
403
+ dataDomain:
404
+ description: DataDomain for filter
405
+ type: string | nil
406
+ sequenceNumber:
407
+ description: Sequence number of filter
408
+ type: integer | nil
409
+ ActionableListRefreshFilterListOutputRepresentation:
410
+ description: Output response for the Actionable List refresh filters
411
+ type: object
412
+ properties:
413
+ conditions:
414
+ description: Actionable list filters
415
+ type: array
416
+ items:
417
+ type: ActionableListRefreshFilterConditionOutputRepresentation | nil
418
+ filterLogic:
419
+ description: List member filter logic
420
+ type: string | nil
421
+ ActionableListFilterTemplateInputRepresentation:
422
+ description: Request schema for new template creation or updation
423
+ type: object
424
+ properties:
425
+ id:
426
+ description: Actionable List Filter Template id in case of update request
427
+ type: string | nil
428
+ templateName:
429
+ description: Actionable List Filter Template Name
430
+ type: string
431
+ description:
432
+ description: Actionable List Filter Template description
433
+ type: string | nil
434
+ filterLogic:
435
+ description: Filter logic for template filter conditions
436
+ type: string | nil
437
+ actionableListDefinitionId:
438
+ description: Id of related actionable list definition
439
+ type: string
440
+ filterList:
441
+ description: List of filter conditions to be stored for template
442
+ type: array
443
+ items:
444
+ type: ActionableListFilterInputRepresentation | nil
445
+ sharingType:
446
+ description: Sharing type of filter template
447
+ type: string
448
+ enum:
449
+ - Private
450
+ - Public
451
+ isTemplateDetailEdit:
452
+ description: specifies if edit is for template details for filter conditions
453
+ type: boolean
454
+ ActionableListFilterTemplateUpsertOutputRepresentation:
455
+ description: Output response for create or update request for filter template
456
+ type: object
457
+ properties:
458
+ errorMessage:
459
+ description: Error message while upserting filter template
460
+ type: string | nil
461
+ id:
462
+ description: Id of actionable list filter template
463
+ type: string | nil
464
+ isSuccess:
465
+ description: Flag to detonate that actionable list filter template successfully upserted
466
+ type: string | nil
467
+ ActionableListFilterTemplateListOutputRepresentation:
468
+ description: Output response for get filter templates request for list definition
469
+ type: object
470
+ properties:
471
+ actionableListDefinitionId:
472
+ description: Id of the actionable list definition
473
+ type: string
474
+ filterTemplates:
475
+ description: List of filter conditions associated with filter template
476
+ type: array
477
+ items:
478
+ type: ActionableListFilterTemplateOutputRepresentation
479
+ ActionableListFilterTemplateOutputRepresentation:
480
+ description: Output response for get filter template
481
+ type: object
482
+ properties:
483
+ id:
484
+ description: Actionable List Filter Template Id
485
+ type: string
486
+ templateName:
487
+ description: Actionable List Filter Template Name
488
+ type: string
489
+ description:
490
+ description: Actionable List Filter Template description
491
+ type: string | nil
492
+ filterLogic:
493
+ description: Filter logic for template filter conditions
494
+ type: string | nil
495
+ ownerId:
496
+ description: User Id of the owner of the filter template
497
+ type: string | nil
498
+ ownerName:
499
+ description: User Name of the owner of the filter template
500
+ type: string | nil
501
+ sharingType:
502
+ description: Sharing type of filter template
503
+ type: string
504
+ enum:
505
+ - Private
506
+ - Public
507
+ filterList:
508
+ description: List of filter conditions associated with template
509
+ type: array
510
+ items:
511
+ type: ActionableListRefreshFilterConditionOutputRepresentation | nil
512
+ ActionableListRefreshInputRepresentation:
513
+ description: Input representation to List refresh for ActionableList
514
+ type: object
515
+ properties:
516
+ actionableListDefinitionId:
517
+ description: Id of the actionable list definition
518
+ type: string
519
+ actionableListId:
520
+ description: Id of the actionable list
521
+ type: string
522
+ ActionableListRefreshOutputRepresentation:
523
+ description: Output response for the Actionable List refresh
524
+ type: object
525
+ properties:
526
+ candidateMemberCount:
527
+ description: List member count
528
+ type: integer | nil
529
+ errorMessage:
530
+ description: Error message while upserting actionable list filter
531
+ type: string | nil
532
+ existingMemberCount:
533
+ description: Existing member count
534
+ type: integer | nil
535
+ filters:
536
+ description: List Filter
537
+ type: ActionableListRefreshFilterListOutputRepresentation | nil
538
+ id:
539
+ description: Id of actionable list
540
+ type: string | nil
541
+ isSuccess:
542
+ description: Flag to detonate that actionable list refresh filters successfully
543
+ upserted
544
+ type: string | nil
545
+ maxMemberCount:
546
+ description: Max allowed member count
547
+ type: integer | nil
548
+ ActionableListUpsertInputRepresentation:
549
+ description: Input representation for upsert Actionable List with it's members
550
+ and columns
551
+ type: object
552
+ properties:
553
+ actionableListColumns:
554
+ description: Upsert actionable list columns of actionable list
555
+ required: false # TODO handrolled W-9314597
556
+ type: array
557
+ items:
558
+ type: string
559
+ actionableListDefinitionId:
560
+ description: Upsert actionable list definition id of actionable list
561
+ type: string | nil
562
+ required: false # TODO handrolled W-9314597
563
+ actionableListMemberIds:
564
+ description: Upsert actionable list members of actionable list
565
+ required: false # TODO handrolled W-9314597
566
+ type: array
567
+ items:
568
+ type: string
569
+ additionalContext:
570
+ description: Additional context of the actionable list
571
+ type: object
572
+ defaultMemberStatusId:
573
+ description: Upsert default member status Id of actionable list
574
+ type: string | nil
575
+ required: false # TODO handrolled W-9314597
576
+ description:
577
+ description: Upsert description of actionable list
578
+ type: string | nil
579
+ required: false # TODO handrolled W-9314597
580
+ filterLogic:
581
+ description: Filter Logic used in dataset query in Async members addition to Actionable List
582
+ type: string
583
+ required: false # TODO handrolled W-9314597
584
+ filters:
585
+ description: Filters used in Async members addition to Actionable List
586
+ required: false # TODO handrolled W-9314597
587
+ type: object
588
+ id:
589
+ description: Id to upsert the actionable list record
590
+ type: string | nil
591
+ required: false # TODO handrolled W-9314597
592
+ isAsync:
593
+ description: Should the upsert be async or sync
594
+ type: boolean
595
+ required: false # TODO handrolled W-9314597
596
+ name:
597
+ description: Upsert name of actionable list
598
+ type: string | nil
599
+ required: false # TODO handrolled W-9314597
600
+ objectName:
601
+ description: Upsert object name of actionable list
602
+ type: string | nil
603
+ required: false # TODO handrolled W-9314597
604
+ ActionableListUpsertOutputRepresentation:
605
+ description: Upsert Actionable List and it's members and columns
606
+ type: object
607
+ properties:
608
+ errorMessage:
609
+ description: Error message while upserting actionable list
610
+ type: string | nil
611
+ id:
612
+ description: Id of actionable list
613
+ type: string | nil
614
+ isSuccess:
615
+ description: Flag to detonate that actionable list successfully upserted
616
+ type: string | nil
617
+ AdditionalContextRepresentation:
618
+ description: Input representation for additional context
619
+ type: object
620
+ properties:
621
+ contextRecordId:
622
+ description: Context record Id of the actionable list
623
+ type: string
624
+ # TODO Hand-rolled W-11954472: ActionableListDefinitionWrapperInputRepresentation added manually
625
+ ActionableListDefinitionWrapperInputRepresentation:
626
+ description: wrapper of ActionableListDefinitionCreateInputRepresentation
627
+ type: object
628
+ properties:
629
+ actionableListDefinitionCreateInput:
630
+ description: Input representation for ActionableListDefinitionCreateInputRepresentation
631
+ type: ActionableListDefinitionCreateInputRepresentation
632
+ # TODO Hand-rolled W-11954472: ActionableListWrapperInputRepresentation added manually
633
+ ActionableListWrapperInputRepresentation:
634
+ description: wrapper of ActionableListUpsertInputRepresentation
635
+ type: object
636
+ properties:
637
+ actionableListUpsertInput:
638
+ description: Input representation for ActionableListUpsertInputRepresentation
639
+ type: ActionableListUpsertInputRepresentation
640
+ # TODO Hand-rolled W-11954472: ActionableListDatasetWrapperInputRepresentation added manually
641
+ ActionableListDatasetWrapperInputRepresentation:
642
+ description: wrapper of ActionableListDatasetInputRepresentation
643
+ type: object
644
+ properties:
645
+ actionableListDataset:
646
+ description: Input representation for ActionableListDatasetInputRepresentation
647
+ type: ActionableListDatasetInputRepresentation
648
+ # TODO Hand-rolled W-11954472: ActionableListDatasetColumnUserWrapperInputRepresentation added manually
649
+ ActionableListDatasetColumnUserWrapperInputRepresentation:
650
+ description: wrapper of ActionableListColumnsUserUpsertInputRepresentation
651
+ type: object
652
+ properties:
653
+ actionableListDatasetColumnUserPreferencesUpsertInput:
654
+ description: Input representation for ActionableListColumnsUserUpsertInputRepresentation
655
+ type: ActionableListColumnsUserUpsertInputRepresentation
656
+ # TODO Hand-rolled W-11954472: ActionableListRefreshWrapperInputRepresentation added manually
657
+ ActionableListRefreshWrapperInputRepresentation:
658
+ description: wrapper of ActionableListRefreshInputRepresentation
659
+ type: object
660
+ properties:
661
+ actionableListRefreshInput:
662
+ description: Input representation for ActionableListRefreshInputRepresentation
663
+ type: ActionableListRefreshInputRepresentation
664
+ ActionableListDatasetColumnValuesOutputRepresentation:
665
+ description: Fetch unique values of a column from dataset
666
+ type: object
667
+ properties:
668
+ datasetRows:
669
+ description: A list of dataset rows containing the unique values of a given
670
+ column
671
+ type: array
672
+ items:
673
+ type: ActionableListDatasetRowRepresentation
674
+ ActionableListMemberInputRepresentation:
675
+ description: Input representation for ActionableListMember
676
+ type: object
677
+ properties:
678
+ actionableListMemberId:
679
+ description: Actionable List Member Id
680
+ type: string
681
+ referenceRecordId:
682
+ description: Reference Record Id
683
+ type: string
684
+ CreateBulkActionPlanInputRepresentation:
685
+ description: Input representation for Create Bulk Action Plan
686
+ type: object
687
+ properties:
688
+ actionPlanName:
689
+ description: Action Plan Name
690
+ type: string
691
+ actionPlanStartDate:
692
+ description: Action Plan Start Date
693
+ type: string
694
+ actionPlanTemplateVersionId:
695
+ description: Action Plan Template Version Id
696
+ type: string
697
+ actionPlanType:
698
+ description: Action Plan Type
699
+ type: string
700
+ actionableListId:
701
+ description: Actionable List Id
702
+ type: string
703
+ actionableListMembers:
704
+ description: Actionable List Member List
705
+ type: array
706
+ items:
707
+ type: ActionableListMemberInputRepresentation
708
+ isSkipNonWorkDaysForTasks:
709
+ description: Skip Non Work Days Flag
710
+ type: boolean
711
+ actionableListMemberStatusId:
712
+ description: Actionable List Member Status Id
713
+ type: string
714
+ required: false # TODO handrolled W-9314597
715
+ actionableListName:
716
+ description: Actionable List Name
717
+ type: string
718
+ actionPlanStatus:
719
+ description: Action Plan Status
720
+ type: string
721
+ CreateBulkActionPlanOutputRepresentation:
722
+ description: Output representation for create bulk action plan acknowledgement
723
+ type: object
724
+ properties:
725
+ acknowledgementMessage:
726
+ description: Acknowledgement that bulk action plan request was enqueued
727
+ type: string
728
+ responseId:
729
+ description: Id of the generation response
730
+ type: string
731
+ /connect:
732
+ /actionable-list-definition:
733
+ get:
734
+ description: Fetch all available actionable list definitions if id is not present
735
+ in query param
736
+ responses:
737
+ '200':
738
+ description: Success
739
+ body:
740
+ application/json:
741
+ type: ActionableListDefinitionGetAllOutputRepresentation
742
+ queryParameters:
743
+ id:
744
+ type: string
745
+ required: false
746
+ isActive:
747
+ type: boolean
748
+ required: false
749
+ limit:
750
+ type: integer
751
+ required: false
752
+ offset:
753
+ type: integer
754
+ required: false
755
+ post:
756
+ description: API to create actionable list definition
757
+ responses:
758
+ '200':
759
+ description: Success
760
+ body:
761
+ application/json:
762
+ type: ActionableListDefinitionCreateOutputRepresentation
763
+ body:
764
+ application/json:
765
+ type: ActionableListDefinitionWrapperInputRepresentation
766
+ # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
767
+ (oas-body-name): actionableListDefinitionCreateInput
768
+ /actionable-list-dataset-column-user-assignment:
769
+ post:
770
+ displayName: postActionableListDatasetColumnUserPrefUpsertResources
771
+ description: API to upsert actionable list dataset columns user preferences
772
+ responses:
773
+ '200':
774
+ description: Success
775
+ body:
776
+ application/json:
777
+ type: ActionableListColumnsUserOutputRepresentation
778
+ body:
779
+ application/json:
780
+ type: ActionableListDatasetColumnUserWrapperInputRepresentation
781
+ # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
782
+ (oas-body-name): actionableListDatasetColumnUserPreferencesUpsertInput
783
+ /get-actionable-list-def-filters:
784
+ get:
785
+ description: Get List of filter templates for given actionable list definition
786
+ responses:
787
+ '200':
788
+ description: Success
789
+ body:
790
+ application/json:
791
+ type: ActionableListFilterTemplateListOutputRepresentation
792
+ queryParameters:
793
+ actionableListDefinitionId:
794
+ type: string
795
+ required: false
796
+ /actionable-list-def-filter:
797
+ post:
798
+ description: API to upsert actionable list definition filters
799
+ responses:
800
+ '200':
801
+ description: Success
802
+ body:
803
+ application/json:
804
+ type: ActionableListFilterTemplateUpsertOutputRepresentation
805
+ body:
806
+ application/json:
807
+ type: ActionableListFilterTemplateInputRepresentation
808
+ (oas-body-name): actionableListDefinitionFilterInput
809
+ /{actionableListDefinitionFilterId}:
810
+ get:
811
+ description: Get List of filter templates for given actionable list definition
812
+ responses:
813
+ '200':
814
+ description: Success
815
+ body:
816
+ application/json:
817
+ type: ActionableListFilterTemplateOutputRepresentation
818
+
819
+ delete:
820
+ description: Delete a filter template corresponding to id.
821
+ responses:
822
+ '200':
823
+ description: Success
824
+ uriParameters:
825
+ actionableListDefinitionFilterId:
826
+ type: string
827
+ required: true
828
+ /actionable-list-refresh-count:
829
+ post:
830
+ displayName: postActionableListRefreshUpsertResources
831
+ description: API to upsert actionable list refresh
832
+ responses:
833
+ '200':
834
+ description: Success
835
+ body:
836
+ application/json:
837
+ type: ActionableListRefreshOutputRepresentation
838
+ body:
839
+ application/json:
840
+ type: ActionableListRefreshWrapperInputRepresentation
841
+ (oas-body-name): actionableListRefreshInput
842
+ /bulk-action/create-bulk-actionplans:
843
+ post:
844
+ displayName: postCreateBulkActionPlans
845
+ description: API to enqueue create action plan message
846
+ responses:
847
+ '200':
848
+ description: Success
849
+ body:
850
+ application/json:
851
+ type: CreateBulkActionPlanOutputRepresentation
852
+ body:
853
+ application/json:
854
+ type: CreateBulkActionPlanInputRepresentation
855
+ (oas-body-name): createBulkActionPlanInput
856
+ /actionable-list/{id}/members:
857
+ get:
858
+ description: Get an ActionableList’s Members
859
+ responses:
860
+ '200':
861
+ description: Success
862
+ body:
863
+ application/json:
864
+ type: ActionableListMembersOutputRepresentation
865
+ uriParameters:
866
+ id:
867
+ type: string
868
+ required: true
869
+ /actionable-list:
870
+ post:
871
+ description: API to upsert actionable list and it's members and columns
872
+ responses:
873
+ '200':
874
+ description: Success
875
+ body:
876
+ application/json:
877
+ type: ActionableListUpsertOutputRepresentation
878
+ body:
879
+ application/json:
880
+ type: ActionableListWrapperInputRepresentation
881
+ # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
882
+ (oas-body-name): actionableListUpsertInput
883
+ /actionable-list-definition/rows:
884
+ post:
885
+ description: API to list actionable Dataset rows and columns of the actionable
886
+ list Definition
887
+ responses:
888
+ '200':
889
+ description: Success
890
+ body:
891
+ application/json:
892
+ type: ActionableListDatasetByDefinitionRepresentation
893
+ body:
894
+ application/json:
895
+ type: ActionableListDatasetWrapperInputRepresentation
896
+ # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
897
+ (oas-body-name): actionableListDataset
898
+ /actionable-list-definition/column-values/{aldcId}:
899
+ get:
900
+ displayName: getActionableListDatasetColumnValues
901
+ description: Resource for getting unique values of a given column in Actionable
902
+ List corresponding dataset
903
+ responses:
904
+ '200':
905
+ description: Success
906
+ body:
907
+ application/json:
908
+ type: ActionableListDatasetColumnValuesOutputRepresentation
909
+ queryParameters:
910
+ limit:
911
+ type: integer
912
+ required: false
913
+ default: 1000
914
+ uriParameters:
915
+ aldcId:
916
+ type: string
917
+ required: true