@salesforce/lds-adapters-service-milestones 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,131 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  BusinessHoursRepresentation:
+    description: Business Hours Description
+    type: object
+    properties:
+      endTime:
+        description: End time of the Business Hours
+        type: string | nil
+      startTime:
+        description: Start Time of the Business Hours
+        type: string | nil
+  MilestoneCompletedRepresentation:
+    description: Milestone Completed Description
+    type: object
+    properties:
+      milestoneId:
+        description: Id of the Milestone
+        type: string | nil
+      completed:
+        description: Completed Status of the Milestone
+        type: boolean | nil
+  MilestonesDataManagerRepresentation:
+    description: Milestone Data Manager Representation Description
+    type: object
+    properties:
+      actualTimeRemaining:
+        description: Get Actual Time Remaining
+        type: object
+        properties:
+          //:
+            type: string
+      milestoneAgreementTypeMap:
+        description: Milestone Agreement Type Map
+        type: object
+        properties:
+          //:
+            type: string
+      fields:
+        description: Get Fields
+        type: array
+        items:
+          type: string
+      ignoreBusinessHours:
+        description: Get Ignore Business Hours
+        type: boolean | nil
+      recordIds:
+        description: Get Record Ids
+        type: array
+        items:
+          type: string
+      slaExitDate:
+        description: Get Sla Exit Date
+        type: string | nil
+      stopStartDate:
+        description: Get Stop StartDate
+        type: string | nil
+      overdueMilestoneIgnoreBusinessHours:
+        description: Get Overdue Milestone Ignore Business Hours
+        type: boolean | nil
+/connect:
+  /milestones/business-hours:
+    get:
+      displayName: getBusinessHours
+      description: Information about business hours
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: BusinessHoursRepresentation
+      queryParameters:
+        businessHoursId:
+          type: string | nil
+          required: false
+        getNextDayBusinessHours:
+          type: boolean | nil
+          required: false
+  /milestones/milestone-completed:
+    put:
+      displayName: markMilestoneCompleted
+      description: Information about milestone completed
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MilestoneCompletedRepresentation
+      queryParameters:
+        milestoneId:
+          type: string | nil
+          required: false
+  /milestones/milestones-data-manager/{recordId}:
+    get:
+      displayName: getMilestonesDataManager
+      description: Information about Milestones Data Manager
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MilestonesDataManagerRepresentation
+    uriParameters:
+      recordId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,32 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Milestones'
+
+types:
+  BusinessHoursRepresentation:
+    (luvio.ttl): 100
+  MilestoneCompletedRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      requestId: milestoneId
+  MilestonesDataManagerRepresentation:
+    (luvio.ttl): 100
+
+/connect:
+  /milestones/business-hours:
+    get:
+      (luvio.adapter):
+        name: getBusinessHours
+  /milestones/milestone-completed:
+    put:
+      (luvio.adapter):
+        name: markMilestoneCompleted
+  /milestones/milestones-data-manager/{recordId}:
+    get:
+      (luvio.adapter):
+        name: getMilestonesDataManager