/** * MIT Learn API * MIT public API * * The version of the OpenAPI document: 0.0.1 (v0) * * * 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'; /** * Serializer for attestations. * @export * @interface Attestation */ export interface Attestation { /** * * @type {number} * @memberof Attestation */ 'id': number; /** * Get the avatar image URL * @type {string} * @memberof Attestation */ 'avatar': string | null; /** * Get the avatar_small image URL * @type {string} * @memberof Attestation */ 'avatar_small': string | null; /** * Get the avatar_medium image URL * @type {string} * @memberof Attestation */ 'avatar_medium': string | null; /** * Get the cover image URL * @type {string} * @memberof Attestation */ 'cover': string | null; /** * * @type {string} * @memberof Attestation */ 'created_on': string; /** * * @type {string} * @memberof Attestation */ 'updated_on': string; /** * The name of the attestant * @type {string} * @memberof Attestation */ 'attestant_name': string; /** * The attestant\'s title * @type {string} * @memberof Attestation */ 'title': string; /** * The testimonial attestation * @type {string} * @memberof Attestation */ 'quote': string; /** * The position the attestation should occupy * @type {number} * @memberof Attestation */ 'position'?: number; /** * The datetime to show the testimonial * @type {string} * @memberof Attestation */ 'publish_date'?: string | null; /** * Channels that the testimonial belongs to * @type {Array} * @memberof Attestation */ 'channels'?: Array; /** * The offerors that this attestation can appear on * @type {Array} * @memberof Attestation */ 'offerors'?: Array; } /** * * `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]; /** * * @export * @enum {string} */ export declare const BlankEnum: { readonly Empty: ""; }; export type BlankEnum = typeof BlankEnum[keyof typeof BlankEnum]; /** * Serializer for CKEditor settings * @export * @interface CKEditorSettings */ export interface CKEditorSettings { /** * Get the JWT token * @type {string} * @memberof CKEditorSettings */ 'token': string | null; } /** * 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; } /** * * `yes` - Yes, I am looking for a certificate * `no` - No, I am not looking for a certificate * `not-sure-yet` - Not Sure * @export * @enum {string} */ export declare const CertificateDesiredEnum: { /** * Yes, I am looking for a certificate */ readonly Yes: "yes"; /** * No, I am not looking for a certificate */ readonly No: "no"; /** * Not Sure */ readonly NotSureYet: "not-sure-yet"; }; export type CertificateDesiredEnum = typeof CertificateDesiredEnum[keyof typeof CertificateDesiredEnum]; /** * @type Channel * @export */ export type Channel = { channel_type: 'department'; } & DepartmentChannel | { channel_type: 'pathway'; } & PathwayChannel | { channel_type: 'topic'; } & TopicChannel | { channel_type: 'unit'; } & UnitChannel; /** * Serializer for resource counts associated with Channel * @export * @interface ChannelCounts */ export interface ChannelCounts { /** * * @type {number} * @memberof ChannelCounts */ 'id': number; /** * * @type {Counts} * @memberof ChannelCounts */ 'counts': Counts; /** * Get the URL for the channel * @type {string} * @memberof ChannelCounts */ 'channel_url': string; /** * * @type {string} * @memberof ChannelCounts */ 'created_on': string; /** * * @type {string} * @memberof ChannelCounts */ 'updated_on': string; /** * * @type {string} * @memberof ChannelCounts */ 'name': string; /** * * @type {string} * @memberof ChannelCounts */ 'title': string; /** * * @type {ChannelTypeEnum} * @memberof ChannelCounts */ 'channel_type': ChannelTypeEnum; /** * * @type {string} * @memberof ChannelCounts */ 'search_filter'?: string; } /** * Write serializer for Channel. Uses primary keys for referenced objects during requests, and delegates to ChannelSerializer for responses. * @export * @interface ChannelCreateRequest */ export interface ChannelCreateRequest { /** * * @type {string} * @memberof ChannelCreateRequest */ 'name': string; /** * * @type {string} * @memberof ChannelCreateRequest */ 'title': string; /** * * @type {string} * @memberof ChannelCreateRequest */ 'public_description'?: string; /** * * @type {Array} * @memberof ChannelCreateRequest */ 'sub_channels'?: Array; /** * Learning path featured in this channel. * @type {number} * @memberof ChannelCreateRequest */ 'featured_list'?: number | null; /** * Learning paths in this channel. * @type {Array} * @memberof ChannelCreateRequest */ 'lists'?: Array; /** * * @type {File} * @memberof ChannelCreateRequest */ 'avatar'?: File | null; /** * * @type {File} * @memberof ChannelCreateRequest */ 'banner'?: File | null; /** * * @type {any} * @memberof ChannelCreateRequest */ 'about'?: any | null; /** * * @type {ChannelTypeEnum} * @memberof ChannelCreateRequest */ 'channel_type': ChannelTypeEnum; /** * * @type {string} * @memberof ChannelCreateRequest */ 'search_filter'?: string; /** * * @type {ChannelTopicDetailRequest} * @memberof ChannelCreateRequest */ 'topic_detail'?: ChannelTopicDetailRequest | null; /** * * @type {ChannelDepartmentDetailRequest} * @memberof ChannelCreateRequest */ 'department_detail'?: ChannelDepartmentDetailRequest | null; } /** * Serializer for the ChannelDepartmentDetail model * @export * @interface ChannelDepartmentDetail */ export interface ChannelDepartmentDetail { /** * * @type {string} * @memberof ChannelDepartmentDetail */ 'department'?: string | null; } /** * Serializer for the ChannelDepartmentDetail model * @export * @interface ChannelDepartmentDetailRequest */ export interface ChannelDepartmentDetailRequest { /** * * @type {string} * @memberof ChannelDepartmentDetailRequest */ 'department'?: string | null; } /** * Serializer for moderators * @export * @interface ChannelModerator */ export interface ChannelModerator { /** * Returns the name for the moderator * @type {string} * @memberof ChannelModerator */ 'moderator_name'?: string; /** * Get the email from the associated user * @type {string} * @memberof ChannelModerator */ 'email'?: string; /** * Get the full name of the associated user * @type {string} * @memberof ChannelModerator */ 'full_name': string; } /** * Serializer for moderators * @export * @interface ChannelModeratorRequest */ export interface ChannelModeratorRequest { /** * Returns the name for the moderator * @type {string} * @memberof ChannelModeratorRequest */ 'moderator_name'?: string; /** * Get the email from the associated user * @type {string} * @memberof ChannelModeratorRequest */ 'email'?: string; } /** * Serializer for the ChannelTopicDetail model * @export * @interface ChannelTopicDetail */ export interface ChannelTopicDetail { /** * * @type {number} * @memberof ChannelTopicDetail */ 'topic'?: number | null; } /** * Serializer for the ChannelTopicDetail model * @export * @interface ChannelTopicDetailRequest */ export interface ChannelTopicDetailRequest { /** * * @type {number} * @memberof ChannelTopicDetailRequest */ 'topic'?: number | null; } /** * * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway * @export * @enum {string} */ export declare const ChannelTypeEnum: { /** * Topic */ readonly Topic: "topic"; /** * Department */ readonly Department: "department"; /** * Unit */ readonly Unit: "unit"; /** * Pathway */ readonly Pathway: "pathway"; }; export type ChannelTypeEnum = typeof ChannelTypeEnum[keyof typeof ChannelTypeEnum]; /** * Serializer for the ChannelOfferorDetail model * @export * @interface ChannelUnitDetail */ export interface ChannelUnitDetail { /** * * @type {LearningResourceOfferorDetail} * @memberof ChannelUnitDetail */ 'unit': LearningResourceOfferorDetail; } /** * 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 {ContentTypeEnum} * @memberof ContentFile */ 'content_type'?: ContentTypeEnum; /** * * @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; } /** * SearchResponseSerializer with OpenAPI annotations for Content Files search * @export * @interface ContentFileVectorSearchResponse */ export interface ContentFileVectorSearchResponse { /** * * @type {number} * @memberof ContentFileVectorSearchResponse */ 'count': number; /** * * @type {string} * @memberof ContentFileVectorSearchResponse */ 'next': string | null; /** * * @type {string} * @memberof ContentFileVectorSearchResponse */ 'previous': string | null; /** * * @type {Array} * @memberof ContentFileVectorSearchResponse */ 'results': Array; /** * * @type {ContentFileVectorSearchResponseMetadata} * @memberof ContentFileVectorSearchResponse */ 'metadata': ContentFileVectorSearchResponseMetadata; } /** * * @export * @interface ContentFileVectorSearchResponseMetadata */ export interface ContentFileVectorSearchResponseMetadata { /** * * @type {{ [key: string]: Array; }} * @memberof ContentFileVectorSearchResponseMetadata */ 'aggregations': { [key: string]: Array; }; /** * * @type {Array} * @memberof ContentFileVectorSearchResponseMetadata */ 'suggestions': Array; } /** * * @export * @interface ContentFileVectorSearchResponseMetadataAggregationsValueInner */ export interface ContentFileVectorSearchResponseMetadataAggregationsValueInner { /** * * @type {string} * @memberof ContentFileVectorSearchResponseMetadataAggregationsValueInner */ 'key': string; /** * * @type {number} * @memberof ContentFileVectorSearchResponseMetadataAggregationsValueInner */ 'doc_count': number; } /** * * `page` - page * `file` - file * `video` - video * `pdf` - pdf * @export * @enum {string} */ export declare const ContentTypeEnum: { /** * page */ readonly Page: "page"; /** * file */ readonly File: "file"; /** * video */ readonly Video: "video"; /** * pdf */ readonly Pdf: "pdf"; }; export type ContentTypeEnum = typeof ContentTypeEnum[keyof typeof ContentTypeEnum]; /** * * @export * @interface Counts */ export interface Counts { /** * * @type {number} * @memberof Counts */ 'courses': number; /** * * @type {number} * @memberof Counts */ 'programs': number; } /** * 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 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]; /** * * @export * @enum {string} */ export declare const CourseResourceResourceTypeEnum: { readonly Course: "course"; }; export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEnum[keyof typeof CourseResourceResourceTypeEnum]; /** * * `` - ---- * `Doctorate` - Doctorate * `Master\'s or professional degree` - Master\'s or professional degree * `Bachelor\'s degree` - Bachelor\'s degree * `Associate degree` - Associate degree * `Secondary/high school` - Secondary/high school * `Junior secondary/junior high/middle school` - Junior secondary/junior high/middle school * `No formal education` - No formal education * `Other education` - Other education * @export * @enum {string} */ export declare const CurrentEducationEnum: { /** * Doctorate */ readonly Doctorate: "Doctorate"; /** * Master's or professional degree */ readonly MastersOrProfessionalDegree: "Master's or professional degree"; /** * Bachelor's degree */ readonly BachelorsDegree: "Bachelor's degree"; /** * Associate degree */ readonly AssociateDegree: "Associate degree"; /** * Secondary/high school */ readonly SecondaryHighSchool: "Secondary/high school"; /** * Junior secondary/junior high/middle school */ readonly JuniorSecondaryJuniorHighMiddleSchool: "Junior secondary/junior high/middle school"; /** * No formal education */ readonly NoFormalEducation: "No formal education"; /** * Other education */ readonly OtherEducation: "Other education"; }; export type CurrentEducationEnum = typeof CurrentEducationEnum[keyof typeof CurrentEducationEnum]; /** * * `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]; /** * Serializer for Channel model of type department * @export * @interface DepartmentChannel */ export interface DepartmentChannel { /** * * @type {number} * @memberof DepartmentChannel */ 'id': number; /** * Get the avatar image URL * @type {string} * @memberof DepartmentChannel */ 'avatar'?: string | null; /** * Get the avatar image small URL * @type {string} * @memberof DepartmentChannel */ 'avatar_small': string | null; /** * Get the avatar image medium URL * @type {string} * @memberof DepartmentChannel */ 'avatar_medium': string | null; /** * Get the banner image URL * @type {string} * @memberof DepartmentChannel */ 'banner'?: string | null; /** * Return true if user is a moderator for the channel * @type {boolean} * @memberof DepartmentChannel */ 'is_moderator': boolean; /** * * @type {Array} * @memberof DepartmentChannel */ 'lists': Array; /** * Get the URL for the channel * @type {string} * @memberof DepartmentChannel */ 'channel_url': string; /** * * @type {DepartmentChannelFeaturedList} * @memberof DepartmentChannel */ 'featured_list': DepartmentChannelFeaturedList | null; /** * * @type {Array} * @memberof DepartmentChannel */ 'sub_channels': Array; /** * * @type {DepartmentChannelTypeEnum} * @memberof DepartmentChannel */ 'channel_type': DepartmentChannelTypeEnum; /** * * @type {ChannelDepartmentDetail} * @memberof DepartmentChannel */ 'department_detail': ChannelDepartmentDetail; /** * * @type {string} * @memberof DepartmentChannel */ 'created_on': string; /** * * @type {string} * @memberof DepartmentChannel */ 'updated_on': string; /** * * @type {string} * @memberof DepartmentChannel */ 'name': string; /** * * @type {string} * @memberof DepartmentChannel */ 'title': string; /** * * @type {any} * @memberof DepartmentChannel */ 'about'?: any | null; /** * * @type {any} * @memberof DepartmentChannel */ 'configuration'?: any | null; /** * * @type {string} * @memberof DepartmentChannel */ 'search_filter'?: string; /** * * @type {string} * @memberof DepartmentChannel */ 'public_description'?: string; /** * * @type {string} * @memberof DepartmentChannel */ 'ga_tracking_id'?: string; /** * * @type {number} * @memberof DepartmentChannel */ 'widget_list'?: number | null; } /** * Learning path featured in this channel. * @export * @interface DepartmentChannelFeaturedList */ export interface DepartmentChannelFeaturedList { /** * * @type {string} * @memberof DepartmentChannelFeaturedList */ 'title': string; /** * * @type {string} * @memberof DepartmentChannelFeaturedList */ 'url'?: string | null; /** * * @type {number} * @memberof DepartmentChannelFeaturedList */ 'id': number; } /** * * `department` - Department * @export * @enum {string} */ export declare const DepartmentChannelTypeEnum: { /** * Department */ readonly Department: "department"; }; export type DepartmentChannelTypeEnum = typeof DepartmentChannelTypeEnum[keyof typeof DepartmentChannelTypeEnum]; /** * 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; } /** * * @export * @enum {string} */ export declare const DocumentResourceResourceTypeEnum: { readonly Document: "document"; }; export type DocumentResourceResourceTypeEnum = typeof DocumentResourceResourceTypeEnum[keyof typeof DocumentResourceResourceTypeEnum]; /** * Serializer for News FeedItem * @export * @interface EventFeedItem */ export interface EventFeedItem { /** * * @type {number} * @memberof EventFeedItem */ 'id': number; /** * * @type {EventFeedItemFeedTypeEnum} * @memberof EventFeedItem */ 'feed_type': EventFeedItemFeedTypeEnum; /** * * @type {FeedImage} * @memberof EventFeedItem */ 'image': FeedImage; /** * * @type {FeedEventDetail} * @memberof EventFeedItem */ 'event_details': FeedEventDetail; /** * * @type {string} * @memberof EventFeedItem */ 'guid': string; /** * * @type {string} * @memberof EventFeedItem */ 'title': string; /** * * @type {string} * @memberof EventFeedItem */ 'url': string; /** * * @type {string} * @memberof EventFeedItem */ 'summary'?: string; /** * * @type {string} * @memberof EventFeedItem */ 'content'?: string; /** * * @type {number} * @memberof EventFeedItem */ 'source': number; } /** * * @export * @enum {string} */ export declare const EventFeedItemFeedTypeEnum: { readonly Events: "events"; }; export type EventFeedItemFeedTypeEnum = typeof EventFeedItemFeedTypeEnum[keyof typeof EventFeedItemFeedTypeEnum]; /** * FeedEventDetail serializer * @export * @interface FeedEventDetail */ export interface FeedEventDetail { /** * * @type {number} * @memberof FeedEventDetail */ 'id': number; /** * * @type {Array} * @memberof FeedEventDetail */ 'audience': Array; /** * * @type {Array} * @memberof FeedEventDetail */ 'location': Array; /** * * @type {Array} * @memberof FeedEventDetail */ 'event_type': Array; /** * * @type {string} * @memberof FeedEventDetail */ 'event_datetime': string; /** * * @type {string} * @memberof FeedEventDetail */ 'event_end_datetime'?: string | null; } /** * Serializer for FeedImage * @export * @interface FeedImage */ export interface FeedImage { /** * * @type {number} * @memberof FeedImage */ 'id': number; /** * * @type {string} * @memberof FeedImage */ 'url'?: string; /** * * @type {string} * @memberof FeedImage */ 'description'?: string; /** * * @type {string} * @memberof FeedImage */ 'alt'?: string; } /** * @type FeedItem * @export */ export type FeedItem = { resource_type: 'events'; } & EventFeedItem | { resource_type: 'news'; } & NewsFeedItem; /** * FeedNewsDetail serializer * @export * @interface FeedNewsDetail */ export interface FeedNewsDetail { /** * * @type {number} * @memberof FeedNewsDetail */ 'id': number; /** * * @type {Array} * @memberof FeedNewsDetail */ 'authors'?: Array; /** * * @type {Array} * @memberof FeedNewsDetail */ 'topics'?: Array; /** * * @type {string} * @memberof FeedNewsDetail */ 'publish_date': string; } /** * FeedSource serializer * @export * @interface FeedSource */ export interface FeedSource { /** * * @type {number} * @memberof FeedSource */ 'id': number; /** * * @type {FeedImage} * @memberof FeedSource */ 'image': FeedImage; /** * * @type {string} * @memberof FeedSource */ 'title': string; /** * * @type {string} * @memberof FeedSource */ 'url': string; /** * * @type {string} * @memberof FeedSource */ 'description'?: string; /** * * @type {FeedSourceFeedTypeEnum} * @memberof FeedSource */ 'feed_type': FeedSourceFeedTypeEnum; } /** * * `news` - News * `events` - Events * @export * @enum {string} */ export declare const FeedSourceFeedTypeEnum: { /** * News */ readonly News: "news"; /** * Events */ readonly Events: "events"; }; export type FeedSourceFeedTypeEnum = typeof FeedSourceFeedTypeEnum[keyof typeof FeedSourceFeedTypeEnum]; /** * * `academic-excellence` - Academic Boost * `career-growth` - Career Growth * `lifelong-learning` - Lifelong Learning * @export * @enum {string} */ export declare const GoalsEnum: { /** * Academic Boost */ readonly AcademicExcellence: "academic-excellence"; /** * Career Growth */ readonly CareerGrowth: "career-growth"; /** * Lifelong Learning */ readonly LifelongLearning: "lifelong-learning"; }; export type GoalsEnum = typeof GoalsEnum[keyof typeof GoalsEnum]; /** * 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; } /** * Serializer for a minimal preview of Learning Paths * @export * @interface LearningPathPreview */ export interface LearningPathPreview { /** * * @type {string} * @memberof LearningPathPreview */ 'title': string; /** * * @type {string} * @memberof LearningPathPreview */ 'url'?: string | null; /** * * @type {number} * @memberof LearningPathPreview */ 'id': 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; } /** * * @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; /** * 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; } /** * 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; } /** * 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 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 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 all details * @export * @interface LearningResourceOfferorDetailRequest */ export interface LearningResourceOfferorDetailRequest { /** * * @type {string} * @memberof LearningResourceOfferorDetailRequest */ 'code': string; /** * * @type {string} * @memberof LearningResourceOfferorDetailRequest */ 'name': string; /** * * @type {boolean} * @memberof LearningResourceOfferorDetailRequest */ 'professional'?: boolean; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'offerings'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'audience'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'formats'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'fee'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'certifications'?: Array; /** * * @type {Array} * @memberof LearningResourceOfferorDetailRequest */ 'content_types'?: Array; /** * * @type {string} * @memberof LearningResourceOfferorDetailRequest */ 'more_information'?: string; /** * * @type {string} * @memberof LearningResourceOfferorDetailRequest */ 'value_prop'?: string; /** * * @type {boolean} * @memberof LearningResourceOfferorDetailRequest */ '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 LearningResourcePrice model * @export * @interface LearningResourcePrice */ export interface LearningResourcePrice { /** * * @type {string} * @memberof LearningResourcePrice */ 'amount': string; /** * * @type {string} * @memberof LearningResourcePrice */ 'currency': string; } /** * 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; } /** * 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 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; } /** * Response serializer for vector based search * @export * @interface LearningResourcesVectorSearchResponse */ export interface LearningResourcesVectorSearchResponse { /** * * @type {number} * @memberof LearningResourcesVectorSearchResponse */ 'count': number; /** * * @type {string} * @memberof LearningResourcesVectorSearchResponse */ 'next': string | null; /** * * @type {string} * @memberof LearningResourcesVectorSearchResponse */ 'previous': string | null; /** * * @type {Array} * @memberof LearningResourcesVectorSearchResponse */ 'results': Array; /** * * @type {ContentFileVectorSearchResponseMetadata} * @memberof LearningResourcesVectorSearchResponse */ 'metadata': ContentFileVectorSearchResponseMetadata; } /** * Serializer for News FeedItem * @export * @interface NewsFeedItem */ export interface NewsFeedItem { /** * * @type {number} * @memberof NewsFeedItem */ 'id': number; /** * * @type {NewsFeedItemFeedTypeEnum} * @memberof NewsFeedItem */ 'feed_type': NewsFeedItemFeedTypeEnum; /** * * @type {FeedImage} * @memberof NewsFeedItem */ 'image': FeedImage; /** * * @type {FeedNewsDetail} * @memberof NewsFeedItem */ 'news_details': FeedNewsDetail; /** * * @type {string} * @memberof NewsFeedItem */ 'guid': string; /** * * @type {string} * @memberof NewsFeedItem */ 'title': string; /** * * @type {string} * @memberof NewsFeedItem */ 'url': string; /** * * @type {string} * @memberof NewsFeedItem */ 'summary'?: string; /** * * @type {string} * @memberof NewsFeedItem */ 'content'?: string; /** * * @type {number} * @memberof NewsFeedItem */ 'source': number; } /** * * @export * @enum {string} */ export declare const NewsFeedItemFeedTypeEnum: { readonly News: "news"; }; export type NewsFeedItemFeedTypeEnum = typeof NewsFeedItemFeedTypeEnum[keyof typeof NewsFeedItemFeedTypeEnum]; /** * * @export * @enum {string} */ export declare const NullEnum: { readonly Null: "null"; }; export type NullEnum = typeof NullEnum[keyof typeof NullEnum]; /** * * @export * @interface PaginatedAttestationList */ export interface PaginatedAttestationList { /** * * @type {number} * @memberof PaginatedAttestationList */ 'count': number; /** * * @type {string} * @memberof PaginatedAttestationList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedAttestationList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedAttestationList */ 'results': Array; } /** * * @export * @interface PaginatedChannelList */ export interface PaginatedChannelList { /** * * @type {number} * @memberof PaginatedChannelList */ 'count': number; /** * * @type {string} * @memberof PaginatedChannelList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedChannelList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedChannelList */ 'results': Array; } /** * * @export * @interface PaginatedFeedItemList */ export interface PaginatedFeedItemList { /** * * @type {number} * @memberof PaginatedFeedItemList */ 'count': number; /** * * @type {string} * @memberof PaginatedFeedItemList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedFeedItemList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedFeedItemList */ 'results': Array; } /** * * @export * @interface PaginatedFeedSourceList */ export interface PaginatedFeedSourceList { /** * * @type {number} * @memberof PaginatedFeedSourceList */ 'count': number; /** * * @type {string} * @memberof PaginatedFeedSourceList */ 'next'?: string | null; /** * * @type {string} * @memberof PaginatedFeedSourceList */ 'previous'?: string | null; /** * * @type {Array} * @memberof PaginatedFeedSourceList */ 'results': Array; } /** * Similar to ChannelCreateSerializer, with read-only name * @export * @interface PatchedChannelWriteRequest */ export interface PatchedChannelWriteRequest { /** * * @type {string} * @memberof PatchedChannelWriteRequest */ 'name'?: string; /** * * @type {string} * @memberof PatchedChannelWriteRequest */ 'title'?: string; /** * * @type {string} * @memberof PatchedChannelWriteRequest */ 'public_description'?: string; /** * * @type {Array} * @memberof PatchedChannelWriteRequest */ 'sub_channels'?: Array; /** * Learning path featured in this channel. * @type {number} * @memberof PatchedChannelWriteRequest */ 'featured_list'?: number | null; /** * Learning paths in this channel. * @type {Array} * @memberof PatchedChannelWriteRequest */ 'lists'?: Array; /** * Get the avatar image URL * @type {string} * @memberof PatchedChannelWriteRequest */ 'avatar'?: string | null; /** * Get the banner image URL * @type {string} * @memberof PatchedChannelWriteRequest */ 'banner'?: string | null; /** * * @type {any} * @memberof PatchedChannelWriteRequest */ 'about'?: any | null; /** * * @type {ChannelTypeEnum} * @memberof PatchedChannelWriteRequest */ 'channel_type'?: ChannelTypeEnum; /** * * @type {string} * @memberof PatchedChannelWriteRequest */ 'search_filter'?: string; /** * * @type {ChannelTopicDetailRequest} * @memberof PatchedChannelWriteRequest */ 'topic_detail'?: ChannelTopicDetailRequest | null; /** * * @type {ChannelDepartmentDetailRequest} * @memberof PatchedChannelWriteRequest */ 'department_detail'?: ChannelDepartmentDetailRequest | null; } /** * Serializer for Profile * @export * @interface PatchedProfileRequest */ export interface PatchedProfileRequest { /** * * @type {string} * @memberof PatchedProfileRequest */ 'image'?: string | null; /** * * @type {string} * @memberof PatchedProfileRequest */ 'image_small'?: string | null; /** * * @type {string} * @memberof PatchedProfileRequest */ 'image_medium'?: string | null; /** * * @type {boolean} * @memberof PatchedProfileRequest */ 'email_optin'?: boolean; /** * * @type {boolean} * @memberof PatchedProfileRequest */ 'toc_optin'?: boolean; /** * * @type {string} * @memberof PatchedProfileRequest */ 'bio'?: string | null; /** * * @type {string} * @memberof PatchedProfileRequest */ 'headline'?: string | null; /** * * @type {any} * @memberof PatchedProfileRequest */ 'location'?: any | null; /** * * @type {Array} * @memberof PatchedProfileRequest */ 'topic_interests'?: Array; /** * * @type {Array} * @memberof PatchedProfileRequest */ 'goals'?: Array; /** * * @type {PatchedProfileRequestCurrentEducation} * @memberof PatchedProfileRequest */ 'current_education'?: PatchedProfileRequestCurrentEducation; /** * * @type {PatchedProfileRequestCertificateDesired} * @memberof PatchedProfileRequest */ 'certificate_desired'?: PatchedProfileRequestCertificateDesired; /** * * @type {PatchedProfileRequestTimeCommitment} * @memberof PatchedProfileRequest */ 'time_commitment'?: PatchedProfileRequestTimeCommitment; /** * * @type {Array} * @memberof PatchedProfileRequest */ 'delivery'?: Array; } /** * @type PatchedProfileRequestCertificateDesired * @export */ export type PatchedProfileRequestCertificateDesired = BlankEnum | CertificateDesiredEnum; /** * @type PatchedProfileRequestCurrentEducation * @export */ export type PatchedProfileRequestCurrentEducation = BlankEnum | CurrentEducationEnum; /** * @type PatchedProfileRequestTimeCommitment * @export */ export type PatchedProfileRequestTimeCommitment = BlankEnum | TimeCommitmentEnum; /** * Serializer for User * @export * @interface PatchedUserRequest */ export interface PatchedUserRequest { /** * * @type {ProfileRequest} * @memberof PatchedUserRequest */ 'profile'?: ProfileRequest; /** * * @type {string} * @memberof PatchedUserRequest */ 'email'?: string; } /** * Serializer for WidgetLists * @export * @interface PatchedWidgetListRequest */ export interface PatchedWidgetListRequest { /** * * @type {Array} * @memberof PatchedWidgetListRequest */ 'widgets'?: Array | null; } /** * Serializer for Channel model of type pathway * @export * @interface PathwayChannel */ export interface PathwayChannel { /** * * @type {number} * @memberof PathwayChannel */ 'id': number; /** * Get the avatar image URL * @type {string} * @memberof PathwayChannel */ 'avatar'?: string | null; /** * Get the avatar image small URL * @type {string} * @memberof PathwayChannel */ 'avatar_small': string | null; /** * Get the avatar image medium URL * @type {string} * @memberof PathwayChannel */ 'avatar_medium': string | null; /** * Get the banner image URL * @type {string} * @memberof PathwayChannel */ 'banner'?: string | null; /** * Return true if user is a moderator for the channel * @type {boolean} * @memberof PathwayChannel */ 'is_moderator': boolean; /** * * @type {Array} * @memberof PathwayChannel */ 'lists': Array; /** * Get the URL for the channel * @type {string} * @memberof PathwayChannel */ 'channel_url': string; /** * * @type {DepartmentChannelFeaturedList} * @memberof PathwayChannel */ 'featured_list': DepartmentChannelFeaturedList | null; /** * * @type {Array} * @memberof PathwayChannel */ 'sub_channels': Array; /** * * @type {PathwayChannelTypeEnum} * @memberof PathwayChannel */ 'channel_type': PathwayChannelTypeEnum; /** * * @type {string} * @memberof PathwayChannel */ 'created_on': string; /** * * @type {string} * @memberof PathwayChannel */ 'updated_on': string; /** * * @type {string} * @memberof PathwayChannel */ 'name': string; /** * * @type {string} * @memberof PathwayChannel */ 'title': string; /** * * @type {any} * @memberof PathwayChannel */ 'about'?: any | null; /** * * @type {any} * @memberof PathwayChannel */ 'configuration'?: any | null; /** * * @type {string} * @memberof PathwayChannel */ 'search_filter'?: string; /** * * @type {string} * @memberof PathwayChannel */ 'public_description'?: string; /** * * @type {string} * @memberof PathwayChannel */ 'ga_tracking_id'?: string; /** * * @type {number} * @memberof PathwayChannel */ 'widget_list'?: number | null; } /** * * `pathway` - Pathway * @export * @enum {string} */ export declare const PathwayChannelTypeEnum: { /** * Pathway */ readonly Pathway: "pathway"; }; export type PathwayChannelTypeEnum = typeof PathwayChannelTypeEnum[keyof typeof PathwayChannelTypeEnum]; /** * 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 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; } /** * * @export * @enum {string} */ export declare const PodcastEpisodeResourceResourceTypeEnum: { readonly PodcastEpisode: "podcast_episode"; }; export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResourceResourceTypeEnum[keyof typeof PodcastEpisodeResourceResourceTypeEnum]; /** * 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; } /** * * @export * @enum {string} */ export declare const PodcastResourceResourceTypeEnum: { readonly Podcast: "podcast"; }; export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceTypeEnum[keyof typeof PodcastResourceResourceTypeEnum]; /** * Serializer for profile search preference filters * @export * @interface PreferencesSearch */ export interface PreferencesSearch { /** * * @type {boolean} * @memberof PreferencesSearch */ 'certification'?: boolean; /** * * @type {Array} * @memberof PreferencesSearch */ 'topic'?: Array; /** * * @type {Array} * @memberof PreferencesSearch */ 'delivery'?: Array; } /** * * @export * @interface ProblemListResponse */ export interface ProblemListResponse { /** * * @type {Array} * @memberof ProblemListResponse */ 'problem_set_titles': Array; } /** * Serializer for Profile * @export * @interface Profile */ export interface Profile { /** * Get the user\'s name * @type {string} * @memberof Profile */ 'name': string; /** * * @type {string} * @memberof Profile */ 'image'?: string | null; /** * * @type {string} * @memberof Profile */ 'image_small'?: string | null; /** * * @type {string} * @memberof Profile */ 'image_medium'?: string | null; /** * * @type {string} * @memberof Profile */ 'image_file': string | null; /** * * @type {string} * @memberof Profile */ 'image_small_file': string | null; /** * * @type {string} * @memberof Profile */ 'image_medium_file': string | null; /** * Custom getter for small profile image * @type {string} * @memberof Profile */ 'profile_image_small': string; /** * Custom getter for medium profile image * @type {string} * @memberof Profile */ 'profile_image_medium': string; /** * * @type {string} * @memberof Profile */ 'bio'?: string | null; /** * * @type {string} * @memberof Profile */ 'headline'?: string | null; /** * Custom getter for the username * @type {string} * @memberof Profile */ 'username': string; /** * Custom getter for location text * @type {string} * @memberof Profile */ 'placename': string; /** * * @type {Array} * @memberof Profile */ 'topic_interests'?: Array; /** * * @type {Array} * @memberof Profile */ 'goals'?: Array; /** * * @type {PatchedProfileRequestCurrentEducation} * @memberof Profile */ 'current_education'?: PatchedProfileRequestCurrentEducation; /** * * @type {PatchedProfileRequestCertificateDesired} * @memberof Profile */ 'certificate_desired'?: PatchedProfileRequestCertificateDesired; /** * * @type {PatchedProfileRequestTimeCommitment} * @memberof Profile */ 'time_commitment'?: PatchedProfileRequestTimeCommitment; /** * * @type {Array} * @memberof Profile */ 'delivery'?: Array; /** * * @type {PreferencesSearch} * @memberof Profile */ 'preference_search_filters': PreferencesSearch; } /** * Serializer for Profile * @export * @interface ProfileRequest */ export interface ProfileRequest { /** * * @type {string} * @memberof ProfileRequest */ 'image'?: string | null; /** * * @type {string} * @memberof ProfileRequest */ 'image_small'?: string | null; /** * * @type {string} * @memberof ProfileRequest */ 'image_medium'?: string | null; /** * * @type {boolean} * @memberof ProfileRequest */ 'email_optin'?: boolean; /** * * @type {boolean} * @memberof ProfileRequest */ 'toc_optin'?: boolean; /** * * @type {string} * @memberof ProfileRequest */ 'bio'?: string | null; /** * * @type {string} * @memberof ProfileRequest */ 'headline'?: string | null; /** * * @type {any} * @memberof ProfileRequest */ 'location'?: any | null; /** * * @type {Array} * @memberof ProfileRequest */ 'topic_interests'?: Array; /** * * @type {Array} * @memberof ProfileRequest */ 'goals'?: Array; /** * * @type {PatchedProfileRequestCurrentEducation} * @memberof ProfileRequest */ 'current_education'?: PatchedProfileRequestCurrentEducation; /** * * @type {PatchedProfileRequestCertificateDesired} * @memberof ProfileRequest */ 'certificate_desired'?: PatchedProfileRequestCertificateDesired; /** * * @type {PatchedProfileRequestTimeCommitment} * @memberof ProfileRequest */ 'time_commitment'?: PatchedProfileRequestTimeCommitment; /** * * @type {Array} * @memberof ProfileRequest */ 'delivery'?: Array; } /** * 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 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; } /** * * @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]; /** * * `news` - news * `events` - events * @export * @enum {string} */ export declare const ResourceTypeEnum: { /** * news */ readonly News: "news"; /** * events */ readonly Events: "events"; }; 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]; /** * * @export * @interface RetrieveProblemResponse */ export interface RetrieveProblemResponse { /** * * @type {string} * @memberof RetrieveProblemResponse */ 'problem_set': string; /** * * @type {string} * @memberof RetrieveProblemResponse */ 'solution_set': string; } /** * * `facebook` - facebook * `linkedin` - linkedin * `personal` - personal * `twitter` - twitter * @export * @enum {string} */ export declare const SiteTypeEnum: { /** * facebook */ readonly Facebook: "facebook"; /** * linkedin */ readonly Linkedin: "linkedin"; /** * personal */ readonly Personal: "personal"; /** * twitter */ readonly Twitter: "twitter"; }; export type SiteTypeEnum = typeof SiteTypeEnum[keyof typeof SiteTypeEnum]; /** * Serializer for SubChannels * @export * @interface SubChannel */ export interface SubChannel { /** * * @type {string} * @memberof SubChannel */ 'parent_channel': string; /** * * @type {string} * @memberof SubChannel */ 'channel': string; /** * * @type {number} * @memberof SubChannel */ 'position'?: number; } /** * * `0-to-5-hours` - <5 hours/week * `5-to-10-hours` - 5-10 hours/week * `10-to-20-hours` - 10-20 hours/week * `20-to-30-hours` - 20-30 hours/week * `30-plus-hours` - 30+ hours/week * @export * @enum {string} */ export declare const TimeCommitmentEnum: { /** * <5 hours/week */ readonly _0To5Hours: "0-to-5-hours"; /** * 5-10 hours/week */ readonly _5To10Hours: "5-to-10-hours"; /** * 10-20 hours/week */ readonly _10To20Hours: "10-to-20-hours"; /** * 20-30 hours/week */ readonly _20To30Hours: "20-to-30-hours"; /** * 30+ hours/week */ readonly _30PlusHours: "30-plus-hours"; }; export type TimeCommitmentEnum = typeof TimeCommitmentEnum[keyof typeof TimeCommitmentEnum]; /** * Serializer for Channel model of type topic * @export * @interface TopicChannel */ export interface TopicChannel { /** * * @type {number} * @memberof TopicChannel */ 'id': number; /** * Get the avatar image URL * @type {string} * @memberof TopicChannel */ 'avatar'?: string | null; /** * Get the avatar image small URL * @type {string} * @memberof TopicChannel */ 'avatar_small': string | null; /** * Get the avatar image medium URL * @type {string} * @memberof TopicChannel */ 'avatar_medium': string | null; /** * Get the banner image URL * @type {string} * @memberof TopicChannel */ 'banner'?: string | null; /** * Return true if user is a moderator for the channel * @type {boolean} * @memberof TopicChannel */ 'is_moderator': boolean; /** * * @type {Array} * @memberof TopicChannel */ 'lists': Array; /** * Get the URL for the channel * @type {string} * @memberof TopicChannel */ 'channel_url': string; /** * * @type {DepartmentChannelFeaturedList} * @memberof TopicChannel */ 'featured_list': DepartmentChannelFeaturedList | null; /** * * @type {Array} * @memberof TopicChannel */ 'sub_channels': Array; /** * * @type {TopicChannelTypeEnum} * @memberof TopicChannel */ 'channel_type': TopicChannelTypeEnum; /** * * @type {ChannelTopicDetail} * @memberof TopicChannel */ 'topic_detail': ChannelTopicDetail; /** * * @type {string} * @memberof TopicChannel */ 'created_on': string; /** * * @type {string} * @memberof TopicChannel */ 'updated_on': string; /** * * @type {string} * @memberof TopicChannel */ 'name': string; /** * * @type {string} * @memberof TopicChannel */ 'title': string; /** * * @type {any} * @memberof TopicChannel */ 'about'?: any | null; /** * * @type {any} * @memberof TopicChannel */ 'configuration'?: any | null; /** * * @type {string} * @memberof TopicChannel */ 'search_filter'?: string; /** * * @type {string} * @memberof TopicChannel */ 'public_description'?: string; /** * * @type {string} * @memberof TopicChannel */ 'ga_tracking_id'?: string; /** * * @type {number} * @memberof TopicChannel */ 'widget_list'?: number | null; } /** * * `topic` - Topic * @export * @enum {string} */ export declare const TopicChannelTypeEnum: { /** * Topic */ readonly Topic: "topic"; }; export type TopicChannelTypeEnum = typeof TopicChannelTypeEnum[keyof typeof TopicChannelTypeEnum]; /** * Serializer for Channel model of type unit * @export * @interface UnitChannel */ export interface UnitChannel { /** * * @type {number} * @memberof UnitChannel */ 'id': number; /** * Get the avatar image URL * @type {string} * @memberof UnitChannel */ 'avatar'?: string | null; /** * Get the avatar image small URL * @type {string} * @memberof UnitChannel */ 'avatar_small': string | null; /** * Get the avatar image medium URL * @type {string} * @memberof UnitChannel */ 'avatar_medium': string | null; /** * Get the banner image URL * @type {string} * @memberof UnitChannel */ 'banner'?: string | null; /** * Return true if user is a moderator for the channel * @type {boolean} * @memberof UnitChannel */ 'is_moderator': boolean; /** * * @type {Array} * @memberof UnitChannel */ 'lists': Array; /** * Get the URL for the channel * @type {string} * @memberof UnitChannel */ 'channel_url': string; /** * * @type {DepartmentChannelFeaturedList} * @memberof UnitChannel */ 'featured_list': DepartmentChannelFeaturedList | null; /** * * @type {Array} * @memberof UnitChannel */ 'sub_channels': Array; /** * * @type {UnitChannelTypeEnum} * @memberof UnitChannel */ 'channel_type': UnitChannelTypeEnum; /** * * @type {ChannelUnitDetail} * @memberof UnitChannel */ 'unit_detail': ChannelUnitDetail; /** * * @type {string} * @memberof UnitChannel */ 'created_on': string; /** * * @type {string} * @memberof UnitChannel */ 'updated_on': string; /** * * @type {string} * @memberof UnitChannel */ 'name': string; /** * * @type {string} * @memberof UnitChannel */ 'title': string; /** * * @type {any} * @memberof UnitChannel */ 'about'?: any | null; /** * * @type {any} * @memberof UnitChannel */ 'configuration'?: any | null; /** * * @type {string} * @memberof UnitChannel */ 'search_filter'?: string; /** * * @type {string} * @memberof UnitChannel */ 'public_description'?: string; /** * * @type {string} * @memberof UnitChannel */ 'ga_tracking_id'?: string; /** * * @type {number} * @memberof UnitChannel */ 'widget_list'?: number | null; } /** * * `unit` - Unit * @export * @enum {string} */ export declare const UnitChannelTypeEnum: { /** * Unit */ readonly Unit: "unit"; }; export type UnitChannelTypeEnum = typeof UnitChannelTypeEnum[keyof typeof UnitChannelTypeEnum]; /** * Serializer for User * @export * @interface User */ export interface User { /** * * @type {number} * @memberof User */ 'id': number; /** * * @type {string} * @memberof User */ 'username': string; /** * * @type {Profile} * @memberof User */ 'profile'?: Profile; /** * * @type {string} * @memberof User */ 'first_name': string; /** * * @type {string} * @memberof User */ 'last_name': string; /** * * @type {boolean} * @memberof User */ 'is_article_editor': boolean; /** * * @type {boolean} * @memberof User */ 'is_learning_path_editor': boolean; /** * * @type {boolean} * @memberof User */ 'is_authenticated': boolean; } /** * Serializer for User * @export * @interface UserRequest */ export interface UserRequest { /** * * @type {ProfileRequest} * @memberof UserRequest */ 'profile'?: ProfileRequest; /** * * @type {string} * @memberof UserRequest */ 'email': string; } /** * Serializer for UserWebsite * @export * @interface UserWebsite */ export interface UserWebsite { /** * * @type {number} * @memberof UserWebsite */ 'id': number; /** * * @type {number} * @memberof UserWebsite */ 'profile': number; /** * * @type {string} * @memberof UserWebsite */ 'url': string; /** * * @type {SiteTypeEnum} * @memberof UserWebsite */ 'site_type': SiteTypeEnum; } /** * Serializer for UserWebsite * @export * @interface UserWebsiteRequest */ export interface UserWebsiteRequest { /** * * @type {number} * @memberof UserWebsiteRequest */ 'profile': number; /** * * @type {string} * @memberof UserWebsiteRequest */ 'url': 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 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 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; } /** * * @export * @enum {string} */ export declare const VideoPlaylistResourceResourceTypeEnum: { readonly VideoPlaylist: "video_playlist"; }; export type VideoPlaylistResourceResourceTypeEnum = typeof VideoPlaylistResourceResourceTypeEnum[keyof typeof VideoPlaylistResourceResourceTypeEnum]; /** * 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; } /** * * @export * @enum {string} */ export declare const VideoResourceResourceTypeEnum: { readonly Video: "video"; }; export type VideoResourceResourceTypeEnum = typeof VideoResourceResourceTypeEnum[keyof typeof VideoResourceResourceTypeEnum]; /** * WidgetInstance serializer * @export * @interface WidgetInstance */ export interface WidgetInstance { /** * * @type {number} * @memberof WidgetInstance */ 'id': number; /** * * @type {WidgetTypeEnum} * @memberof WidgetInstance */ 'widget_type': WidgetTypeEnum; /** * * @type {string} * @memberof WidgetInstance */ 'title': string; /** * Returns the configuration to serialize * @type {{ [key: string]: any; }} * @memberof WidgetInstance */ 'configuration'?: { [key: string]: any; }; /** * Renders the widget to json based on configuration * @type {{ [key: string]: any; }} * @memberof WidgetInstance */ 'json': { [key: string]: any; } | null; } /** * Serializer for WidgetLists * @export * @interface WidgetList */ export interface WidgetList { /** * * @type {number} * @memberof WidgetList */ 'id': number; /** * * @type {Array} * @memberof WidgetList */ 'widgets'?: Array | null; /** * * @type {Array} * @memberof WidgetList */ 'available_widgets': Array; } /** * * @export * @interface WidgetListAvailableWidgetsInner */ export interface WidgetListAvailableWidgetsInner { /** * * @type {string} * @memberof WidgetListAvailableWidgetsInner */ 'widget_type'?: string; /** * * @type {string} * @memberof WidgetListAvailableWidgetsInner */ 'description'?: string; /** * * @type {object} * @memberof WidgetListAvailableWidgetsInner */ 'form_spec'?: object; } /** * Serializer for WidgetLists * @export * @interface WidgetListRequest */ export interface WidgetListRequest { /** * * @type {Array} * @memberof WidgetListRequest */ 'widgets'?: Array | null; } /** * * `Markdown` - Markdown * `URL` - URL * `RSS Feed` - RSS Feed * `People` - People * @export * @enum {string} */ export declare const WidgetTypeEnum: { /** * Markdown */ readonly Markdown: "Markdown"; /** * URL */ readonly Url: "URL"; /** * RSS Feed */ readonly RssFeed: "RSS Feed"; /** * People */ readonly People: "People"; }; export type WidgetTypeEnum = typeof WidgetTypeEnum[keyof typeof WidgetTypeEnum]; /** * ChannelsApi - axios parameter creator * @export */ export declare const ChannelsApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {string} channel_type * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCountsList: (channel_type: string, options?: RawAxiosRequestConfig) => Promise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Create * @param {ChannelCreateRequest} ChannelCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCreate: (ChannelCreateRequest: ChannelCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Destroy * @param {number} id A unique integer value identifying this channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary List * @param {ChannelsListChannelTypeEnum} [channel_type] * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway * @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} */ channelsList: (channel_type?: ChannelsListChannelTypeEnum, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * View for listing and adding moderators * @summary Channel Moderators Create * @param {string} id * @param {ChannelModeratorRequest} [ChannelModeratorRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsCreate: (id: string, ChannelModeratorRequest?: ChannelModeratorRequest, options?: RawAxiosRequestConfig) => Promise; /** * Remove the user from the moderator groups for this website * @summary Channel Moderators Destroy * @param {string} id * @param {string} moderator_name * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsDestroy: (id: string, moderator_name: string, options?: RawAxiosRequestConfig) => Promise; /** * View for listing and adding moderators * @summary Channel Moderators List * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsList: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Update * @param {number} id A unique integer value identifying this channel. * @param {PatchedChannelWriteRequest} [PatchedChannelWriteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsPartialUpdate: (id: number, PatchedChannelWriteRequest?: PatchedChannelWriteRequest, options?: RawAxiosRequestConfig) => Promise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Retrieve * @param {number} id A unique integer value identifying this channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {string} channel_type * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsTypeRetrieve: (channel_type: string, name: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ChannelsApi - functional programming interface * @export */ export declare const ChannelsApiFp: (configuration?: Configuration) => { /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {string} channel_type * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCountsList(channel_type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Create * @param {ChannelCreateRequest} ChannelCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCreate(ChannelCreateRequest: ChannelCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Destroy * @param {number} id A unique integer value identifying this channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary List * @param {ChannelsListChannelTypeEnum} [channel_type] * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway * @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} */ channelsList(channel_type?: ChannelsListChannelTypeEnum, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for listing and adding moderators * @summary Channel Moderators Create * @param {string} id * @param {ChannelModeratorRequest} [ChannelModeratorRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsCreate(id: string, ChannelModeratorRequest?: ChannelModeratorRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove the user from the moderator groups for this website * @summary Channel Moderators Destroy * @param {string} id * @param {string} moderator_name * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsDestroy(id: string, moderator_name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for listing and adding moderators * @summary Channel Moderators List * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsList(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Update * @param {number} id A unique integer value identifying this channel. * @param {PatchedChannelWriteRequest} [PatchedChannelWriteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsPartialUpdate(id: number, PatchedChannelWriteRequest?: PatchedChannelWriteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Retrieve * @param {number} id A unique integer value identifying this channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {string} channel_type * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsTypeRetrieve(channel_type: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ChannelsApi - factory interface * @export */ export declare const ChannelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {ChannelsApiChannelsCountsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCountsList(requestParameters: ChannelsApiChannelsCountsListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Create * @param {ChannelsApiChannelsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsCreate(requestParameters: ChannelsApiChannelsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Destroy * @param {ChannelsApiChannelsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsDestroy(requestParameters: ChannelsApiChannelsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary List * @param {ChannelsApiChannelsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsList(requestParameters?: ChannelsApiChannelsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for listing and adding moderators * @summary Channel Moderators Create * @param {ChannelsApiChannelsModeratorsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsCreate(requestParameters: ChannelsApiChannelsModeratorsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove the user from the moderator groups for this website * @summary Channel Moderators Destroy * @param {ChannelsApiChannelsModeratorsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsDestroy(requestParameters: ChannelsApiChannelsModeratorsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for listing and adding moderators * @summary Channel Moderators List * @param {ChannelsApiChannelsModeratorsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsModeratorsList(requestParameters: ChannelsApiChannelsModeratorsListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Update * @param {ChannelsApiChannelsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsPartialUpdate(requestParameters: ChannelsApiChannelsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Retrieve * @param {ChannelsApiChannelsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsRetrieve(requestParameters: ChannelsApiChannelsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {ChannelsApiChannelsTypeRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ channelsTypeRetrieve(requestParameters: ChannelsApiChannelsTypeRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for channelsCountsList operation in ChannelsApi. * @export * @interface ChannelsApiChannelsCountsListRequest */ export interface ChannelsApiChannelsCountsListRequest { /** * * @type {string} * @memberof ChannelsApiChannelsCountsList */ readonly channel_type: string; } /** * Request parameters for channelsCreate operation in ChannelsApi. * @export * @interface ChannelsApiChannelsCreateRequest */ export interface ChannelsApiChannelsCreateRequest { /** * * @type {ChannelCreateRequest} * @memberof ChannelsApiChannelsCreate */ readonly ChannelCreateRequest: ChannelCreateRequest; } /** * Request parameters for channelsDestroy operation in ChannelsApi. * @export * @interface ChannelsApiChannelsDestroyRequest */ export interface ChannelsApiChannelsDestroyRequest { /** * A unique integer value identifying this channel. * @type {number} * @memberof ChannelsApiChannelsDestroy */ readonly id: number; } /** * Request parameters for channelsList operation in ChannelsApi. * @export * @interface ChannelsApiChannelsListRequest */ export interface ChannelsApiChannelsListRequest { /** * * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway * @type {'department' | 'pathway' | 'topic' | 'unit'} * @memberof ChannelsApiChannelsList */ readonly channel_type?: ChannelsListChannelTypeEnum; /** * Number of results to return per page. * @type {number} * @memberof ChannelsApiChannelsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof ChannelsApiChannelsList */ readonly offset?: number; } /** * Request parameters for channelsModeratorsCreate operation in ChannelsApi. * @export * @interface ChannelsApiChannelsModeratorsCreateRequest */ export interface ChannelsApiChannelsModeratorsCreateRequest { /** * * @type {string} * @memberof ChannelsApiChannelsModeratorsCreate */ readonly id: string; /** * * @type {ChannelModeratorRequest} * @memberof ChannelsApiChannelsModeratorsCreate */ readonly ChannelModeratorRequest?: ChannelModeratorRequest; } /** * Request parameters for channelsModeratorsDestroy operation in ChannelsApi. * @export * @interface ChannelsApiChannelsModeratorsDestroyRequest */ export interface ChannelsApiChannelsModeratorsDestroyRequest { /** * * @type {string} * @memberof ChannelsApiChannelsModeratorsDestroy */ readonly id: string; /** * * @type {string} * @memberof ChannelsApiChannelsModeratorsDestroy */ readonly moderator_name: string; } /** * Request parameters for channelsModeratorsList operation in ChannelsApi. * @export * @interface ChannelsApiChannelsModeratorsListRequest */ export interface ChannelsApiChannelsModeratorsListRequest { /** * * @type {string} * @memberof ChannelsApiChannelsModeratorsList */ readonly id: string; } /** * Request parameters for channelsPartialUpdate operation in ChannelsApi. * @export * @interface ChannelsApiChannelsPartialUpdateRequest */ export interface ChannelsApiChannelsPartialUpdateRequest { /** * A unique integer value identifying this channel. * @type {number} * @memberof ChannelsApiChannelsPartialUpdate */ readonly id: number; /** * * @type {PatchedChannelWriteRequest} * @memberof ChannelsApiChannelsPartialUpdate */ readonly PatchedChannelWriteRequest?: PatchedChannelWriteRequest; } /** * Request parameters for channelsRetrieve operation in ChannelsApi. * @export * @interface ChannelsApiChannelsRetrieveRequest */ export interface ChannelsApiChannelsRetrieveRequest { /** * A unique integer value identifying this channel. * @type {number} * @memberof ChannelsApiChannelsRetrieve */ readonly id: number; } /** * Request parameters for channelsTypeRetrieve operation in ChannelsApi. * @export * @interface ChannelsApiChannelsTypeRetrieveRequest */ export interface ChannelsApiChannelsTypeRetrieveRequest { /** * * @type {string} * @memberof ChannelsApiChannelsTypeRetrieve */ readonly channel_type: string; /** * * @type {string} * @memberof ChannelsApiChannelsTypeRetrieve */ readonly name: string; } /** * ChannelsApi - object-oriented interface * @export * @class ChannelsApi * @extends {BaseAPI} */ export declare class ChannelsApi extends BaseAPI { /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {ChannelsApiChannelsCountsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsCountsList(requestParameters: ChannelsApiChannelsCountsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Create * @param {ChannelsApiChannelsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsCreate(requestParameters: ChannelsApiChannelsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Destroy * @param {ChannelsApiChannelsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsDestroy(requestParameters: ChannelsApiChannelsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary List * @param {ChannelsApiChannelsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsList(requestParameters?: ChannelsApiChannelsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for listing and adding moderators * @summary Channel Moderators Create * @param {ChannelsApiChannelsModeratorsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsModeratorsCreate(requestParameters: ChannelsApiChannelsModeratorsCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Remove the user from the moderator groups for this website * @summary Channel Moderators Destroy * @param {ChannelsApiChannelsModeratorsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsModeratorsDestroy(requestParameters: ChannelsApiChannelsModeratorsDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for listing and adding moderators * @summary Channel Moderators List * @param {ChannelsApiChannelsModeratorsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsModeratorsList(requestParameters: ChannelsApiChannelsModeratorsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Update * @param {ChannelsApiChannelsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsPartialUpdate(requestParameters: ChannelsApiChannelsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * CRUD Operations related to Channels. Channels may represent groups or organizations at MIT and are a high-level categorization of content. * @summary Retrieve * @param {ChannelsApiChannelsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsRetrieve(requestParameters: ChannelsApiChannelsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for retrieving an individual channel by type and name * @summary Channel Detail Lookup by channel type and name * @param {ChannelsApiChannelsTypeRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelsApi */ channelsTypeRetrieve(requestParameters: ChannelsApiChannelsTypeRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ChannelsListChannelTypeEnum: { readonly Department: "department"; readonly Pathway: "pathway"; readonly Topic: "topic"; readonly Unit: "unit"; }; export type ChannelsListChannelTypeEnum = typeof ChannelsListChannelTypeEnum[keyof typeof ChannelsListChannelTypeEnum]; /** * CkeditorApi - axios parameter creator * @export */ export declare const CkeditorApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get the settings response * @param {*} [options] Override http request option. * @throws {RequiredError} */ ckeditorRetrieve: (options?: RawAxiosRequestConfig) => Promise; }; /** * CkeditorApi - functional programming interface * @export */ export declare const CkeditorApiFp: (configuration?: Configuration) => { /** * Get the settings response * @param {*} [options] Override http request option. * @throws {RequiredError} */ ckeditorRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CkeditorApi - factory interface * @export */ export declare const CkeditorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get the settings response * @param {*} [options] Override http request option. * @throws {RequiredError} */ ckeditorRetrieve(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CkeditorApi - object-oriented interface * @export * @class CkeditorApi * @extends {BaseAPI} */ export declare class CkeditorApi extends BaseAPI { /** * Get the settings response * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CkeditorApi */ ckeditorRetrieve(options?: RawAxiosRequestConfig): Promise>; } /** * LearningResourcesSearchAdminParamsApi - axios parameter creator * @export */ export declare const LearningResourcesSearchAdminParamsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Learning resource search default admin param values * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchAdminParamsRetrieve: (options?: RawAxiosRequestConfig) => Promise; }; /** * LearningResourcesSearchAdminParamsApi - functional programming interface * @export */ export declare const LearningResourcesSearchAdminParamsApiFp: (configuration?: Configuration) => { /** * Learning resource search default admin param values * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LearningResourcesSearchAdminParamsApi - factory interface * @export */ export declare const LearningResourcesSearchAdminParamsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Learning resource search default admin param values * @param {*} [options] Override http request option. * @throws {RequiredError} */ learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * LearningResourcesSearchAdminParamsApi - object-oriented interface * @export * @class LearningResourcesSearchAdminParamsApi * @extends {BaseAPI} */ export declare class LearningResourcesSearchAdminParamsApi extends BaseAPI { /** * Learning resource search default admin param values * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LearningResourcesSearchAdminParamsApi */ learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig): Promise>; } /** * NewsEventsApi - axios parameter creator * @export */ export declare const NewsEventsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of feed items. * @param {Array} [feed_type] The type of item * `news` - News * `events` - Events * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {NewsEventsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `event_date` - Event date ascending * `-event_date` - Event date descending * `news_date` - Creation date ascending * `-news_date` - Creation date descending * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsList: (feed_type?: Array, limit?: number, offset?: number, sortby?: NewsEventsListSortbyEnum, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single feed item. * @param {number} id A unique integer value identifying this feed item. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * NewsEventsApi - functional programming interface * @export */ export declare const NewsEventsApiFp: (configuration?: Configuration) => { /** * Get a paginated list of feed items. * @param {Array} [feed_type] The type of item * `news` - News * `events` - Events * @param {number} [limit] Number of results to return per page. * @param {number} [offset] The initial index from which to return the results. * @param {NewsEventsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `event_date` - Event date ascending * `-event_date` - Event date descending * `news_date` - Creation date ascending * `-news_date` - Creation date descending * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsList(feed_type?: Array, limit?: number, offset?: number, sortby?: NewsEventsListSortbyEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single feed item. * @param {number} id A unique integer value identifying this feed item. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NewsEventsApi - factory interface * @export */ export declare const NewsEventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of feed items. * @param {NewsEventsApiNewsEventsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsList(requestParameters?: NewsEventsApiNewsEventsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single feed item. * @param {NewsEventsApiNewsEventsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsRetrieve(requestParameters: NewsEventsApiNewsEventsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for newsEventsList operation in NewsEventsApi. * @export * @interface NewsEventsApiNewsEventsListRequest */ export interface NewsEventsApiNewsEventsListRequest { /** * The type of item * `news` - News * `events` - Events * @type {Array<'events' | 'news'>} * @memberof NewsEventsApiNewsEventsList */ readonly feed_type?: Array; /** * Number of results to return per page. * @type {number} * @memberof NewsEventsApiNewsEventsList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof NewsEventsApiNewsEventsList */ readonly offset?: number; /** * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `event_date` - Event date ascending * `-event_date` - Event date descending * `news_date` - Creation date ascending * `-news_date` - Creation date descending * @type {'-event_date' | '-id' | '-news_date' | 'event_date' | 'id' | 'news_date'} * @memberof NewsEventsApiNewsEventsList */ readonly sortby?: NewsEventsListSortbyEnum; } /** * Request parameters for newsEventsRetrieve operation in NewsEventsApi. * @export * @interface NewsEventsApiNewsEventsRetrieveRequest */ export interface NewsEventsApiNewsEventsRetrieveRequest { /** * A unique integer value identifying this feed item. * @type {number} * @memberof NewsEventsApiNewsEventsRetrieve */ readonly id: number; } /** * NewsEventsApi - object-oriented interface * @export * @class NewsEventsApi * @extends {BaseAPI} */ export declare class NewsEventsApi extends BaseAPI { /** * Get a paginated list of feed items. * @param {NewsEventsApiNewsEventsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NewsEventsApi */ newsEventsList(requestParameters?: NewsEventsApiNewsEventsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single feed item. * @param {NewsEventsApiNewsEventsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NewsEventsApi */ newsEventsRetrieve(requestParameters: NewsEventsApiNewsEventsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const NewsEventsListFeedTypeEnum: { readonly Events: "events"; readonly News: "news"; }; export type NewsEventsListFeedTypeEnum = typeof NewsEventsListFeedTypeEnum[keyof typeof NewsEventsListFeedTypeEnum]; /** * @export */ export declare const NewsEventsListSortbyEnum: { readonly EventDate: "-event_date"; readonly Id: "-id"; readonly NewsDate: "-news_date"; readonly EventDate2: "event_date"; readonly Id2: "id"; readonly NewsDate2: "news_date"; }; export type NewsEventsListSortbyEnum = typeof NewsEventsListSortbyEnum[keyof typeof NewsEventsListSortbyEnum]; /** * NewsEventsSourcesApi - axios parameter creator * @export */ export declare const NewsEventsSourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get a paginated list of news/event feed sources. * @param {Array} [feed_type] The type of source * `news` - News * `events` - Events * @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} */ newsEventsSourcesList: (feed_type?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single news/event feed source. * @param {number} id A unique integer value identifying this feed source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsSourcesRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * NewsEventsSourcesApi - functional programming interface * @export */ export declare const NewsEventsSourcesApiFp: (configuration?: Configuration) => { /** * Get a paginated list of news/event feed sources. * @param {Array} [feed_type] The type of source * `news` - News * `events` - Events * @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} */ newsEventsSourcesList(feed_type?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single news/event feed source. * @param {number} id A unique integer value identifying this feed source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsSourcesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NewsEventsSourcesApi - factory interface * @export */ export declare const NewsEventsSourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get a paginated list of news/event feed sources. * @param {NewsEventsSourcesApiNewsEventsSourcesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsSourcesList(requestParameters?: NewsEventsSourcesApiNewsEventsSourcesListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single news/event feed source. * @param {NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ newsEventsSourcesRetrieve(requestParameters: NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for newsEventsSourcesList operation in NewsEventsSourcesApi. * @export * @interface NewsEventsSourcesApiNewsEventsSourcesListRequest */ export interface NewsEventsSourcesApiNewsEventsSourcesListRequest { /** * The type of source * `news` - News * `events` - Events * @type {Array<'events' | 'news'>} * @memberof NewsEventsSourcesApiNewsEventsSourcesList */ readonly feed_type?: Array; /** * Number of results to return per page. * @type {number} * @memberof NewsEventsSourcesApiNewsEventsSourcesList */ readonly limit?: number; /** * The initial index from which to return the results. * @type {number} * @memberof NewsEventsSourcesApiNewsEventsSourcesList */ readonly offset?: number; } /** * Request parameters for newsEventsSourcesRetrieve operation in NewsEventsSourcesApi. * @export * @interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest */ export interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest { /** * A unique integer value identifying this feed source. * @type {number} * @memberof NewsEventsSourcesApiNewsEventsSourcesRetrieve */ readonly id: number; } /** * NewsEventsSourcesApi - object-oriented interface * @export * @class NewsEventsSourcesApi * @extends {BaseAPI} */ export declare class NewsEventsSourcesApi extends BaseAPI { /** * Get a paginated list of news/event feed sources. * @param {NewsEventsSourcesApiNewsEventsSourcesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NewsEventsSourcesApi */ newsEventsSourcesList(requestParameters?: NewsEventsSourcesApiNewsEventsSourcesListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single news/event feed source. * @param {NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NewsEventsSourcesApi */ newsEventsSourcesRetrieve(requestParameters: NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const NewsEventsSourcesListFeedTypeEnum: { readonly Events: "events"; readonly News: "news"; }; export type NewsEventsSourcesListFeedTypeEnum = typeof NewsEventsSourcesListFeedTypeEnum[keyof typeof NewsEventsSourcesListFeedTypeEnum]; /** * ProfilesApi - axios parameter creator * @export */ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for profile * @param {string} user__username * @param {PatchedProfileRequest} [PatchedProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesPartialUpdate: (user__username: string, PatchedProfileRequest?: PatchedProfileRequest, options?: RawAxiosRequestConfig) => Promise; /** * View for profile * @param {string} user__username * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesRetrieve: (user__username: string, options?: RawAxiosRequestConfig) => Promise; /** * View for profile * @param {string} user__username * @param {ProfileRequest} [ProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesUpdate: (user__username: string, ProfileRequest?: ProfileRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * ProfilesApi - functional programming interface * @export */ export declare const ProfilesApiFp: (configuration?: Configuration) => { /** * View for profile * @param {string} user__username * @param {PatchedProfileRequest} [PatchedProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesPartialUpdate(user__username: string, PatchedProfileRequest?: PatchedProfileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for profile * @param {string} user__username * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesRetrieve(user__username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for profile * @param {string} user__username * @param {ProfileRequest} [ProfileRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesUpdate(user__username: string, ProfileRequest?: ProfileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProfilesApi - factory interface * @export */ export declare const ProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for profile * @param {ProfilesApiProfilesPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesPartialUpdate(requestParameters: ProfilesApiProfilesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for profile * @param {ProfilesApiProfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesRetrieve(requestParameters: ProfilesApiProfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for profile * @param {ProfilesApiProfilesUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ profilesUpdate(requestParameters: ProfilesApiProfilesUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for profilesPartialUpdate operation in ProfilesApi. * @export * @interface ProfilesApiProfilesPartialUpdateRequest */ export interface ProfilesApiProfilesPartialUpdateRequest { /** * * @type {string} * @memberof ProfilesApiProfilesPartialUpdate */ readonly user__username: string; /** * * @type {PatchedProfileRequest} * @memberof ProfilesApiProfilesPartialUpdate */ readonly PatchedProfileRequest?: PatchedProfileRequest; } /** * Request parameters for profilesRetrieve operation in ProfilesApi. * @export * @interface ProfilesApiProfilesRetrieveRequest */ export interface ProfilesApiProfilesRetrieveRequest { /** * * @type {string} * @memberof ProfilesApiProfilesRetrieve */ readonly user__username: string; } /** * Request parameters for profilesUpdate operation in ProfilesApi. * @export * @interface ProfilesApiProfilesUpdateRequest */ export interface ProfilesApiProfilesUpdateRequest { /** * * @type {string} * @memberof ProfilesApiProfilesUpdate */ readonly user__username: string; /** * * @type {ProfileRequest} * @memberof ProfilesApiProfilesUpdate */ readonly ProfileRequest?: ProfileRequest; } /** * ProfilesApi - object-oriented interface * @export * @class ProfilesApi * @extends {BaseAPI} */ export declare class ProfilesApi extends BaseAPI { /** * View for profile * @param {ProfilesApiProfilesPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ profilesPartialUpdate(requestParameters: ProfilesApiProfilesPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for profile * @param {ProfilesApiProfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ profilesRetrieve(requestParameters: ProfilesApiProfilesRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for profile * @param {ProfilesApiProfilesUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ profilesUpdate(requestParameters: ProfilesApiProfilesUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ProgramCertificatesApi - axios parameter creator * @export */ export declare const ProgramCertificatesApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for listing program certificates for a user (includes program letter links) * @param {number} [micromasters_program_id] * @param {string} [program_title] * @param {*} [options] Override http request option. * @throws {RequiredError} */ programCertificatesList: (micromasters_program_id?: number, program_title?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ProgramCertificatesApi - functional programming interface * @export */ export declare const ProgramCertificatesApiFp: (configuration?: Configuration) => { /** * View for listing program certificates for a user (includes program letter links) * @param {number} [micromasters_program_id] * @param {string} [program_title] * @param {*} [options] Override http request option. * @throws {RequiredError} */ programCertificatesList(micromasters_program_id?: number, program_title?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * ProgramCertificatesApi - factory interface * @export */ export declare const ProgramCertificatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for listing program certificates for a user (includes program letter links) * @param {ProgramCertificatesApiProgramCertificatesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ programCertificatesList(requestParameters?: ProgramCertificatesApiProgramCertificatesListRequest, options?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for programCertificatesList operation in ProgramCertificatesApi. * @export * @interface ProgramCertificatesApiProgramCertificatesListRequest */ export interface ProgramCertificatesApiProgramCertificatesListRequest { /** * * @type {number} * @memberof ProgramCertificatesApiProgramCertificatesList */ readonly micromasters_program_id?: number; /** * * @type {string} * @memberof ProgramCertificatesApiProgramCertificatesList */ readonly program_title?: string; } /** * ProgramCertificatesApi - object-oriented interface * @export * @class ProgramCertificatesApi * @extends {BaseAPI} */ export declare class ProgramCertificatesApi extends BaseAPI { /** * View for listing program certificates for a user (includes program letter links) * @param {ProgramCertificatesApiProgramCertificatesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProgramCertificatesApi */ programCertificatesList(requestParameters?: ProgramCertificatesApiProgramCertificatesListRequest, options?: RawAxiosRequestConfig): Promise>; } /** * TestimonialsApi - axios parameter creator * @export */ export declare const TestimonialsApiAxiosParamCreator: (configuration?: Configuration) => { /** * List all testimonials. * @summary List * @param {Array} [channels] The channels the attestation is for * @param {number} [limit] Number of results to return per page. * @param {Array} [offerors] The offerors the attestation is for * @param {number} [offset] The initial index from which to return the results. * @param {number} [position] Only show items that exist at this position * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsList: (channels?: Array, limit?: number, offerors?: Array, offset?: number, position?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a testimonial. * @summary Retrieve * @param {number} id A unique integer value identifying this attestation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * TestimonialsApi - functional programming interface * @export */ export declare const TestimonialsApiFp: (configuration?: Configuration) => { /** * List all testimonials. * @summary List * @param {Array} [channels] The channels the attestation is for * @param {number} [limit] Number of results to return per page. * @param {Array} [offerors] The offerors the attestation is for * @param {number} [offset] The initial index from which to return the results. * @param {number} [position] Only show items that exist at this position * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsList(channels?: Array, limit?: number, offerors?: Array, offset?: number, position?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a testimonial. * @summary Retrieve * @param {number} id A unique integer value identifying this attestation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TestimonialsApi - factory interface * @export */ export declare const TestimonialsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List all testimonials. * @summary List * @param {TestimonialsApiTestimonialsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsList(requestParameters?: TestimonialsApiTestimonialsListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a testimonial. * @summary Retrieve * @param {TestimonialsApiTestimonialsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ testimonialsRetrieve(requestParameters: TestimonialsApiTestimonialsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for testimonialsList operation in TestimonialsApi. * @export * @interface TestimonialsApiTestimonialsListRequest */ export interface TestimonialsApiTestimonialsListRequest { /** * The channels the attestation is for * @type {Array} * @memberof TestimonialsApiTestimonialsList */ readonly channels?: Array; /** * Number of results to return per page. * @type {number} * @memberof TestimonialsApiTestimonialsList */ readonly limit?: number; /** * The offerors the attestation is for * @type {Array} * @memberof TestimonialsApiTestimonialsList */ readonly offerors?: Array; /** * The initial index from which to return the results. * @type {number} * @memberof TestimonialsApiTestimonialsList */ readonly offset?: number; /** * Only show items that exist at this position * @type {number} * @memberof TestimonialsApiTestimonialsList */ readonly position?: number; } /** * Request parameters for testimonialsRetrieve operation in TestimonialsApi. * @export * @interface TestimonialsApiTestimonialsRetrieveRequest */ export interface TestimonialsApiTestimonialsRetrieveRequest { /** * A unique integer value identifying this attestation. * @type {number} * @memberof TestimonialsApiTestimonialsRetrieve */ readonly id: number; } /** * TestimonialsApi - object-oriented interface * @export * @class TestimonialsApi * @extends {BaseAPI} */ export declare class TestimonialsApi extends BaseAPI { /** * List all testimonials. * @summary List * @param {TestimonialsApiTestimonialsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TestimonialsApi */ testimonialsList(requestParameters?: TestimonialsApiTestimonialsListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a testimonial. * @summary Retrieve * @param {TestimonialsApiTestimonialsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TestimonialsApi */ testimonialsRetrieve(requestParameters: TestimonialsApiTestimonialsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * TutorApi - axios parameter creator * @export */ export declare const TutorApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve a list of problem names for a course run * @summary Retrieve problem list * @param {string} run_readable_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProblems: (run_readable_id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a specific problem and its solution for a course run * @summary Retrieve Problem * @param {string} problem_title * @param {string} run_readable_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProblem: (problem_title: string, run_readable_id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * TutorApi - functional programming interface * @export */ export declare const TutorApiFp: (configuration?: Configuration) => { /** * Retrieve a list of problem names for a course run * @summary Retrieve problem list * @param {string} run_readable_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProblems(run_readable_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a specific problem and its solution for a course run * @summary Retrieve Problem * @param {string} problem_title * @param {string} run_readable_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProblem(problem_title: string, run_readable_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TutorApi - factory interface * @export */ export declare const TutorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve a list of problem names for a course run * @summary Retrieve problem list * @param {TutorApiListProblemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProblems(requestParameters: TutorApiListProblemsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a specific problem and its solution for a course run * @summary Retrieve Problem * @param {TutorApiRetrieveProblemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveProblem(requestParameters: TutorApiRetrieveProblemRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for listProblems operation in TutorApi. * @export * @interface TutorApiListProblemsRequest */ export interface TutorApiListProblemsRequest { /** * * @type {string} * @memberof TutorApiListProblems */ readonly run_readable_id: string; } /** * Request parameters for retrieveProblem operation in TutorApi. * @export * @interface TutorApiRetrieveProblemRequest */ export interface TutorApiRetrieveProblemRequest { /** * * @type {string} * @memberof TutorApiRetrieveProblem */ readonly problem_title: string; /** * * @type {string} * @memberof TutorApiRetrieveProblem */ readonly run_readable_id: string; } /** * TutorApi - object-oriented interface * @export * @class TutorApi * @extends {BaseAPI} */ export declare class TutorApi extends BaseAPI { /** * Retrieve a list of problem names for a course run * @summary Retrieve problem list * @param {TutorApiListProblemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TutorApi */ listProblems(requestParameters: TutorApiListProblemsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a specific problem and its solution for a course run * @summary Retrieve Problem * @param {TutorApiRetrieveProblemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TutorApi */ retrieveProblem(requestParameters: TutorApiRetrieveProblemRequest, options?: RawAxiosRequestConfig): Promise>; } /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for users * @param {UserRequest} UserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersCreate: (UserRequest: UserRequest, options?: RawAxiosRequestConfig) => Promise; /** * View for users * @param {string} username * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersDestroy: (username: string, options?: RawAxiosRequestConfig) => Promise; /** * View for users * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersList: (options?: RawAxiosRequestConfig) => Promise; /** * User retrieve and update viewsets for the current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersMeRetrieve: (options?: RawAxiosRequestConfig) => Promise; /** * View for users * @param {string} username * @param {PatchedUserRequest} [PatchedUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersPartialUpdate: (username: string, PatchedUserRequest?: PatchedUserRequest, options?: RawAxiosRequestConfig) => Promise; /** * View for users * @param {string} username * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersRetrieve: (username: string, options?: RawAxiosRequestConfig) => Promise; /** * View for users * @param {string} username * @param {UserRequest} UserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersUpdate: (username: string, UserRequest: UserRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * View for users * @param {UserRequest} UserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersCreate(UserRequest: UserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for users * @param {string} username * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersDestroy(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for users * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * User retrieve and update viewsets for the current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersMeRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for users * @param {string} username * @param {PatchedUserRequest} [PatchedUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersPartialUpdate(username: string, PatchedUserRequest?: PatchedUserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for users * @param {string} username * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersRetrieve(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for users * @param {string} username * @param {UserRequest} UserRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersUpdate(username: string, UserRequest: UserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for users * @param {UsersApiUsersCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersCreate(requestParameters: UsersApiUsersCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for users * @param {UsersApiUsersDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersDestroy(requestParameters: UsersApiUsersDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for users * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersList(options?: RawAxiosRequestConfig): AxiosPromise>; /** * User retrieve and update viewsets for the current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersMeRetrieve(options?: RawAxiosRequestConfig): AxiosPromise; /** * View for users * @param {UsersApiUsersPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersPartialUpdate(requestParameters: UsersApiUsersPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for users * @param {UsersApiUsersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersRetrieve(requestParameters: UsersApiUsersRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for users * @param {UsersApiUsersUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ usersUpdate(requestParameters: UsersApiUsersUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for usersCreate operation in UsersApi. * @export * @interface UsersApiUsersCreateRequest */ export interface UsersApiUsersCreateRequest { /** * * @type {UserRequest} * @memberof UsersApiUsersCreate */ readonly UserRequest: UserRequest; } /** * Request parameters for usersDestroy operation in UsersApi. * @export * @interface UsersApiUsersDestroyRequest */ export interface UsersApiUsersDestroyRequest { /** * * @type {string} * @memberof UsersApiUsersDestroy */ readonly username: string; } /** * Request parameters for usersPartialUpdate operation in UsersApi. * @export * @interface UsersApiUsersPartialUpdateRequest */ export interface UsersApiUsersPartialUpdateRequest { /** * * @type {string} * @memberof UsersApiUsersPartialUpdate */ readonly username: string; /** * * @type {PatchedUserRequest} * @memberof UsersApiUsersPartialUpdate */ readonly PatchedUserRequest?: PatchedUserRequest; } /** * Request parameters for usersRetrieve operation in UsersApi. * @export * @interface UsersApiUsersRetrieveRequest */ export interface UsersApiUsersRetrieveRequest { /** * * @type {string} * @memberof UsersApiUsersRetrieve */ readonly username: string; } /** * Request parameters for usersUpdate operation in UsersApi. * @export * @interface UsersApiUsersUpdateRequest */ export interface UsersApiUsersUpdateRequest { /** * * @type {string} * @memberof UsersApiUsersUpdate */ readonly username: string; /** * * @type {UserRequest} * @memberof UsersApiUsersUpdate */ readonly UserRequest: UserRequest; } /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export declare class UsersApi extends BaseAPI { /** * View for users * @param {UsersApiUsersCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersCreate(requestParameters: UsersApiUsersCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for users * @param {UsersApiUsersDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersDestroy(requestParameters: UsersApiUsersDestroyRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for users * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersList(options?: RawAxiosRequestConfig): Promise>; /** * User retrieve and update viewsets for the current user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersMeRetrieve(options?: RawAxiosRequestConfig): Promise>; /** * View for users * @param {UsersApiUsersPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersPartialUpdate(requestParameters: UsersApiUsersPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for users * @param {UsersApiUsersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersRetrieve(requestParameters: UsersApiUsersRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for users * @param {UsersApiUsersUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ usersUpdate(requestParameters: UsersApiUsersUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * VectorContentFilesSearchApi - axios parameter creator * @export */ export declare const VectorContentFilesSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Vector Search for content * @summary Content File Vector Search * @param {Array} [aggregations] aggregations for facet counts * `key` - Key * `course_number` - Course Number * `platform` - Platform * `offered_by` - Offered By * `file_extension` - File Extension * `content_feature_type` - Content Feature Type * `run_readable_id` - Run Readable Id * `resource_readable_id` - Resource Readable Id * `run_title` - Run Title * `edx_module_id` - Edx Module Id * `content_type` - Content Type * `description` - Description * `title` - Title * `url` - Url * `file_type` - File Type * `summary` - Summary * `flashcards` - Flashcards * `checksum` - Checksum * @param {string} [collection_name] Manually specify the name of the Qdrant collection to query * @param {Array} [edx_module_id] The edX module id of the content file * @param {Array} [file_extension] The extension of the content file. * @param {string} [group_by] The attribute to group results by * @param {number} [group_size] The number of chunks in each group. Only relevant when group_by is used * @param {boolean} [hybrid_search] Whether to use a hybrid search * @param {Array} [key] The filename of the content file * @param {number} [limit] Number of results to return per page * @param {Array} [offered_by] Offeror of the content file * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] platform(s) of the content file * @param {string} [q] The search text * @param {Array} [resource_readable_id] The readable_id value of the parent learning resource for the content file * @param {Array} [run_readable_id] The readable_id value of the run that the content file belongs to * @param {boolean | null} [title__isnull] Filter to content files where title is null/not null * @param {boolean | null} [url__isnull] Filter to content files where url is null/not null * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorContentFilesSearchRetrieve: (aggregations?: Array, collection_name?: string, edx_module_id?: Array, file_extension?: Array, group_by?: string, group_size?: number, hybrid_search?: boolean, key?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_readable_id?: Array, run_readable_id?: Array, title__isnull?: boolean | null, url__isnull?: boolean | null, options?: RawAxiosRequestConfig) => Promise; }; /** * VectorContentFilesSearchApi - functional programming interface * @export */ export declare const VectorContentFilesSearchApiFp: (configuration?: Configuration) => { /** * Vector Search for content * @summary Content File Vector Search * @param {Array} [aggregations] aggregations for facet counts * `key` - Key * `course_number` - Course Number * `platform` - Platform * `offered_by` - Offered By * `file_extension` - File Extension * `content_feature_type` - Content Feature Type * `run_readable_id` - Run Readable Id * `resource_readable_id` - Resource Readable Id * `run_title` - Run Title * `edx_module_id` - Edx Module Id * `content_type` - Content Type * `description` - Description * `title` - Title * `url` - Url * `file_type` - File Type * `summary` - Summary * `flashcards` - Flashcards * `checksum` - Checksum * @param {string} [collection_name] Manually specify the name of the Qdrant collection to query * @param {Array} [edx_module_id] The edX module id of the content file * @param {Array} [file_extension] The extension of the content file. * @param {string} [group_by] The attribute to group results by * @param {number} [group_size] The number of chunks in each group. Only relevant when group_by is used * @param {boolean} [hybrid_search] Whether to use a hybrid search * @param {Array} [key] The filename of the content file * @param {number} [limit] Number of results to return per page * @param {Array} [offered_by] Offeror of the content file * @param {number} [offset] The initial index from which to return the results * @param {Array} [platform] platform(s) of the content file * @param {string} [q] The search text * @param {Array} [resource_readable_id] The readable_id value of the parent learning resource for the content file * @param {Array} [run_readable_id] The readable_id value of the run that the content file belongs to * @param {boolean | null} [title__isnull] Filter to content files where title is null/not null * @param {boolean | null} [url__isnull] Filter to content files where url is null/not null * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorContentFilesSearchRetrieve(aggregations?: Array, collection_name?: string, edx_module_id?: Array, file_extension?: Array, group_by?: string, group_size?: number, hybrid_search?: boolean, key?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_readable_id?: Array, run_readable_id?: Array, title__isnull?: boolean | null, url__isnull?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VectorContentFilesSearchApi - factory interface * @export */ export declare const VectorContentFilesSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Vector Search for content * @summary Content File Vector Search * @param {VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorContentFilesSearchRetrieve(requestParameters?: VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for vectorContentFilesSearchRetrieve operation in VectorContentFilesSearchApi. * @export * @interface VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest */ export interface VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest { /** * aggregations for facet counts * `key` - Key * `course_number` - Course Number * `platform` - Platform * `offered_by` - Offered By * `file_extension` - File Extension * `content_feature_type` - Content Feature Type * `run_readable_id` - Run Readable Id * `resource_readable_id` - Resource Readable Id * `run_title` - Run Title * `edx_module_id` - Edx Module Id * `content_type` - Content Type * `description` - Description * `title` - Title * `url` - Url * `file_type` - File Type * `summary` - Summary * `flashcards` - Flashcards * `checksum` - Checksum * @type {Array<'key' | 'course_number' | 'platform' | 'offered_by' | 'file_extension' | 'content_feature_type' | 'run_readable_id' | 'resource_readable_id' | 'run_title' | 'edx_module_id' | 'content_type' | 'description' | 'title' | 'url' | 'file_type' | 'summary' | 'flashcards' | 'checksum'>} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly aggregations?: Array; /** * Manually specify the name of the Qdrant collection to query * @type {string} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly collection_name?: string; /** * The edX module id of the content file * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly edx_module_id?: Array; /** * The extension of the content file. * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly file_extension?: Array; /** * The attribute to group results by * @type {string} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly group_by?: string; /** * The number of chunks in each group. Only relevant when group_by is used * @type {number} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly group_size?: number; /** * Whether to use a hybrid search * @type {boolean} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly hybrid_search?: boolean; /** * The filename of the content file * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly key?: Array; /** * Number of results to return per page * @type {number} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly limit?: number; /** * Offeror of the content file * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly offset?: number; /** * platform(s) of the content file * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly platform?: Array; /** * The search text * @type {string} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly q?: string; /** * The readable_id value of the parent learning resource for the content file * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly resource_readable_id?: Array; /** * The readable_id value of the run that the content file belongs to * @type {Array} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly run_readable_id?: Array; /** * Filter to content files where title is null/not null * @type {boolean} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly title__isnull?: boolean | null; /** * Filter to content files where url is null/not null * @type {boolean} * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve */ readonly url__isnull?: boolean | null; } /** * VectorContentFilesSearchApi - object-oriented interface * @export * @class VectorContentFilesSearchApi * @extends {BaseAPI} */ export declare class VectorContentFilesSearchApi extends BaseAPI { /** * Vector Search for content * @summary Content File Vector Search * @param {VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VectorContentFilesSearchApi */ vectorContentFilesSearchRetrieve(requestParameters?: VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const VectorContentFilesSearchRetrieveAggregationsEnum: { readonly Key: "key"; readonly CourseNumber: "course_number"; readonly Platform: "platform"; readonly OfferedBy: "offered_by"; readonly FileExtension: "file_extension"; readonly ContentFeatureType: "content_feature_type"; readonly RunReadableId: "run_readable_id"; readonly ResourceReadableId: "resource_readable_id"; readonly RunTitle: "run_title"; readonly EdxModuleId: "edx_module_id"; readonly ContentType: "content_type"; readonly Description: "description"; readonly Title: "title"; readonly Url: "url"; readonly FileType: "file_type"; readonly Summary: "summary"; readonly Flashcards: "flashcards"; readonly Checksum: "checksum"; }; export type VectorContentFilesSearchRetrieveAggregationsEnum = typeof VectorContentFilesSearchRetrieveAggregationsEnum[keyof typeof VectorContentFilesSearchRetrieveAggregationsEnum]; /** * VectorLearningResourcesSearchApi - axios parameter creator * @export */ export declare const VectorLearningResourcesSearchApiAxiosParamCreator: (configuration?: Configuration) => { /** * Vector Search for learning resources * @summary Vector Search * @param {Array} [aggregations] aggregations for facet counts * `readable_id` - Readable Id * `resource_type` - Resource Type * `certification` - Certification * `certification_type` - Certification Type * `professional` - Professional * `free` - Free * `course_feature` - Course Feature * `topic` - Topic * `ocw_topic` - Ocw Topic * `level` - Level * `department` - Department * `platform` - Platform * `offered_by` - Offered By * `delivery` - Delivery * `title` - Title * `url` - Url * `resource_type_group` - Resource Type Group * `resource_category` - Resource Category * `published` - Published * `next_start_date` - Next Start Date * `views` - Views * `created_on` - Created On * @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 {boolean} [hybrid_search] Whether to use a hybrid search * @param {Array} [level] * @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 {boolean | null} [professional] * @param {boolean} [published] If the resource is published. We default to True unless passed in * @param {string} [q] The search text * @param {string} [readable_id] The readable id of 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] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {number} [score_cutoff] The minimum score a result must have to be returned. Defaults to 0.0 when omitted, but the server clamps the effective cutoff to the minimum allowed for the selected search mode (dense or hybrid). * @param {VectorLearningResourcesSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `next_start_date` - next_start_date * `views` - views * `created_on` - created_on * `-next_start_date` - -next_start_date * `-views` - -views * `-created_on` - -created_on * @param {boolean | null} [title__isnull] Filter to learning resources where title is null/not null * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {boolean | null} [url__isnull] Filter to learning resources where url is null/not null * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorLearningResourcesSearchRetrieve: (aggregations?: Array, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, hybrid_search?: boolean, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, published?: boolean, q?: string, readable_id?: string, resource_type?: Array, resource_type_group?: Array, score_cutoff?: number, sortby?: VectorLearningResourcesSearchRetrieveSortbyEnum, title__isnull?: boolean | null, topic?: Array, url__isnull?: boolean | null, options?: RawAxiosRequestConfig) => Promise; }; /** * VectorLearningResourcesSearchApi - functional programming interface * @export */ export declare const VectorLearningResourcesSearchApiFp: (configuration?: Configuration) => { /** * Vector Search for learning resources * @summary Vector Search * @param {Array} [aggregations] aggregations for facet counts * `readable_id` - Readable Id * `resource_type` - Resource Type * `certification` - Certification * `certification_type` - Certification Type * `professional` - Professional * `free` - Free * `course_feature` - Course Feature * `topic` - Topic * `ocw_topic` - Ocw Topic * `level` - Level * `department` - Department * `platform` - Platform * `offered_by` - Offered By * `delivery` - Delivery * `title` - Title * `url` - Url * `resource_type_group` - Resource Type Group * `resource_category` - Resource Category * `published` - Published * `next_start_date` - Next Start Date * `views` - Views * `created_on` - Created On * @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 {boolean} [hybrid_search] Whether to use a hybrid search * @param {Array} [level] * @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 {boolean | null} [professional] * @param {boolean} [published] If the resource is published. We default to True unless passed in * @param {string} [q] The search text * @param {string} [readable_id] The readable id of 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] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @param {number} [score_cutoff] The minimum score a result must have to be returned. Defaults to 0.0 when omitted, but the server clamps the effective cutoff to the minimum allowed for the selected search mode (dense or hybrid). * @param {VectorLearningResourcesSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `next_start_date` - next_start_date * `views` - views * `created_on` - created_on * `-next_start_date` - -next_start_date * `-views` - -views * `-created_on` - -created_on * @param {boolean | null} [title__isnull] Filter to learning resources where title is null/not null * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ * @param {boolean | null} [url__isnull] Filter to learning resources where url is null/not null * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorLearningResourcesSearchRetrieve(aggregations?: Array, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, hybrid_search?: boolean, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, published?: boolean, q?: string, readable_id?: string, resource_type?: Array, resource_type_group?: Array, score_cutoff?: number, sortby?: VectorLearningResourcesSearchRetrieveSortbyEnum, title__isnull?: boolean | null, topic?: Array, url__isnull?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VectorLearningResourcesSearchApi - factory interface * @export */ export declare const VectorLearningResourcesSearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Vector Search for learning resources * @summary Vector Search * @param {VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ vectorLearningResourcesSearchRetrieve(requestParameters?: VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for vectorLearningResourcesSearchRetrieve operation in VectorLearningResourcesSearchApi. * @export * @interface VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest */ export interface VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest { /** * aggregations for facet counts * `readable_id` - Readable Id * `resource_type` - Resource Type * `certification` - Certification * `certification_type` - Certification Type * `professional` - Professional * `free` - Free * `course_feature` - Course Feature * `topic` - Topic * `ocw_topic` - Ocw Topic * `level` - Level * `department` - Department * `platform` - Platform * `offered_by` - Offered By * `delivery` - Delivery * `title` - Title * `url` - Url * `resource_type_group` - Resource Type Group * `resource_category` - Resource Category * `published` - Published * `next_start_date` - Next Start Date * `views` - Views * `created_on` - Created On * @type {Array<'readable_id' | 'resource_type' | 'certification' | 'certification_type' | 'professional' | 'free' | 'course_feature' | 'topic' | 'ocw_topic' | 'level' | 'department' | 'platform' | 'offered_by' | 'delivery' | 'title' | 'url' | 'resource_type_group' | 'resource_category' | 'published' | 'next_start_date' | 'views' | 'created_on'>} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly aggregations?: Array; /** * True if the learning resource offers a certificate * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly certification_type?: Array; /** * The course feature. Possible options are at api/v1/course_features/ * @type {Array} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly department?: Array; /** * * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly free?: boolean | null; /** * Whether to use a hybrid search * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly hybrid_search?: boolean; /** * * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly level?: Array; /** * Number of results to return per page * @type {number} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly limit?: number; /** * The ocw topic name. * @type {Array} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly offered_by?: Array; /** * The initial index from which to return the results * @type {number} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly platform?: Array; /** * * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly professional?: boolean | null; /** * If the resource is published. We default to True unless passed in * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly published?: boolean; /** * The search text * @type {string} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly q?: string; /** * The readable id of the resource * @type {string} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly readable_id?: string; /** * 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 VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly resource_type?: Array; /** * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material * @type {Array<'course' | 'program' | 'learning_material'>} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly resource_type_group?: Array; /** * The minimum score a result must have to be returned. Defaults to 0.0 when omitted, but the server clamps the effective cutoff to the minimum allowed for the selected search mode (dense or hybrid). * @type {number} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly score_cutoff?: number; /** * if the parameter starts with \'-\' the sort is in descending order * `next_start_date` - next_start_date * `views` - views * `created_on` - created_on * `-next_start_date` - -next_start_date * `-views` - -views * `-created_on` - -created_on * @type {'next_start_date' | 'views' | 'created_on' | '-next_start_date' | '-views' | '-created_on'} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly sortby?: VectorLearningResourcesSearchRetrieveSortbyEnum; /** * Filter to learning resources where title is null/not null * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly title__isnull?: boolean | null; /** * The topic name. To see a list of options go to api/v1/topics/ * @type {Array} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly topic?: Array; /** * Filter to learning resources where url is null/not null * @type {boolean} * @memberof VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieve */ readonly url__isnull?: boolean | null; } /** * VectorLearningResourcesSearchApi - object-oriented interface * @export * @class VectorLearningResourcesSearchApi * @extends {BaseAPI} */ export declare class VectorLearningResourcesSearchApi extends BaseAPI { /** * Vector Search for learning resources * @summary Vector Search * @param {VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VectorLearningResourcesSearchApi */ vectorLearningResourcesSearchRetrieve(requestParameters?: VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const VectorLearningResourcesSearchRetrieveAggregationsEnum: { readonly ReadableId: "readable_id"; readonly ResourceType: "resource_type"; readonly Certification: "certification"; readonly CertificationType: "certification_type"; readonly Professional: "professional"; readonly Free: "free"; readonly CourseFeature: "course_feature"; readonly Topic: "topic"; readonly OcwTopic: "ocw_topic"; readonly Level: "level"; readonly Department: "department"; readonly Platform: "platform"; readonly OfferedBy: "offered_by"; readonly Delivery: "delivery"; readonly Title: "title"; readonly Url: "url"; readonly ResourceTypeGroup: "resource_type_group"; readonly ResourceCategory: "resource_category"; readonly Published: "published"; readonly NextStartDate: "next_start_date"; readonly Views: "views"; readonly CreatedOn: "created_on"; }; export type VectorLearningResourcesSearchRetrieveAggregationsEnum = typeof VectorLearningResourcesSearchRetrieveAggregationsEnum[keyof typeof VectorLearningResourcesSearchRetrieveAggregationsEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveCertificationTypeEnum: { readonly Micromasters: "micromasters"; readonly Professional: "professional"; readonly Completion: "completion"; readonly None: "none"; }; export type VectorLearningResourcesSearchRetrieveCertificationTypeEnum = typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum[keyof typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveDeliveryEnum: { readonly Online: "online"; readonly Hybrid: "hybrid"; readonly InPerson: "in_person"; readonly Offline: "offline"; }; export type VectorLearningResourcesSearchRetrieveDeliveryEnum = typeof VectorLearningResourcesSearchRetrieveDeliveryEnum[keyof typeof VectorLearningResourcesSearchRetrieveDeliveryEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveDepartmentEnum: { 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 VectorLearningResourcesSearchRetrieveDepartmentEnum = typeof VectorLearningResourcesSearchRetrieveDepartmentEnum[keyof typeof VectorLearningResourcesSearchRetrieveDepartmentEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveLevelEnum: { readonly Undergraduate: "undergraduate"; readonly Graduate: "graduate"; readonly HighSchool: "high_school"; readonly Noncredit: "noncredit"; readonly Advanced: "advanced"; readonly Intermediate: "intermediate"; readonly Introductory: "introductory"; }; export type VectorLearningResourcesSearchRetrieveLevelEnum = typeof VectorLearningResourcesSearchRetrieveLevelEnum[keyof typeof VectorLearningResourcesSearchRetrieveLevelEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveOfferedByEnum: { readonly Mitx: "mitx"; readonly Ocw: "ocw"; readonly Bootcamps: "bootcamps"; readonly Xpro: "xpro"; readonly Mitpe: "mitpe"; readonly See: "see"; readonly Climate: "climate"; }; export type VectorLearningResourcesSearchRetrieveOfferedByEnum = typeof VectorLearningResourcesSearchRetrieveOfferedByEnum[keyof typeof VectorLearningResourcesSearchRetrieveOfferedByEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrievePlatformEnum: { 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 VectorLearningResourcesSearchRetrievePlatformEnum = typeof VectorLearningResourcesSearchRetrievePlatformEnum[keyof typeof VectorLearningResourcesSearchRetrievePlatformEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveResourceTypeEnum: { 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 VectorLearningResourcesSearchRetrieveResourceTypeEnum = typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum: { readonly Course: "course"; readonly Program: "program"; readonly LearningMaterial: "learning_material"; }; export type VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum = typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum]; /** * @export */ export declare const VectorLearningResourcesSearchRetrieveSortbyEnum: { readonly NextStartDate: "next_start_date"; readonly Views: "views"; readonly CreatedOn: "created_on"; readonly NextStartDate2: "-next_start_date"; readonly Views2: "-views"; readonly CreatedOn2: "-created_on"; }; export type VectorLearningResourcesSearchRetrieveSortbyEnum = typeof VectorLearningResourcesSearchRetrieveSortbyEnum[keyof typeof VectorLearningResourcesSearchRetrieveSortbyEnum]; /** * WebsitesApi - axios parameter creator * @export */ export declare const WebsitesApiAxiosParamCreator: (configuration?: Configuration) => { /** * View for user websites * @param {UserWebsiteRequest} UserWebsiteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesCreate: (UserWebsiteRequest: UserWebsiteRequest, options?: RawAxiosRequestConfig) => Promise; /** * View for user websites * @param {number} id A unique integer value identifying this user website. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise; }; /** * WebsitesApi - functional programming interface * @export */ export declare const WebsitesApiFp: (configuration?: Configuration) => { /** * View for user websites * @param {UserWebsiteRequest} UserWebsiteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesCreate(UserWebsiteRequest: UserWebsiteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * View for user websites * @param {number} id A unique integer value identifying this user website. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebsitesApi - factory interface * @export */ export declare const WebsitesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * View for user websites * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesCreate(requestParameters: WebsitesApiWebsitesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * View for user websites * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ websitesDestroy(requestParameters: WebsitesApiWebsitesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for websitesCreate operation in WebsitesApi. * @export * @interface WebsitesApiWebsitesCreateRequest */ export interface WebsitesApiWebsitesCreateRequest { /** * * @type {UserWebsiteRequest} * @memberof WebsitesApiWebsitesCreate */ readonly UserWebsiteRequest: UserWebsiteRequest; } /** * Request parameters for websitesDestroy operation in WebsitesApi. * @export * @interface WebsitesApiWebsitesDestroyRequest */ export interface WebsitesApiWebsitesDestroyRequest { /** * A unique integer value identifying this user website. * @type {number} * @memberof WebsitesApiWebsitesDestroy */ readonly id: number; } /** * WebsitesApi - object-oriented interface * @export * @class WebsitesApi * @extends {BaseAPI} */ export declare class WebsitesApi extends BaseAPI { /** * View for user websites * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsitesApi */ websitesCreate(requestParameters: WebsitesApiWebsitesCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * View for user websites * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebsitesApi */ websitesDestroy(requestParameters: WebsitesApiWebsitesDestroyRequest, options?: RawAxiosRequestConfig): Promise>; } /** * WidgetListsApi - axios parameter creator * @export */ export declare const WidgetListsApiAxiosParamCreator: (configuration?: Configuration) => { /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {PatchedWidgetListRequest} [PatchedWidgetListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsPartialUpdate: (id: number, PatchedWidgetListRequest?: PatchedWidgetListRequest, options?: RawAxiosRequestConfig) => Promise; /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise; /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {WidgetListRequest} [WidgetListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsUpdate: (id: number, WidgetListRequest?: WidgetListRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * WidgetListsApi - functional programming interface * @export */ export declare const WidgetListsApiFp: (configuration?: Configuration) => { /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {PatchedWidgetListRequest} [PatchedWidgetListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsPartialUpdate(id: number, PatchedWidgetListRequest?: PatchedWidgetListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * API for managing widget lists * @param {number} id A unique integer value identifying this widget list. * @param {WidgetListRequest} [WidgetListRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsUpdate(id: number, WidgetListRequest?: WidgetListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WidgetListsApi - factory interface * @export */ export declare const WidgetListsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * API for managing widget lists * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsPartialUpdate(requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * API for managing widget lists * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsRetrieve(requestParameters: WidgetListsApiWidgetListsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * API for managing widget lists * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ widgetListsUpdate(requestParameters: WidgetListsApiWidgetListsUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for widgetListsPartialUpdate operation in WidgetListsApi. * @export * @interface WidgetListsApiWidgetListsPartialUpdateRequest */ export interface WidgetListsApiWidgetListsPartialUpdateRequest { /** * A unique integer value identifying this widget list. * @type {number} * @memberof WidgetListsApiWidgetListsPartialUpdate */ readonly id: number; /** * * @type {PatchedWidgetListRequest} * @memberof WidgetListsApiWidgetListsPartialUpdate */ readonly PatchedWidgetListRequest?: PatchedWidgetListRequest; } /** * Request parameters for widgetListsRetrieve operation in WidgetListsApi. * @export * @interface WidgetListsApiWidgetListsRetrieveRequest */ export interface WidgetListsApiWidgetListsRetrieveRequest { /** * A unique integer value identifying this widget list. * @type {number} * @memberof WidgetListsApiWidgetListsRetrieve */ readonly id: number; } /** * Request parameters for widgetListsUpdate operation in WidgetListsApi. * @export * @interface WidgetListsApiWidgetListsUpdateRequest */ export interface WidgetListsApiWidgetListsUpdateRequest { /** * A unique integer value identifying this widget list. * @type {number} * @memberof WidgetListsApiWidgetListsUpdate */ readonly id: number; /** * * @type {WidgetListRequest} * @memberof WidgetListsApiWidgetListsUpdate */ readonly WidgetListRequest?: WidgetListRequest; } /** * WidgetListsApi - object-oriented interface * @export * @class WidgetListsApi * @extends {BaseAPI} */ export declare class WidgetListsApi extends BaseAPI { /** * API for managing widget lists * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WidgetListsApi */ widgetListsPartialUpdate(requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, options?: RawAxiosRequestConfig): Promise>; /** * API for managing widget lists * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WidgetListsApi */ widgetListsRetrieve(requestParameters: WidgetListsApiWidgetListsRetrieveRequest, options?: RawAxiosRequestConfig): Promise>; /** * API for managing widget lists * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WidgetListsApi */ widgetListsUpdate(requestParameters: WidgetListsApiWidgetListsUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } //# sourceMappingURL=api.d.ts.map