@salesforce/lds-adapters-service-einstein-copilot-bot 1.287.0-dev1 → 1.287.0-dev3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -228,6 +228,89 @@ types:
228
228
  isSuccess:
229
229
  description: Success indicator of the get operation.
230
230
  type: boolean
231
+ CopilotQuickActionRepresentation:
232
+ description: Represents a Copilot QuickAction which can be executed by a Copilot client.
233
+ type: object
234
+ properties:
235
+ type:
236
+ description: Type of Copilot QuickAction.
237
+ type: string
238
+ required: false
239
+ label:
240
+ description: Label to display when rendering Copilot QuickAction.
241
+ type: string
242
+ required: false
243
+ icon:
244
+ description: Icon name for the Recommended Action to be used by the client when rendering the QuickAction in the UI.
245
+ type: string
246
+ required: false
247
+ description:
248
+ description: Description of Copilot QuickAction.
249
+ type: string
250
+ required: false
251
+ planTemplateId:
252
+ description: Plan TemplateId associated to the Copilot QuickAction.
253
+ type: string
254
+ required: false
255
+ intent:
256
+ description: Intent associated to the Copilot QuickAction which is used by the planner.
257
+ type: string
258
+ required: false
259
+ userUtterance:
260
+ description: User utterance to be recorded in conversation history by Planner when executing this Copilot Quick Action.
261
+ type: string
262
+ required: false
263
+ actionApiName:
264
+ description: Api name of Copilot QuickAction.
265
+ type: string
266
+ required: false
267
+ createdDate:
268
+ description: Creation date of Copilot QuickAction.
269
+ type: string
270
+ required: false
271
+ lastModifiedDate:
272
+ description: Last Modified date of Copilot QuickAction
273
+ type: string
274
+ required: false
275
+ isGlobal:
276
+ description: Is the copilot QuickAction global or not.
277
+ type: boolean
278
+ required: false
279
+ planTemplateInput:
280
+ description: Input Variables for executing this plan template.
281
+ type: object
282
+ required: false
283
+ properties:
284
+ //:
285
+ type: string
286
+ isStandard:
287
+ description: Is the Copilot QuickAction a standard Action.
288
+ type: boolean
289
+ required: false
290
+ orgAccess:
291
+ description: Level of Org access required for this QuickAction to be visible for the org.
292
+ type: string
293
+ required: false
294
+ namespace:
295
+ description: Namespace of the Copilot QuickAction
296
+ type: string
297
+ required: false
298
+ RecommendedActionsRepresentation:
299
+ description: Represents the result of a get recommended actions request.
300
+ type: object
301
+ properties:
302
+ copilotQuickActions:
303
+ description: Recommended copilot Quick Actions.
304
+ type: array
305
+ items:
306
+ type: CopilotQuickActionRepresentation
307
+ isSuccess:
308
+ description: Success indicator of the get operation.
309
+ type: boolean
310
+ errorMessage:
311
+ description: Error message for the failed get operation
312
+ type: string
313
+ required: false
231
314
  EsTypeMessageRepresentation:
232
315
  description: Represents a ES type message
233
316
  type: object
@@ -348,3 +431,39 @@ types:
348
431
  objectType:
349
432
  type: string
350
433
  required: true
434
+ /recommended-actions:
435
+ get:
436
+ displayName: getRecommendedActions
437
+ description: Provides a list of recommended actions based on the criteria passed in.
438
+ responses:
439
+ '200':
440
+ description: Success
441
+ body:
442
+ application/json:
443
+ type: RecommendedActionsRepresentation
444
+ queryParameters:
445
+ pageName:
446
+ type: string
447
+ required: false
448
+ pageType:
449
+ type: string
450
+ required: false
451
+ actionName:
452
+ type: string
453
+ required: false
454
+ objectApiName:
455
+ type: string
456
+ required: false
457
+ customApplicationName:
458
+ type: string
459
+ required: false
460
+ sessionId:
461
+ type: string
462
+ required: false
463
+ formFactor:
464
+ type: string
465
+ required: false
466
+ enum:
467
+ - Large
468
+ - Medium
469
+ - Small
@@ -29,6 +29,10 @@ types:
29
29
  (luvio.ttl): 900000
30
30
  RecommendedPlanTemplatesRepresentation:
31
31
  (luvio.ttl): 900000
32
+ CopilotQuickActionRepresentation:
33
+ (luvio.ttl): 900000
34
+ RecommendedActionsRepresentation:
35
+ (luvio.ttl): 900000
32
36
 
33
37
  /connect:
34
38
  /conversation-runtime-proxy:
@@ -42,3 +46,7 @@ types:
42
46
  get:
43
47
  (luvio.adapter):
44
48
  name: getRecommendedPlanTemplates
49
+ /recommended-actions:
50
+ get:
51
+ (luvio.adapter):
52
+ name: getRecommendedActions