@salesforce/lds-adapters-industries-eri 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,173 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  DigestNotification:
+    description: Digest notification
+    type: object
+    properties:
+      fields:
+        description: Display fields in the notification
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: string
+      id:
+        description: Unique id of the notification in the digest
+        type: string
+      name:
+        description: Record Name referenced in this notification
+        type: string
+      navigationLink:
+        description: Navigation Url
+        type: string
+      recordId:
+        description: Record id referenced in this notification
+        type: string
+      recordTypeId:
+        description: Record id type referenced in this notification
+        type: string
+        required: false
+      sobjectType:
+        description: Sobject Type of the record referenced in this notification
+        type: string
+      sobjectTypeLabel:
+        description: Sobject type label of the record referenced in this notification
+        type: string
+      timeStamp:
+        description: Time when this relationship is found
+        type: string
+      read:
+        description: true if the notification is read by the user
+        type: boolean
+        required: false
+      type:
+        description: Notificatio type
+        type: string
+        enum:
+          - JobChangeNotification
+          - RelationNotification
+          - NewsNotification
+  FollowingInfoInputRepresentation:
+    description: An Input Representation following object
+    type: object
+    properties:
+      filterTypes:
+        description: List of sObjectTypes used in home page mappings
+        type: array
+        required: false
+        items:
+          type: string
+      page:
+        description: 'Page number of the eri relationship digest list '
+        type: integer
+        required: false
+      recordIds:
+        description: List of RecordIds being followed by the user
+        type: array
+        required: false
+        items:
+          type: string
+      hasNext:
+        description: true if there any more recordIds to be queried for notifications else false
+        type: boolean
+        required: false
+      demo:
+        description: true for demo reponse else false
+        type: boolean
+        required: false
+  ERIDigestInputRepresentation:
+    description: An Input Representation for ERI digest
+    type: object
+    properties:
+      following:
+        type: FollowingInfoInputRepresentation
+        description: following input
+  ERIDigestInputRepresentationWrapper:
+    description: Wrapper for ERI digest input representation
+    type: object
+    properties:
+      eriDigestInput:
+        type: ERIDigestInputRepresentation
+        description: ERI Digest input represenation
+  ERIDigestOutputRepresentation:
+    description: Output representation of a ERI  Digest
+    type: object
+    properties:
+      errorMsg:
+        description: Error message
+        type: string
+        required: false
+      following:
+        description: User following records info
+        type: FollowingInfo
+        required: false
+      notifications:
+        description: Notifications list
+        type: array
+        required: false
+        items:
+          type: DigestNotification
+      requestSucceeded:
+        description: true if request is succeeded else false
+        type: boolean
+      statusCode:
+        description: Status code
+        type: string
+  FollowingInfo:
+    description: following info
+    type: object
+    properties:
+      filterTypes:
+        description: List of sObjectTypes used in home page mappings
+        type: array
+        items:
+          type: string
+      page:
+        description: 'Page number of the eri  digest '
+        type: integer
+      recordIds:
+        description: List of RecordIds being followed by the user
+        type: array
+        items:
+          type: string
+
+/connect:
+  /eri/digest:
+    post:
+      description: API to get relationship digest in ERI
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ERIDigestOutputRepresentation
+      body:
+        application/json:
+          type: ERIDigestInputRepresentationWrapper
+          (oas-body-name): eriDigestInput

package/src/raml/luvio.raml

@@ -0,0 +1,22 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'eri'
+(luvio.ttl): 1000
+
+types:
+  DigestNotification:
+    (luvio.opaque): true
+  ERIDigestOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: requestSucceeded
+
+/connect/eri/digest:
+  post:
+    (luvio.adapter):
+      name: getERIDigest