api/lib/api library

Classes

AcceptanceEnum
  • Unaccepted - Unaccepted * Accepted - Accepted * Rejected - Rejected
    • AcceptanceEnumTypeTransformer
    Transformation class that can encode an instance of AcceptanceEnum to String, and decode dynamic data back to AcceptanceEnum.
    ActiveUsersData
    ActiveUsersList
    ActiveUsersPerCourse
    ActiveUsersPerCourseData
    ActivityAPI
    ActivityData
    AiApi
    AlignMentorBubbleEnum
  • left - Left * right - Right
    • AlignMentorBubbleEnumTypeTransformer
    Transformation class that can encode an instance of AlignMentorBubbleEnum to String, and decode dynamic data back to AlignMentorBubbleEnum.
    ApiClient
    ApiKeyAuth
    APITokenCost
    AskMentorRequest
    AskMentorResponse
    Assertions
    AudienceApi
    AudioToTextRequest
    AudioToTextResponse
    Authentication
    Average
    AverageData
    AverageOvertime
    AvgCourseGradeWithCutoff
    AvgCourseGradeWithCutoffData
    BlankEnum
    BlankEnumTypeTransformer
    Transformation class that can encode an instance of BlankEnum to String, and decode dynamic data back to BlankEnum.
    Bot
    BotCommand
    BotCreate
    CatalogApi
    ChatHistory
    ChatHistoryItem
    ChatHistorySessionId
    ChatSessionRequest
    ChatSessionResponse
    ChatSessionWithMessage
    CheckDocumentTrainingStatus
    CognitiveSkillsEnum
  • Memorization - Memorization * Comprehension - Comprehension * Application - Application * Analysis - Analysis * Synthesis - Synthesis * Evaluation - Evaluation
    • CognitiveSkillsEnumTypeTransformer
    Transformation class that can encode an instance of CognitiveSkillsEnum to String, and decode dynamic data back to CognitiveSkillsEnum.
    CoreApi
    Count
    CountData
    CourseCompletionPerCourse
    CourseCompletionPerCourseData
    CourseCompletionSummaryDataOvertime
    CourseCompletionSummaryOvertime
    CourseGradeDetailBlock
    CourseGradeDetailSubSection
    CourseGradeSummary
    CourseGradeSummaryData
    CourseGradingDetail
    CourseGradingDetailData
    CoursePoint
    CourseSkill
    CredApi
    Credential
    CredentialCredentialType
    CredentialExpiresDuration
    CredentialIssuingSignal
    CredentialsApi
    CredentialTypeEnum
  • MICROCREDENTIAL - MICROCREDENTIAL * CERTIFICATE - CERTIFICATE * PROGRAM_CERTIFICATE - PROGRAM_CERTIFICATE * COURSE_CERTIFICATE - COURSE_CERTIFICATE
    • CredentialTypeEnumTypeTransformer
    Transformation class that can encode an instance of CredentialTypeEnum to String, and decode dynamic data back to CredentialTypeEnum.
    DefaultResponse
    DeserializationMessage
    Primarily intended for use in an isolate.
    DesiredRole
    DesiredSkill
    DetailedGradeSubsection
    DetailedGradeView
    DetailedGradeViewData
    DiscordWebhook
    EdxSignalReceiverRequest
    EngagementApi
    EngagementPerCourse
    EngagementPerCourseData
    Enrollments
    EnrollmentsData
    EnrollmentsPerUser
    EnrollmentsPerUserData
    ExpiresDurationEnum
  • days - Days * weeks - Weeks * months - Months * years - Years
    • ExpiresDurationEnumTypeTransformer
    Transformation class that can encode an instance of ExpiresDurationEnum to String, and decode dynamic data back to ExpiresDurationEnum.
    FinanceApi
    FloatOverTime
    FreeUsageCount
    GradingPerUser
    GradingPerUserData
    GuidedPromptsResponse
    HttpBasicAuth
    HttpBearerAuth
    IBLAIPlatformMeta
    IntegrationCredential
    IssuingSignalEnum
  • COURSE_COMPLETED - Course Completed * COURSE_PASSED - Course Passed
    • IssuingSignalEnumTypeTransformer
    Transformation class that can encode an instance of IssuingSignalEnum to String, and decode dynamic data back to IssuingSignalEnum.
    LauncherViewPostRequest
    LearnerInformationAPI
    LearnerInformationAPIData
    LLMCredential
    MathQuestion
    MathQuestionCognitiveSkills
    MathQuestionWithAnswer
    MathStudent
    Mentor
    MentorFromTemplateRequest
    MentorFromTemplateWithSettingRequest
    MentorLLMFlowResponse
    MentorSettings
    MentorSettingsMentorVisibility
    MentorSettingsRequest
    MentorVisibilityEnum
  • public - Public * unlisted - Unlisted * private - Private
    • MentorVisibilityEnumTypeTransformer
    Transformation class that can encode an instance of MentorVisibilityEnum to String, and decode dynamic data back to MentorVisibilityEnum.
    MessageView
    MessageViewRequest
    MessageViewUpdatResponse
    MonitoringApi
    NetRevenueOverTime
    NullEnum
    NullEnumTypeTransformer
    Transformation class that can encode an instance of NullEnum to String, and decode dynamic data back to NullEnum.
    OAuth
    Order
    OverTime
    Overtime
    OvertimeMeta
    OvertimeWithChangeInfo
    OverviewApi
    PageContent
    PaginatedAssertionsList
    PaginatedCredentialList
    PaginatedMentorList
    Pagination
    PatchedBotCommand
    PatchedBotCreate
    PatchedIntegrationCredential
    PatchedLLMCredential
    PatchedMathQuestion
    PatchedMathStudent
    PatchedMentor
    PatchedPrompt
    PatchedSkill
    PatchedSkillThreshold
    PatchedStudentAnswer
    PerformanceApi
    PerformanceGradesPerCourse
    PerformanceGradesPerCourseData
    PerlearnerApi
    PerLearnerCourseLastAccessData
    PerlearnerCourseProgress
    PerlearnerCourseProgressData
    PerLearnerCourseVideosWatched
    PerLearnerCourseVideosWatchedData
    PerlearnerEngagementVideosData
    PerlearnerEngagementVideosWatchedPerCourse
    PerlearnerGradeSummary
    PerlearnerGradeSummaryData
    PerlearnerGradeWithCutOff
    PerlearnerGradeWithCutOffData
    PerlearnerGradingPerCourseAPI
    PerlearnerGradingPerCourseAPIData
    PerLearnerLastAccess
    PerLearnerLastAccessData
    PerLearnerTimeSpentInCourseTree
    PerlearnerUserList
    PerlearnerUserListData
    PinnedMessageCreate
    PlatformApi
    PlatformList
    PlatformListStatusEnum
  • -2 - FAILED * -1 - TERMINATED * 0 - PENDING * 1 - BUILDING * 2 - RUNNING * 3 - PAUSED * 4 - STOPPING * 5 - STOPPED * 6 - REPAIR
    • PlatformListStatusEnumTypeTransformer
    Transformation class that can encode an instance of PlatformListStatusEnum to int, and decode dynamic data back to PlatformListStatusEnum.
    PlatformUpdatePostRequest
    PointsPercentile
    PredictiveAnalyticsRequest
    PredictiveAnalyticsResponse
    Product
    ProductTable
    Prompt
    PromptCategory
    ProviderEnum
  • webex - Webex * slack - Slack * whatsapp - Whatsapp * discord - Discord
    • ProviderEnumTypeTransformer
    Transformation class that can encode an instance of ProviderEnum to String, and decode dynamic data back to ProviderEnum.
    QueryEndpoint
    QueryParam
    RatingEnum
  • 1 - Up Vote * -1 - Down Vote
    • RatingEnumTypeTransformer
    Transformation class that can encode an instance of RatingEnum to int, and decode dynamic data back to RatingEnum.
    RecommendationsApi
    RecommendationSearchAPI
    RecommendCourseResponse
    RelatedText
    ReportCreate
    ReportData
    ReportedRole
    ReportedSkill
    ReportList
    ReportRequest
    ReportsApi
    ReportStatus
    RequestDataVariable
    ResourcePoint
    ResponseDataVariable
    RetreiverTrainViewRequest
    RetreiverTrainViewResponse
    RetrieverDocumentEmbedding
    RetrieverDocumentEmbeddingRequest
    RetrieverRequestSearch
    RetrieverRequestSearchDocument
    RetrieverResponseSearch
    RetrieveTask
    ReuestDataVariableList
    RevenueByProduct
    Role
    RolesApi
    SaasApi
    SampleQuestionsDocument
    SampleQuestionsDocumentStatusEnum
  • Pending - Pending * Processing - Processing * Completed - Completed * Failed - Failed
    • SampleQuestionsDocumentStatusEnumTypeTransformer
    Transformation class that can encode an instance of SampleQuestionsDocumentStatusEnum to String, and decode dynamic data back to SampleQuestionsDocumentStatusEnum.
    SearchApi
    ServiceApi
    SessionDetail
    Skill
    SkillDetail
    SkillInfo
    SkillsApi
    SkillThreshold
    SlackWebhook
    StateEnum
  • pending - Pending * running - Running * accumulating - Accumulating * processing - Processing * storing - Storing * completed - Completed * cancelled - Cancelled * error - Error
    • StateEnumTypeTransformer
    Transformation class that can encode an instance of StateEnum to String, and decode dynamic data back to StateEnum.
    StudentAnswer
    SubTimeChild
    SubTopic
    SuggestedPrompt
    SuggestedPromptIndex
    SuggestedPrompts
    Summary
    TaskView
    ThemeEnum
  • dark - Dark * light - Light
    • ThemeEnumTypeTransformer
    Transformation class that can encode an instance of ThemeEnum to String, and decode dynamic data back to ThemeEnum.
    TimeChildData
    TimeDetail
    TimeDetailChild
    TimeDetailData
    TimeSpentByUsersInCourse
    TimeSpentByUsersInCourseData
    TimeSpentPerCourse
    TimeSpentPerCourseData
    Topic
    TrainChatSessionDocumentView
    TrainDocumentViewRequest
    TrainDocumentViewResponse
    Usage
    UserChatFeedback
    UserPlatformManagementListViewGetResponse
    UserPlatformViewPostRequest
    UserProxyBulkRequest
    UserProxyGetResponse
    UserProxyPostRequest
    UserProxyPostResponse
    UserSearchViewGetResponse
    UserSkill
    UserSkillPointsPercentile
    Value
    ValueData
    VideoBlock
    VideoEngagementPerCourse
    VideoEngagementPerCourseData
    VideosCount
    VideosCountData
    VideosInCourseSummary
    VideosInCourseSummaryData
    VideosSpecificCourse
    VideosSpecificCourseData
    VideosWatchedSubSection
    WatchedVideosPerCourse
    WatchedVideosPerCourseData
    WatchedVideosPerUser
    WatchedVideosPerUserData
    WebexWebhook
    WebSocketStopGenerationView
    WhatAppWebHook

    Properties

    defaultApiClient ↔ ApiClient
    An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
    getter/setter pair

    Functions

    decodeAsync(DeserializationMessage message) → Future
    Primarily intended for use in an isolate.
    deserializeAsync(DeserializationMessage message) → Future
    Primarily intended for use in an isolate.
    mapCastOfType<K, V>(dynamic map, String key) → Map<K, V>?
    Returns a valid Map<K, V> found at the specified Map key, null otherwise.
    mapDateTime(dynamic map, String key, [String? pattern]) → DateTime?
    Returns a valid DateTime found at the specified Map key, null otherwise.
    mapValueOfType<T>(dynamic map, String key) → T?
    Returns a valid T value found at the specified Map key, null otherwise.
    parameterToString(dynamic value) → String
    Format the given parameter object into a String.
    serializeAsync(Object? value) → Future<String>
    Primarily intended for use in an isolate.

    Typedefs

    HttpBearerAuthProvider = String Function()

    Exceptions / Errors

    ApiException