Class Lms


  • public class Lms
    extends java.lang.Object
    • Method Detail

      • async

        public AsyncLms async()
        Switches to the async SDK.
        Returns:
        The async SDK
      • listCourses

        public LmsListCoursesResponse listCourses​(LmsListCoursesRequest request)
        List Courses
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listCourses

        public LmsListCoursesResponse listCourses​(LmsListCoursesRequest request,
                                                  java.util.Optional<Options> options)
        List Courses
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCourse

        public LmsGetCourseResponse getCourse​(LmsGetCourseRequest request)
        Get Course
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCourse

        public LmsGetCourseResponse getCourse​(LmsGetCourseRequest request,
                                              java.util.Optional<Options> options)
        Get Course
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUserAssignments

        public LmsListUserAssignmentsResponse listUserAssignments​(LmsListUserAssignmentsRequest request)
        List User Assignments
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUserAssignments

        public LmsListUserAssignmentsResponse listUserAssignments​(LmsListUserAssignmentsRequest request,
                                                                  java.util.Optional<Options> options)
        List User Assignments
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • createUserAssignment

        public LmsCreateUserAssignmentResponse createUserAssignment​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    LmsCreateAssignmentRequestDto lmsCreateAssignmentRequestDto)
        Create User Assignment
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateAssignmentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • createUserAssignment

        public LmsCreateUserAssignmentResponse createUserAssignment​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    LmsCreateAssignmentRequestDto lmsCreateAssignmentRequestDto,
                                                                    java.util.Optional<Options> options)
        Create User Assignment
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateAssignmentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUserAssignment

        public LmsGetUserAssignmentResponse getUserAssignment​(LmsGetUserAssignmentRequest request)
        Get User Assignment
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUserAssignment

        public LmsGetUserAssignmentResponse getUserAssignment​(LmsGetUserAssignmentRequest request,
                                                              java.util.Optional<Options> options)
        Get User Assignment
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • batchUpsertContent

        public LmsBatchUpsertContentResponse batchUpsertContent​(java.lang.String xAccountId,
                                                                LmsBatchUpsertContentRequestDto lmsBatchUpsertContentRequestDto)
        Batch Upsert Content
        Parameters:
        xAccountId - The account identifier
        lmsBatchUpsertContentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • batchUpsertContent

        public LmsBatchUpsertContentResponse batchUpsertContent​(java.lang.String xAccountId,
                                                                LmsBatchUpsertContentRequestDto lmsBatchUpsertContentRequestDto,
                                                                java.util.Optional<Options> options)
        Batch Upsert Content
        Parameters:
        xAccountId - The account identifier
        lmsBatchUpsertContentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listContent

        public LmsListContentResponse listContent​(LmsListContentRequest request)
        List Content
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listContent

        public LmsListContentResponse listContent​(LmsListContentRequest request,
                                                  java.util.Optional<Options> options)
        List Content
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • upsertContent

        public LmsUpsertContentResponse upsertContent​(java.lang.String xAccountId,
                                                      LmsUpsertContentRequestDto lmsUpsertContentRequestDto)
        Upsert Content
        Parameters:
        xAccountId - The account identifier
        lmsUpsertContentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • upsertContent

        public LmsUpsertContentResponse upsertContent​(java.lang.String xAccountId,
                                                      LmsUpsertContentRequestDto lmsUpsertContentRequestDto,
                                                      java.util.Optional<Options> options)
        Upsert Content
        Parameters:
        xAccountId - The account identifier
        lmsUpsertContentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getContent

        public LmsGetContentResponse getContent​(LmsGetContentRequest request)
        Get Content
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getContent

        public LmsGetContentResponse getContent​(LmsGetContentRequest request,
                                                java.util.Optional<Options> options)
        Get Content
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • updateContent

        public LmsUpdateContentResponse updateContent​(java.lang.String xAccountId,
                                                      java.lang.String id,
                                                      LmsCreateContentRequestDto lmsCreateContentRequestDto)
        Update Content
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateContentRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • updateContent

        public LmsUpdateContentResponse updateContent​(java.lang.String xAccountId,
                                                      java.lang.String id,
                                                      LmsCreateContentRequestDto lmsCreateContentRequestDto,
                                                      java.util.Optional<Options> options)
        Update Content
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateContentRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUserCompletions

        public LmsListUserCompletionsResponse listUserCompletions​(LmsListUserCompletionsRequest request)
        List User Completions
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUserCompletions

        public LmsListUserCompletionsResponse listUserCompletions​(LmsListUserCompletionsRequest request,
                                                                  java.util.Optional<Options> options)
        List User Completions
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • createUserCompletion

        public LmsCreateUserCompletionResponse createUserCompletion​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    LmsCreateCompletionRequestDto lmsCreateCompletionRequestDto)
        Create User Completion
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateCompletionRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • createUserCompletion

        public LmsCreateUserCompletionResponse createUserCompletion​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    LmsCreateCompletionRequestDto lmsCreateCompletionRequestDto,
                                                                    java.util.Optional<Options> options)
        Create User Completion
        Parameters:
        xAccountId - The account identifier
        id -
        lmsCreateCompletionRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUserCompletion

        public LmsGetUserCompletionResponse getUserCompletion​(LmsGetUserCompletionRequest request)
        Get User Completion
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUserCompletion

        public LmsGetUserCompletionResponse getUserCompletion​(LmsGetUserCompletionRequest request,
                                                              java.util.Optional<Options> options)
        Get User Completion
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • deleteUserCompletion

        public LmsDeleteUserCompletionResponse deleteUserCompletion​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    java.lang.String subResourceId)
        Delete User Completion
        Parameters:
        xAccountId - The account identifier
        id -
        subResourceId -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • deleteUserCompletion

        public LmsDeleteUserCompletionResponse deleteUserCompletion​(java.lang.String xAccountId,
                                                                    java.lang.String id,
                                                                    java.lang.String subResourceId,
                                                                    java.util.Optional<Options> options)
        Delete User Completion
        Parameters:
        xAccountId - The account identifier
        id -
        subResourceId -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listCompletions

        public LmsListCompletionsResponse listCompletions​(LmsListCompletionsRequest request)
        List Completions
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listCompletions

        public LmsListCompletionsResponse listCompletions​(LmsListCompletionsRequest request,
                                                          java.util.Optional<Options> options)
        List Completions
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCompletion

        public LmsGetCompletionResponse getCompletion​(LmsGetCompletionRequest request)
        Get Completion
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCompletion

        public LmsGetCompletionResponse getCompletion​(LmsGetCompletionRequest request,
                                                      java.util.Optional<Options> options)
        Get Completion
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCategory

        public LmsGetCategoryResponse getCategory​(LmsGetCategoryRequest request)
        Get Category
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getCategory

        public LmsGetCategoryResponse getCategory​(LmsGetCategoryRequest request,
                                                  java.util.Optional<Options> options)
        Get Category
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listCategories

        public LmsListCategoriesResponse listCategories​(LmsListCategoriesRequest request)
        List Categories
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listCategories

        public LmsListCategoriesResponse listCategories​(LmsListCategoriesRequest request,
                                                        java.util.Optional<Options> options)
        List Categories
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUsers

        public LmsListUsersResponse listUsers​(LmsListUsersRequest request)
        List Users
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listUsers

        public LmsListUsersResponse listUsers​(LmsListUsersRequest request,
                                              java.util.Optional<Options> options)
        List Users
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUser

        public LmsGetUserResponse getUser​(LmsGetUserRequest request)
        Get User
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getUser

        public LmsGetUserResponse getUser​(LmsGetUserRequest request,
                                          java.util.Optional<Options> options)
        Get User
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getSkill

        public LmsGetSkillResponse getSkill​(LmsGetSkillRequest request)
        Get Skill
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getSkill

        public LmsGetSkillResponse getSkill​(LmsGetSkillRequest request,
                                            java.util.Optional<Options> options)
        Get Skill
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listSkills

        public LmsListSkillsResponse listSkills​(LmsListSkillsRequest request)
        List Skills
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listSkills

        public LmsListSkillsResponse listSkills​(LmsListSkillsRequest request,
                                                java.util.Optional<Options> options)
        List Skills
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listAssignments

        public LmsListAssignmentsResponse listAssignments​(LmsListAssignmentsRequest request)
        List Assignments
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • listAssignments

        public LmsListAssignmentsResponse listAssignments​(LmsListAssignmentsRequest request,
                                                          java.util.Optional<Options> options)
        List Assignments
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getAssignment

        public LmsGetAssignmentResponse getAssignment​(LmsGetAssignmentRequest request)
        Get Assignment
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails
      • getAssignment

        public LmsGetAssignmentResponse getAssignment​(LmsGetAssignmentRequest request,
                                                      java.util.Optional<Options> options)
        Get Assignment
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails