@salesforce/lds-adapters-industries-timeline 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,284 @@
+#%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:
+  TimelineDataGetResultRepresentation:
+    description: Output representation of Timeline Data from the GET Resource
+    type: object
+    properties:
+      errors:
+        description: TimelineData GET Resource List of Errors
+        type: array
+        items:
+          type: TimelineErrorRepresentation
+        required: false
+      eventTypes:
+        description: TimelineData GET Resource Event Types
+        type: array
+        items:
+          type: TimelineEventTypeRepresentation
+        required: false
+      events:
+        description: TimelineData GET Resource fetch all events
+        type: array
+        items:
+          type: TimelineEventRepresentation
+        required: false
+      hasMoreData:
+        description: TimelineData Get Resource - more Data to be fetched
+        type: boolean
+        required: false
+      isSuccess:
+        description: TimelineData get status flag
+        type: boolean
+        required: false
+  TimelineErrorRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      code:
+        description: Code for Error
+        type: string | nil
+      message:
+        description: Message Error
+        type: string | nil
+  TimelineEventFieldRepresentation:
+    description: Output representation of the Event Field that is returned as part
+      of the GET Timeline Data Result
+    type: object
+    properties:
+      name:
+        description: Event Field Name
+        type: string | nil
+      value:
+        description: Event Field Value
+        type: string | nil
+  TimelineEventRepresentation:
+    description: Output representation of the Event that is returned as part of the
+      GET Timeline Data Result
+    type: object
+    properties:
+      description:
+        description: Description of the Event Entity
+        type: string | nil
+      eventDateTime:
+        description: Date Time of the Event
+        type: string | nil
+      fields:
+        description: Fields of the Event
+        type: array
+        required: false
+        items:
+          type: TimelineEventFieldRepresentation
+      id:
+        description: Record Id
+        type: string | nil
+      title:
+        description: Title of the Event Entity
+        type: string | nil
+      type:
+        description: Event Entity Type
+        type: string | nil
+  TimelineEventTypeRepresentation:
+    description: Output representation of EventType that is returned as part of the
+      GET Timeline Data Result
+    type: object
+    properties:
+      eventApiName:
+        description: Event API Name
+        type: string | nil
+      offset:
+        description: Timeline Data Offset
+        type: integer | nil
+  TimelineMetadataResultRepresentation:
+    description: Output representation of Timeline Metadata from the GET Resource
+    type: object
+    properties:
+      definitions:
+        description: TimelineMetadata GET Resource fetch all definitions
+        type: array
+        required: false
+        items:
+          type: TimelineMetadataDefinitionRepresentation
+      errors:
+        description: TimelineMetadata GET Resource List of Errors
+        type: array
+        required: false
+        items:
+          type: TimelineErrorRepresentation
+      status:
+        description: TimelineMetadata get status
+        type: string | nil
+  TimelineMetadataDefinitionRepresentation:
+    description: Output representation of Timeline Metadata from the GET Resource
+    type: object
+    properties:
+      anchorObject:
+        description: TimelineMetadata Anchor Object
+        type: TimelineEntityRepresentation
+        required: false
+      fullName:
+        description: TimelineMetadata Configuration Name
+        type: string | nil
+      eventTypes:
+        description: TimelineMetadata GET Resource fetch all event objects
+        type: array
+        required: false
+        items:
+          type: TimelineEventTypeMetadataRepresentation
+      isActive:
+        description: TimelineMetadata active status flag
+        type: boolean
+        required: false
+      masterLabel:
+        description: TimelineMetadata Configuration Label
+        type: string | nil
+  TimelineEntityRepresentation:
+    description: Output representation of entity that is returned as part of the GET
+      Timeline metadata
+    type: object
+    properties:
+      ageField:
+        description: TimelineMetadata Age Field
+        type: string | nil
+      entityLabel:
+        description: EntityLabel
+        type: string | nil
+      entityName:
+        description: Entity Name
+        type: string | nil
+      icon:
+        description: Icon
+        type: string | nil
+      isAgeFieldSelected:
+        description: TimelineMetadata age field selected flag
+        type: boolean
+        required: false
+      source:
+        description: Source
+        type: string | nil
+  TimelineEventTypeMetadataRepresentation:
+    description: Output representation of Event Object that is returned as part of
+      the GET Timeline metadata
+    type: object
+    properties:
+      anchorReferenceField:
+        description: Event Object anchor Reference field
+        type: TimelineElementRepresentation
+        required: false
+      entityApiName:
+        description: Event Entity API Name
+        type: string | nil
+      entityLabel:
+        description: Event Entity Label Name
+        type: string | nil
+      fieldsToDisplay:
+        description: Event Object fieldsToDisplay List
+        type: array
+        required: false
+        items:
+          type: TimelineElementRepresentation
+      relatedlistsToDisplay:
+        description: Event Object relatedlistsToDisplay List
+        type: array
+        required: false
+        items:
+          type: TimelineElementRepresentation
+      relationType:
+        description: Event Object relation type
+        type: string | nil
+      sortField:
+        description: Event Object sort field
+        type: TimelineElementRepresentation
+        required: false
+      subTitle:
+        description: Event Object subTitle field
+        type: TimelineElementRepresentation
+        required: false
+      title:
+        description: Event Object title field
+        type: TimelineElementRepresentation
+        required: false
+  TimelineElementRepresentation:
+    description: Output representation of Fields/related Lists that is returned as
+      part of the GET Timeline metadata
+    type: object
+    properties:
+      apiName:
+        description: Element API Name
+        type: string | nil
+      dataType:
+        description: Element dataType Name
+        type: string | nil
+      label:
+        description: Element label Name
+        type: string | nil
+/connect/timeline:
+  /{timelineObjRecordId}/timeline-definitions/{timelineConfigFullName}/events:
+    get:
+      description: API to get Timeline data
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TimelineDataGetResultRepresentation
+      queryParameters:
+        direction:
+          type: string
+          required: false
+        endDate:
+          type: string
+          required: false
+        eventTypeOffsets:
+          type: string
+          required: false
+        eventTypes:
+          type: string
+          required: false
+        startDate:
+          type: string
+          required: false
+    uriParameters:
+      timelineConfigFullName:
+        type: string
+        required: true
+      timelineObjRecordId:
+        type: string
+        required: true
+  /metadata/configurations:
+    get:
+      description: API to get Timeline metadata
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TimelineMetadataResultRepresentation
+      queryParameters:
+        fullNames:
+          type: string[]
+          required: false

