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

package/src/raml/api.raml

@@ -0,0 +1,131 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  OnDemandComputationResponseRepresentation:
+    description: OnDemand Computation Response Representation
+    type: object
+    properties:
+      enablementProgramId:
+        description: Record Id of Enablement Program for which computation is being
+          triggered
+        type: string
+  MilestoneProgressContributingRecordsRepresentation:
+    description: MilestoneProgress Contributing Records Output Representation
+    type: object
+    properties:
+      aggregationField:
+        description: Aggregation Field
+        type: ContributingRecordFieldInfoRepresentation
+      aggregationType:
+        description: Indicates milestone aggregation type
+        type: string
+        enum:
+          - Average
+          - Count
+          - Sum
+      dateFilterField:
+        description: Date Filter Field
+        type: ContributingRecordFieldInfoRepresentation
+      displayField:
+        description: Display Field
+        type: ContributingRecordFieldInfoRepresentation
+      inaccessibleRecordCount:
+        description: Inaccessible Contributing records count
+        type: integer
+      measureName:
+        description: Measure Name
+        type: string
+      records:
+        description: Contributing records
+        type: array
+        items:
+          type: ContributingRecordFieldsValueRepresentation
+      sourceObjectApiName:
+        description: Source Object on which the measure is defined
+        type: string
+      taskMeasureProgressId:
+        description: Task measure progress id
+        type: string
+  ContributingRecordFieldsValueRepresentation:
+    description: MilestoneProgress Contributing Record Fields Output Representation
+    type: object
+    properties:
+      aggregationFieldValue:
+        description: Aggregation field value
+        type: string | nil
+      dateFilterFieldValue:
+        description: Date filter field value
+        type: string | nil
+      displayFieldValue:
+        description: Display field value
+        type: string | nil
+      recordId:
+        description: Contributing record id
+        type: string
+  ContributingRecordFieldInfoRepresentation:
+    description: Contributing Record Field Info Representation.
+    type: object
+    properties:
+      apiName:
+        description: Field Api Name
+        type: string | nil
+      label:
+        description: Field Label
+        type: string | nil
+      dataType:
+        description: Data type of field
+        type: string | nil
+/connect:
+  /enablement:
+    /on-demand-computation/programs/{programId}:
+      patch:
+        displayName: patchOnDemandComputation
+        description: HTTP Patch method to for triggering on demand computation for a given program
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: OnDemandComputationResponseRepresentation
+      uriParameters:
+        programId:
+          type: string
+          required: true
+    /contributing-records/taskMeasureProgress/{taskMeasureProgressId}:
+      get:
+        displayName: getMilestoneContributingRecordsInfo
+        description: HTTP GET method to fetch contributing records' info for given milestone progress
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: MilestoneProgressContributingRecordsRepresentation
+      uriParameters:
+        taskMeasureProgressId:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,26 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'EnablementMeasureConnectFamily'
+
+types:
+  OnDemandComputationResponseRepresentation:
+    (luvio.ttl): 5000 # 5 seconds
+    (luvio.key):
+      enablementProgramId: enablementProgramId
+
+  MilestoneProgressContributingRecordsRepresentation:
+    (luvio.ttl): 5000 # 5 seconds
+
+/connect/enablement:
+  /on-demand-computation/programs/{programId}:
+    patch:
+      (luvio.adapter):
+        name: triggerOnDemandComputation
+  /contributing-records/taskMeasureProgress/{taskMeasureProgressId}:
+    get:
+      (luvio.adapter):
+        name: getContributingRecordsInfoForMilestone