api library

Classes

AcceptInvitation
ACourse
ACourseSubject
ACourseSubscription
AnswerTypeEnum
  • selectall - Select All * selectone - Select One * truefalse - True/False
    • AnswerTypeEnumTypeTransformer
    Transformation class that can encode an instance of AnswerTypeEnum to String, and decode dynamic data back to AnswerTypeEnum.
    ApiApi
    ApiClient
    ApiKeyAuth
    Authentication
    Availability
    AvailabilitySlot
    BaseResponseDTO
    Booking
    BookingCancel
    BookingReschedule
    BookingTime
    Card
    CardCreate
    CategoryEnum
  • DBS_CERTIFICATE_FILE - DBS Certificate * PASSPORT_FILE - Current Valid Passport * BRP_FILE - Biometric Residence Permit * PHOTOCARD_FILE - Current Photocard Driving Licence * BIRTH_CERT_FILE - Birth Certificate * ADOPTION_CERT_FILE - Adoption Certificate * DRIVING_LICENCE_FILE - Photocard Driver Licence * OLD_DRIVING_LICENCE_FILE - Old Style Paper Driver Licence * MARRIAGE_PARTNERSHIP_CERT_FILE - Marriage/Civil Partnership Certificate * HM_FORCES_ID_CARD_FILE - HM Forces ID Card * FIRE_ARMS_LICENCE_FILE - Fire Arms Licence * MORTGAGE_STATEMENT_FILE - Mortgage Statement * BANK_STATEMENT_FILE - Bank/Building Society Statement * BANK_OPENING_CONFIRMATION_FILE - Bank/Building Society Account Opening Confirmation Letter * FINANCIAL_STATEMENT_FILE - Financial Statement * P45_P60_STATEMENT_FILE - P45/P60 Statement * COUNCIL_TAX_FILE - Council Tax Statement * WORK_PERMIT_VISA_FILE - Work Permit/Visa * GAS_BILL_FILE - Utility Bill - Gas * ELECTRICITY_BILL_FILE - Utility Bill - Electricity * WATER_BILL_FILE - Utility Bill - Water * PHONE_BILL_FILE - Utility Bill - Phone * BENEFIT_STATEMENT_FILE - Benefit Statement * CENTRAL_GOV_DOCUMENT_FILE - Central Government Document * EU_ID_CARD_FILE - EU National ID Card * CARD_PASS_FILE - Cards carrying the PASS acreditation Logo * TEACHER_LETTER_FILE - Letter from Head Teacher or College Principal * SPONSOR_LETTER_FILE - Letter of sponsorship for future employment provider * PLAIN_FILE - Other Type of file * CURRICULUM_VITAE_FILE - Tutor curriculum vitae
    • CategoryEnumTypeTransformer
    Transformation class that can encode an instance of CategoryEnum to String, and decode dynamic data back to CategoryEnum.
    Chat
    ChatTutor
    ChatUser
    CheckSMSVerificationCode
    ClearPhoneCache
    ConfirmedStatusEnum
  • great - It was great! * problem - Problem * timeout - Automatically closed
    • ConfirmedStatusEnumTypeTransformer
    Transformation class that can encode an instance of ConfirmedStatusEnum to String, and decode dynamic data back to ConfirmedStatusEnum.
    ContactUs
    Country
    Coupon
    CouponCodeCheck
    CourseOption
    CreateAccount
    CreateSMSAccountRequestDTO
    CreateSMSAccountResponseDTO
    CreateSMSCustomerRequestDTO
    CreateSMSCustomerResponseDTO
    Customer
    CustomerEnquiry
    CustomerFeedback
    CustomerFeedbackStatusEnum
  • negative - Negative * positive - Positive * neutral - Neutral * problem--tutor-absent - Tutor didn't turn up * problem--tutor-late - Tutor was late * problem--tutor-left-early - Tutor didn't stay for the agreed time * problem--undefined - Something else
    • CustomerFeedbackStatusEnumTypeTransformer
    Transformation class that can encode an instance of CustomerFeedbackStatusEnum to String, and decode dynamic data back to CustomerFeedbackStatusEnum.
    CustomerInterest
    CustomerJobPostCreate
    CustomerProfile
    CustomerSettings
    Day
    DayEnum
  • 1 - Monday * 2 - Tuesday * 3 - Wednesday * 4 - Thursday * 5 - Friday * 6 - Saturday * 7 - Sunday
    • DayEnumTypeTransformer
    Transformation class that can encode an instance of DayEnum to int, and decode dynamic data back to DayEnum.
    DeserializationMessage
    Primarily intended for use in an isolate.
    DiscountTypeEnum
  • Discount - Discount * FreeLessons - Free Lessons
    • DiscountTypeEnumTypeTransformer
    Transformation class that can encode an instance of DiscountTypeEnum to String, and decode dynamic data back to DiscountTypeEnum.
    DownloadRequest
    EmailConfirmation
    Enquiry
    FcmDeviceToken
    FeedbackBooking
    FeedbackSerialCourse
    FindTutorRequest
    FullChat
    FullUser
    GroupSubjects
    HttpBasicAuth
    HttpBearerAuth
    IndexTutorCard
    IndexTutors
    Interest
    Invitation
    InvitationDate
    InvitationDateCreate
    InvitationInstant
    JobApplication
    JobApplicationCreate
    JobApplicationTutor
    JobApplicationTutorMinimal
    JobPostAvailability
    JobPostDetail
    JobPostList
    JobPostShort
    JobPostStudentAvailability
    JobPostView
    JobTypeEnum
  • primary - Primary * secondary - Secondary
    • JobTypeEnumTypeTransformer
    Transformation class that can encode an instance of JobTypeEnum to String, and decode dynamic data back to JobTypeEnum.
    LastMessage
    LessonPrice
    Level
    LiveSessionTypeEnum
  • 1 - WhiteBoard * 2 - Zoom
    • LiveSessionTypeEnumTypeTransformer
    Transformation class that can encode an instance of LiveSessionTypeEnum to int, and decode dynamic data back to LiveSessionTypeEnum.
    LoginNewRequestDTO
    LoginRequestDTO
    LoginResponseDTO
    Message
    MessageTutorEnquiry
    NotificationActionEnum
  • ComingBookings - ComingBookings * CompletedBookings - CompletedBookings * TrialBookings - TrialBookings
    • NotificationActionEnumTypeTransformer
    Transformation class that can encode an instance of NotificationActionEnum to String, and decode dynamic data back to NotificationActionEnum.
    NotificationType
    OAuth
    OnboardingFlowCreateCustomer
    PaginatedCustomerFeedbackList
    PaginatedJobApplicationList
    PaginatedPushNotificationList
    PaginatedTutorCardList
    PaginatedTutorJobPostViewList
    PaginatedTutorReferenceListList
    PaginatedUserNotificationList
    PasswordRestRequest
    PatchedBooking
    PatchedBookingReschedule
    PatchedCustomerFeedback
    PatchedCustomerSettings
    PatchedInvitation
    PatchedPersonalityTestLevel
    PatchedtutorBooking
    PatchedTutorFeedback
    PatchedTutorInvitation
    PatchedTutorProfileOnboarding
    PatchedTutorReference
    PatchedTutorReview
    PatchedtutorSerialCourse
    PatchedTutorSettings
    PatchedTutorSupplyProfile
    PatchedUserProfile
    PatchedUserProfileUpdateRequestDTO
    PersonalityEnquiry
    PersonalityTestLevel
    PersonalityTestSubject
    PhoneConfirmation
    PhoneConfirmationResend
    ProfileAttachment
    PushNotification
    Qualification
    QueryParam
    Question
    QuestionOption
    RecaptchaToken
    RecordAction
    RequestTutor
    School
    SchoolsupplyRequestTutor
    SendEmailVerificationCode
    SendPersonalityEnquiryToTutor
    SendSMSVerificationCode
    SerialCourseCustomer
    Session
    SetupIntent
    SimpleSubjectLevel
    SocialAuthMethodEnum
  • google-oauth2 - Goolge * linkedin-oauth2 - Linked In * facebook - Facebook * none - None
    • SocialAuthMethodEnumTypeTransformer
    Transformation class that can encode an instance of SocialAuthMethodEnum to String, and decode dynamic data back to SocialAuthMethodEnum.
    SocialLogin
    SocialToken
    Status59dEnum
  • ok - ok * fail - fail
    • Status59dEnumTypeTransformer
    Transformation class that can encode an instance of Status59dEnum to String, and decode dynamic data back to Status59dEnum.
    StatusC27Enum
  • archived - Archived * deleted - Deleted * published - Published * taken - Taken * unpublished - Unpublished * filled - Position filled
    • StatusC27EnumTypeTransformer
    Transformation class that can encode an instance of StatusC27Enum to String, and decode dynamic data back to StatusC27Enum.
    StripeAuthorize
    StudentPersonality
    Subject
    SubjectLevel
    SubjectLevels
    SubscribedNotification
    SubscriptionStatusEnum
  • SubscriptionStatus.SCHEDULED - SCHEDULED * SubscriptionStatus.TRIALING - TRIALING * SubscriptionStatus.ACTIVE - ACTIVE * SubscriptionStatus.PAST_DUE - PAST_DUE * SubscriptionStatus.CANCELED - CANCELED * SubscriptionStatus.UNPAID - UNPAID * SubscriptionStatus.INCOMPLETE - INCOMPLETE * SubscriptionStatus.INCOMPLETE_EXPIRED - INCOMPLETE_EXPIRED
    • SubscriptionStatusEnumTypeTransformer
    Transformation class that can encode an instance of SubscriptionStatusEnum to String, and decode dynamic data back to SubscriptionStatusEnum.
    SupplyTeachingExperience
    SupplyTeachingLevel
    SwaggerUiApi
    TeachingExperience
    TeachingFrequency
    TeachingLevel
    TestAnswer
    TrialCallInvitation
    Tutor
    TutorAvailability
    TutorBooking
    TutorCard
    TutorCardSubject
    TutorCreateAccount
    TutorCruncherSignup
    TutorEnquiry
    TutorFeedback
    TutorInvitation
    TutorInvitationCreate
    TutorInvitationResponse
    TutorJobPostView
    TutorLogin
    TutorPersonalityEnquiry
    TutorProfile
    TutorProfileDisplay
    TutorProfileFiles
    TutorProfileMinimal
    TutorProfileOnboarding
    TutorProfileOnboardingDTO
    TutorQualification
    TutorReference
    TutorReferenceCreate
    TutorReferenceList
    TutorReview
    TutorSerialCourse
    TutorSettings
    TutorSMSCreateAccount
    TutorSubject
    TutorSupplyProfile
    TutorTimeOff
    TypeAf8Enum
  • text - Text * invitation - Invitation * enquiry - Enquiry * booking--cancelled - Booking Cancelled * tutor-enquiry--accepted_online - Tutor Enquiry Accepted Online * tutor-enquiry--accepted - Tutor Enquiry Accepted * invitation--cancelled - Invitation Cancelled * invitation--rejected - Invitation Rejected * tutor-enquiry--rejected - Tutor Enquiry Rejected * booking--confirmed-timeout - Booking Confirmed Timeout * invitation--accepted - Invitation Accepted * invitation--cancelled-inviteexpired - Invitation Cancelled (Invite Expired) * invitation--created - Invitation Created
    • TypeAf8EnumTypeTransformer
    Transformation class that can encode an instance of TypeAf8Enum to String, and decode dynamic data back to TypeAf8Enum.
    User
    UserDataDTO
    UserNotification
    UserNotificationTypeEnum
  • internal - internal * email - email * sms - sms * all - all
    • UserNotificationTypeEnumTypeTransformer
    Transformation class that can encode an instance of UserNotificationTypeEnum to String, and decode dynamic data back to UserNotificationTypeEnum.
    UserProfile
    UserProfileResponseDTO
    UserProfileUpdateRequestDTO
    UserRetrival
    UserUpdate
    ZoomMeeting

    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