@salesforce/lds-adapters-platform-enablement 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,207 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.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:
+  EnablementProgramSummaryItemRepresentation:
+    description: Common Enablement Program Summary item representation
+    discriminator: type
+    type: object
+    properties:
+      description:
+        description: Description of the enablement program summary item
+        type: string
+      id:
+        description: Id of the enablement program summary item
+        type: string
+      sequenceNumber:
+        description: Sequence Number of the enablement task
+        type: integer
+      title:
+        description: Title of the enablement program summary item
+        type: string
+      type:
+        description: Type of enablement program summary item
+        type: string
+        enum:
+          - Section
+          - Task
+  EnablementProgramSummaryListRepresentation:
+    description: List of Enablement Program Summary Representations
+    type: object
+    properties:
+      hasMore:
+        description: Indicates if there are more programs available than the results returned
+        type: boolean
+      programSummaryList:
+        description: List of enablement program summaries
+        type: array
+        items:
+          type: EnablementProgramSummaryRepresentation
+  EnablementProgramSummaryRepresentation:
+    description: Enablement Program Summary Representation
+    type: object
+    properties:
+      description:
+        description: Description of the enablement program
+        type: string | nil
+      dueDate:
+        description: Due date for enablement program.
+        type: string | nil
+      id:
+        description: Id of the enablement program
+        type: string | nil
+      items:
+        description: List of items for the enablement program
+        type: array
+        items:
+          # type: EnablementProgramSummaryItemRepresentation
+          type: any # TODO Hand-rolled W-10668851
+      learningItemId:
+        description: Learning Item Id of the enablement program
+        type: string | nil
+      outcome:
+        description: Outcome of the enablement program
+        type: EnablementProgramSummaryTaskRepresentation | nil # TODO Hand-rolled W-7093257
+      status:
+        description: Status of the enablement program
+        type: string
+        enum:
+          - Archived
+          - Draft
+          - Published
+      systemModStamp:
+        description: System modification timestamp of the enablement program
+        type: string | nil
+        required: false
+      title:
+        description: Name of the enablement program
+        type: string | nil
+  EnablementProgramSummarySectionRepresentation:
+    description: Runtime representation of enablement program section.
+    discriminatorValue: Section
+    type: EnablementProgramSummaryItemRepresentation
+    properties:
+      tasks:
+        description: List of tasks for the enablement program section
+        type: array
+        items:
+          type: EnablementProgramSummaryTaskRepresentation
+  EnablementProgramSummaryTaskRepresentation:
+    description: Runtime representation of enablement program task.
+    discriminatorValue: Task
+    type: EnablementProgramSummaryItemRepresentation
+    properties:
+      completedDate:
+        description: The date the item was completed
+        type: string | nil
+      completedPercent:
+        description: Percent complete for the current user
+        #format: double # Hand-rolled format not allowed with union type
+        type: number | nil
+      contributingRecordCount:
+        description: The total contributing record count
+        type: integer | nil
+      dueDate:
+        description: Due date for the current assignment
+        type: string | nil
+      enablementProgramSectionId:
+        description: Program Section Id of the enablement task
+        type: string | nil
+      isCompleted:
+        description: Indicates if the item is complete or not
+        type: boolean | nil
+      isOverdue:
+        description: Indicates if the item is overdue or not
+        type: boolean | nil
+      learningItemId:
+        description: Learning Item Id of the enablement task
+        type: string | nil
+      milestoneResult:
+        description: The result value of if the task is of measure type
+        #format: double # Hand-rolled format not allowed with union type
+        type: number | nil
+      milestoneTarget:
+        description: Milestone Target of the enablement task
+        #format: double # Hand-rolled format not allowed with union type
+        type: number | nil
+      minimumSampleSize:
+        description: The minimum sample record size
+        type: integer | nil
+      programDay:
+        description: The day the program task is due
+        type: integer
+      taskCategory:
+        description: Category Type of the enablement task
+        type: string
+        enum:
+          - Exercise
+          - Milestone
+      taskSubCategory:
+        description: Sub Category Type of the enablement task
+        type: string
+        enum:
+          - AudioRecording
+          - Document
+          - Other
+          - OtherExercise
+          - ScheduledEvent
+          - TextLesson
+          - Trailhead
+          - Video
+/connect/enablement:
+  /program:
+    /summary:
+      /assigned:
+        get:
+          description: Assigned Enablement Program Summary
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: EnablementProgramSummaryListRepresentation
+          queryParameters:
+            limit:
+              type: integer
+              required: false
+      /{enablementProgramId}:
+        get:
+          description: Enablement Program Summary
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: EnablementProgramSummaryRepresentation
+          queryParameters:
+            includeProgress:
+              type: boolean
+              required: false
+              default: true
+        uriParameters:
+          enablementProgramId:
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,27 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'enablement'
+(luvio.ttl): 15000
+
+types:
+  EnablementProgramSummaryRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      enablement_program_id: id
+
+/connect/enablement:
+  /program:
+    /summary/{enablementProgramId}:
+      get:
+        (luvio.adapter):
+          name: getEnablementProgramSummary
+        (luvio.key):
+          enablement_program_id: urlParams.enablementProgramId
+    /summary/assigned:
+      get:
+        (luvio.adapter):
+          name: getAssignedEnablementProgramSummary