@salesforce/lds-adapters-platform-enablement 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,357 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.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:
+  EnablementProgramSelfEnrollmentRepresentation:
+    description: Enablement Program Self-Enrollment Output Representation
+    type: object
+    properties:
+      learningItemAssignmentId:
+        description: Record Id of LearningItemAssignment
+        type: string
+  EnablementProgramSelfUnenrollmentRepresentation:
+    description: Enablement Program Self-Unenrollment Output Representation
+    type: object
+  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:
+          - Milestone
+          - 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
+  EnablementProgramSummaryMeasureRepresentation:
+    description: Measure Representation
+    type: object
+    properties:
+      aggregationType:
+        description: Indicates milestone aggregation type
+        type: string
+        enum:
+          - Average
+          - Count
+          - Sum
+      measureId:
+        description: Id of the enablement program summary measure
+        type: string
+  EnablementProgramSummaryMilestoneRepresentation:
+    description: Runtime representation of enablement program milestone.
+    discriminatorValue: Milestone
+    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
+      compositeMilestoneType:
+        description: Indicates composite milestone type
+        type: string | nil
+        enum:
+          - Addition
+          - Division
+          - Percentage
+      contributingRecordCount:
+        description: The total contributing record count
+        type: integer | nil
+      dueDate:
+        description: Due date for the current assignment
+        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
+      measures:
+        description: Indicates measure details
+        type: array
+        items:
+          type: EnablementProgramSummaryMeasureRepresentation
+      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
+      progressStatus:
+        description: Indicates milestone progress status
+        type: string | nil
+        enum:
+          - Behind
+          - CompletedLate
+          - CompletedOnTime
+          - NoLongerTracking
+          - NotCompleted
+          - Overdue
+  EnablementProgramSummaryRepresentation:
+    description: Enablement Program Summary Representation
+    type: object
+    properties:
+      description:
+        description: Description of the enablement program
+        type: string | nil
+      doesAllowSelfEnrollment:
+        description: Does the program allow self enrollment
+        type: boolean
+      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: EnablementProgramSummaryMilestoneRepresentation | 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
+      dueDate:
+        description: Due date for the current assignment
+        type: string | 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
+      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:
+  /communities/{communityId}/enablement/program/summary:
+    /collection:
+      get:
+        description: Enablement Program Summary Collection
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EnablementProgramSummaryListRepresentation
+        queryParameters:
+          filter:
+            type: string
+            required: false
+            enum:
+              - All
+              - Assigned
+              - AvailableForSelfEnrollment
+              - Completed
+              - InProgress
+              - SelfEnrolled
+          limit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          collectionKey:
+            type: string
+            required: false
+      uriParameters:
+        communityId:
+          type: string
+          required: true
+  /enablement:
+    /program:
+      /summary:
+        /collection:
+          get:
+            description: Enablement Program Summary Collection
+            responses:
+              '200':
+                description: Success
+                body:
+                  application/json:
+                    type: EnablementProgramSummaryListRepresentation
+            queryParameters:
+              filter:
+                type: string
+                required: false
+                enum:
+                  - All
+                  - Assigned
+                  - AvailableForSelfEnrollment
+                  - Completed
+                  - InProgress
+                  - SelfEnrolled
+              limit:
+                type: integer
+                required: false
+              offset:
+                type: integer
+                required: false
+              collectionKey:
+                type: string
+                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
+      /{enablementProgramId}:
+        /actions:
+          /enroll:
+            post:
+              displayName: postEnablementProgramSelfEnrollment
+              description: Self Enrolls user into a program
+              responses:
+                '200':
+                  description: Success
+                  body:
+                    application/json:
+                      type: EnablementProgramSelfEnrollmentRepresentation
+            uriParameters:
+              enablementProgramId:
+                type: string
+                required: true
+          /unenroll:
+            post:
+              displayName: postEnablementProgramSelfUnenrollment
+              description: Self Unenrolls user into a program
+              responses:
+                '200': # This never gets used. Unenroll endpoint always responds with 204 and an empty payload. But for post we need 200 response handler and can't have just 204 handler
+                  description: Success
+                  body:
+                    application/json:
+                      type: EnablementProgramSelfEnrollmentRepresentation
+                '204':
+                  description: Success
+                  body:
+                    application/json:
+                      type: EnablementProgramSelfUnenrollmentRepresentation
+            uriParameters:
+              enablementProgramId:
+                type: string
+                required: true

package/src/raml/luvio.raml

@@ -0,0 +1,53 @@
+#%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
+    (luvio.updateAvailable):
+      name: notifyEnablementProgramSummaryUpdateAvailable
+      parameters:
+        enablement_program_id: id
+  EnablementProgramSummaryListRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+  EnablementProgramSelfEnrollmentRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      learning_item_assignment_id: learningItemAssignmentId
+  EnablementProgramSelfUnenrollmentRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+
+/connect:
+  /communities/{communityId}/enablement/program/summary/collection:
+    get:
+      (luvio.adapter):
+        name: getProgramSummaryCollectionForCommunity
+  /enablement:
+    /program:
+      /summary/{enablementProgramId}:
+        get:
+          (luvio.adapter):
+            name: getEnablementProgramSummary
+          (luvio.key):
+            enablement_program_id: urlParams.enablementProgramId
+      /summary/collection:
+        get:
+          (luvio.adapter):
+            name: getProgramSummaryCollection
+      /{enablementProgramId}/actions:
+        /enroll:
+          post:
+            (luvio.adapter):
+              name: selfEnrollInEnablementProgram
+        /unenroll:
+          post:
+            (luvio.adapter):
+              name: unenrollFromEnablementProgram