@salesforce/lds-adapters-industries-audit-trail-export 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1085 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.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:
+      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
+      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
+  AuditTrailExportInputRepresentation:
+    description: Input representation to create an audit trail export
+    type: object
+    properties:
+      endDate:
+        description: Set the end date of the audit export
+        type: string
+      endTime:
+        description: Set the end time of the audit export
+        type: string
+      initiatingAttendeeId:
+        description: Set the initiating attendee id of the audit export
+        type: string
+      startDate:
+        description: Set the start date of the audit export
+        type: string
+      startTime:
+        description: Set the start time of the audit export
+        type: string
+      verificationStatus:
+        description: Set the verification status of the audit export
+        type: string
+  AuditTrailExportListOutputRepresentation:
+    description: Output representation capturing all audit trail export where file
+      status is available/failed
+    type: object
+    properties:
+      auditTrailExports:
+        description: audit trail export details
+        type: array
+        items:
+          type: AuditTrailExportOutputRepresentation
+  AuditTrailExportOutputRepresentation:
+    description: Output representation capturing the audit trail export
+    type: object
+    properties:
+      completedAt:
+        description: time at which the audit trail export was completed
+        type: string
+      requestIdentifier:
+        description: request id of the audit trail export
+        type: string
+      requestedAt:
+        description: time at which the audit trail export was placed
+        type: string
+      requestedByUserId:
+        description: id of the user who requested for the audit trail export
+        type: string
+      requestedByUserName:
+        description: name of the user who requested for the audit trail export
+        type: string
+      status:
+        description: status of the audit trail export
+        type: string
+      title:
+        description: title of the audit trail export generated
+        type: string
+  AuditTrailFileDownloadOutputRepresentation:
+    description: Output representation to download the exported audit trail data
+    type: object
+    properties:
+      auditTrailLogs:
+        description: list of audit trail log records
+        type: array
+        items:
+          type: AuditTrailLogOutputRepresentation
+  AuditTrailFileExportInputRepresentation:
+    description: Input representation to create an audit trail export
+    type: object
+    properties:
+      auditTrailExportInput:
+        description: Set the audit trail export
+        type: AuditTrailExportInputRepresentation
+  AuditTrailLogOutputRepresentation:
+    description: Output representation for a single audit log record
+    type: object
+    properties:
+      communicationChannel:
+        description: communication channel
+        type: string
+      engagementTopic:
+        description: engagement topic
+        type: string
+      initiatingAttendee:
+        description: initiating attendee
+        type: string
+      initiatingAttendeeType:
+        description: initiating attendee type
+        type: string
+      recordName:
+        description: record name
+        type: string
+      verificationStatus:
+        description: verification status
+        type: string
+      verificationTimestamp:
+        description: verification timestamp
+        type: string
+      verificationType:
+        description: verification type
+        type: string
+  CustomFieldOutputRepresentation:
+    description: Output representation for creating an engagement interaction, topic,
+      or attendee record with a custom field.
+    type: object
+    properties:
+      key:
+        description: Fetches the name of a custom field from a Salesforce object.
+        type: string
+      value:
+        description: Fetches the value of a custom field from a Salesforce object.
+        type: object
+  CustomFieldsInputRepresentation:
+    description: Input representation for creating an engagement interaction, topic,
+      or attendee record with a custom field.
+    type: object
+    properties:
+      key:
+        description: Sets the name of a custom field in a Salesforce object.
+        type: string
+      value:
+        description: Sets the value of a custom field in a Salesforce object.
+        type: object
+  CustomFieldsListInputRepresentation:
+    description: Wraps a list of custom fields
+    type: object
+    properties:
+      customFields:
+        description: List of custom fields
+        type: array
+        items:
+          type: object
+  EngagementAttendeeCreateInputRepresentation:
+    description: Input representation to create an engagement attendee record
+    type: object
+    properties:
+      customFieldsList:
+        description: Sets the value of the custom fields list for an EngagementAttendee.
+        type: array
+        items:
+          type: object
+      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
+      isAuthenticated:
+        description: Sets the value of the IsAuthenticated field for an EngagementAttendee.
+        type: boolean
+      isVerified:
+        description: Sets the value of the IsVerified field for an EngagementAttendee.
+        type: boolean
+      ownerId:
+        description: Set the ownerId field for this EngagementAttendee
+        type: string
+      role:
+        description: Sets the value of the Role field for an EngagementAttendee. The
+          possible values are Customer, Representative, and Contact Center Agent.
+        type: string
+      startDateTime:
+        description: Set the StartDateTime field for this EngagementAttendee
+        type: string
+      verificationTime:
+        description: Sets the value of the VerificationTime field for an 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:
+      customFields:
+        description: get list of custom fields
+        type: array
+        items:
+          type: CustomFieldOutputRepresentation
+      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
+      isAuthenticated:
+        description: Fetches the value of the IsAuthenticated field for an EngagementAttendee.
+        type: boolean
+      isVerified:
+        description: Fetches the value of the IsVerified field for an EngagementAttendee.
+        type: boolean
+      ownerId:
+        description: get owner id
+        type: string
+      role:
+        description: Fetches the role of the EngagementAttendee.
+        type: string
+      startDateTime:
+        description: get start date-time
+        type: string
+      verificationTime:
+        description: Fetches the value of the VerificationTime field for an EngagementAttendee.
+        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
+      customFieldsList:
+        description: Sets the value of the custom fields list for an EngagementInteraction.
+        type: array
+        items:
+          type: object
+      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
+      phoneNumber:
+        description: Sets the value of the PhoneNumber field for an EngagementInteraction.
+        type: string
+      reason:
+        description: Sets the value of the Reason field for an 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
+      customFields:
+        description: get list of custom fields
+        type: array
+        items:
+          type: CustomFieldOutputRepresentation
+      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
+      phoneNumber:
+        description: Fetches the PhoneNumber of the EngagementInteraction.
+        type: string
+      reason:
+        description: Fetches the reason of the EngagementInteraction.
+        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
+      phoneNumber:
+        description: Updates the value of the PhoneNumber field for an EngagementInteraction.
+        type: string
+      reason:
+        description: Updates the value of the Reason field for an 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:
+      customFieldsList:
+        description: Sets the value of the custom fields list for an EngagementTopic.
+        type: array
+        items:
+          type: object
+      engagementInteractionId:
+        description: Set the engagementInteractionId field for this EngagementTopic
+        type: string
+      id:
+        description: Set the id field for this EngagementTopic
+        type: string
+      interactionSummary:
+        description: Sets the value of the InteractionSummary field for an 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
+      interactionSummary:
+        description: Fetches the interaction summary of the EngagementTopic.
+        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:
+      customFields:
+        description: get list of custom fields
+        type: array
+        items:
+          type: CustomFieldOutputRepresentation
+      engagementInteractionId:
+        description: get engagement interaction id
+        type: string
+      id:
+        description: get engagement topic id
+        type: string
+      interactionSummary:
+        description: Fetches the interaction summary of the EngagementTopic.
+        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
+  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
+  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 | nil
+      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: object
+      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
+  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
+/connect/service-excellence:
+  /audit-trail-exports:
+    get:
+      displayName: getAuditTrailFileExport
+      description: method to fetch all audit trail export which have filestatus as
+        available/failed.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AuditTrailExportListOutputRepresentation
+    post:
+      displayName: postAuditTrailFileExport
+      description: method to fetch all audit trail exports with filestatus as available/failed
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AuditTrailExportOutputRepresentation
+      body:
+        application/json:
+          type: AuditTrailFileExportInputRepresentation
+          #required: false
+          (oas-body-name): auditTrailExportInput
+  /audit-trail-exports/{requestIdentifier}:
+    delete:
+      displayName: deleteAuditTrailExportDelete
+      description: method to delete the file associated with the audit trail export
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getAuditTrailExportDelete
+      description: method to fetch audit trail export for a given requestIdentifier.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AuditTrailExportOutputRepresentation
+    uriParameters:
+      requestIdentifier:
+        type: string
+        required: true
+  /audit-trail-exports/{requestIdentifier}/download:
+    get:
+      displayName: getAuditTrailFileExportDownload
+      description: method to fetch audit trail logs for a given request.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AuditTrailFileDownloadOutputRepresentation
+    uriParameters:
+      requestIdentifier:
+        type: string
+        required: true
+  /engagement-interactions:
+    delete:
+      displayName: deleteEngagementInteraction
+      description: method to delete engagements
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getEngagementInteraction
+      description: method to fetch engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EngagementInteractionFetchOutputRepresentation
+    # TODO: Hand rolled
+    # post:
+    #   displayName: postEngagementInteraction
+    #   description: method to create engagements
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: EngagementInteractionCreateOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: EngagementsCreateInputRepresentation
+    #       #required: false
+    #       (oas-body-name): engagementContainerInput
+  /engagement-interactions/{engagementInteractionId}:
+    delete:
+      displayName: deleteEngagementInteraction
+      description: method to delete engagements
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getEngagementInteraction
+      description: method to fetch engagements
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EngagementInteractionFetchOutputRepresentation
+    # TODO: Hand rolled
+    # post:
+    #   displayName: postEngagementInteraction
+    #   description: method to create engagements
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: EngagementInteractionCreateOutputRepresentation
+    #   body:
+    #     application/json:
+    #       type: EngagementsCreateInputRepresentation
+    #       #required: false
+    #       (oas-body-name): engagementContainerInput
+    uriParameters:
+      engagementInteractionId:
+        type: string
+        required: true
+  /service-catalog-items:
+    /action-launch:
+      # TODO: Hand rolled
+      # post:
+      #   displayName: postActionLaunch
+      #   description: The method to post the details of an action launch event.
+      #   responses:
+      #     '200':
+      #       description: Success
+      #       body:
+      #         application/json:
+      #           type: ActionLaunchStatusRepresentation
+      #   body:
+      #     application/json:
+      #       type: ActionLaunchInputRepresentation
+      #       #required: false
+      #       (oas-body-name): actionLaunchDetails
+    /recent-actions:
+      get:
+        displayName: getRecentActions
+        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:
+        displayName: getServiceCatalog
+        description: method to fetch action items
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceCatalogItemsFetchOutputRepresentation
+        queryParameters:
+          deploymentName:
+            type: string
+            required: false
+      uriParameters:
+        recordId:
+          type: string
+          required: true