@salesforce/lds-adapters-sales-eci 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,278 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.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:
+  ConversationGenInsightListRepresentation:
+    description: List of GenerativeInsightRepresentation records
+    type: object
+    properties:
+      error:
+        description: Generative Insight Error
+        type: object
+        properties:
+          //:
+            type: string
+      generativeInsights:
+        description: List of Generative Insight records
+        type: array
+        items:
+          type: ConversationGenerativeInsightRepresentation
+      recordId:
+        description: ID for the VoiceCall or VideoCall
+        type: string
+  ConversationGenerativeInsightRepresentation:
+    description: Represents a generative insight for a voice/video call
+    type: object
+    properties:
+      generatedText:
+        description: Generative insight generated text
+        type: string
+      insightName:
+        description: Insight Type Name
+        type: string
+      insightTypeId:
+        description: Insight Type Id
+        type: string
+      modifiedBy:
+        description: Generative insight created/modified by
+        type: string
+  ConversationRealtimeEndMeetingPayloadInputRepresentation:
+    type: object
+    description: Represents a conversations real-time end meeting payload
+    properties:
+      botId:
+        description: real-time meeting bot id
+        type: string
+  ConversationRealtimeMeetingInitiationResponseRepresentation:
+    description: Represents details to connect to the real-time insights service on
+      meeting initiation.
+    type: object
+    properties:
+      botId:
+        description: Identifier for the Bot that participates in the meeting
+        type: string
+      error:
+        description: Realtime Insight Error
+        type: object
+        properties:
+          //:
+            type: string
+      jwtToken:
+        description: JWT token to connect to the real-time-processing-service for
+          obtaining insights
+        type: string
+      webSocketUrl:
+        description: WebSocket URL to connect to the real-time-processing-service
+          for obtaining insights
+        type: string
+  ConversationRealtimeEndMeetingResponseRepresentation:
+    description: Represents empty response
+    type: object
+    properties:
+      fakeKey: string # TODO: Handrolled because luvio doesn't support mutation operations that don't return a key
+  ConversationRealtimeMeetingParticipantRepresentation:
+    description: Representation of realtime meeting participant
+    type: object
+    properties:
+      screenName:
+        description: Display name of meeting participant
+        type: string
+      participantUUID:
+        description: UUID associated with meeting participant
+        type: string | nil
+  ConversationRealtimeStartMeetingPayloadRepresentation:
+    type: object
+    properties:
+      meetingUrl:
+        type: string
+        required: true
+      vendorName:
+        type: string
+        required: true
+      meetingSubject:
+        type: string | nil
+        required: true
+      meetingId:
+        type: string | nil
+        required: true
+      participants:
+        type: array
+        required: true
+        items:
+          type: ConversationRealtimeMeetingParticipantRepresentation
+  conversationRealtimeEndMeetingPayloadRepresentation:
+    type: object
+    properties:
+      botId:
+        type: string
+        required: true
+  ConversationSummaryListRepresentation:
+    description: Represents a list of GenAIConversationSummary records
+    type: object
+    properties:
+      conversationIds:
+        description: List of IDs for the VoiceCall, VideoCall.
+        type: array
+        items:
+          type: string
+      conversationSummaryList:
+        description: List of GenAIConversationSummary records
+        type: array
+        items:
+          type: ConversationSummaryRepresentation
+      id:
+        description: 'ID for the related record object of VoiceCall, VideoCall. Eg:
+          Opportunity, Accounts etc.'
+        type: string
+  ConversationSummaryRepresentation:
+    description: This represents a single GenAIConversationSummary record
+    type: object
+    properties:
+      conversationRecordId:
+        description: Conversation Record ID for this summary. Multi-domain of VoiceCall
+          and VideoCall.
+        type: string
+      errorMessage:
+        description: Error message when state is Error
+        type: string | nil
+      id:
+        description: GenAIConversationSummary Record ID for this summary.
+        type: string
+      source:
+        description: 'The source of the most recent update of the summary field. Values:
+          USER_EDITED, EINSTEIN_GPT'
+        type: string | nil
+      status:
+        description: 'The status this summary is in: Success, Generating, Error'
+        type: string
+      summary:
+        description: The generated or edited summary of the referenced record
+        type: string | nil
+  ConversationTranscriptRepresentation:
+    description: Represents the transcript structure from SIQ
+    type: object
+    properties:
+      transcriptData:
+        description: Transcript Data as JSON
+        type: string | nil
+      error:
+        description: Transcript Error Message
+        type: object
+        properties:
+          //:
+            type: string
+/conversation:
+  /generative/insight/{id}:
+    get:
+      displayName: getConversationGenerativeInsight
+      description: Returns list of GenerativeInsight records
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConversationGenInsightListRepresentation
+    uriParameters:
+      id:
+        type: string
+        required: true
+  /realtime/insight/meeting:
+    /initiate:
+      post:
+        displayName: postConversationRealtimeInsightsStartMeeting
+        description: Initiate the request to start the meeting and to include ECI
+          Real-time bot in the meeting.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ConversationRealtimeMeetingInitiationResponseRepresentation
+        body:
+          application/json:
+            type: ConversationRealtimeStartMeetingPayloadRepresentation
+            (oas-body-name): conversationRealtimeStartMeetingPayload
+    /terminate:
+      post:
+        description: Initiate the request to end the meeting and to remove the ECI Real-time bot from the meeting.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ConversationRealtimeEndMeetingResponseRepresentation
+        body:
+          application/json:
+            type: conversationRealtimeEndMeetingPayloadRepresentation
+            (oas-body-name): conversationRealtimeEndMeetingPayload
+  /summary:
+    /ai/generate/{conversationId}:
+      post:
+        displayName: postConversationSummaryGenerate
+        description: Generates summary for a VideoCall, VoiceCall recording
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ConversationSummaryRepresentation
+      uriParameters:
+        conversationId:
+          type: string
+          required: true
+    /related/{id}:
+      get:
+        displayName: getConversationSummaryRelatedList
+        description: Returns a list of GenAIConversationSummary records
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ConversationSummaryListRepresentation
+      uriParameters:
+        id:
+          type: string
+          required: true
+  /transcript/{sfdcCallIdOrRecordingId}:
+    get:
+      displayName: getConversationTranscript
+      description: Returns preseigned URL for the Transcript content (as avro file)
+        for a given video call recording id or voice call id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConversationTranscriptRepresentation
+      queryParameters:
+        includeData:
+          type: boolean
+          required: false
+    uriParameters:
+      sfdcCallIdOrRecordingId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,67 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'eci'
+# 30 days
+(luvio.ttl): 2592000000
+
+types:
+  ConversationGenerativeInsightRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+  ConversationGenInsightListRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      id: recordId
+  ConversationSummaryRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      conversation_sumamry_id: id
+  ConversationSummaryListRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      id: id
+  ConversationTranscriptRepresentation:
+    (luvio.ttl): 2592000000
+  ConversationRealtimeMeetingInitiationResponseRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      id: botId
+  ConversationRealtimeEndMeetingResponseRepresentation:
+    (luvio.ttl): 60000 # 60 seconds
+    (luvio.key):
+      fakeKey: fakeKey
+
+/conversation:
+  /generative/insight/{id}:
+    get:
+      (luvio.adapter):
+        name: getConversationGenerativeInsight
+      (luvio.key):
+        id: urlParams.id
+  /realtime/insight/meeting:
+    /initiate:
+      post:
+        (luvio.adapter):
+          name: initiateMeeting
+    /terminate:
+      post:
+        (luvio.adapter):
+          name: terminateMeeting
+  /summary:
+    /ai/generate/{conversationId}:
+      post:
+        (luvio.adapter):
+          name: generateConversationSummary
+    /related/{id}:
+      get:
+        (luvio.adapter):
+          name: getConversationSummaryRelatedList
+        (luvio.key):
+          id: urlParams.id
+  /transcript/{sfdcCallIdOrRecordingId}:
+    get:
+      (luvio.adapter):
+        name: getTranscript