package/src/raml/luvio.raml

@@ -0,0 +1,109 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Timeline'
+(luvio.ttl): 360000
+
+types:
+  TimelineDataGetResultRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 500
+    examples:
+      validResponse: !include ../wire/getTimelineData/__karma__/data/TimelineEventsResponse.json
+      emptyResponse: !include ../wire/getTimelineData/__karma__/data/TimelineEventsEmptyResponse.json
+  TimelineMetadataResultRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 500
+    examples:
+      validMetadataResponse: !include ../wire/getTimelineMetadata/__karma__/data/TimelineMetadataResponse.json
+
+/connect/timeline:
+  /{timelineObjRecordId}/timeline-definitions/{timelineConfigFullName}/events:
+    get:
+      (luvio.adapter):
+        name: getTimelineData
+        tests:
+          validConfigs:
+            - |
+              {
+                "timelineObjRecordId": "0DMR00000000gKcOAI",
+                "timelineConfigFullName": "HealthTimeline",
+                "direction": "prev",
+                "endDate": "2025-10-08T01:02:03Z",
+                "startDate": "2021-10-08T01:02:03Z"
+              }
+            - |
+              {
+                "timelineObjRecordId": "0DMR00000000gKcOAI",
+                "timelineConfigFullName": "HealthTimeline",
+                "eventTypeOffsets": "5",
+                "endDate": "2025-10-08T01:02:03Z",
+                "startDate": "2021-10-08T01:02:03Z"
+              }
+            - |
+              {
+                "timelineObjRecordId": "0DMR00000000gKcOAI",
+                "timelineConfigFullName": "HealthTimeline"
+              }
+          invalidConfigs:
+            - |
+              {}
+            - |
+              {
+                "timelineObjRecordId": 1234567890
+              }
+            - |
+              {
+                "direction": "prev",
+                "endDate": "2025-10-08T01:02:03Z",
+                "eventTypeOffsets": "5",
+                "eventTypes": "Case",
+                "startDate": "2021-10-08T01:02:03Z"
+              }
+      queryParameters:
+        direction:
+          examples:
+            validResponse: 'next'
+            emptyResponse: 'up'
+        endDate:
+          examples:
+            validResponse: '2025-10-08T01:02:03Z'
+            emptyResponse: '2025-10-08T01:02:03Z'
+        eventTypeOffsets:
+          examples:
+            validResponse: '5'
+            emptyResponse: '5'
+        eventTypes:
+          examples:
+            validResponse: 'Case'
+            emptyResponse: 'Case'
+        startDate:
+          examples:
+            validResponse: '2022-10-08T01:02:03Z'
+            emptyResponse: '2022-10-08T01:02:03Z'
+    uriParameters:
+      timelineConfigFullName:
+        examples:
+          validResponse: 'HealthTimeline'
+          emptyResponse: 'HealthTimeline'
+      timelineObjRecordId:
+        examples:
+          validResponse: '0DMR00000000gKcOAI'
+          emptyResponse: '0DMR00000000gKcOAI'
+  /metadata/configurations:
+    get:
+      (luvio.adapter):
+        name: getTimelineMetadata
+        tests:
+          validConfigs:
+            - |
+              {
+                "fullNames": ["AccountTimeline"]
+              }
+      queryParameters:
+        fullNames:
+          examples:
+            validMetadataResponse: ['AccountTimeline', 'CaseTimeline']