CoreApi class

Constructors

CoreApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

coreLauncherCreate(LauncherViewPostRequest launcherViewPostRequest) → Future<PlatformList?>
POST: Launch a new edX platform Params: user_id: The ID of the requesting user (required) key: The Deep LMS subdomain (required) name: The edX platform name ("optional") org: The edX organization ("optional") lms_url: LMS URL ("optional") cms_url: CMS URL ("optional") portal_url: Portal URL ("optional")
coreLauncherCreateWithHttpInfo(LauncherViewPostRequest launcherViewPostRequest) → Future<Response>
POST: Launch a new edX platform Params: user_id: The ID of the requesting user (required) key: The Deep LMS subdomain (required) name: The edX platform name ("optional") org: The edX organization ("optional") lms_url: LMS URL ("optional") cms_url: CMS URL ("optional") portal_url: Portal URL ("optional")
coreLauncherRetrieve(String key, {int? userId}) → Future<PlatformList?>
GET Launch status Params: key user_id: Optional
coreLauncherRetrieveWithHttpInfo(String key, {int? userId}) → Future<Response>
GET Launch status Params: key user_id: Optional
corePlatformConfigSiteCreate({Map<String, Object>? requestBody}) → Future<Map<String, Object>?>
GET /site Get site settings. POST /site Save site settings. Params: user_id key field_key (POST) value (POST)
corePlatformConfigSiteCreateWithHttpInfo({Map<String, Object>? requestBody}) → Future<Response>
GET /site Get site settings. POST /site Save site settings. Params: user_id key field_key (POST) value (POST)
corePlatformConfigSiteRetrieve(String key, {int? userId}) → Future<Map<String, Object>?>
GET /site Get site settings. POST /site Save site settings. Params: user_id key field_key (POST) value (POST)
corePlatformConfigSiteRetrieveWithHttpInfo(String key, {int? userId}) → Future<Response>
GET /site Get site settings. POST /site Save site settings. Params: user_id key field_key (POST) value (POST)
corePlatformCreate(PlatformUpdatePostRequest platformUpdatePostRequest) → Future<PlatformList?>
Update platform object Params: user_id key new_key (If changing platform key) name Advanced Params (Don't expose these to users) lms_url cms_url portal_url
corePlatformCreateWithHttpInfo(PlatformUpdatePostRequest platformUpdatePostRequest) → Future<Response>
Update platform object Params: user_id key new_key (If changing platform key) name Advanced Params (Don't expose these to users) lms_url cms_url portal_url
corePlatformRetrieve(String key, {int? userId}) → Future<PlatformList?>
GET /api/core/platform/ Get main platform info. POST /api/core/platform/ Save main platform settings. Params: user_id (optional) key field_key (POST) value (POST)
corePlatformRetrieveWithHttpInfo(String key, {int? userId}) → Future<Response>
GET /api/core/platform/ Get main platform info. POST /api/core/platform/ Save main platform settings. Params: user_id (optional) key field_key (POST) value (POST)
corePlatformUsersRetrieve({String? key, String? org, int? page, int? pageSize, String? query, String? sort}) → Future<UserPlatformManagementListViewGetResponse?>
Retrieve users associated with platform Params: key org query sort is_admin: To return all the tenant admin user
corePlatformUsersRetrieveWithHttpInfo({String? key, String? org, int? page, int? pageSize, String? query, String? sort}) → Future<Response>
Retrieve users associated with platform Params: key org query sort is_admin: To return all the tenant admin user
coreSignalsEdxCreate(EdxSignalReceiverRequest edxSignalReceiverRequest) → Future<void>
POST signals/edx/
coreSignalsEdxCreateWithHttpInfo(EdxSignalReceiverRequest edxSignalReceiverRequest) → Future<Response>
POST signals/edx/
coreUsersPlatformsCreate(UserPlatformViewPostRequest userPlatformViewPostRequest) → Future<void>
Explicitly link platform to user_id Params: user_id key added_on (optional) expired_on (optional) is_admin (optional) active (optional)
coreUsersPlatformsCreateWithHttpInfo(UserPlatformViewPostRequest userPlatformViewPostRequest) → Future<Response>
Explicitly link platform to user_id Params: user_id key added_on (optional) expired_on (optional) is_admin (optional) active (optional)
coreUsersPlatformsList(int userId) → Future<List<PlatformList>?>
Retrieve platforms associated with user_id Params: user_id
coreUsersPlatformsListWithHttpInfo(int userId) → Future<Response>
Retrieve platforms associated with user_id Params: user_id
coreUsersProxyBulkCreate(UserProxyBulkRequest userProxyBulkRequest) → Future<List<Map<String, String>>?>
Add proxy users by bulk Params: users: list of user objects [ {\"user_id\": 1, ...}, {\"user_id\": 2, ...} ]
coreUsersProxyBulkCreateWithHttpInfo(UserProxyBulkRequest userProxyBulkRequest) → Future<Response>
Add proxy users by bulk Params: users: list of user objects [ {\"user_id\": 1, ...}, {\"user_id\": 2, ...} ]
coreUsersProxyCreate(UserProxyPostRequest userProxyPostRequest) → Future<UserProxyPostResponse?>
Add proxy user Params: user_id username email edx_data data
coreUsersProxyCreateWithHttpInfo(UserProxyPostRequest userProxyPostRequest) → Future<Response>
Add proxy user Params: user_id username email edx_data data
coreUsersProxyRetrieve({String? email, int? userId, String? username}) → Future<UserProxyGetResponse?>
Retrieve proxy user information by user_id
coreUsersProxyRetrieveWithHttpInfo({String? email, int? userId, String? username}) → Future<Response>
Retrieve proxy user information by user_id
coreUsersSearchRetrieve({int? page, int? pageSize, String? query, String? sort}) → Future<UserSearchViewGetResponse?>
Retrieve users based on query Not intended for public use with multitenant platforms Params: query sort
coreUsersSearchRetrieveWithHttpInfo({int? page, int? pageSize, String? query, String? sort}) → Future<Response>
Retrieve users based on query Not intended for public use with multitenant platforms Params: query sort
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