Learners

Look up the institute's learners, and what is needed to enrol or edit them. Read-only. Pick an `action`:
- find (query): learners whose name, email, phone or username matches, with their courses. When several match, list them (name, email, phone, courses) and ask the admin which one — never guess.
- get (learner_id): one learner's full profile and enrolments — the fields learner_edit can change.
- enroll_options (course_ids: [..], max 10): each course's batches and the invites a learner can be enrolled through (name, price / payment type, default or not). Ask the admin which invite to use when a course has more than one. Batches sold to organisations are marked enrollable=false (enrol those from the dashboard). Also says whether the welcome email / login-details email may be sent, and which automations run on enrolment (they may send their own welcome message).
- enroll_template: the bulk-enrol CSV columns (same as the dashboard's template) as a header + sample row — hand it to the admin as a .csv file to fill in, then pass the rows (or the CSV text) to learner_enroll.

Change a learner's details: name, mobile number, password, gender, date of birth, address, city, state, PIN code, parents' names / phones / emails, school, and the institute's custom fields. Email and username can never be changed here. First find the learner with learners(action='find') — when several match, show them (name, email, phone, courses) and ask which one; never guess. Then:
- preview (learner_id, changes?: {field: new value}, password?, custom_fields?: {label or field_id: value}): checks the change and shows each field's current → new value. Nothing is saved. Returns a confirm_token (valid 15 min).
- apply (same arguments + confirm_token, send_credentials_via?: [EMAIL, WHATSAPP] — after a password change, sends the learner their login details; ask the admin): saves it.
changes keys: full_name, mobile_number, gender, date_of_birth, address_line, city, region, pin_code, fathers_name, mothers_name, parents_mobile_number, parents_email, parents_to_mother_mobile_number, parents_to_mother_email, linked_institute_name. gender: MALE | FEMALE | OTHER. date_of_birth: YYYY-MM-DD. Phone numbers with country code. A field cannot be blanked from here. The password is set to exactly what the admin gives (min 6 characters, no spaces) — never make one up unless asked, and do not repeat it back in the chat.

Enrol learners into courses through an invite — one learner or a whole list / CSV, into one or several courses at once (every learner goes into every course listed, like the dashboard's Enroll Learner dialog). Never removes or unenrols anyone. Steps: learners(action='enroll_options') for the courses → ask the admin which invite when a course has several (never pick a price for them) → preview → show the admin the outcome (who is new, who is already enrolled and skipped, which invite / price) and get a clear yes → enroll with the SAME arguments plus confirm_token. Pick an `action`:
- preview (learners and/or csv, courses, options?): checks everything and runs a dry run. Nothing is saved. Returns the per-learner outcome and a confirm_token (valid 15 min).
- enroll (same arguments + confirm_token): does it. Changed arguments need a new preview.
learners: [{learner_id} (an existing learner, from learners(action='find')) | a new-learner row using the enroll_template columns, e.g. {full_name, email, mobile_number, …, custom_fields?: {label: value}}] (max 200). csv: the filled-in template as CSV text (header row first). A row whose email / mobile already belongs to a learner of this institute enrols that learner and leaves their profile as is.
courses: [{course_id, batch_id? (needed when the course has several batches), invite_id? (needed when the course has several invites), access_days?}] (max 10).
options: {send_welcome_email: bool (the 'Welcome to <institute>' enrolment email — ASK the admin), send_credentials: bool (email username + password to NEW learners — ASK the admin; only asked when new accounts are created), duplicate_handling?: SKIP (default: already-enrolled learners are skipped) | ERROR (reported as failed), payment_date?: YYYY-MM-DD (offline payment received), transaction_id?, credentials_file: bool (a CSV of every enrolled learner's username + password, delivered as a private download link valid 30 minutes — ASK the admin)}. Never assume these answers: preview returns error 'ask_admin' until they are given (a switch turned off in Course Settings is not asked). Hand the credentials link to the admin as is; never open it. The preview also lists the enrolment automations that will run anyway — they may send their own welcome message; tell the admin.