@salesforce/lds-adapters-industries-timeline 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,611 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  EngagementEventTimelineDataRepresentation:
+    description: Output representation of engagement events to be displayed on the
+      timeline component
+    type: object
+    properties:
+      errors:
+        description: List of errors
+        type: array
+        items:
+          type: TimelineErrorRepresentation
+      eventTypes:
+        description: Type of events fetched
+        type: array
+        items:
+          type: TimelineEventTypeRepresentation
+      events:
+        description: List containing data of all events fetched.
+        type: array
+        items:
+          type: TimelineDataCloudEventRepresentation
+      isSuccess:
+        description: status flag
+        type: boolean
+  CdpMetadataOutputRepresentation:
+    description: Output representation to fetch all engagement dmos
+    type: object
+    properties:
+      dmos:
+        description: get all dmos
+        type: array
+        items:
+          type: DmoOutputRepresentation
+  DGObjectOutputRepresentation:
+    description: Output representation of DMO node in Datagraph
+    type: object
+    properties:
+      category:
+        description: get category
+        type: string
+      displayName:
+        description: get dmo display name
+        type: string
+      developerName:
+        description: get developer name
+        type: string
+      fields:
+        description: get fields
+        type: array
+        items:
+          type: any
+      filterCriteria:
+        description: get filter criteria
+        type: string
+        required: false
+      memberDmoName:
+        description: get member dmo name
+        type: string
+      paths:
+        description: get paths
+        type: array
+        items:
+          type: any
+      recencyCriteria:
+        description: get recency criteria
+        type: array
+        items:
+          type: any
+      relatedObjects:
+        description: get related objects
+        type: array
+        items:
+          type: DGObjectOutputRepresentation
+      type:
+        description: get creation type
+        type: string
+  DataGraphMetadataRepresentation:
+    description: Output representation to fetch all datagraphs and their metadata.
+    type: object
+    properties:
+      dataGraphMetadata:
+        description: get all datagraphs
+        type: array
+        items:
+          type: DataGraphOutputRepresentation
+  DataGraphOutputRepresentation:
+    description: Output representation of a single datagraph
+    type: object
+    properties:
+      dataspaceName:
+        description: get dataspace name
+        type: string
+      description:
+        description: get description of a datagraph
+        type: string
+        required: false
+      developerName:
+        description: get developer name
+        type: string
+      dgObject:
+        description: get data graph object
+        type: DGObjectOutputRepresentation
+      idDmoName:
+        description: get id dmo name
+        type: string
+      primaryObjectName:
+        description: get primary dmo name
+        type: string
+      valuesDmoName:
+        description: get value dmo name
+        type: string
+      version:
+        description: get version
+        type: string
+      displayName:
+        description: get display name
+        type: string
+  DmoFieldsOutputRepresentation:
+    description: Output representation of each field of DMO
+    type: object
+    properties:
+      displayName:
+        description: get display name of a dmo
+        type: string
+      name:
+        description: get name of a dmo
+        type: string
+      type:
+        description: get type of fields
+        type: string
+  DmoOutputRepresentation:
+    description: Output representation of each dmo
+    type: object
+    properties:
+      category:
+        description: get category of a dmo
+        type: string
+      displayName:
+        description: get display name of a dmo
+        type: string
+      fields:
+        description: get all fields of a dmo
+        type: array
+        items:
+          type: DmoFieldsOutputRepresentation
+      name:
+        description: get name of a dmo
+        type: string
+      referenceModelEntityDeveloperName:
+        description: get reference model entity developer name of a dmo
+        type: string
+      relationships:
+        description: get all relationships of a dmo
+        type: array
+        items:
+          type: DmoRelationshipsOutputRepresentation
+  DmoRelationshipsOutputRepresentation:
+    description: Output representation of relationships for a DMO
+    type: object
+    properties:
+      fromEntity:
+        description: 'get fromEntity in relationship '
+        type: RelationshipTypeOutputRepresentation
+      toEntity:
+        description: 'get toEntity in relationship '
+        type: RelationshipTypeOutputRepresentation
+  EngagementEventsRelatedListFieldsRepresentation:
+    description: 'Output representation of FIELDS of Related List of Engagement Events '
+    type: object
+    properties:
+      label:
+        description: label of the field
+        type: string
+      type:
+        description: data type of the field
+        type: string
+      value:
+        description: value of the field
+        type: string
+  EngagementEventsRelatedListRecordsRepresentation:
+    description: 'Output representation of RECORDS of Related List of Engagement Events '
+    type: object
+    properties:
+      fields:
+        description: 'list of fields for a record '
+        type: array
+        items:
+          type: EngagementEventsRelatedListFieldsRepresentation
+  PathToDmoRepresentation:
+    description: Output representation for the Path of DMO
+    type: object
+    properties:
+      dmoName:
+        description: 'name of the DMO '
+        type: string
+      pathToDmoRepresentation:
+        description: 'path to DMO in JSON '
+        type: PathToDmoRepresentation
+        required: false
+  RelationshipTypeOutputRepresentation:
+    description: Output representation of relationship type
+    type: object
+    properties:
+      attribute:
+        description: 'get attribute of the entity in Relationship '
+        type: string
+      name:
+        description: 'get name of the entity in Relationship '
+        type: string
+  TimelineDataCloudEventRepresentation:
+    description: Output representation of the Data Cloud Events
+    type: object
+    properties:
+      description:
+        description: Description of the Event Entity
+        type: string
+        required: false
+      eventDateTime:
+        description: Date Time of the Event
+        type: string
+      fields:
+        description: Fields of the Event
+        type: array
+        items:
+          type: TimelineEventFieldRepresentation
+      id:
+        description: Record Id
+        type: string
+        required: false
+      relatedListEvents:
+        description: list of related Lists data
+        type: array
+        required: false
+        items:
+          type: TimelineEngagementRelatedListEventsRepresentation
+      title:
+        description: Title of the Event Entity
+        type: string
+      type:
+        description: Event Entity Type
+        type: string
+  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
+      isCreatable:
+        description: Whether Event Entity is creatable
+        type: boolean
+        required: false
+      additionalEventData:
+        description: Event Entity Additional Data
+        type: any
+        required: false
+      allowNew:
+        description: Event Entity allowNew boolean
+        type: boolean
+        required: false
+      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
+      summaryField:
+        description: Event Entity Summary 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
+  TimelineEngagementRelatedListEventsRepresentation:
+    description: Output representation of RELATED LISTS for Engagement Events
+    type: object
+    properties:
+      nameOfDmo:
+        description: 'name of the Related List DMO '
+        type: string
+      pathToDmo:
+        description: path till the Related List DMO
+        type: PathToDmoRepresentation
+      records:
+        description: list of records of Related List
+        type: array
+        items:
+          type: EngagementEventsRelatedListRecordsRepresentation
+/connect/timeline:
+  /{timelineObjRecordId}/timeline-definitions/{timelineConfigFullName}:
+    /cust-data-pfrm/events:
+      get:
+        description: API to get engagement events data to display on timeline component.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EngagementEventTimelineDataRepresentation
+        queryParameters:
+          dataCloudEventSource:
+            type: string
+            required: false
+      uriParameters:
+        timelineConfigFullName:
+          type: string
+          required: true
+        timelineObjRecordId:
+          type: string
+          required: true
+    /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
+  /cust-data-pfrm:
+    /data-graph-metadata:
+      get:
+        displayName: getTimelineGetDataGraphMetadata
+        description: Retrieve data graphs and their metadata, which are built within
+          a data space.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DataGraphMetadataRepresentation
+        queryParameters:
+          dataSpaceApiName:
+            description: The API name of the data space that contains the data graphs
+              to be fetched.
+            type: string
+            required: false
+    /data-model-objects:
+      get:
+        displayName: getTimelineGetCDPMetadata
+        description: Gets data model objects from Data Cloud.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMetadataOutputRepresentation
+        queryParameters:
+          dataSpaceApiName:
+            type: string
+            required: false
+          objectCategory:
+            type: string
+            required: false
+  /metadata/configurations:
+    get:
+      description: API to get Timeline metadata
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TimelineMetadataResultRepresentation
+      queryParameters:
+        fullNames:
+          type: string[]
+          required: false