@mitodl/ol-analytics-learner-records-api-axios 0.0.0-stage → 2026.10.20-1

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, MIT Office of Digital Learning
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/cjs/api.d.ts

@@ -0,0 +1,650 @@
+/**
+ * B2B Learner Records
+ * Machine-to-machine, read-only, organization-scoped learner progress records for B2B site-license partners. Records identify individual learners.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ * ``passed`` without ``certified`` is normal — certificates are issued on a schedule after grading, and audit-mode enrollments never certify.
+ */
+export declare const CompletionStatus: {
+    readonly NotStarted: "not_started";
+    readonly InProgress: "in_progress";
+    readonly Passed: "passed";
+    readonly Certified: "certified";
+};
+export type CompletionStatus = typeof CompletionStatus[keyof typeof CompletionStatus];
+export declare const CompletionStatusFilter: {
+    readonly NotStarted: "not_started";
+    readonly InProgress: "in_progress";
+    readonly Passed: "passed";
+    readonly Certified: "certified";
+    readonly Unknown: "unknown";
+};
+export type CompletionStatusFilter = typeof CompletionStatusFilter[keyof typeof CompletionStatusFilter];
+/**
+ * ``not_recorded`` = the learner has not answered. ``declined`` covers a learner who answered no and one who consented and later withdrew: MITx Online keeps one nullable boolean per (learner, contract).
+ */
+export declare const ConsentStatus: {
+    readonly Consented: "consented";
+    readonly Declined: "declined";
+    readonly NotRecorded: "not_recorded";
+};
+export type ConsentStatus = typeof ConsentStatus[keyof typeof ConsentStatus];
+/**
+ * One course run covered by one of the organization\'s contracts. No personal data, so no consent gate.
+ */
+export interface CourseRun {
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Display name of the organization.
+     */
+    'organization_name': string;
+    /**
+     * Numeric identifier of the B2B contract.
+     */
+    'contract_id': number;
+    /**
+     * Name of the B2B contract.
+     */
+    'contract_name': string;
+    /**
+     * Whether the contract is currently active.
+     */
+    'contract_is_active': boolean;
+    /**
+     * Null where the contract records no start date.
+     */
+    'contract_start_date': string | null;
+    /**
+     * Null where the contract records no end date.
+     */
+    'contract_end_date': string | null;
+    /**
+     * Null means uncapped, not zero.
+     */
+    'seat_limit': number | null;
+    /**
+     * Readable course-run identifier, e.g. `course-v1:MITxT+14.310x+2T2026`.
+     */
+    'courserun_id': string;
+    /**
+     * Mutable display title — key on courserun_id.
+     */
+    'courserun_title': string;
+    /**
+     * Start date/time of the course run, or null if unscheduled.
+     */
+    'courserun_start_on': string | null;
+    /**
+     * Null for self-paced runs.
+     */
+    'courserun_end_on': string | null;
+}
+/**
+ * One learner\'s enrollment in one course run under one contract.
+ */
+export interface Enrollment {
+    /**
+     * Stable opaque identifier, consistent across endpoints and stable across email changes. Use as the join key.
+     */
+    'learner_id': string;
+    /**
+     * Not a join key; may differ from the enrolling address.
+     */
+    'email': string | null;
+    /**
+     * Often null.
+     */
+    'full_name': string | null;
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Numeric identifier of the B2B contract the enrollment is attributed to.
+     */
+    'contract_id': number;
+    /**
+     * Name of the B2B contract.
+     */
+    'contract_name': string;
+    /**
+     * Readable course-run identifier, e.g. `course-v1:MITxT+14.310x+2T2026`.
+     */
+    'courserun_id': string;
+    /**
+     * Mutable display title — key on courserun_id.
+     */
+    'courserun_title': string;
+    /**
+     * Start date/time of the course run, or null if unscheduled.
+     */
+    'courserun_start_on': string | null;
+    /**
+     * Null for self-paced runs.
+     */
+    'courserun_end_on': string | null;
+    /**
+     * This run\'s enrollment, not an earlier run of the same course. Not consent-gated.
+     */
+    'enrolled_on': string;
+    /**
+     * Not consent-gated.
+     */
+    'enrollment_is_active': boolean;
+    /**
+     * e.g. `verified`, `audit`. Determines whether the run is certificate-bearing.
+     */
+    'enrollment_mode': string | null;
+    /**
+     * Deactivation reason where one was recorded.
+     */
+    'enrollment_status': string | null;
+    /**
+     * The learner\'s recorded decision for this enrollment\'s contract, before the deployment\'s default: not_recorded is a learner who has not answered, declined one who answered no or withdrew. Not consent-gated.
+     */
+    'outcomes_consent_status': ConsentStatus;
+    /**
+     * Whether the learner\'s course status is shared for this enrollment\'s contract. A recorded consent decision always decides it; with none recorded, the deployment\'s default does. False means every field below is null.
+     */
+    'outcomes_shared': boolean;
+    /**
+     * Single derived answer per row. Null when outcomes are withheld. in_progress means not passed or certified, with a nonzero grade or any tracked activity in the run; not_started means neither.
+     */
+    'completion_status': CompletionStatus | null;
+    /**
+     * Null where no grade has been computed.
+     */
+    'is_passing': boolean | null;
+    /**
+     * Numeric grade between 0 and 1.
+     */
+    'grade': number | null;
+    /**
+     * Frequently null — not every platform records one.
+     */
+    'letter_grade': string | null;
+    /**
+     * Share of the run\'s current course content the learner has completed, between 0 and 1. Times 100 it is the completion percent on the course\'s progress page. Not an input to completion_status: a certified learner can be below 1. Null where the run has no content to count. Changes to it do not move updated_since.
+     */
+    'content_progress': number | null;
+    /**
+     * Timestamp the certificate was issued, or null if none exists.
+     */
+    'certificate_issued_on': string | null;
+    /**
+     * Null where no certificate exists. A revoked certificate doesn\'t count as certified: completion_status then follows the grade, so it can read passed, in_progress or not_started.
+     */
+    'certificate_is_revoked': boolean | null;
+    /**
+     * Most recent day with tracked activity in this course run. A date in the course platform\'s local day, not a UTC day. Null with no activity. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'last_active_on': string | null;
+    /**
+     * Distinct days with tracked activity in this course run. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'days_active': number | null;
+    /**
+     * Video blocks played, counted once per day: a block played on two days counts twice. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'videos_watched': number | null;
+    /**
+     * Problem blocks checked, counted once per day: a block attempted on two days counts twice. Viewing an answer is not an attempt. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'problems_attempted': number | null;
+    /**
+     * Chatbot submits in this course run, counting each (session, block) once per day. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'chatbot_interactions': number | null;
+}
+export interface HTTPValidationError {
+    'detail'?: Array<ValidationError>;
+}
+/**
+ * One learner\'s association with the organization.
+ */
+export interface Learner {
+    /**
+     * Stable opaque identifier, consistent across endpoints and stable across email changes. Use as the join key.
+     */
+    'learner_id': string;
+    /**
+     * Not a join key; may differ from the enrolling address.
+     */
+    'email': string | null;
+    /**
+     * Often null.
+     */
+    'full_name': string | null;
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Display name of the organization.
+     */
+    'organization_name': string;
+    /**
+     * How the learner is associated with the organization; see MembershipSource for the individual values.
+     */
+    'membership_source': MembershipSource;
+    /**
+     * Administers the organization in MITx Online.
+     */
+    'is_organization_manager': boolean;
+    /**
+     * Null for a roster member with no enrollments.
+     */
+    'first_enrolled_on': string | null;
+    /**
+     * Timestamp of the learner\'s most recent enrollment.
+     */
+    'last_enrolled_on': string | null;
+    /**
+     * Distinct course runs under the organization\'s contracts. Not consent-gated.
+     */
+    'courses_enrolled': number;
+    /**
+     * The learner\'s recorded decision, before the deployment\'s default: not_recorded is a learner who has not answered, declined one who answered no or withdrew. Across several contracts any decline reads declined, then any contract with no decision reads not_recorded. Not consent-gated.
+     */
+    'outcomes_consent_status': ConsentStatus;
+    /**
+     * Whether this learner\'s course status is shared. A recorded consent decision always decides it; with none recorded, the deployment\'s default does. False means every field below is null.
+     */
+    'outcomes_shared': boolean;
+    /**
+     * When consent was recorded. Null when outcomes_shared is false, and when it is true with no recorded decision.
+     */
+    'outcomes_consent_on': string | null;
+    /**
+     * Most recent day with tracked course activity (video play, problem check, navigation, discussion or chatbot submit) across the enrollments the request covers: active ones only, unless include_inactive is set. A date in the course platform\'s local day, not a UTC day. Null with no activity. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'last_active_on': string | null;
+    /**
+     * Distinct course runs whose completion_status is in_progress: not passed or certified, with a nonzero grade or any tracked activity. Active enrollments only, unless include_inactive is set. Changes to it do not move updated_since; a full reload picks them up.
+     */
+    'courses_in_progress': number | null;
+    /**
+     * Distinct course runs where the learner has a passing grade.
+     */
+    'courses_passed': number | null;
+    /**
+     * Distinct course runs where the learner holds a non-revoked certificate.
+     */
+    'courses_certified': number | null;
+    /**
+     * Includes program certificates, which have no course run and so are not in courses_certified.
+     */
+    'certificates_earned': number | null;
+}
+export interface LearnerRecordsResponseCourseRun {
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Last refresh of the backing data. Null before an organization\'s first refresh.
+     */
+    'as_of': string | null;
+    /**
+     * Matching records across all pages, not this page.
+     */
+    'total_count': number;
+    /**
+     * Records in total_count carrying outcomes_shared: false. Always 0 on endpoints with no consent gate.
+     */
+    'outcomes_withheld_count': number;
+    /**
+     * The requested page of records.
+     */
+    'data': Array<CourseRun>;
+}
+export interface LearnerRecordsResponseEnrollment {
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Last refresh of the backing data. Null before an organization\'s first refresh.
+     */
+    'as_of': string | null;
+    /**
+     * Matching records across all pages, not this page.
+     */
+    'total_count': number;
+    /**
+     * Records in total_count carrying outcomes_shared: false. Always 0 on endpoints with no consent gate.
+     */
+    'outcomes_withheld_count': number;
+    /**
+     * The requested page of records.
+     */
+    'data': Array<Enrollment>;
+}
+export interface LearnerRecordsResponseLearner {
+    /**
+     * The organization\'s Keycloak organization UUID.
+     */
+    'organization_id': string;
+    /**
+     * Last refresh of the backing data. Null before an organization\'s first refresh.
+     */
+    'as_of': string | null;
+    /**
+     * Matching records across all pages, not this page.
+     */
+    'total_count': number;
+    /**
+     * Records in total_count carrying outcomes_shared: false. Always 0 on endpoints with no consent gate.
+     */
+    'outcomes_withheld_count': number;
+    /**
+     * The requested page of records.
+     */
+    'data': Array<Learner>;
+}
+export interface LocationInner {
+}
+/**
+ * ``roster`` = on the organization\'s membership roster with no enrollments (an assigned, unstarted seat). ``enrollment`` = enrolled under a contract but absent from the roster (usually a provisioning lag). ``both`` = the expected state.
+ */
+export declare const MembershipSource: {
+    readonly Roster: "roster";
+    readonly Enrollment: "enrollment";
+    readonly Both: "both";
+};
+export type MembershipSource = typeof MembershipSource[keyof typeof MembershipSource];
+export interface ValidationError {
+    'loc': Array<LocationInner>;
+    'msg': string;
+    'type': string;
+    'input'?: any;
+    'ctx'?: object;
+}
+/**
+ * CatalogApi - axios parameter creator
+ */
+export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Contracts and course runs covered by the organization\'s licence
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {boolean | null} [contract_is_active]
+     * @param {string | null} [courserun_id]
+     * @param {string | null} [courserun_starts_after] Return only course runs starting at or after this instant. Self-paced or otherwise unscheduled runs have no start date and match neither this nor courserun_starts_before; a partitioned sync needs one pass with neither set to pick those up.
+     * @param {string | null} [courserun_starts_before] Return only course runs starting strictly before this instant.
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCourses: (organization_id: string, contract_id?: number | null, contract_is_active?: boolean | null, courserun_id?: string | null, courserun_starts_after?: string | null, courserun_starts_before?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CatalogApi - functional programming interface
+ */
+export declare const CatalogApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Contracts and course runs covered by the organization\'s licence
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {boolean | null} [contract_is_active]
+     * @param {string | null} [courserun_id]
+     * @param {string | null} [courserun_starts_after] Return only course runs starting at or after this instant. Self-paced or otherwise unscheduled runs have no start date and match neither this nor courserun_starts_before; a partitioned sync needs one pass with neither set to pick those up.
+     * @param {string | null} [courserun_starts_before] Return only course runs starting strictly before this instant.
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCourses(organization_id: string, contract_id?: number | null, contract_is_active?: boolean | null, courserun_id?: string | null, courserun_starts_after?: string | null, courserun_starts_before?: string | null, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LearnerRecordsResponseCourseRun>>;
+};
+/**
+ * CatalogApi - factory interface
+ */
+export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Contracts and course runs covered by the organization\'s licence
+     * @param {CatalogApiListCoursesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCourses(requestParameters: CatalogApiListCoursesRequest, options?: RawAxiosRequestConfig): AxiosPromise<LearnerRecordsResponseCourseRun>;
+};
+/**
+ * Request parameters for listCourses operation in CatalogApi.
+ */
+export interface CatalogApiListCoursesRequest {
+    readonly organization_id: string;
+    readonly contract_id?: number | null;
+    readonly contract_is_active?: boolean | null;
+    readonly courserun_id?: string | null;
+    /**
+     * Return only course runs starting at or after this instant. Self-paced or otherwise unscheduled runs have no start date and match neither this nor courserun_starts_before; a partitioned sync needs one pass with neither set to pick those up.
+     */
+    readonly courserun_starts_after?: string | null;
+    /**
+     * Return only course runs starting strictly before this instant.
+     */
+    readonly courserun_starts_before?: string | null;
+    readonly limit?: number;
+    readonly offset?: number;
+}
+/**
+ * CatalogApi - object-oriented interface
+ */
+export declare class CatalogApi extends BaseAPI {
+    /**
+     *
+     * @summary Contracts and course runs covered by the organization\'s licence
+     * @param {CatalogApiListCoursesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCourses(requestParameters: CatalogApiListCoursesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LearnerRecordsResponseCourseRun, any, {}, any>>;
+}
+/**
+ * EnrollmentsApi - axios parameter creator
+ */
+export declare const EnrollmentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Learner-by-course-run enrollment and completion records
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {string | null} [courserun_id]
+     * @param {Array<string>} [learner_id] Repeat for several.
+     * @param {Array<CompletionStatusFilter>} [completion_status]
+     * @param {string | null} [updated_since] Return only records changed at or after this instant.
+     * @param {string | null} [updated_before] Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded, transferred).
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEnrollments: (organization_id: string, contract_id?: number | null, courserun_id?: string | null, learner_id?: Array<string>, completion_status?: Array<CompletionStatusFilter>, updated_since?: string | null, updated_before?: string | null, include_inactive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EnrollmentsApi - functional programming interface
+ */
+export declare const EnrollmentsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Learner-by-course-run enrollment and completion records
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {string | null} [courserun_id]
+     * @param {Array<string>} [learner_id] Repeat for several.
+     * @param {Array<CompletionStatusFilter>} [completion_status]
+     * @param {string | null} [updated_since] Return only records changed at or after this instant.
+     * @param {string | null} [updated_before] Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded, transferred).
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEnrollments(organization_id: string, contract_id?: number | null, courserun_id?: string | null, learner_id?: Array<string>, completion_status?: Array<CompletionStatusFilter>, updated_since?: string | null, updated_before?: string | null, include_inactive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LearnerRecordsResponseEnrollment>>;
+};
+/**
+ * EnrollmentsApi - factory interface
+ */
+export declare const EnrollmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Learner-by-course-run enrollment and completion records
+     * @param {EnrollmentsApiListEnrollmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEnrollments(requestParameters: EnrollmentsApiListEnrollmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<LearnerRecordsResponseEnrollment>;
+};
+/**
+ * Request parameters for listEnrollments operation in EnrollmentsApi.
+ */
+export interface EnrollmentsApiListEnrollmentsRequest {
+    readonly organization_id: string;
+    readonly contract_id?: number | null;
+    readonly courserun_id?: string | null;
+    /**
+     * Repeat for several.
+     */
+    readonly learner_id?: Array<string>;
+    readonly completion_status?: Array<CompletionStatusFilter>;
+    /**
+     * Return only records changed at or after this instant.
+     */
+    readonly updated_since?: string | null;
+    /**
+     * Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     */
+    readonly updated_before?: string | null;
+    /**
+     * Include deactivated enrollments (unenrolled, refunded, transferred).
+     */
+    readonly include_inactive?: boolean;
+    readonly limit?: number;
+    readonly offset?: number;
+}
+/**
+ * EnrollmentsApi - object-oriented interface
+ */
+export declare class EnrollmentsApi extends BaseAPI {
+    /**
+     *
+     * @summary Learner-by-course-run enrollment and completion records
+     * @param {EnrollmentsApiListEnrollmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listEnrollments(requestParameters: EnrollmentsApiListEnrollmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LearnerRecordsResponseEnrollment, any, {}, any>>;
+}
+/**
+ * LearnersApi - axios parameter creator
+ */
+export declare const LearnersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Learner roster with progress rollups
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {Array<string>} [learner_id] Repeat for several.
+     * @param {string | null} [updated_since] Return only records changed at or after this instant.
+     * @param {string | null} [updated_before] Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded, transferred).
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLearners: (organization_id: string, contract_id?: number | null, learner_id?: Array<string>, updated_since?: string | null, updated_before?: string | null, include_inactive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * LearnersApi - functional programming interface
+ */
+export declare const LearnersApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Learner roster with progress rollups
+     * @param {string} organization_id
+     * @param {number | null} [contract_id]
+     * @param {Array<string>} [learner_id] Repeat for several.
+     * @param {string | null} [updated_since] Return only records changed at or after this instant.
+     * @param {string | null} [updated_before] Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded, transferred).
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLearners(organization_id: string, contract_id?: number | null, learner_id?: Array<string>, updated_since?: string | null, updated_before?: string | null, include_inactive?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LearnerRecordsResponseLearner>>;
+};
+/**
+ * LearnersApi - factory interface
+ */
+export declare const LearnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Learner roster with progress rollups
+     * @param {LearnersApiListLearnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLearners(requestParameters: LearnersApiListLearnersRequest, options?: RawAxiosRequestConfig): AxiosPromise<LearnerRecordsResponseLearner>;
+};
+/**
+ * Request parameters for listLearners operation in LearnersApi.
+ */
+export interface LearnersApiListLearnersRequest {
+    readonly organization_id: string;
+    readonly contract_id?: number | null;
+    /**
+     * Repeat for several.
+     */
+    readonly learner_id?: Array<string>;
+    /**
+     * Return only records changed at or after this instant.
+     */
+    readonly updated_since?: string | null;
+    /**
+     * Return only records changed strictly before this instant. Paired with updated_since, bounds a window for a partitioned backfill or replay.
+     */
+    readonly updated_before?: string | null;
+    /**
+     * Include deactivated enrollments (unenrolled, refunded, transferred).
+     */
+    readonly include_inactive?: boolean;
+    readonly limit?: number;
+    readonly offset?: number;
+}
+/**
+ * LearnersApi - object-oriented interface
+ */
+export declare class LearnersApi extends BaseAPI {
+    /**
+     *
+     * @summary Learner roster with progress rollups
+     * @param {LearnersApiListLearnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLearners(requestParameters: LearnersApiListLearnersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LearnerRecordsResponseLearner, any, {}, any>>;
+}
+//# sourceMappingURL=api.d.ts.map