CatalogApi class
Constructors
- CatalogApi([ApiClient? apiClient])
Properties
Methods
-
catalogConditionalsCourseEligibilityRetrieve(
) → Future< void> - GET Retrieve prerequisite eligibility info for user/course Params: user_id/username course_id
-
catalogConditionalsCourseEligibilityRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve prerequisite eligibility info for user/course Params: user_id/username course_id
-
catalogConditionalsCoursePrerequisitesManageBulkCreate(
) → Future< void> - Prerequisite bulk management view Params: course_id rules key_only
-
catalogConditionalsCoursePrerequisitesManageBulkCreateWithHttpInfo(
) → Future< Response> - Prerequisite bulk management view Params: course_id rules key_only
-
catalogConditionalsCoursePrerequisitesManageRetrieve(
) → Future< void> - GET Retrieve prerequisite info for course Params: course_id key_only
-
catalogConditionalsCoursePrerequisitesManageRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve prerequisite info for course Params: course_id key_only
-
catalogCoursesCreate(
) → Future< void> - POST Add a course to the database. Params: course_id org name (optional)
-
catalogCoursesCreateWithHttpInfo(
) → Future< Response> - POST Add a course to the database. Params: course_id org name (optional)
-
catalogCoursesDestroy(
) → Future< void> - DELETE Remove a course from the database. Params (all required): course_id org
-
catalogCoursesDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove a course from the database. Params (all required): course_id org
-
catalogCoursesRetrieve(
) → Future< void> - GET Retrieve courses matching query. Params: course_id slug org
-
catalogCoursesRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve courses matching query. Params: course_id slug org
-
catalogEligibilityCoursesCheckRetrieve(
) → Future< void> - GET Check whether user is eligible to enroll in a course Params: user_id course_id org
-
catalogEligibilityCoursesCheckRetrieveWithHttpInfo(
) → Future< Response> - GET Check whether user is eligible to enroll in a course Params: user_id course_id org
-
catalogEligibilityCoursesRetrieve(
) → Future< void> - GET List 'eligible' courses for user. Params: user_id org query
-
catalogEligibilityCoursesRetrieveWithHttpInfo(
) → Future< Response> - GET List 'eligible' courses for user. Params: user_id org query
-
catalogEnrollmentCoursesSearchRetrieve(
) → Future< void> - GET Search course enrollments by filters Params: user_id course_id slug org platform_key Returns paginated enrollment results
-
catalogEnrollmentCoursesSearchRetrieveWithHttpInfo(
) → Future< Response> - GET Search course enrollments by filters Params: user_id course_id slug org platform_key Returns paginated enrollment results
-
catalogEnrollmentProgramsCreate(
) → Future< void> - POST Log user enrollment with program. Params: user_id program_id org started (date string?) expired (date string?) active (default True)
-
catalogEnrollmentProgramsCreateWithHttpInfo(
) → Future< Response> - POST Log user enrollment with program. Params: user_id program_id org started (date string?) expired (date string?) active (default True)
-
catalogEnrollmentProgramsDestroy(
) → Future< void> - DELETE Unenroll from program. Deactivates enrollment. Params: user_id program_id org ignore_expiration
-
catalogEnrollmentProgramsDestroyWithHttpInfo(
) → Future< Response> - DELETE Unenroll from program. Deactivates enrollment. Params: user_id program_id org ignore_expiration
-
catalogEnrollmentProgramsRetrieve(
) → Future< void> - GET Search program enrollments user_id or program_id/slug should be required Params: user_id program_id slug org program_type (string): 'standard', 'platform', 'custom'
-
catalogEnrollmentProgramsRetrieveWithHttpInfo(
) → Future< Response> - GET Search program enrollments user_id or program_id/slug should be required Params: user_id program_id slug org program_type (string): 'standard', 'platform', 'custom'
-
catalogIncrementCreate(
) → Future< void> - POST Update auto increment information and retrieve a new ID. Params: org: Platform org key: Platform key number_type: Type of number requested (course, program)
-
catalogIncrementCreateWithHttpInfo(
) → Future< Response> - POST Update auto increment information and retrieve a new ID. Params: org: Platform org key: Platform key number_type: Type of number requested (course, program)
-
catalogIncrementRetrieve(
) → Future< void> - GET Retrieve auto increment information. Params: org key
-
catalogIncrementRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve auto increment information. Params: org key
-
catalogInvitationsCourseBulkCreate(
) → Future< void> - POST Add invites to the database Params: course_id source count
-
catalogInvitationsCourseBulkCreateWithHttpInfo(
) → Future< Response> - POST Add invites to the database Params: course_id source count
-
catalogInvitationsCourseCreate(
) → Future< void> - POST Add a single invite to the database Params: course_id email active
-
catalogInvitationsCourseCreateWithHttpInfo(
) → Future< Response> - POST Add a single invite to the database Params: course_id email active
-
catalogInvitationsCourseDestroy(
) → Future< void> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsCourseDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsCourseRedeemCreate(
) → Future< void> - POST Redeem invites from empty invitations Params: course_id* source*
-
catalogInvitationsCourseRedeemCreateWithHttpInfo(
) → Future< Response> - POST Redeem invites from empty invitations Params: course_id* source*
-
catalogInvitationsCourseRetrieve(
) → Future< void> - GET Query course invitations Params: course_id email source active verbose sort
-
catalogInvitationsCourseRetrieveWithHttpInfo(
) → Future< Response> - GET Query course invitations Params: course_id email source active verbose sort
-
catalogInvitationsPlatformBulkCreate(
) → Future< void> - POST Add invites to the database Params: platform_key source count
-
catalogInvitationsPlatformBulkCreateWithHttpInfo(
) → Future< Response> - POST Add invites to the database Params: platform_key source count
-
catalogInvitationsPlatformCreate(
) → Future< void> - POST Add a single invite to the database Params: platform_key username/email
-
catalogInvitationsPlatformCreateWithHttpInfo(
) → Future< Response> - POST Add a single invite to the database Params: platform_key username/email
-
catalogInvitationsPlatformDestroy(
) → Future< void> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsPlatformDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsPlatformRedeemCreate(
) → Future< void> - POST Redeem invites from empty invitations Params: platform_key* source*
-
catalogInvitationsPlatformRedeemCreateWithHttpInfo(
) → Future< Response> - POST Redeem invites from empty invitations Params: platform_key* source*
-
catalogInvitationsPlatformRetrieve(
) → Future< void> - GET Query platform invitations Params: platform_key org email source active verbose sort
-
catalogInvitationsPlatformRetrieveWithHttpInfo(
) → Future< Response> - GET Query platform invitations Params: platform_key org email source active verbose sort
-
catalogInvitationsProgramBulkCreate(
) → Future< void> - POST Add invites to the database Params: program_key source count
-
catalogInvitationsProgramBulkCreateWithHttpInfo(
) → Future< Response> - POST Add invites to the database Params: program_key source count
-
catalogInvitationsProgramCreate(
) → Future< void> - POST Add a single invite to the database Params: program_key email active
-
catalogInvitationsProgramCreateWithHttpInfo(
) → Future< Response> - POST Add a single invite to the database Params: program_key email active
-
catalogInvitationsProgramDestroy(
) → Future< void> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsProgramDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove an invitation from the database. Params (all required): id: invitation (numeric) ID org
-
catalogInvitationsProgramRedeemCreate(
) → Future< void> - POST Redeem invites from empty invitations Params: program_key* source*
-
catalogInvitationsProgramRedeemCreateWithHttpInfo(
) → Future< Response> - POST Redeem invites from empty invitations Params: program_key* source*
-
catalogInvitationsProgramRetrieve(
) → Future< void> - GET Query program invitations Params: program_key email source active verbose sort
-
catalogInvitationsProgramRetrieveWithHttpInfo(
) → Future< Response> - GET Query program invitations Params: program_key email source active verbose sort
-
catalogMetadataChoicesRetrieve(
) → Future< void> - GET Query metadata choices Params: field_key scope org
-
catalogMetadataChoicesRetrieveWithHttpInfo(
) → Future< Response> - GET Query metadata choices Params: field_key scope org
-
catalogMetadataCourseCreate(
) → Future< void> - POST Update course metadata Params: course_id metadata update (optional)
-
catalogMetadataCourseCreate2(
String field) → Future< void> - POST Update course metadata Params: course_id metadata update (optional)
-
catalogMetadataCourseCreate2WithHttpInfo(
String field) → Future< Response> - POST Update course metadata Params: course_id metadata update (optional)
-
catalogMetadataCourseCreateWithHttpInfo(
) → Future< Response> - POST Update course metadata Params: course_id metadata update (optional)
-
catalogMetadataCoursePublicRetrieve(
) → Future< void> - GET Query public course metadata Params: course_id
-
catalogMetadataCoursePublicRetrieve2(
String field) → Future< void> - GET Query public course metadata Params: course_id
-
catalogMetadataCoursePublicRetrieve2WithHttpInfo(
String field) → Future< Response> - GET Query public course metadata Params: course_id
-
catalogMetadataCoursePublicRetrieveWithHttpInfo(
) → Future< Response> - GET Query public course metadata Params: course_id
-
catalogMetadataCourseRetrieve(
) → Future< void> - GET Query course metadata Params: course_id
-
catalogMetadataCourseRetrieve2(
String field) → Future< void> - GET Query course metadata Params: course_id
-
catalogMetadataCourseRetrieve2WithHttpInfo(
String field) → Future< Response> - GET Query course metadata Params: course_id
-
catalogMetadataCourseRetrieveWithHttpInfo(
) → Future< Response> - GET Query course metadata Params: course_id
-
catalogMetadataProgramCreate(
) → Future< void> - POST Update program metadata TODO: program-key compatibility Params: program_id org metadata update (optional)
-
catalogMetadataProgramCreate2(
String field) → Future< void> - POST Update program metadata TODO: program-key compatibility Params: program_id org metadata update (optional)
-
catalogMetadataProgramCreate2WithHttpInfo(
String field) → Future< Response> - POST Update program metadata TODO: program-key compatibility Params: program_id org metadata update (optional)
-
catalogMetadataProgramCreateWithHttpInfo(
) → Future< Response> - POST Update program metadata TODO: program-key compatibility Params: program_id org metadata update (optional)
-
catalogMetadataProgramPublicRetrieve(
) → Future< void> - GET Query public program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramPublicRetrieve2(
String field) → Future< void> - GET Query public program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramPublicRetrieve2WithHttpInfo(
String field) → Future< Response> - GET Query public program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramPublicRetrieveWithHttpInfo(
) → Future< Response> - GET Query public program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramRetrieve(
) → Future< void> - GET Query program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramRetrieve2(
String field) → Future< void> - GET Query program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramRetrieve2WithHttpInfo(
String field) → Future< Response> - GET Query program metadata TODO: program-key compatibility Params: program_id org
-
catalogMetadataProgramRetrieveWithHttpInfo(
) → Future< Response> - GET Query program metadata TODO: program-key compatibility Params: program_id org
-
catalogMilestonesCompletionsCourseCatalogRetrieve(
) → Future< void> - GET Retrieve catalog-compatible completion info for user Params: course_id
-
catalogMilestonesCompletionsCourseCatalogRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve catalog-compatible completion info for user Params: course_id
-
catalogMilestonesCompletionsCourseManageCreate(
) → Future< void> - POST Update completion info for course/user Params: course_id user_id
-
catalogMilestonesCompletionsCourseManageCreateWithHttpInfo(
) → Future< Response> - POST Update completion info for course/user Params: course_id user_id
-
catalogMilestonesCompletionsCourseManageRetrieve(
) → Future< void> - GET Retrieve completion info for course/user Params: course_id user_id
-
catalogMilestonesCompletionsCourseManageRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve completion info for course/user Params: course_id user_id
-
catalogMilestonesCompletionsResourceManageCreate(
) → Future< void> - POST Update completion info for resource/user Params: resource_id user_id
-
catalogMilestonesCompletionsResourceManageCreateWithHttpInfo(
) → Future< Response> - POST Update completion info for resource/user Params: resource_id user_id
-
catalogMilestonesCompletionsResourceManageRetrieve(
) → Future< void> - GET Retrieve completion info for resource/user Params: resource_id user_id
-
catalogMilestonesCompletionsResourceManageRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve completion info for resource/user Params: resource_id user_id
-
catalogMilestonesSkillPointsBlockCreate(
) → Future< void> - POST Update skill point information for block Params: block_id point_data
-
catalogMilestonesSkillPointsBlockCreateWithHttpInfo(
) → Future< Response> - POST Update skill point information for block Params: block_id point_data
-
catalogMilestonesSkillPointsBlockRetrieve(
) → Future< void> - GET Retrieve skill information for block Params: block_id
-
catalogMilestonesSkillPointsBlockRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve skill information for block Params: block_id
-
catalogMilestonesSkillPointsCourseCreate(
) → Future< void> - POST Update skill point information for course Params: course_id point_data
-
catalogMilestonesSkillPointsCourseCreateWithHttpInfo(
) → Future< Response> - POST Update skill point information for course Params: course_id point_data
-
catalogMilestonesSkillPointsCourseRetrieve(
) → Future< void> - GET Retrieve skill information for course Params: course_id
-
catalogMilestonesSkillPointsCourseRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve skill information for course Params: course_id
-
catalogMilestonesSkillPointsUserRetrieve(
) → Future< void> - GET Retrieve user skill point info Params: user_id/username
-
catalogMilestonesSkillPointsUserRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve user skill point info Params: user_id/username
-
catalogPathwaysCreate(
) → Future< void> -
POST Add or update a pathway. Params: pathway_id user_id name slug visible path: Array of dict with
course_idkeys{'course_id': 'course-v1:A+B+C'} -
catalogPathwaysCreateWithHttpInfo(
) → Future< Response> -
POST Add or update a pathway. Params: pathway_id user_id name slug visible path: Array of dict with
course_idkeys{'course_id': 'course-v1:A+B+C'} -
catalogPathwaysDestroy(
) → Future< void> - DELETE Remove a pathway from the database. Params (all required): pathway_id user_id Return: count type
-
catalogPathwaysDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove a pathway from the database. Params (all required): pathway_id user_id Return: count type
-
catalogPathwaysRetrieve(
) → Future< void> - GET Retrieve pathways matching query. Limited parameters. Params: pathway_id user_id/username Optional: name slug visible
-
catalogPathwaysRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve pathways matching query. Limited parameters. Params: pathway_id user_id/username Optional: name slug visible
-
catalogProgramsCreate(
) → Future< void> -
POST Add or update a program. Params: course_list: Array of dict with
course_idkeys{'course_id': 'course-v1:A+B+C'}#update: Whether this is strictly a create (if true, then will update or create) -
catalogProgramsCreateWithHttpInfo(
) → Future< Response> -
POST Add or update a program. Params: course_list: Array of dict with
course_idkeys{'course_id': 'course-v1:A+B+C'}#update: Whether this is strictly a create (if true, then will update or create) -
catalogProgramsDestroy(
) → Future< void> - DELETE Remove a program from the database. Params (all required): program_id org Return: count type
-
catalogProgramsDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove a program from the database. Params (all required): program_id org Return: count type
-
catalogProgramsRetrieve(
) → Future< void> - GET Retrieve programs matching query. Limited parameters. Params: program_id name slug enabled org
-
catalogProgramsRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve programs matching query. Limited parameters. Params: program_id name slug enabled org
-
catalogRecommendationCoursesRetrieve(
) → Future< void> - GET Get a 'next' course Params: user_id course_id org
-
catalogRecommendationCoursesRetrieveWithHttpInfo(
) → Future< Response> - GET Get a 'next' course Params: user_id course_id org
-
catalogResourcesCreate(
) → Future< void> - POST Add or update a resource. Params: id resource_type url name skills data
-
catalogResourcesCreateWithHttpInfo(
) → Future< Response> - POST Add or update a resource. Params: id resource_type url name skills data
-
catalogResourcesDestroy(
) → Future< void> - DELETE Remove a resource from the database. Params (all required): id user_id Return: count type
-
catalogResourcesDestroyWithHttpInfo(
) → Future< Response> - DELETE Remove a resource from the database. Params (all required): id user_id Return: count type
-
catalogResourcesRetrieve(
) → Future< void> - GET Retrieve resources matching query. Limited parameters. Params: id Optional: resource_type item_id name
-
catalogResourcesRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve resources matching query. Limited parameters. Params: id Optional: resource_type item_id name
-
catalogReviewsCoursesCreate(
) → Future< void> - POST Add/update course reviews Params: user_id/username course_id metadata content rating visible
-
catalogReviewsCoursesCreateWithHttpInfo(
) → Future< Response> - POST Add/update course reviews Params: user_id/username course_id metadata content rating visible
-
catalogReviewsCoursesRetrieve(
) → Future< void> - GET Query course reviews Params: course_id details (bool)
-
catalogReviewsCoursesRetrieveWithHttpInfo(
) → Future< Response> - GET Query course reviews Params: course_id details (bool)
-
catalogRolesCreate(
) → Future< void> - POST Add or update a role. Params: id name slug data
-
catalogRolesCreateWithHttpInfo(
) → Future< Response> - POST Add or update a role. Params: id name slug data
-
catalogRolesDesiredCreate(
) → Future< void> - POST Add or update a role. Params: user_id/username skills data
-
catalogRolesDesiredCreateWithHttpInfo(
) → Future< Response> - POST Add or update a role. Params: user_id/username skills data
-
catalogRolesDesiredRetrieve(
) → Future< void> - GET Retrieve desired skills for user Params: name id slug
-
catalogRolesDesiredRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve desired skills for user Params: name id slug
-
catalogRolesReportedCreate(
) → Future< void> - POST Add or update a role. Params: user_id/username skills data
-
catalogRolesReportedCreateWithHttpInfo(
) → Future< Response> - POST Add or update a role. Params: user_id/username skills data
-
catalogRolesReportedRetrieve(
) → Future< void> - GET Retrieve desired roles for user Params: name id slug
-
catalogRolesReportedRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve desired roles for user Params: name id slug
-
catalogRolesRetrieve(
) → Future< void> - GET Retrieve roles matching query. Limited parameters. Params: name id slug
-
catalogRolesRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve roles matching query. Limited parameters. Params: name id slug
-
catalogSearchProgramsCreate(
) → Future< void> - POST Retrieve programs matching query. Params: query --- org
-
catalogSearchProgramsCreateWithHttpInfo(
) → Future< Response> - POST Retrieve programs matching query. Params: query --- org
-
catalogSkillsCreate(
) → Future< void> - POST Add or update a skill. Params: id name slug data
-
catalogSkillsCreateWithHttpInfo(
) → Future< Response> - POST Add or update a skill. Params: id name slug data
-
catalogSkillsDesiredCreate(
) → Future< void> - POST Add or update a skill. Params: user_id/username skills data
-
catalogSkillsDesiredCreateWithHttpInfo(
) → Future< Response> - POST Add or update a skill. Params: user_id/username skills data
-
catalogSkillsDesiredRetrieve(
) → Future< void> - GET Retrieve desired skills for user Params: name id slug
-
catalogSkillsDesiredRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve desired skills for user Params: name id slug
-
catalogSkillsReportedCreate(
) → Future< void> - POST Add or update a skill. Params: user_id/username skills data
-
catalogSkillsReportedCreateWithHttpInfo(
) → Future< Response> - POST Add or update a skill. Params: user_id/username skills data
-
catalogSkillsReportedRetrieve(
) → Future< void> - GET Retrieve desired skills for user Params: name id slug
-
catalogSkillsReportedRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve desired skills for user Params: name id slug
-
catalogSkillsRetrieve(
) → Future< void> - GET Retrieve skills matching query. Limited parameters. Params: name id slug
-
catalogSkillsRetrieveWithHttpInfo(
) → Future< Response> - GET Retrieve skills matching query. Limited parameters. Params: name id slug
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited