@salesforce/lds-adapters-platform-learning-content 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,773 @@
+#%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:
+  FeaturedItemRecommendedListRepresentation:
+    description: This representation defines a list of recommended items in the side
+      panel home page
+    type: object
+    properties:
+      recommendedList:
+        description: returns recommended list
+        type: array
+        items:
+          type: FeaturedItemRepresentation
+  FeaturedItemRelatedListRepresentation:
+    description: This representation defines a list of related items in the side panel
+      home page
+    type: object
+    properties:
+      relatedList:
+        description: returns related list
+        type: array
+        items:
+          type: FeaturedItemRepresentation
+  FeaturedItemRepresentation:
+    description: This representation will be used to show featured items(recommended
+      & related) in the Side Panel Home Page
+    type: object
+    properties:
+      availablePointCount:
+        description: the total points possible for the LearningContent
+        type: integer | nil
+      completedDate:
+        description: the completedDate for the LearningItem for the end user at runtime
+        type: string | nil
+      completedItemCount:
+        description: Returns the number of LearningContentItems completed by the current
+          user
+        type: integer | nil
+      completedPercent:
+        description: The completion percentage of the learning unit as a whole integer,
+        type: integer | nil
+      description:
+        description: Description for the side panel item
+        type: string
+      dueDate:
+        description: the dueDate for the FeaturedItem for the end user at runtime
+        type: string | nil
+      earnedPointCount:
+        description: the number of points earned by the user for this LearningContent
+        type: integer | nil
+      iconName:
+        description: SLDS icon name
+        type: string
+      id:
+        description: Defines a uniques identifier across different content types
+        type: string
+      imageUrl:
+        description: Specifies the image url in a FeaturedItem
+        type: string | nil
+      isCompleted:
+        description: If the end-user completed the learningItem
+        type: boolean | nil
+      isCuratedContent:
+        description: if this content was curated by SFDC, instead of being assembled
+          by a learning admin.
+        type: boolean | nil
+      itemCount:
+        description: Returns the number of LearningContentItems associated with this
+          FeaturedItem
+        type: integer | nil
+      minutesRemainingCount:
+        description: the number of minutes remaining for the user to complete this
+          LearningContent
+        type: integer | nil
+      relatedId:
+        description: Id for the entity backing the learning unit, E.g. this would
+          return the Id for a Trailhead module if this was a Trailhead unit, or the
+          Id for a LearningLink if this was a link to outside content
+        type: string | nil
+      title:
+        description: The localized title for the side panel item
+        type: string
+      totalMinutesCount:
+        description: the total time in minutes for the LearningContent
+        type: integer | nil
+      type:
+        description: Specifies different Content Types that will be in the side panel
+          home page.
+        type: string
+      url:
+        description: Specifies a URL in a FeaturedItem
+        type: string | nil
+  LearningAssignmentInputRepresentation:
+    description: This representation defines a method of inputting a LearningAssignment
+      representation
+    type: object
+    properties:
+      assignedCount:
+        description: Input AssignedCount for LearningAssignment
+        type: integer
+      assigneeId:
+        description: Input AssigneeId for LearningAssignment
+        type: string
+      assigneeName:
+        description: Input AssigneeName for LearningAssignment
+        type: string
+      assigneeType:
+        description: Input AssigneeType for LearningAssignment
+        type: string
+      assignmentDate:
+        description: Input AssignmentDate for LearningAssignment
+        type: string
+      completedCount:
+        description: Input CompletedCount for LearningAssignment
+        type: integer
+      completedPercent:
+        description: Input CompletedPercent for LearningAssignment
+        type: integer
+      daysUntilDueDate:
+        description: Input DaysUntilDueDate for LearningAssignment
+        type: integer
+      dueDate:
+        description: Input due date for LearningAssignment
+        type: string
+      id:
+        description: Input id for LearningAssignment
+        type: string
+      learningItemId:
+        description: Input LearningItemId for LearningAssignment
+        type: string
+  LearningAssignmentRepresentation:
+    description: This representation will be used to show featured items(recommended
+      & related) in the Side Panel Home Page
+    type: object
+    properties:
+      assignedCount:
+        description: Id of the LearningAssignment
+        type: integer | nil
+      assigneeId:
+        description: Assignee Id associated with the LearningAssignment
+        type: string | nil
+      assigneeName:
+        description: Assignee name associated with the LearningAssignment
+        type: string | nil
+      assigneeType:
+        description: AssigneeType of the LearningAssignment
+        type: string | nil
+      assignmentDate:
+        description: Assignment date of the LearningAssignment
+        type: string | nil
+      completedCount:
+        description: Completed count of the LearningAssignment
+        type: integer | nil
+      completedPercent:
+        description: Completed percent of the LearningAssignment
+        type: integer | nil
+      daysUntilDueDate:
+        description: Days until the due date for the LearningAssignment
+        type: integer | nil
+      dueDate:
+        description: Due date of the LearningAssignment
+        type: string | nil
+      id:
+        description: Id of the LearningAssignment
+        type: string
+      learningItemId:
+        description: LearningItemId of the LearningAssignment
+        type: string
+  LearningConfigRepresentation:
+    description: This representation will be used to return config for Learning Paths
+    type: object
+    properties:
+      hasElevatedLearningAccess:
+        description: defines if user manage learning items
+        type: boolean
+      maxLearningAssignmentsAllowed:
+        description: defines max learning assignments allowed
+        type: integer
+      maxLearningItemsAllowed:
+        description: defines max learning items allowed
+        type: integer
+  LearningItemAssignmentRepresentation:
+    description: This representation is for LearningItemAssignment types returned
+      for LearningModelOutputRepresentation
+    type: object
+    properties:
+      assigneeId:
+        description: Assignee Id associated with the LearningAssignment
+        type: string | nil
+      assigneeName:
+        description: Assignee name associated with the LearningAssignment
+        type: string | nil
+      assigneeType:
+        description: AssigneeType of the LearningAssignment
+        type: string | nil
+      assignmentDate:
+        description: Assignment date of the LearningAssignment
+        type: string | nil
+      completedDate:
+        description: Assignment date of the LearningAssignment
+        type: string | nil
+      dueDate:
+        description: Due date of the LearningAssignment
+        type: string | nil
+      id:
+        description: Id of the LearningItemAssignment
+        type: string
+      learningItemId:
+        description: LearningItemId of the LearningItemAssignment
+        type: string
+      startDate:
+        description: Assignment date of the LearningAssignment
+        type: string | nil
+  LearningItemListRepresentation:
+    description: This representation defines a list of LearningItemRepresentation
+      entities
+    type: object
+    properties:
+      list:
+        description: returns the list of LearningItemRepresentation objects
+        type: array
+        items:
+          type: LearningItemRepresentation
+  LearningItemProgressListRepresentation:
+    description: This representation defines a list of LearningItemProgressRepresentation
+      entities
+    type: object
+    properties:
+      list:
+        description: returns the list of LearningItemProgressRepresentation objects
+        type: array
+        items:
+          type: LearningItemProgressRepresentation
+  LearningItemProgressRepresentation:
+    description: Learning Item Progress Representation
+    type: object
+    properties:
+      completedDate:
+        description: Completed date of the learning item progress
+        type: string | nil
+      completedPercent:
+        description: Completed percent of the learning item progress
+        #format: double # Hand-rolled format not allowed with union type
+        type: number | nil
+      isCompleted:
+        description: Completed state of the learning item progress
+        type: boolean
+      learningItemId:
+        description: Id of the learning item associated with this learning item progress
+        type: string
+  LearningItemRepresentation:
+    description: This representation maps to the LearningListItem class and is used
+      to represent LearningItem information
+    type: object
+    properties:
+      completionRate:
+        description: Specifies the given completion rate for the LearningItem
+        format: double
+        type: number
+      contentType:
+        description: Specifies the given content type for the LearningItem
+        type: string | nil
+      createdBy:
+        description: Specifies the given createdBy field for the LearningItem
+        type: string | nil
+      createdDate:
+        description: Specifies the given creation date for the LearningItem
+        type: string | nil
+      description:
+        description: Specifies the given description for the LearningItem
+        type: string | nil
+      duration:
+        description: Optional duration field for the LearningItem
+        type: integer | nil
+      hasAssignments:
+        description: Specifies whether the LearningItem has assignments
+        type: boolean | nil
+      id:
+        description: Specifies the given Id for the LearningItem
+        type: string | nil
+      imageUrl:
+        description: Specifies the given image url for the LearningItem
+        type: string | nil
+      learningContentId:
+        description: Specifies the given Learning Content Id for the LearningItem
+        type: string | nil
+      title:
+        description: Specifies the given title for the LearningItem
+        type: string | nil
+      url:
+        description: Optional url field for the LearningItem
+        type: string | nil
+  LearningModelInputRepresentation:
+    description: This representation defines a method of inputting a LearningModel
+      representation
+    type: object
+    properties:
+      assignmentType:
+        description: Input assignment type for LearningModel
+        type: string
+      assignments:
+        description: Input list of assignments for LearningModel
+        type: array
+        items:
+          type: LearningAssignmentInputRepresentation
+      contentType:
+        description: Input LearningContent type for LearningModel
+        type: string
+      customDueDate:
+        description: Input custom due date for LearningModel
+        type: string
+      description:
+        description: Input description for LearningModel
+        type: string
+      dueDateType:
+        description: Input due date type for LearningModel
+        type: string
+      id:
+        description: Input id for LearningModel
+        type: string
+      learningContentId:
+        description: Input LearningContent id for LearningModel
+        type: string
+      pageRefs:
+        description: Input pageRefs for LearningModel
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: object
+      startDate:
+        description: Input start date for LearningModel
+        type: string
+      title:
+        description: Input title for LearningModel
+        type: string
+      url:
+        description: Input url for LearningModel
+        type: string
+  LearningModelOutputRepresentation:
+    description: This representation will be used to return LearningModels
+    type: object
+    properties:
+      assignmentType:
+        description: Specifies the Assignment Type for the LearningModel
+        type: string | nil
+      assignments:
+        description: Specifies a list of LearningAssignments for the LearningModel.
+        type: array
+        items:
+          type: LearningAssignmentRepresentation
+      availablePointCount:
+        description: Specifies the available pount count for the LearningModel.
+        type: integer | nil
+      contentType:
+        description: Specifies the content type of the LearningModel
+        type: string | nil
+      description:
+        description: Specifies the description for the LearningModel.
+        type: string
+      durationCount:
+        description: Specifies the duration count of the LearningModel.
+        type: integer | nil
+      id:
+        description: Specifies the given Id for the LearningModel.
+        type: string | nil
+      imageUrl:
+        description: Specifies the image URL for the LearningModel.
+        type: string | nil
+      learningContentId:
+        description: Specifies the LearningContent id for the LearningModel.
+        type: string | nil
+      pageRefs:
+        description: Specifies a list of pageRefs for the LearningModel.
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any # TODO Hand-rolled W-10668851
+      title:
+        description: Specifies the title for the LearningModel.
+        type: string
+      url:
+        description: Specifies the given URL for the LearningModel
+        type: string | nil
+  LearningPracticeRepresentation:
+    description: This representation maps to the LearningPractice class and is used to represent learning practice (Coaching)
+    type: object
+    properties:
+      description:
+        description: Description of the learning practice
+        type: string
+      learningItemId:
+        description: Learning Item ID of the learning practice
+        type: string
+      minimumInviteeQuantity:
+        description: Specifies the minimum invitee quantity for the Learning Practice
+        type: integer
+      surveyId:
+        description: Specifies the Survey Id for the Learning Practice
+        type: string
+      title:
+        description: Title of the learning practice
+        type: string
+  LearningSearchDescribeContentRepresentation:
+    description: This representation will be used to represent a specific searchable
+      content types
+    type: object
+    properties:
+      title:
+        description: Represents the localized label of the searchable content type
+        type: string
+      type:
+        description: Represents the enum value of the searchable content type
+        type: string
+  LearningSearchDescribeRepresentation:
+    description: This representation will be used to represent a list of all searchable
+      content types
+    type: object
+    properties:
+      contentTypes:
+        description: Represents the list of all searchable content types that the
+          org and users have access to
+        type: array
+        items:
+          type: LearningSearchDescribeContentRepresentation
+  LearningSearchResultsRepresentation:
+    description: This representation will be used to represent the search results
+    type: object
+    properties:
+      results:
+        description: Represents the list of search results
+        type: array
+        items:
+          type: FeaturedItemRepresentation
+      totalResults:
+        description: Represents the number of total search results
+        type: integer
+      type:
+        description: Represents the searchable content type for which this search
+          result is returned
+        type: string
+  LearningTextLessonRepresentation:
+    description: This representation maps to the LearningTextView class and is used
+      to represent Text Lessons
+    type: object
+    properties:
+      description:
+        description: Description of what the text lesson is for
+        type: string
+      learningItemId:
+        description: Learning Item ID of the text lesson
+        type: string
+      sections:
+        description: Ordered list of all the LearningTextLessonSection sections that
+          are part of the text lesson
+        type: array
+        items:
+          type: LearningTextLessonSectionRepresentation
+      title:
+        description: Title of the text lesson
+        type: string
+      totalTime:
+        description: Estimated time in minutes to read the entire text lesson
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+  LearningTextLessonSectionRepresentation:
+    description: This representation maps to the LearningTextSectionView class and
+      is used to represent Text Lesson Sections
+    type: object
+    properties:
+      content:
+        description: Rich text content for the text lesson section
+        type: string
+      keyConcept:
+        description: Description of what this section of the text lesson is trying to teach
+        type: string | nil
+      sectionTime:
+        description: Estimated time to read the section in minutes
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+  TrailheadModuleRepresentation:
+    description: This representation will be used to represent a single user's view
+      of a Trailhead module.
+    type: object
+    properties:
+      availablePointCount:
+        description: Represents the total points possible for the module
+        type: integer
+      completedDate:
+        description: Represents the completedDate for the module for the end user
+          at runtime
+        type: string | nil
+      completedItemCount:
+        description: Represents the number of units completed by the current user
+        type: integer | nil
+      completedPercent:
+        description: Represents the completion percentage of the module as a whole
+          integer,
+        type: integer | nil
+      description:
+        description: Represents the description of a module
+        type: string
+      durationCount:
+        description: Represents the number of minutes remaining for the user to complete
+          the module
+        type: integer
+      earnedPointCount:
+        description: Represents the number of points earned by the user for this module
+        type: integer | nil
+      imageUrl:
+        description: Represents the image url of a module
+        type: string
+      isCompleted:
+        description: Represents if the end-user completed the module
+        type: boolean
+      isCuratedContent:
+        description: Represents if this content was sfdc curated or not
+        type: boolean
+      itemCount:
+        description: Represents the number of units associated with the module
+        type: integer | nil
+      moduleUnits:
+        description: Represents the learning content items associated with this learning
+          content
+        type: array
+        items:
+          type: TrailheadModuleUnitRepresentation
+      relatedId:
+        description: Represents the Id for the entity backing the learning unit, E.g.
+          this would return the Id for a Trailhead module if this was a Trailhead
+          unit, or the Id for a LearningLink if this was a link to outside content
+        type: string
+      title:
+        description: Represents the localized title of a module
+        type: string
+      type:
+        description: Represents the module type
+        type: string
+  TrailheadModuleUnitRepresentation:
+    description: This representation will be used to represent a single user's view
+      of a Trailhead module's unit.
+    type: object
+    properties:
+      completedDate:
+        description: Represents the complete date of the item, Date if the user has
+          completed the item else null
+        type: string | nil
+      contentUrl:
+        description: Represents the URL of a page that will render the content of
+          this item
+        type: string
+      durationCount:
+        description: Represents the duration to complete the item
+        type: integer
+      earnedPointCount:
+        description: Represents the number of points earned by the user for this item
+        type: integer | nil
+      id:
+        description: Represents the id of a learning content item
+        type: string
+      title:
+        description: Represents the title of a learning content item
+        type: string
+      trustedFrameOrigin:
+        description: Represents the trusted frame origin used in iframe messaging.
+        type: string
+/learning-content-platform:
+  /featured-item:
+    /list/recommended:
+      get:
+        description: Returns a list of recommended items to be displayed on the side
+          panel home page
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FeaturedItemRecommendedListRepresentation
+        queryParameters:
+          appId:
+            type: string
+            required: true
+          context:
+            type: string
+            required: true
+    /list/related:
+      get:
+        description: Returns a list of related items to be displayed on the side panel
+          home page
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FeaturedItemRelatedListRepresentation
+        queryParameters:
+          appId:
+            type: string
+            required: true
+          pageRef:
+            type: string
+            required: true
+  /learning:
+    /search:
+      /describe:
+        get:
+          description: Returns a list of searchable content types
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: LearningSearchDescribeRepresentation
+      /type/{contentType}:
+        get:
+          description: Returns a list of search results for a given content type
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: LearningSearchResultsRepresentation
+          queryParameters:
+            limit:
+              type: integer
+              required: true
+            q:
+              type: string
+              required: true
+        uriParameters:
+          contentType:
+            type: string
+            required: true
+    /config:
+      get:
+        description: Returns a config object for Learning Home
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningConfigRepresentation
+    /item/list:
+      get:
+        description: Returns a list of LearningItemRepresentation objects for the
+          given list of learningItemId
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningItemListRepresentation
+        queryParameters:
+          learningItemIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /item/progress:
+      get:
+        description: Returns a list of LearningItemRepresentation objects for the
+          current user
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningItemProgressListRepresentation
+        queryParameters:
+          learningItemIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /model/{learningItemId}:
+      get:
+        description: Returns a LearningModel object for a given LearningItem id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningModelOutputRepresentation
+      uriParameters:
+        learningItemId:
+          type: string
+          required: true
+    /module/{moduleId}:
+      get:
+        description: Returns a trailhead module for module view
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TrailheadModuleRepresentation
+      uriParameters:
+        moduleId:
+          type: string
+          required: true
+    /practice/{learningItemId}:
+      get:
+        description: Returns a Learning Practice to the user based on the LearningItemId passed
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningPracticeRepresentation
+      uriParameters:
+        learningItemId:
+          type: string
+          required: true
+    /evaluate:
+      post:
+        description: Evaluate learning items
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningItemProgressListRepresentation
+        queryParameters:
+          learningItemIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /textlesson/{learningItemId}:
+      get:
+        description: Returns a Text Lesson to the user based on the passed in ID
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LearningTextLessonRepresentation
+      uriParameters:
+        learningItemId:
+          type: string
+          required: true