/** * MIT Learn API * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) * * * 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'; /** * * `resource_type` - resource_type * `certification` - certification * `certification_type` - certification_type * `offered_by` - offered_by * `platform` - platform * `topic` - topic * `department` - department * `level` - level * `course_feature` - course_feature * `professional` - professional * `free` - free * `delivery` - delivery * `resource_type_group` - resource_type_group * `resource_category` - resource_category * @export * @enum {string} */ export declare const AggregationsEnum: { /** * resource_type */ readonly ResourceType: "resource_type"; /** * certification */ readonly Certification: "certification"; /** * certification_type */ readonly CertificationType: "certification_type"; /** * offered_by */ readonly OfferedBy: "offered_by"; /** * platform */ readonly Platform: "platform"; /** * topic */ readonly Topic: "topic"; /** * department */ readonly Department: "department"; /** * level */ readonly Level: "level"; /** * course_feature */ readonly CourseFeature: "course_feature"; /** * professional */ readonly Professional: "professional"; /** * free */ readonly Free: "free"; /** * delivery */ readonly Delivery: "delivery"; /** * resource_type_group */ readonly ResourceTypeGroup: "resource_type_group"; /** * resource_category */ readonly ResourceCategory: "resource_category"; }; export type AggregationsEnum = typeof AggregationsEnum[keyof typeof AggregationsEnum]; /** * * `dated` - Dated * `anytime` - Anytime * @export * @enum {string} */ export declare const AvailabilityEnum: { /** * Dated */ readonly Dated: "dated"; /** * Anytime */ readonly Anytime: "anytime"; }; export type AvailabilityEnum = typeof AvailabilityEnum[keyof typeof AvailabilityEnum]; /** * Serializer for caption URL entries * @export * @interface CaptionUrl */ export interface CaptionUrl { /** * * @type {string} * @memberof CaptionUrl */ 'language': string; /** * * @type {string} * @memberof CaptionUrl */ 'language_name': string; /** * * @type {string} * @memberof CaptionUrl */ 'url': string; } /** * Serializer for caption URL entries * @export * @interface CaptionUrlRequest */ export interface CaptionUrlRequest { /** * * @type {string} * @memberof CaptionUrlRequest */ 'language': string; /** * * @type {string} * @memberof CaptionUrlRequest */ 'language_name': string; /** * * @type {string} * @memberof CaptionUrlRequest */ 'url': string; } /** * * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @export * @enum {string} */ export declare const CertificationTypeEnum: { /** * MicroMasters Credential */ readonly Micromasters: "micromasters"; /** * Professional Certificate */ readonly Professional: "professional"; /** * Certificate of Completion */ readonly Completion: "completion"; /** * No Certificate */ readonly None: "none"; }; export type CertificationTypeEnum = typeof CertificationTypeEnum[keyof typeof CertificationTypeEnum]; /** * Serializer class for course run ContentFiles * @export * @interface ContentFile */ export interface ContentFile { /** * * @type {number} * @memberof ContentFile */ 'id': number; /** * * @type {number} * @memberof ContentFile */ 'run_id'?: number; /** * * @type {number} * @memberof ContentFile */ 'direct_learning_resource_id'?: number | null; /** * * @type {string} * @memberof ContentFile */ 'run_title'?: string; /** * * @type {string} * @memberof ContentFile */ 'run_slug'?: string; /** * * @type {Array} * @memberof ContentFile */ 'departments': Array; /** * * @type {string} * @memberof ContentFile */ 'semester'?: string; /** * * @type {number} * @memberof ContentFile */ 'year'?: number; /** * * @type {Array} * @memberof ContentFile */ 'topics': Array; /** * * @type {string} * @memberof ContentFile */ 'key'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'uid'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'title'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'description'?: string | null; /** * * @type {boolean} * @memberof ContentFile */ 'require_summaries': boolean; /** * * @type {string} * @memberof ContentFile */ 'url'?: string | null; /** * * @type {Array} * @memberof ContentFile */ 'content_feature_type': Array; /** * * @type {ContentFileContentTypeEnum} * @memberof ContentFile */ 'content_type'?: ContentFileContentTypeEnum; /** * * @type {string} * @memberof ContentFile */ 'content'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'content_title'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'content_author'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'content_language'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'checksum'?: string; /** * * @type {string} * @memberof ContentFile */ 'image_src'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'resource_id': string; /** * * @type {string} * @memberof ContentFile */ 'resource_readable_id': string; /** * * @type {string} * @memberof ContentFile */ 'source_path'?: string; /** * Extract the course number(s) from the associated course * @type {Array} * @memberof ContentFile */ 'course_number': Array; /** * * @type {string} * @memberof ContentFile */ 'file_type'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'file_extension'?: string | null; /** * * @type {LearningResourceOfferor} * @memberof ContentFile */ 'offered_by': LearningResourceOfferor; /** * * @type {LearningResourcePlatform} * @memberof ContentFile */ 'platform': LearningResourcePlatform; /** * * @type {string} * @memberof ContentFile */ 'run_readable_id'?: string; /** * * @type {string} * @memberof ContentFile */ 'edx_module_id'?: string | null; /** * * @type {string} * @memberof ContentFile */ 'summary'?: string; /** * * @type {any} * @memberof ContentFile */ 'flashcards'?: any; /** * * @type {string} * @memberof ContentFile */ 'youtube_id'?: string | null; } /** * * `page` - page * `file` - file * `video` - video * `pdf` - pdf * @export * @enum {string} */ export declare const ContentFileContentTypeEnum: { /** * page */ readonly Page: "page"; /** * file */ readonly File: "file"; /** * video */ readonly Video: "video"; /** * pdf */ readonly Pdf: "pdf"; }; export type ContentFileContentTypeEnum = typeof ContentFileContentTypeEnum[keyof typeof ContentFileContentTypeEnum]; /** * SearchResponseSerializer with OpenAPI annotations for Content Files search * @export * @interface ContentFileSearchResponse */ export interface ContentFileSearchResponse { /** * * @type {number} * @memberof ContentFileSearchResponse */ 'count': number; /** * * @type {string} * @memberof ContentFileSearchResponse */ 'next': string | null; /** * * @type {string} * @memberof ContentFileSearchResponse */ 'previous': string | null; /** * * @type {Array} * @memberof ContentFileSearchResponse */ 'results': Array; /** * * @type {ContentFileSearchResponseMetadata} * @memberof ContentFileSearchResponse */ 'metadata': ContentFileSearchResponseMetadata; } /** * * @export * @interface ContentFileSearchResponseMetadata */ export interface ContentFileSearchResponseMetadata { /** * * @type {{ [key: string]: Array; }} * @memberof ContentFileSearchResponseMetadata */ 'aggregations': { [key: string]: Array; }; /** * * @type {Array} * @memberof ContentFileSearchResponseMetadata */ 'suggestions': Array; } /** * * @export * @interface ContentFileSearchResponseMetadataAggregationsValueInner */ export interface ContentFileSearchResponseMetadataAggregationsValueInner { /** * * @type {string} * @memberof ContentFileSearchResponseMetadataAggregationsValueInner */ 'key': string; /** * * @type {number} * @memberof ContentFileSearchResponseMetadataAggregationsValueInner */ 'doc_count': number; } /** * Serializer for ContentFile webhook requests. * @export * @interface ContentFileWebHookRequest */ export interface ContentFileWebHookRequest { /** * * @type {string} * @memberof ContentFileWebHookRequest */ 'content_path'?: string; /** * * @type {SourceEnum} * @memberof ContentFileWebHookRequest */ 'source': SourceEnum; /** * * @type {string} * @memberof ContentFileWebHookRequest */ 'course_id'?: string; /** * * @type {string} * @memberof ContentFileWebHookRequest */ 'course_readable_id'?: string; } /** * Serializer for ContentFile webhook requests. * @export * @interface ContentFileWebHookRequestRequest */ export interface ContentFileWebHookRequestRequest { /** * * @type {string} * @memberof ContentFileWebHookRequestRequest */ 'content_path'?: string; /** * * @type {SourceEnum} * @memberof ContentFileWebHookRequestRequest */ 'source': SourceEnum; /** * * @type {string} * @memberof ContentFileWebHookRequestRequest */ 'course_id'?: string; /** * * @type {string} * @memberof ContentFileWebHookRequestRequest */ 'course_readable_id'?: string; } /** * Serializer for the Course model * @export * @interface Course */ export interface Course { /** * * @type {Array} * @memberof Course */ 'course_numbers': Array | null; } /** * Serializer for CourseNumber * @export * @interface CourseNumber */ export interface CourseNumber { /** * * @type {string} * @memberof CourseNumber */ 'value': string; /** * * @type {LearningResourceDepartment} * @memberof CourseNumber */ 'department': LearningResourceDepartment; /** * * @type {string} * @memberof CourseNumber */ 'listing_type': string; } /** * Serializer for CourseNumber * @export * @interface CourseNumberRequest */ export interface CourseNumberRequest { /** * * @type {string} * @memberof CourseNumberRequest */ 'value': string; /** * * @type {LearningResourceDepartmentRequest} * @memberof CourseNumberRequest */ 'department': LearningResourceDepartmentRequest; /** * * @type {string} * @memberof CourseNumberRequest */ 'listing_type': string; } /** * Serializer for the Course model * @export * @interface CourseRequest */ export interface CourseRequest { /** * * @type {Array} * @memberof CourseRequest */ 'course_numbers': Array | null; } /** * Serializer for course resources * @export * @interface CourseResource */ export interface CourseResource { /** * * @type {number} * @memberof CourseResource */ 'id': number; /** * * @type {Array} * @memberof CourseResource */ 'topics'?: Array; /** * * @type {number} * @memberof CourseResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof CourseResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof CourseResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof CourseResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof CourseResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof CourseResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof CourseResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof CourseResource */ 'prices': Array; /** * * @type {Array} * @memberof CourseResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof CourseResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof CourseResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof CourseResource */ 'views': number; /** * * @type {Array} * @memberof CourseResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof CourseResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof CourseResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof CourseResource */ 'format': Array; /** * * @type {Array} * @memberof CourseResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof CourseResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof CourseResource */ 'best_run_id': number | null; /** * * @type {CourseResourceResourceTypeEnum} * @memberof CourseResource */ 'resource_type': CourseResourceResourceTypeEnum; /** * * @type {Course} * @memberof CourseResource */ 'course': Course; /** * * @type {string} * @memberof CourseResource */ 'readable_id': string; /** * * @type {string} * @memberof CourseResource */ 'title': string; /** * * @type {string} * @memberof CourseResource */ 'description'?: string | null; /** * * @type {string} * @memberof CourseResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof CourseResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof CourseResource */ 'published'?: boolean; /** * * @type {Array} * @memberof CourseResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof CourseResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof CourseResource */ 'resource_category': string; /** * * @type {Array} * @memberof CourseResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof CourseResource */ 'professional': boolean; /** * * @type {string} * @memberof CourseResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof CourseResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof CourseResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof CourseResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof CourseResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof CourseResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof CourseResource */ 'location'?: string; /** * * @type {string} * @memberof CourseResource */ 'duration'?: string; /** * * @type {number} * @memberof CourseResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof CourseResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof CourseResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof CourseResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof CourseResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof CourseResource */ 'require_summaries': boolean; } /** * * @export * @interface CourseResourceCertificationType */ export interface CourseResourceCertificationType { /** * * @type {string} * @memberof CourseResourceCertificationType */ 'code': CourseResourceCertificationTypeCodeEnum; /** * * @type {string} * @memberof CourseResourceCertificationType */ 'name': string; } export declare const CourseResourceCertificationTypeCodeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type CourseResourceCertificationTypeCodeEnum = typeof CourseResourceCertificationTypeCodeEnum[keyof typeof CourseResourceCertificationTypeCodeEnum]; /** * * @export * @interface CourseResourceDeliveryInner */ export interface CourseResourceDeliveryInner { /** * * @type {string} * @memberof CourseResourceDeliveryInner */ 'code': CourseResourceDeliveryInnerCodeEnum; /** * * @type {string} * @memberof CourseResourceDeliveryInner */ 'name': string; } export declare const CourseResourceDeliveryInnerCodeEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type CourseResourceDeliveryInnerCodeEnum = typeof CourseResourceDeliveryInnerCodeEnum[keyof typeof CourseResourceDeliveryInnerCodeEnum]; /** * * @export * @interface CourseResourceFormatInner */ export interface CourseResourceFormatInner { /** * * @type {string} * @memberof CourseResourceFormatInner */ 'code': CourseResourceFormatInnerCodeEnum; /** * * @type {string} * @memberof CourseResourceFormatInner */ 'name': string; } export declare const CourseResourceFormatInnerCodeEnum: { readonly Synchronous: "synchronous"; readonly Asynchronous: "asynchronous"; }; export type CourseResourceFormatInnerCodeEnum = typeof CourseResourceFormatInnerCodeEnum[keyof typeof CourseResourceFormatInnerCodeEnum]; /** * * @export * @interface CourseResourcePaceInner */ export interface CourseResourcePaceInner { /** * * @type {string} * @memberof CourseResourcePaceInner */ 'code': CourseResourcePaceInnerCodeEnum; /** * * @type {string} * @memberof CourseResourcePaceInner */ 'name': string; } export declare const CourseResourcePaceInnerCodeEnum: { readonly SelfPaced: "self_paced"; readonly InstructorPaced: "instructor_paced"; }; export type CourseResourcePaceInnerCodeEnum = typeof CourseResourcePaceInnerCodeEnum[keyof typeof CourseResourcePaceInnerCodeEnum]; /** * Serializer for course resources * @export * @interface CourseResourceRequest */ export interface CourseResourceRequest { /** * * @type {Array} * @memberof CourseResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof CourseResourceRequest */ 'title': string; /** * * @type {string} * @memberof CourseResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof CourseResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof CourseResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof CourseResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof CourseResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof CourseResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof CourseResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof CourseResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof CourseResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof CourseResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof CourseResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof CourseResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof CourseResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof CourseResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof CourseResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof CourseResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof CourseResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof CourseResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof CourseResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof CourseResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const CourseResourceResourceTypeEnum: { readonly Course: "course"; }; export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEnum[keyof typeof CourseResourceResourceTypeEnum]; /** * * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @export * @enum {string} */ export declare const DeliveryEnum: { /** * Online */ readonly Online: "online"; /** * Hybrid */ readonly Hybrid: "hybrid"; /** * In person */ readonly InPerson: "in_person"; /** * Offline */ readonly Offline: "offline"; }; export type DeliveryEnum = typeof DeliveryEnum[keyof typeof DeliveryEnum]; /** * * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @export * @enum {string} */ export declare const DepartmentEnum: { /** * Civil and Environmental Engineering */ readonly _1: "1"; /** * Mechanical Engineering */ readonly _2: "2"; /** * Materials Science and Engineering */ readonly _3: "3"; /** * Architecture */ readonly _4: "4"; /** * Chemistry */ readonly _5: "5"; /** * Electrical Engineering and Computer Science */ readonly _6: "6"; /** * Biology */ readonly _7: "7"; /** * Physics */ readonly _8: "8"; /** * Brain and Cognitive Sciences */ readonly _9: "9"; /** * Chemical Engineering */ readonly _10: "10"; /** * Urban Studies and Planning */ readonly _11: "11"; /** * Earth, Atmospheric, and Planetary Sciences */ readonly _12: "12"; /** * Economics */ readonly _14: "14"; /** * Management */ readonly _15: "15"; /** * Aeronautics and Astronautics */ readonly _16: "16"; /** * Political Science */ readonly _17: "17"; /** * Mathematics */ readonly _18: "18"; /** * Biological Engineering */ readonly _20: "20"; /** * Anthropology */ readonly _21A: "21A"; /** * Global Languages */ readonly _21G: "21G"; /** * History */ readonly _21H: "21H"; /** * Literature */ readonly _21L: "21L"; /** * Music and Theater Arts */ readonly _21M: "21M"; /** * Nuclear Science and Engineering */ readonly _22: "22"; /** * Linguistics and Philosophy */ readonly _24: "24"; /** * Concourse */ readonly Cc: "CC"; /** * Comparative Media Studies/Writing */ readonly CmsW: "CMS-W"; /** * Edgerton Center */ readonly Ec: "EC"; /** * Experimental Study Group */ readonly Es: "ES"; /** * Engineering Systems Division */ readonly Esd: "ESD"; /** * Medical Engineering and Science */ readonly Hst: "HST"; /** * Data, Systems, and Society */ readonly Ids: "IDS"; /** * Media Arts and Sciences */ readonly Mas: "MAS"; /** * Athletics, Physical Education and Recreation */ readonly Pe: "PE"; /** * Special Programs */ readonly Sp: "SP"; /** * Science, Technology, and Society */ readonly Sts: "STS"; /** * Women's and Gender Studies */ readonly Wgs: "WGS"; }; export type DepartmentEnum = typeof DepartmentEnum[keyof typeof DepartmentEnum]; /** * Serializer for document resources * @export * @interface DocumentResource */ export interface DocumentResource { /** * * @type {number} * @memberof DocumentResource */ 'id': number; /** * * @type {Array} * @memberof DocumentResource */ 'topics'?: Array; /** * * @type {number} * @memberof DocumentResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof DocumentResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof DocumentResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof DocumentResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof DocumentResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof DocumentResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof DocumentResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof DocumentResource */ 'prices': Array; /** * * @type {Array} * @memberof DocumentResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof DocumentResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof DocumentResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof DocumentResource */ 'views': number; /** * * @type {Array} * @memberof DocumentResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof DocumentResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof DocumentResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof DocumentResource */ 'format': Array; /** * * @type {Array} * @memberof DocumentResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof DocumentResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof DocumentResource */ 'best_run_id': number | null; /** * * @type {DocumentResourceResourceTypeEnum} * @memberof DocumentResource */ 'resource_type': DocumentResourceResourceTypeEnum; /** * * @type {Array} * @memberof DocumentResource */ 'content_files': Array | null; /** * * @type {string} * @memberof DocumentResource */ 'description': string | null; /** * * @type {string} * @memberof DocumentResource */ 'readable_id': string; /** * * @type {string} * @memberof DocumentResource */ 'title': string; /** * * @type {string} * @memberof DocumentResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof DocumentResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof DocumentResource */ 'published'?: boolean; /** * * @type {Array} * @memberof DocumentResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof DocumentResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof DocumentResource */ 'resource_category': string; /** * * @type {Array} * @memberof DocumentResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof DocumentResource */ 'professional': boolean; /** * * @type {string} * @memberof DocumentResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof DocumentResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof DocumentResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof DocumentResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof DocumentResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof DocumentResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof DocumentResource */ 'location'?: string; /** * * @type {string} * @memberof DocumentResource */ 'duration'?: string; /** * * @type {number} * @memberof DocumentResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof DocumentResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof DocumentResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof DocumentResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof DocumentResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof DocumentResource */ 'require_summaries': boolean; } /** * Serializer for document resources * @export * @interface DocumentResourceRequest */ export interface DocumentResourceRequest { /** * * @type {Array} * @memberof DocumentResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof DocumentResourceRequest */ 'title': string; /** * * @type {string} * @memberof DocumentResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof DocumentResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof DocumentResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof DocumentResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof DocumentResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof DocumentResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof DocumentResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof DocumentResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof DocumentResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof DocumentResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof DocumentResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof DocumentResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof DocumentResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof DocumentResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof DocumentResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof DocumentResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof DocumentResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof DocumentResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof DocumentResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const DocumentResourceResourceTypeEnum: { readonly Document: "document"; }; export type DocumentResourceResourceTypeEnum = typeof DocumentResourceResourceTypeEnum[keyof typeof DocumentResourceResourceTypeEnum]; /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPaging */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPaging { /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging */ 'paging'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging */ 'results'?: Array; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging { /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging */ 'next'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext */ 'link'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext */ 'after'?: string | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'form_type'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'id'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'name'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'created_at'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'updated_at'?: string | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'archived'?: boolean | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'archived_at'?: string | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'field_groups'?: Array; /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'configuration'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration; /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'display_options'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions; /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ 'legal_consent_options'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration { /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'create_new_contact_for_new_email'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'editable'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'allow_link_to_reset_known_values'?: boolean | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'lifecycle_stages'?: Array; /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'post_submit_action'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'language'?: string | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'pre_populate_known_values'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'cloneable'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'notify_contact_owner'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'recaptcha_enabled'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'archivable'?: boolean | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ 'notify_recipients'?: Array; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem */ 'object_type_id'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem */ 'value'?: string | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction */ 'type'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction */ 'value'?: string | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions { /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ 'render_raw_html'?: boolean | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ 'css_class'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ 'theme'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ 'submit_button_text'?: string | null; /** * * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ 'style'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'label_text_size'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'legal_consent_text_color'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'font_family'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'legal_consent_text_size'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'background_width'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'help_text_size'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'submit_font_color'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'label_text_color'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'submit_alignment'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'submit_size'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'help_text_color'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ 'submit_color'?: string | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ 'group_type'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ 'rich_text_type'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ 'rich_text'?: string | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ 'fields'?: Array; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'object_type_id'?: string | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'hidden'?: boolean | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'default_value'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'name'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'description'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'label'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'placeholder'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'field_type'?: string | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'required'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'use_country_code_select'?: boolean | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ 'allow_multiple_files'?: boolean | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions { /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'type'?: string | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'subscription_type_ids'?: Array; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'lawful_basis'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'privacy_text'?: string | null; /** * * @type {Array} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'communications_checkboxes'?: Array; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'communication_consent_text'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'consent_to_process_checkbox_label'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'consent_to_process_footer_text'?: string | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ 'consent_to_process_text'?: string | null; } /** * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem { /** * * @type {number} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem */ 'subscription_type_id'?: number | null; /** * * @type {string} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem */ 'label'?: string | null; /** * * @type {boolean} * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem */ 'required'?: boolean | null; } /** * * @export * @interface HubspotFormDefinition */ export interface HubspotFormDefinition { /** * * @type {string} * @memberof HubspotFormDefinition */ 'form_type'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinition */ 'id'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinition */ 'name'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinition */ 'created_at'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinition */ 'updated_at'?: string | null; /** * * @type {boolean} * @memberof HubspotFormDefinition */ 'archived'?: boolean | null; /** * * @type {string} * @memberof HubspotFormDefinition */ 'archived_at'?: string | null; /** * * @type {Array} * @memberof HubspotFormDefinition */ 'field_groups'?: Array; /** * * @type {HubspotFormDefinitionConfiguration} * @memberof HubspotFormDefinition */ 'configuration'?: HubspotFormDefinitionConfiguration; /** * * @type {HubspotFormDefinitionDisplayOptions} * @memberof HubspotFormDefinition */ 'display_options'?: HubspotFormDefinitionDisplayOptions; /** * * @type {HubspotFormDefinitionLegalConsentOptions} * @memberof HubspotFormDefinition */ 'legal_consent_options'?: HubspotFormDefinitionLegalConsentOptions; } /** * * @export * @interface HubspotFormDefinitionConfiguration */ export interface HubspotFormDefinitionConfiguration { /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'create_new_contact_for_new_email'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'editable'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'allow_link_to_reset_known_values'?: boolean | null; /** * * @type {Array} * @memberof HubspotFormDefinitionConfiguration */ 'lifecycle_stages'?: Array; /** * * @type {HubspotFormDefinitionConfigurationPostSubmitAction} * @memberof HubspotFormDefinitionConfiguration */ 'post_submit_action'?: HubspotFormDefinitionConfigurationPostSubmitAction; /** * * @type {string} * @memberof HubspotFormDefinitionConfiguration */ 'language'?: string | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'pre_populate_known_values'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'cloneable'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'notify_contact_owner'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'recaptcha_enabled'?: boolean | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionConfiguration */ 'archivable'?: boolean | null; /** * * @type {Array} * @memberof HubspotFormDefinitionConfiguration */ 'notify_recipients'?: Array; } /** * * @export * @interface HubspotFormDefinitionConfigurationLifecycleStageItem */ export interface HubspotFormDefinitionConfigurationLifecycleStageItem { /** * * @type {string} * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem */ 'object_type_id'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem */ 'value'?: string | null; } /** * * @export * @interface HubspotFormDefinitionConfigurationPostSubmitAction */ export interface HubspotFormDefinitionConfigurationPostSubmitAction { /** * * @type {string} * @memberof HubspotFormDefinitionConfigurationPostSubmitAction */ 'type'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionConfigurationPostSubmitAction */ 'value'?: string | null; } /** * * @export * @interface HubspotFormDefinitionDisplayOptions */ export interface HubspotFormDefinitionDisplayOptions { /** * * @type {boolean} * @memberof HubspotFormDefinitionDisplayOptions */ 'render_raw_html'?: boolean | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptions */ 'css_class'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptions */ 'theme'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptions */ 'submit_button_text'?: string | null; /** * * @type {HubspotFormDefinitionDisplayOptionsStyle} * @memberof HubspotFormDefinitionDisplayOptions */ 'style'?: HubspotFormDefinitionDisplayOptionsStyle; } /** * * @export * @interface HubspotFormDefinitionDisplayOptionsStyle */ export interface HubspotFormDefinitionDisplayOptionsStyle { /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'label_text_size'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'legal_consent_text_color'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'font_family'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'legal_consent_text_size'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'background_width'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'help_text_size'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'submit_font_color'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'label_text_color'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'submit_alignment'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'submit_size'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'help_text_color'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionDisplayOptionsStyle */ 'submit_color'?: string | null; } /** * * @export * @interface HubspotFormDefinitionFieldGroupItem */ export interface HubspotFormDefinitionFieldGroupItem { /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItem */ 'group_type'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItem */ 'rich_text_type'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItem */ 'rich_text'?: string | null; /** * * @type {Array} * @memberof HubspotFormDefinitionFieldGroupItem */ 'fields'?: Array; } /** * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItem */ export interface HubspotFormDefinitionFieldGroupItemFieldItem { /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'object_type_id'?: string | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'hidden'?: boolean | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'default_value'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'name'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'description'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'label'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'placeholder'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'field_type'?: string | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'required'?: boolean | null; /** * * @type {HubspotFormDefinitionFieldGroupItemFieldItemValidation} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'validation'?: HubspotFormDefinitionFieldGroupItemFieldItemValidation; /** * * @type {boolean} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'use_country_code_select'?: boolean | null; /** * * @type {Array} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'options'?: Array; /** * * @type {Array} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'default_values'?: Array; /** * * @type {boolean} * @memberof HubspotFormDefinitionFieldGroupItemFieldItem */ 'allow_multiple_files'?: boolean | null; } /** * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ export interface HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated { /** * * @type {number} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ 'display_order'?: number | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ 'description'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ 'label'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ 'value'?: string | null; } /** * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItemValidation */ export interface HubspotFormDefinitionFieldGroupItemFieldItemValidation { /** * * @type {number} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation */ 'min_allowed_digits'?: number | null; /** * * @type {number} * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation */ 'max_allowed_digits'?: number | null; } /** * * @export * @interface HubspotFormDefinitionLegalConsentOptions */ export interface HubspotFormDefinitionLegalConsentOptions { /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'type'?: string | null; /** * * @type {Array} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'subscription_type_ids'?: Array; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'lawful_basis'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'privacy_text'?: string | null; /** * * @type {Array} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'communications_checkboxes'?: Array; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'communication_consent_text'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'consent_to_process_checkbox_label'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'consent_to_process_footer_text'?: string | null; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptions */ 'consent_to_process_text'?: string | null; } /** * * @export * @interface HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem */ export interface HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem { /** * * @type {number} * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem */ 'subscription_type_id'?: number | null; /** * * @type {string} * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem */ 'label'?: string | null; /** * * @type {boolean} * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem */ 'required'?: boolean | null; } /** * Serializer for individual form field values in submission. * @export * @interface HubspotFormFieldValueRequest */ export interface HubspotFormFieldValueRequest { /** * * @type {string} * @memberof HubspotFormFieldValueRequest */ 'name': string; /** * * @type {any} * @memberof HubspotFormFieldValueRequest */ 'value': any | null; } /** * Serializer for HubSpot form submission requests. * @export * @interface HubspotFormSubmitRequestRequest */ export interface HubspotFormSubmitRequestRequest { /** * * @type {Array} * @memberof HubspotFormSubmitRequestRequest */ 'fields': Array; /** * * @type {string} * @memberof HubspotFormSubmitRequestRequest */ 'page_uri'?: string; /** * * @type {string} * @memberof HubspotFormSubmitRequestRequest */ 'hutk'?: string; /** * * @type {string} * @memberof HubspotFormSubmitRequestRequest */ 'page_name'?: string; /** * * @type {number} * @memberof HubspotFormSubmitRequestRequest */ 'submitted_at'?: number; /** * * @type {string} * @memberof HubspotFormSubmitRequestRequest */ 'recaptcha_token'?: string; /** * * @type {string} * @memberof HubspotFormSubmitRequestRequest */ 'page_title'?: string; /** * * @type {number} * @memberof HubspotFormSubmitRequestRequest */ 'timestamp'?: number; } /** * Serializer for HubSpot form submission response. * @export * @interface HubspotFormSubmitResponse */ export interface HubspotFormSubmitResponse { /** * * @type {string} * @memberof HubspotFormSubmitResponse */ 'status'?: string; } /** * Serializer for the LearningPath model * @export * @interface LearningPath */ export interface LearningPath { /** * * @type {number} * @memberof LearningPath */ 'id': number; /** * Number of published items in the list. * @type {number} * @memberof LearningPath */ 'item_count': number; } /** * Specialized serializer for a LearningPath relationship * @export * @interface LearningPathRelationship */ export interface LearningPathRelationship { /** * * @type {number} * @memberof LearningPathRelationship */ 'id': number; /** * * @type {LearningResource} * @memberof LearningPathRelationship */ 'resource': LearningResource; /** * * @type {number} * @memberof LearningPathRelationship */ 'position'?: number; /** * * @type {number} * @memberof LearningPathRelationship */ 'parent': number; /** * * @type {number} * @memberof LearningPathRelationship */ 'child': number; } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. * @export * @interface LearningPathRelationshipCreate */ export interface LearningPathRelationshipCreate { /** * * @type {number} * @memberof LearningPathRelationshipCreate */ 'id': number; /** * * @type {LearningResource} * @memberof LearningPathRelationshipCreate */ 'resource': LearningResource; /** * * @type {number} * @memberof LearningPathRelationshipCreate */ 'position'?: number; /** * * @type {number} * @memberof LearningPathRelationshipCreate */ 'parent': number; /** * * @type {number} * @memberof LearningPathRelationshipCreate */ 'child': number; } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. * @export * @interface LearningPathRelationshipCreateRequest */ export interface LearningPathRelationshipCreateRequest { /** * * @type {number} * @memberof LearningPathRelationshipCreateRequest */ 'position'?: number; /** * * @type {number} * @memberof LearningPathRelationshipCreateRequest */ 'child': number; } /** * CRUD serializer for LearningPath resources * @export * @interface LearningPathResource */ export interface LearningPathResource { /** * * @type {number} * @memberof LearningPathResource */ 'id': number; /** * * @type {Array} * @memberof LearningPathResource */ 'topics'?: Array; /** * * @type {number} * @memberof LearningPathResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof LearningPathResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof LearningPathResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof LearningPathResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof LearningPathResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof LearningPathResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof LearningPathResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof LearningPathResource */ 'prices': Array; /** * * @type {Array} * @memberof LearningPathResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof LearningPathResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof LearningPathResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof LearningPathResource */ 'views': number; /** * * @type {Array} * @memberof LearningPathResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof LearningPathResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof LearningPathResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof LearningPathResource */ 'format': Array; /** * * @type {Array} * @memberof LearningPathResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof LearningPathResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof LearningPathResource */ 'best_run_id': number | null; /** * * @type {LearningPathResourceResourceTypeEnum} * @memberof LearningPathResource */ 'resource_type': LearningPathResourceResourceTypeEnum; /** * The display category for this resource. * @type {string} * @memberof LearningPathResource */ 'resource_category': string; /** * * @type {LearningPath} * @memberof LearningPathResource */ 'learning_path': LearningPath; /** * * @type {string} * @memberof LearningPathResource */ 'readable_id': string; /** * * @type {string} * @memberof LearningPathResource */ 'title': string; /** * * @type {string} * @memberof LearningPathResource */ 'description'?: string | null; /** * * @type {string} * @memberof LearningPathResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof LearningPathResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof LearningPathResource */ 'published'?: boolean; /** * * @type {Array} * @memberof LearningPathResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof LearningPathResource */ 'url'?: string | null; /** * * @type {Array} * @memberof LearningPathResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof LearningPathResource */ 'professional': boolean; /** * * @type {string} * @memberof LearningPathResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof LearningPathResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof LearningPathResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof LearningPathResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof LearningPathResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof LearningPathResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof LearningPathResource */ 'location'?: string; /** * * @type {string} * @memberof LearningPathResource */ 'duration'?: string; /** * * @type {number} * @memberof LearningPathResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof LearningPathResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof LearningPathResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof LearningPathResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof LearningPathResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof LearningPathResource */ 'require_summaries': boolean; } /** * CRUD serializer for LearningPath resources * @export * @interface LearningPathResourceRequest */ export interface LearningPathResourceRequest { /** * * @type {Array} * @memberof LearningPathResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'title': string; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof LearningPathResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof LearningPathResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof LearningPathResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof LearningPathResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof LearningPathResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof LearningPathResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof LearningPathResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof LearningPathResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof LearningPathResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof LearningPathResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof LearningPathResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof LearningPathResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const LearningPathResourceResourceTypeEnum: { readonly LearningPath: "learning_path"; }; export type LearningPathResourceResourceTypeEnum = typeof LearningPathResourceResourceTypeEnum[keyof typeof LearningPathResourceResourceTypeEnum]; /** * @type LearningResource * @export */ export type LearningResource = { resource_type: 'course'; } & CourseResource | { resource_type: 'document'; } & DocumentResource | { resource_type: 'learning_path'; } & LearningPathResource | { resource_type: 'podcast'; } & PodcastResource | { resource_type: 'podcast_episode'; } & PodcastEpisodeResource | { resource_type: 'program'; } & ProgramResource | { resource_type: 'video'; } & VideoResource | { resource_type: 'video_playlist'; } & VideoPlaylistResource; /** * Serializer for LearningResourceDepartment, minus school The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseDepartment */ export interface LearningResourceBaseDepartment { /** * * @type {string} * @memberof LearningResourceBaseDepartment */ 'department_id': string; /** * * @type {string} * @memberof LearningResourceBaseDepartment */ 'name': string; /** * * @type {string} * @memberof LearningResourceBaseDepartment */ 'channel_url': string | null; } /** * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseSchool */ export interface LearningResourceBaseSchool { /** * * @type {number} * @memberof LearningResourceBaseSchool */ 'id': number; /** * * @type {string} * @memberof LearningResourceBaseSchool */ 'name': string; /** * * @type {string} * @memberof LearningResourceBaseSchool */ 'url': string; } /** * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseSchoolRequest */ export interface LearningResourceBaseSchoolRequest { /** * * @type {string} * @memberof LearningResourceBaseSchoolRequest */ 'name': string; /** * * @type {string} * @memberof LearningResourceBaseSchoolRequest */ 'url': string; } /** * Serializer for LearningResourceContentTag * @export * @interface LearningResourceContentTag */ export interface LearningResourceContentTag { /** * * @type {number} * @memberof LearningResourceContentTag */ 'id': number; /** * * @type {string} * @memberof LearningResourceContentTag */ 'name': string; } /** * Full serializer for LearningResourceDepartment, including school * @export * @interface LearningResourceDepartment */ export interface LearningResourceDepartment { /** * * @type {string} * @memberof LearningResourceDepartment */ 'department_id': string; /** * * @type {string} * @memberof LearningResourceDepartment */ 'name': string; /** * * @type {string} * @memberof LearningResourceDepartment */ 'channel_url': string | null; /** * * @type {LearningResourceBaseSchool} * @memberof LearningResourceDepartment */ 'school': LearningResourceBaseSchool | null; } /** * Full serializer for LearningResourceDepartment, including school * @export * @interface LearningResourceDepartmentRequest */ export interface LearningResourceDepartmentRequest { /** * * @type {string} * @memberof LearningResourceDepartmentRequest */ 'department_id': string; /** * * @type {string} * @memberof LearningResourceDepartmentRequest */ 'name': string; } /** * Serializer for the response of the display info endpoint * @export * @interface LearningResourceDisplayInfoResponse */ export interface LearningResourceDisplayInfoResponse { /** * Title * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'title': string; /** * Description * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'description': string; /** * Full Description * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'full_description': string | null; /** * Website * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'url': string; /** * Free * @type {boolean} * @memberof LearningResourceDisplayInfoResponse */ 'free': boolean | null; /** * Topics * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'topics': Array; /** * Price * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'price': string | null; /** * Extra Price Information * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'extra_price_info': string | null; /** * Certificate * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'certification': string | null; /** * Instructors * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'instructors': Array | null; /** * Runs/Sessions * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'runs': Array | null; /** * Offered By * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'offered_by': string | null; /** * Languages * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'languages': Array | null; /** * Levels * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'levels': Array | null; /** * Departments * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'departments': Array; /** * Platform * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'platform': string | null; /** * Number of Courses * @type {number} * @memberof LearningResourceDisplayInfoResponse */ 'number_of_courses': number | null; /** * Number of Programs * @type {number} * @memberof LearningResourceDisplayInfoResponse */ 'number_of_programs': number | null; /** * Child courses and programs included in this learning resource * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'program_courses': Array | null; /** * Location * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'location': string | null; /** * Starts * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'starts': Array | null; /** * Format * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'format_type': Array | null; /** * As Taught In * @type {Array} * @memberof LearningResourceDisplayInfoResponse */ 'as_taught_in': Array | null; /** * Duration * @type {string} * @memberof LearningResourceDisplayInfoResponse */ 'duration': string | null; /** * * @type {number} * @memberof LearningResourceDisplayInfoResponse */ 'id': number; } /** * * @export * @interface LearningResourceDisplayInfoResponseRunsInner */ export interface LearningResourceDisplayInfoResponseRunsInner { /** * * @type {string} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'location'?: string; /** * * @type {string} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'start_date'?: string; /** * * @type {Array} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'instructors'?: Array; /** * * @type {string} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'duration'?: string; /** * * @type {string} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'price'?: string; /** * * @type {Array} * @memberof LearningResourceDisplayInfoResponseRunsInner */ 'format'?: Array; } /** * Serializer for LearningResourceImage * @export * @interface LearningResourceImage */ export interface LearningResourceImage { /** * * @type {number} * @memberof LearningResourceImage */ 'id': number; /** * * @type {string} * @memberof LearningResourceImage */ 'url': string; /** * * @type {string} * @memberof LearningResourceImage */ 'description'?: string | null; /** * * @type {string} * @memberof LearningResourceImage */ 'alt'?: string | null; } /** * Serializer for LearningResourceImage * @export * @interface LearningResourceImageRequest */ export interface LearningResourceImageRequest { /** * * @type {string} * @memberof LearningResourceImageRequest */ 'url': string; /** * * @type {string} * @memberof LearningResourceImageRequest */ 'description'?: string | null; /** * * @type {string} * @memberof LearningResourceImageRequest */ 'alt'?: string | null; } /** * Serializer for LearningResourceInstructor model * @export * @interface LearningResourceInstructor */ export interface LearningResourceInstructor { /** * * @type {number} * @memberof LearningResourceInstructor */ 'id': number; /** * * @type {string} * @memberof LearningResourceInstructor */ 'first_name'?: string | null; /** * * @type {string} * @memberof LearningResourceInstructor */ 'last_name'?: string | null; /** * * @type {string} * @memberof LearningResourceInstructor */ 'full_name'?: string | null; } /** * Serializer for LearningResourceInstructor model * @export * @interface LearningResourceInstructorRequest */ export interface LearningResourceInstructorRequest { /** * * @type {string} * @memberof LearningResourceInstructorRequest */ 'first_name'?: string | null; /** * * @type {string} * @memberof LearningResourceInstructorRequest */ 'last_name'?: string | null; /** * * @type {string} * @memberof LearningResourceInstructorRequest */ 'full_name'?: string | null; } /** * Serializer for LearningResourceOfferor with basic details * @export * @interface LearningResourceOfferor */ export interface LearningResourceOfferor { /** * * @type {string} * @memberof LearningResourceOfferor */ 'code': string; /** * * @type {string} * @memberof LearningResourceOfferor */ 'name': string; /** * * @type {string} * @memberof LearningResourceOfferor */ 'channel_url': string | null; /** * * @type {boolean} * @memberof LearningResourceOfferor */ 'display_facet'?: boolean; } /** * Serializer for LearningResourceOfferor with all details * @export * @interface LearningResourceOfferorDetail */ export interface LearningResourceOfferorDetail { /** * * @type {string} * @memberof LearningResourceOfferorDetail */ 'code': string; /** * * @type {string} * @memberof LearningResourceOfferorDetail */ 'channel_url': string | null; /** * * @type {string} * @memberof LearningResourceOfferorDetail */ 'name': string; /** * * @type {boolean} * @memberof LearningResourceOfferorDetail */ 'professional'?: boolean; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'offerings'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'audience'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'formats'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'fee'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'certifications'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetail */ 'content_types'?: Array; /** * * @type {string} * @memberof LearningResourceOfferorDetail */ 'more_information'?: string; /** * * @type {string} * @memberof LearningResourceOfferorDetail */ 'value_prop'?: string; /** * * @type {boolean} * @memberof LearningResourceOfferorDetail */ 'display_facet'?: boolean; } /** * Serializer for LearningResourceOfferor with basic details * @export * @interface LearningResourceOfferorRequest */ export interface LearningResourceOfferorRequest { /** * * @type {string} * @memberof LearningResourceOfferorRequest */ 'code': string; /** * * @type {string} * @memberof LearningResourceOfferorRequest */ 'name': string; /** * * @type {boolean} * @memberof LearningResourceOfferorRequest */ 'display_facet'?: boolean; } /** * Serializer for LearningResourcePlatform * @export * @interface LearningResourcePlatform */ export interface LearningResourcePlatform { /** * * @type {string} * @memberof LearningResourcePlatform */ 'code': string; /** * * @type {string} * @memberof LearningResourcePlatform */ 'name'?: string; } /** * Serializer for LearningResourcePlatform * @export * @interface LearningResourcePlatformRequest */ export interface LearningResourcePlatformRequest { /** * * @type {string} * @memberof LearningResourcePlatformRequest */ 'code': string; /** * * @type {string} * @memberof LearningResourcePlatformRequest */ 'name'?: string; } /** * Serializer for LearningResourcePrice model * @export * @interface LearningResourcePrice */ export interface LearningResourcePrice { /** * * @type {string} * @memberof LearningResourcePrice */ 'amount': string; /** * * @type {string} * @memberof LearningResourcePrice */ 'currency': string; } /** * Serializer for LearningResourcePrice model * @export * @interface LearningResourcePriceRequest */ export interface LearningResourcePriceRequest { /** * * @type {string} * @memberof LearningResourcePriceRequest */ 'amount': string; /** * * @type {string} * @memberof LearningResourcePriceRequest */ 'currency': string; } /** * CRUD serializer for LearningResourceRelationship * @export * @interface LearningResourceRelationship */ export interface LearningResourceRelationship { /** * * @type {number} * @memberof LearningResourceRelationship */ 'id': number; /** * * @type {LearningResource} * @memberof LearningResourceRelationship */ 'resource': LearningResource; /** * * @type {number} * @memberof LearningResourceRelationship */ 'position'?: number; /** * * @type {RelationTypeEnum} * @memberof LearningResourceRelationship */ 'relation_type'?: RelationTypeEnum; /** * * @type {number} * @memberof LearningResourceRelationship */ 'parent': number; /** * * @type {number} * @memberof LearningResourceRelationship */ 'child': number; } /** * Serializer field for the LearningResourceRelationship model that uses the LearningResourceSerializer to serialize the child resources * @export * @interface LearningResourceRelationshipChildField */ export interface LearningResourceRelationshipChildField { /** * * @type {number} * @memberof LearningResourceRelationshipChildField */ 'child': number; /** * * @type {number} * @memberof LearningResourceRelationshipChildField */ 'position'?: number; /** * * @type {RelationTypeEnum} * @memberof LearningResourceRelationshipChildField */ 'relation_type'?: RelationTypeEnum; /** * * @type {string} * @memberof LearningResourceRelationshipChildField */ 'title': string; /** * * @type {string} * @memberof LearningResourceRelationshipChildField */ 'readable_id': string; } /** * @type LearningResourceRequest * @export */ export type LearningResourceRequest = { resource_type: 'course'; } & CourseResourceRequest | { resource_type: 'document'; } & DocumentResourceRequest | { resource_type: 'learning_path'; } & LearningPathResourceRequest | { resource_type: 'podcast'; } & PodcastResourceRequest | { resource_type: 'podcast_episode'; } & PodcastEpisodeResourceRequest | { resource_type: 'program'; } & ProgramResourceRequest | { resource_type: 'video'; } & VideoResourceRequest | { resource_type: 'video_playlist'; } & VideoPlaylistResourceRequest; /** * Serializer for the LearningResourceRun model * @export * @interface LearningResourceRun */ export interface LearningResourceRun { /** * * @type {number} * @memberof LearningResourceRun */ 'id': number; /** * * @type {Array} * @memberof LearningResourceRun */ 'instructors': Array | null; /** * * @type {LearningResourceImage} * @memberof LearningResourceRun */ 'image': LearningResourceImage | null; /** * * @type {Array} * @memberof LearningResourceRun */ 'level': Array; /** * * @type {Array} * @memberof LearningResourceRun */ 'delivery': Array; /** * * @type {Array} * @memberof LearningResourceRun */ 'format': Array; /** * * @type {Array} * @memberof LearningResourceRun */ 'pace': Array; /** * * @type {Array} * @memberof LearningResourceRun */ 'resource_prices': Array; /** * * @type {string} * @memberof LearningResourceRun */ 'run_id': string; /** * * @type {string} * @memberof LearningResourceRun */ 'title': string; /** * * @type {string} * @memberof LearningResourceRun */ 'description'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'full_description'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof LearningResourceRun */ 'published'?: boolean; /** * * @type {Array} * @memberof LearningResourceRun */ 'languages'?: Array | null; /** * * @type {string} * @memberof LearningResourceRun */ 'url'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'slug'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'semester'?: string | null; /** * * @type {number} * @memberof LearningResourceRun */ 'year'?: number | null; /** * * @type {string} * @memberof LearningResourceRun */ 'start_date'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'end_date'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'enrollment_start'?: string | null; /** * * @type {string} * @memberof LearningResourceRun */ 'enrollment_end'?: string | null; /** * * @type {Array} * @memberof LearningResourceRun */ 'prices'?: Array | null; /** * * @type {string} * @memberof LearningResourceRun */ 'checksum'?: string | null; /** * * @type {AvailabilityEnum} * @memberof LearningResourceRun */ 'availability'?: AvailabilityEnum | null; /** * * @type {string} * @memberof LearningResourceRun */ 'location'?: string; /** * * @type {string} * @memberof LearningResourceRun */ 'duration'?: string; /** * * @type {number} * @memberof LearningResourceRun */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof LearningResourceRun */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof LearningResourceRun */ 'time_commitment'?: string; /** * * @type {number} * @memberof LearningResourceRun */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof LearningResourceRun */ 'max_weekly_hours'?: number | null; } /** * * @export * @interface LearningResourceRunLevelInner */ export interface LearningResourceRunLevelInner { /** * * @type {string} * @memberof LearningResourceRunLevelInner */ 'code': LearningResourceRunLevelInnerCodeEnum; /** * * @type {string} * @memberof LearningResourceRunLevelInner */ 'name': string; } export declare const LearningResourceRunLevelInnerCodeEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourceRunLevelInnerCodeEnum = typeof LearningResourceRunLevelInnerCodeEnum[keyof typeof LearningResourceRunLevelInnerCodeEnum]; /** * Serializer for the LearningResourceRun model * @export * @interface LearningResourceRunRequest */ export interface LearningResourceRunRequest { /** * * @type {Array} * @memberof LearningResourceRunRequest */ 'level': Array; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'run_id': string; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'title': string; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'description'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof LearningResourceRunRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof LearningResourceRunRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'url'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'slug'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'semester'?: string | null; /** * * @type {number} * @memberof LearningResourceRunRequest */ 'year'?: number | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'start_date'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'end_date'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'enrollment_start'?: string | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'enrollment_end'?: string | null; /** * * @type {Array} * @memberof LearningResourceRunRequest */ 'prices'?: Array | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'checksum'?: string | null; /** * * @type {AvailabilityEnum} * @memberof LearningResourceRunRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'location'?: string; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'duration'?: string; /** * * @type {number} * @memberof LearningResourceRunRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof LearningResourceRunRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof LearningResourceRunRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof LearningResourceRunRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof LearningResourceRunRequest */ 'max_weekly_hours'?: number | null; } /** * Serializer for LearningResourceSchool model, including list of departments * @export * @interface LearningResourceSchool */ export interface LearningResourceSchool { /** * * @type {number} * @memberof LearningResourceSchool */ 'id': number; /** * * @type {string} * @memberof LearningResourceSchool */ 'name': string; /** * * @type {string} * @memberof LearningResourceSchool */ 'url': string; /** * * @type {Array} * @memberof LearningResourceSchool */ 'departments': Array; } /** * Minimal serializer for LearningResource - returns only essential fields for sitemap generation and other use cases requiring minimal data transfer. * @export * @interface LearningResourceSummary */ export interface LearningResourceSummary { /** * * @type {number} * @memberof LearningResourceSummary */ 'id': number; /** * * @type {string} * @memberof LearningResourceSummary */ 'last_modified'?: string | null; /** * * @type {string} * @memberof LearningResourceSummary */ 'url'?: string | null; } /** * Serializer for LearningResourceTopic model * @export * @interface LearningResourceTopic */ export interface LearningResourceTopic { /** * * @type {number} * @memberof LearningResourceTopic */ 'id': number; /** * * @type {string} * @memberof LearningResourceTopic */ 'name': string; /** * The icon to display for the topic. * @type {string} * @memberof LearningResourceTopic */ 'icon'?: string; /** * * @type {number} * @memberof LearningResourceTopic */ 'parent'?: number | null; /** * * @type {string} * @memberof LearningResourceTopic */ 'channel_url': string | null; } /** * SearchResponseSerializer with OpenAPI annotations for Learning Resources search * @export * @interface LearningResourcesSearchResponse */ export interface LearningResourcesSearchResponse { /** * * @type {number} * @memberof LearningResourcesSearchResponse */ 'count': number; /** * * @type {string} * @memberof LearningResourcesSearchResponse */ 'next': string | null; /** * * @type {string} * @memberof LearningResourcesSearchResponse */ 'previous': string | null; /** * * @type {Array} * @memberof LearningResourcesSearchResponse */ 'results': Array; /** * * @type {ContentFileSearchResponseMetadata} * @memberof LearningResourcesSearchResponse */ 'metadata': ContentFileSearchResponseMetadata; } /** * * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @export * @enum {string} */ export declare const LevelEnum: { /** * Undergraduate */ readonly Undergraduate: "undergraduate"; /** * Graduate */ readonly Graduate: "graduate"; /** * High School */ readonly HighSchool: "high_school"; /** * Non-Credit */ readonly Noncredit: "noncredit"; /** * Advanced */ readonly Advanced: "advanced"; /** * Intermediate */ readonly Intermediate: "intermediate"; /** * Introductory */ readonly Introductory: "introductory"; }; export type LevelEnum = typeof LevelEnum[keyof typeof LevelEnum]; /** * * @export * @interface MediaUpload201Response */ export interface MediaUpload201Response { /** * * @type {string} * @memberof MediaUpload201Response */ 'url'?: string; } /** * Serializer containing only parent and child ids for a learning path relationship * @export * @interface MicroLearningPathRelationship */ export interface MicroLearningPathRelationship { /** * * @type {number} * @memberof MicroLearningPathRelationship */ 'id': number; /** * The id of the parent learning resource * @type {number} * @memberof MicroLearningPathRelationship */ 'parent': number; /** * * @type {number} * @memberof MicroLearningPathRelationship */ 'child': number; } /** * Serializer containing only parent and child ids for a user list relationship * @export * @interface MicroUserListRelationship */ export interface MicroUserListRelationship { /** * * @type {number} * @memberof MicroUserListRelationship */ 'id': number; /** * The id of the parent learning resource * @type {number} * @memberof MicroUserListRelationship */ 'parent': number; /** * * @type {number} * @memberof MicroUserListRelationship */ 'child': number; } /** * * @export * @enum {string} */ export declare const NullEnum: { readonly Null: "null"; }; export type NullEnum = typeof NullEnum[keyof typeof NullEnum]; /** * Serializer for OVS video webhook requests. Accepts either an OVS video upsert payload (full result dict from the OVS public videos API; `key` is required) or a delete payload (`video_id` plus `delete: true`). * @export * @interface OVSVideoWebhookRequestRequest */ export interface OVSVideoWebhookRequestRequest { /** * * @type {string} * @memberof OVSVideoWebhookRequestRequest */ 'key'?: string; /** * * @type {string} * @memberof OVSVideoWebhookRequestRequest */ 'video_id'?: string; /** * * @type {boolean} * @memberof OVSVideoWebhookRequestRequest */ 'delete'?: boolean; } /** * * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @export * @enum {string} */ export declare const OfferedByEnum: { /** * MITx */ readonly Mitx: "mitx"; /** * MIT OpenCourseWare */ readonly Ocw: "ocw"; /** * Bootcamps */ readonly Bootcamps: "bootcamps"; /** * MIT xPRO */ readonly Xpro: "xpro"; /** * MIT Professional Education */ readonly Mitpe: "mitpe"; /** * MIT Sloan Executive Education */ readonly See: "see"; /** * MIT Climate */ readonly Climate: "climate"; }; export type OfferedByEnum = typeof OfferedByEnum[keyof typeof OfferedByEnum]; /** * * @export * @interface PaginatedContentFileList */ export interface PaginatedContentFileList { /** * * @type {number} * @memberof PaginatedContentFileList */ 'count': number; /** * * @type {string} * @memberof PaginatedContentFileList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedContentFileList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedContentFileList */ 'results': Array; } /** * * @export * @interface PaginatedCourseResourceList */ export interface PaginatedCourseResourceList { /** * * @type {number} * @memberof PaginatedCourseResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedCourseResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedCourseResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedCourseResourceList */ 'results': Array; } /** * * @export * @interface PaginatedLearningPathRelationshipList */ export interface PaginatedLearningPathRelationshipList { /** * * @type {number} * @memberof PaginatedLearningPathRelationshipList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningPathRelationshipList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningPathRelationshipList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningPathRelationshipList */ 'results': Array; } /** * * @export * @interface PaginatedLearningPathResourceList */ export interface PaginatedLearningPathResourceList { /** * * @type {number} * @memberof PaginatedLearningPathResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningPathResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningPathResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningPathResourceList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceContentTagList */ export interface PaginatedLearningResourceContentTagList { /** * * @type {number} * @memberof PaginatedLearningResourceContentTagList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceContentTagList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceContentTagList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceContentTagList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceDepartmentList */ export interface PaginatedLearningResourceDepartmentList { /** * * @type {number} * @memberof PaginatedLearningResourceDepartmentList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceDepartmentList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceDepartmentList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceDepartmentList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceDisplayInfoResponseList */ export interface PaginatedLearningResourceDisplayInfoResponseList { /** * * @type {number} * @memberof PaginatedLearningResourceDisplayInfoResponseList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceDisplayInfoResponseList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceDisplayInfoResponseList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceDisplayInfoResponseList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceList */ export interface PaginatedLearningResourceList { /** * * @type {number} * @memberof PaginatedLearningResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceOfferorDetailList */ export interface PaginatedLearningResourceOfferorDetailList { /** * * @type {number} * @memberof PaginatedLearningResourceOfferorDetailList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceOfferorDetailList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceOfferorDetailList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceOfferorDetailList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourcePlatformList */ export interface PaginatedLearningResourcePlatformList { /** * * @type {number} * @memberof PaginatedLearningResourcePlatformList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourcePlatformList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourcePlatformList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourcePlatformList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceRelationshipList */ export interface PaginatedLearningResourceRelationshipList { /** * * @type {number} * @memberof PaginatedLearningResourceRelationshipList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceRelationshipList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceRelationshipList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceRelationshipList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceSchoolList */ export interface PaginatedLearningResourceSchoolList { /** * * @type {number} * @memberof PaginatedLearningResourceSchoolList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceSchoolList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceSchoolList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceSchoolList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceSummaryList */ export interface PaginatedLearningResourceSummaryList { /** * * @type {number} * @memberof PaginatedLearningResourceSummaryList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceSummaryList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceSummaryList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceSummaryList */ 'results': Array; } /** * * @export * @interface PaginatedLearningResourceTopicList */ export interface PaginatedLearningResourceTopicList { /** * * @type {number} * @memberof PaginatedLearningResourceTopicList */ 'count': number; /** * * @type {string} * @memberof PaginatedLearningResourceTopicList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedLearningResourceTopicList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedLearningResourceTopicList */ 'results': Array; } /** * * @export * @interface PaginatedPodcastEpisodeResourceList */ export interface PaginatedPodcastEpisodeResourceList { /** * * @type {number} * @memberof PaginatedPodcastEpisodeResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedPodcastEpisodeResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedPodcastEpisodeResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedPodcastEpisodeResourceList */ 'results': Array; } /** * * @export * @interface PaginatedPodcastResourceList */ export interface PaginatedPodcastResourceList { /** * * @type {number} * @memberof PaginatedPodcastResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedPodcastResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedPodcastResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedPodcastResourceList */ 'results': Array; } /** * * @export * @interface PaginatedProgramResourceList */ export interface PaginatedProgramResourceList { /** * * @type {number} * @memberof PaginatedProgramResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedProgramResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedProgramResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedProgramResourceList */ 'results': Array; } /** * * @export * @interface PaginatedUserListList */ export interface PaginatedUserListList { /** * * @type {number} * @memberof PaginatedUserListList */ 'count': number; /** * * @type {string} * @memberof PaginatedUserListList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedUserListList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedUserListList */ 'results': Array; } /** * * @export * @interface PaginatedUserListRelationshipList */ export interface PaginatedUserListRelationshipList { /** * * @type {number} * @memberof PaginatedUserListRelationshipList */ 'count': number; /** * * @type {string} * @memberof PaginatedUserListRelationshipList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedUserListRelationshipList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedUserListRelationshipList */ 'results': Array; } /** * * @export * @interface PaginatedVideoPlaylistResourceList */ export interface PaginatedVideoPlaylistResourceList { /** * * @type {number} * @memberof PaginatedVideoPlaylistResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedVideoPlaylistResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedVideoPlaylistResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedVideoPlaylistResourceList */ 'results': Array; } /** * * @export * @interface PaginatedVideoResourceList */ export interface PaginatedVideoResourceList { /** * * @type {number} * @memberof PaginatedVideoResourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedVideoResourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedVideoResourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedVideoResourceList */ 'results': Array; } /** * * @export * @interface PaginatedWebsiteContentList */ export interface PaginatedWebsiteContentList { /** * * @type {number} * @memberof PaginatedWebsiteContentList */ 'count': number; /** * * @type {string} * @memberof PaginatedWebsiteContentList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedWebsiteContentList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedWebsiteContentList */ 'results': Array; } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. * @export * @interface PatchedLearningPathRelationshipCreateRequest */ export interface PatchedLearningPathRelationshipCreateRequest { /** * * @type {number} * @memberof PatchedLearningPathRelationshipCreateRequest */ 'position'?: number; /** * * @type {number} * @memberof PatchedLearningPathRelationshipCreateRequest */ 'child'?: number; } /** * CRUD serializer for LearningPath resources * @export * @interface PatchedLearningPathResourceRequest */ export interface PatchedLearningPathResourceRequest { /** * * @type {Array} * @memberof PatchedLearningPathResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'title'?: string; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof PatchedLearningPathResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof PatchedLearningPathResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof PatchedLearningPathResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof PatchedLearningPathResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof PatchedLearningPathResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof PatchedLearningPathResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof PatchedLearningPathResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof PatchedLearningPathResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof PatchedLearningPathResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof PatchedLearningPathResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof PatchedLearningPathResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof PatchedLearningPathResourceRequest */ 'max_weekly_hours'?: number | null; } /** * CRUD serializer for LearningResourceRelationship * @export * @interface PatchedLearningResourceRelationshipRequest */ export interface PatchedLearningResourceRelationshipRequest { /** * * @type {number} * @memberof PatchedLearningResourceRelationshipRequest */ 'position'?: number; /** * * @type {RelationTypeEnum} * @memberof PatchedLearningResourceRelationshipRequest */ 'relation_type'?: RelationTypeEnum; /** * * @type {number} * @memberof PatchedLearningResourceRelationshipRequest */ 'parent'?: number; /** * * @type {number} * @memberof PatchedLearningResourceRelationshipRequest */ 'child'?: number; } /** * Serializer for UserListRelationship model * @export * @interface PatchedUserListRelationshipRequest */ export interface PatchedUserListRelationshipRequest { /** * * @type {number} * @memberof PatchedUserListRelationshipRequest */ 'position'?: number; /** * * @type {number} * @memberof PatchedUserListRelationshipRequest */ 'parent'?: number; /** * * @type {number} * @memberof PatchedUserListRelationshipRequest */ 'child'?: number; } /** * Simplified serializer for UserList model. * @export * @interface PatchedUserListRequest */ export interface PatchedUserListRequest { /** * * @type {Array} * @memberof PatchedUserListRequest */ 'topics'?: Array; /** * * @type {string} * @memberof PatchedUserListRequest */ 'title'?: string; /** * * @type {string} * @memberof PatchedUserListRequest */ 'description'?: string; /** * * @type {PrivacyLevelEnum} * @memberof PatchedUserListRequest */ 'privacy_level'?: PrivacyLevelEnum; } /** * Serializer for WebsiteContent model. * @export * @interface PatchedWebsiteContentRequest */ export interface PatchedWebsiteContentRequest { /** * * @type {string} * @memberof PatchedWebsiteContentRequest */ 'title'?: string; /** * * @type {string} * @memberof PatchedWebsiteContentRequest */ 'author_name'?: string; /** * * @type {any} * @memberof PatchedWebsiteContentRequest */ 'content'?: any; /** * * @type {WebsiteContentContentTypeEnum} * @memberof PatchedWebsiteContentRequest */ 'content_type'?: WebsiteContentContentTypeEnum; /** * * @type {boolean} * @memberof PatchedWebsiteContentRequest */ 'is_published'?: boolean; /** * * @type {string} * @memberof PatchedWebsiteContentRequest */ 'slug'?: string; } /** * Serializer for PercolateQuery objects * @export * @interface PercolateQuery */ export interface PercolateQuery { /** * * @type {number} * @memberof PercolateQuery */ 'id': number; /** * * @type {string} * @memberof PercolateQuery */ 'source_description': string; /** * * @type {string} * @memberof PercolateQuery */ 'source_label': string; /** * * @type {any} * @memberof PercolateQuery */ 'original_query': any; /** * * @type {any} * @memberof PercolateQuery */ 'query': any; /** * * @type {SourceTypeEnum} * @memberof PercolateQuery */ 'source_type': SourceTypeEnum; /** * Friendly display label for the query * @type {string} * @memberof PercolateQuery */ 'display_label'?: string; } /** * PercolateQuerySubscriptionRequestSerializer with OpenAPI annotations for Percolate Subscription requests * @export * @interface PercolateQuerySubscriptionRequestRequest */ export interface PercolateQuerySubscriptionRequestRequest { /** * The search text * @type {string} * @memberof PercolateQuerySubscriptionRequestRequest */ 'q'?: string; /** * The initial index from which to return the results * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'offset'?: number; /** * Number of results to return per page * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'limit'?: number; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'offered_by'?: Array; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'platform'?: Array; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'topic'?: Array; /** * The ocw topic name. * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'ocw_topic'?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof PercolateQuerySubscriptionRequestRequest */ 'dev_mode'?: boolean | null; /** * The id value for the learning resource * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'id'?: Array; /** * * @type {SortbyEnum} * @memberof PercolateQuerySubscriptionRequestRequest */ 'sortby'?: SortbyEnum; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'resource_type'?: Array; /** * * @type {boolean} * @memberof PercolateQuerySubscriptionRequestRequest */ 'free'?: boolean | null; /** * * @type {boolean} * @memberof PercolateQuerySubscriptionRequestRequest */ 'professional'?: boolean | null; /** * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'yearly_decay_percent'?: number | null; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof PercolateQuerySubscriptionRequestRequest */ 'certification'?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'certification_type'?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'department'?: Array; /** * * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'level'?: Array; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'course_feature'?: Array; /** * Show resource counts by category * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'aggregations'?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'delivery'?: Array; /** * * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'resource_type_group'?: Array; /** * The resource category for the resource * @type {Array} * @memberof PercolateQuerySubscriptionRequestRequest */ 'resource_category'?: Array; /** * * @type {SearchModeEnum} * @memberof PercolateQuerySubscriptionRequestRequest */ 'search_mode'?: SearchModeEnum; /** * Allowed distance for phrase search * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'slop'?: number | null; /** * Minimum score value a text query result needs to have to be displayed * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'min_score'?: number | null; /** * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'max_incompleteness_penalty'?: number | null; /** * Score weight for content file data. 1 is the default. 0 means content files are ignored * @type {number} * @memberof PercolateQuerySubscriptionRequestRequest */ 'content_file_score_weight'?: number | null; /** * Whether to include select OCW content files in search results. * @type {boolean} * @memberof PercolateQuerySubscriptionRequestRequest */ 'show_ocw_files'?: boolean | null; /** * * @type {SourceTypeEnum} * @memberof PercolateQuerySubscriptionRequestRequest */ 'source_type'?: SourceTypeEnum; } /** * * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @export * @enum {string} */ export declare const PercolateQuerySubscriptionRequestResourceTypeEnum: { /** * course */ readonly Course: "course"; /** * program */ readonly Program: "program"; /** * learning path */ readonly LearningPath: "learning_path"; /** * podcast */ readonly Podcast: "podcast"; /** * podcast episode */ readonly PodcastEpisode: "podcast_episode"; /** * video */ readonly Video: "video"; /** * video playlist */ readonly VideoPlaylist: "video_playlist"; /** * document */ readonly Document: "document"; }; export type PercolateQuerySubscriptionRequestResourceTypeEnum = typeof PercolateQuerySubscriptionRequestResourceTypeEnum[keyof typeof PercolateQuerySubscriptionRequestResourceTypeEnum]; /** * * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @export * @enum {string} */ export declare const PlatformEnum: { /** * edX */ readonly Edx: "edx"; /** * MIT OpenCourseWare */ readonly Ocw: "ocw"; /** * Open Learning Library */ readonly Oll: "oll"; /** * MITx Online */ readonly Mitxonline: "mitxonline"; /** * Bootcamps */ readonly Bootcamps: "bootcamps"; /** * MIT xPRO */ readonly Xpro: "xpro"; /** * CSAIL */ readonly Csail: "csail"; /** * MIT Professional Education */ readonly Mitpe: "mitpe"; /** * MIT Sloan Executive Education */ readonly See: "see"; /** * Schwarzman College of Computing */ readonly Scc: "scc"; /** * Center for Transportation & Logistics */ readonly Ctl: "ctl"; /** * WHU */ readonly Whu: "whu"; /** * Susskind */ readonly Susskind: "susskind"; /** * Global Alumni */ readonly Globalalumni: "globalalumni"; /** * Simplilearn */ readonly Simplilearn: "simplilearn"; /** * Emeritus */ readonly Emeritus: "emeritus"; /** * Podcast */ readonly Podcast: "podcast"; /** * YouTube */ readonly Youtube: "youtube"; /** * Canvas */ readonly Canvas: "canvas"; /** * MIT Climate */ readonly Climate: "climate"; /** * ODL Video Service */ readonly Ovs: "ovs"; }; export type PlatformEnum = typeof PlatformEnum[keyof typeof PlatformEnum]; /** * Serializer for Podcasts * @export * @interface Podcast */ export interface Podcast { /** * * @type {number} * @memberof Podcast */ 'id': number; /** * * @type {number} * @memberof Podcast */ 'episode_count': number; /** * * @type {string} * @memberof Podcast */ 'apple_podcasts_url'?: string | null; /** * * @type {string} * @memberof Podcast */ 'google_podcasts_url'?: string | null; /** * * @type {string} * @memberof Podcast */ 'rss_url'?: string | null; } /** * Serializer for PodcastEpisode * @export * @interface PodcastEpisode */ export interface PodcastEpisode { /** * * @type {number} * @memberof PodcastEpisode */ 'id': number; /** * Get the podcast id(s) the episode belongs to * @type {Array} * @memberof PodcastEpisode */ 'podcasts': Array; /** * * @type {string} * @memberof PodcastEpisode */ 'transcript'?: string; /** * * @type {string} * @memberof PodcastEpisode */ 'audio_url': string; /** * * @type {string} * @memberof PodcastEpisode */ 'episode_link'?: string | null; /** * * @type {string} * @memberof PodcastEpisode */ 'duration'?: string | null; /** * * @type {string} * @memberof PodcastEpisode */ 'rss'?: string | null; } /** * Serializer for PodcastEpisode * @export * @interface PodcastEpisodeRequest */ export interface PodcastEpisodeRequest { /** * * @type {string} * @memberof PodcastEpisodeRequest */ 'transcript'?: string; /** * * @type {string} * @memberof PodcastEpisodeRequest */ 'audio_url': string; /** * * @type {string} * @memberof PodcastEpisodeRequest */ 'episode_link'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeRequest */ 'duration'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeRequest */ 'rss'?: string | null; } /** * Serializer for podcast episode resources * @export * @interface PodcastEpisodeResource */ export interface PodcastEpisodeResource { /** * * @type {number} * @memberof PodcastEpisodeResource */ 'id': number; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'topics'?: Array; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof PodcastEpisodeResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof PodcastEpisodeResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof PodcastEpisodeResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'prices': Array; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof PodcastEpisodeResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'views': number; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof PodcastEpisodeResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof PodcastEpisodeResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'format': Array; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof PodcastEpisodeResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof PodcastEpisodeResource */ 'best_run_id': number | null; /** * * @type {PodcastEpisodeResourceResourceTypeEnum} * @memberof PodcastEpisodeResource */ 'resource_type': PodcastEpisodeResourceResourceTypeEnum; /** * * @type {PodcastEpisode} * @memberof PodcastEpisodeResource */ 'podcast_episode': PodcastEpisode; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'readable_id': string; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'title': string; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'description'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'published'?: boolean; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof PodcastEpisodeResource */ 'resource_category': string; /** * * @type {Array} * @memberof PodcastEpisodeResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'professional': boolean; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof PodcastEpisodeResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'location'?: string; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'duration'?: string; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof PodcastEpisodeResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof PodcastEpisodeResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof PodcastEpisodeResource */ 'require_summaries': boolean; } /** * Serializer for podcast episode resources * @export * @interface PodcastEpisodeResourceRequest */ export interface PodcastEpisodeResourceRequest { /** * * @type {Array} * @memberof PodcastEpisodeResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'title': string; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof PodcastEpisodeResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof PodcastEpisodeResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof PodcastEpisodeResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof PodcastEpisodeResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof PodcastEpisodeResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof PodcastEpisodeResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof PodcastEpisodeResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof PodcastEpisodeResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof PodcastEpisodeResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof PodcastEpisodeResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof PodcastEpisodeResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof PodcastEpisodeResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const PodcastEpisodeResourceResourceTypeEnum: { readonly PodcastEpisode: "podcast_episode"; }; export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResourceResourceTypeEnum[keyof typeof PodcastEpisodeResourceResourceTypeEnum]; /** * Serializer for Podcasts * @export * @interface PodcastRequest */ export interface PodcastRequest { /** * * @type {number} * @memberof PodcastRequest */ 'episode_count': number; /** * * @type {string} * @memberof PodcastRequest */ 'apple_podcasts_url'?: string | null; /** * * @type {string} * @memberof PodcastRequest */ 'google_podcasts_url'?: string | null; /** * * @type {string} * @memberof PodcastRequest */ 'rss_url'?: string | null; } /** * Serializer for podcast resources * @export * @interface PodcastResource */ export interface PodcastResource { /** * * @type {number} * @memberof PodcastResource */ 'id': number; /** * * @type {Array} * @memberof PodcastResource */ 'topics'?: Array; /** * * @type {number} * @memberof PodcastResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof PodcastResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof PodcastResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof PodcastResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof PodcastResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof PodcastResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof PodcastResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof PodcastResource */ 'prices': Array; /** * * @type {Array} * @memberof PodcastResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof PodcastResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof PodcastResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof PodcastResource */ 'views': number; /** * * @type {Array} * @memberof PodcastResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof PodcastResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof PodcastResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof PodcastResource */ 'format': Array; /** * * @type {Array} * @memberof PodcastResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof PodcastResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof PodcastResource */ 'best_run_id': number | null; /** * * @type {PodcastResourceResourceTypeEnum} * @memberof PodcastResource */ 'resource_type': PodcastResourceResourceTypeEnum; /** * * @type {Podcast} * @memberof PodcastResource */ 'podcast': Podcast; /** * * @type {string} * @memberof PodcastResource */ 'readable_id': string; /** * * @type {string} * @memberof PodcastResource */ 'title': string; /** * * @type {string} * @memberof PodcastResource */ 'description'?: string | null; /** * * @type {string} * @memberof PodcastResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof PodcastResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof PodcastResource */ 'published'?: boolean; /** * * @type {Array} * @memberof PodcastResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof PodcastResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof PodcastResource */ 'resource_category': string; /** * * @type {Array} * @memberof PodcastResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof PodcastResource */ 'professional': boolean; /** * * @type {string} * @memberof PodcastResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof PodcastResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof PodcastResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof PodcastResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof PodcastResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof PodcastResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof PodcastResource */ 'location'?: string; /** * * @type {string} * @memberof PodcastResource */ 'duration'?: string; /** * * @type {number} * @memberof PodcastResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof PodcastResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof PodcastResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof PodcastResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof PodcastResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof PodcastResource */ 'require_summaries': boolean; } /** * Serializer for podcast resources * @export * @interface PodcastResourceRequest */ export interface PodcastResourceRequest { /** * * @type {Array} * @memberof PodcastResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof PodcastResourceRequest */ 'title': string; /** * * @type {string} * @memberof PodcastResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof PodcastResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof PodcastResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof PodcastResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof PodcastResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof PodcastResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof PodcastResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof PodcastResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof PodcastResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof PodcastResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof PodcastResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof PodcastResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof PodcastResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof PodcastResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof PodcastResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof PodcastResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof PodcastResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof PodcastResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof PodcastResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof PodcastResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const PodcastResourceResourceTypeEnum: { readonly Podcast: "podcast"; }; export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceTypeEnum[keyof typeof PodcastResourceResourceTypeEnum]; /** * * `private` - private * `unlisted` - unlisted * @export * @enum {string} */ export declare const PrivacyLevelEnum: { /** * private */ readonly Private: "private"; /** * unlisted */ readonly Unlisted: "unlisted"; }; export type PrivacyLevelEnum = typeof PrivacyLevelEnum[keyof typeof PrivacyLevelEnum]; /** * Serializer for the Program model * @export * @interface Program */ export interface Program { /** * * @type {number} * @memberof Program */ 'course_count': number; /** * * @type {number} * @memberof Program */ 'program_count': number; } /** * Serializer for Program Certificates * @export * @interface ProgramCertificate */ export interface ProgramCertificate { /** * * @type {string} * @memberof ProgramCertificate */ 'record_hash': string; /** * * @type {string} * @memberof ProgramCertificate */ 'program_letter_generate_url': string; /** * * @type {string} * @memberof ProgramCertificate */ 'program_letter_share_url': string; /** * * @type {string} * @memberof ProgramCertificate */ 'program_title': string; /** * * @type {string} * @memberof ProgramCertificate */ 'user_full_name'?: string; /** * * @type {string} * @memberof ProgramCertificate */ 'user_email': string; /** * * @type {number} * @memberof ProgramCertificate */ 'user_edxorg_id'?: number | null; /** * * @type {number} * @memberof ProgramCertificate */ 'micromasters_program_id'?: number | null; /** * * @type {number} * @memberof ProgramCertificate */ 'mitxonline_program_id'?: number | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_edxorg_username'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_gender'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_address_city'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_first_name'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_last_name'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_year_of_birth'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_country'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_address_postal_code'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_street_address'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_address_state_or_territory'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'user_mitxonline_username'?: string | null; /** * * @type {string} * @memberof ProgramCertificate */ 'program_completion_timestamp'?: string | null; } /** * Serializer for Program Letters * @export * @interface ProgramLetter */ export interface ProgramLetter { /** * * @type {string} * @memberof ProgramLetter */ 'id': string; /** * * @type {ProgramLetterTemplateField} * @memberof ProgramLetter */ 'template_fields': ProgramLetterTemplateField; /** * * @type {ProgramCertificate} * @memberof ProgramLetter */ 'certificate': ProgramCertificate; } /** * Seriializer for program letter template data which is configured in micromasters * @export * @interface ProgramLetterTemplateField */ export interface ProgramLetterTemplateField { /** * * @type {number} * @memberof ProgramLetterTemplateField */ 'id': number; /** * * @type {any} * @memberof ProgramLetterTemplateField */ 'meta': any; /** * * @type {string} * @memberof ProgramLetterTemplateField */ 'title': string; /** * * @type {number} * @memberof ProgramLetterTemplateField */ 'program_id': number; /** * * @type {any} * @memberof ProgramLetterTemplateField */ 'program_letter_footer': any; /** * * @type {string} * @memberof ProgramLetterTemplateField */ 'program_letter_footer_text': string; /** * * @type {string} * @memberof ProgramLetterTemplateField */ 'program_letter_header_text': string; /** * * @type {string} * @memberof ProgramLetterTemplateField */ 'program_letter_text': string; /** * * @type {any} * @memberof ProgramLetterTemplateField */ 'program_letter_logo': any; /** * * @type {Array} * @memberof ProgramLetterTemplateField */ 'program_letter_signatories': Array; } /** * Serializer for program resources * @export * @interface ProgramResource */ export interface ProgramResource { /** * * @type {number} * @memberof ProgramResource */ 'id': number; /** * * @type {Array} * @memberof ProgramResource */ 'topics'?: Array; /** * * @type {number} * @memberof ProgramResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof ProgramResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof ProgramResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof ProgramResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof ProgramResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof ProgramResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof ProgramResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof ProgramResource */ 'prices': Array; /** * * @type {Array} * @memberof ProgramResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof ProgramResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof ProgramResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof ProgramResource */ 'views': number; /** * * @type {Array} * @memberof ProgramResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof ProgramResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof ProgramResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof ProgramResource */ 'format': Array; /** * * @type {Array} * @memberof ProgramResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof ProgramResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof ProgramResource */ 'best_run_id': number | null; /** * * @type {ProgramResourceResourceTypeEnum} * @memberof ProgramResource */ 'resource_type': ProgramResourceResourceTypeEnum; /** * * @type {Program} * @memberof ProgramResource */ 'program': Program; /** * * @type {string} * @memberof ProgramResource */ 'readable_id': string; /** * * @type {string} * @memberof ProgramResource */ 'title': string; /** * * @type {string} * @memberof ProgramResource */ 'description'?: string | null; /** * * @type {string} * @memberof ProgramResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof ProgramResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof ProgramResource */ 'published'?: boolean; /** * * @type {Array} * @memberof ProgramResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof ProgramResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof ProgramResource */ 'resource_category': string; /** * * @type {Array} * @memberof ProgramResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof ProgramResource */ 'professional': boolean; /** * * @type {string} * @memberof ProgramResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof ProgramResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof ProgramResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof ProgramResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof ProgramResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof ProgramResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof ProgramResource */ 'location'?: string; /** * * @type {string} * @memberof ProgramResource */ 'duration'?: string; /** * * @type {number} * @memberof ProgramResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof ProgramResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof ProgramResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof ProgramResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof ProgramResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof ProgramResource */ 'require_summaries': boolean; } /** * Serializer for program resources * @export * @interface ProgramResourceRequest */ export interface ProgramResourceRequest { /** * * @type {Array} * @memberof ProgramResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof ProgramResourceRequest */ 'title': string; /** * * @type {string} * @memberof ProgramResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof ProgramResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof ProgramResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof ProgramResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof ProgramResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof ProgramResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof ProgramResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof ProgramResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof ProgramResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof ProgramResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof ProgramResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof ProgramResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof ProgramResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof ProgramResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof ProgramResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof ProgramResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof ProgramResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof ProgramResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof ProgramResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof ProgramResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const ProgramResourceResourceTypeEnum: { readonly Program: "program"; }; export type ProgramResourceResourceTypeEnum = typeof ProgramResourceResourceTypeEnum[keyof typeof ProgramResourceResourceTypeEnum]; /** * * `PROGRAM_COURSES` - Program Courses * `PROGRAM_PROGRAMS` - Program Programs * `LEARNING_PATH_ITEMS` - Learning Path Items * `PODCAST_EPISODES` - Podcast Episodes * `PLAYLIST_VIDEOS` - Playlist Videos * `COURSE_LEARNING_MATERIALS` - Course Learning Materials * @export * @enum {string} */ export declare const RelationTypeEnum: { /** * Program Courses */ readonly ProgramCourses: "PROGRAM_COURSES"; /** * Program Programs */ readonly ProgramPrograms: "PROGRAM_PROGRAMS"; /** * Learning Path Items */ readonly LearningPathItems: "LEARNING_PATH_ITEMS"; /** * Podcast Episodes */ readonly PodcastEpisodes: "PODCAST_EPISODES"; /** * Playlist Videos */ readonly PlaylistVideos: "PLAYLIST_VIDEOS"; /** * Course Learning Materials */ readonly CourseLearningMaterials: "COURSE_LEARNING_MATERIALS"; }; export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationTypeEnum]; /** * Serializer for child course/program entries within a program. * @export * @interface ResourceChildSummary */ export interface ResourceChildSummary { /** * * @type {string} * @memberof ResourceChildSummary */ 'title': string; /** * * @type {string} * @memberof ResourceChildSummary */ 'readable_id': string; /** * * @type {string} * @memberof ResourceChildSummary */ 'description': string; /** * * @type {string} * @memberof ResourceChildSummary */ 'resource_type': string; /** * * @type {Array} * @memberof ResourceChildSummary */ 'topics': Array; /** * * @type {string} * @memberof ResourceChildSummary */ 'parent_program'?: string; } /** * * `course` - course * `program` - program * `learning_path` - learning_path * `podcast` - podcast * `podcast_episode` - podcast_episode * `video` - video * `video_playlist` - video_playlist * `document` - document * @export * @enum {string} */ export declare const ResourceTypeEnum: { /** * course */ readonly Course: "course"; /** * program */ readonly Program: "program"; /** * learning_path */ readonly LearningPath: "learning_path"; /** * podcast */ readonly Podcast: "podcast"; /** * podcast_episode */ readonly PodcastEpisode: "podcast_episode"; /** * video */ readonly Video: "video"; /** * video_playlist */ readonly VideoPlaylist: "video_playlist"; /** * document */ readonly Document: "document"; }; export type ResourceTypeEnum = typeof ResourceTypeEnum[keyof typeof ResourceTypeEnum]; /** * * `course` - Course * `program` - Program * `learning_material` - Learning Material * @export * @enum {string} */ export declare const ResourceTypeGroupEnum: { /** * Course */ readonly Course: "course"; /** * Program */ readonly Program: "program"; /** * Learning Material */ readonly LearningMaterial: "learning_material"; }; export type ResourceTypeGroupEnum = typeof ResourceTypeGroupEnum[keyof typeof ResourceTypeGroupEnum]; /** * * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @export * @enum {string} */ export declare const SearchModeEnum: { /** * phrase */ readonly Phrase: "phrase"; /** * best_fields */ readonly BestFields: "best_fields"; /** * most_fields */ readonly MostFields: "most_fields"; /** * hybrid */ readonly Hybrid: "hybrid"; }; export type SearchModeEnum = typeof SearchModeEnum[keyof typeof SearchModeEnum]; /** * * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @export * @enum {string} */ export declare const SortbyEnum: { /** * Featured */ readonly Featured: "featured"; /** * Object ID ascending */ readonly Id: "id"; /** * Object ID descending */ readonly Id2: "-id"; /** * Readable ID ascending */ readonly ReadableId: "readable_id"; /** * Readable ID descending */ readonly ReadableId2: "-readable_id"; /** * Last Modified Date ascending */ readonly LastModified: "last_modified"; /** * Last Modified Date descending */ readonly LastModified2: "-last_modified"; /** * Newest resources first */ readonly New: "new"; /** * Start Date ascending */ readonly StartDate: "start_date"; /** * Start Date descending */ readonly StartDate2: "-start_date"; /** * MIT course number ascending */ readonly Mitcoursenumber: "mitcoursenumber"; /** * MIT course number descending */ readonly Mitcoursenumber2: "-mitcoursenumber"; /** * Popularity ascending */ readonly Views: "views"; /** * Popularity descending */ readonly Views2: "-views"; /** * Next start date ascending */ readonly Upcoming: "upcoming"; }; export type SortbyEnum = typeof SortbyEnum[keyof typeof SortbyEnum]; /** * * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs * @export * @enum {string} */ export declare const SourceEnum: { /** * micromasters */ readonly Micromasters: "micromasters"; /** * mit_edx */ readonly MitEdx: "mit_edx"; /** * mitpe */ readonly Mitpe: "mitpe"; /** * mitxonline */ readonly Mitxonline: "mitxonline"; /** * oll */ readonly Oll: "oll"; /** * ocw */ readonly Ocw: "ocw"; /** * podcast */ readonly Podcast: "podcast"; /** * mit_climate */ readonly MitClimate: "mit_climate"; /** * see */ readonly See: "see"; /** * xpro */ readonly Xpro: "xpro"; /** * youtube */ readonly Youtube: "youtube"; /** * canvas */ readonly Canvas: "canvas"; /** * ovs */ readonly Ovs: "ovs"; }; export type SourceEnum = typeof SourceEnum[keyof typeof SourceEnum]; /** * * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @export * @enum {string} */ export declare const SourceTypeEnum: { /** * search_subscription_type */ readonly SearchSubscriptionType: "search_subscription_type"; /** * channel_subscription_type */ readonly ChannelSubscriptionType: "channel_subscription_type"; }; export type SourceTypeEnum = typeof SourceTypeEnum[keyof typeof SourceTypeEnum]; /** * * @export * @interface User */ export interface User { /** * * @type {string} * @memberof User */ 'first_name'?: string; /** * * @type {string} * @memberof User */ 'last_name'?: string; } /** * Simplified serializer for UserList model. * @export * @interface UserList */ export interface UserList { /** * * @type {number} * @memberof UserList */ 'id': number; /** * * @type {Array} * @memberof UserList */ 'topics'?: Array; /** * Number of published items in the list. * @type {number} * @memberof UserList */ 'item_count': number; /** * Return the image of the first item * @type {{ [key: string]: any; }} * @memberof UserList */ 'image': { [key: string]: any; }; /** * * @type {string} * @memberof UserList */ 'title': string; /** * * @type {string} * @memberof UserList */ 'description'?: string; /** * * @type {PrivacyLevelEnum} * @memberof UserList */ 'privacy_level'?: PrivacyLevelEnum; /** * * @type {number} * @memberof UserList */ 'author': number; } /** * Serializer for UserListRelationship model * @export * @interface UserListRelationship */ export interface UserListRelationship { /** * * @type {number} * @memberof UserListRelationship */ 'id': number; /** * * @type {LearningResource} * @memberof UserListRelationship */ 'resource': LearningResource; /** * * @type {number} * @memberof UserListRelationship */ 'position'?: number; /** * * @type {number} * @memberof UserListRelationship */ 'parent': number; /** * * @type {number} * @memberof UserListRelationship */ 'child': number; } /** * Serializer for UserListRelationship model * @export * @interface UserListRelationshipRequest */ export interface UserListRelationshipRequest { /** * * @type {number} * @memberof UserListRelationshipRequest */ 'position'?: number; /** * * @type {number} * @memberof UserListRelationshipRequest */ 'parent': number; /** * * @type {number} * @memberof UserListRelationshipRequest */ 'child': number; } /** * Simplified serializer for UserList model. * @export * @interface UserListRequest */ export interface UserListRequest { /** * * @type {Array} * @memberof UserListRequest */ 'topics'?: Array; /** * * @type {string} * @memberof UserListRequest */ 'title': string; /** * * @type {string} * @memberof UserListRequest */ 'description'?: string; /** * * @type {PrivacyLevelEnum} * @memberof UserListRequest */ 'privacy_level'?: PrivacyLevelEnum; } /** * * @export * @interface UserRequest */ export interface UserRequest { /** * * @type {string} * @memberof UserRequest */ 'first_name'?: string; /** * * @type {string} * @memberof UserRequest */ 'last_name'?: string; } /** * Serializer for the Video model * @export * @interface Video */ export interface Video { /** * * @type {number} * @memberof Video */ 'id': number; /** * * @type {Array} * @memberof Video */ 'caption_urls': Array; /** * * @type {string} * @memberof Video */ 'streaming_url': string | null; /** * * @type {string} * @memberof Video */ 'cover_image_url': string | null; /** * * @type {string} * @memberof Video */ 'duration': string; } /** * Serializer for the VideoChannel model * @export * @interface VideoChannel */ export interface VideoChannel { /** * * @type {string} * @memberof VideoChannel */ 'channel_id': string; /** * * @type {string} * @memberof VideoChannel */ 'title': string; } /** * Serializer for the VideoChannel model * @export * @interface VideoChannelRequest */ export interface VideoChannelRequest { /** * * @type {string} * @memberof VideoChannelRequest */ 'channel_id': string; /** * * @type {string} * @memberof VideoChannelRequest */ 'title': string; } /** * Serializer for the VideoPlaylist model * @export * @interface VideoPlaylist */ export interface VideoPlaylist { /** * * @type {number} * @memberof VideoPlaylist */ 'id': number; /** * * @type {VideoChannel} * @memberof VideoPlaylist */ 'channel': VideoChannel | null; /** * * @type {number} * @memberof VideoPlaylist */ 'video_count': number; } /** * Serializer for the VideoPlaylist model * @export * @interface VideoPlaylistRequest */ export interface VideoPlaylistRequest { /** * * @type {number} * @memberof VideoPlaylistRequest */ 'video_count': number; } /** * Serializer for video playlist resources * @export * @interface VideoPlaylistResource */ export interface VideoPlaylistResource { /** * * @type {number} * @memberof VideoPlaylistResource */ 'id': number; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'topics'?: Array; /** * * @type {number} * @memberof VideoPlaylistResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof VideoPlaylistResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof VideoPlaylistResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof VideoPlaylistResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'prices': Array; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof VideoPlaylistResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof VideoPlaylistResource */ 'views': number; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof VideoPlaylistResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof VideoPlaylistResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'format': Array; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof VideoPlaylistResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof VideoPlaylistResource */ 'best_run_id': number | null; /** * * @type {VideoPlaylistResourceResourceTypeEnum} * @memberof VideoPlaylistResource */ 'resource_type': VideoPlaylistResourceResourceTypeEnum; /** * * @type {VideoPlaylist} * @memberof VideoPlaylistResource */ 'video_playlist': VideoPlaylist; /** * * @type {string} * @memberof VideoPlaylistResource */ 'readable_id': string; /** * * @type {string} * @memberof VideoPlaylistResource */ 'title': string; /** * * @type {string} * @memberof VideoPlaylistResource */ 'description'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'published'?: boolean; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof VideoPlaylistResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof VideoPlaylistResource */ 'resource_category': string; /** * * @type {Array} * @memberof VideoPlaylistResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'professional': boolean; /** * * @type {string} * @memberof VideoPlaylistResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof VideoPlaylistResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof VideoPlaylistResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof VideoPlaylistResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResource */ 'location'?: string; /** * * @type {string} * @memberof VideoPlaylistResource */ 'duration'?: string; /** * * @type {number} * @memberof VideoPlaylistResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof VideoPlaylistResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof VideoPlaylistResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof VideoPlaylistResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof VideoPlaylistResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof VideoPlaylistResource */ 'require_summaries': boolean; } /** * Serializer for video playlist resources * @export * @interface VideoPlaylistResourceRequest */ export interface VideoPlaylistResourceRequest { /** * * @type {Array} * @memberof VideoPlaylistResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'title': string; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'description'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof VideoPlaylistResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof VideoPlaylistResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof VideoPlaylistResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof VideoPlaylistResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof VideoPlaylistResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof VideoPlaylistResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof VideoPlaylistResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof VideoPlaylistResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof VideoPlaylistResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof VideoPlaylistResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof VideoPlaylistResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof VideoPlaylistResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const VideoPlaylistResourceResourceTypeEnum: { readonly VideoPlaylist: "video_playlist"; }; export type VideoPlaylistResourceResourceTypeEnum = typeof VideoPlaylistResourceResourceTypeEnum[keyof typeof VideoPlaylistResourceResourceTypeEnum]; /** * Serializer for the Video model * @export * @interface VideoRequest */ export interface VideoRequest { /** * * @type {string} * @memberof VideoRequest */ 'duration': string; } /** * Serializer for video resources * @export * @interface VideoResource */ export interface VideoResource { /** * * @type {number} * @memberof VideoResource */ 'id': number; /** * * @type {Array} * @memberof VideoResource */ 'topics'?: Array; /** * * @type {number} * @memberof VideoResource */ 'position': number | null; /** * * @type {LearningResourceOfferor} * @memberof VideoResource */ 'offered_by': LearningResourceOfferor | null; /** * * @type {LearningResourcePlatform} * @memberof VideoResource */ 'platform': LearningResourcePlatform | null; /** * * @type {Array} * @memberof VideoResource */ 'course_feature': Array | null; /** * * @type {Array} * @memberof VideoResource */ 'departments': Array | null; /** * * @type {boolean} * @memberof VideoResource */ 'certification': boolean; /** * * @type {CourseResourceCertificationType} * @memberof VideoResource */ 'certification_type': CourseResourceCertificationType; /** * * @type {Array} * @memberof VideoResource */ 'prices': Array; /** * * @type {Array} * @memberof VideoResource */ 'resource_prices': Array; /** * * @type {Array} * @memberof VideoResource */ 'runs': Array | null; /** * * @type {LearningResourceImage} * @memberof VideoResource */ 'image': LearningResourceImage | null; /** * * @type {number} * @memberof VideoResource */ 'views': number; /** * * @type {Array} * @memberof VideoResource */ 'delivery': Array; /** * Return true if the resource is free/has a free option * @type {boolean} * @memberof VideoResource */ 'free': boolean; /** * * @type {ResourceTypeGroupEnum} * @memberof VideoResource */ 'resource_type_group': ResourceTypeGroupEnum; /** * * @type {Array} * @memberof VideoResource */ 'format': Array; /** * * @type {Array} * @memberof VideoResource */ 'pace': Array; /** * * @type {LearningResourceRelationshipChildField} * @memberof VideoResource */ 'children': LearningResourceRelationshipChildField | null; /** * Return the best run id for the resource, if it has runs * @type {number} * @memberof VideoResource */ 'best_run_id': number | null; /** * * @type {VideoResourceResourceTypeEnum} * @memberof VideoResource */ 'resource_type': VideoResourceResourceTypeEnum; /** * * @type {Video} * @memberof VideoResource */ 'video': Video | null; /** * Get the playlist id(s) the video belongs to * @type {Array} * @memberof VideoResource */ 'playlists': Array; /** * * @type {Array} * @memberof VideoResource */ 'content_files': Array | null; /** * * @type {string} * @memberof VideoResource */ 'description': string | null; /** * * @type {string} * @memberof VideoResource */ 'readable_id': string; /** * * @type {string} * @memberof VideoResource */ 'title': string; /** * * @type {string} * @memberof VideoResource */ 'full_description'?: string | null; /** * * @type {string} * @memberof VideoResource */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof VideoResource */ 'published'?: boolean; /** * * @type {Array} * @memberof VideoResource */ 'languages'?: Array | null; /** * * @type {string} * @memberof VideoResource */ 'url'?: string | null; /** * The display category for this resource. * @type {string} * @memberof VideoResource */ 'resource_category': string; /** * * @type {Array} * @memberof VideoResource */ 'ocw_topics'?: Array; /** * * @type {boolean} * @memberof VideoResource */ 'professional': boolean; /** * * @type {string} * @memberof VideoResource */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof VideoResource */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof VideoResource */ 'completeness'?: number; /** * * @type {boolean} * @memberof VideoResource */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof VideoResource */ 'test_mode'?: boolean; /** * * @type {string} * @memberof VideoResource */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof VideoResource */ 'location'?: string; /** * * @type {string} * @memberof VideoResource */ 'duration'?: string; /** * * @type {number} * @memberof VideoResource */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof VideoResource */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof VideoResource */ 'time_commitment'?: string; /** * * @type {number} * @memberof VideoResource */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof VideoResource */ 'max_weekly_hours'?: number | null; /** * * @type {boolean} * @memberof VideoResource */ 'require_summaries': boolean; } /** * Serializer for video resources * @export * @interface VideoResourceRequest */ export interface VideoResourceRequest { /** * * @type {Array} * @memberof VideoResourceRequest */ 'topics'?: Array; /** * * @type {string} * @memberof VideoResourceRequest */ 'title': string; /** * * @type {string} * @memberof VideoResourceRequest */ 'full_description'?: string | null; /** * * @type {string} * @memberof VideoResourceRequest */ 'last_modified'?: string | null; /** * * @type {boolean} * @memberof VideoResourceRequest */ 'published'?: boolean; /** * * @type {Array} * @memberof VideoResourceRequest */ 'languages'?: Array | null; /** * * @type {string} * @memberof VideoResourceRequest */ 'url'?: string | null; /** * * @type {Array} * @memberof VideoResourceRequest */ 'ocw_topics'?: Array; /** * * @type {string} * @memberof VideoResourceRequest */ 'next_start_date'?: string | null; /** * * @type {AvailabilityEnum} * @memberof VideoResourceRequest */ 'availability'?: AvailabilityEnum | null; /** * * @type {number} * @memberof VideoResourceRequest */ 'completeness'?: number; /** * * @type {boolean} * @memberof VideoResourceRequest */ 'license_cc'?: boolean; /** * * @type {boolean} * @memberof VideoResourceRequest */ 'test_mode'?: boolean; /** * * @type {string} * @memberof VideoResourceRequest */ 'continuing_ed_credits'?: string | null; /** * * @type {string} * @memberof VideoResourceRequest */ 'location'?: string; /** * * @type {string} * @memberof VideoResourceRequest */ 'duration'?: string; /** * * @type {number} * @memberof VideoResourceRequest */ 'min_weeks'?: number | null; /** * * @type {number} * @memberof VideoResourceRequest */ 'max_weeks'?: number | null; /** * * @type {string} * @memberof VideoResourceRequest */ 'time_commitment'?: string; /** * * @type {number} * @memberof VideoResourceRequest */ 'min_weekly_hours'?: number | null; /** * * @type {number} * @memberof VideoResourceRequest */ 'max_weekly_hours'?: number | null; } /** * * @export * @enum {string} */ export declare const VideoResourceResourceTypeEnum: { readonly Video: "video"; }; export type VideoResourceResourceTypeEnum = typeof VideoResourceResourceTypeEnum[keyof typeof VideoResourceResourceTypeEnum]; /** * Serializer for webhook responses. * @export * @interface WebhookResponse */ export interface WebhookResponse { /** * * @type {string} * @memberof WebhookResponse */ 'status': string; /** * * @type {string} * @memberof WebhookResponse */ 'message'?: string; /** * * @type {string} * @memberof WebhookResponse */ 'error'?: string; } /** * Serializer for WebsiteContent model. * @export * @interface WebsiteContent */ export interface WebsiteContent { /** * * @type {number} * @memberof WebsiteContent */ 'id': number; /** * * @type {string} * @memberof WebsiteContent */ 'title': string; /** * * @type {string} * @memberof WebsiteContent */ 'author_name'?: string; /** * * @type {any} * @memberof WebsiteContent */ 'content'?: any; /** * * @type {WebsiteContentContentTypeEnum} * @memberof WebsiteContent */ 'content_type'?: WebsiteContentContentTypeEnum; /** * * @type {User} * @memberof WebsiteContent */ 'user': User; /** * * @type {string} * @memberof WebsiteContent */ 'created_on': string; /** * * @type {string} * @memberof WebsiteContent */ 'updated_on': string; /** * * @type {string} * @memberof WebsiteContent */ 'publish_date': string; /** * * @type {boolean} * @memberof WebsiteContent */ 'is_published'?: boolean; /** * * @type {string} * @memberof WebsiteContent */ 'slug'?: string; } /** * * `news` - News * `article` - Article * @export * @enum {string} */ export declare const WebsiteContentContentTypeEnum: { /** * News */ readonly News: "news"; /** * Article */ readonly Article: "article"; }; export type WebsiteContentContentTypeEnum = typeof WebsiteContentContentTypeEnum[keyof typeof WebsiteContentContentTypeEnum]; /** * Serializer for WebsiteContent model. * @export * @interface WebsiteContentRequest */ export interface WebsiteContentRequest { /** * * @type {string} * @memberof WebsiteContentRequest */ 'title': string; /** * * @type {string} * @memberof WebsiteContentRequest */ 'author_name'?: string; /** * * @type {any} * @memberof WebsiteContentRequest */ 'content'?: any; /** * * @type {WebsiteContentContentTypeEnum} * @memberof WebsiteContentRequest */ 'content_type'?: WebsiteContentContentTypeEnum; /** * * @type {boolean} * @memberof WebsiteContentRequest */ 'is_published'?: boolean; /** * * @type {string} * @memberof WebsiteContentRequest */ 'slug'?: string; } /** * ArticlesApi - axios parameter creator * @export */ export declare const ArticlesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new content item * @summary Create * @param {WebsiteContentRequest} WebsiteContentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesCreate: (WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Delete a content item * @summary Destroy * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {string} identifier Numeric ID or slug of the content item * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDetailRetrieve: (identifier: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of website content items * @summary List * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article * @param {boolean} [draft] Filter to show only draft (unpublished) items * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesList: (content_type?: ArticlesListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Update a content item * @summary Update * @param {number} id A unique integer value identifying this website content. * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesPartialUpdate: (id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single content item * @summary Retrieve * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ArticlesApi - functional programming interface * @export */ export declare const ArticlesApiFp: (configuration?: Configuration) => { /** * Create a new content item * @summary Create * @param {WebsiteContentRequest} WebsiteContentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesCreate(WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a content item * @summary Destroy * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {string} identifier Numeric ID or slug of the content item * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDetailRetrieve(identifier: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of website content items * @summary List * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article * @param {boolean} [draft] Filter to show only draft (unpublished) items * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesList(content_type?: ArticlesListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a content item * @summary Update * @param {number} id A unique integer value identifying this website content. * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesPartialUpdate(id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single content item * @summary Retrieve * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ArticlesApi - factory interface * @export */ export declare const ArticlesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new content item * @summary Create * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesCreate(requestParameters: ArticlesApiArticlesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a content item * @summary Destroy * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDestroy(requestParameters: ArticlesApiArticlesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesDetailRetrieve(requestParameters: ArticlesApiArticlesDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of website content items * @summary List * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesList(requestParameters?: ArticlesApiArticlesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update a content item * @summary Update * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesPartialUpdate(requestParameters: ArticlesApiArticlesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single content item * @summary Retrieve * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ articlesRetrieve(requestParameters: ArticlesApiArticlesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for articlesCreate operation in ArticlesApi. * @export * @interface ArticlesApiArticlesCreateRequest */ export interface ArticlesApiArticlesCreateRequest { /** * * @type {WebsiteContentRequest} * @memberof ArticlesApiArticlesCreate */ readonly WebsiteContentRequest: WebsiteContentRequest; } /** * Request parameters for articlesDestroy operation in ArticlesApi. * @export * @interface ArticlesApiArticlesDestroyRequest */ export interface ArticlesApiArticlesDestroyRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof ArticlesApiArticlesDestroy */ readonly id: number; } /** * Request parameters for articlesDetailRetrieve operation in ArticlesApi. * @export * @interface ArticlesApiArticlesDetailRetrieveRequest */ export interface ArticlesApiArticlesDetailRetrieveRequest { /** * Numeric ID or slug of the content item * @type {string} * @memberof ArticlesApiArticlesDetailRetrieve */ readonly identifier: string; } /** * Request parameters for articlesList operation in ArticlesApi. * @export * @interface ArticlesApiArticlesListRequest */ export interface ArticlesApiArticlesListRequest { /** * Filter by content type * `news` - News * `article` - Article * @type {'article' | 'news'} * @memberof ArticlesApiArticlesList */ readonly content_type?: ArticlesListContentTypeEnum; /** * Filter to show only draft (unpublished) items * @type {boolean} * @memberof ArticlesApiArticlesList */ readonly draft?: boolean; /** * Number of results to return per page. * @type {number} * @memberof ArticlesApiArticlesList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof ArticlesApiArticlesList */ readonly offset?: number; } /** * Request parameters for articlesPartialUpdate operation in ArticlesApi. * @export * @interface ArticlesApiArticlesPartialUpdateRequest */ export interface ArticlesApiArticlesPartialUpdateRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof ArticlesApiArticlesPartialUpdate */ readonly id: number; /** * * @type {PatchedWebsiteContentRequest} * @memberof ArticlesApiArticlesPartialUpdate */ readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest; } /** * Request parameters for articlesRetrieve operation in ArticlesApi. * @export * @interface ArticlesApiArticlesRetrieveRequest */ export interface ArticlesApiArticlesRetrieveRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof ArticlesApiArticlesRetrieve */ readonly id: number; } /** * ArticlesApi - object-oriented interface * @export * @class ArticlesApi * @extends {BaseAPI} */ export declare class ArticlesApi extends BaseAPI { /** * Create a new content item * @summary Create * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesCreate(requestParameters: ArticlesApiArticlesCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Delete a content item * @summary Destroy * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesDestroy(requestParameters: ArticlesApiArticlesDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesDetailRetrieve(requestParameters: ArticlesApiArticlesDetailRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of website content items * @summary List * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesList(requestParameters?: ArticlesApiArticlesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Update a content item * @summary Update * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesPartialUpdate(requestParameters: ArticlesApiArticlesPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single content item * @summary Retrieve * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArticlesApi */ articlesRetrieve(requestParameters: ArticlesApiArticlesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ArticlesListContentTypeEnum: { readonly Article: "article"; readonly News: "news"; }; export type ArticlesListContentTypeEnum = typeof ArticlesListContentTypeEnum[keyof typeof ArticlesListContentTypeEnum]; /** * ContentFileSearchApi - axios parameter creator * @export */ export declare const ContentFileSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Search for content files * @summary Search * @param {Array} [aggregations] Show resource counts by category * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {Array} [id] The id value for the content file * @param {number} [limit] Number of results to return per page * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {string} [q] The search text * @param {Array} [resource_id] The id value of the parent learning resource for the content file * @param {Array} [run_id] The id value of the run that the content file belongs to * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentFileSearchRetrieve: (aggregations?: Array, content_feature_type?: Array, dev_mode?: boolean | null, id?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_id?: Array, run_id?: Array, sortby?: ContentFileSearchRetrieveSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * ContentFileSearchApi - functional programming interface * @export */ export declare const ContentFileSearchApiFp: (configuration?: Configuration) => { /** * Search for content files * @summary Search * @param {Array} [aggregations] Show resource counts by category * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {Array} [id] The id value for the content file * @param {number} [limit] Number of results to return per page * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {string} [q] The search text * @param {Array} [resource_id] The id value of the parent learning resource for the content file * @param {Array} [run_id] The id value of the run that the content file belongs to * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentFileSearchRetrieve(aggregations?: Array, content_feature_type?: Array, dev_mode?: boolean | null, id?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_id?: Array, run_id?: Array, sortby?: ContentFileSearchRetrieveSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContentFileSearchApi - factory interface * @export */ export declare const ContentFileSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Search for content files * @summary Search * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentFileSearchRetrieve(requestParameters?: ContentFileSearchApiContentFileSearchRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for contentFileSearchRetrieve operation in ContentFileSearchApi. * @export * @interface ContentFileSearchApiContentFileSearchRetrieveRequest */ export interface ContentFileSearchApiContentFileSearchRetrieveRequest { /** * Show resource counts by category * @type {Array<'topic' | 'content_feature_type' | 'platform' | 'offered_by'>} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly aggregations?: Array; /** * The feature type of the content file. Possible options are at api/v1/course_features/ * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly content_feature_type?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly dev_mode?: boolean | null; /** * The id value for the content file * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly id?: Array; /** * Number of results to return per page * @type {number} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly limit?: number; /** * The ocw topic name. * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly offset?: number; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly platform?: Array; /** * The search text * @type {string} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly q?: string; /** * The id value of the parent learning resource for the content file * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly resource_id?: Array; /** * The id value of the run that the content file belongs to * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly run_id?: Array; /** * if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id * @type {'id' | '-id' | 'resource_readable_id' | '-resource_readable_id'} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly sortby?: ContentFileSearchRetrieveSortbyEnum; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof ContentFileSearchApiContentFileSearchRetrieve */ readonly topic?: Array; } /** * ContentFileSearchApi - object-oriented interface * @export * @class ContentFileSearchApi * @extends {BaseAPI} */ export declare class ContentFileSearchApi extends BaseAPI { /** * Search for content files * @summary Search * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentFileSearchApi */ contentFileSearchRetrieve(requestParameters?: ContentFileSearchApiContentFileSearchRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ContentFileSearchRetrieveAggregationsEnum: { readonly Topic: "topic"; readonly ContentFeatureType: "content_feature_type"; readonly Platform: "platform"; readonly OfferedBy: "offered_by"; }; export type ContentFileSearchRetrieveAggregationsEnum = typeof ContentFileSearchRetrieveAggregationsEnum[keyof typeof ContentFileSearchRetrieveAggregationsEnum]; /** * @export */ export declare const ContentFileSearchRetrieveOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type ContentFileSearchRetrieveOfferedByEnum = typeof ContentFileSearchRetrieveOfferedByEnum[keyof typeof ContentFileSearchRetrieveOfferedByEnum]; /** * @export */ export declare const ContentFileSearchRetrievePlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type ContentFileSearchRetrievePlatformEnum = typeof ContentFileSearchRetrievePlatformEnum[keyof typeof ContentFileSearchRetrievePlatformEnum]; /** * @export */ export declare const ContentFileSearchRetrieveSortbyEnum: { readonly Id: "id"; readonly Id2: "-id"; readonly ResourceReadableId: "resource_readable_id"; readonly ResourceReadableId2: "-resource_readable_id"; }; export type ContentFileSearchRetrieveSortbyEnum = typeof ContentFileSearchRetrieveSortbyEnum[keyof typeof ContentFileSearchRetrieveSortbyEnum]; /** * ContentfilesApi - axios parameter creator * @export */ export declare const ContentfilesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Viewset for ContentFiles * @summary List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesList: (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for ContentFiles * @summary Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ContentfilesApi - functional programming interface * @export */ export declare const ContentfilesApiFp: (configuration?: Configuration) => { /** * Viewset for ContentFiles * @summary List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for ContentFiles * @summary Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContentfilesApi - factory interface * @export */ export declare const ContentfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Viewset for ContentFiles * @summary List * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesList(requestParameters: ContentfilesApiContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for ContentFiles * @summary Retrieve * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contentfilesRetrieve(requestParameters: ContentfilesApiContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for contentfilesList operation in ContentfilesApi. * @export * @interface ContentfilesApiContentfilesListRequest */ export interface ContentfilesApiContentfilesListRequest { /** * id of the parent learning resource * @type {number} * @memberof ContentfilesApiContentfilesList */ readonly learning_resource_id: number; /** * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof ContentfilesApiContentfilesList */ readonly content_feature_type?: Array; /** * The edx module id of the content file * @type {Array} * @memberof ContentfilesApiContentfilesList */ readonly edx_module_id?: Array; /** * Number of results to return per page. * @type {number} * @memberof ContentfilesApiContentfilesList */ readonly limit?: number; /** * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof ContentfilesApiContentfilesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof ContentfilesApiContentfilesList */ readonly offset?: number; /** * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof ContentfilesApiContentfilesList */ readonly platform?: Array; /** * The id of the learning resource the content file belongs to * @type {Array} * @memberof ContentfilesApiContentfilesList */ readonly resource_id?: Array; /** * The id of the learning resource run the content file belongs to * @type {Array} * @memberof ContentfilesApiContentfilesList */ readonly run_id?: Array; } /** * Request parameters for contentfilesRetrieve operation in ContentfilesApi. * @export * @interface ContentfilesApiContentfilesRetrieveRequest */ export interface ContentfilesApiContentfilesRetrieveRequest { /** * A unique integer value identifying this contentfile. * @type {number} * @memberof ContentfilesApiContentfilesRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof ContentfilesApiContentfilesRetrieve */ readonly learning_resource_id: number; } /** * ContentfilesApi - object-oriented interface * @export * @class ContentfilesApi * @extends {BaseAPI} */ export declare class ContentfilesApi extends BaseAPI { /** * Viewset for ContentFiles * @summary List * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentfilesApi */ contentfilesList(requestParameters: ContentfilesApiContentfilesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for ContentFiles * @summary Retrieve * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentfilesApi */ contentfilesRetrieve(requestParameters: ContentfilesApiContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ContentfilesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type ContentfilesListOfferedByEnum = typeof ContentfilesListOfferedByEnum[keyof typeof ContentfilesListOfferedByEnum]; /** * @export */ export declare const ContentfilesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type ContentfilesListPlatformEnum = typeof ContentfilesListPlatformEnum[keyof typeof ContentfilesListPlatformEnum]; /** * CourseFeaturesApi - axios parameter creator * @export */ export declare const CourseFeaturesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Course Features and Content Feature Types * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Course Features and Content Feature Types * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource content tag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * CourseFeaturesApi - functional programming interface * @export */ export declare const CourseFeaturesApiFp: (configuration?: Configuration) => { /** * Course Features and Content Feature Types * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Course Features and Content Feature Types * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource content tag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CourseFeaturesApi - factory interface * @export */ export declare const CourseFeaturesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Course Features and Content Feature Types * @summary List * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesList(requestParameters?: CourseFeaturesApiCourseFeaturesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Course Features and Content Feature Types * @summary Retrieve * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ courseFeaturesRetrieve(requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for courseFeaturesList operation in CourseFeaturesApi. * @export * @interface CourseFeaturesApiCourseFeaturesListRequest */ export interface CourseFeaturesApiCourseFeaturesListRequest { /** * Number of results to return per page. * @type {number} * @memberof CourseFeaturesApiCourseFeaturesList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof CourseFeaturesApiCourseFeaturesList */ readonly offset?: number; } /** * Request parameters for courseFeaturesRetrieve operation in CourseFeaturesApi. * @export * @interface CourseFeaturesApiCourseFeaturesRetrieveRequest */ export interface CourseFeaturesApiCourseFeaturesRetrieveRequest { /** * A unique integer value identifying this learning resource content tag. * @type {number} * @memberof CourseFeaturesApiCourseFeaturesRetrieve */ readonly id: number; } /** * CourseFeaturesApi - object-oriented interface * @export * @class CourseFeaturesApi * @extends {BaseAPI} */ export declare class CourseFeaturesApi extends BaseAPI { /** * Course Features and Content Feature Types * @summary List * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CourseFeaturesApi */ courseFeaturesList(requestParameters?: CourseFeaturesApiCourseFeaturesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Course Features and Content Feature Types * @summary Retrieve * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CourseFeaturesApi */ courseFeaturesRetrieve(requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * CoursesApi - axios parameter creator * @export */ export declare const CoursesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesList: (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of courses * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: CoursesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single course * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * CoursesApi - functional programming interface * @export */ export declare const CoursesApiFp: (configuration?: Configuration) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of courses * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: CoursesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single course * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CoursesApi - factory interface * @export */ export declare const CoursesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesList(requestParameters: CoursesApiCoursesContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesContentfilesRetrieve(requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of courses * @summary List * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesList(requestParameters?: CoursesApiCoursesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single course * @summary Retrieve * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ coursesRetrieve(requestParameters: CoursesApiCoursesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for coursesContentfilesList operation in CoursesApi. * @export * @interface CoursesApiCoursesContentfilesListRequest */ export interface CoursesApiCoursesContentfilesListRequest { /** * id of the parent learning resource * @type {number} * @memberof CoursesApiCoursesContentfilesList */ readonly learning_resource_id: number; /** * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof CoursesApiCoursesContentfilesList */ readonly content_feature_type?: Array; /** * The edx module id of the content file * @type {Array} * @memberof CoursesApiCoursesContentfilesList */ readonly edx_module_id?: Array; /** * Number of results to return per page. * @type {number} * @memberof CoursesApiCoursesContentfilesList */ readonly limit?: number; /** * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof CoursesApiCoursesContentfilesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof CoursesApiCoursesContentfilesList */ readonly offset?: number; /** * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof CoursesApiCoursesContentfilesList */ readonly platform?: Array; /** * The id of the learning resource the content file belongs to * @type {Array} * @memberof CoursesApiCoursesContentfilesList */ readonly resource_id?: Array; /** * The id of the learning resource run the content file belongs to * @type {Array} * @memberof CoursesApiCoursesContentfilesList */ readonly run_id?: Array; } /** * Request parameters for coursesContentfilesRetrieve operation in CoursesApi. * @export * @interface CoursesApiCoursesContentfilesRetrieveRequest */ export interface CoursesApiCoursesContentfilesRetrieveRequest { /** * A unique integer value identifying this contentfile. * @type {number} * @memberof CoursesApiCoursesContentfilesRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof CoursesApiCoursesContentfilesRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for coursesList operation in CoursesApi. * @export * @interface CoursesApiCoursesListRequest */ export interface CoursesApiCoursesListRequest { /** * * @type {boolean} * @memberof CoursesApiCoursesList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof CoursesApiCoursesList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof CoursesApiCoursesList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof CoursesApiCoursesList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof CoursesApiCoursesList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof CoursesApiCoursesList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof CoursesApiCoursesList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof CoursesApiCoursesList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof CoursesApiCoursesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof CoursesApiCoursesList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof CoursesApiCoursesList */ readonly platform?: Array; /** * * @type {boolean} * @memberof CoursesApiCoursesList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof CoursesApiCoursesList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof CoursesApiCoursesList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof CoursesApiCoursesList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof CoursesApiCoursesList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof CoursesApiCoursesList */ readonly sortby?: CoursesListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof CoursesApiCoursesList */ readonly topic?: Array; } /** * Request parameters for coursesRetrieve operation in CoursesApi. * @export * @interface CoursesApiCoursesRetrieveRequest */ export interface CoursesApiCoursesRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof CoursesApiCoursesRetrieve */ readonly id: number; } /** * CoursesApi - object-oriented interface * @export * @class CoursesApi * @extends {BaseAPI} */ export declare class CoursesApi extends BaseAPI { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoursesApi */ coursesContentfilesList(requestParameters: CoursesApiCoursesContentfilesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoursesApi */ coursesContentfilesRetrieve(requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of courses * @summary List * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoursesApi */ coursesList(requestParameters?: CoursesApiCoursesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single course * @summary Retrieve * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CoursesApi */ coursesRetrieve(requestParameters: CoursesApiCoursesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const CoursesContentfilesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type CoursesContentfilesListOfferedByEnum = typeof CoursesContentfilesListOfferedByEnum[keyof typeof CoursesContentfilesListOfferedByEnum]; /** * @export */ export declare const CoursesContentfilesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type CoursesContentfilesListPlatformEnum = typeof CoursesContentfilesListPlatformEnum[keyof typeof CoursesContentfilesListPlatformEnum]; /** * @export */ export declare const CoursesListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type CoursesListCertificationTypeEnum = typeof CoursesListCertificationTypeEnum[keyof typeof CoursesListCertificationTypeEnum]; /** * @export */ export declare const CoursesListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type CoursesListDeliveryEnum = typeof CoursesListDeliveryEnum[keyof typeof CoursesListDeliveryEnum]; /** * @export */ export declare const CoursesListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type CoursesListDepartmentEnum = typeof CoursesListDepartmentEnum[keyof typeof CoursesListDepartmentEnum]; /** * @export */ export declare const CoursesListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type CoursesListLevelEnum = typeof CoursesListLevelEnum[keyof typeof CoursesListLevelEnum]; /** * @export */ export declare const CoursesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type CoursesListOfferedByEnum = typeof CoursesListOfferedByEnum[keyof typeof CoursesListOfferedByEnum]; /** * @export */ export declare const CoursesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type CoursesListPlatformEnum = typeof CoursesListPlatformEnum[keyof typeof CoursesListPlatformEnum]; /** * @export */ export declare const CoursesListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type CoursesListResourceTypeEnum = typeof CoursesListResourceTypeEnum[keyof typeof CoursesListResourceTypeEnum]; /** * @export */ export declare const CoursesListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type CoursesListResourceTypeGroupEnum = typeof CoursesListResourceTypeGroupEnum[keyof typeof CoursesListResourceTypeGroupEnum]; /** * @export */ export declare const CoursesListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type CoursesListSortbyEnum = typeof CoursesListSortbyEnum[keyof typeof CoursesListSortbyEnum]; /** * DepartmentsApi - axios parameter creator * @export */ export declare const DepartmentsApiAxiosParamCreator: (configuration?: Configuration) => { /** * MIT academic departments * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * MIT academic departments * @summary Retrieve * @param {string} department_id A unique value identifying this learning resource department. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsRetrieve: (department_id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * DepartmentsApi - functional programming interface * @export */ export declare const DepartmentsApiFp: (configuration?: Configuration) => { /** * MIT academic departments * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * MIT academic departments * @summary Retrieve * @param {string} department_id A unique value identifying this learning resource department. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsRetrieve(department_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DepartmentsApi - factory interface * @export */ export declare const DepartmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * MIT academic departments * @summary List * @param {DepartmentsApiDepartmentsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsList(requestParameters?: DepartmentsApiDepartmentsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * MIT academic departments * @summary Retrieve * @param {DepartmentsApiDepartmentsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ departmentsRetrieve(requestParameters: DepartmentsApiDepartmentsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for departmentsList operation in DepartmentsApi. * @export * @interface DepartmentsApiDepartmentsListRequest */ export interface DepartmentsApiDepartmentsListRequest { /** * Number of results to return per page. * @type {number} * @memberof DepartmentsApiDepartmentsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof DepartmentsApiDepartmentsList */ readonly offset?: number; } /** * Request parameters for departmentsRetrieve operation in DepartmentsApi. * @export * @interface DepartmentsApiDepartmentsRetrieveRequest */ export interface DepartmentsApiDepartmentsRetrieveRequest { /** * A unique value identifying this learning resource department. * @type {string} * @memberof DepartmentsApiDepartmentsRetrieve */ readonly department_id: string; } /** * DepartmentsApi - object-oriented interface * @export * @class DepartmentsApi * @extends {BaseAPI} */ export declare class DepartmentsApi extends BaseAPI { /** * MIT academic departments * @summary List * @param {DepartmentsApiDepartmentsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DepartmentsApi */ departmentsList(requestParameters?: DepartmentsApiDepartmentsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * MIT academic departments * @summary Retrieve * @param {DepartmentsApiDepartmentsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DepartmentsApi */ departmentsRetrieve(requestParameters: DepartmentsApiDepartmentsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * FeaturedApi - axios parameter creator * @export */ export declare const FeaturedApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of featured resources * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: FeaturedListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single featured resource * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * FeaturedApi - functional programming interface * @export */ export declare const FeaturedApiFp: (configuration?: Configuration) => { /** * Get a paginated list of featured resources * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: FeaturedListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single featured resource * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FeaturedApi - factory interface * @export */ export declare const FeaturedApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of featured resources * @summary List * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredList(requestParameters?: FeaturedApiFeaturedListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single featured resource * @summary Retrieve * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ featuredRetrieve(requestParameters: FeaturedApiFeaturedRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for featuredList operation in FeaturedApi. * @export * @interface FeaturedApiFeaturedListRequest */ export interface FeaturedApiFeaturedListRequest { /** * * @type {boolean} * @memberof FeaturedApiFeaturedList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof FeaturedApiFeaturedList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof FeaturedApiFeaturedList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof FeaturedApiFeaturedList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof FeaturedApiFeaturedList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof FeaturedApiFeaturedList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof FeaturedApiFeaturedList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof FeaturedApiFeaturedList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof FeaturedApiFeaturedList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof FeaturedApiFeaturedList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof FeaturedApiFeaturedList */ readonly platform?: Array; /** * * @type {boolean} * @memberof FeaturedApiFeaturedList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof FeaturedApiFeaturedList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof FeaturedApiFeaturedList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof FeaturedApiFeaturedList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof FeaturedApiFeaturedList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof FeaturedApiFeaturedList */ readonly sortby?: FeaturedListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof FeaturedApiFeaturedList */ readonly topic?: Array; } /** * Request parameters for featuredRetrieve operation in FeaturedApi. * @export * @interface FeaturedApiFeaturedRetrieveRequest */ export interface FeaturedApiFeaturedRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof FeaturedApiFeaturedRetrieve */ readonly id: number; } /** * FeaturedApi - object-oriented interface * @export * @class FeaturedApi * @extends {BaseAPI} */ export declare class FeaturedApi extends BaseAPI { /** * Get a paginated list of featured resources * @summary List * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeaturedApi */ featuredList(requestParameters?: FeaturedApiFeaturedListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single featured resource * @summary Retrieve * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeaturedApi */ featuredRetrieve(requestParameters: FeaturedApiFeaturedRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const FeaturedListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type FeaturedListCertificationTypeEnum = typeof FeaturedListCertificationTypeEnum[keyof typeof FeaturedListCertificationTypeEnum]; /** * @export */ export declare const FeaturedListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type FeaturedListDeliveryEnum = typeof FeaturedListDeliveryEnum[keyof typeof FeaturedListDeliveryEnum]; /** * @export */ export declare const FeaturedListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type FeaturedListDepartmentEnum = typeof FeaturedListDepartmentEnum[keyof typeof FeaturedListDepartmentEnum]; /** * @export */ export declare const FeaturedListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type FeaturedListLevelEnum = typeof FeaturedListLevelEnum[keyof typeof FeaturedListLevelEnum]; /** * @export */ export declare const FeaturedListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type FeaturedListOfferedByEnum = typeof FeaturedListOfferedByEnum[keyof typeof FeaturedListOfferedByEnum]; /** * @export */ export declare const FeaturedListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type FeaturedListPlatformEnum = typeof FeaturedListPlatformEnum[keyof typeof FeaturedListPlatformEnum]; /** * @export */ export declare const FeaturedListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type FeaturedListResourceTypeEnum = typeof FeaturedListResourceTypeEnum[keyof typeof FeaturedListResourceTypeEnum]; /** * @export */ export declare const FeaturedListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type FeaturedListResourceTypeGroupEnum = typeof FeaturedListResourceTypeGroupEnum[keyof typeof FeaturedListResourceTypeGroupEnum]; /** * @export */ export declare const FeaturedListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type FeaturedListSortbyEnum = typeof FeaturedListSortbyEnum[keyof typeof FeaturedListSortbyEnum]; /** * HubspotApi - axios parameter creator * @export */ export declare const HubspotApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get one HubSpot form by id from the backend. * @param {string} form_id * @param {boolean} [archived] * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsDetailRetrieve: (form_id: string, archived?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * List HubSpot forms from the backend. * @param {string} [after] * @param {boolean} [archived] * @param {Array} [form_types] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsList: (after?: string, archived?: boolean, form_types?: Array, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Submit a form to HubSpot. * @param {string} form_id * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsSubmit: (form_id: string, HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * HubspotApi - functional programming interface * @export */ export declare const HubspotApiFp: (configuration?: Configuration) => { /** * Get one HubSpot form by id from the backend. * @param {string} form_id * @param {boolean} [archived] * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsDetailRetrieve(form_id: string, archived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List HubSpot forms from the backend. * @param {string} [after] * @param {boolean} [archived] * @param {Array} [form_types] * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsList(after?: string, archived?: boolean, form_types?: Array, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submit a form to HubSpot. * @param {string} form_id * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsSubmit(form_id: string, HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HubspotApi - factory interface * @export */ export declare const HubspotApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get one HubSpot form by id from the backend. * @param {HubspotApiHubspotFormsDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsDetailRetrieve(requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * List HubSpot forms from the backend. * @param {HubspotApiHubspotFormsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsList(requestParameters?: HubspotApiHubspotFormsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submit a form to HubSpot. * @param {HubspotApiHubspotFormsSubmitRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ hubspotFormsSubmit(requestParameters: HubspotApiHubspotFormsSubmitRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for hubspotFormsDetailRetrieve operation in HubspotApi. * @export * @interface HubspotApiHubspotFormsDetailRetrieveRequest */ export interface HubspotApiHubspotFormsDetailRetrieveRequest { /** * * @type {string} * @memberof HubspotApiHubspotFormsDetailRetrieve */ readonly form_id: string; /** * * @type {boolean} * @memberof HubspotApiHubspotFormsDetailRetrieve */ readonly archived?: boolean; } /** * Request parameters for hubspotFormsList operation in HubspotApi. * @export * @interface HubspotApiHubspotFormsListRequest */ export interface HubspotApiHubspotFormsListRequest { /** * * @type {string} * @memberof HubspotApiHubspotFormsList */ readonly after?: string; /** * * @type {boolean} * @memberof HubspotApiHubspotFormsList */ readonly archived?: boolean; /** * * @type {Array} * @memberof HubspotApiHubspotFormsList */ readonly form_types?: Array; /** * * @type {number} * @memberof HubspotApiHubspotFormsList */ readonly limit?: number; } /** * Request parameters for hubspotFormsSubmit operation in HubspotApi. * @export * @interface HubspotApiHubspotFormsSubmitRequest */ export interface HubspotApiHubspotFormsSubmitRequest { /** * * @type {string} * @memberof HubspotApiHubspotFormsSubmit */ readonly form_id: string; /** * * @type {HubspotFormSubmitRequestRequest} * @memberof HubspotApiHubspotFormsSubmit */ readonly HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest; } /** * HubspotApi - object-oriented interface * @export * @class HubspotApi * @extends {BaseAPI} */ export declare class HubspotApi extends BaseAPI { /** * Get one HubSpot form by id from the backend. * @param {HubspotApiHubspotFormsDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HubspotApi */ hubspotFormsDetailRetrieve(requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * List HubSpot forms from the backend. * @param {HubspotApiHubspotFormsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HubspotApi */ hubspotFormsList(requestParameters?: HubspotApiHubspotFormsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Submit a form to HubSpot. * @param {HubspotApiHubspotFormsSubmitRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HubspotApi */ hubspotFormsSubmit(requestParameters: HubspotApiHubspotFormsSubmitRequest, options?: RawAxiosRequestConfig): Promise>; } /** * LearningResourceDisplayInfoApi - axios parameter creator * @export */ export declare const LearningResourceDisplayInfoApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of learning resource display info * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourceDisplayInfoListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve display info for a learning resource. * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * LearningResourceDisplayInfoApi - functional programming interface * @export */ export declare const LearningResourceDisplayInfoApiFp: (configuration?: Configuration) => { /** * Get a paginated list of learning resource display info * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourceDisplayInfoListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve display info for a learning resource. * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LearningResourceDisplayInfoApi - factory interface * @export */ export declare const LearningResourceDisplayInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of learning resource display info * @summary List * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoList(requestParameters?: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve display info for a learning resource. * @summary Retrieve * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourceDisplayInfoRetrieve(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for learningResourceDisplayInfoList operation in LearningResourceDisplayInfoApi. * @export * @interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest */ export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest { /** * * @type {boolean} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly sortby?: LearningResourceDisplayInfoListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList */ readonly topic?: Array; } /** * Request parameters for learningResourceDisplayInfoRetrieve operation in LearningResourceDisplayInfoApi. * @export * @interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest */ export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieve */ readonly id: number; } /** * LearningResourceDisplayInfoApi - object-oriented interface * @export * @class LearningResourceDisplayInfoApi * @extends {BaseAPI} */ export declare class LearningResourceDisplayInfoApi extends BaseAPI { /** * Get a paginated list of learning resource display info * @summary List * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourceDisplayInfoApi */ learningResourceDisplayInfoList(requestParameters?: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve display info for a learning resource. * @summary Retrieve * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourceDisplayInfoApi */ learningResourceDisplayInfoRetrieve(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LearningResourceDisplayInfoListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type LearningResourceDisplayInfoListCertificationTypeEnum = typeof LearningResourceDisplayInfoListCertificationTypeEnum[keyof typeof LearningResourceDisplayInfoListCertificationTypeEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourceDisplayInfoListDeliveryEnum = typeof LearningResourceDisplayInfoListDeliveryEnum[keyof typeof LearningResourceDisplayInfoListDeliveryEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourceDisplayInfoListDepartmentEnum = typeof LearningResourceDisplayInfoListDepartmentEnum[keyof typeof LearningResourceDisplayInfoListDepartmentEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type LearningResourceDisplayInfoListLevelEnum = typeof LearningResourceDisplayInfoListLevelEnum[keyof typeof LearningResourceDisplayInfoListLevelEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type LearningResourceDisplayInfoListOfferedByEnum = typeof LearningResourceDisplayInfoListOfferedByEnum[keyof typeof LearningResourceDisplayInfoListOfferedByEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type LearningResourceDisplayInfoListPlatformEnum = typeof LearningResourceDisplayInfoListPlatformEnum[keyof typeof LearningResourceDisplayInfoListPlatformEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type LearningResourceDisplayInfoListResourceTypeEnum = typeof LearningResourceDisplayInfoListResourceTypeEnum[keyof typeof LearningResourceDisplayInfoListResourceTypeEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type LearningResourceDisplayInfoListResourceTypeGroupEnum = typeof LearningResourceDisplayInfoListResourceTypeGroupEnum[keyof typeof LearningResourceDisplayInfoListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourceDisplayInfoListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type LearningResourceDisplayInfoListSortbyEnum = typeof LearningResourceDisplayInfoListSortbyEnum[keyof typeof LearningResourceDisplayInfoListSortbyEnum]; /** * LearningResourcesApi - axios parameter creator * @export */ export declare const LearningResourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesList: (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsList: (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Set Learning Path Relationships on a given Learning Resource. * @summary Set Learning Path Relationships * @param {number} id id of the learning resource * @param {Array} [learning_path_id] id of the parent learning path * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesLearningPathsPartialUpdate: (id: number, learning_path_id?: Array, PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of learning resources. * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single learning resource. * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources * @param {number} id * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [free] * @param {Array} [level] * @param {number} [limit] * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSimilarList: (id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of learning resources with summary fields * @summary Get learning resources summary * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSummaryList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesSummaryListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Set User List Relationships on a given Learning Resource. * @summary Set User List Relationships * @param {number} id id of the learning resource * @param {Array} [userlist_id] id of the parent user list * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserlistsPartialUpdate: (id: number, userlist_id?: Array, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig) => Promise; /** * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources using vector embeddings * @param {number} id * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [free] * @param {Array} [level] * @param {number} [limit] * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesVectorSimilarList: (id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * LearningResourcesApi - functional programming interface * @export */ export declare const LearningResourcesApiFp: (configuration?: Configuration) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {number} learning_resource_id id of the parent learning resource * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array} [edx_module_id] The edx module id of the content file * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {Array} [resource_id] The id of the learning resource the content file belongs to * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {number} id A unique integer value identifying this contentfile. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set Learning Path Relationships on a given Learning Resource. * @summary Set Learning Path Relationships * @param {number} id id of the learning resource * @param {Array} [learning_path_id] id of the parent learning path * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesLearningPathsPartialUpdate(id: number, learning_path_id?: Array, PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get a paginated list of learning resources. * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single learning resource. * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources * @param {number} id * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [free] * @param {Array} [level] * @param {number} [limit] * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSimilarList(id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Get a paginated list of learning resources with summary fields * @summary Get learning resources summary * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSummaryList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesSummaryListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set User List Relationships on a given Learning Resource. * @summary Set User List Relationships * @param {number} id id of the learning resource * @param {Array} [userlist_id] id of the parent user list * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserlistsPartialUpdate(id: number, userlist_id?: Array, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources using vector embeddings * @param {number} id * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [free] * @param {Array} [level] * @param {number} [limit] * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesVectorSimilarList(id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * LearningResourcesApi - factory interface * @export */ export declare const LearningResourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesList(requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesContentfilesRetrieve(requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsList(requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesItemsRetrieve(requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set Learning Path Relationships on a given Learning Resource. * @summary Set Learning Path Relationships * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesLearningPathsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Get a paginated list of learning resources. * @summary List * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesList(requestParameters?: LearningResourcesApiLearningResourcesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single learning resource. * @summary Retrieve * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesRetrieve(requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSimilarList(requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Get a paginated list of learning resources with summary fields * @summary Get learning resources summary * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSummaryList(requestParameters?: LearningResourcesApiLearningResourcesSummaryListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set User List Relationships on a given Learning Resource. * @summary Set User List Relationships * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserlistsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources using vector embeddings * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesVectorSimilarList(requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for learningResourcesContentfilesList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesContentfilesListRequest */ export interface LearningResourcesApiLearningResourcesContentfilesListRequest { /** * id of the parent learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly learning_resource_id: number; /** * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly content_feature_type?: Array; /** * The edx module id of the content file * @type {Array} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly edx_module_id?: Array; /** * Number of results to return per page. * @type {number} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly limit?: number; /** * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly offset?: number; /** * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly platform?: Array; /** * The id of the learning resource the content file belongs to * @type {Array} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly resource_id?: Array; /** * The id of the learning resource run the content file belongs to * @type {Array} * @memberof LearningResourcesApiLearningResourcesContentfilesList */ readonly run_id?: Array; } /** * Request parameters for learningResourcesContentfilesRetrieve operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest */ export interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest { /** * A unique integer value identifying this contentfile. * @type {number} * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for learningResourcesItemsList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesItemsListRequest */ export interface LearningResourcesApiLearningResourcesItemsListRequest { /** * id of the parent learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesItemsList */ readonly learning_resource_id: number; /** * Number of results to return per page. * @type {number} * @memberof LearningResourcesApiLearningResourcesItemsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof LearningResourcesApiLearningResourcesItemsList */ readonly offset?: number; /** * Which field to use when ordering the results. * @type {string} * @memberof LearningResourcesApiLearningResourcesItemsList */ readonly sortby?: string; } /** * Request parameters for learningResourcesItemsRetrieve operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesItemsRetrieveRequest */ export interface LearningResourcesApiLearningResourcesItemsRetrieveRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof LearningResourcesApiLearningResourcesItemsRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesItemsRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for learningResourcesLearningPathsPartialUpdate operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest */ export interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest { /** * id of the learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate */ readonly id: number; /** * id of the parent learning path * @type {Array} * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate */ readonly learning_path_id?: Array; /** * * @type {PatchedLearningResourceRelationshipRequest} * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate */ readonly PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest; } /** * Request parameters for learningResourcesList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesListRequest */ export interface LearningResourcesApiLearningResourcesListRequest { /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof LearningResourcesApiLearningResourcesList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof LearningResourcesApiLearningResourcesList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof LearningResourcesApiLearningResourcesList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof LearningResourcesApiLearningResourcesList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof LearningResourcesApiLearningResourcesList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof LearningResourcesApiLearningResourcesList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof LearningResourcesApiLearningResourcesList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof LearningResourcesApiLearningResourcesList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof LearningResourcesApiLearningResourcesList */ readonly sortby?: LearningResourcesListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof LearningResourcesApiLearningResourcesList */ readonly topic?: Array; } /** * Request parameters for learningResourcesRetrieve operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesRetrieveRequest */ export interface LearningResourcesApiLearningResourcesRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof LearningResourcesApiLearningResourcesRetrieve */ readonly id: number; } /** * Request parameters for learningResourcesSimilarList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesSimilarListRequest */ export interface LearningResourcesApiLearningResourcesSimilarListRequest { /** * * @type {number} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly id: number; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly certification_type?: Array; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly department?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly free?: boolean | null; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly level?: Array; /** * * @type {number} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly limit?: number; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly offered_by?: Array; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly professional?: boolean | null; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly resource_type?: Array; /** * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly resource_type_group?: Array; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesApiLearningResourcesSimilarList */ readonly topic?: Array; } /** * Request parameters for learningResourcesSummaryList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesSummaryListRequest */ export interface LearningResourcesApiLearningResourcesSummaryListRequest { /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly sortby?: LearningResourcesSummaryListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof LearningResourcesApiLearningResourcesSummaryList */ readonly topic?: Array; } /** * Request parameters for learningResourcesUserlistsPartialUpdate operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest */ export interface LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest { /** * id of the learning resource * @type {number} * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate */ readonly id: number; /** * id of the parent user list * @type {Array} * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate */ readonly userlist_id?: Array; /** * * @type {PatchedUserListRelationshipRequest} * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate */ readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest; } /** * Request parameters for learningResourcesVectorSimilarList operation in LearningResourcesApi. * @export * @interface LearningResourcesApiLearningResourcesVectorSimilarListRequest */ export interface LearningResourcesApiLearningResourcesVectorSimilarListRequest { /** * * @type {number} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly id: number; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly certification_type?: Array; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly department?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly free?: boolean | null; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly level?: Array; /** * * @type {number} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly limit?: number; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly offered_by?: Array; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly professional?: boolean | null; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly resource_type?: Array; /** * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly resource_type_group?: Array; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesApiLearningResourcesVectorSimilarList */ readonly topic?: Array; } /** * LearningResourcesApi - object-oriented interface * @export * @class LearningResourcesApi * @extends {BaseAPI} */ export declare class LearningResourcesApi extends BaseAPI { /** * Show content files for a learning resource * @summary Learning Resource Content File List * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesContentfilesList(requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Show content files for a learning resource * @summary Learning Resource Content File Retrieve * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesContentfilesRetrieve(requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesItemsList(requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesItemsRetrieve(requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Set Learning Path Relationships on a given Learning Resource. * @summary Set Learning Path Relationships * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesLearningPathsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of learning resources. * @summary List * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesList(requestParameters?: LearningResourcesApiLearningResourcesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single learning resource. * @summary Retrieve * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesRetrieve(requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesSimilarList(requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of learning resources with summary fields * @summary Get learning resources summary * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesSummaryList(requestParameters?: LearningResourcesApiLearningResourcesSummaryListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Set User List Relationships on a given Learning Resource. * @summary Set User List Relationships * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesUserlistsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter * @summary Get similar resources using vector embeddings * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesApi */ learningResourcesVectorSimilarList(requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LearningResourcesContentfilesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type LearningResourcesContentfilesListOfferedByEnum = typeof LearningResourcesContentfilesListOfferedByEnum[keyof typeof LearningResourcesContentfilesListOfferedByEnum]; /** * @export */ export declare const LearningResourcesContentfilesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type LearningResourcesContentfilesListPlatformEnum = typeof LearningResourcesContentfilesListPlatformEnum[keyof typeof LearningResourcesContentfilesListPlatformEnum]; /** * @export */ export declare const LearningResourcesListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type LearningResourcesListCertificationTypeEnum = typeof LearningResourcesListCertificationTypeEnum[keyof typeof LearningResourcesListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesListDeliveryEnum = typeof LearningResourcesListDeliveryEnum[keyof typeof LearningResourcesListDeliveryEnum]; /** * @export */ export declare const LearningResourcesListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesListDepartmentEnum = typeof LearningResourcesListDepartmentEnum[keyof typeof LearningResourcesListDepartmentEnum]; /** * @export */ export declare const LearningResourcesListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type LearningResourcesListLevelEnum = typeof LearningResourcesListLevelEnum[keyof typeof LearningResourcesListLevelEnum]; /** * @export */ export declare const LearningResourcesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type LearningResourcesListOfferedByEnum = typeof LearningResourcesListOfferedByEnum[keyof typeof LearningResourcesListOfferedByEnum]; /** * @export */ export declare const LearningResourcesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type LearningResourcesListPlatformEnum = typeof LearningResourcesListPlatformEnum[keyof typeof LearningResourcesListPlatformEnum]; /** * @export */ export declare const LearningResourcesListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type LearningResourcesListResourceTypeEnum = typeof LearningResourcesListResourceTypeEnum[keyof typeof LearningResourcesListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type LearningResourcesListResourceTypeGroupEnum = typeof LearningResourcesListResourceTypeGroupEnum[keyof typeof LearningResourcesListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type LearningResourcesListSortbyEnum = typeof LearningResourcesListSortbyEnum[keyof typeof LearningResourcesListSortbyEnum]; /** * @export */ export declare const LearningResourcesSimilarListCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesSimilarListCertificationTypeEnum = typeof LearningResourcesSimilarListCertificationTypeEnum[keyof typeof LearningResourcesSimilarListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesSimilarListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesSimilarListDeliveryEnum = typeof LearningResourcesSimilarListDeliveryEnum[keyof typeof LearningResourcesSimilarListDeliveryEnum]; /** * @export */ export declare const LearningResourcesSimilarListDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesSimilarListDepartmentEnum = typeof LearningResourcesSimilarListDepartmentEnum[keyof typeof LearningResourcesSimilarListDepartmentEnum]; /** * @export */ export declare const LearningResourcesSimilarListLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesSimilarListLevelEnum = typeof LearningResourcesSimilarListLevelEnum[keyof typeof LearningResourcesSimilarListLevelEnum]; /** * @export */ export declare const LearningResourcesSimilarListOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesSimilarListOfferedByEnum = typeof LearningResourcesSimilarListOfferedByEnum[keyof typeof LearningResourcesSimilarListOfferedByEnum]; /** * @export */ export declare const LearningResourcesSimilarListPlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesSimilarListPlatformEnum = typeof LearningResourcesSimilarListPlatformEnum[keyof typeof LearningResourcesSimilarListPlatformEnum]; /** * @export */ export declare const LearningResourcesSimilarListResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesSimilarListResourceTypeEnum = typeof LearningResourcesSimilarListResourceTypeEnum[keyof typeof LearningResourcesSimilarListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesSimilarListResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesSimilarListResourceTypeGroupEnum = typeof LearningResourcesSimilarListResourceTypeGroupEnum[keyof typeof LearningResourcesSimilarListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesSummaryListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type LearningResourcesSummaryListCertificationTypeEnum = typeof LearningResourcesSummaryListCertificationTypeEnum[keyof typeof LearningResourcesSummaryListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesSummaryListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesSummaryListDeliveryEnum = typeof LearningResourcesSummaryListDeliveryEnum[keyof typeof LearningResourcesSummaryListDeliveryEnum]; /** * @export */ export declare const LearningResourcesSummaryListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesSummaryListDepartmentEnum = typeof LearningResourcesSummaryListDepartmentEnum[keyof typeof LearningResourcesSummaryListDepartmentEnum]; /** * @export */ export declare const LearningResourcesSummaryListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type LearningResourcesSummaryListLevelEnum = typeof LearningResourcesSummaryListLevelEnum[keyof typeof LearningResourcesSummaryListLevelEnum]; /** * @export */ export declare const LearningResourcesSummaryListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type LearningResourcesSummaryListOfferedByEnum = typeof LearningResourcesSummaryListOfferedByEnum[keyof typeof LearningResourcesSummaryListOfferedByEnum]; /** * @export */ export declare const LearningResourcesSummaryListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type LearningResourcesSummaryListPlatformEnum = typeof LearningResourcesSummaryListPlatformEnum[keyof typeof LearningResourcesSummaryListPlatformEnum]; /** * @export */ export declare const LearningResourcesSummaryListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type LearningResourcesSummaryListResourceTypeEnum = typeof LearningResourcesSummaryListResourceTypeEnum[keyof typeof LearningResourcesSummaryListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesSummaryListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type LearningResourcesSummaryListResourceTypeGroupEnum = typeof LearningResourcesSummaryListResourceTypeGroupEnum[keyof typeof LearningResourcesSummaryListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesSummaryListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type LearningResourcesSummaryListSortbyEnum = typeof LearningResourcesSummaryListSortbyEnum[keyof typeof LearningResourcesSummaryListSortbyEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesVectorSimilarListCertificationTypeEnum = typeof LearningResourcesVectorSimilarListCertificationTypeEnum[keyof typeof LearningResourcesVectorSimilarListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesVectorSimilarListDeliveryEnum = typeof LearningResourcesVectorSimilarListDeliveryEnum[keyof typeof LearningResourcesVectorSimilarListDeliveryEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesVectorSimilarListDepartmentEnum = typeof LearningResourcesVectorSimilarListDepartmentEnum[keyof typeof LearningResourcesVectorSimilarListDepartmentEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesVectorSimilarListLevelEnum = typeof LearningResourcesVectorSimilarListLevelEnum[keyof typeof LearningResourcesVectorSimilarListLevelEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesVectorSimilarListOfferedByEnum = typeof LearningResourcesVectorSimilarListOfferedByEnum[keyof typeof LearningResourcesVectorSimilarListOfferedByEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListPlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesVectorSimilarListPlatformEnum = typeof LearningResourcesVectorSimilarListPlatformEnum[keyof typeof LearningResourcesVectorSimilarListPlatformEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesVectorSimilarListResourceTypeEnum = typeof LearningResourcesVectorSimilarListResourceTypeEnum[keyof typeof LearningResourcesVectorSimilarListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesVectorSimilarListResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesVectorSimilarListResourceTypeGroupEnum = typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum[keyof typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum]; /** * LearningResourcesSearchApi - axios parameter creator * @export */ export declare const LearningResourcesSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Search for learning resources * @summary Search * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchRetrieve: (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesSearchRetrieveSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig) => Promise; }; /** * LearningResourcesSearchApi - functional programming interface * @export */ export declare const LearningResourcesSearchApiFp: (configuration?: Configuration) => { /** * Search for learning resources * @summary Search * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchRetrieve(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesSearchRetrieveSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LearningResourcesSearchApi - factory interface * @export */ export declare const LearningResourcesSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Search for learning resources * @summary Search * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchRetrieve(requestParameters?: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for learningResourcesSearchRetrieve operation in LearningResourcesSearchApi. * @export * @interface LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest */ export interface LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest { /** * Show resource counts by category * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly aggregations?: Array; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly certification_type?: Array; /** * Score weight for content file data. 1 is the default. 0 means content files are ignored * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly content_file_score_weight?: number | null; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly department?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly dev_mode?: boolean | null; /** * * @type {boolean} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly free?: boolean | null; /** * The id value for the learning resource * @type {Array} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly id?: Array; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly level?: Array; /** * Number of results to return per page * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly limit?: number; /** * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly max_incompleteness_penalty?: number | null; /** * Minimum score value a text query result needs to have to be displayed * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly min_score?: number | null; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly offset?: number; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly professional?: boolean | null; /** * The search text * @type {string} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly q?: string; /** * The resource category for the resource * @type {Array} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly resource_category?: Array; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly resource_type?: Array; /** * * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly resource_type_group?: Array; /** * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly search_mode?: LearningResourcesSearchRetrieveSearchModeEnum; /** * Whether to include select OCW content files in search results. * @type {boolean} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly show_ocw_files?: boolean | null; /** * Allowed distance for phrase search * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly slop?: number | null; /** * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly sortby?: LearningResourcesSearchRetrieveSortbyEnum; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly topic?: Array; /** * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve */ readonly yearly_decay_percent?: number | null; } /** * LearningResourcesSearchApi - object-oriented interface * @export * @class LearningResourcesSearchApi * @extends {BaseAPI} */ export declare class LearningResourcesSearchApi extends BaseAPI { /** * Search for learning resources * @summary Search * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesSearchApi */ learningResourcesSearchRetrieve(requestParameters?: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LearningResourcesSearchRetrieveAggregationsEnum: { readonly ResourceType: "resource_type"; readonly Certification: "certification"; readonly CertificationType: "certification_type"; readonly OfferedBy: "offered_by"; readonly Platform: "platform"; readonly Topic: "topic"; readonly Department: "department"; readonly Level: "level"; readonly CourseFeature: "course_feature"; readonly Professional: "professional"; readonly Free: "free"; readonly Delivery: "delivery"; readonly ResourceTypeGroup: "resource_type_group"; readonly ResourceCategory: "resource_category"; }; export type LearningResourcesSearchRetrieveAggregationsEnum = typeof LearningResourcesSearchRetrieveAggregationsEnum[keyof typeof LearningResourcesSearchRetrieveAggregationsEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesSearchRetrieveCertificationTypeEnum = typeof LearningResourcesSearchRetrieveCertificationTypeEnum[keyof typeof LearningResourcesSearchRetrieveCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesSearchRetrieveDeliveryEnum = typeof LearningResourcesSearchRetrieveDeliveryEnum[keyof typeof LearningResourcesSearchRetrieveDeliveryEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesSearchRetrieveDepartmentEnum = typeof LearningResourcesSearchRetrieveDepartmentEnum[keyof typeof LearningResourcesSearchRetrieveDepartmentEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesSearchRetrieveLevelEnum = typeof LearningResourcesSearchRetrieveLevelEnum[keyof typeof LearningResourcesSearchRetrieveLevelEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesSearchRetrieveOfferedByEnum = typeof LearningResourcesSearchRetrieveOfferedByEnum[keyof typeof LearningResourcesSearchRetrieveOfferedByEnum]; /** * @export */ export declare const LearningResourcesSearchRetrievePlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesSearchRetrievePlatformEnum = typeof LearningResourcesSearchRetrievePlatformEnum[keyof typeof LearningResourcesSearchRetrievePlatformEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesSearchRetrieveResourceTypeEnum = typeof LearningResourcesSearchRetrieveResourceTypeEnum[keyof typeof LearningResourcesSearchRetrieveResourceTypeEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesSearchRetrieveResourceTypeGroupEnum = typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum[keyof typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveSearchModeEnum: { readonly Phrase: "phrase"; readonly BestFields: "best_fields"; readonly MostFields: "most_fields"; readonly Hybrid: "hybrid"; }; export type LearningResourcesSearchRetrieveSearchModeEnum = typeof LearningResourcesSearchRetrieveSearchModeEnum[keyof typeof LearningResourcesSearchRetrieveSearchModeEnum]; /** * @export */ export declare const LearningResourcesSearchRetrieveSortbyEnum: { readonly Featured: "featured"; readonly Id: "id"; readonly Id2: "-id"; readonly ReadableId: "readable_id"; readonly ReadableId2: "-readable_id"; readonly LastModified: "last_modified"; readonly LastModified2: "-last_modified"; readonly New: "new"; readonly StartDate: "start_date"; readonly StartDate2: "-start_date"; readonly Mitcoursenumber: "mitcoursenumber"; readonly Mitcoursenumber2: "-mitcoursenumber"; readonly Views: "views"; readonly Views2: "-views"; readonly Upcoming: "upcoming"; }; export type LearningResourcesSearchRetrieveSortbyEnum = typeof LearningResourcesSearchRetrieveSortbyEnum[keyof typeof LearningResourcesSearchRetrieveSortbyEnum]; /** * LearningResourcesUserSubscriptionApi - axios parameter creator * @export */ export declare const LearningResourcesUserSubscriptionApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for listing percolate query subscriptions for a user * @summary Check if a user is subscribed to a specific query * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionCheckList: (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig) => Promise; /** * View for listing percolate query subscriptions for a user * @summary List subscribed queries * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionList: (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionListSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig) => Promise; /** * Subscribe a user to query * @summary Subscribe user to query * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionSubscribeCreate: (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, options?: RawAxiosRequestConfig) => Promise; /** * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query * @summary Unsubscribe user from query * @param {number} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionUnsubscribeDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * LearningResourcesUserSubscriptionApi - functional programming interface * @export */ export declare const LearningResourcesUserSubscriptionApiFp: (configuration?: Configuration) => { /** * View for listing percolate query subscriptions for a user * @summary Check if a user is subscribed to a specific query * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionCheckList(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * View for listing percolate query subscriptions for a user * @summary List subscribed queries * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionList(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionListSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Subscribe a user to query * @summary Subscribe user to query * @param {Array} [aggregations] Show resource counts by category * @param {boolean | null} [certification] True if the learning resource offers a certificate * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations * @param {boolean | null} [free] * @param {Array} [id] The id value for the learning resource * @param {Array} [level] * @param {number} [limit] Number of results to return per page * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed * @param {Array} [ocw_topic] The ocw topic name. * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean | null} [professional] * @param {string} [q] The search text * @param {Array} [resource_category] The resource category for the resource * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @param {Array} [resource_type_group] * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. * @param {number | null} [slop] Allowed distance for phrase search * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionSubscribeCreate(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query * @summary Unsubscribe user from query * @param {number} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionUnsubscribeDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LearningResourcesUserSubscriptionApi - factory interface * @export */ export declare const LearningResourcesUserSubscriptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for listing percolate query subscriptions for a user * @summary Check if a user is subscribed to a specific query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionCheckList(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * View for listing percolate query subscriptions for a user * @summary List subscribed queries * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionList(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Subscribe a user to query * @summary Subscribe user to query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionSubscribeCreate(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query * @summary Unsubscribe user from query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for learningResourcesUserSubscriptionCheckList operation in LearningResourcesUserSubscriptionApi. * @export * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest */ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest { /** * Show resource counts by category * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly aggregations?: Array; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly certification_type?: Array; /** * Score weight for content file data. 1 is the default. 0 means content files are ignored * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly content_file_score_weight?: number | null; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly department?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly dev_mode?: boolean | null; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly free?: boolean | null; /** * The id value for the learning resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly id?: Array; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly level?: Array; /** * Number of results to return per page * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly limit?: number; /** * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly max_incompleteness_penalty?: number | null; /** * Minimum score value a text query result needs to have to be displayed * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly min_score?: number | null; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly offset?: number; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly professional?: boolean | null; /** * The search text * @type {string} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly q?: string; /** * The resource category for the resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly resource_category?: Array; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly resource_type?: Array; /** * * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly resource_type_group?: Array; /** * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum; /** * Whether to include select OCW content files in search results. * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly show_ocw_files?: boolean | null; /** * Allowed distance for phrase search * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly slop?: number | null; /** * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum; /** * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @type {'search_subscription_type' | 'channel_subscription_type'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly topic?: Array; /** * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList */ readonly yearly_decay_percent?: number | null; } /** * Request parameters for learningResourcesUserSubscriptionList operation in LearningResourcesUserSubscriptionApi. * @export * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest */ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest { /** * Show resource counts by category * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly aggregations?: Array; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly certification_type?: Array; /** * Score weight for content file data. 1 is the default. 0 means content files are ignored * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly content_file_score_weight?: number | null; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly department?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly dev_mode?: boolean | null; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly free?: boolean | null; /** * The id value for the learning resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly id?: Array; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly level?: Array; /** * Number of results to return per page * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly limit?: number; /** * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly max_incompleteness_penalty?: number | null; /** * Minimum score value a text query result needs to have to be displayed * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly min_score?: number | null; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly offset?: number; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly professional?: boolean | null; /** * The search text * @type {string} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly q?: string; /** * The resource category for the resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly resource_category?: Array; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly resource_type?: Array; /** * * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly resource_type_group?: Array; /** * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum; /** * Whether to include select OCW content files in search results. * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly show_ocw_files?: boolean | null; /** * Allowed distance for phrase search * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly slop?: number | null; /** * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly sortby?: LearningResourcesUserSubscriptionListSortbyEnum; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly topic?: Array; /** * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList */ readonly yearly_decay_percent?: number | null; } /** * Request parameters for learningResourcesUserSubscriptionSubscribeCreate operation in LearningResourcesUserSubscriptionApi. * @export * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest */ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest { /** * Show resource counts by category * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly aggregations?: Array; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly certification?: boolean | null; /** * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly certification_type?: Array; /** * Score weight for content file data. 1 is the default. 0 means content files are ignored * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly content_file_score_weight?: number | null; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly course_feature?: Array; /** * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly delivery?: Array; /** * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly department?: Array; /** * If true return raw open search results with score explanations * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly dev_mode?: boolean | null; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly free?: boolean | null; /** * The id value for the learning resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly id?: Array; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly level?: Array; /** * Number of results to return per page * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly limit?: number; /** * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly max_incompleteness_penalty?: number | null; /** * Minimum score value a text query result needs to have to be displayed * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly min_score?: number | null; /** * The ocw topic name. * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly ocw_topic?: Array; /** * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly offset?: number; /** * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly professional?: boolean | null; /** * The search text * @type {string} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly q?: string; /** * The resource category for the resource * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly resource_category?: Array; /** * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly resource_type?: Array; /** * * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly resource_type_group?: Array; /** * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum; /** * Whether to include select OCW content files in search results. * @type {boolean} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly show_ocw_files?: boolean | null; /** * Allowed distance for phrase search * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly slop?: number | null; /** * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum; /** * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type * @type {'search_subscription_type' | 'channel_subscription_type'} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly topic?: Array; /** * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly yearly_decay_percent?: number | null; /** * * @type {PercolateQuerySubscriptionRequestRequest} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate */ readonly PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest; } /** * Request parameters for learningResourcesUserSubscriptionUnsubscribeDestroy operation in LearningResourcesUserSubscriptionApi. * @export * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest */ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest { /** * * @type {number} * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroy */ readonly id: number; } /** * LearningResourcesUserSubscriptionApi - object-oriented interface * @export * @class LearningResourcesUserSubscriptionApi * @extends {BaseAPI} */ export declare class LearningResourcesUserSubscriptionApi extends BaseAPI { /** * View for listing percolate query subscriptions for a user * @summary Check if a user is subscribed to a specific query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesUserSubscriptionApi */ learningResourcesUserSubscriptionCheckList(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for listing percolate query subscriptions for a user * @summary List subscribed queries * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesUserSubscriptionApi */ learningResourcesUserSubscriptionList(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Subscribe a user to query * @summary Subscribe user to query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesUserSubscriptionApi */ learningResourcesUserSubscriptionSubscribeCreate(requestParameters?: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query * @summary Unsubscribe user from query * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesUserSubscriptionApi */ learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListAggregationsEnum: { readonly ResourceType: "resource_type"; readonly Certification: "certification"; readonly CertificationType: "certification_type"; readonly OfferedBy: "offered_by"; readonly Platform: "platform"; readonly Topic: "topic"; readonly Department: "department"; readonly Level: "level"; readonly CourseFeature: "course_feature"; readonly Professional: "professional"; readonly Free: "free"; readonly Delivery: "delivery"; readonly ResourceTypeGroup: "resource_type_group"; readonly ResourceCategory: "resource_category"; }; export type LearningResourcesUserSubscriptionCheckListAggregationsEnum = typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesUserSubscriptionCheckListCertificationTypeEnum = typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesUserSubscriptionCheckListDeliveryEnum = typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesUserSubscriptionCheckListDepartmentEnum = typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesUserSubscriptionCheckListLevelEnum = typeof LearningResourcesUserSubscriptionCheckListLevelEnum[keyof typeof LearningResourcesUserSubscriptionCheckListLevelEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesUserSubscriptionCheckListOfferedByEnum = typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListPlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesUserSubscriptionCheckListPlatformEnum = typeof LearningResourcesUserSubscriptionCheckListPlatformEnum[keyof typeof LearningResourcesUserSubscriptionCheckListPlatformEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesUserSubscriptionCheckListResourceTypeEnum = typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListSearchModeEnum: { readonly Phrase: "phrase"; readonly BestFields: "best_fields"; readonly MostFields: "most_fields"; readonly Hybrid: "hybrid"; }; export type LearningResourcesUserSubscriptionCheckListSearchModeEnum = typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListSortbyEnum: { readonly Featured: "featured"; readonly Id: "id"; readonly Id2: "-id"; readonly ReadableId: "readable_id"; readonly ReadableId2: "-readable_id"; readonly LastModified: "last_modified"; readonly LastModified2: "-last_modified"; readonly New: "new"; readonly StartDate: "start_date"; readonly StartDate2: "-start_date"; readonly Mitcoursenumber: "mitcoursenumber"; readonly Mitcoursenumber2: "-mitcoursenumber"; readonly Views: "views"; readonly Views2: "-views"; readonly Upcoming: "upcoming"; }; export type LearningResourcesUserSubscriptionCheckListSortbyEnum = typeof LearningResourcesUserSubscriptionCheckListSortbyEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSortbyEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionCheckListSourceTypeEnum: { readonly SearchSubscriptionType: "search_subscription_type"; readonly ChannelSubscriptionType: "channel_subscription_type"; }; export type LearningResourcesUserSubscriptionCheckListSourceTypeEnum = typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListAggregationsEnum: { readonly ResourceType: "resource_type"; readonly Certification: "certification"; readonly CertificationType: "certification_type"; readonly OfferedBy: "offered_by"; readonly Platform: "platform"; readonly Topic: "topic"; readonly Department: "department"; readonly Level: "level"; readonly CourseFeature: "course_feature"; readonly Professional: "professional"; readonly Free: "free"; readonly Delivery: "delivery"; readonly ResourceTypeGroup: "resource_type_group"; readonly ResourceCategory: "resource_category"; }; export type LearningResourcesUserSubscriptionListAggregationsEnum = typeof LearningResourcesUserSubscriptionListAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionListAggregationsEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesUserSubscriptionListCertificationTypeEnum = typeof LearningResourcesUserSubscriptionListCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionListCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesUserSubscriptionListDeliveryEnum = typeof LearningResourcesUserSubscriptionListDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionListDeliveryEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesUserSubscriptionListDepartmentEnum = typeof LearningResourcesUserSubscriptionListDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionListDepartmentEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesUserSubscriptionListLevelEnum = typeof LearningResourcesUserSubscriptionListLevelEnum[keyof typeof LearningResourcesUserSubscriptionListLevelEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesUserSubscriptionListOfferedByEnum = typeof LearningResourcesUserSubscriptionListOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionListOfferedByEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListPlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesUserSubscriptionListPlatformEnum = typeof LearningResourcesUserSubscriptionListPlatformEnum[keyof typeof LearningResourcesUserSubscriptionListPlatformEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesUserSubscriptionListResourceTypeEnum = typeof LearningResourcesUserSubscriptionListResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionListResourceTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesUserSubscriptionListResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListSearchModeEnum: { readonly Phrase: "phrase"; readonly BestFields: "best_fields"; readonly MostFields: "most_fields"; readonly Hybrid: "hybrid"; }; export type LearningResourcesUserSubscriptionListSearchModeEnum = typeof LearningResourcesUserSubscriptionListSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionListSearchModeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionListSortbyEnum: { readonly Featured: "featured"; readonly Id: "id"; readonly Id2: "-id"; readonly ReadableId: "readable_id"; readonly ReadableId2: "-readable_id"; readonly LastModified: "last_modified"; readonly LastModified2: "-last_modified"; readonly New: "new"; readonly StartDate: "start_date"; readonly StartDate2: "-start_date"; readonly Mitcoursenumber: "mitcoursenumber"; readonly Mitcoursenumber2: "-mitcoursenumber"; readonly Views: "views"; readonly Views2: "-views"; readonly Upcoming: "upcoming"; }; export type LearningResourcesUserSubscriptionListSortbyEnum = typeof LearningResourcesUserSubscriptionListSortbyEnum[keyof typeof LearningResourcesUserSubscriptionListSortbyEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum: { readonly ResourceType: "resource_type"; readonly Certification: "certification"; readonly CertificationType: "certification_type"; readonly OfferedBy: "offered_by"; readonly Platform: "platform"; readonly Topic: "topic"; readonly Department: "department"; readonly Level: "level"; readonly CourseFeature: "course_feature"; readonly Professional: "professional"; readonly Free: "free"; readonly Delivery: "delivery"; readonly ResourceTypeGroup: "resource_type_group"; readonly ResourceCategory: "resource_category"; }; export type LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum: { readonly _1: "1"; readonly _2: "2"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type LearningResourcesUserSubscriptionSubscribeCreateLevelEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum: { readonly Edx: "edx"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Mitxonline: "mitxonline"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Csail: "csail"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Scc: "scc"; readonly Ctl: "ctl"; readonly Whu: "whu"; readonly Susskind: "susskind"; readonly Globalalumni: "globalalumni"; readonly Simplilearn: "simplilearn"; readonly Emeritus: "emeritus"; readonly Podcast: "podcast"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Ovs: "ovs"; }; export type LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum = typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; readonly Document: "document"; }; export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum: { readonly Phrase: "phrase"; readonly BestFields: "best_fields"; readonly MostFields: "most_fields"; readonly Hybrid: "hybrid"; }; export type LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum: { readonly Featured: "featured"; readonly Id: "id"; readonly Id2: "-id"; readonly ReadableId: "readable_id"; readonly ReadableId2: "-readable_id"; readonly LastModified: "last_modified"; readonly LastModified2: "-last_modified"; readonly New: "new"; readonly StartDate: "start_date"; readonly StartDate2: "-start_date"; readonly Mitcoursenumber: "mitcoursenumber"; readonly Mitcoursenumber2: "-mitcoursenumber"; readonly Views: "views"; readonly Views2: "-views"; readonly Upcoming: "upcoming"; }; export type LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum]; /** * @export */ export declare const LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum: { readonly SearchSubscriptionType: "search_subscription_type"; readonly ChannelSubscriptionType: "channel_subscription_type"; }; export type LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum]; /** * LearningpathsApi - axios parameter creator * @export */ export declare const LearningpathsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a learning path * @summary Create * @param {LearningPathResourceRequest} LearningPathResourceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsCreate: (LearningPathResourceRequest: LearningPathResourceRequest, options?: RawAxiosRequestConfig) => Promise; /** * Remove a learning path * @summary Destroy * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Add * @param {number} learning_resource_id The learning resource id of the learning path * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsCreate: (learning_resource_id: number, LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Remove * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsDestroy: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for LearningPath related resources * @param {number} learning_resource_id The learning resource id of the learning path * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsList: (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Update * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsPartialUpdate: (id: number, learning_resource_id: number, PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of learning paths * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningpathsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of all learning path items * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsMembershipList: (options?: RawAxiosRequestConfig) => Promise; /** * Update individual fields of a learning path * @summary Update * @param {number} id A unique integer value identifying this learning resource. * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsPartialUpdate: (id: number, PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrive a single learning path * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * LearningpathsApi - functional programming interface * @export */ export declare const LearningpathsApiFp: (configuration?: Configuration) => { /** * Create a learning path * @summary Create * @param {LearningPathResourceRequest} LearningPathResourceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsCreate(LearningPathResourceRequest: LearningPathResourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove a learning path * @summary Destroy * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Add * @param {number} learning_resource_id The learning resource id of the learning path * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsCreate(learning_resource_id: number, LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Remove * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsDestroy(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for LearningPath related resources * @param {number} learning_resource_id The learning resource id of the learning path * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Update * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsPartialUpdate(id: number, learning_resource_id: number, PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id The learning resource id of the learning path * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of learning paths * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningpathsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all learning path items * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsMembershipList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Update individual fields of a learning path * @summary Update * @param {number} id A unique integer value identifying this learning resource. * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsPartialUpdate(id: number, PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrive a single learning path * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LearningpathsApi - factory interface * @export */ export declare const LearningpathsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a learning path * @summary Create * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsCreate(requestParameters: LearningpathsApiLearningpathsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove a learning path * @summary Destroy * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsDestroy(requestParameters: LearningpathsApiLearningpathsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Add * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsCreate(requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Remove * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsDestroy(requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for LearningPath related resources * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsList(requestParameters: LearningpathsApiLearningpathsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Update * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsPartialUpdate(requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsItemsRetrieve(requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of learning paths * @summary List * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsList(requestParameters?: LearningpathsApiLearningpathsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a list of all learning path items * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsMembershipList(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Update individual fields of a learning path * @summary Update * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsPartialUpdate(requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrive a single learning path * @summary Retrieve * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningpathsRetrieve(requestParameters: LearningpathsApiLearningpathsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for learningpathsCreate operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsCreateRequest */ export interface LearningpathsApiLearningpathsCreateRequest { /** * * @type {LearningPathResourceRequest} * @memberof LearningpathsApiLearningpathsCreate */ readonly LearningPathResourceRequest: LearningPathResourceRequest; } /** * Request parameters for learningpathsDestroy operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsDestroyRequest */ export interface LearningpathsApiLearningpathsDestroyRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof LearningpathsApiLearningpathsDestroy */ readonly id: number; } /** * Request parameters for learningpathsItemsCreate operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsItemsCreateRequest */ export interface LearningpathsApiLearningpathsItemsCreateRequest { /** * The learning resource id of the learning path * @type {number} * @memberof LearningpathsApiLearningpathsItemsCreate */ readonly learning_resource_id: number; /** * * @type {LearningPathRelationshipCreateRequest} * @memberof LearningpathsApiLearningpathsItemsCreate */ readonly LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest; } /** * Request parameters for learningpathsItemsDestroy operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsItemsDestroyRequest */ export interface LearningpathsApiLearningpathsItemsDestroyRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof LearningpathsApiLearningpathsItemsDestroy */ readonly id: number; /** * The learning resource id of the learning path * @type {number} * @memberof LearningpathsApiLearningpathsItemsDestroy */ readonly learning_resource_id: number; } /** * Request parameters for learningpathsItemsList operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsItemsListRequest */ export interface LearningpathsApiLearningpathsItemsListRequest { /** * The learning resource id of the learning path * @type {number} * @memberof LearningpathsApiLearningpathsItemsList */ readonly learning_resource_id: number; /** * Number of results to return per page. * @type {number} * @memberof LearningpathsApiLearningpathsItemsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof LearningpathsApiLearningpathsItemsList */ readonly offset?: number; /** * Which field to use when ordering the results. * @type {string} * @memberof LearningpathsApiLearningpathsItemsList */ readonly sortby?: string; } /** * Request parameters for learningpathsItemsPartialUpdate operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsItemsPartialUpdateRequest */ export interface LearningpathsApiLearningpathsItemsPartialUpdateRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof LearningpathsApiLearningpathsItemsPartialUpdate */ readonly id: number; /** * The learning resource id of the learning path * @type {number} * @memberof LearningpathsApiLearningpathsItemsPartialUpdate */ readonly learning_resource_id: number; /** * * @type {PatchedLearningPathRelationshipCreateRequest} * @memberof LearningpathsApiLearningpathsItemsPartialUpdate */ readonly PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest; } /** * Request parameters for learningpathsItemsRetrieve operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsItemsRetrieveRequest */ export interface LearningpathsApiLearningpathsItemsRetrieveRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof LearningpathsApiLearningpathsItemsRetrieve */ readonly id: number; /** * The learning resource id of the learning path * @type {number} * @memberof LearningpathsApiLearningpathsItemsRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for learningpathsList operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsListRequest */ export interface LearningpathsApiLearningpathsListRequest { /** * * @type {boolean} * @memberof LearningpathsApiLearningpathsList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof LearningpathsApiLearningpathsList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof LearningpathsApiLearningpathsList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof LearningpathsApiLearningpathsList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof LearningpathsApiLearningpathsList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof LearningpathsApiLearningpathsList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof LearningpathsApiLearningpathsList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof LearningpathsApiLearningpathsList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof LearningpathsApiLearningpathsList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof LearningpathsApiLearningpathsList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof LearningpathsApiLearningpathsList */ readonly platform?: Array; /** * * @type {boolean} * @memberof LearningpathsApiLearningpathsList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof LearningpathsApiLearningpathsList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof LearningpathsApiLearningpathsList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof LearningpathsApiLearningpathsList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof LearningpathsApiLearningpathsList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof LearningpathsApiLearningpathsList */ readonly sortby?: LearningpathsListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof LearningpathsApiLearningpathsList */ readonly topic?: Array; } /** * Request parameters for learningpathsPartialUpdate operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsPartialUpdateRequest */ export interface LearningpathsApiLearningpathsPartialUpdateRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof LearningpathsApiLearningpathsPartialUpdate */ readonly id: number; /** * * @type {PatchedLearningPathResourceRequest} * @memberof LearningpathsApiLearningpathsPartialUpdate */ readonly PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest; } /** * Request parameters for learningpathsRetrieve operation in LearningpathsApi. * @export * @interface LearningpathsApiLearningpathsRetrieveRequest */ export interface LearningpathsApiLearningpathsRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof LearningpathsApiLearningpathsRetrieve */ readonly id: number; } /** * LearningpathsApi - object-oriented interface * @export * @class LearningpathsApi * @extends {BaseAPI} */ export declare class LearningpathsApi extends BaseAPI { /** * Create a learning path * @summary Create * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsCreate(requestParameters: LearningpathsApiLearningpathsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Remove a learning path * @summary Destroy * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsDestroy(requestParameters: LearningpathsApiLearningpathsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Add * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsItemsCreate(requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Remove * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsItemsDestroy(requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for LearningPath related resources * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsItemsList(requestParameters: LearningpathsApiLearningpathsItemsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for LearningPath related resources * @summary Learning Path Resource Relationship Update * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsItemsPartialUpdate(requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsItemsRetrieve(requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of learning paths * @summary List * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsList(requestParameters?: LearningpathsApiLearningpathsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a list of all learning path items * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsMembershipList(options?: RawAxiosRequestConfig): Promise>; /** * Update individual fields of a learning path * @summary Update * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsPartialUpdate(requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrive a single learning path * @summary Retrieve * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningpathsApi */ learningpathsRetrieve(requestParameters: LearningpathsApiLearningpathsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const LearningpathsListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type LearningpathsListCertificationTypeEnum = typeof LearningpathsListCertificationTypeEnum[keyof typeof LearningpathsListCertificationTypeEnum]; /** * @export */ export declare const LearningpathsListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type LearningpathsListDeliveryEnum = typeof LearningpathsListDeliveryEnum[keyof typeof LearningpathsListDeliveryEnum]; /** * @export */ export declare const LearningpathsListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type LearningpathsListDepartmentEnum = typeof LearningpathsListDepartmentEnum[keyof typeof LearningpathsListDepartmentEnum]; /** * @export */ export declare const LearningpathsListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type LearningpathsListLevelEnum = typeof LearningpathsListLevelEnum[keyof typeof LearningpathsListLevelEnum]; /** * @export */ export declare const LearningpathsListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type LearningpathsListOfferedByEnum = typeof LearningpathsListOfferedByEnum[keyof typeof LearningpathsListOfferedByEnum]; /** * @export */ export declare const LearningpathsListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type LearningpathsListPlatformEnum = typeof LearningpathsListPlatformEnum[keyof typeof LearningpathsListPlatformEnum]; /** * @export */ export declare const LearningpathsListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type LearningpathsListResourceTypeEnum = typeof LearningpathsListResourceTypeEnum[keyof typeof LearningpathsListResourceTypeEnum]; /** * @export */ export declare const LearningpathsListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type LearningpathsListResourceTypeGroupEnum = typeof LearningpathsListResourceTypeGroupEnum[keyof typeof LearningpathsListResourceTypeGroupEnum]; /** * @export */ export declare const LearningpathsListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type LearningpathsListSortbyEnum = typeof LearningpathsListSortbyEnum[keyof typeof LearningpathsListSortbyEnum]; /** * MediaApi - axios parameter creator * @export */ export declare const MediaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Upload an image (multipart/form-data) and return the storage URL. * @param {File} image_file * @param {*} [options] Override http request option. * @throws {RequiredError} */ mediaUpload: (image_file: File, options?: RawAxiosRequestConfig) => Promise; }; /** * MediaApi - functional programming interface * @export */ export declare const MediaApiFp: (configuration?: Configuration) => { /** * Upload an image (multipart/form-data) and return the storage URL. * @param {File} image_file * @param {*} [options] Override http request option. * @throws {RequiredError} */ mediaUpload(image_file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MediaApi - factory interface * @export */ export declare const MediaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Upload an image (multipart/form-data) and return the storage URL. * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ mediaUpload(requestParameters: MediaApiMediaUploadRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for mediaUpload operation in MediaApi. * @export * @interface MediaApiMediaUploadRequest */ export interface MediaApiMediaUploadRequest { /** * * @type {File} * @memberof MediaApiMediaUpload */ readonly image_file: File; } /** * MediaApi - object-oriented interface * @export * @class MediaApi * @extends {BaseAPI} */ export declare class MediaApi extends BaseAPI { /** * Upload an image (multipart/form-data) and return the storage URL. * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MediaApi */ mediaUpload(requestParameters: MediaApiMediaUploadRequest, options?: RawAxiosRequestConfig): Promise>; } /** * OfferorsApi - axios parameter creator * @export */ export declare const OfferorsApiAxiosParamCreator: (configuration?: Configuration) => { /** * MIT organizations that offer learning resources * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * MIT organizations that offer learning resources * @summary Retrieve * @param {string} code A unique value identifying this learning resource offeror. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsRetrieve: (code: string, options?: RawAxiosRequestConfig) => Promise; }; /** * OfferorsApi - functional programming interface * @export */ export declare const OfferorsApiFp: (configuration?: Configuration) => { /** * MIT organizations that offer learning resources * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * MIT organizations that offer learning resources * @summary Retrieve * @param {string} code A unique value identifying this learning resource offeror. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsRetrieve(code: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OfferorsApi - factory interface * @export */ export declare const OfferorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * MIT organizations that offer learning resources * @summary List * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsList(requestParameters?: OfferorsApiOfferorsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * MIT organizations that offer learning resources * @summary Retrieve * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ offerorsRetrieve(requestParameters: OfferorsApiOfferorsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for offerorsList operation in OfferorsApi. * @export * @interface OfferorsApiOfferorsListRequest */ export interface OfferorsApiOfferorsListRequest { /** * Number of results to return per page. * @type {number} * @memberof OfferorsApiOfferorsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof OfferorsApiOfferorsList */ readonly offset?: number; } /** * Request parameters for offerorsRetrieve operation in OfferorsApi. * @export * @interface OfferorsApiOfferorsRetrieveRequest */ export interface OfferorsApiOfferorsRetrieveRequest { /** * A unique value identifying this learning resource offeror. * @type {string} * @memberof OfferorsApiOfferorsRetrieve */ readonly code: string; } /** * OfferorsApi - object-oriented interface * @export * @class OfferorsApi * @extends {BaseAPI} */ export declare class OfferorsApi extends BaseAPI { /** * MIT organizations that offer learning resources * @summary List * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OfferorsApi */ offerorsList(requestParameters?: OfferorsApiOfferorsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * MIT organizations that offer learning resources * @summary Retrieve * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OfferorsApi */ offerorsRetrieve(requestParameters: OfferorsApiOfferorsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * PlatformsApi - axios parameter creator * @export */ export declare const PlatformsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Platforms on which learning resources are hosted * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Platforms on which learning resources are hosted * @summary Retrieve * @param {string} code A unique value identifying this learning resource platform. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsRetrieve: (code: string, options?: RawAxiosRequestConfig) => Promise; }; /** * PlatformsApi - functional programming interface * @export */ export declare const PlatformsApiFp: (configuration?: Configuration) => { /** * Platforms on which learning resources are hosted * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Platforms on which learning resources are hosted * @summary Retrieve * @param {string} code A unique value identifying this learning resource platform. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsRetrieve(code: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PlatformsApi - factory interface * @export */ export declare const PlatformsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Platforms on which learning resources are hosted * @summary List * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsList(requestParameters?: PlatformsApiPlatformsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Platforms on which learning resources are hosted * @summary Retrieve * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ platformsRetrieve(requestParameters: PlatformsApiPlatformsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for platformsList operation in PlatformsApi. * @export * @interface PlatformsApiPlatformsListRequest */ export interface PlatformsApiPlatformsListRequest { /** * Number of results to return per page. * @type {number} * @memberof PlatformsApiPlatformsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof PlatformsApiPlatformsList */ readonly offset?: number; } /** * Request parameters for platformsRetrieve operation in PlatformsApi. * @export * @interface PlatformsApiPlatformsRetrieveRequest */ export interface PlatformsApiPlatformsRetrieveRequest { /** * A unique value identifying this learning resource platform. * @type {string} * @memberof PlatformsApiPlatformsRetrieve */ readonly code: string; } /** * PlatformsApi - object-oriented interface * @export * @class PlatformsApi * @extends {BaseAPI} */ export declare class PlatformsApi extends BaseAPI { /** * Platforms on which learning resources are hosted * @summary List * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlatformsApi */ platformsList(requestParameters?: PlatformsApiPlatformsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Platforms on which learning resources are hosted * @summary Retrieve * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlatformsApi */ platformsRetrieve(requestParameters: PlatformsApiPlatformsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * PodcastEpisodesApi - axios parameter creator * @export */ export declare const PodcastEpisodesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of podcast episodes * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastEpisodesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single podcast episode * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * PodcastEpisodesApi - functional programming interface * @export */ export declare const PodcastEpisodesApiFp: (configuration?: Configuration) => { /** * Get a paginated list of podcast episodes * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastEpisodesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single podcast episode * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PodcastEpisodesApi - factory interface * @export */ export declare const PodcastEpisodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of podcast episodes * @summary List * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesList(requestParameters?: PodcastEpisodesApiPodcastEpisodesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single podcast episode * @summary Retrieve * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastEpisodesRetrieve(requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for podcastEpisodesList operation in PodcastEpisodesApi. * @export * @interface PodcastEpisodesApiPodcastEpisodesListRequest */ export interface PodcastEpisodesApiPodcastEpisodesListRequest { /** * * @type {boolean} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly platform?: Array; /** * * @type {boolean} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly sortby?: PodcastEpisodesListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof PodcastEpisodesApiPodcastEpisodesList */ readonly topic?: Array; } /** * Request parameters for podcastEpisodesRetrieve operation in PodcastEpisodesApi. * @export * @interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest */ export interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof PodcastEpisodesApiPodcastEpisodesRetrieve */ readonly id: number; } /** * PodcastEpisodesApi - object-oriented interface * @export * @class PodcastEpisodesApi * @extends {BaseAPI} */ export declare class PodcastEpisodesApi extends BaseAPI { /** * Get a paginated list of podcast episodes * @summary List * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastEpisodesApi */ podcastEpisodesList(requestParameters?: PodcastEpisodesApiPodcastEpisodesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single podcast episode * @summary Retrieve * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastEpisodesApi */ podcastEpisodesRetrieve(requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const PodcastEpisodesListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type PodcastEpisodesListCertificationTypeEnum = typeof PodcastEpisodesListCertificationTypeEnum[keyof typeof PodcastEpisodesListCertificationTypeEnum]; /** * @export */ export declare const PodcastEpisodesListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type PodcastEpisodesListDeliveryEnum = typeof PodcastEpisodesListDeliveryEnum[keyof typeof PodcastEpisodesListDeliveryEnum]; /** * @export */ export declare const PodcastEpisodesListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type PodcastEpisodesListDepartmentEnum = typeof PodcastEpisodesListDepartmentEnum[keyof typeof PodcastEpisodesListDepartmentEnum]; /** * @export */ export declare const PodcastEpisodesListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type PodcastEpisodesListLevelEnum = typeof PodcastEpisodesListLevelEnum[keyof typeof PodcastEpisodesListLevelEnum]; /** * @export */ export declare const PodcastEpisodesListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type PodcastEpisodesListOfferedByEnum = typeof PodcastEpisodesListOfferedByEnum[keyof typeof PodcastEpisodesListOfferedByEnum]; /** * @export */ export declare const PodcastEpisodesListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type PodcastEpisodesListPlatformEnum = typeof PodcastEpisodesListPlatformEnum[keyof typeof PodcastEpisodesListPlatformEnum]; /** * @export */ export declare const PodcastEpisodesListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type PodcastEpisodesListResourceTypeEnum = typeof PodcastEpisodesListResourceTypeEnum[keyof typeof PodcastEpisodesListResourceTypeEnum]; /** * @export */ export declare const PodcastEpisodesListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type PodcastEpisodesListResourceTypeGroupEnum = typeof PodcastEpisodesListResourceTypeGroupEnum[keyof typeof PodcastEpisodesListResourceTypeGroupEnum]; /** * @export */ export declare const PodcastEpisodesListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type PodcastEpisodesListSortbyEnum = typeof PodcastEpisodesListSortbyEnum[keyof typeof PodcastEpisodesListSortbyEnum]; /** * PodcastsApi - axios parameter creator * @export */ export declare const PodcastsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsList: (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of podcasts * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single podcast * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * PodcastsApi - functional programming interface * @export */ export declare const PodcastsApiFp: (configuration?: Configuration) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of podcasts * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single podcast * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PodcastsApi - factory interface * @export */ export declare const PodcastsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsList(requestParameters: PodcastsApiPodcastsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsItemsRetrieve(requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of podcasts * @summary List * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsList(requestParameters?: PodcastsApiPodcastsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single podcast * @summary Retrieve * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ podcastsRetrieve(requestParameters: PodcastsApiPodcastsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for podcastsItemsList operation in PodcastsApi. * @export * @interface PodcastsApiPodcastsItemsListRequest */ export interface PodcastsApiPodcastsItemsListRequest { /** * id of the parent learning resource * @type {number} * @memberof PodcastsApiPodcastsItemsList */ readonly learning_resource_id: number; /** * Number of results to return per page. * @type {number} * @memberof PodcastsApiPodcastsItemsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof PodcastsApiPodcastsItemsList */ readonly offset?: number; /** * Which field to use when ordering the results. * @type {string} * @memberof PodcastsApiPodcastsItemsList */ readonly sortby?: string; } /** * Request parameters for podcastsItemsRetrieve operation in PodcastsApi. * @export * @interface PodcastsApiPodcastsItemsRetrieveRequest */ export interface PodcastsApiPodcastsItemsRetrieveRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof PodcastsApiPodcastsItemsRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof PodcastsApiPodcastsItemsRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for podcastsList operation in PodcastsApi. * @export * @interface PodcastsApiPodcastsListRequest */ export interface PodcastsApiPodcastsListRequest { /** * * @type {boolean} * @memberof PodcastsApiPodcastsList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof PodcastsApiPodcastsList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof PodcastsApiPodcastsList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof PodcastsApiPodcastsList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof PodcastsApiPodcastsList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof PodcastsApiPodcastsList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof PodcastsApiPodcastsList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof PodcastsApiPodcastsList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof PodcastsApiPodcastsList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof PodcastsApiPodcastsList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof PodcastsApiPodcastsList */ readonly platform?: Array; /** * * @type {boolean} * @memberof PodcastsApiPodcastsList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof PodcastsApiPodcastsList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof PodcastsApiPodcastsList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof PodcastsApiPodcastsList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof PodcastsApiPodcastsList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof PodcastsApiPodcastsList */ readonly sortby?: PodcastsListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof PodcastsApiPodcastsList */ readonly topic?: Array; } /** * Request parameters for podcastsRetrieve operation in PodcastsApi. * @export * @interface PodcastsApiPodcastsRetrieveRequest */ export interface PodcastsApiPodcastsRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof PodcastsApiPodcastsRetrieve */ readonly id: number; } /** * PodcastsApi - object-oriented interface * @export * @class PodcastsApi * @extends {BaseAPI} */ export declare class PodcastsApi extends BaseAPI { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastsApi */ podcastsItemsList(requestParameters: PodcastsApiPodcastsItemsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastsApi */ podcastsItemsRetrieve(requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of podcasts * @summary List * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastsApi */ podcastsList(requestParameters?: PodcastsApiPodcastsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single podcast * @summary Retrieve * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PodcastsApi */ podcastsRetrieve(requestParameters: PodcastsApiPodcastsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const PodcastsListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type PodcastsListCertificationTypeEnum = typeof PodcastsListCertificationTypeEnum[keyof typeof PodcastsListCertificationTypeEnum]; /** * @export */ export declare const PodcastsListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type PodcastsListDeliveryEnum = typeof PodcastsListDeliveryEnum[keyof typeof PodcastsListDeliveryEnum]; /** * @export */ export declare const PodcastsListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type PodcastsListDepartmentEnum = typeof PodcastsListDepartmentEnum[keyof typeof PodcastsListDepartmentEnum]; /** * @export */ export declare const PodcastsListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type PodcastsListLevelEnum = typeof PodcastsListLevelEnum[keyof typeof PodcastsListLevelEnum]; /** * @export */ export declare const PodcastsListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type PodcastsListOfferedByEnum = typeof PodcastsListOfferedByEnum[keyof typeof PodcastsListOfferedByEnum]; /** * @export */ export declare const PodcastsListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type PodcastsListPlatformEnum = typeof PodcastsListPlatformEnum[keyof typeof PodcastsListPlatformEnum]; /** * @export */ export declare const PodcastsListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type PodcastsListResourceTypeEnum = typeof PodcastsListResourceTypeEnum[keyof typeof PodcastsListResourceTypeEnum]; /** * @export */ export declare const PodcastsListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type PodcastsListResourceTypeGroupEnum = typeof PodcastsListResourceTypeGroupEnum[keyof typeof PodcastsListResourceTypeGroupEnum]; /** * @export */ export declare const PodcastsListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type PodcastsListSortbyEnum = typeof PodcastsListSortbyEnum[keyof typeof PodcastsListSortbyEnum]; /** * ProgramLettersApi - axios parameter creator * @export */ export declare const ProgramLettersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Detail only View for program letters * @param {string} id A UUID string identifying this program letter. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programLettersRetrieve: (id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ProgramLettersApi - functional programming interface * @export */ export declare const ProgramLettersApiFp: (configuration?: Configuration) => { /** * Detail only View for program letters * @param {string} id A UUID string identifying this program letter. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programLettersRetrieve(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProgramLettersApi - factory interface * @export */ export declare const ProgramLettersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Detail only View for program letters * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programLettersRetrieve(requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for programLettersRetrieve operation in ProgramLettersApi. * @export * @interface ProgramLettersApiProgramLettersRetrieveRequest */ export interface ProgramLettersApiProgramLettersRetrieveRequest { /** * A UUID string identifying this program letter. * @type {string} * @memberof ProgramLettersApiProgramLettersRetrieve */ readonly id: string; } /** * ProgramLettersApi - object-oriented interface * @export * @class ProgramLettersApi * @extends {BaseAPI} */ export declare class ProgramLettersApi extends BaseAPI { /** * Detail only View for program letters * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProgramLettersApi */ programLettersRetrieve(requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ProgramsApi - axios parameter creator * @export */ export declare const ProgramsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of programs * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: ProgramsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single program * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ProgramsApi - functional programming interface * @export */ export declare const ProgramsApiFp: (configuration?: Configuration) => { /** * Get a paginated list of programs * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: ProgramsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single program * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProgramsApi - factory interface * @export */ export declare const ProgramsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of programs * @summary List * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsList(requestParameters?: ProgramsApiProgramsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single program * @summary Retrieve * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programsRetrieve(requestParameters: ProgramsApiProgramsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for programsList operation in ProgramsApi. * @export * @interface ProgramsApiProgramsListRequest */ export interface ProgramsApiProgramsListRequest { /** * * @type {boolean} * @memberof ProgramsApiProgramsList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof ProgramsApiProgramsList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof ProgramsApiProgramsList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof ProgramsApiProgramsList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof ProgramsApiProgramsList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof ProgramsApiProgramsList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof ProgramsApiProgramsList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof ProgramsApiProgramsList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof ProgramsApiProgramsList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof ProgramsApiProgramsList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof ProgramsApiProgramsList */ readonly platform?: Array; /** * * @type {boolean} * @memberof ProgramsApiProgramsList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof ProgramsApiProgramsList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof ProgramsApiProgramsList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof ProgramsApiProgramsList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof ProgramsApiProgramsList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof ProgramsApiProgramsList */ readonly sortby?: ProgramsListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof ProgramsApiProgramsList */ readonly topic?: Array; } /** * Request parameters for programsRetrieve operation in ProgramsApi. * @export * @interface ProgramsApiProgramsRetrieveRequest */ export interface ProgramsApiProgramsRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof ProgramsApiProgramsRetrieve */ readonly id: number; } /** * ProgramsApi - object-oriented interface * @export * @class ProgramsApi * @extends {BaseAPI} */ export declare class ProgramsApi extends BaseAPI { /** * Get a paginated list of programs * @summary List * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProgramsApi */ programsList(requestParameters?: ProgramsApiProgramsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single program * @summary Retrieve * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProgramsApi */ programsRetrieve(requestParameters: ProgramsApiProgramsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ProgramsListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type ProgramsListCertificationTypeEnum = typeof ProgramsListCertificationTypeEnum[keyof typeof ProgramsListCertificationTypeEnum]; /** * @export */ export declare const ProgramsListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type ProgramsListDeliveryEnum = typeof ProgramsListDeliveryEnum[keyof typeof ProgramsListDeliveryEnum]; /** * @export */ export declare const ProgramsListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type ProgramsListDepartmentEnum = typeof ProgramsListDepartmentEnum[keyof typeof ProgramsListDepartmentEnum]; /** * @export */ export declare const ProgramsListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type ProgramsListLevelEnum = typeof ProgramsListLevelEnum[keyof typeof ProgramsListLevelEnum]; /** * @export */ export declare const ProgramsListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type ProgramsListOfferedByEnum = typeof ProgramsListOfferedByEnum[keyof typeof ProgramsListOfferedByEnum]; /** * @export */ export declare const ProgramsListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type ProgramsListPlatformEnum = typeof ProgramsListPlatformEnum[keyof typeof ProgramsListPlatformEnum]; /** * @export */ export declare const ProgramsListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type ProgramsListResourceTypeEnum = typeof ProgramsListResourceTypeEnum[keyof typeof ProgramsListResourceTypeEnum]; /** * @export */ export declare const ProgramsListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type ProgramsListResourceTypeGroupEnum = typeof ProgramsListResourceTypeGroupEnum[keyof typeof ProgramsListResourceTypeGroupEnum]; /** * @export */ export declare const ProgramsListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type ProgramsListSortbyEnum = typeof ProgramsListSortbyEnum[keyof typeof ProgramsListSortbyEnum]; /** * SchoolsApi - axios parameter creator * @export */ export declare const SchoolsApiAxiosParamCreator: (configuration?: Configuration) => { /** * MIT schools * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * MIT schools * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource school. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * SchoolsApi - functional programming interface * @export */ export declare const SchoolsApiFp: (configuration?: Configuration) => { /** * MIT schools * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * MIT schools * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource school. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SchoolsApi - factory interface * @export */ export declare const SchoolsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * MIT schools * @summary List * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsList(requestParameters?: SchoolsApiSchoolsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * MIT schools * @summary Retrieve * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ schoolsRetrieve(requestParameters: SchoolsApiSchoolsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for schoolsList operation in SchoolsApi. * @export * @interface SchoolsApiSchoolsListRequest */ export interface SchoolsApiSchoolsListRequest { /** * Number of results to return per page. * @type {number} * @memberof SchoolsApiSchoolsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof SchoolsApiSchoolsList */ readonly offset?: number; } /** * Request parameters for schoolsRetrieve operation in SchoolsApi. * @export * @interface SchoolsApiSchoolsRetrieveRequest */ export interface SchoolsApiSchoolsRetrieveRequest { /** * A unique integer value identifying this learning resource school. * @type {number} * @memberof SchoolsApiSchoolsRetrieve */ readonly id: number; } /** * SchoolsApi - object-oriented interface * @export * @class SchoolsApi * @extends {BaseAPI} */ export declare class SchoolsApi extends BaseAPI { /** * MIT schools * @summary List * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ schoolsList(requestParameters?: SchoolsApiSchoolsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * MIT schools * @summary Retrieve * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SchoolsApi */ schoolsRetrieve(requestParameters: SchoolsApiSchoolsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * TopicsApi - axios parameter creator * @export */ export declare const TopicsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Topics covered by learning resources * @summary List * @param {boolean} [is_toplevel] Filter top-level topics * @param {number} [limit] Number of results to return per page. * @param {Array} [name] Topic name * @param {number} [offset] The initial index from which to return the results. * @param {Array} [parent_topic_id] Parent topic ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsList: (is_toplevel?: boolean, limit?: number, name?: Array, offset?: number, parent_topic_id?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Topics covered by learning resources * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource topic. * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * TopicsApi - functional programming interface * @export */ export declare const TopicsApiFp: (configuration?: Configuration) => { /** * Topics covered by learning resources * @summary List * @param {boolean} [is_toplevel] Filter top-level topics * @param {number} [limit] Number of results to return per page. * @param {Array} [name] Topic name * @param {number} [offset] The initial index from which to return the results. * @param {Array} [parent_topic_id] Parent topic ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsList(is_toplevel?: boolean, limit?: number, name?: Array, offset?: number, parent_topic_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Topics covered by learning resources * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource topic. * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TopicsApi - factory interface * @export */ export declare const TopicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Topics covered by learning resources * @summary List * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsList(requestParameters?: TopicsApiTopicsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Topics covered by learning resources * @summary Retrieve * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ topicsRetrieve(requestParameters: TopicsApiTopicsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for topicsList operation in TopicsApi. * @export * @interface TopicsApiTopicsListRequest */ export interface TopicsApiTopicsListRequest { /** * Filter top-level topics * @type {boolean} * @memberof TopicsApiTopicsList */ readonly is_toplevel?: boolean; /** * Number of results to return per page. * @type {number} * @memberof TopicsApiTopicsList */ readonly limit?: number; /** * Topic name * @type {Array} * @memberof TopicsApiTopicsList */ readonly name?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof TopicsApiTopicsList */ readonly offset?: number; /** * Parent topic ID * @type {Array} * @memberof TopicsApiTopicsList */ readonly parent_topic_id?: Array; } /** * Request parameters for topicsRetrieve operation in TopicsApi. * @export * @interface TopicsApiTopicsRetrieveRequest */ export interface TopicsApiTopicsRetrieveRequest { /** * A unique integer value identifying this learning resource topic. * @type {number} * @memberof TopicsApiTopicsRetrieve */ readonly id: number; } /** * TopicsApi - object-oriented interface * @export * @class TopicsApi * @extends {BaseAPI} */ export declare class TopicsApi extends BaseAPI { /** * Topics covered by learning resources * @summary List * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TopicsApi */ topicsList(requestParameters?: TopicsApiTopicsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Topics covered by learning resources * @summary Retrieve * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TopicsApi */ topicsRetrieve(requestParameters: TopicsApiTopicsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * UserlistsApi - axios parameter creator * @export */ export declare const UserlistsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Viewset for UserLists * @summary Create * @param {UserListRequest} UserListRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsCreate: (UserListRequest: UserListRequest, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserLists * @summary Destroy * @param {number} id A unique integer value identifying this user list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Add * @param {number} userlist_id id of the parent user list * @param {UserListRelationshipRequest} UserListRelationshipRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsCreate: (userlist_id: number, UserListRelationshipRequest: UserListRelationshipRequest, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Remove * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsDestroy: (id: number, userlist_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserListRelationships * @summary User List Resources List * @param {number} userlist_id id of the parent user list * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsList: (userlist_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Update * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsPartialUpdate: (id: number, userlist_id: number, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserListRelationships * @summary User List Resources Retrieve * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsRetrieve: (id: number, userlist_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserLists * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsList: (limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of all userlist items for a user * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsMembershipList: (options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserLists * @summary Update * @param {number} id A unique integer value identifying this user list. * @param {PatchedUserListRequest} [PatchedUserListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsPartialUpdate: (id: number, PatchedUserListRequest?: PatchedUserListRequest, options?: RawAxiosRequestConfig) => Promise; /** * Viewset for UserLists * @summary Retrieve * @param {number} id A unique integer value identifying this user list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * UserlistsApi - functional programming interface * @export */ export declare const UserlistsApiFp: (configuration?: Configuration) => { /** * Viewset for UserLists * @summary Create * @param {UserListRequest} UserListRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsCreate(UserListRequest: UserListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserLists * @summary Destroy * @param {number} id A unique integer value identifying this user list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Add * @param {number} userlist_id id of the parent user list * @param {UserListRelationshipRequest} UserListRelationshipRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsCreate(userlist_id: number, UserListRelationshipRequest: UserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Remove * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsDestroy(id: number, userlist_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserListRelationships * @summary User List Resources List * @param {number} userlist_id id of the parent user list * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsList(userlist_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Update * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsPartialUpdate(id: number, userlist_id: number, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserListRelationships * @summary User List Resources Retrieve * @param {number} id A unique integer value identifying this user list relationship. * @param {number} userlist_id id of the parent user list * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsRetrieve(id: number, userlist_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserLists * @summary List * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of all userlist items for a user * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsMembershipList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Viewset for UserLists * @summary Update * @param {number} id A unique integer value identifying this user list. * @param {PatchedUserListRequest} [PatchedUserListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsPartialUpdate(id: number, PatchedUserListRequest?: PatchedUserListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Viewset for UserLists * @summary Retrieve * @param {number} id A unique integer value identifying this user list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserlistsApi - factory interface * @export */ export declare const UserlistsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Viewset for UserLists * @summary Create * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsCreate(requestParameters: UserlistsApiUserlistsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserLists * @summary Destroy * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsDestroy(requestParameters: UserlistsApiUserlistsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Add * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsCreate(requestParameters: UserlistsApiUserlistsItemsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Remove * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsDestroy(requestParameters: UserlistsApiUserlistsItemsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserListRelationships * @summary User List Resources List * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsList(requestParameters: UserlistsApiUserlistsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Update * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsPartialUpdate(requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserListRelationships * @summary User List Resources Retrieve * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsItemsRetrieve(requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserLists * @summary List * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsList(requestParameters?: UserlistsApiUserlistsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a list of all userlist items for a user * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsMembershipList(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Viewset for UserLists * @summary Update * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsPartialUpdate(requestParameters: UserlistsApiUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Viewset for UserLists * @summary Retrieve * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userlistsRetrieve(requestParameters: UserlistsApiUserlistsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for userlistsCreate operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsCreateRequest */ export interface UserlistsApiUserlistsCreateRequest { /** * * @type {UserListRequest} * @memberof UserlistsApiUserlistsCreate */ readonly UserListRequest: UserListRequest; } /** * Request parameters for userlistsDestroy operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsDestroyRequest */ export interface UserlistsApiUserlistsDestroyRequest { /** * A unique integer value identifying this user list. * @type {number} * @memberof UserlistsApiUserlistsDestroy */ readonly id: number; } /** * Request parameters for userlistsItemsCreate operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsItemsCreateRequest */ export interface UserlistsApiUserlistsItemsCreateRequest { /** * id of the parent user list * @type {number} * @memberof UserlistsApiUserlistsItemsCreate */ readonly userlist_id: number; /** * * @type {UserListRelationshipRequest} * @memberof UserlistsApiUserlistsItemsCreate */ readonly UserListRelationshipRequest: UserListRelationshipRequest; } /** * Request parameters for userlistsItemsDestroy operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsItemsDestroyRequest */ export interface UserlistsApiUserlistsItemsDestroyRequest { /** * A unique integer value identifying this user list relationship. * @type {number} * @memberof UserlistsApiUserlistsItemsDestroy */ readonly id: number; /** * id of the parent user list * @type {number} * @memberof UserlistsApiUserlistsItemsDestroy */ readonly userlist_id: number; } /** * Request parameters for userlistsItemsList operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsItemsListRequest */ export interface UserlistsApiUserlistsItemsListRequest { /** * id of the parent user list * @type {number} * @memberof UserlistsApiUserlistsItemsList */ readonly userlist_id: number; /** * Number of results to return per page. * @type {number} * @memberof UserlistsApiUserlistsItemsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof UserlistsApiUserlistsItemsList */ readonly offset?: number; } /** * Request parameters for userlistsItemsPartialUpdate operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsItemsPartialUpdateRequest */ export interface UserlistsApiUserlistsItemsPartialUpdateRequest { /** * A unique integer value identifying this user list relationship. * @type {number} * @memberof UserlistsApiUserlistsItemsPartialUpdate */ readonly id: number; /** * id of the parent user list * @type {number} * @memberof UserlistsApiUserlistsItemsPartialUpdate */ readonly userlist_id: number; /** * * @type {PatchedUserListRelationshipRequest} * @memberof UserlistsApiUserlistsItemsPartialUpdate */ readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest; } /** * Request parameters for userlistsItemsRetrieve operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsItemsRetrieveRequest */ export interface UserlistsApiUserlistsItemsRetrieveRequest { /** * A unique integer value identifying this user list relationship. * @type {number} * @memberof UserlistsApiUserlistsItemsRetrieve */ readonly id: number; /** * id of the parent user list * @type {number} * @memberof UserlistsApiUserlistsItemsRetrieve */ readonly userlist_id: number; } /** * Request parameters for userlistsList operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsListRequest */ export interface UserlistsApiUserlistsListRequest { /** * Number of results to return per page. * @type {number} * @memberof UserlistsApiUserlistsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof UserlistsApiUserlistsList */ readonly offset?: number; } /** * Request parameters for userlistsPartialUpdate operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsPartialUpdateRequest */ export interface UserlistsApiUserlistsPartialUpdateRequest { /** * A unique integer value identifying this user list. * @type {number} * @memberof UserlistsApiUserlistsPartialUpdate */ readonly id: number; /** * * @type {PatchedUserListRequest} * @memberof UserlistsApiUserlistsPartialUpdate */ readonly PatchedUserListRequest?: PatchedUserListRequest; } /** * Request parameters for userlistsRetrieve operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsRetrieveRequest */ export interface UserlistsApiUserlistsRetrieveRequest { /** * A unique integer value identifying this user list. * @type {number} * @memberof UserlistsApiUserlistsRetrieve */ readonly id: number; } /** * UserlistsApi - object-oriented interface * @export * @class UserlistsApi * @extends {BaseAPI} */ export declare class UserlistsApi extends BaseAPI { /** * Viewset for UserLists * @summary Create * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsCreate(requestParameters: UserlistsApiUserlistsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserLists * @summary Destroy * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsDestroy(requestParameters: UserlistsApiUserlistsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Add * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsItemsCreate(requestParameters: UserlistsApiUserlistsItemsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Remove * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsItemsDestroy(requestParameters: UserlistsApiUserlistsItemsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserListRelationships * @summary User List Resources List * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsItemsList(requestParameters: UserlistsApiUserlistsItemsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserListRelationships * @summary User List Resource Relationship Update * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsItemsPartialUpdate(requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserListRelationships * @summary User List Resources Retrieve * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsItemsRetrieve(requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserLists * @summary List * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsList(requestParameters?: UserlistsApiUserlistsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a list of all userlist items for a user * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsMembershipList(options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserLists * @summary Update * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsPartialUpdate(requestParameters: UserlistsApiUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Viewset for UserLists * @summary Retrieve * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserlistsApi */ userlistsRetrieve(requestParameters: UserlistsApiUserlistsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * VideoPlaylistsApi - axios parameter creator * @export */ export declare const VideoPlaylistsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsList: (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsRetrieve: (id: number, learning_resource_id: number, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of video playlists * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideoPlaylistsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single video playlist * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * VideoPlaylistsApi - functional programming interface * @export */ export declare const VideoPlaylistsApiFp: (configuration?: Configuration) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {number} learning_resource_id id of the parent learning resource * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {number} id A unique integer value identifying this learning resource relationship. * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of video playlists * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideoPlaylistsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single video playlist * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VideoPlaylistsApi - factory interface * @export */ export declare const VideoPlaylistsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsList(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsItemsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of video playlists * @summary List * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsList(requestParameters?: VideoPlaylistsApiVideoPlaylistsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single video playlist * @summary Retrieve * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videoPlaylistsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for videoPlaylistsItemsList operation in VideoPlaylistsApi. * @export * @interface VideoPlaylistsApiVideoPlaylistsItemsListRequest */ export interface VideoPlaylistsApiVideoPlaylistsItemsListRequest { /** * id of the parent learning resource * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsItemsList */ readonly learning_resource_id: number; /** * Number of results to return per page. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsItemsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsItemsList */ readonly offset?: number; /** * Which field to use when ordering the results. * @type {string} * @memberof VideoPlaylistsApiVideoPlaylistsItemsList */ readonly sortby?: string; } /** * Request parameters for videoPlaylistsItemsRetrieve operation in VideoPlaylistsApi. * @export * @interface VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest */ export interface VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest { /** * A unique integer value identifying this learning resource relationship. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve */ readonly id: number; /** * id of the parent learning resource * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve */ readonly learning_resource_id: number; } /** * Request parameters for videoPlaylistsList operation in VideoPlaylistsApi. * @export * @interface VideoPlaylistsApiVideoPlaylistsListRequest */ export interface VideoPlaylistsApiVideoPlaylistsListRequest { /** * * @type {boolean} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly platform?: Array; /** * * @type {boolean} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly sortby?: VideoPlaylistsListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof VideoPlaylistsApiVideoPlaylistsList */ readonly topic?: Array; } /** * Request parameters for videoPlaylistsRetrieve operation in VideoPlaylistsApi. * @export * @interface VideoPlaylistsApiVideoPlaylistsRetrieveRequest */ export interface VideoPlaylistsApiVideoPlaylistsRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof VideoPlaylistsApiVideoPlaylistsRetrieve */ readonly id: number; } /** * VideoPlaylistsApi - object-oriented interface * @export * @class VideoPlaylistsApi * @extends {BaseAPI} */ export declare class VideoPlaylistsApi extends BaseAPI { /** * Get a list of related learning resources for a learning resource. * @summary Nested Learning Resource List * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideoPlaylistsApi */ videoPlaylistsItemsList(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a singe related learning resource for a learning resource. * @summary Nested Learning Resource Retrieve * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideoPlaylistsApi */ videoPlaylistsItemsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of video playlists * @summary List * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideoPlaylistsApi */ videoPlaylistsList(requestParameters?: VideoPlaylistsApiVideoPlaylistsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single video playlist * @summary Retrieve * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideoPlaylistsApi */ videoPlaylistsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const VideoPlaylistsListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type VideoPlaylistsListCertificationTypeEnum = typeof VideoPlaylistsListCertificationTypeEnum[keyof typeof VideoPlaylistsListCertificationTypeEnum]; /** * @export */ export declare const VideoPlaylistsListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type VideoPlaylistsListDeliveryEnum = typeof VideoPlaylistsListDeliveryEnum[keyof typeof VideoPlaylistsListDeliveryEnum]; /** * @export */ export declare const VideoPlaylistsListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type VideoPlaylistsListDepartmentEnum = typeof VideoPlaylistsListDepartmentEnum[keyof typeof VideoPlaylistsListDepartmentEnum]; /** * @export */ export declare const VideoPlaylistsListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type VideoPlaylistsListLevelEnum = typeof VideoPlaylistsListLevelEnum[keyof typeof VideoPlaylistsListLevelEnum]; /** * @export */ export declare const VideoPlaylistsListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type VideoPlaylistsListOfferedByEnum = typeof VideoPlaylistsListOfferedByEnum[keyof typeof VideoPlaylistsListOfferedByEnum]; /** * @export */ export declare const VideoPlaylistsListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type VideoPlaylistsListPlatformEnum = typeof VideoPlaylistsListPlatformEnum[keyof typeof VideoPlaylistsListPlatformEnum]; /** * @export */ export declare const VideoPlaylistsListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type VideoPlaylistsListResourceTypeEnum = typeof VideoPlaylistsListResourceTypeEnum[keyof typeof VideoPlaylistsListResourceTypeEnum]; /** * @export */ export declare const VideoPlaylistsListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type VideoPlaylistsListResourceTypeGroupEnum = typeof VideoPlaylistsListResourceTypeGroupEnum[keyof typeof VideoPlaylistsListResourceTypeGroupEnum]; /** * @export */ export declare const VideoPlaylistsListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type VideoPlaylistsListSortbyEnum = typeof VideoPlaylistsListSortbyEnum[keyof typeof VideoPlaylistsListSortbyEnum]; /** * VideosApi - axios parameter creator * @export */ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of videos * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosList: (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideosListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single video * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * VideosApi - functional programming interface * @export */ export declare const VideosApiFp: (configuration?: Configuration) => { /** * Get a paginated list of videos * @summary List * @param {boolean} [certification] * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @param {boolean} [free] The course/program is offered for free * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @param {number} [limit] Number of results to return per page. * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @param {number} [offset] The initial index from which to return the results. * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @param {boolean} [professional] * @param {Array} [readable_id] A unique text identifier for the resources * @param {Array} [resource_id] Comma-separated list of learning resource IDs * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideosListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single video * @summary Retrieve * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VideosApi - factory interface * @export */ export declare const VideosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of videos * @summary List * @param {VideosApiVideosListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosList(requestParameters?: VideosApiVideosListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single video * @summary Retrieve * @param {VideosApiVideosRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ videosRetrieve(requestParameters: VideosApiVideosRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for videosList operation in VideosApi. * @export * @interface VideosApiVideosListRequest */ export interface VideosApiVideosListRequest { /** * * @type {boolean} * @memberof VideosApiVideosList */ readonly certification?: boolean; /** * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} * @memberof VideosApiVideosList */ readonly certification_type?: Array; /** * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features * @type {Array} * @memberof VideosApiVideosList */ readonly course_feature?: Array; /** * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline * @type {Array>} * @memberof VideosApiVideosList */ readonly delivery?: Array>; /** * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} * @memberof VideosApiVideosList */ readonly department?: Array; /** * The course/program is offered for free * @type {boolean} * @memberof VideosApiVideosList */ readonly free?: boolean; /** * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} * @memberof VideosApiVideosList */ readonly level?: Array; /** * Number of results to return per page. * @type {number} * @memberof VideosApiVideosList */ readonly limit?: number; /** * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} * @memberof VideosApiVideosList */ readonly offered_by?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof VideosApiVideosList */ readonly offset?: number; /** * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} * @memberof VideosApiVideosList */ readonly platform?: Array; /** * * @type {boolean} * @memberof VideosApiVideosList */ readonly professional?: boolean; /** * A unique text identifier for the resources * @type {Array} * @memberof VideosApiVideosList */ readonly readable_id?: Array; /** * Comma-separated list of learning resource IDs * @type {Array} * @memberof VideosApiVideosList */ readonly resource_id?: Array; /** * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} * @memberof VideosApiVideosList */ readonly resource_type?: Array; /** * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'learning_material' | 'program'>} * @memberof VideosApiVideosList */ readonly resource_type_group?: Array; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} * @memberof VideosApiVideosList */ readonly sortby?: VideosListSortbyEnum; /** * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @type {Array} * @memberof VideosApiVideosList */ readonly topic?: Array; } /** * Request parameters for videosRetrieve operation in VideosApi. * @export * @interface VideosApiVideosRetrieveRequest */ export interface VideosApiVideosRetrieveRequest { /** * A unique integer value identifying this learning resource. * @type {number} * @memberof VideosApiVideosRetrieve */ readonly id: number; } /** * VideosApi - object-oriented interface * @export * @class VideosApi * @extends {BaseAPI} */ export declare class VideosApi extends BaseAPI { /** * Get a paginated list of videos * @summary List * @param {VideosApiVideosListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideosApi */ videosList(requestParameters?: VideosApiVideosListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single video * @summary Retrieve * @param {VideosApiVideosRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VideosApi */ videosRetrieve(requestParameters: VideosApiVideosRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const VideosListCertificationTypeEnum: { readonly Completion: "completion"; readonly Micromasters: "micromasters"; readonly None: "none"; readonly Professional: "professional"; }; export type VideosListCertificationTypeEnum = typeof VideosListCertificationTypeEnum[keyof typeof VideosListCertificationTypeEnum]; /** * @export */ export declare const VideosListDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type VideosListDeliveryEnum = typeof VideosListDeliveryEnum[keyof typeof VideosListDeliveryEnum]; /** * @export */ export declare const VideosListDepartmentEnum: { readonly _1: "1"; readonly _10: "10"; readonly _11: "11"; readonly _12: "12"; readonly _14: "14"; readonly _15: "15"; readonly _16: "16"; readonly _17: "17"; readonly _18: "18"; readonly _2: "2"; readonly _20: "20"; readonly _21A: "21A"; readonly _21G: "21G"; readonly _21H: "21H"; readonly _21L: "21L"; readonly _21M: "21M"; readonly _22: "22"; readonly _24: "24"; readonly _3: "3"; readonly _4: "4"; readonly _5: "5"; readonly _6: "6"; readonly _7: "7"; readonly _8: "8"; readonly _9: "9"; readonly Cc: "CC"; readonly CmsW: "CMS-W"; readonly Ec: "EC"; readonly Es: "ES"; readonly Esd: "ESD"; readonly Hst: "HST"; readonly Ids: "IDS"; readonly Mas: "MAS"; readonly Pe: "PE"; readonly Sp: "SP"; readonly Sts: "STS"; readonly Wgs: "WGS"; }; export type VideosListDepartmentEnum = typeof VideosListDepartmentEnum[keyof typeof VideosListDepartmentEnum]; /** * @export */ export declare const VideosListLevelEnum: { readonly Advanced: "advanced"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; readonly Noncredit: "noncredit"; readonly Undergraduate: "undergraduate"; }; export type VideosListLevelEnum = typeof VideosListLevelEnum[keyof typeof VideosListLevelEnum]; /** * @export */ export declare const VideosListOfferedByEnum: { readonly Bootcamps: "bootcamps"; readonly Climate: "climate"; readonly Mitpe: "mitpe"; readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly See: "see"; readonly Xpro: "xpro"; }; export type VideosListOfferedByEnum = typeof VideosListOfferedByEnum[keyof typeof VideosListOfferedByEnum]; /** * @export */ export declare const VideosListPlatformEnum: { readonly Bootcamps: "bootcamps"; readonly Canvas: "canvas"; readonly Climate: "climate"; readonly Csail: "csail"; readonly Ctl: "ctl"; readonly Edx: "edx"; readonly Emeritus: "emeritus"; readonly Globalalumni: "globalalumni"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Ocw: "ocw"; readonly Oll: "oll"; readonly Ovs: "ovs"; readonly Podcast: "podcast"; readonly Scc: "scc"; readonly See: "see"; readonly Simplilearn: "simplilearn"; readonly Susskind: "susskind"; readonly Whu: "whu"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; }; export type VideosListPlatformEnum = typeof VideosListPlatformEnum[keyof typeof VideosListPlatformEnum]; /** * @export */ export declare const VideosListResourceTypeEnum: { readonly Course: "course"; readonly Document: "document"; readonly LearningPath: "learning_path"; readonly Podcast: "podcast"; readonly PodcastEpisode: "podcast_episode"; readonly Program: "program"; readonly Video: "video"; readonly VideoPlaylist: "video_playlist"; }; export type VideosListResourceTypeEnum = typeof VideosListResourceTypeEnum[keyof typeof VideosListResourceTypeEnum]; /** * @export */ export declare const VideosListResourceTypeGroupEnum: { readonly Course: "course"; readonly LearningMaterial: "learning_material"; readonly Program: "program"; }; export type VideosListResourceTypeGroupEnum = typeof VideosListResourceTypeGroupEnum[keyof typeof VideosListResourceTypeGroupEnum]; /** * @export */ export declare const VideosListSortbyEnum: { readonly Id: "-id"; readonly LastModified: "-last_modified"; readonly Mitcoursenumber: "-mitcoursenumber"; readonly ReadableId: "-readable_id"; readonly StartDate: "-start_date"; readonly Views: "-views"; readonly Id2: "id"; readonly LastModified2: "last_modified"; readonly Mitcoursenumber2: "mitcoursenumber"; readonly New: "new"; readonly ReadableId2: "readable_id"; readonly StartDate2: "start_date"; readonly Upcoming: "upcoming"; readonly Views2: "views"; }; export type VideosListSortbyEnum = typeof VideosListSortbyEnum[keyof typeof VideosListSortbyEnum]; /** * WebhooksApi - axios parameter creator * @export */ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => { /** * Webhook handler for ContentFile updates * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest * @param {string} [content_path] * @param {string} [course_id] * @param {string} [course_readable_id] * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesCreate: (source: WebhooksContentFilesCreateSourceEnum, ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, content_path?: string, course_id?: string, course_readable_id?: string, options?: RawAxiosRequestConfig) => Promise; /** * Webhook handler for ContentFile DELETE requests * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesDeleteCreate: (ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, options?: RawAxiosRequestConfig) => Promise; /** * Webhook handler for OVS video upserts and deletes from the dagster pipeline * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksOvsVideosCreate: (OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * WebhooksApi - functional programming interface * @export */ export declare const WebhooksApiFp: (configuration?: Configuration) => { /** * Webhook handler for ContentFile updates * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest * @param {string} [content_path] * @param {string} [course_id] * @param {string} [course_readable_id] * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesCreate(source: WebhooksContentFilesCreateSourceEnum, ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, content_path?: string, course_id?: string, course_readable_id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Webhook handler for ContentFile DELETE requests * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesDeleteCreate(ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Webhook handler for OVS video upserts and deletes from the dagster pipeline * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksOvsVideosCreate(OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksApi - factory interface * @export */ export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Webhook handler for ContentFile updates * @param {WebhooksApiWebhooksContentFilesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesCreate(requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Webhook handler for ContentFile DELETE requests * @param {WebhooksApiWebhooksContentFilesDeleteCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksContentFilesDeleteCreate(requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Webhook handler for OVS video upserts and deletes from the dagster pipeline * @param {WebhooksApiWebhooksOvsVideosCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ webhooksOvsVideosCreate(requestParameters?: WebhooksApiWebhooksOvsVideosCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for webhooksContentFilesCreate operation in WebhooksApi. * @export * @interface WebhooksApiWebhooksContentFilesCreateRequest */ export interface WebhooksApiWebhooksContentFilesCreateRequest { /** * * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs * @type {'micromasters' | 'mit_edx' | 'mitpe' | 'mitxonline' | 'oll' | 'ocw' | 'podcast' | 'mit_climate' | 'see' | 'xpro' | 'youtube' | 'canvas' | 'ovs'} * @memberof WebhooksApiWebhooksContentFilesCreate */ readonly source: WebhooksContentFilesCreateSourceEnum; /** * * @type {ContentFileWebHookRequestRequest} * @memberof WebhooksApiWebhooksContentFilesCreate */ readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest; /** * * @type {string} * @memberof WebhooksApiWebhooksContentFilesCreate */ readonly content_path?: string; /** * * @type {string} * @memberof WebhooksApiWebhooksContentFilesCreate */ readonly course_id?: string; /** * * @type {string} * @memberof WebhooksApiWebhooksContentFilesCreate */ readonly course_readable_id?: string; } /** * Request parameters for webhooksContentFilesDeleteCreate operation in WebhooksApi. * @export * @interface WebhooksApiWebhooksContentFilesDeleteCreateRequest */ export interface WebhooksApiWebhooksContentFilesDeleteCreateRequest { /** * * @type {ContentFileWebHookRequestRequest} * @memberof WebhooksApiWebhooksContentFilesDeleteCreate */ readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest; } /** * Request parameters for webhooksOvsVideosCreate operation in WebhooksApi. * @export * @interface WebhooksApiWebhooksOvsVideosCreateRequest */ export interface WebhooksApiWebhooksOvsVideosCreateRequest { /** * * @type {OVSVideoWebhookRequestRequest} * @memberof WebhooksApiWebhooksOvsVideosCreate */ readonly OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest; } /** * WebhooksApi - object-oriented interface * @export * @class WebhooksApi * @extends {BaseAPI} */ export declare class WebhooksApi extends BaseAPI { /** * Webhook handler for ContentFile updates * @param {WebhooksApiWebhooksContentFilesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ webhooksContentFilesCreate(requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Webhook handler for ContentFile DELETE requests * @param {WebhooksApiWebhooksContentFilesDeleteCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ webhooksContentFilesDeleteCreate(requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Webhook handler for OVS video upserts and deletes from the dagster pipeline * @param {WebhooksApiWebhooksOvsVideosCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ webhooksOvsVideosCreate(requestParameters?: WebhooksApiWebhooksOvsVideosCreateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const WebhooksContentFilesCreateSourceEnum: { readonly Micromasters: "micromasters"; readonly MitEdx: "mit_edx"; readonly Mitpe: "mitpe"; readonly Mitxonline: "mitxonline"; readonly Oll: "oll"; readonly Ocw: "ocw"; readonly Podcast: "podcast"; readonly MitClimate: "mit_climate"; readonly See: "see"; readonly Xpro: "xpro"; readonly Youtube: "youtube"; readonly Canvas: "canvas"; readonly Ovs: "ovs"; }; export type WebhooksContentFilesCreateSourceEnum = typeof WebhooksContentFilesCreateSourceEnum[keyof typeof WebhooksContentFilesCreateSourceEnum]; /** * WebsiteContentApi - axios parameter creator * @export */ export declare const WebsiteContentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new content item * @summary Create * @param {WebsiteContentRequest} WebsiteContentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentCreate: (WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Delete a content item * @summary Destroy * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {string} identifier Numeric ID or slug of the content item * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDetailRetrieve: (identifier: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a paginated list of website content items * @summary List * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article * @param {boolean} [draft] Filter to show only draft (unpublished) items * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentList: (content_type?: WebsiteContentListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Update a content item * @summary Update * @param {number} id A unique integer value identifying this website content. * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentPartialUpdate: (id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single content item * @summary Retrieve * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * WebsiteContentApi - functional programming interface * @export */ export declare const WebsiteContentApiFp: (configuration?: Configuration) => { /** * Create a new content item * @summary Create * @param {WebsiteContentRequest} WebsiteContentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentCreate(WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a content item * @summary Destroy * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {string} identifier Numeric ID or slug of the content item * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDetailRetrieve(identifier: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a paginated list of website content items * @summary List * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article * @param {boolean} [draft] Filter to show only draft (unpublished) items * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentList(content_type?: WebsiteContentListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a content item * @summary Update * @param {number} id A unique integer value identifying this website content. * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentPartialUpdate(id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single content item * @summary Retrieve * @param {number} id A unique integer value identifying this website content. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebsiteContentApi - factory interface * @export */ export declare const WebsiteContentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new content item * @summary Create * @param {WebsiteContentApiWebsiteContentCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentCreate(requestParameters: WebsiteContentApiWebsiteContentCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a content item * @summary Destroy * @param {WebsiteContentApiWebsiteContentDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDestroy(requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {WebsiteContentApiWebsiteContentDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentDetailRetrieve(requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a paginated list of website content items * @summary List * @param {WebsiteContentApiWebsiteContentListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentList(requestParameters?: WebsiteContentApiWebsiteContentListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update a content item * @summary Update * @param {WebsiteContentApiWebsiteContentPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentPartialUpdate(requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single content item * @summary Retrieve * @param {WebsiteContentApiWebsiteContentRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websiteContentRetrieve(requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for websiteContentCreate operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentCreateRequest */ export interface WebsiteContentApiWebsiteContentCreateRequest { /** * * @type {WebsiteContentRequest} * @memberof WebsiteContentApiWebsiteContentCreate */ readonly WebsiteContentRequest: WebsiteContentRequest; } /** * Request parameters for websiteContentDestroy operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentDestroyRequest */ export interface WebsiteContentApiWebsiteContentDestroyRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof WebsiteContentApiWebsiteContentDestroy */ readonly id: number; } /** * Request parameters for websiteContentDetailRetrieve operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentDetailRetrieveRequest */ export interface WebsiteContentApiWebsiteContentDetailRetrieveRequest { /** * Numeric ID or slug of the content item * @type {string} * @memberof WebsiteContentApiWebsiteContentDetailRetrieve */ readonly identifier: string; } /** * Request parameters for websiteContentList operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentListRequest */ export interface WebsiteContentApiWebsiteContentListRequest { /** * Filter by content type * `news` - News * `article` - Article * @type {'article' | 'news'} * @memberof WebsiteContentApiWebsiteContentList */ readonly content_type?: WebsiteContentListContentTypeEnum; /** * Filter to show only draft (unpublished) items * @type {boolean} * @memberof WebsiteContentApiWebsiteContentList */ readonly draft?: boolean; /** * Number of results to return per page. * @type {number} * @memberof WebsiteContentApiWebsiteContentList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof WebsiteContentApiWebsiteContentList */ readonly offset?: number; } /** * Request parameters for websiteContentPartialUpdate operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentPartialUpdateRequest */ export interface WebsiteContentApiWebsiteContentPartialUpdateRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof WebsiteContentApiWebsiteContentPartialUpdate */ readonly id: number; /** * * @type {PatchedWebsiteContentRequest} * @memberof WebsiteContentApiWebsiteContentPartialUpdate */ readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest; } /** * Request parameters for websiteContentRetrieve operation in WebsiteContentApi. * @export * @interface WebsiteContentApiWebsiteContentRetrieveRequest */ export interface WebsiteContentApiWebsiteContentRetrieveRequest { /** * A unique integer value identifying this website content. * @type {number} * @memberof WebsiteContentApiWebsiteContentRetrieve */ readonly id: number; } /** * WebsiteContentApi - object-oriented interface * @export * @class WebsiteContentApi * @extends {BaseAPI} */ export declare class WebsiteContentApi extends BaseAPI { /** * Create a new content item * @summary Create * @param {WebsiteContentApiWebsiteContentCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentCreate(requestParameters: WebsiteContentApiWebsiteContentCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Delete a content item * @summary Destroy * @param {WebsiteContentApiWebsiteContentDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentDestroy(requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {WebsiteContentApiWebsiteContentDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentDetailRetrieve(requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get a paginated list of website content items * @summary List * @param {WebsiteContentApiWebsiteContentListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentList(requestParameters?: WebsiteContentApiWebsiteContentListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Update a content item * @summary Update * @param {WebsiteContentApiWebsiteContentPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentPartialUpdate(requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single content item * @summary Retrieve * @param {WebsiteContentApiWebsiteContentRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsiteContentApi */ websiteContentRetrieve(requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const WebsiteContentListContentTypeEnum: { readonly Article: "article"; readonly News: "news"; }; export type WebsiteContentListContentTypeEnum = typeof WebsiteContentListContentTypeEnum[keyof typeof WebsiteContentListContentTypeEnum]; //# sourceMappingURL=api.d.ts.map