@salesforce/lds-adapters-industries-service-excellence 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1185 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  ActionLaunchInputRepresentation:
+    description: Input representation for action details.
+    type: object
+    properties:
+      actionCategory:
+        description: set the action category
+        type: string
+        required: false
+      actionDevName:
+        description: set unique identifier of the launched action
+        type: string
+      actionType:
+        description: set the type of action
+        type: string
+      deploymentId:
+        description: set deployment id of the deployment
+        type: string
+        required: false
+      objectKeyPrefix:
+        description: set the key prefix of object corresponding to the record page
+          where the action was launched
+        type: string
+  ActionLaunchStatusRepresentation:
+    description: Output representation to display the status of an API request
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  ActionLauncherConversationInputRepresentation:
+    description: Input representation to extract and process conversation ID
+    type: object
+    properties:
+      id:
+        description: set the conversation ID
+        type: string
+        required: false
+      type:
+        description: set the conversation type
+        type: string
+        enum:
+          - MessagingSession
+          - VoiceCall
+        required: false
+  ActionLauncherIntentActionsMappingOutputRepresentation:
+    description: Output representation for intents and actions mapping
+    type: object
+    properties:
+      actions:
+        description: get list of actions against each intent
+        type: array
+        items:
+          type: any
+      name:
+        description: get name of intent
+        type: string
+  ActionLauncherRecommendationsInputRepresentation:
+    description: Input representation to extract and process intents for action launcher
+      recommendations.
+    type: object
+    properties:
+      conversation:
+        description: set conversation(id and type)
+        type: ActionLauncherConversationInputRepresentation
+      intents:
+        description: set the intents for deriving recommendations
+        type: array
+        items:
+          type: string
+      limit:
+        description: set the limit denoting the total recommendations to be fetched
+        type: integer
+      mode:
+        description: set recommendation mode(CONVERSATION/KEYWORD_SEARCH)
+        type: string
+        enum:
+          - Conversation
+          - KeywordSearch
+  ActionLauncherRecommendationsOutputRepresentation:
+    description: Output representation to fetch all the einstein recommended actions
+      based conversation transcript or keyword
+    type: object
+    properties:
+      intentsActionMapping:
+        description: get intents and actions
+        type: array
+        items:
+          type: ActionLauncherIntentActionsMappingOutputRepresentation
+      mode:
+        description: get mode type for current call
+        type: string
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  ActionLaunchInputWrapper:
+    description: Wrapper for ActionLaunchInputRepresentation
+    type: object
+    properties:
+      actionLaunchDetails:
+        description: The oas body name for action-detail endpoint
+        type: ActionLaunchInputRepresentation
+  EngagementAttendeeCreateInputRepresentation:
+    description: Input representation to create an engagement attendee record
+    type: object
+    properties:
+      endDateTime:
+        description: Set the EndDateTime field for this EngagementAttendee
+        type: string
+      engagementInteractionId:
+        description: Set the ownerId field for this EngagementAttendee
+        type: string
+      externalAttendeeId:
+        description: Set the ExternalAttendeeId field for this EngagementAttendee
+        type: string
+      id:
+        description: Set the id field for this EngagementAttendee
+        type: string
+      internalAttendeeId:
+        description: Set the InternalAttendeeId field for this EngagementAttendee
+        type: string
+      ownerId:
+        description: Set the ownerId field for this EngagementAttendee
+        type: string
+      startDateTime:
+        description: Set the StartDateTime field for this EngagementAttendee
+        type: string
+  EngagementAttendeeCreateOutputRepresentation:
+    description: Output representation to create an engagement attendee record along
+      with the status
+    type: object
+    properties:
+      engagementAttendee:
+        description: get engagement attendee id
+        type: ServiceExcellenceIdOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementAttendeeFetchOutputRepresentation:
+    description: Output representation to fetch an engagement attendee record along
+      with the status
+    type: object
+    properties:
+      engagementAttendee:
+        description: get engagement attendee
+        type: EngagementAttendeeOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementAttendeeListInputRepresentation:
+    description: Wraps a list of engagementAttendees
+    type: object
+    properties:
+      engagementAttendees:
+        description: List of EngagementAttendee Fields
+        type: array
+        items:
+          type: object
+  EngagementAttendeeOutputRepresentation:
+    description: Output representation to create an engagement attendee record
+    type: object
+    properties:
+      endDateTime:
+        description: get end date-time
+        type: string
+      engagementInteractionId:
+        description: get engagement interaction id
+        type: string
+      externalAttendeeId:
+        description: get external attendee id
+        type: string
+      id:
+        description: get attendee id
+        type: string
+      internalAttendeeId:
+        description: get internal attendee id
+        type: string
+      ownerId:
+        description: get owner id
+        type: string
+      startDateTime:
+        description: get start date-time
+        type: string
+  # TODO: Hand rolled
+  # EngagementDetailsOutputRepresentation:
+  #   description: Output representation to display the engagement details
+  #   type: object
+  #   properties:
+  #     attendeeAuthenticated:
+  #       description: check if Attendee Authenticated
+  #       type: boolean
+  #     attendeeVerificationTime:
+  #       description: get attendee verification time
+  #       format: int64
+  #       type: integer
+  #     attendeeVerified:
+  #       description: get is attendee verified
+  #       type: boolean
+  #     communicationChannel:
+  #       description: get communication channel
+  #       type: string
+  #     contextId:
+  #       description: get context id
+  #       type: string
+  #     duration:
+  #       description: get engagement interaction duration
+  #       type: string
+  #     endDateTime:
+  #       description: get endDateTime
+  #       type: string
+  #     engagementAttendees:
+  #       description: get list of engagement attendees
+  #       type: array
+  #       items:
+  #         type: EngagementAttendeeOutputRepresentation
+  #     engagementTopics:
+  #       description: get list of engagement topics
+  #       type: array
+  #       items:
+  #         type: EngagementTopicDetailsOutputRepresentation
+  #     externalIdentifierId:
+  #       description: get external identifier id
+  #       type: string
+  #     id:
+  #       description: get engagement interaction id
+  #       type: string
+  #     initiatingAttendeeId:
+  #       description: get initiating attendee id
+  #       type: string
+  #     mappedState:
+  #       description: get mapped state
+  #       type: string
+  #     ownerId:
+  #       description: get owner id
+  #       type: string
+  #     sentiment:
+  #       description: get sentiment
+  #       type: string
+  #     startDateTime:
+  #       description: get start date time
+  #       type: string
+  #     status:
+  #       description: get status of engagement interaction
+  #       type: string
+  #     type:
+  #       description: get Type
+  #       type: string
+  EngagementInteractionCreateInputRepresentation:
+    description: Input representation to create an engagement interaction record
+    type: object
+    properties:
+      attendeeAuthenticated:
+        description: Set the attendeeAuthenticated field for this EngagementInteraction
+        type: boolean
+      attendeeVerificationTime:
+        description: Set the attendeeVerificationTime field for this EngagementInteraction
+        type: string
+      attendeeVerified:
+        description: Set the attendeeVerified field for this EngagementInteraction
+        type: boolean
+      communicationChannel:
+        description: Set the CommunicationChannel field for this EngagementInteraction
+        type: string
+      contextId:
+        description: Set the ContextId field for this EngagementInteraction
+        type: string
+      duration:
+        description: Set the duration field for this EngagementInteraction
+        type: string
+      endDateTime:
+        description: Set the EndDateTime field for this EngagementInteraction
+        type: string
+      engagementAttendees:
+        description: Set the EngagementAttendees field for this EngagementInteraction
+        type: array
+        items:
+          type: object
+      engagementTopics:
+        description: Set the EngagementTopics field for this EngagementInteraction
+        type: array
+        items:
+          type: object
+      externalIdentifierId:
+        description: Set the ExternalIdentifierId field for this EngagementInteraction
+        type: string
+      id:
+        description: Set the id field for this EngagementInteraction
+        type: string
+      initiatingAttendeeId:
+        description: Set the InitiatingAttendeeId field for this EngagementInteraction
+        type: string
+      mappedState:
+        description: Set the mappedState field for this EngagementInteraction
+        type: string
+      sentiment:
+        description: Set the Sentiment field for this EngagementInteraction
+        type: string
+      startDateTime:
+        description: Set the StartDateTime field for this EngagementInteraction
+        type: string
+      status:
+        description: Set the status field for this EngagementInteraction
+        type: string
+      type:
+        description: Set the type field for this EngagementInteraction
+        type: string
+  EngagementInteractionCreateOutputRepresentation:
+    description: Output representation to create an engagement record along with the
+      status
+    type: object
+    properties:
+      engagementInteraction:
+        description: get engagement interaction id
+        type: EngagementInteractionIdsCreateOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementInteractionFetchOutputRepresentation:
+    description: Output representation to fetch an engagement interaction record along
+      with the status
+    type: object
+    properties:
+      engagementInteraction:
+        description: get engagement interaction
+        type: EngagementInteractionOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementInteractionIdsCreateOutputRepresentation:
+    description: Output representation to create an engagement ID
+    type: object
+    properties:
+      engagementAttendees:
+        description: get attendee list
+        type: array
+        items:
+          type: ServiceExcellenceIdOutputRepresentation
+      engagementTopics:
+        description: get topic list
+        type: array
+        items:
+          type: ServiceExcellenceIdOutputRepresentation
+      id:
+        description: get engagement interaction id
+        type: string
+  EngagementInteractionOutputRepresentation:
+    description: Output representation to fetch the engagement interaction record
+    type: object
+    properties:
+      attendeeAuthenticated:
+        description: check if Attendee Authenticated
+        type: boolean
+      attendeeVerificationTime:
+        description: get attendee verification time
+        type: string
+      attendeeVerified:
+        description: get is attendee verified
+        type: boolean
+      communicationChannel:
+        description: get communication channel
+        type: string
+      contextId:
+        description: get context id
+        type: string
+      duration:
+        description: get engagement interaction duration
+        type: string
+      endDateTime:
+        description: get endDateTime
+        type: string
+      engagementAttendees:
+        description: get list of engagement attendees
+        type: array
+        items:
+          type: EngagementAttendeeOutputRepresentation
+      engagementTopics:
+        description: get list of engagement topics
+        type: array
+        items:
+          type: EngagementTopicOutputRepresentation
+      externalIdentifierId:
+        description: get external identifier id
+        type: string
+      id:
+        description: get engagement interaction id
+        type: string
+      initiatingAttendeeId:
+        description: get initiating attendee id
+        type: string
+      mappedState:
+        description: get mapped state
+        type: string
+      ownerId:
+        description: get owner id
+        type: string
+      sentiment:
+        description: get sentiment
+        type: string
+      startDateTime:
+        description: get start date time
+        type: string
+      status:
+        description: get status of engagement interaction
+        type: string
+      type:
+        description: get Type
+        type: string
+  EngagementInteractionUpdateInputRepresentation:
+    description: Input representation to update an engagement interaction record
+    type: object
+    properties:
+      attendeeAuthenticated:
+        description: Set the attendeeAuthenticated field for this EngagementInteraction
+        type: boolean
+      attendeeVerificationTime:
+        description: Set the attendeeVerificationTime field for this EngagementInteraction
+        type: string
+      attendeeVerified:
+        description: Set the attendeeVerified field for this EngagementInteraction
+        type: boolean
+      communicationChannel:
+        description: Set the CommunicationChannel field for this EngagementInteraction
+        type: string
+      contextId:
+        description: Set the ContextId field for this EngagementInteraction
+        type: string
+      duration:
+        description: Set the duration field for this EngagementInteraction
+        type: string
+      endDateTime:
+        description: Set the EndDateTime field for this EngagementInteraction
+        type: string
+      externalIdentifierId:
+        description: Set the ExternalIdentifierId field for this EngagementInteraction
+        type: string
+      id:
+        description: Set the id field for this EngagementInteraction
+        type: string
+      initiatingAttendeeId:
+        description: Set the InitiatingAttendeeId field for this EngagementInteraction
+        type: string
+      mappedState:
+        description: Set the mappedState field for this EngagementInteraction
+        type: string
+      sentiment:
+        description: Set the Sentiment field for this EngagementInteraction
+        type: string
+      startDateTime:
+        description: Set the StartDateTime field for this EngagementInteraction
+        type: string
+      status:
+        description: Set the status field for this EngagementInteraction
+        type: string
+      type:
+        description: Set the type field for this EngagementInteraction
+        type: string
+  EngagementInteractionUpdateOutputRepresentation:
+    description: Output representation to update an engagement record along with the
+      status
+    type: object
+    properties:
+      engagementAttendees:
+        description: get attendee list
+        type: array
+        items:
+          type: ServiceExcellenceIdOutputRepresentation
+      engagementInteraction:
+        description: get engagement interaction id
+        type: ServiceExcellenceIdOutputRepresentation
+      engagementTopics:
+        description: get topic list
+        type: array
+        items:
+          type: ServiceExcellenceIdOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementTopicCreateInputRepresentation:
+    description: Input representation to create an engagement topic record
+    type: object
+    properties:
+      engagementInteractionId:
+        description: Set the engagementInteractionId field for this EngagementTopic
+        type: string
+      id:
+        description: Set the id field for this EngagementTopic
+        type: string
+      name:
+        description: Set the name field for this EngagementTopic
+        type: string
+      ownerId:
+        description: Set the ownerId field for this EngagementTopic
+        type: string
+      parentTopicId:
+        description: Set the name field for this EngagementTopic
+        type: string
+      processFailureReason:
+        description: Set the name field for this EngagementTopic
+        type: string
+      processName:
+        description: Set the processName field for this EngagementTopic
+        type: string
+      processStatus:
+        description: Set the ProcessStatus field for this EngagementTopic
+        type: string
+      processType:
+        description: Set the processType field for this EngagementTopic
+        type: string
+      relatedPersonId:
+        description: Set the RelatedPersonId field for this EngagementTopic
+        type: string
+      topicId:
+        description: Set the TopicId field for this EngagementTopic
+        type: string
+  EngagementTopicCreateOutputRepresentation:
+    description: Output representation to create an engagement topic record along
+      with the status
+    type: object
+    properties:
+      engagementTopic:
+        description: get engagement topic id
+        type: ServiceExcellenceIdOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementTopicDetailsOutputRepresentation:
+    description: Output representation to create an engagement topic record
+    type: object
+    properties:
+      id:
+        description: get engagement topic id
+        type: string
+      name:
+        description: get name
+        type: string
+      ownerId:
+        description: get owner id reason
+        type: string
+      parentTopicId:
+        description: get parent topic id
+        type: string
+      processFailureReason:
+        description: get process failure reason
+        type: string
+      processName:
+        description: get process name
+        type: string
+      processStatus:
+        description: get process status
+        type: string
+      processType:
+        description: get process type
+        type: string
+      relatedPersonId:
+        description: get related person id
+        type: string
+      topicId:
+        description: get topic id
+        type: string
+  EngagementTopicFetchOutputRepresentation:
+    description: Output representation to fetch an engagement topic record along with
+      the status
+    type: object
+    properties:
+      engagementTopic:
+        description: get engagement topic
+        type: EngagementTopicOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementTopicListInputRepresentation:
+    description: Wraps a list of engagementTopics
+    type: object
+    properties:
+      engagementTopics:
+        description: List of EngagementTopic Fields
+        type: array
+        items:
+          type: object
+  EngagementTopicOutputRepresentation:
+    description: Output representation to create an engagement topic record
+    type: object
+    properties:
+      engagementInteractionId:
+        description: get engagement interaction id
+        type: string
+      id:
+        description: get engagement topic id
+        type: string
+      name:
+        description: get name
+        type: string
+      ownerId:
+        description: get owner id
+        type: string
+      parentTopicId:
+        description: get parent topic id
+        type: string
+      processFailureReason:
+        description: get process failure reason
+        type: string
+      processName:
+        description: get process name
+        type: string
+      processStatus:
+        description: get process status
+        type: string
+      processType:
+        description: get process type
+        type: string
+      relatedPersonId:
+        description: get related person id
+        type: string
+      topicId:
+        description: get topic id
+        type: string
+  EngagementsCreateInputRepresentation:
+    description: Input representation to create an engagement record
+    type: object
+    properties:
+      engagementInteraction:
+        description: Set the EngagementInteraction field for this container
+        type: object
+  EngagementsFetchOutputRepresentation:
+    description: Output representation to fetch an engagement record along with the
+      status
+    type: object
+    properties:
+      engagementInteraction:
+        description: get complete engagement interaction
+        type: EngagementInteractionOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  EngagementsUpdateInputRepresentation:
+    description: Input representation to update an engagement record
+    type: object
+    properties:
+      engagementAttendees:
+        description: Set the list of EngagementAttendees field for this container
+        type: array
+        items:
+          type: object
+      engagementInteraction:
+        description: Set the EngagementInteraction field for this container
+        type: object
+      engagementTopics:
+        description: Set the list of EngagementTopics field for this container
+        type: array
+        items:
+          type: object
+  RecentlyUsedActionsRepresentation:
+    description: Output representation of most recently used actions.
+    type: object
+    properties:
+      recentActions:
+        description: get the  recent used actions for given {userId, deploymentId,
+          object}
+        type: array
+        items:
+          type: ServiceCatalogItemsOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  ServiceCatalogFrequentActionsOutputRepresentation:
+    description: Output representation of each frequent action items
+    type: object
+    properties:
+      dynamicActions:
+        description: get dynamic action
+        type: array
+        items:
+          type: ServiceCatalogActionsCategoryOutputRepresentation
+      staticActions:
+        description: get static action
+        type: array
+        items:
+          type: ServiceCatalogActionsCategoryOutputRepresentation
+  ServiceCatalogItemsFetchOutputRepresentation:
+    description: Output representation to fetch all action items against a record
+      Id
+    type: object
+    properties:
+      actions:
+        description: get all action items
+        type: array
+        items:
+          type: ServiceCatalogItemsOutputRepresentation
+      frequentActions:
+        description: get frequent actions
+        type: ServiceCatalogFrequentActionsOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+  ServiceCatalogItemsOutputRepresentation:
+    description: Output representation of each service catalog Item
+    type: object
+    properties:
+      actionDefinition:
+        description: It contains action item specific definitions.
+        type: any
+      actionDescription:
+        description: get action Description
+        type: string
+      actionId:
+        description: get unique Action ID
+        type: string
+      actionLabel:
+        description: get action Label
+        type: string
+      actionType:
+        description: get action Type
+        type: string
+  ServiceCatalogActionsCategoryOutputRepresentation:
+    description: Output representation of Static Actions
+    type: object
+    properties:
+      actionId:
+        description: get developer Name
+        type: string | nil
+      businessName:
+        description: get the type of action
+        type: string | nil
+      order:
+        description: get priority/order
+        type: integer | nil
+  ServiceExcellenceIdOutputRepresentation:
+    description: Output representation of entity Id output
+    type: object
+    properties:
+      id:
+        description: get id
+        type: string
+  ServiceExcellenceStatusOutputRepresentation:
+    description: Output representation to display the status of an API request
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+      generationId:
+        description: get unique id against this response
+        type: string | nil
+  UserPreferenceInputRepresentation:
+    description: Input representation for user preferences.
+    type: object
+    properties:
+      preferenceKey:
+        description: set the preference key
+        type: string
+      preferenceValue:
+        description: set the preference value
+        type: string
+  UserPreferenceNodeOutputRepresentation:
+    description: Output representation to display the current state of various user preferences
+    type: object
+    properties:
+      preferenceKey:
+        description: get preference key
+        type: string | nil
+      preferenceValue:
+        description: get preference value
+        type: string | nil
+  UserPreferenceOutputRepresentation:
+    description: Output representation to display the current state of various user preferences
+    type: object
+    properties:
+      userPreference:
+        description: get all preference values
+        type: array
+        items:
+          type: UserPreferenceNodeOutputRepresentation
+      status:
+        description: get status
+        type: ServiceExcellenceStatusOutputRepresentation
+/connect/service-excellence:
+  /action-launcher-recommendations:
+    post:
+      displayName: postActionLauncherRecommendations
+      description: Get recommended action items for Action Launcher in deployment
+        or service catalog.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionLauncherRecommendationsOutputRepresentation
+      queryParameters:
+        catalogId:
+          type: string
+          required: false
+        dataSpaceName:
+          type: string
+          required: false
+        deploymentName:
+          type: string
+          required: false
+        searchIndexName:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: ActionLauncherRecommendationsInputRepresentation
+          (oas-body-name): actionLauncherRecommendations
+  /engagement-interactions:
+    delete:
+      description: method to delete engagements
+      responses:
+        '200':
+          description: Success
+    get:
+      description: method to fetch engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EngagementInteractionFetchOutputRepresentation
+    patch:
+      description: method to update engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceExcellenceStatusOutputRepresentation
+      body:
+        application/json:
+          type: EngagementInteractionUpdateInputRepresentation
+          (oas-body-name): engagementContainerUpdateInput
+    # TODO: Hand rolled
+    # post:
+    #   description: method to create engagements
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: EngagementInteractionCreateOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: EngagementsCreateInputRepresentation
+    #       (oas-body-name): engagementContainerInput
+  /engagement-interactions/{engagementInteractionId}:
+    delete:
+      description: method to delete engagements
+      responses:
+        '200':
+          description: Success
+    get:
+      description: method to fetch engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EngagementInteractionFetchOutputRepresentation
+    patch:
+      description: method to update engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceExcellenceStatusOutputRepresentation
+      body:
+        application/json:
+          type: EngagementInteractionUpdateInputRepresentation
+          (oas-body-name): engagementContainerUpdateInput
+    # TODO: Hand rolled
+    # post:
+    #   description: method to create engagements
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: EngagementInteractionCreateOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: EngagementsCreateInputRepresentation
+    #       (oas-body-name): engagementContainerInput
+    uriParameters:
+      engagementInteractionId:
+        type: string
+        required: true
+    /engagement-attendees:
+      delete:
+        description: method to delete engagement attendee
+        responses:
+          '200':
+            description: Success
+      get:
+        description: method to fetch engagement attendee
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EngagementAttendeeFetchOutputRepresentation
+      patch:
+        description: method to update engagement attendee entity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceExcellenceStatusOutputRepresentation
+        body:
+          application/json:
+            type: EngagementAttendeeCreateInputRepresentation
+            (oas-body-name): engagementAttendeeInput
+      # TODO: Hand rolled
+      # post:
+      #   description: method to create engagement attendee entity
+      #   responses:
+      #     '200':
+      #       description: Success
+      #       body:
+      #         application/json:
+      #           type: EngagementAttendeeCreateOutputRepresentation
+      #   body:
+      #     application/json:
+      #       type: EngagementAttendeeCreateInputRepresentation
+      #       (oas-body-name): engagementAttendeeInput
+      uriParameters:
+        engagementInteractionId:
+          type: string
+          required: true
+    /engagement-attendees/{engagementAttendeeId}:
+      delete:
+        description: method to delete engagement attendee
+        responses:
+          '200':
+            description: Success
+      get:
+        description: method to fetch engagement attendee
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EngagementAttendeeFetchOutputRepresentation
+      patch:
+        description: method to update engagement attendee entity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceExcellenceStatusOutputRepresentation
+        body:
+          application/json:
+            type: EngagementAttendeeCreateInputRepresentation
+            (oas-body-name): engagementAttendeeInput
+      # TODO: Hand rolled
+      # post:
+      #   description: method to create engagement attendee entity
+      #   responses:
+      #     '200':
+      #       description: Success
+      #       body:
+      #         application/json:
+      #           type: EngagementAttendeeCreateOutputRepresentation
+      #   body:
+      #     application/json:
+      #       type: EngagementAttendeeCreateInputRepresentation
+      #       (oas-body-name): engagementAttendeeInput
+      uriParameters:
+        engagementAttendeeId:
+          type: string
+          required: true
+        engagementInteractionId:
+          type: string
+          required: true
+    /engagement-topics:
+      delete:
+        description: method to delete engagement topic
+        responses:
+          '200':
+            description: Success
+      get:
+        description: method to fetch engagement topic
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EngagementTopicFetchOutputRepresentation
+      patch:
+        description: method to update engagement topic entity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceExcellenceStatusOutputRepresentation
+        body:
+          application/json:
+            type: EngagementTopicCreateInputRepresentation
+            (oas-body-name): engagementTopicInput
+      # TODO: Hand rolled
+      # post:
+      #   description: method to create engagement topic entity
+      #   responses:
+      #     '200':
+      #       description: Success
+      #       body:
+      #         application/json:
+      #           type: EngagementTopicCreateOutputRepresentation
+      #   body:
+      #     application/json:
+      #       type: EngagementTopicCreateInputRepresentation
+      #       (oas-body-name): engagementTopicInput
+      uriParameters:
+        engagementInteractionId:
+          type: string
+          required: true
+    /engagement-topics/{engagementTopicId}:
+      delete:
+        description: method to delete engagement topic
+        responses:
+          '200':
+            description: Success
+      get:
+        description: method to fetch engagement topic
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EngagementTopicFetchOutputRepresentation
+      patch:
+        description: method to update engagement topic entity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceExcellenceStatusOutputRepresentation
+        body:
+          application/json:
+            type: EngagementTopicCreateInputRepresentation
+            (oas-body-name): engagementTopicInput
+      # TODO: Hand rolled
+      # post:
+      #   description: method to create engagement topic entity
+      #   responses:
+      #     '200':
+      #       description: Success
+      #       body:
+      #         application/json:
+      #           type: EngagementTopicCreateOutputRepresentation
+      #   body:
+      #     application/json:
+      #       type: EngagementTopicCreateInputRepresentation
+      #       (oas-body-name): engagementTopicInput
+      uriParameters:
+        engagementInteractionId:
+          type: string
+          required: true
+        engagementTopicId:
+          type: string
+          required: true
+  /service-catalog-items:
+    /action-launch:
+      post:
+        description: The method to post the details of an action launch event.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ActionLaunchStatusRepresentation
+        body:
+          application/json:
+            # TODO hand rolled. W-12418972
+            type: ActionLaunchInputWrapper
+            #required: false
+            (oas-body-name): actionLaunchDetails
+    /recent-actions:
+      get:
+        description: The method to fetch a user’s recently used actions that correspond
+          to a record and deployment.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecentlyUsedActionsRepresentation
+        queryParameters:
+          deploymentId:
+            type: string
+            required: false
+          objectKeyPrefix:
+            type: string
+            required: false
+    /{recordId}:
+      get:
+        description: method to fetch action items
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceCatalogItemsFetchOutputRepresentation
+        queryParameters:
+          catalogId:
+            type: string
+            required: false
+          configuration:
+            type: string
+            enum:
+              - Deployment
+              - Catalog
+              - UnifiedCatalog
+            required: true
+          deploymentName:
+            type: string
+            required: false
+          expressionSetId:
+            type: string
+            required: false
+      uriParameters:
+        recordId:
+          type: string
+          required: true
+  /user-preference:
+    post:
+      displayName: postUserPreferences
+      description: Set a given user preference to a specified value
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceExcellenceStatusOutputRepresentation
+      body:
+        application/json:
+          type: UserPreferenceInputRepresentation
+          (oas-body-name): userPreference
+  /fetch-user-preference:
+    get:
+      description: The method to fetch the current state of user preference
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UserPreferenceOutputRepresentation
+      queryParameters:
+        userPreference:
+          type: string