From 42a155e50764a7b7ae2b1a49191940cf57bee156 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 05:32:42 +0000 Subject: [PATCH 1/2] Lock file maintenance --- poetry.lock | 6 +- src/typescript/mit-learn-api-axios/yarn.lock | 125 ++++++++++++------- 2 files changed, 85 insertions(+), 46 deletions(-) diff --git a/poetry.lock b/poetry.lock index 9303b41..1beebc2 100644 --- a/poetry.lock +++ b/poetry.lock @@ -20,13 +20,13 @@ toml = "*" [[package]] name = "click" -version = "8.3.0" +version = "8.4.1" description = "Composable command line interface toolkit" optional = false python-versions = ">=3.10" files = [ - {file = "click-8.3.0-py3-none-any.whl", hash = "sha256:9b9f285302c6e3064f4330c05f05b81945b2a39544279343e6e7c5f27a9baddc"}, - {file = "click-8.3.0.tar.gz", hash = "sha256:e7b8232224eba16f4ebe410c25ced9f7875cb5f3263ffc93cc3e8da705e229c4"}, + {file = "click-8.4.1-py3-none-any.whl", hash = "sha256:482be17c6991b8c19c5429a1e995d9b0efdbb63172824c41f99965dc0ade8ec2"}, + {file = "click-8.4.1.tar.gz", hash = "sha256:918b5633eddf6b41c32d4f454bf0de810065c74e3f7dbf8ee5452f8be88d3e96"}, ] [package.dependencies] diff --git a/src/typescript/mit-learn-api-axios/yarn.lock b/src/typescript/mit-learn-api-axios/yarn.lock index aefaf24..4794258 100644 --- a/src/typescript/mit-learn-api-axios/yarn.lock +++ b/src/typescript/mit-learn-api-axios/yarn.lock @@ -50,9 +50,9 @@ __metadata: linkType: soft "@tsconfig/node10@npm:^1.0.7": - version: 1.0.11 - resolution: "@tsconfig/node10@npm:1.0.11" - checksum: 10c0/28a0710e5d039e0de484bdf85fee883bfd3f6a8980601f4d44066b0a6bcd821d31c4e231d1117731c4e24268bd4cf2a788a6787c12fc7f8d11014c07d582783c + version: 1.0.12 + resolution: "@tsconfig/node10@npm:1.0.12" + checksum: 10c0/7bbbd7408cfaced86387a9b1b71cebc91c6fd701a120369735734da8eab1a4773fc079abd9f40c9e0b049e12586c8ac0e13f0da596bfd455b9b4c3faa813ebc5 languageName: node linkType: hard @@ -78,29 +78,38 @@ __metadata: linkType: hard "@types/node@npm:^22.0.0": - version: 22.19.0 - resolution: "@types/node@npm:22.19.0" + version: 22.20.0 + resolution: "@types/node@npm:22.20.0" dependencies: undici-types: "npm:~6.21.0" - checksum: 10c0/66b98fcd38efb4ae58c628d61fed2b8f17c830eb665d8bceabc4174cae1dd81b8e4caac4c70d7dc929f9f76a3dc46cb21f480e904d0b898297bd12c0a2d1571a + checksum: 10c0/55d78223205bd5f81f043d71b7a5c8d8854b9ef44ef81291680943adb27fa5ba1f092658c87183d5bc8cf6baf6a57b81dad966eb3afa452cc301a615b6d9b20e languageName: node linkType: hard "acorn-walk@npm:^8.1.1": - version: 8.3.4 - resolution: "acorn-walk@npm:8.3.4" + version: 8.3.5 + resolution: "acorn-walk@npm:8.3.5" dependencies: acorn: "npm:^8.11.0" - checksum: 10c0/76537ac5fb2c37a64560feaf3342023dadc086c46da57da363e64c6148dc21b57d49ace26f949e225063acb6fb441eabffd89f7a3066de5ad37ab3e328927c62 + checksum: 10c0/e31bf5b5423ed1349437029d66d708b9fbd1b77a644b031501e2c753b028d13b56348210ed901d5b1d0d86eb3381c0a0fc0d0998511a9d546d1194936266a332 languageName: node linkType: hard "acorn@npm:^8.11.0, acorn@npm:^8.4.1": - version: 8.15.0 - resolution: "acorn@npm:8.15.0" + version: 8.17.0 + resolution: "acorn@npm:8.17.0" bin: acorn: bin/acorn - checksum: 10c0/dec73ff59b7d6628a01eebaece7f2bdb8bb62b9b5926dcad0f8931f2b8b79c2be21f6c68ac095592adb5adb15831a3635d9343e6a91d028bbe85d564875ec3ec + checksum: 10c0/5dcefea5f8f023b6cc24cbe71fb5a8112b601d36c4fa07d14e4e6ffc2ee47383332c46b36c766d9437725aa6660156eae50efa0c838719823b50d7c327c4ed42 + languageName: node + linkType: hard + +"agent-base@npm:6": + version: 6.0.2 + resolution: "agent-base@npm:6.0.2" + dependencies: + debug: "npm:4" + checksum: 10c0/dc4f757e40b5f3e3d674bc9beb4f1048f4ee83af189bae39be99f57bf1f48dde166a8b0a5342a84b5944ee8e6ed1e5a9d801858f4ad44764e84957122fe46261 languageName: node linkType: hard @@ -133,13 +142,14 @@ __metadata: linkType: hard "axios@npm:^1.6.5": - version: 1.13.2 - resolution: "axios@npm:1.13.2" + version: 1.18.1 + resolution: "axios@npm:1.18.1" dependencies: - follow-redirects: "npm:^1.15.6" - form-data: "npm:^4.0.4" - proxy-from-env: "npm:^1.1.0" - checksum: 10c0/e8a42e37e5568ae9c7a28c348db0e8cf3e43d06fcbef73f0048669edfe4f71219664da7b6cc991b0c0f01c28a48f037c515263cb79be1f1ae8ff034cd813867b + follow-redirects: "npm:^1.16.0" + form-data: "npm:^4.0.5" + https-proxy-agent: "npm:^5.0.1" + proxy-from-env: "npm:^2.1.0" + checksum: 10c0/9d9378a3af0d0ad730a52ad9d15ec7201f3926ad6e7e8bbffc5ae21ca2835ad11d1d9598698f5dd9718917486039f55ea1d7dc23d8e44fa827a55cc3262c02fc languageName: node linkType: hard @@ -169,6 +179,18 @@ __metadata: languageName: node linkType: hard +"debug@npm:4": + version: 4.4.3 + resolution: "debug@npm:4.4.3" + dependencies: + ms: "npm:^2.1.3" + peerDependenciesMeta: + supports-color: + optional: true + checksum: 10c0/d79136ec6c83ecbefd0f6a5593da6a9c91ec4d7ddc4b54c883d6e71ec9accb5f67a1a5e96d00a328196b5b5c86d365e98d8a3a70856aaf16b4e7b1985e67f5a6 + languageName: node + linkType: hard + "delayed-stream@npm:~1.0.0": version: 1.0.0 resolution: "delayed-stream@npm:1.0.0" @@ -177,9 +199,9 @@ __metadata: linkType: hard "diff@npm:^4.0.1": - version: 4.0.2 - resolution: "diff@npm:4.0.2" - checksum: 10c0/81b91f9d39c4eaca068eb0c1eb0e4afbdc5bb2941d197f513dd596b820b956fef43485876226d65d497bebc15666aa2aa82c679e84f65d5f2bfbf14ee46e32c1 + version: 4.0.4 + resolution: "diff@npm:4.0.4" + checksum: 10c0/855fb70b093d1d9643ddc12ea76dca90dc9d9cdd7f82c08ee8b9325c0dc5748faf3c82e2047ced5dcaa8b26e58f7903900be2628d0380a222c02d79d8de385df languageName: node linkType: hard @@ -209,11 +231,11 @@ __metadata: linkType: hard "es-object-atoms@npm:^1.0.0, es-object-atoms@npm:^1.1.1": - version: 1.1.1 - resolution: "es-object-atoms@npm:1.1.1" + version: 1.1.2 + resolution: "es-object-atoms@npm:1.1.2" dependencies: es-errors: "npm:^1.3.0" - checksum: 10c0/65364812ca4daf48eb76e2a3b7a89b3f6a2e62a1c420766ce9f692665a29d94fe41fe88b65f24106f449859549711e4b40d9fb8002d862dfd7eb1c512d10be0c + checksum: 10c0/1772861f094f739d6f41b579cfb9a18579daffeb434552a370a5fbef50a32d22227e27b63fdbb757b7ddd429d1b42fe52ccae7966d9302a2ec221b6f1b41bbc4 languageName: node linkType: hard @@ -229,26 +251,26 @@ __metadata: languageName: node linkType: hard -"follow-redirects@npm:^1.15.6": - version: 1.15.11 - resolution: "follow-redirects@npm:1.15.11" +"follow-redirects@npm:^1.16.0": + version: 1.16.0 + resolution: "follow-redirects@npm:1.16.0" peerDependenciesMeta: debug: optional: true - checksum: 10c0/d301f430542520a54058d4aeeb453233c564aaccac835d29d15e050beb33f339ad67d9bddbce01739c5dc46a6716dbe3d9d0d5134b1ca203effa11a7ef092343 + checksum: 10c0/a1e2900163e6f1b4d1ed5c221b607f41decbab65534c63fe7e287e40a5d552a6496e7d9d7d976fa4ba77b4c51c11e5e9f683f10b43011ea11e442ff128d0e181 languageName: node linkType: hard -"form-data@npm:^4.0.4": - version: 4.0.4 - resolution: "form-data@npm:4.0.4" +"form-data@npm:^4.0.5": + version: 4.0.6 + resolution: "form-data@npm:4.0.6" dependencies: asynckit: "npm:^0.4.0" combined-stream: "npm:^1.0.8" es-set-tostringtag: "npm:^2.1.0" - hasown: "npm:^2.0.2" - mime-types: "npm:^2.1.12" - checksum: 10c0/373525a9a034b9d57073e55eab79e501a714ffac02e7a9b01be1c820780652b16e4101819785e1e18f8d98f0aee866cc654d660a435c378e16a72f2e7cac9695 + hasown: "npm:^2.0.4" + mime-types: "npm:^2.1.35" + checksum: 10c0/43947a77bf0ff45c6ceed789778982d47a3f3e720a74b71721174ebf3310a5f1a8be1d6b38a3ee3688e8a18a2c4273073ec0844cd37efda3eaf46d41c9c318ff languageName: node linkType: hard @@ -320,12 +342,22 @@ __metadata: languageName: node linkType: hard -"hasown@npm:^2.0.2": - version: 2.0.2 - resolution: "hasown@npm:2.0.2" +"hasown@npm:^2.0.2, hasown@npm:^2.0.4": + version: 2.0.4 + resolution: "hasown@npm:2.0.4" dependencies: function-bind: "npm:^1.1.2" - checksum: 10c0/3769d434703b8ac66b209a4cca0737519925bbdb61dd887f93a16372b14694c63ff4e797686d87c90f08168e81082248b9b028bad60d4da9e0d1148766f56eb9 + checksum: 10c0/2d8de939e270b70618f8cebb69746620db10617dbb495bc66ddad326955ea24d3ca4af133aff3eb7c1853e0218f867bc2b050ec26fe02e3aea58f880ffc5e506 + languageName: node + linkType: hard + +"https-proxy-agent@npm:^5.0.1": + version: 5.0.1 + resolution: "https-proxy-agent@npm:5.0.1" + dependencies: + agent-base: "npm:6" + debug: "npm:4" + checksum: 10c0/6dd639f03434003577c62b27cafdb864784ef19b2de430d8ae2a1d45e31c4fd60719e5637b44db1a88a046934307da7089e03d6089ec3ddacc1189d8de8897d1 languageName: node linkType: hard @@ -350,7 +382,7 @@ __metadata: languageName: node linkType: hard -"mime-types@npm:^2.1.12": +"mime-types@npm:^2.1.35": version: 2.1.35 resolution: "mime-types@npm:2.1.35" dependencies: @@ -359,10 +391,17 @@ __metadata: languageName: node linkType: hard -"proxy-from-env@npm:^1.1.0": - version: 1.1.0 - resolution: "proxy-from-env@npm:1.1.0" - checksum: 10c0/fe7dd8b1bdbbbea18d1459107729c3e4a2243ca870d26d34c2c1bcd3e4425b7bcc5112362df2d93cc7fb9746f6142b5e272fd1cc5c86ddf8580175186f6ad42b +"ms@npm:^2.1.3": + version: 2.1.3 + resolution: "ms@npm:2.1.3" + checksum: 10c0/d924b57e7312b3b63ad21fc5b3dc0af5e78d61a1fc7cfb5457edaf26326bf62be5307cc87ffb6862ef1c2b33b0233cdb5d4f01c4c958cc0d660948b65a287a48 + languageName: node + linkType: hard + +"proxy-from-env@npm:^2.1.0": + version: 2.1.0 + resolution: "proxy-from-env@npm:2.1.0" + checksum: 10c0/ed01729fd4d094eab619cd7e17ce3698b3413b31eb102c4904f9875e677cd207392795d5b4adee9cec359dfd31c44d5ad7595a3a3ad51c40250e141512281c58 languageName: node linkType: hard From d791b0ee5d11d54a6386414db6702fd57a4a937b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 05:33:06 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../src/v0/.openapi-generator/VERSION | 2 +- .../mit-learn-api-axios/src/v0/api.ts | 19549 +++--- .../mit-learn-api-axios/src/v0/base.ts | 65 +- .../mit-learn-api-axios/src/v0/common.ts | 194 +- .../src/v0/configuration.ts | 202 +- .../mit-learn-api-axios/src/v0/index.ts | 8 +- .../src/v1/.openapi-generator/VERSION | 2 +- .../mit-learn-api-axios/src/v1/api.ts | 55216 +++++++++------- .../mit-learn-api-axios/src/v1/base.ts | 65 +- .../mit-learn-api-axios/src/v1/common.ts | 194 +- .../src/v1/configuration.ts | 202 +- .../mit-learn-api-axios/src/v1/index.ts | 8 +- 12 files changed, 42186 insertions(+), 33521 deletions(-) diff --git a/src/typescript/mit-learn-api-axios/src/v0/.openapi-generator/VERSION b/src/typescript/mit-learn-api-axios/src/v0/.openapi-generator/VERSION index 4b49d9b..0ee843c 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/.openapi-generator/VERSION +++ b/src/typescript/mit-learn-api-axios/src/v0/.openapi-generator/VERSION @@ -1 +1 @@ -7.2.0 \ No newline at end of file +7.2.0 diff --git a/src/typescript/mit-learn-api-axios/src/v0/api.ts b/src/typescript/mit-learn-api-axios/src/v0/api.ts index ff6682d..480c8e4 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/api.ts +++ b/src/typescript/mit-learn-api-axios/src/v0/api.ts @@ -5,23 +5,39 @@ * 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 globalAxios from 'axios'; +import type { Configuration } from "./configuration" +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios" +import globalAxios from "axios" // Some imports not used depending on template conditions // @ts-ignore -import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; -import type { RequestArgs } from './base'; +import { + DUMMY_BASE_URL, + assertParamExists, + setApiKeyToObject, + setBasicAuthToObject, + setBearerAuthToObject, + setOAuthToObject, + setSearchParams, + serializeDataIfNeeded, + toPathString, + createRequestFunction, +} from "./common" +import type { RequestArgs } from "./base" // @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; +import { + BASE_PATH, + COLLECTION_FORMATS, + BaseAPI, + RequiredError, + operationServerMap, +} from "./base" /** * Serializer for attestations. @@ -29,90 +45,90 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM * @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; + /** + * + * @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 @@ -121,31 +137,30 @@ export interface Attestation { */ export const AvailabilityEnum = { - /** - * Dated - */ - Dated: 'dated', - /** - * Anytime - */ - Anytime: 'anytime' -} as const; - -export type AvailabilityEnum = typeof AvailabilityEnum[keyof typeof AvailabilityEnum]; + /** + * Dated + */ + Dated: "dated", + /** + * Anytime + */ + Anytime: "anytime", +} as const +export type AvailabilityEnum = + (typeof AvailabilityEnum)[keyof typeof AvailabilityEnum] /** - * + * * @export * @enum {string} */ export const BlankEnum = { - Empty: '' -} as const; - -export type BlankEnum = typeof BlankEnum[keyof typeof BlankEnum]; + Empty: "", +} as const +export type BlankEnum = (typeof BlankEnum)[keyof typeof BlankEnum] /** * Serializer for CKEditor settings @@ -153,12 +168,12 @@ export type BlankEnum = typeof BlankEnum[keyof typeof BlankEnum]; * @interface CKEditorSettings */ export interface CKEditorSettings { - /** - * Get the JWT token - * @type {string} - * @memberof CKEditorSettings - */ - 'token': string | null; + /** + * Get the JWT token + * @type {string} + * @memberof CKEditorSettings + */ + token: string | null } /** * Serializer for caption URL entries @@ -166,24 +181,24 @@ export interface CKEditorSettings { * @interface CaptionUrl */ export interface CaptionUrl { - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'language': string; - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'language_name': string; - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'url': string; + /** + * + * @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 @@ -192,28 +207,32 @@ export interface CaptionUrl { */ export const CertificateDesiredEnum = { - /** - * Yes, I am looking for a certificate - */ - Yes: 'yes', - /** - * No, I am not looking for a certificate - */ - No: 'no', - /** - * Not Sure - */ - NotSureYet: 'not-sure-yet' -} as const; - -export type CertificateDesiredEnum = typeof CertificateDesiredEnum[keyof typeof CertificateDesiredEnum]; - + /** + * Yes, I am looking for a certificate + */ + Yes: "yes", + /** + * No, I am not looking for a certificate + */ + No: "no", + /** + * Not Sure + */ + NotSureYet: "not-sure-yet", +} as const + +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; +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 @@ -221,75 +240,74 @@ export type Channel = { channel_type: 'department' } & DepartmentChannel | { cha * @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; + /** + * + * @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 } - /** * Serializer for the ChannelDepartmentDetail model * @export * @interface ChannelDepartmentDetail */ export interface ChannelDepartmentDetail { - /** - * - * @type {string} - * @memberof ChannelDepartmentDetail - */ - 'department'?: string | null; + /** + * + * @type {string} + * @memberof ChannelDepartmentDetail + */ + department?: string | null } /** * Serializer for the ChannelTopicDetail model @@ -297,12 +315,12 @@ export interface ChannelDepartmentDetail { * @interface ChannelTopicDetail */ export interface ChannelTopicDetail { - /** - * - * @type {number} - * @memberof ChannelTopicDetail - */ - 'topic'?: number | null; + /** + * + * @type {number} + * @memberof ChannelTopicDetail + */ + topic?: number | null } /** * * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway @@ -311,26 +329,26 @@ export interface ChannelTopicDetail { */ export const ChannelTypeEnum = { - /** - * Topic - */ - Topic: 'topic', - /** - * Department - */ - Department: 'department', - /** - * Unit - */ - Unit: 'unit', - /** - * Pathway - */ - Pathway: 'pathway' -} as const; - -export type ChannelTypeEnum = typeof ChannelTypeEnum[keyof typeof ChannelTypeEnum]; - + /** + * Topic + */ + Topic: "topic", + /** + * Department + */ + Department: "department", + /** + * Unit + */ + Unit: "unit", + /** + * Pathway + */ + Pathway: "pathway", +} as const + +export type ChannelTypeEnum = + (typeof ChannelTypeEnum)[keyof typeof ChannelTypeEnum] /** * Serializer for the ChannelOfferorDetail model @@ -338,12 +356,12 @@ export type ChannelTypeEnum = typeof ChannelTypeEnum[keyof typeof ChannelTypeEnu * @interface ChannelUnitDetail */ export interface ChannelUnitDetail { - /** - * - * @type {LearningResourceOfferorDetail} - * @memberof ChannelUnitDetail - */ - 'unit': LearningResourceOfferorDetail; + /** + * + * @type {LearningResourceOfferorDetail} + * @memberof ChannelUnitDetail + */ + unit: LearningResourceOfferorDetail } /** * Serializer class for course run ContentFiles @@ -351,299 +369,302 @@ export interface ChannelUnitDetail { * @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; + /** + * + * @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; + /** + * + * @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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof ContentFileVectorSearchResponseMetadataAggregationsValueInner + */ + key: string + /** + * + * @type {number} + * @memberof ContentFileVectorSearchResponseMetadataAggregationsValueInner + */ + doc_count: number } /** * * `page` - page * `file` - file * `video` - video * `pdf` - pdf @@ -652,45 +673,45 @@ export interface ContentFileVectorSearchResponseMetadataAggregationsValueInner { */ export const ContentTypeEnum = { - /** - * page - */ - Page: 'page', - /** - * file - */ - File: 'file', - /** - * video - */ - Video: 'video', - /** - * pdf - */ - Pdf: 'pdf' -} as const; - -export type ContentTypeEnum = typeof ContentTypeEnum[keyof typeof ContentTypeEnum]; - + /** + * page + */ + Page: "page", + /** + * file + */ + File: "file", + /** + * video + */ + Video: "video", + /** + * pdf + */ + Pdf: "pdf", +} as const + +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; + /** + * + * @type {number} + * @memberof Counts + */ + courses: number + /** + * + * @type {number} + * @memberof Counts + */ + programs: number } /** * Serializer for the Course model @@ -698,12 +719,12 @@ export interface Counts { * @interface Course */ export interface Course { - /** - * - * @type {Array} - * @memberof Course - */ - 'course_numbers': Array | null; + /** + * + * @type {Array} + * @memberof Course + */ + course_numbers: Array | null } /** * Serializer for CourseNumber @@ -711,24 +732,24 @@ export interface Course { * @interface CourseNumber */ export interface CourseNumber { - /** - * - * @type {string} - * @memberof CourseNumber - */ - 'value': string; - /** - * - * @type {LearningResourceDepartment} - * @memberof CourseNumber - */ - 'department': LearningResourceDepartment; - /** - * - * @type {string} - * @memberof CourseNumber - */ - 'listing_type': string; + /** + * + * @type {string} + * @memberof CourseNumber + */ + value: string + /** + * + * @type {LearningResourceDepartment} + * @memberof CourseNumber + */ + department: LearningResourceDepartment + /** + * + * @type {string} + * @memberof CourseNumber + */ + listing_type: string } /** * Serializer for course resources @@ -736,421 +757,424 @@ export interface CourseNumber { * @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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof CourseResourceCertificationType + */ + code: CourseResourceCertificationTypeCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceCertificationType + */ + name: string } export const CourseResourceCertificationTypeCodeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const -export type CourseResourceCertificationTypeCodeEnum = typeof CourseResourceCertificationTypeCodeEnum[keyof typeof CourseResourceCertificationTypeCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourceDeliveryInner + */ + code: CourseResourceDeliveryInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceDeliveryInner + */ + name: string } export const CourseResourceDeliveryInnerCodeEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const -export type CourseResourceDeliveryInnerCodeEnum = typeof CourseResourceDeliveryInnerCodeEnum[keyof typeof CourseResourceDeliveryInnerCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourceFormatInner + */ + code: CourseResourceFormatInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceFormatInner + */ + name: string } export const CourseResourceFormatInnerCodeEnum = { - Synchronous: 'synchronous', - Asynchronous: 'asynchronous' -} as const; + Synchronous: "synchronous", + Asynchronous: "asynchronous", +} as const -export type CourseResourceFormatInnerCodeEnum = typeof CourseResourceFormatInnerCodeEnum[keyof typeof CourseResourceFormatInnerCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourcePaceInner + */ + code: CourseResourcePaceInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourcePaceInner + */ + name: string } export const CourseResourcePaceInnerCodeEnum = { - SelfPaced: 'self_paced', - InstructorPaced: 'instructor_paced' -} as const; + SelfPaced: "self_paced", + InstructorPaced: "instructor_paced", +} as const -export type CourseResourcePaceInnerCodeEnum = typeof CourseResourcePaceInnerCodeEnum[keyof typeof CourseResourcePaceInnerCodeEnum]; +export type CourseResourcePaceInnerCodeEnum = + (typeof CourseResourcePaceInnerCodeEnum)[keyof typeof CourseResourcePaceInnerCodeEnum] /** - * + * * @export * @enum {string} */ export const CourseResourceResourceTypeEnum = { - Course: 'course' -} as const; - -export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEnum[keyof typeof CourseResourceResourceTypeEnum]; + Course: "course", +} as const +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 @@ -1159,42 +1183,43 @@ export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEn */ export const CurrentEducationEnum = { - /** - * Doctorate - */ - Doctorate: 'Doctorate', - /** - * Master's or professional degree - */ - MastersOrProfessionalDegree: 'Master\'s or professional degree', - /** - * Bachelor's degree - */ - BachelorsDegree: 'Bachelor\'s degree', - /** - * Associate degree - */ - AssociateDegree: 'Associate degree', - /** - * Secondary/high school - */ - SecondaryHighSchool: 'Secondary/high school', - /** - * Junior secondary/junior high/middle school - */ - JuniorSecondaryJuniorHighMiddleSchool: 'Junior secondary/junior high/middle school', - /** - * No formal education - */ - NoFormalEducation: 'No formal education', - /** - * Other education - */ - OtherEducation: 'Other education' -} as const; - -export type CurrentEducationEnum = typeof CurrentEducationEnum[keyof typeof CurrentEducationEnum]; - + /** + * Doctorate + */ + Doctorate: "Doctorate", + /** + * Master's or professional degree + */ + MastersOrProfessionalDegree: "Master's or professional degree", + /** + * Bachelor's degree + */ + BachelorsDegree: "Bachelor's degree", + /** + * Associate degree + */ + AssociateDegree: "Associate degree", + /** + * Secondary/high school + */ + SecondaryHighSchool: "Secondary/high school", + /** + * Junior secondary/junior high/middle school + */ + JuniorSecondaryJuniorHighMiddleSchool: + "Junior secondary/junior high/middle school", + /** + * No formal education + */ + NoFormalEducation: "No formal education", + /** + * Other education + */ + OtherEducation: "Other education", +} as const + +export type CurrentEducationEnum = + (typeof CurrentEducationEnum)[keyof typeof CurrentEducationEnum] /** * * `online` - Online * `hybrid` - Hybrid * `in_person` - In-Person * `offline` - Offline @@ -1203,26 +1228,25 @@ export type CurrentEducationEnum = typeof CurrentEducationEnum[keyof typeof Curr */ export const DeliveryEnum = { - /** - * Online - */ - Online: 'online', - /** - * Hybrid - */ - Hybrid: 'hybrid', - /** - * In-Person - */ - InPerson: 'in_person', - /** - * Offline - */ - Offline: 'offline' -} as const; - -export type DeliveryEnum = typeof DeliveryEnum[keyof typeof DeliveryEnum]; - + /** + * Online + */ + Online: "online", + /** + * Hybrid + */ + Hybrid: "hybrid", + /** + * In-Person + */ + InPerson: "in_person", + /** + * Offline + */ + Offline: "offline", +} as const + +export type DeliveryEnum = (typeof DeliveryEnum)[keyof typeof DeliveryEnum] /** * Serializer for Channel model of type department @@ -1230,159 +1254,158 @@ export type DeliveryEnum = typeof DeliveryEnum[keyof typeof DeliveryEnum]; * @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; - /** - * - * @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; + /** + * + * @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 + /** + * + * @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; + /** + * + * @type {string} + * @memberof DepartmentChannelFeaturedList + */ + title: string + /** + * + * @type {string} + * @memberof DepartmentChannelFeaturedList + */ + url?: string | null + /** + * + * @type {number} + * @memberof DepartmentChannelFeaturedList + */ + id: number } /** * * `department` - Department @@ -1391,14 +1414,14 @@ export interface DepartmentChannelFeaturedList { */ export const DepartmentChannelTypeEnum = { - /** - * Department - */ - Department: 'department' -} as const; - -export type DepartmentChannelTypeEnum = typeof DepartmentChannelTypeEnum[keyof typeof DepartmentChannelTypeEnum]; + /** + * Department + */ + Department: "department", +} as const +export type DepartmentChannelTypeEnum = + (typeof DepartmentChannelTypeEnum)[keyof typeof DepartmentChannelTypeEnum] /** * Serializer for document resources @@ -1406,309 +1429,308 @@ export type DepartmentChannelTypeEnum = typeof DepartmentChannelTypeEnum[keyof t * @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; + /** + * + * @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 const DocumentResourceResourceTypeEnum = { - Document: 'document' -} as const; - -export type DocumentResourceResourceTypeEnum = typeof DocumentResourceResourceTypeEnum[keyof typeof DocumentResourceResourceTypeEnum]; + Document: "document", +} as const +export type DocumentResourceResourceTypeEnum = + (typeof DocumentResourceResourceTypeEnum)[keyof typeof DocumentResourceResourceTypeEnum] /** * Serializer for News FeedItem @@ -1716,81 +1738,80 @@ export type DocumentResourceResourceTypeEnum = typeof DocumentResourceResourceTy * @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; + /** + * + * @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 const EventFeedItemFeedTypeEnum = { - Events: 'events' -} as const; - -export type EventFeedItemFeedTypeEnum = typeof EventFeedItemFeedTypeEnum[keyof typeof EventFeedItemFeedTypeEnum]; + Events: "events", +} as const +export type EventFeedItemFeedTypeEnum = + (typeof EventFeedItemFeedTypeEnum)[keyof typeof EventFeedItemFeedTypeEnum] /** * FeedEventDetail serializer @@ -1798,42 +1819,42 @@ export type EventFeedItemFeedTypeEnum = typeof EventFeedItemFeedTypeEnum[keyof t * @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; + /** + * + * @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 @@ -1841,36 +1862,38 @@ export interface FeedEventDetail { * @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 {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; +export type FeedItem = + | ({ resource_type: "events" } & EventFeedItem) + | ({ resource_type: "news" } & NewsFeedItem) /** * FeedNewsDetail serializer @@ -1878,30 +1901,30 @@ export type FeedItem = { resource_type: 'events' } & EventFeedItem | { resource_ * @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; + /** + * + * @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 @@ -1909,45 +1932,44 @@ export interface FeedNewsDetail { * @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; + /** + * + * @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 @@ -1955,18 +1977,18 @@ export interface FeedSource { */ export const FeedSourceFeedTypeEnum = { - /** - * News - */ - News: 'news', - /** - * Events - */ - Events: 'events' -} as const; - -export type FeedSourceFeedTypeEnum = typeof FeedSourceFeedTypeEnum[keyof typeof FeedSourceFeedTypeEnum]; + /** + * News + */ + News: "news", + /** + * Events + */ + Events: "events", +} as const +export type FeedSourceFeedTypeEnum = + (typeof FeedSourceFeedTypeEnum)[keyof typeof FeedSourceFeedTypeEnum] /** * * `academic-excellence` - Academic Boost * `career-growth` - Career Growth * `lifelong-learning` - Lifelong Learning @@ -1975,22 +1997,21 @@ export type FeedSourceFeedTypeEnum = typeof FeedSourceFeedTypeEnum[keyof typeof */ export const GoalsEnum = { - /** - * Academic Boost - */ - AcademicExcellence: 'academic-excellence', - /** - * Career Growth - */ - CareerGrowth: 'career-growth', - /** - * Lifelong Learning - */ - LifelongLearning: 'lifelong-learning' -} as const; - -export type GoalsEnum = typeof GoalsEnum[keyof typeof GoalsEnum]; - + /** + * Academic Boost + */ + AcademicExcellence: "academic-excellence", + /** + * Career Growth + */ + CareerGrowth: "career-growth", + /** + * Lifelong Learning + */ + LifelongLearning: "lifelong-learning", +} as const + +export type GoalsEnum = (typeof GoalsEnum)[keyof typeof GoalsEnum] /** * Serializer for the LearningPath model @@ -1998,18 +2019,18 @@ export type GoalsEnum = typeof GoalsEnum[keyof typeof GoalsEnum]; * @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; + /** + * + * @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 @@ -2017,24 +2038,24 @@ export interface LearningPath { * @interface LearningPathPreview */ export interface LearningPathPreview { - /** - * - * @type {string} - * @memberof LearningPathPreview - */ - 'title': string; - /** - * - * @type {string} - * @memberof LearningPathPreview - */ - 'url'?: string | null; - /** - * - * @type {number} - * @memberof LearningPathPreview - */ - 'id': number; + /** + * + * @type {string} + * @memberof LearningPathPreview + */ + title: string + /** + * + * @type {string} + * @memberof LearningPathPreview + */ + url?: string | null + /** + * + * @type {number} + * @memberof LearningPathPreview + */ + id: number } /** * CRUD serializer for LearningPath resources @@ -2042,315 +2063,322 @@ export interface LearningPathPreview { * @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; + /** + * + * @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 const LearningPathResourceResourceTypeEnum = { - LearningPath: 'learning_path' -} as const; - -export type LearningPathResourceResourceTypeEnum = typeof LearningPathResourceResourceTypeEnum[keyof typeof LearningPathResourceResourceTypeEnum]; + LearningPath: "learning_path", +} as const +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; +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. @@ -2358,24 +2386,24 @@ export type LearningResource = { resource_type: 'course' } & CourseResource | { * @interface LearningResourceBaseSchool */ export interface LearningResourceBaseSchool { - /** - * - * @type {number} - * @memberof LearningResourceBaseSchool - */ - 'id': number; - /** - * - * @type {string} - * @memberof LearningResourceBaseSchool - */ - 'name': string; - /** - * - * @type {string} - * @memberof LearningResourceBaseSchool - */ - 'url': string; + /** + * + * @type {number} + * @memberof LearningResourceBaseSchool + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceBaseSchool + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceBaseSchool + */ + url: string } /** * Full serializer for LearningResourceDepartment, including school @@ -2383,30 +2411,30 @@ export interface LearningResourceBaseSchool { * @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; + /** + * + * @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 @@ -2414,30 +2442,30 @@ export interface LearningResourceDepartment { * @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; + /** + * + * @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 @@ -2445,30 +2473,30 @@ export interface LearningResourceImage { * @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; + /** + * + * @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 @@ -2476,30 +2504,30 @@ export interface LearningResourceInstructor { * @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; + /** + * + * @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 @@ -2507,84 +2535,84 @@ export interface LearningResourceOfferor { * @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; + /** + * + * @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 LearningResourcePlatform @@ -2592,18 +2620,18 @@ export interface LearningResourceOfferorDetail { * @interface LearningResourcePlatform */ export interface LearningResourcePlatform { - /** - * - * @type {string} - * @memberof LearningResourcePlatform - */ - 'code': string; - /** - * - * @type {string} - * @memberof LearningResourcePlatform - */ - 'name'?: string; + /** + * + * @type {string} + * @memberof LearningResourcePlatform + */ + code: string + /** + * + * @type {string} + * @memberof LearningResourcePlatform + */ + name?: string } /** * Serializer for LearningResourcePrice model @@ -2611,18 +2639,18 @@ export interface LearningResourcePlatform { * @interface LearningResourcePrice */ export interface LearningResourcePrice { - /** - * - * @type {string} - * @memberof LearningResourcePrice - */ - 'amount': string; - /** - * - * @type {string} - * @memberof LearningResourcePrice - */ - 'currency': string; + /** + * + * @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 @@ -2630,277 +2658,276 @@ export interface LearningResourcePrice { * @interface LearningResourceRelationshipChildField */ export interface LearningResourceRelationshipChildField { - /** - * - * @type {number} - * @memberof LearningResourceRelationshipChildField - */ - 'child': number; - /** - * - * @type {number} - * @memberof LearningResourceRelationshipChildField - */ - 'position'?: number; - /** - * - * @type {RelationTypeEnum} - * @memberof LearningResourceRelationshipChildField - */ - 'relation_type'?: RelationTypeEnum; - /** - * - * @type {string} - * @memberof LearningResourceRelationshipChildField - */ - 'title': string; - /** - * - * @type {string} - * @memberof LearningResourceRelationshipChildField - */ - 'readable_id': string; + /** + * + * @type {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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof LearningResourceRunLevelInner + */ + code: LearningResourceRunLevelInnerCodeEnum + /** + * + * @type {string} + * @memberof LearningResourceRunLevelInner + */ + name: string } export const LearningResourceRunLevelInnerCodeEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const -export type LearningResourceRunLevelInnerCodeEnum = typeof LearningResourceRunLevelInnerCodeEnum[keyof typeof LearningResourceRunLevelInnerCodeEnum]; +export type LearningResourceRunLevelInnerCodeEnum = + (typeof LearningResourceRunLevelInnerCodeEnum)[keyof typeof LearningResourceRunLevelInnerCodeEnum] /** * Serializer for LearningResourceTopic model @@ -2908,36 +2935,36 @@ export type LearningResourceRunLevelInnerCodeEnum = typeof LearningResourceRunLe * @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; + /** + * + * @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 @@ -2945,36 +2972,36 @@ export interface LearningResourceTopic { * @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; + /** + * + * @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 @@ -2982,218 +3009,216 @@ export interface LearningResourcesVectorSearchResponse { * @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; + /** + * + * @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 const NewsFeedItemFeedTypeEnum = { - News: 'news' -} as const; - -export type NewsFeedItemFeedTypeEnum = typeof NewsFeedItemFeedTypeEnum[keyof typeof NewsFeedItemFeedTypeEnum]; + News: "news", +} as const +export type NewsFeedItemFeedTypeEnum = + (typeof NewsFeedItemFeedTypeEnum)[keyof typeof NewsFeedItemFeedTypeEnum] /** - * + * * @export * @enum {string} */ export const NullEnum = { - Null: 'null' -} as const; - -export type NullEnum = typeof NullEnum[keyof typeof NullEnum]; + Null: "null", +} as const +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; + /** + * + * @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; + /** + * + * @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; + /** + * + * @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; + /** + * + * @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 } /** * Serializer for Profile @@ -3201,108 +3226,112 @@ export interface PaginatedFeedSourceList { * @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 {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; +export type PatchedProfileRequestCertificateDesired = + | BlankEnum + | CertificateDesiredEnum /** * @type PatchedProfileRequestCurrentEducation * @export */ -export type PatchedProfileRequestCurrentEducation = BlankEnum | CurrentEducationEnum; +export type PatchedProfileRequestCurrentEducation = + | BlankEnum + | CurrentEducationEnum /** * @type PatchedProfileRequestTimeCommitment * @export */ -export type PatchedProfileRequestTimeCommitment = BlankEnum | TimeCommitmentEnum; +export type PatchedProfileRequestTimeCommitment = BlankEnum | TimeCommitmentEnum /** * Serializer for User @@ -3310,18 +3339,18 @@ export type PatchedProfileRequestTimeCommitment = BlankEnum | TimeCommitmentEnum * @interface PatchedUserRequest */ export interface PatchedUserRequest { - /** - * - * @type {ProfileRequest} - * @memberof PatchedUserRequest - */ - 'profile'?: ProfileRequest; - /** - * - * @type {string} - * @memberof PatchedUserRequest - */ - 'email'?: string; + /** + * + * @type {ProfileRequest} + * @memberof PatchedUserRequest + */ + profile?: ProfileRequest + /** + * + * @type {string} + * @memberof PatchedUserRequest + */ + email?: string } /** * Serializer for WidgetLists @@ -3329,12 +3358,12 @@ export interface PatchedUserRequest { * @interface PatchedWidgetListRequest */ export interface PatchedWidgetListRequest { - /** - * - * @type {Array} - * @memberof PatchedWidgetListRequest - */ - 'widgets'?: Array | null; + /** + * + * @type {Array} + * @memberof PatchedWidgetListRequest + */ + widgets?: Array | null } /** * Serializer for Channel model of type pathway @@ -3342,129 +3371,128 @@ export interface PatchedWidgetListRequest { * @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; - /** - * - * @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; + /** + * + * @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 + /** + * + * @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 @@ -3472,14 +3500,14 @@ export interface PathwayChannel { */ export const PathwayChannelTypeEnum = { - /** - * Pathway - */ - Pathway: 'pathway' -} as const; - -export type PathwayChannelTypeEnum = typeof PathwayChannelTypeEnum[keyof typeof PathwayChannelTypeEnum]; + /** + * Pathway + */ + Pathway: "pathway", +} as const +export type PathwayChannelTypeEnum = + (typeof PathwayChannelTypeEnum)[keyof typeof PathwayChannelTypeEnum] /** * Serializer for Podcasts @@ -3487,36 +3515,36 @@ export type PathwayChannelTypeEnum = typeof PathwayChannelTypeEnum[keyof typeof * @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; + /** + * + * @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 @@ -3524,48 +3552,48 @@ export interface Podcast { * @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; + /** + * + * @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 @@ -3573,309 +3601,308 @@ export interface PodcastEpisode { * @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; + /** + * + * @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 const PodcastEpisodeResourceResourceTypeEnum = { - PodcastEpisode: 'podcast_episode' -} as const; - -export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResourceResourceTypeEnum[keyof typeof PodcastEpisodeResourceResourceTypeEnum]; + PodcastEpisode: "podcast_episode", +} as const +export type PodcastEpisodeResourceResourceTypeEnum = + (typeof PodcastEpisodeResourceResourceTypeEnum)[keyof typeof PodcastEpisodeResourceResourceTypeEnum] /** * Serializer for podcast resources @@ -3883,309 +3910,308 @@ export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResour * @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; + /** + * + * @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 const PodcastResourceResourceTypeEnum = { - Podcast: 'podcast' -} as const; - -export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceTypeEnum[keyof typeof PodcastResourceResourceTypeEnum]; + Podcast: "podcast", +} as const +export type PodcastResourceResourceTypeEnum = + (typeof PodcastResourceResourceTypeEnum)[keyof typeof PodcastResourceResourceTypeEnum] /** * Serializer for profile search preference filters @@ -4193,37 +4219,37 @@ export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceType * @interface PreferencesSearch */ export interface PreferencesSearch { - /** - * - * @type {boolean} - * @memberof PreferencesSearch - */ - 'certification'?: boolean; - /** - * - * @type {Array} - * @memberof PreferencesSearch - */ - 'topic'?: Array; - /** - * - * @type {Array} - * @memberof PreferencesSearch - */ - 'delivery'?: Array; + /** + * + * @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; + /** + * + * @type {Array} + * @memberof ProblemListResponse + */ + problem_set_titles: Array } /** * Serializer for Profile @@ -4231,126 +4257,126 @@ export interface ProblemListResponse { * @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; + /** + * 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 @@ -4358,90 +4384,90 @@ export interface Profile { * @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; + /** + * + * @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 @@ -4449,18 +4475,18 @@ export interface ProfileRequest { * @interface Program */ export interface Program { - /** - * - * @type {number} - * @memberof Program - */ - 'course_count': number; - /** - * - * @type {number} - * @memberof Program - */ - 'program_count': number; + /** + * + * @type {number} + * @memberof Program + */ + course_count: number + /** + * + * @type {number} + * @memberof Program + */ + program_count: number } /** * Serializer for Program Certificates @@ -4468,132 +4494,132 @@ export interface Program { * @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; + /** + * + * @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 @@ -4601,309 +4627,308 @@ export interface ProgramCertificate { * @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; + /** + * + * @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 const ProgramResourceResourceTypeEnum = { - Program: 'program' -} as const; - -export type ProgramResourceResourceTypeEnum = typeof ProgramResourceResourceTypeEnum[keyof typeof ProgramResourceResourceTypeEnum]; + Program: "program", +} as const +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 @@ -4912,34 +4937,34 @@ export type ProgramResourceResourceTypeEnum = typeof ProgramResourceResourceType */ export const RelationTypeEnum = { - /** - * Program Courses - */ - ProgramCourses: 'PROGRAM_COURSES', - /** - * Program Programs - */ - ProgramPrograms: 'PROGRAM_PROGRAMS', - /** - * Learning Path Items - */ - LearningPathItems: 'LEARNING_PATH_ITEMS', - /** - * Podcast Episodes - */ - PodcastEpisodes: 'PODCAST_EPISODES', - /** - * Playlist Videos - */ - PlaylistVideos: 'PLAYLIST_VIDEOS', - /** - * Course Learning Materials - */ - CourseLearningMaterials: 'COURSE_LEARNING_MATERIALS' -} as const; - -export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationTypeEnum]; - + /** + * Program Courses + */ + ProgramCourses: "PROGRAM_COURSES", + /** + * Program Programs + */ + ProgramPrograms: "PROGRAM_PROGRAMS", + /** + * Learning Path Items + */ + LearningPathItems: "LEARNING_PATH_ITEMS", + /** + * Podcast Episodes + */ + PodcastEpisodes: "PODCAST_EPISODES", + /** + * Playlist Videos + */ + PlaylistVideos: "PLAYLIST_VIDEOS", + /** + * Course Learning Materials + */ + CourseLearningMaterials: "COURSE_LEARNING_MATERIALS", +} as const + +export type RelationTypeEnum = + (typeof RelationTypeEnum)[keyof typeof RelationTypeEnum] /** * * `news` - news * `events` - events @@ -4948,18 +4973,18 @@ export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationType */ export const ResourceTypeEnum = { - /** - * news - */ - News: 'news', - /** - * events - */ - Events: 'events' -} as const; - -export type ResourceTypeEnum = typeof ResourceTypeEnum[keyof typeof ResourceTypeEnum]; + /** + * news + */ + News: "news", + /** + * events + */ + Events: "events", +} as const +export type ResourceTypeEnum = + (typeof ResourceTypeEnum)[keyof typeof ResourceTypeEnum] /** * * `course` - Course * `program` - Program * `learning_material` - Learning Material @@ -4968,41 +4993,41 @@ export type ResourceTypeEnum = typeof ResourceTypeEnum[keyof typeof ResourceType */ export const ResourceTypeGroupEnum = { - /** - * Course - */ - Course: 'course', - /** - * Program - */ - Program: 'program', - /** - * Learning Material - */ - LearningMaterial: 'learning_material' -} as const; - -export type ResourceTypeGroupEnum = typeof ResourceTypeGroupEnum[keyof typeof ResourceTypeGroupEnum]; - + /** + * Course + */ + Course: "course", + /** + * Program + */ + Program: "program", + /** + * Learning Material + */ + LearningMaterial: "learning_material", +} as const + +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; + /** + * + * @type {string} + * @memberof RetrieveProblemResponse + */ + problem_set: string + /** + * + * @type {string} + * @memberof RetrieveProblemResponse + */ + solution_set: string } /** * * `facebook` - facebook * `linkedin` - linkedin * `personal` - personal * `twitter` - twitter @@ -5011,26 +5036,25 @@ export interface RetrieveProblemResponse { */ export const SiteTypeEnum = { - /** - * facebook - */ - Facebook: 'facebook', - /** - * linkedin - */ - Linkedin: 'linkedin', - /** - * personal - */ - Personal: 'personal', - /** - * twitter - */ - Twitter: 'twitter' -} as const; - -export type SiteTypeEnum = typeof SiteTypeEnum[keyof typeof SiteTypeEnum]; - + /** + * facebook + */ + Facebook: "facebook", + /** + * linkedin + */ + Linkedin: "linkedin", + /** + * personal + */ + Personal: "personal", + /** + * twitter + */ + Twitter: "twitter", +} as const + +export type SiteTypeEnum = (typeof SiteTypeEnum)[keyof typeof SiteTypeEnum] /** * Serializer for SubChannels @@ -5038,24 +5062,24 @@ export type SiteTypeEnum = typeof SiteTypeEnum[keyof typeof SiteTypeEnum]; * @interface SubChannel */ export interface SubChannel { - /** - * - * @type {string} - * @memberof SubChannel - */ - 'parent_channel': string; - /** - * - * @type {string} - * @memberof SubChannel - */ - 'channel': string; - /** - * - * @type {number} - * @memberof SubChannel - */ - 'position'?: number; + /** + * + * @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 @@ -5064,30 +5088,30 @@ export interface SubChannel { */ export const TimeCommitmentEnum = { - /** - * <5 hours/week - */ - _0To5Hours: '0-to-5-hours', - /** - * 5-10 hours/week - */ - _5To10Hours: '5-to-10-hours', - /** - * 10-20 hours/week - */ - _10To20Hours: '10-to-20-hours', - /** - * 20-30 hours/week - */ - _20To30Hours: '20-to-30-hours', - /** - * 30+ hours/week - */ - _30PlusHours: '30-plus-hours' -} as const; - -export type TimeCommitmentEnum = typeof TimeCommitmentEnum[keyof typeof TimeCommitmentEnum]; - + /** + * <5 hours/week + */ + _0To5Hours: "0-to-5-hours", + /** + * 5-10 hours/week + */ + _5To10Hours: "5-to-10-hours", + /** + * 10-20 hours/week + */ + _10To20Hours: "10-to-20-hours", + /** + * 20-30 hours/week + */ + _20To30Hours: "20-to-30-hours", + /** + * 30+ hours/week + */ + _30PlusHours: "30-plus-hours", +} as const + +export type TimeCommitmentEnum = + (typeof TimeCommitmentEnum)[keyof typeof TimeCommitmentEnum] /** * Serializer for Channel model of type topic @@ -5095,135 +5119,134 @@ export type TimeCommitmentEnum = typeof TimeCommitmentEnum[keyof typeof TimeComm * @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; - /** - * - * @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; + /** + * + * @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 + /** + * + * @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 @@ -5231,14 +5254,14 @@ export interface TopicChannel { */ export const TopicChannelTypeEnum = { - /** - * Topic - */ - Topic: 'topic' -} as const; - -export type TopicChannelTypeEnum = typeof TopicChannelTypeEnum[keyof typeof TopicChannelTypeEnum]; + /** + * Topic + */ + Topic: "topic", +} as const +export type TopicChannelTypeEnum = + (typeof TopicChannelTypeEnum)[keyof typeof TopicChannelTypeEnum] /** * Serializer for Channel model of type unit @@ -5246,135 +5269,134 @@ export type TopicChannelTypeEnum = typeof TopicChannelTypeEnum[keyof typeof Topi * @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; - /** - * - * @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; + /** + * + * @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 + /** + * + * @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 @@ -5382,14 +5404,14 @@ export interface UnitChannel { */ export const UnitChannelTypeEnum = { - /** - * Unit - */ - Unit: 'unit' -} as const; - -export type UnitChannelTypeEnum = typeof UnitChannelTypeEnum[keyof typeof UnitChannelTypeEnum]; + /** + * Unit + */ + Unit: "unit", +} as const +export type UnitChannelTypeEnum = + (typeof UnitChannelTypeEnum)[keyof typeof UnitChannelTypeEnum] /** * Serializer for User @@ -5397,54 +5419,54 @@ export type UnitChannelTypeEnum = typeof UnitChannelTypeEnum[keyof typeof UnitCh * @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; + /** + * + * @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 @@ -5452,18 +5474,18 @@ export interface User { * @interface UserRequest */ export interface UserRequest { - /** - * - * @type {ProfileRequest} - * @memberof UserRequest - */ - 'profile'?: ProfileRequest; - /** - * - * @type {string} - * @memberof UserRequest - */ - 'email': string; + /** + * + * @type {ProfileRequest} + * @memberof UserRequest + */ + profile?: ProfileRequest + /** + * + * @type {string} + * @memberof UserRequest + */ + email: string } /** * Serializer for UserWebsite @@ -5471,51 +5493,50 @@ export interface UserRequest { * @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; + /** + * + * @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; + /** + * + * @type {number} + * @memberof UserWebsiteRequest + */ + profile: number + /** + * + * @type {string} + * @memberof UserWebsiteRequest + */ + url: string } /** * Serializer for the Video model @@ -5523,36 +5544,36 @@ export interface UserWebsiteRequest { * @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; + /** + * + * @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 @@ -5560,699 +5581,697 @@ export interface Video { * @interface VideoChannel */ export interface VideoChannel { - /** - * - * @type {string} - * @memberof VideoChannel - */ - 'channel_id': string; - /** - * - * @type {string} - * @memberof VideoChannel - */ - 'title': string; + /** + * + * @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; - /** - * - * @type {number} - * @memberof VideoPlaylist - */ - 'parent_learning_resource_id': number | null; - /** - * - * @type {string} - * @memberof VideoPlaylist - */ - 'parent_title': string | null; - /** - * - * @type {string} - * @memberof VideoPlaylist - */ - 'parent_url': string | null; - /** - * Extract the course number(s) from the parent course, if any - * @type {Array} - * @memberof VideoPlaylist - */ - 'parent_course_numbers': Array; -} -/** - * 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 const VideoPlaylistResourceResourceTypeEnum = { - VideoPlaylist: 'video_playlist' -} as const; - -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; + * @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 + /** + * + * @type {number} + * @memberof VideoPlaylist + */ + parent_learning_resource_id: number | null + /** + * + * @type {string} + * @memberof VideoPlaylist + */ + parent_title: string | null + /** + * + * @type {string} + * @memberof VideoPlaylist + */ + parent_url: string | null + /** + * Extract the course number(s) from the parent course, if any + * @type {Array} + * @memberof VideoPlaylist + */ + parent_course_numbers: Array +} +/** + * 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 const VideoPlaylistResourceResourceTypeEnum = { + VideoPlaylist: "video_playlist", +} as const + +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 const VideoResourceResourceTypeEnum = { - Video: 'video' -} as const; - -export type VideoResourceResourceTypeEnum = typeof VideoResourceResourceTypeEnum[keyof typeof VideoResourceResourceTypeEnum]; + Video: "video", +} as const +export type VideoResourceResourceTypeEnum = + (typeof VideoResourceResourceTypeEnum)[keyof typeof VideoResourceResourceTypeEnum] /** * WidgetInstance serializer @@ -6260,88 +6279,87 @@ export type VideoResourceResourceTypeEnum = typeof VideoResourceResourceTypeEnum * @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; + /** + * + * @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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof WidgetListAvailableWidgetsInner + */ + widget_type?: string + /** + * + * @type {string} + * @memberof WidgetListAvailableWidgetsInner + */ + description?: string + /** + * + * @type {object} + * @memberof WidgetListAvailableWidgetsInner + */ + form_spec?: object } /** * Serializer for WidgetLists @@ -6349,12 +6367,12 @@ export interface WidgetListAvailableWidgetsInner { * @interface WidgetListRequest */ export interface WidgetListRequest { - /** - * - * @type {Array} - * @memberof WidgetListRequest - */ - 'widgets'?: Array | null; + /** + * + * @type {Array} + * @memberof WidgetListRequest + */ + widgets?: Array | null } /** * * `Markdown` - Markdown * `URL` - URL * `RSS Feed` - RSS Feed * `People` - People @@ -6363,2923 +6381,4185 @@ export interface WidgetListRequest { */ export const WidgetTypeEnum = { - /** - * Markdown - */ - Markdown: 'Markdown', - /** - * URL - */ - Url: 'URL', - /** - * RSS Feed - */ - RssFeed: 'RSS Feed', - /** - * People - */ - People: 'People' -} as const; - -export type WidgetTypeEnum = typeof WidgetTypeEnum[keyof typeof WidgetTypeEnum]; - - + /** + * Markdown + */ + Markdown: "Markdown", + /** + * URL + */ + Url: "URL", + /** + * RSS Feed + */ + RssFeed: "RSS Feed", + /** + * People + */ + People: "People", +} as const + +export type WidgetTypeEnum = + (typeof WidgetTypeEnum)[keyof typeof WidgetTypeEnum] /** * ChannelsApi - axios parameter creator * @export */ -export const ChannelsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * List channel counts by resource type. - * @summary Channel Counts by channel type - * @param {string} channel_type - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - channelsCountsList: async (channel_type: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'channel_type' is not null or undefined - assertParamExists('channelsCountsList', 'channel_type', channel_type) - const localVarPath = `/api/v0/channels/counts/{channel_type}/` - .replace(`{${"channel_type"}}`, encodeURIComponent(String(channel_type))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * List published channels. - * @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: async (channel_type?: ChannelsListChannelTypeEnum, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/channels/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (channel_type !== undefined) { - localVarQueryParameter['channel_type'] = channel_type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single channel by id. - * @summary Retrieve - * @param {number} id A unique integer value identifying this channel. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - channelsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('channelsRetrieve', 'id', id) - const localVarPath = `/api/v0/channels/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (channel_type: string, name: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'channel_type' is not null or undefined - assertParamExists('channelsTypeRetrieve', 'channel_type', channel_type) - // verify required parameter 'name' is not null or undefined - assertParamExists('channelsTypeRetrieve', 'name', name) - const localVarPath = `/api/v0/channels/type/{channel_type}/{name}/` - .replace(`{${"channel_type"}}`, encodeURIComponent(String(channel_type))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * ChannelsApi - functional programming interface - * @export - */ -export const ChannelsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ChannelsApiAxiosParamCreator(configuration) - return { - /** - * List channel counts by resource type. - * @summary Channel Counts by channel type - * @param {string} channel_type - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async channelsCountsList(channel_type: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelsCountsList(channel_type, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ChannelsApi.channelsCountsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * List published channels. - * @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} - */ - async channelsList(channel_type?: ChannelsListChannelTypeEnum, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelsList(channel_type, limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ChannelsApi.channelsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single channel by id. - * @summary Retrieve - * @param {number} id A unique integer value identifying this channel. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async channelsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ChannelsApi.channelsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * 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} - */ - async channelsTypeRetrieve(channel_type: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelsTypeRetrieve(channel_type, name, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ChannelsApi.channelsTypeRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * ChannelsApi - factory interface - * @export - */ -export const ChannelsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ChannelsApiFp(configuration) - return { - /** - * List channel counts by resource type. - * @summary Channel Counts by channel type - * @param {ChannelsApiChannelsCountsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - channelsCountsList(requestParameters: ChannelsApiChannelsCountsListRequest, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.channelsCountsList(requestParameters.channel_type, options).then((request) => request(axios, basePath)); - }, - /** - * List published channels. - * @summary List - * @param {ChannelsApiChannelsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - channelsList(requestParameters: ChannelsApiChannelsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelsList(requestParameters.channel_type, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single channel by id. - * @summary Retrieve - * @param {ChannelsApiChannelsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - channelsRetrieve(requestParameters: ChannelsApiChannelsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * 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 { - return localVarFp.channelsTypeRetrieve(requestParameters.channel_type, requestParameters.name, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for channelsCountsList operation in ChannelsApi. - * @export - * @interface ChannelsApiChannelsCountsListRequest - */ -export interface ChannelsApiChannelsCountsListRequest { +export const ChannelsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {string} - * @memberof ChannelsApiChannelsCountsList + * List channel counts by resource type. + * @summary Channel Counts by channel type + * @param {string} channel_type + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly channel_type: string -} - -/** - * Request parameters for channelsList operation in ChannelsApi. - * @export - * @interface ChannelsApiChannelsListRequest - */ -export interface ChannelsApiChannelsListRequest { + channelsCountsList: async ( + channel_type: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'channel_type' is not null or undefined + assertParamExists("channelsCountsList", "channel_type", channel_type) + const localVarPath = `/api/v0/channels/counts/{channel_type}/`.replace( + `{${"channel_type"}}`, + encodeURIComponent(String(channel_type)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * * `topic` - Topic * `department` - Department * `unit` - Unit * `pathway` - Pathway - * @type {'department' | 'pathway' | 'topic' | 'unit'} - * @memberof ChannelsApiChannelsList + * List published channels. + * @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} */ - readonly channel_type?: ChannelsListChannelTypeEnum - + channelsList: async ( + channel_type?: ChannelsListChannelTypeEnum, + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/channels/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (channel_type !== undefined) { + localVarQueryParameter["channel_type"] = channel_type + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Number of results to return per page. - * @type {number} - * @memberof ChannelsApiChannelsList + * Retrieve a single channel by id. + * @summary Retrieve + * @param {number} id A unique integer value identifying this channel. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + channelsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("channelsRetrieve", "id", id) + const localVarPath = `/api/v0/channels/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof ChannelsApiChannelsList + * 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} */ - readonly offset?: number + channelsTypeRetrieve: async ( + channel_type: string, + name: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'channel_type' is not null or undefined + assertParamExists("channelsTypeRetrieve", "channel_type", channel_type) + // verify required parameter 'name' is not null or undefined + assertParamExists("channelsTypeRetrieve", "name", name) + const localVarPath = `/api/v0/channels/type/{channel_type}/{name}/` + .replace( + `{${"channel_type"}}`, + encodeURIComponent(String(channel_type)), + ) + .replace(`{${"name"}}`, encodeURIComponent(String(name))) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for channelsRetrieve operation in ChannelsApi. + * ChannelsApi - functional programming interface * @export - * @interface ChannelsApiChannelsRetrieveRequest */ -export interface ChannelsApiChannelsRetrieveRequest { +export const ChannelsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = ChannelsApiAxiosParamCreator(configuration) + return { /** - * A unique integer value identifying this channel. - * @type {number} - * @memberof ChannelsApiChannelsRetrieve + * List channel counts by resource type. + * @summary Channel Counts by channel type + * @param {string} channel_type + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * Request parameters for channelsTypeRetrieve operation in ChannelsApi. - * @export - * @interface ChannelsApiChannelsTypeRetrieveRequest - */ -export interface ChannelsApiChannelsTypeRetrieveRequest { + async channelsCountsList( + channel_type: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.channelsCountsList( + channel_type, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ChannelsApi.channelsCountsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {string} - * @memberof ChannelsApiChannelsTypeRetrieve + * List published channels. + * @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} */ - readonly channel_type: string - + async channelsList( + channel_type?: ChannelsListChannelTypeEnum, + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.channelsList( + channel_type, + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ChannelsApi.channelsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Retrieve a single channel by id. + * @summary Retrieve + * @param {number} id A unique integer value identifying this channel. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async channelsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.channelsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ChannelsApi.channelsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {string} - * @memberof ChannelsApiChannelsTypeRetrieve + * 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} */ - readonly name: string + async channelsTypeRetrieve( + channel_type: string, + name: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.channelsTypeRetrieve( + channel_type, + name, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ChannelsApi.channelsTypeRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * ChannelsApi - object-oriented interface + * ChannelsApi - factory interface * @export - * @class ChannelsApi - * @extends {BaseAPI} */ -export class ChannelsApi extends BaseAPI { +export const ChannelsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ChannelsApiFp(configuration) + return { /** * List channel counts by resource type. * @summary Channel Counts by channel type * @param {ChannelsApiChannelsCountsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ChannelsApi */ - public channelsCountsList(requestParameters: ChannelsApiChannelsCountsListRequest, options?: RawAxiosRequestConfig) { - return ChannelsApiFp(this.configuration).channelsCountsList(requestParameters.channel_type, options).then((request) => request(this.axios, this.basePath)); - } - + channelsCountsList( + requestParameters: ChannelsApiChannelsCountsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .channelsCountsList(requestParameters.channel_type, options) + .then((request) => request(axios, basePath)) + }, /** * List published channels. * @summary List * @param {ChannelsApiChannelsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ChannelsApi */ - public channelsList(requestParameters: ChannelsApiChannelsListRequest = {}, options?: RawAxiosRequestConfig) { - return ChannelsApiFp(this.configuration).channelsList(requestParameters.channel_type, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + channelsList( + requestParameters: ChannelsApiChannelsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .channelsList( + requestParameters.channel_type, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a single channel by id. * @summary Retrieve * @param {ChannelsApiChannelsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ChannelsApi */ - public channelsRetrieve(requestParameters: ChannelsApiChannelsRetrieveRequest, options?: RawAxiosRequestConfig) { - return ChannelsApiFp(this.configuration).channelsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - + channelsRetrieve( + requestParameters: ChannelsApiChannelsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .channelsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** * 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 */ - public channelsTypeRetrieve(requestParameters: ChannelsApiChannelsTypeRetrieveRequest, options?: RawAxiosRequestConfig) { - return ChannelsApiFp(this.configuration).channelsTypeRetrieve(requestParameters.channel_type, requestParameters.name, options).then((request) => request(this.axios, this.basePath)); - } + channelsTypeRetrieve( + requestParameters: ChannelsApiChannelsTypeRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .channelsTypeRetrieve( + requestParameters.channel_type, + requestParameters.name, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for channelsCountsList operation in ChannelsApi. * @export + * @interface ChannelsApiChannelsCountsListRequest */ -export const ChannelsListChannelTypeEnum = { - Department: 'department', - Pathway: 'pathway', - Topic: 'topic', - Unit: 'unit' -} as const; -export type ChannelsListChannelTypeEnum = typeof ChannelsListChannelTypeEnum[keyof typeof ChannelsListChannelTypeEnum]; - +export interface ChannelsApiChannelsCountsListRequest { + /** + * + * @type {string} + * @memberof ChannelsApiChannelsCountsList + */ + readonly channel_type: string +} /** - * CkeditorApi - axios parameter creator + * Request parameters for channelsList operation in ChannelsApi. * @export + * @interface ChannelsApiChannelsListRequest */ -export const CkeditorApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the settings response - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - ckeditorRetrieve: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/ckeditor`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +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 +} /** - * CkeditorApi - functional programming interface + * Request parameters for channelsRetrieve operation in ChannelsApi. * @export + * @interface ChannelsApiChannelsRetrieveRequest */ -export const CkeditorApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CkeditorApiAxiosParamCreator(configuration) - return { - /** - * Get the settings response - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async ckeditorRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.ckeditorRetrieve(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CkeditorApi.ckeditorRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface ChannelsApiChannelsRetrieveRequest { + /** + * A unique integer value identifying this channel. + * @type {number} + * @memberof ChannelsApiChannelsRetrieve + */ + readonly id: number +} /** - * CkeditorApi - factory interface + * Request parameters for channelsTypeRetrieve operation in ChannelsApi. * @export + * @interface ChannelsApiChannelsTypeRetrieveRequest */ -export const CkeditorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CkeditorApiFp(configuration) - return { - /** - * Get the settings response - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - ckeditorRetrieve(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.ckeditorRetrieve(options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface ChannelsApiChannelsTypeRetrieveRequest { + /** + * + * @type {string} + * @memberof ChannelsApiChannelsTypeRetrieve + */ + readonly channel_type: string + + /** + * + * @type {string} + * @memberof ChannelsApiChannelsTypeRetrieve + */ + readonly name: string +} /** - * CkeditorApi - object-oriented interface + * ChannelsApi - object-oriented interface * @export - * @class CkeditorApi + * @class ChannelsApi * @extends {BaseAPI} */ -export class CkeditorApi extends BaseAPI { +export class ChannelsApi extends BaseAPI { + /** + * List channel counts by resource type. + * @summary Channel Counts by channel type + * @param {ChannelsApiChannelsCountsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ChannelsApi + */ + public channelsCountsList( + requestParameters: ChannelsApiChannelsCountsListRequest, + options?: RawAxiosRequestConfig, + ) { + return ChannelsApiFp(this.configuration) + .channelsCountsList(requestParameters.channel_type, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * List published channels. + * @summary List + * @param {ChannelsApiChannelsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ChannelsApi + */ + public channelsList( + requestParameters: ChannelsApiChannelsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return ChannelsApiFp(this.configuration) + .channelsList( + requestParameters.channel_type, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single channel by id. + * @summary Retrieve + * @param {ChannelsApiChannelsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ChannelsApi + */ + public channelsRetrieve( + requestParameters: ChannelsApiChannelsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ChannelsApiFp(this.configuration) + .channelsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * 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 + */ + public channelsTypeRetrieve( + requestParameters: ChannelsApiChannelsTypeRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ChannelsApiFp(this.configuration) + .channelsTypeRetrieve( + requestParameters.channel_type, + requestParameters.name, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} + +/** + * @export + */ +export const ChannelsListChannelTypeEnum = { + Department: "department", + Pathway: "pathway", + Topic: "topic", + Unit: "unit", +} as const +export type ChannelsListChannelTypeEnum = + (typeof ChannelsListChannelTypeEnum)[keyof typeof ChannelsListChannelTypeEnum] + +/** + * CkeditorApi - axios parameter creator + * @export + */ +export const CkeditorApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** * Get the settings response * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CkeditorApi */ - public ckeditorRetrieve(options?: RawAxiosRequestConfig) { - return CkeditorApiFp(this.configuration).ckeditorRetrieve(options).then((request) => request(this.axios, this.basePath)); - } + ckeditorRetrieve: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/ckeditor` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } - - /** - * LearningResourcesSearchAdminParamsApi - axios parameter creator + * CkeditorApi - functional programming interface * @export */ -export const LearningResourcesSearchAdminParamsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Learning resource search default admin param values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSearchAdminParamsRetrieve: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/learning_resources_search_admin_params/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const CkeditorApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = CkeditorApiAxiosParamCreator(configuration) + return { + /** + * Get the settings response + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async ckeditorRetrieve( + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.ckeditorRetrieve(options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CkeditorApi.ckeditorRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** - * LearningResourcesSearchAdminParamsApi - functional programming interface + * CkeditorApi - factory interface * @export */ -export const LearningResourcesSearchAdminParamsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningResourcesSearchAdminParamsApiAxiosParamCreator(configuration) - return { - /** - * Learning resource search default admin param values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesSearchAdminParamsRetrieve(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesSearchAdminParamsApi.learningResourcesSearchAdminParamsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const CkeditorApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = CkeditorApiFp(configuration) + return { + /** + * Get the settings response + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + ckeditorRetrieve( + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .ckeditorRetrieve(options) + .then((request) => request(axios, basePath)) + }, + } +} /** - * LearningResourcesSearchAdminParamsApi - factory interface + * CkeditorApi - object-oriented interface * @export + * @class CkeditorApi + * @extends {BaseAPI} */ -export const LearningResourcesSearchAdminParamsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningResourcesSearchAdminParamsApiFp(configuration) - return { - /** - * Learning resource search default admin param values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesSearchAdminParamsRetrieve(options).then((request) => request(axios, basePath)); - }, - }; -}; +export class CkeditorApi extends BaseAPI { + /** + * Get the settings response + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CkeditorApi + */ + public ckeditorRetrieve(options?: RawAxiosRequestConfig) { + return CkeditorApiFp(this.configuration) + .ckeditorRetrieve(options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * LearningResourcesSearchAdminParamsApi - object-oriented interface + * LearningResourcesSearchAdminParamsApi - axios parameter creator * @export - * @class LearningResourcesSearchAdminParamsApi - * @extends {BaseAPI} */ -export class LearningResourcesSearchAdminParamsApi extends BaseAPI { +export const LearningResourcesSearchAdminParamsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** * Learning resource search default admin param values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningResourcesSearchAdminParamsApi */ - public learningResourcesSearchAdminParamsRetrieve(options?: RawAxiosRequestConfig) { - return LearningResourcesSearchAdminParamsApiFp(this.configuration).learningResourcesSearchAdminParamsRetrieve(options).then((request) => request(this.axios, this.basePath)); - } + learningResourcesSearchAdminParamsRetrieve: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/learning_resources_search_admin_params/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } - - /** - * NewsEventsApi - axios parameter creator + * LearningResourcesSearchAdminParamsApi - functional programming interface * @export */ -export const NewsEventsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (feed_type?: Array, limit?: number, offset?: number, sortby?: NewsEventsListSortbyEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/news_events/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (feed_type) { - localVarQueryParameter['feed_type'] = feed_type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('newsEventsRetrieve', 'id', id) - const localVarPath = `/api/v0/news_events/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const LearningResourcesSearchAdminParamsApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + LearningResourcesSearchAdminParamsApiAxiosParamCreator(configuration) + return { + /** + * Learning resource search default admin param values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async learningResourcesSearchAdminParamsRetrieve( + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesSearchAdminParamsRetrieve( + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesSearchAdminParamsApi.learningResourcesSearchAdminParamsRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** - * NewsEventsApi - functional programming interface + * LearningResourcesSearchAdminParamsApi - factory interface * @export */ -export const NewsEventsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NewsEventsApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async newsEventsList(feed_type?: Array, limit?: number, offset?: number, sortby?: NewsEventsListSortbyEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.newsEventsList(feed_type, limit, offset, sortby, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['NewsEventsApi.newsEventsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single feed item. - * @param {number} id A unique integer value identifying this feed item. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async newsEventsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.newsEventsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['NewsEventsApi.newsEventsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const LearningResourcesSearchAdminParamsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningResourcesSearchAdminParamsApiFp(configuration) + return { + /** + * Learning resource search default admin param values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + learningResourcesSearchAdminParamsRetrieve( + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesSearchAdminParamsRetrieve(options) + .then((request) => request(axios, basePath)) + }, + } +} /** - * NewsEventsApi - factory interface + * LearningResourcesSearchAdminParamsApi - object-oriented interface * @export + * @class LearningResourcesSearchAdminParamsApi + * @extends {BaseAPI} */ -export const NewsEventsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NewsEventsApiFp(configuration) - return { - /** - * 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 { - return localVarFp.newsEventsList(requestParameters.feed_type, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single feed item. - * @param {NewsEventsApiNewsEventsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - newsEventsRetrieve(requestParameters: NewsEventsApiNewsEventsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.newsEventsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class LearningResourcesSearchAdminParamsApi extends BaseAPI { + /** + * Learning resource search default admin param values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesSearchAdminParamsApi + */ + public learningResourcesSearchAdminParamsRetrieve( + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesSearchAdminParamsApiFp(this.configuration) + .learningResourcesSearchAdminParamsRetrieve(options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for newsEventsList operation in NewsEventsApi. + * NewsEventsApi - axios parameter creator * @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 - +export const NewsEventsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The initial index from which to return the results. - * @type {number} - * @memberof NewsEventsApiNewsEventsList + * 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} */ - readonly offset?: number - + newsEventsList: async ( + feed_type?: Array, + limit?: number, + offset?: number, + sortby?: NewsEventsListSortbyEnum, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/news_events/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (feed_type) { + localVarQueryParameter["feed_type"] = feed_type + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * 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 + * Retrieve a single feed item. + * @param {number} id A unique integer value identifying this feed item. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: NewsEventsListSortbyEnum + newsEventsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("newsEventsRetrieve", "id", id) + const localVarPath = `/api/v0/news_events/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for newsEventsRetrieve operation in NewsEventsApi. + * NewsEventsApi - functional programming interface * @export - * @interface NewsEventsApiNewsEventsRetrieveRequest */ -export interface NewsEventsApiNewsEventsRetrieveRequest { +export const NewsEventsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + NewsEventsApiAxiosParamCreator(configuration) + return { + /** + * 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} + */ + async newsEventsList( + feed_type?: Array, + limit?: number, + offset?: number, + sortby?: NewsEventsListSortbyEnum, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.newsEventsList( + feed_type, + limit, + offset, + sortby, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["NewsEventsApi.newsEventsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this feed item. - * @type {number} - * @memberof NewsEventsApiNewsEventsRetrieve + * Retrieve a single feed item. + * @param {number} id A unique integer value identifying this feed item. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async newsEventsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.newsEventsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["NewsEventsApi.newsEventsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * NewsEventsApi - object-oriented interface + * NewsEventsApi - factory interface * @export - * @class NewsEventsApi - * @extends {BaseAPI} */ -export class NewsEventsApi extends BaseAPI { +export const NewsEventsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = NewsEventsApiFp(configuration) + return { /** * Get a paginated list of feed items. * @param {NewsEventsApiNewsEventsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof NewsEventsApi */ - public newsEventsList(requestParameters: NewsEventsApiNewsEventsListRequest = {}, options?: RawAxiosRequestConfig) { - return NewsEventsApiFp(this.configuration).newsEventsList(requestParameters.feed_type, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(this.axios, this.basePath)); - } - + newsEventsList( + requestParameters: NewsEventsApiNewsEventsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .newsEventsList( + requestParameters.feed_type, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a single feed item. * @param {NewsEventsApiNewsEventsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof NewsEventsApi */ - public newsEventsRetrieve(requestParameters: NewsEventsApiNewsEventsRetrieveRequest, options?: RawAxiosRequestConfig) { - return NewsEventsApiFp(this.configuration).newsEventsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + newsEventsRetrieve( + requestParameters: NewsEventsApiNewsEventsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .newsEventsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for newsEventsList operation in NewsEventsApi. * @export + * @interface NewsEventsApiNewsEventsListRequest */ -export const NewsEventsListFeedTypeEnum = { - Events: 'events', - News: 'news' -} as const; -export type NewsEventsListFeedTypeEnum = typeof NewsEventsListFeedTypeEnum[keyof typeof NewsEventsListFeedTypeEnum]; +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 const NewsEventsListSortbyEnum = { - EventDate: '-event_date', - Id: '-id', - NewsDate: '-news_date', - EventDate2: 'event_date', - Id2: 'id', - NewsDate2: 'news_date' -} as const; -export type NewsEventsListSortbyEnum = typeof NewsEventsListSortbyEnum[keyof typeof NewsEventsListSortbyEnum]; - +export interface NewsEventsApiNewsEventsRetrieveRequest { + /** + * A unique integer value identifying this feed item. + * @type {number} + * @memberof NewsEventsApiNewsEventsRetrieve + */ + readonly id: number +} /** - * NewsEventsSourcesApi - axios parameter creator + * NewsEventsApi - object-oriented interface * @export + * @class NewsEventsApi + * @extends {BaseAPI} */ -export const NewsEventsSourcesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (feed_type?: Array, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/news_events_sources/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (feed_type) { - localVarQueryParameter['feed_type'] = feed_type; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('newsEventsSourcesRetrieve', 'id', id) - const localVarPath = `/api/v0/news_events_sources/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export 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 + */ + public newsEventsList( + requestParameters: NewsEventsApiNewsEventsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return NewsEventsApiFp(this.configuration) + .newsEventsList( + requestParameters.feed_type, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single feed item. + * @param {NewsEventsApiNewsEventsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NewsEventsApi + */ + public newsEventsRetrieve( + requestParameters: NewsEventsApiNewsEventsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return NewsEventsApiFp(this.configuration) + .newsEventsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * NewsEventsSourcesApi - functional programming interface * @export */ -export const NewsEventsSourcesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NewsEventsSourcesApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async newsEventsSourcesList(feed_type?: Array, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.newsEventsSourcesList(feed_type, limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['NewsEventsSourcesApi.newsEventsSourcesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * 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} - */ - async newsEventsSourcesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.newsEventsSourcesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['NewsEventsSourcesApi.newsEventsSourcesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - +export const NewsEventsListFeedTypeEnum = { + Events: "events", + News: "news", +} as const +export type NewsEventsListFeedTypeEnum = + (typeof NewsEventsListFeedTypeEnum)[keyof typeof NewsEventsListFeedTypeEnum] /** - * NewsEventsSourcesApi - factory interface * @export */ -export const NewsEventsSourcesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NewsEventsSourcesApiFp(configuration) - return { - /** - * 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 { - return localVarFp.newsEventsSourcesList(requestParameters.feed_type, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * 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 { - return localVarFp.newsEventsSourcesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const NewsEventsListSortbyEnum = { + EventDate: "-event_date", + Id: "-id", + NewsDate: "-news_date", + EventDate2: "event_date", + Id2: "id", + NewsDate2: "news_date", +} as const +export type NewsEventsListSortbyEnum = + (typeof NewsEventsListSortbyEnum)[keyof typeof NewsEventsListSortbyEnum] /** - * Request parameters for newsEventsSourcesList operation in NewsEventsSourcesApi. + * NewsEventsSourcesApi - axios parameter creator * @export - * @interface NewsEventsSourcesApiNewsEventsSourcesListRequest */ -export interface NewsEventsSourcesApiNewsEventsSourcesListRequest { +export const NewsEventsSourcesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * 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 + * 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} */ - readonly limit?: number - + newsEventsSourcesList: async ( + feed_type?: Array, + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/news_events_sources/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (feed_type) { + localVarQueryParameter["feed_type"] = feed_type + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof NewsEventsSourcesApiNewsEventsSourcesList + * 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} */ - readonly offset?: number + newsEventsSourcesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("newsEventsSourcesRetrieve", "id", id) + const localVarPath = `/api/v0/news_events_sources/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for newsEventsSourcesRetrieve operation in NewsEventsSourcesApi. + * NewsEventsSourcesApi - functional programming interface * @export - * @interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest */ -export interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest { +export const NewsEventsSourcesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + NewsEventsSourcesApiAxiosParamCreator(configuration) + return { + /** + * 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} + */ + async newsEventsSourcesList( + feed_type?: Array, + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.newsEventsSourcesList( + feed_type, + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["NewsEventsSourcesApi.newsEventsSourcesList"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this feed source. - * @type {number} - * @memberof NewsEventsSourcesApiNewsEventsSourcesRetrieve + * 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} */ - readonly id: number + async newsEventsSourcesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.newsEventsSourcesRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["NewsEventsSourcesApi.newsEventsSourcesRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * NewsEventsSourcesApi - object-oriented interface + * NewsEventsSourcesApi - factory interface * @export - * @class NewsEventsSourcesApi - * @extends {BaseAPI} */ -export class NewsEventsSourcesApi extends BaseAPI { +export const NewsEventsSourcesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = NewsEventsSourcesApiFp(configuration) + return { /** * Get a paginated list of news/event feed sources. * @param {NewsEventsSourcesApiNewsEventsSourcesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof NewsEventsSourcesApi */ - public newsEventsSourcesList(requestParameters: NewsEventsSourcesApiNewsEventsSourcesListRequest = {}, options?: RawAxiosRequestConfig) { - return NewsEventsSourcesApiFp(this.configuration).newsEventsSourcesList(requestParameters.feed_type, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + newsEventsSourcesList( + requestParameters: NewsEventsSourcesApiNewsEventsSourcesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .newsEventsSourcesList( + requestParameters.feed_type, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a single news/event feed source. * @param {NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof NewsEventsSourcesApi */ - public newsEventsSourcesRetrieve(requestParameters: NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest, options?: RawAxiosRequestConfig) { - return NewsEventsSourcesApiFp(this.configuration).newsEventsSourcesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + newsEventsSourcesRetrieve( + requestParameters: NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .newsEventsSourcesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for newsEventsSourcesList operation in NewsEventsSourcesApi. * @export + * @interface NewsEventsSourcesApiNewsEventsSourcesListRequest */ -export const NewsEventsSourcesListFeedTypeEnum = { - Events: 'events', - News: 'news' -} as const; -export type NewsEventsSourcesListFeedTypeEnum = typeof NewsEventsSourcesListFeedTypeEnum[keyof typeof NewsEventsSourcesListFeedTypeEnum]; - +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 +} /** - * ProfilesApi - axios parameter creator + * Request parameters for newsEventsSourcesRetrieve operation in NewsEventsSourcesApi. * @export + * @interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest */ -export const ProfilesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * View for profile - * @param {string} user__username - * @param {PatchedProfileRequest} [PatchedProfileRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesPartialUpdate: async (user__username: string, PatchedProfileRequest?: PatchedProfileRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'user__username' is not null or undefined - assertParamExists('profilesPartialUpdate', 'user__username', user__username) - const localVarPath = `/api/v0/profiles/{user__username}/` - .replace(`{${"user__username"}}`, encodeURIComponent(String(user__username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedProfileRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for profile - * @param {string} user__username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesRetrieve: async (user__username: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'user__username' is not null or undefined - assertParamExists('profilesRetrieve', 'user__username', user__username) - const localVarPath = `/api/v0/profiles/{user__username}/` - .replace(`{${"user__username"}}`, encodeURIComponent(String(user__username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for profile - * @param {string} user__username - * @param {ProfileRequest} [ProfileRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesUpdate: async (user__username: string, ProfileRequest?: ProfileRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'user__username' is not null or undefined - assertParamExists('profilesUpdate', 'user__username', user__username) - const localVarPath = `/api/v0/profiles/{user__username}/` - .replace(`{${"user__username"}}`, encodeURIComponent(String(user__username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(ProfileRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest { + /** + * A unique integer value identifying this feed source. + * @type {number} + * @memberof NewsEventsSourcesApiNewsEventsSourcesRetrieve + */ + readonly id: number +} /** - * ProfilesApi - functional programming interface + * NewsEventsSourcesApi - object-oriented interface * @export + * @class NewsEventsSourcesApi + * @extends {BaseAPI} */ -export const ProfilesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ProfilesApiAxiosParamCreator(configuration) - return { - /** - * View for profile - * @param {string} user__username - * @param {PatchedProfileRequest} [PatchedProfileRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async profilesPartialUpdate(user__username: string, PatchedProfileRequest?: PatchedProfileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.profilesPartialUpdate(user__username, PatchedProfileRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProfilesApi.profilesPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for profile - * @param {string} user__username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async profilesRetrieve(user__username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.profilesRetrieve(user__username, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProfilesApi.profilesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for profile - * @param {string} user__username - * @param {ProfileRequest} [ProfileRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async profilesUpdate(user__username: string, ProfileRequest?: ProfileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.profilesUpdate(user__username, ProfileRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProfilesApi.profilesUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export 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 + */ + public newsEventsSourcesList( + requestParameters: NewsEventsSourcesApiNewsEventsSourcesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return NewsEventsSourcesApiFp(this.configuration) + .newsEventsSourcesList( + requestParameters.feed_type, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single news/event feed source. + * @param {NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NewsEventsSourcesApi + */ + public newsEventsSourcesRetrieve( + requestParameters: NewsEventsSourcesApiNewsEventsSourcesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return NewsEventsSourcesApiFp(this.configuration) + .newsEventsSourcesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * ProfilesApi - factory interface * @export */ -export const ProfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ProfilesApiFp(configuration) - return { - /** - * View for profile - * @param {ProfilesApiProfilesPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesPartialUpdate(requestParameters: ProfilesApiProfilesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.profilesPartialUpdate(requestParameters.user__username, requestParameters.PatchedProfileRequest, options).then((request) => request(axios, basePath)); - }, - /** - * View for profile - * @param {ProfilesApiProfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesRetrieve(requestParameters: ProfilesApiProfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.profilesRetrieve(requestParameters.user__username, options).then((request) => request(axios, basePath)); - }, - /** - * View for profile - * @param {ProfilesApiProfilesUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilesUpdate(requestParameters: ProfilesApiProfilesUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.profilesUpdate(requestParameters.user__username, requestParameters.ProfileRequest, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const NewsEventsSourcesListFeedTypeEnum = { + Events: "events", + News: "news", +} as const +export type NewsEventsSourcesListFeedTypeEnum = + (typeof NewsEventsSourcesListFeedTypeEnum)[keyof typeof NewsEventsSourcesListFeedTypeEnum] /** - * Request parameters for profilesPartialUpdate operation in ProfilesApi. + * ProfilesApi - axios parameter creator * @export - * @interface ProfilesApiProfilesPartialUpdateRequest */ -export interface ProfilesApiProfilesPartialUpdateRequest { +export const ProfilesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {string} - * @memberof ProfilesApiProfilesPartialUpdate + * View for profile + * @param {string} user__username + * @param {PatchedProfileRequest} [PatchedProfileRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly user__username: string - + profilesPartialUpdate: async ( + user__username: string, + PatchedProfileRequest?: PatchedProfileRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'user__username' is not null or undefined + assertParamExists( + "profilesPartialUpdate", + "user__username", + user__username, + ) + const localVarPath = `/api/v0/profiles/{user__username}/`.replace( + `{${"user__username"}}`, + encodeURIComponent(String(user__username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedProfileRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * View for profile + * @param {string} user__username + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + profilesRetrieve: async ( + user__username: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'user__username' is not null or undefined + assertParamExists("profilesRetrieve", "user__username", user__username) + const localVarPath = `/api/v0/profiles/{user__username}/`.replace( + `{${"user__username"}}`, + encodeURIComponent(String(user__username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {PatchedProfileRequest} - * @memberof ProfilesApiProfilesPartialUpdate + * View for profile + * @param {string} user__username + * @param {ProfileRequest} [ProfileRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly PatchedProfileRequest?: PatchedProfileRequest + profilesUpdate: async ( + user__username: string, + ProfileRequest?: ProfileRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'user__username' is not null or undefined + assertParamExists("profilesUpdate", "user__username", user__username) + const localVarPath = `/api/v0/profiles/{user__username}/`.replace( + `{${"user__username"}}`, + encodeURIComponent(String(user__username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PUT", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + ProfileRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for profilesRetrieve operation in ProfilesApi. + * ProfilesApi - functional programming interface * @export - * @interface ProfilesApiProfilesRetrieveRequest */ -export interface ProfilesApiProfilesRetrieveRequest { +export const ProfilesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = ProfilesApiAxiosParamCreator(configuration) + return { /** - * - * @type {string} - * @memberof ProfilesApiProfilesRetrieve + * View for profile + * @param {string} user__username + * @param {PatchedProfileRequest} [PatchedProfileRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly user__username: string -} - -/** - * Request parameters for profilesUpdate operation in ProfilesApi. - * @export - * @interface ProfilesApiProfilesUpdateRequest - */ -export interface ProfilesApiProfilesUpdateRequest { + async profilesPartialUpdate( + user__username: string, + PatchedProfileRequest?: PatchedProfileRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.profilesPartialUpdate( + user__username, + PatchedProfileRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProfilesApi.profilesPartialUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {string} - * @memberof ProfilesApiProfilesUpdate + * View for profile + * @param {string} user__username + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly user__username: string - + async profilesRetrieve( + user__username: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.profilesRetrieve( + user__username, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProfilesApi.profilesRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {ProfileRequest} - * @memberof ProfilesApiProfilesUpdate + * View for profile + * @param {string} user__username + * @param {ProfileRequest} [ProfileRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly ProfileRequest?: ProfileRequest + async profilesUpdate( + user__username: string, + ProfileRequest?: ProfileRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.profilesUpdate( + user__username, + ProfileRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProfilesApi.profilesUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * ProfilesApi - object-oriented interface + * ProfilesApi - factory interface * @export - * @class ProfilesApi - * @extends {BaseAPI} */ -export class ProfilesApi extends BaseAPI { +export const ProfilesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ProfilesApiFp(configuration) + return { /** * View for profile * @param {ProfilesApiProfilesPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProfilesApi */ - public profilesPartialUpdate(requestParameters: ProfilesApiProfilesPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return ProfilesApiFp(this.configuration).profilesPartialUpdate(requestParameters.user__username, requestParameters.PatchedProfileRequest, options).then((request) => request(this.axios, this.basePath)); - } - + profilesPartialUpdate( + requestParameters: ProfilesApiProfilesPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .profilesPartialUpdate( + requestParameters.user__username, + requestParameters.PatchedProfileRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * View for profile * @param {ProfilesApiProfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProfilesApi */ - public profilesRetrieve(requestParameters: ProfilesApiProfilesRetrieveRequest, options?: RawAxiosRequestConfig) { - return ProfilesApiFp(this.configuration).profilesRetrieve(requestParameters.user__username, options).then((request) => request(this.axios, this.basePath)); - } - + profilesRetrieve( + requestParameters: ProfilesApiProfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .profilesRetrieve(requestParameters.user__username, options) + .then((request) => request(axios, basePath)) + }, /** * View for profile * @param {ProfilesApiProfilesUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProfilesApi */ - public profilesUpdate(requestParameters: ProfilesApiProfilesUpdateRequest, options?: RawAxiosRequestConfig) { - return ProfilesApiFp(this.configuration).profilesUpdate(requestParameters.user__username, requestParameters.ProfileRequest, options).then((request) => request(this.axios, this.basePath)); - } + profilesUpdate( + requestParameters: ProfilesApiProfilesUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .profilesUpdate( + requestParameters.user__username, + requestParameters.ProfileRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * ProgramCertificatesApi - axios parameter creator + * Request parameters for profilesPartialUpdate operation in ProfilesApi. * @export + * @interface ProfilesApiProfilesPartialUpdateRequest */ -export const ProgramCertificatesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (micromasters_program_id?: number, program_title?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/program_certificates/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (micromasters_program_id !== undefined) { - localVarQueryParameter['micromasters_program_id'] = micromasters_program_id; - } - - if (program_title !== undefined) { - localVarQueryParameter['program_title'] = program_title; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface ProfilesApiProfilesPartialUpdateRequest { + /** + * + * @type {string} + * @memberof ProfilesApiProfilesPartialUpdate + */ + readonly user__username: string + + /** + * + * @type {PatchedProfileRequest} + * @memberof ProfilesApiProfilesPartialUpdate + */ + readonly PatchedProfileRequest?: PatchedProfileRequest +} /** - * ProgramCertificatesApi - functional programming interface + * Request parameters for profilesRetrieve operation in ProfilesApi. * @export + * @interface ProfilesApiProfilesRetrieveRequest */ -export const ProgramCertificatesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ProgramCertificatesApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async programCertificatesList(micromasters_program_id?: number, program_title?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.programCertificatesList(micromasters_program_id, program_title, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProgramCertificatesApi.programCertificatesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface ProfilesApiProfilesRetrieveRequest { + /** + * + * @type {string} + * @memberof ProfilesApiProfilesRetrieve + */ + readonly user__username: string +} /** - * ProgramCertificatesApi - factory interface + * Request parameters for profilesUpdate operation in ProfilesApi. * @export + * @interface ProfilesApiProfilesUpdateRequest */ -export const ProgramCertificatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ProgramCertificatesApiFp(configuration) - return { - /** - * 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> { - return localVarFp.programCertificatesList(requestParameters.micromasters_program_id, requestParameters.program_title, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface ProfilesApiProfilesUpdateRequest { + /** + * + * @type {string} + * @memberof ProfilesApiProfilesUpdate + */ + readonly user__username: string + + /** + * + * @type {ProfileRequest} + * @memberof ProfilesApiProfilesUpdate + */ + readonly ProfileRequest?: ProfileRequest +} /** - * Request parameters for programCertificatesList operation in ProgramCertificatesApi. + * ProfilesApi - object-oriented interface * @export - * @interface ProgramCertificatesApiProgramCertificatesListRequest + * @class ProfilesApi + * @extends {BaseAPI} */ -export interface ProgramCertificatesApiProgramCertificatesListRequest { - /** - * - * @type {number} - * @memberof ProgramCertificatesApiProgramCertificatesList - */ - readonly micromasters_program_id?: number +export class ProfilesApi extends BaseAPI { + /** + * View for profile + * @param {ProfilesApiProfilesPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProfilesApi + */ + public profilesPartialUpdate( + requestParameters: ProfilesApiProfilesPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return ProfilesApiFp(this.configuration) + .profilesPartialUpdate( + requestParameters.user__username, + requestParameters.PatchedProfileRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for profile + * @param {ProfilesApiProfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProfilesApi + */ + public profilesRetrieve( + requestParameters: ProfilesApiProfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ProfilesApiFp(this.configuration) + .profilesRetrieve(requestParameters.user__username, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for profile + * @param {ProfilesApiProfilesUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProfilesApi + */ + public profilesUpdate( + requestParameters: ProfilesApiProfilesUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return ProfilesApiFp(this.configuration) + .profilesUpdate( + requestParameters.user__username, + requestParameters.ProfileRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} +/** + * ProgramCertificatesApi - axios parameter creator + * @export + */ +export const ProgramCertificatesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {string} - * @memberof ProgramCertificatesApiProgramCertificatesList + * 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} */ - readonly program_title?: string + programCertificatesList: async ( + micromasters_program_id?: number, + program_title?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/program_certificates/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (micromasters_program_id !== undefined) { + localVarQueryParameter["micromasters_program_id"] = + micromasters_program_id + } + + if (program_title !== undefined) { + localVarQueryParameter["program_title"] = program_title + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * ProgramCertificatesApi - object-oriented interface + * ProgramCertificatesApi - functional programming interface * @export - * @class ProgramCertificatesApi - * @extends {BaseAPI} */ -export class ProgramCertificatesApi extends BaseAPI { +export const ProgramCertificatesApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + ProgramCertificatesApiAxiosParamCreator(configuration) + return { /** * View for listing program certificates for a user (includes program letter links) - * @param {ProgramCertificatesApiProgramCertificatesListRequest} requestParameters Request parameters. + * @param {number} [micromasters_program_id] + * @param {string} [program_title] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProgramCertificatesApi */ - public programCertificatesList(requestParameters: ProgramCertificatesApiProgramCertificatesListRequest = {}, options?: RawAxiosRequestConfig) { - return ProgramCertificatesApiFp(this.configuration).programCertificatesList(requestParameters.micromasters_program_id, requestParameters.program_title, options).then((request) => request(this.axios, this.basePath)); - } + async programCertificatesList( + micromasters_program_id?: number, + program_title?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.programCertificatesList( + micromasters_program_id, + program_title, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProgramCertificatesApi.programCertificatesList"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } - - /** - * TestimonialsApi - axios parameter creator + * ProgramCertificatesApi - factory interface * @export */ -export const TestimonialsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (channels?: Array, limit?: number, offerors?: Array, offset?: number, position?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/testimonials/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (channels) { - localVarQueryParameter['channels'] = channels; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offerors) { - localVarQueryParameter['offerors'] = offerors; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (position !== undefined) { - localVarQueryParameter['position'] = position; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a testimonial. - * @summary Retrieve - * @param {number} id A unique integer value identifying this attestation. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - testimonialsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('testimonialsRetrieve', 'id', id) - const localVarPath = `/api/v0/testimonials/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const ProgramCertificatesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ProgramCertificatesApiFp(configuration) + return { + /** + * 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> { + return localVarFp + .programCertificatesList( + requestParameters.micromasters_program_id, + requestParameters.program_title, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} /** - * TestimonialsApi - functional programming interface + * Request parameters for programCertificatesList operation in ProgramCertificatesApi. * @export + * @interface ProgramCertificatesApiProgramCertificatesListRequest */ -export const TestimonialsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TestimonialsApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async testimonialsList(channels?: Array, limit?: number, offerors?: Array, offset?: number, position?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testimonialsList(channels, limit, offerors, offset, position, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TestimonialsApi.testimonialsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a testimonial. - * @summary Retrieve - * @param {number} id A unique integer value identifying this attestation. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async testimonialsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.testimonialsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TestimonialsApi.testimonialsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface ProgramCertificatesApiProgramCertificatesListRequest { + /** + * + * @type {number} + * @memberof ProgramCertificatesApiProgramCertificatesList + */ + readonly micromasters_program_id?: number + + /** + * + * @type {string} + * @memberof ProgramCertificatesApiProgramCertificatesList + */ + readonly program_title?: string +} /** - * TestimonialsApi - factory interface + * ProgramCertificatesApi - object-oriented interface * @export + * @class ProgramCertificatesApi + * @extends {BaseAPI} */ -export const TestimonialsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TestimonialsApiFp(configuration) - return { - /** - * List all testimonials. - * @summary List - * @param {TestimonialsApiTestimonialsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - testimonialsList(requestParameters: TestimonialsApiTestimonialsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testimonialsList(requestParameters.channels, requestParameters.limit, requestParameters.offerors, requestParameters.offset, requestParameters.position, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a testimonial. - * @summary Retrieve - * @param {TestimonialsApiTestimonialsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - testimonialsRetrieve(requestParameters: TestimonialsApiTestimonialsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.testimonialsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export 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 + */ + public programCertificatesList( + requestParameters: ProgramCertificatesApiProgramCertificatesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return ProgramCertificatesApiFp(this.configuration) + .programCertificatesList( + requestParameters.micromasters_program_id, + requestParameters.program_title, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for testimonialsList operation in TestimonialsApi. + * TestimonialsApi - axios parameter creator * @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 - +export const TestimonialsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * 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 + * 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} */ - readonly offset?: number - + testimonialsList: async ( + channels?: Array, + limit?: number, + offerors?: Array, + offset?: number, + position?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/testimonials/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (channels) { + localVarQueryParameter["channels"] = channels + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offerors) { + localVarQueryParameter["offerors"] = offerors + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (position !== undefined) { + localVarQueryParameter["position"] = position + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Only show items that exist at this position - * @type {number} - * @memberof TestimonialsApiTestimonialsList + * Retrieve a testimonial. + * @summary Retrieve + * @param {number} id A unique integer value identifying this attestation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly position?: number + testimonialsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("testimonialsRetrieve", "id", id) + const localVarPath = `/api/v0/testimonials/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for testimonialsRetrieve operation in TestimonialsApi. + * TestimonialsApi - functional programming interface * @export - * @interface TestimonialsApiTestimonialsRetrieveRequest */ -export interface TestimonialsApiTestimonialsRetrieveRequest { +export const TestimonialsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + TestimonialsApiAxiosParamCreator(configuration) + return { + /** + * 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} + */ + async testimonialsList( + channels?: Array, + limit?: number, + offerors?: Array, + offset?: number, + position?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.testimonialsList( + channels, + limit, + offerors, + offset, + position, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TestimonialsApi.testimonialsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this attestation. - * @type {number} - * @memberof TestimonialsApiTestimonialsRetrieve + * Retrieve a testimonial. + * @summary Retrieve + * @param {number} id A unique integer value identifying this attestation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async testimonialsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.testimonialsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TestimonialsApi.testimonialsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * TestimonialsApi - object-oriented interface + * TestimonialsApi - factory interface * @export - * @class TestimonialsApi - * @extends {BaseAPI} */ -export class TestimonialsApi extends BaseAPI { +export const TestimonialsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = TestimonialsApiFp(configuration) + return { /** * List all testimonials. * @summary List * @param {TestimonialsApiTestimonialsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TestimonialsApi */ - public testimonialsList(requestParameters: TestimonialsApiTestimonialsListRequest = {}, options?: RawAxiosRequestConfig) { - return TestimonialsApiFp(this.configuration).testimonialsList(requestParameters.channels, requestParameters.limit, requestParameters.offerors, requestParameters.offset, requestParameters.position, options).then((request) => request(this.axios, this.basePath)); - } - + testimonialsList( + requestParameters: TestimonialsApiTestimonialsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .testimonialsList( + requestParameters.channels, + requestParameters.limit, + requestParameters.offerors, + requestParameters.offset, + requestParameters.position, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a testimonial. * @summary Retrieve * @param {TestimonialsApiTestimonialsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TestimonialsApi */ - public testimonialsRetrieve(requestParameters: TestimonialsApiTestimonialsRetrieveRequest, options?: RawAxiosRequestConfig) { - return TestimonialsApiFp(this.configuration).testimonialsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + testimonialsRetrieve( + requestParameters: TestimonialsApiTestimonialsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .testimonialsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * TutorApi - axios parameter creator + * Request parameters for testimonialsList operation in TestimonialsApi. * @export + * @interface TestimonialsApiTestimonialsListRequest */ -export const TutorApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (run_readable_id: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'run_readable_id' is not null or undefined - assertParamExists('listProblems', 'run_readable_id', run_readable_id) - const localVarPath = `/api/v0/tutor/problems/{run_readable_id}/` - .replace(`{${"run_readable_id"}}`, encodeURIComponent(String(run_readable_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (problem_title: string, run_readable_id: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'problem_title' is not null or undefined - assertParamExists('retrieveProblem', 'problem_title', problem_title) - // verify required parameter 'run_readable_id' is not null or undefined - assertParamExists('retrieveProblem', 'run_readable_id', run_readable_id) - const localVarPath = `/api/v0/tutor/problems/{run_readable_id}/{problem_title}/` - .replace(`{${"problem_title"}}`, encodeURIComponent(String(problem_title))) - .replace(`{${"run_readable_id"}}`, encodeURIComponent(String(run_readable_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +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 +} /** - * TutorApi - functional programming interface + * Request parameters for testimonialsRetrieve operation in TestimonialsApi. * @export + * @interface TestimonialsApiTestimonialsRetrieveRequest */ -export const TutorApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TutorApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async listProblems(run_readable_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listProblems(run_readable_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TutorApi.listProblems']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * 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} - */ - async retrieveProblem(problem_title: string, run_readable_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveProblem(problem_title, run_readable_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TutorApi.retrieveProblem']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface TestimonialsApiTestimonialsRetrieveRequest { + /** + * A unique integer value identifying this attestation. + * @type {number} + * @memberof TestimonialsApiTestimonialsRetrieve + */ + readonly id: number +} /** - * TutorApi - factory interface + * TestimonialsApi - object-oriented interface * @export + * @class TestimonialsApi + * @extends {BaseAPI} */ -export const TutorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TutorApiFp(configuration) - return { - /** - * 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 { - return localVarFp.listProblems(requestParameters.run_readable_id, options).then((request) => request(axios, basePath)); - }, - /** - * 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 { - return localVarFp.retrieveProblem(requestParameters.problem_title, requestParameters.run_readable_id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class TestimonialsApi extends BaseAPI { + /** + * List all testimonials. + * @summary List + * @param {TestimonialsApiTestimonialsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TestimonialsApi + */ + public testimonialsList( + requestParameters: TestimonialsApiTestimonialsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return TestimonialsApiFp(this.configuration) + .testimonialsList( + requestParameters.channels, + requestParameters.limit, + requestParameters.offerors, + requestParameters.offset, + requestParameters.position, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a testimonial. + * @summary Retrieve + * @param {TestimonialsApiTestimonialsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TestimonialsApi + */ + public testimonialsRetrieve( + requestParameters: TestimonialsApiTestimonialsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return TestimonialsApiFp(this.configuration) + .testimonialsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for listProblems operation in TutorApi. + * TutorApi - axios parameter creator * @export - * @interface TutorApiListProblemsRequest */ -export interface TutorApiListProblemsRequest { +export const TutorApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * 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: async ( + run_readable_id: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'run_readable_id' is not null or undefined + assertParamExists("listProblems", "run_readable_id", run_readable_id) + const localVarPath = `/api/v0/tutor/problems/{run_readable_id}/`.replace( + `{${"run_readable_id"}}`, + encodeURIComponent(String(run_readable_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof TutorApiListProblems + * 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} */ - readonly run_readable_id: string + retrieveProblem: async ( + problem_title: string, + run_readable_id: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'problem_title' is not null or undefined + assertParamExists("retrieveProblem", "problem_title", problem_title) + // verify required parameter 'run_readable_id' is not null or undefined + assertParamExists("retrieveProblem", "run_readable_id", run_readable_id) + const localVarPath = + `/api/v0/tutor/problems/{run_readable_id}/{problem_title}/` + .replace( + `{${"problem_title"}}`, + encodeURIComponent(String(problem_title)), + ) + .replace( + `{${"run_readable_id"}}`, + encodeURIComponent(String(run_readable_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for retrieveProblem operation in TutorApi. + * TutorApi - functional programming interface * @export - * @interface TutorApiRetrieveProblemRequest */ -export interface TutorApiRetrieveProblemRequest { +export const TutorApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = TutorApiAxiosParamCreator(configuration) + return { /** - * - * @type {string} - * @memberof TutorApiRetrieveProblem + * 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} */ - readonly problem_title: string - + async listProblems( + run_readable_id: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.listProblems( + run_readable_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TutorApi.listProblems"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {string} - * @memberof TutorApiRetrieveProblem + * 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} */ - readonly run_readable_id: string + async retrieveProblem( + problem_title: string, + run_readable_id: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.retrieveProblem( + problem_title, + run_readable_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TutorApi.retrieveProblem"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * TutorApi - object-oriented interface + * TutorApi - factory interface * @export - * @class TutorApi - * @extends {BaseAPI} */ -export class TutorApi extends BaseAPI { +export const TutorApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = TutorApiFp(configuration) + return { /** * 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 */ - public listProblems(requestParameters: TutorApiListProblemsRequest, options?: RawAxiosRequestConfig) { - return TutorApiFp(this.configuration).listProblems(requestParameters.run_readable_id, options).then((request) => request(this.axios, this.basePath)); - } - + listProblems( + requestParameters: TutorApiListProblemsRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .listProblems(requestParameters.run_readable_id, options) + .then((request) => request(axios, basePath)) + }, /** * 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 */ - public retrieveProblem(requestParameters: TutorApiRetrieveProblemRequest, options?: RawAxiosRequestConfig) { - return TutorApiFp(this.configuration).retrieveProblem(requestParameters.problem_title, requestParameters.run_readable_id, options).then((request) => request(this.axios, this.basePath)); - } + retrieveProblem( + requestParameters: TutorApiRetrieveProblemRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .retrieveProblem( + requestParameters.problem_title, + requestParameters.run_readable_id, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * UsersApi - axios parameter creator + * Request parameters for listProblems operation in TutorApi. * @export + * @interface TutorApiListProblemsRequest */ -export const UsersApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * View for users - * @param {UserRequest} UserRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersCreate: async (UserRequest: UserRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'UserRequest' is not null or undefined - assertParamExists('usersCreate', 'UserRequest', UserRequest) - const localVarPath = `/api/v0/users/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(UserRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for users - * @param {string} username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersDestroy: async (username: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('usersDestroy', 'username', username) - const localVarPath = `/api/v0/users/{username}/` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for users - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersList: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/users/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * User retrieve and update viewsets for the current user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersMeRetrieve: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v0/users/me/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for users - * @param {string} username - * @param {PatchedUserRequest} [PatchedUserRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersPartialUpdate: async (username: string, PatchedUserRequest?: PatchedUserRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('usersPartialUpdate', 'username', username) - const localVarPath = `/api/v0/users/{username}/` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedUserRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for users - * @param {string} username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersRetrieve: async (username: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('usersRetrieve', 'username', username) - const localVarPath = `/api/v0/users/{username}/` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for users - * @param {string} username - * @param {UserRequest} UserRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersUpdate: async (username: string, UserRequest: UserRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('usersUpdate', 'username', username) - // verify required parameter 'UserRequest' is not null or undefined - assertParamExists('usersUpdate', 'UserRequest', UserRequest) - const localVarPath = `/api/v0/users/{username}/` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(UserRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface TutorApiListProblemsRequest { + /** + * + * @type {string} + * @memberof TutorApiListProblems + */ + readonly run_readable_id: string +} /** - * UsersApi - functional programming interface + * Request parameters for retrieveProblem operation in TutorApi. * @export + * @interface TutorApiRetrieveProblemRequest */ -export const UsersApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration) - return { - /** - * View for users - * @param {UserRequest} UserRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersCreate(UserRequest: UserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersCreate(UserRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for users - * @param {string} username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersDestroy(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersDestroy(username, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for users - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersList(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * User retrieve and update viewsets for the current user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersMeRetrieve(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersMeRetrieve(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersMeRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for users - * @param {string} username - * @param {PatchedUserRequest} [PatchedUserRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersPartialUpdate(username: string, PatchedUserRequest?: PatchedUserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersPartialUpdate(username, PatchedUserRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for users - * @param {string} username - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersRetrieve(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersRetrieve(username, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for users - * @param {string} username - * @param {UserRequest} UserRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async usersUpdate(username: string, UserRequest: UserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.usersUpdate(username, UserRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UsersApi.usersUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface TutorApiRetrieveProblemRequest { + /** + * + * @type {string} + * @memberof TutorApiRetrieveProblem + */ + readonly problem_title: string + + /** + * + * @type {string} + * @memberof TutorApiRetrieveProblem + */ + readonly run_readable_id: string +} /** - * UsersApi - factory interface + * TutorApi - object-oriented interface * @export + * @class TutorApi + * @extends {BaseAPI} */ -export const UsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UsersApiFp(configuration) - return { - /** - * View for users - * @param {UsersApiUsersCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersCreate(requestParameters: UsersApiUsersCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersCreate(requestParameters.UserRequest, options).then((request) => request(axios, basePath)); - }, - /** - * View for users - * @param {UsersApiUsersDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersDestroy(requestParameters: UsersApiUsersDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersDestroy(requestParameters.username, options).then((request) => request(axios, basePath)); - }, - /** - * View for users - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersList(options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.usersList(options).then((request) => request(axios, basePath)); - }, - /** - * User retrieve and update viewsets for the current user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersMeRetrieve(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersMeRetrieve(options).then((request) => request(axios, basePath)); - }, - /** - * View for users - * @param {UsersApiUsersPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersPartialUpdate(requestParameters: UsersApiUsersPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersPartialUpdate(requestParameters.username, requestParameters.PatchedUserRequest, options).then((request) => request(axios, basePath)); - }, - /** - * View for users - * @param {UsersApiUsersRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersRetrieve(requestParameters: UsersApiUsersRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersRetrieve(requestParameters.username, options).then((request) => request(axios, basePath)); - }, - /** - * View for users - * @param {UsersApiUsersUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - usersUpdate(requestParameters: UsersApiUsersUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.usersUpdate(requestParameters.username, requestParameters.UserRequest, options).then((request) => request(axios, basePath)); - }, - }; -}; +export 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 + */ + public listProblems( + requestParameters: TutorApiListProblemsRequest, + options?: RawAxiosRequestConfig, + ) { + return TutorApiFp(this.configuration) + .listProblems(requestParameters.run_readable_id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * 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 + */ + public retrieveProblem( + requestParameters: TutorApiRetrieveProblemRequest, + options?: RawAxiosRequestConfig, + ) { + return TutorApiFp(this.configuration) + .retrieveProblem( + requestParameters.problem_title, + requestParameters.run_readable_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for usersCreate operation in UsersApi. + * UsersApi - axios parameter creator * @export - * @interface UsersApiUsersCreateRequest */ -export interface UsersApiUsersCreateRequest { +export const UsersApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {UserRequest} - * @memberof UsersApiUsersCreate + * View for users + * @param {UserRequest} UserRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly UserRequest: UserRequest -} - -/** - * Request parameters for usersDestroy operation in UsersApi. - * @export - * @interface UsersApiUsersDestroyRequest - */ -export interface UsersApiUsersDestroyRequest { + usersCreate: async ( + UserRequest: UserRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'UserRequest' is not null or undefined + assertParamExists("usersCreate", "UserRequest", UserRequest) + const localVarPath = `/api/v0/users/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + UserRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof UsersApiUsersDestroy + * View for users + * @param {string} username + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly username: string -} - -/** - * Request parameters for usersPartialUpdate operation in UsersApi. - * @export - * @interface UsersApiUsersPartialUpdateRequest - */ -export interface UsersApiUsersPartialUpdateRequest { + usersDestroy: async ( + username: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists("usersDestroy", "username", username) + const localVarPath = `/api/v0/users/{username}/`.replace( + `{${"username"}}`, + encodeURIComponent(String(username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof UsersApiUsersPartialUpdate + * View for users + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly username: string - + usersList: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/users/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * User retrieve and update viewsets for the current user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + usersMeRetrieve: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v0/users/me/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {PatchedUserRequest} - * @memberof UsersApiUsersPartialUpdate + * View for users + * @param {string} username + * @param {PatchedUserRequest} [PatchedUserRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly PatchedUserRequest?: PatchedUserRequest -} - -/** - * Request parameters for usersRetrieve operation in UsersApi. - * @export - * @interface UsersApiUsersRetrieveRequest - */ -export interface UsersApiUsersRetrieveRequest { + usersPartialUpdate: async ( + username: string, + PatchedUserRequest?: PatchedUserRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists("usersPartialUpdate", "username", username) + const localVarPath = `/api/v0/users/{username}/`.replace( + `{${"username"}}`, + encodeURIComponent(String(username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedUserRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * View for users + * @param {string} username + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + usersRetrieve: async ( + username: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists("usersRetrieve", "username", username) + const localVarPath = `/api/v0/users/{username}/`.replace( + `{${"username"}}`, + encodeURIComponent(String(username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof UsersApiUsersRetrieve + * View for users + * @param {string} username + * @param {UserRequest} UserRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly username: string + usersUpdate: async ( + username: string, + UserRequest: UserRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists("usersUpdate", "username", username) + // verify required parameter 'UserRequest' is not null or undefined + assertParamExists("usersUpdate", "UserRequest", UserRequest) + const localVarPath = `/api/v0/users/{username}/`.replace( + `{${"username"}}`, + encodeURIComponent(String(username)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PUT", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + UserRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for usersUpdate operation in UsersApi. + * UsersApi - functional programming interface * @export - * @interface UsersApiUsersUpdateRequest */ -export interface UsersApiUsersUpdateRequest { +export const UsersApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration) + return { /** - * - * @type {string} - * @memberof UsersApiUsersUpdate + * View for users + * @param {UserRequest} UserRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly username: string - + async usersCreate( + UserRequest: UserRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.usersCreate( + UserRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * View for users + * @param {string} username + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async usersDestroy( + username: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.usersDestroy( + username, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersDestroy"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * View for users + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async usersList( + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.usersList(options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * User retrieve and update viewsets for the current user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async usersMeRetrieve( + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.usersMeRetrieve(options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersMeRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * View for users + * @param {string} username + * @param {PatchedUserRequest} [PatchedUserRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async usersPartialUpdate( + username: string, + PatchedUserRequest?: PatchedUserRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.usersPartialUpdate( + username, + PatchedUserRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersPartialUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * View for users + * @param {string} username + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async usersRetrieve( + username: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.usersRetrieve( + username, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {UserRequest} - * @memberof UsersApiUsersUpdate + * View for users + * @param {string} username + * @param {UserRequest} UserRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly UserRequest: UserRequest + async usersUpdate( + username: string, + UserRequest: UserRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.usersUpdate( + username, + UserRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UsersApi.usersUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * UsersApi - object-oriented interface + * UsersApi - factory interface * @export - * @class UsersApi - * @extends {BaseAPI} */ -export class UsersApi extends BaseAPI { +export const UsersApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = UsersApiFp(configuration) + return { /** * View for users * @param {UsersApiUsersCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersCreate(requestParameters: UsersApiUsersCreateRequest, options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersCreate(requestParameters.UserRequest, options).then((request) => request(this.axios, this.basePath)); - } - + usersCreate( + requestParameters: UsersApiUsersCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .usersCreate(requestParameters.UserRequest, options) + .then((request) => request(axios, basePath)) + }, /** * View for users * @param {UsersApiUsersDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersDestroy(requestParameters: UsersApiUsersDestroyRequest, options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersDestroy(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); - } - + usersDestroy( + requestParameters: UsersApiUsersDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .usersDestroy(requestParameters.username, options) + .then((request) => request(axios, basePath)) + }, /** * View for users * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersList(options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersList(options).then((request) => request(this.axios, this.basePath)); - } - + usersList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp + .usersList(options) + .then((request) => request(axios, basePath)) + }, /** * User retrieve and update viewsets for the current user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersMeRetrieve(options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersMeRetrieve(options).then((request) => request(this.axios, this.basePath)); - } - + usersMeRetrieve(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp + .usersMeRetrieve(options) + .then((request) => request(axios, basePath)) + }, /** * View for users * @param {UsersApiUsersPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersPartialUpdate(requestParameters: UsersApiUsersPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersPartialUpdate(requestParameters.username, requestParameters.PatchedUserRequest, options).then((request) => request(this.axios, this.basePath)); - } - + usersPartialUpdate( + requestParameters: UsersApiUsersPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .usersPartialUpdate( + requestParameters.username, + requestParameters.PatchedUserRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * View for users * @param {UsersApiUsersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersRetrieve(requestParameters: UsersApiUsersRetrieveRequest, options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersRetrieve(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); - } - + usersRetrieve( + requestParameters: UsersApiUsersRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .usersRetrieve(requestParameters.username, options) + .then((request) => request(axios, basePath)) + }, /** * View for users * @param {UsersApiUsersUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ - public usersUpdate(requestParameters: UsersApiUsersUpdateRequest, options?: RawAxiosRequestConfig) { - return UsersApiFp(this.configuration).usersUpdate(requestParameters.username, requestParameters.UserRequest, options).then((request) => request(this.axios, this.basePath)); - } + usersUpdate( + requestParameters: UsersApiUsersUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .usersUpdate( + requestParameters.username, + requestParameters.UserRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * VectorContentFilesSearchApi - axios parameter creator + * Request parameters for usersCreate operation in UsersApi. * @export + * @interface UsersApiUsersCreateRequest */ -export const VectorContentFilesSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (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 => { - const localVarPath = `/api/v0/vector_content_files_search/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (collection_name !== undefined) { - localVarQueryParameter['collection_name'] = collection_name; - } - - if (edx_module_id) { - localVarQueryParameter['edx_module_id'] = edx_module_id; - } - - if (file_extension) { - localVarQueryParameter['file_extension'] = file_extension; - } - - if (group_by !== undefined) { - localVarQueryParameter['group_by'] = group_by; - } - - if (group_size !== undefined) { - localVarQueryParameter['group_size'] = group_size; - } - - if (hybrid_search !== undefined) { - localVarQueryParameter['hybrid_search'] = hybrid_search; - } - - if (key) { - localVarQueryParameter['key'] = key; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_readable_id) { - localVarQueryParameter['resource_readable_id'] = resource_readable_id; - } - - if (run_readable_id) { - localVarQueryParameter['run_readable_id'] = run_readable_id; - } - - if (title__isnull !== undefined) { - localVarQueryParameter['title__isnull'] = title__isnull; - } - - if (url__isnull !== undefined) { - localVarQueryParameter['url__isnull'] = url__isnull; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface UsersApiUsersCreateRequest { + /** + * + * @type {UserRequest} + * @memberof UsersApiUsersCreate + */ + readonly UserRequest: UserRequest +} /** - * VectorContentFilesSearchApi - functional programming interface + * Request parameters for usersDestroy operation in UsersApi. * @export + * @interface UsersApiUsersDestroyRequest */ -export const VectorContentFilesSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VectorContentFilesSearchApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async 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> { - const localVarAxiosArgs = await localVarAxiosParamCreator.vectorContentFilesSearchRetrieve(aggregations, collection_name, edx_module_id, file_extension, group_by, group_size, hybrid_search, key, limit, offered_by, offset, platform, q, resource_readable_id, run_readable_id, title__isnull, url__isnull, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VectorContentFilesSearchApi.vectorContentFilesSearchRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface UsersApiUsersDestroyRequest { + /** + * + * @type {string} + * @memberof UsersApiUsersDestroy + */ + readonly username: string +} /** - * VectorContentFilesSearchApi - factory interface + * Request parameters for usersPartialUpdate operation in UsersApi. * @export + * @interface UsersApiUsersPartialUpdateRequest */ -export const VectorContentFilesSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VectorContentFilesSearchApiFp(configuration) - return { - /** - * 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 { - return localVarFp.vectorContentFilesSearchRetrieve(requestParameters.aggregations, requestParameters.collection_name, requestParameters.edx_module_id, requestParameters.file_extension, requestParameters.group_by, requestParameters.group_size, requestParameters.hybrid_search, requestParameters.key, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.q, requestParameters.resource_readable_id, requestParameters.run_readable_id, requestParameters.title__isnull, requestParameters.url__isnull, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface UsersApiUsersPartialUpdateRequest { + /** + * + * @type {string} + * @memberof UsersApiUsersPartialUpdate + */ + readonly username: string + + /** + * + * @type {PatchedUserRequest} + * @memberof UsersApiUsersPartialUpdate + */ + readonly PatchedUserRequest?: PatchedUserRequest +} /** - * Request parameters for vectorContentFilesSearchRetrieve operation in VectorContentFilesSearchApi. + * Request parameters for usersRetrieve operation in UsersApi. * @export - * @interface VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest + * @interface UsersApiUsersRetrieveRequest */ -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 +export interface UsersApiUsersRetrieveRequest { + /** + * + * @type {string} + * @memberof UsersApiUsersRetrieve + */ + readonly username: string +} - /** - * platform(s) of the content file - * @type {Array} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve - */ - readonly platform?: Array +/** + * 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 +} - /** - * The search text - * @type {string} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve - */ - readonly q?: string +/** + * UsersApi - object-oriented interface + * @export + * @class UsersApi + * @extends {BaseAPI} + */ +export class UsersApi extends BaseAPI { + /** + * View for users + * @param {UsersApiUsersCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersCreate( + requestParameters: UsersApiUsersCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return UsersApiFp(this.configuration) + .usersCreate(requestParameters.UserRequest, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for users + * @param {UsersApiUsersDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersDestroy( + requestParameters: UsersApiUsersDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return UsersApiFp(this.configuration) + .usersDestroy(requestParameters.username, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for users + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersList(options?: RawAxiosRequestConfig) { + return UsersApiFp(this.configuration) + .usersList(options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * User retrieve and update viewsets for the current user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersMeRetrieve(options?: RawAxiosRequestConfig) { + return UsersApiFp(this.configuration) + .usersMeRetrieve(options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for users + * @param {UsersApiUsersPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersPartialUpdate( + requestParameters: UsersApiUsersPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return UsersApiFp(this.configuration) + .usersPartialUpdate( + requestParameters.username, + requestParameters.PatchedUserRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for users + * @param {UsersApiUsersRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersRetrieve( + requestParameters: UsersApiUsersRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return UsersApiFp(this.configuration) + .usersRetrieve(requestParameters.username, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for users + * @param {UsersApiUsersUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UsersApi + */ + public usersUpdate( + requestParameters: UsersApiUsersUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return UsersApiFp(this.configuration) + .usersUpdate( + requestParameters.username, + requestParameters.UserRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} +/** + * VectorContentFilesSearchApi - axios parameter creator + * @export + */ +export const VectorContentFilesSearchApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The readable_id value of the parent learning resource for the content file - * @type {Array} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve + * 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} */ - readonly resource_readable_id?: Array + vectorContentFilesSearchRetrieve: async ( + 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 => { + const localVarPath = `/api/v0/vector_content_files_search/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (collection_name !== undefined) { + localVarQueryParameter["collection_name"] = collection_name + } + + if (edx_module_id) { + localVarQueryParameter["edx_module_id"] = edx_module_id + } + + if (file_extension) { + localVarQueryParameter["file_extension"] = file_extension + } + + if (group_by !== undefined) { + localVarQueryParameter["group_by"] = group_by + } + + if (group_size !== undefined) { + localVarQueryParameter["group_size"] = group_size + } + + if (hybrid_search !== undefined) { + localVarQueryParameter["hybrid_search"] = hybrid_search + } + + if (key) { + localVarQueryParameter["key"] = key + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_readable_id) { + localVarQueryParameter["resource_readable_id"] = resource_readable_id + } + + if (run_readable_id) { + localVarQueryParameter["run_readable_id"] = run_readable_id + } + + if (title__isnull !== undefined) { + localVarQueryParameter["title__isnull"] = title__isnull + } + + if (url__isnull !== undefined) { + localVarQueryParameter["url__isnull"] = url__isnull + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * VectorContentFilesSearchApi - functional programming interface + * @export + */ +export const VectorContentFilesSearchApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + VectorContentFilesSearchApiAxiosParamCreator(configuration) + return { /** - * The readable_id value of the run that the content file belongs to - * @type {Array} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve + * 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} */ - readonly run_readable_id?: Array + async 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 + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.vectorContentFilesSearchRetrieve( + aggregations, + collection_name, + edx_module_id, + file_extension, + group_by, + group_size, + hybrid_search, + key, + limit, + offered_by, + offset, + platform, + q, + resource_readable_id, + run_readable_id, + title__isnull, + url__isnull, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "VectorContentFilesSearchApi.vectorContentFilesSearchRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * VectorContentFilesSearchApi - factory interface + * @export + */ +export const VectorContentFilesSearchApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = VectorContentFilesSearchApiFp(configuration) + return { /** - * Filter to content files where title is null/not null - * @type {boolean} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve + * Vector Search for content + * @summary Content File Vector Search + * @param {VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly title__isnull?: boolean | null + vectorContentFilesSearchRetrieve( + requestParameters: VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .vectorContentFilesSearchRetrieve( + requestParameters.aggregations, + requestParameters.collection_name, + requestParameters.edx_module_id, + requestParameters.file_extension, + requestParameters.group_by, + requestParameters.group_size, + requestParameters.hybrid_search, + requestParameters.key, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.q, + requestParameters.resource_readable_id, + requestParameters.run_readable_id, + requestParameters.title__isnull, + requestParameters.url__isnull, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} - /** - * Filter to content files where url is null/not null - * @type {boolean} - * @memberof VectorContentFilesSearchApiVectorContentFilesSearchRetrieve - */ - readonly url__isnull?: boolean | null +/** + * 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 } /** @@ -9289,275 +10569,443 @@ export interface VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequ * @extends {BaseAPI} */ export 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 - */ - public vectorContentFilesSearchRetrieve(requestParameters: VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig) { - return VectorContentFilesSearchApiFp(this.configuration).vectorContentFilesSearchRetrieve(requestParameters.aggregations, requestParameters.collection_name, requestParameters.edx_module_id, requestParameters.file_extension, requestParameters.group_by, requestParameters.group_size, requestParameters.hybrid_search, requestParameters.key, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.q, requestParameters.resource_readable_id, requestParameters.run_readable_id, requestParameters.title__isnull, requestParameters.url__isnull, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Vector Search for content + * @summary Content File Vector Search + * @param {VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VectorContentFilesSearchApi + */ + public vectorContentFilesSearchRetrieve( + requestParameters: VectorContentFilesSearchApiVectorContentFilesSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return VectorContentFilesSearchApiFp(this.configuration) + .vectorContentFilesSearchRetrieve( + requestParameters.aggregations, + requestParameters.collection_name, + requestParameters.edx_module_id, + requestParameters.file_extension, + requestParameters.group_by, + requestParameters.group_size, + requestParameters.hybrid_search, + requestParameters.key, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.q, + requestParameters.resource_readable_id, + requestParameters.run_readable_id, + requestParameters.title__isnull, + requestParameters.url__isnull, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const VectorContentFilesSearchRetrieveAggregationsEnum = { - Key: 'key', - CourseNumber: 'course_number', - Platform: 'platform', - OfferedBy: 'offered_by', - FileExtension: 'file_extension', - ContentFeatureType: 'content_feature_type', - RunReadableId: 'run_readable_id', - ResourceReadableId: 'resource_readable_id', - RunTitle: 'run_title', - EdxModuleId: 'edx_module_id', - ContentType: 'content_type', - Description: 'description', - Title: 'title', - Url: 'url', - FileType: 'file_type', - Summary: 'summary', - Flashcards: 'flashcards', - Checksum: 'checksum' -} as const; -export type VectorContentFilesSearchRetrieveAggregationsEnum = typeof VectorContentFilesSearchRetrieveAggregationsEnum[keyof typeof VectorContentFilesSearchRetrieveAggregationsEnum]; - + Key: "key", + CourseNumber: "course_number", + Platform: "platform", + OfferedBy: "offered_by", + FileExtension: "file_extension", + ContentFeatureType: "content_feature_type", + RunReadableId: "run_readable_id", + ResourceReadableId: "resource_readable_id", + RunTitle: "run_title", + EdxModuleId: "edx_module_id", + ContentType: "content_type", + Description: "description", + Title: "title", + Url: "url", + FileType: "file_type", + Summary: "summary", + Flashcards: "flashcards", + Checksum: "checksum", +} as const +export type VectorContentFilesSearchRetrieveAggregationsEnum = + (typeof VectorContentFilesSearchRetrieveAggregationsEnum)[keyof typeof VectorContentFilesSearchRetrieveAggregationsEnum] /** * VectorLearningResourcesSearchApi - axios parameter creator * @export */ -export const VectorLearningResourcesSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (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 => { - const localVarPath = `/api/v0/vector_learning_resources_search/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (hybrid_search !== undefined) { - localVarQueryParameter['hybrid_search'] = hybrid_search; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (readable_id !== undefined) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (score_cutoff !== undefined) { - localVarQueryParameter['score_cutoff'] = score_cutoff; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (title__isnull !== undefined) { - localVarQueryParameter['title__isnull'] = title__isnull; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - if (url__isnull !== undefined) { - localVarQueryParameter['url__isnull'] = url__isnull; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const VectorLearningResourcesSearchApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * 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: async ( + 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 => { + const localVarPath = `/api/v0/vector_learning_resources_search/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (hybrid_search !== undefined) { + localVarQueryParameter["hybrid_search"] = hybrid_search + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (published !== undefined) { + localVarQueryParameter["published"] = published + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (readable_id !== undefined) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (score_cutoff !== undefined) { + localVarQueryParameter["score_cutoff"] = score_cutoff + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (title__isnull !== undefined) { + localVarQueryParameter["title__isnull"] = title__isnull + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + if (url__isnull !== undefined) { + localVarQueryParameter["url__isnull"] = url__isnull + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} /** * VectorLearningResourcesSearchApi - functional programming interface * @export */ -export const VectorLearningResourcesSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VectorLearningResourcesSearchApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async 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> { - const localVarAxiosArgs = await localVarAxiosParamCreator.vectorLearningResourcesSearchRetrieve(aggregations, certification, certification_type, course_feature, delivery, department, free, hybrid_search, level, limit, ocw_topic, offered_by, offset, platform, professional, published, q, readable_id, resource_type, resource_type_group, score_cutoff, sortby, title__isnull, topic, url__isnull, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VectorLearningResourcesSearchApi.vectorLearningResourcesSearchRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const VectorLearningResourcesSearchApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + VectorLearningResourcesSearchApiAxiosParamCreator(configuration) + return { + /** + * 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} + */ + async 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 + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.vectorLearningResourcesSearchRetrieve( + aggregations, + certification, + certification_type, + course_feature, + delivery, + department, + free, + hybrid_search, + level, + limit, + ocw_topic, + offered_by, + offset, + platform, + professional, + published, + q, + readable_id, + resource_type, + resource_type_group, + score_cutoff, + sortby, + title__isnull, + topic, + url__isnull, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "VectorLearningResourcesSearchApi.vectorLearningResourcesSearchRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** * VectorLearningResourcesSearchApi - factory interface * @export */ -export const VectorLearningResourcesSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VectorLearningResourcesSearchApiFp(configuration) - return { - /** - * 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 { - return localVarFp.vectorLearningResourcesSearchRetrieve(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.hybrid_search, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.published, requestParameters.q, requestParameters.readable_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.score_cutoff, requestParameters.sortby, requestParameters.title__isnull, requestParameters.topic, requestParameters.url__isnull, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const VectorLearningResourcesSearchApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = VectorLearningResourcesSearchApiFp(configuration) + return { + /** + * 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 { + return localVarFp + .vectorLearningResourcesSearchRetrieve( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.hybrid_search, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.published, + requestParameters.q, + requestParameters.readable_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.score_cutoff, + requestParameters.sortby, + requestParameters.title__isnull, + requestParameters.topic, + requestParameters.url__isnull, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} /** * Request parameters for vectorLearningResourcesSearchRetrieve operation in VectorLearningResourcesSearchApi. @@ -9565,180 +11013,180 @@ export const VectorLearningResourcesSearchApiFactory = function (configuration?: * @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 + /** + * 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 } /** @@ -9748,338 +11196,455 @@ export interface VectorLearningResourcesSearchApiVectorLearningResourcesSearchRe * @extends {BaseAPI} */ export 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 - */ - public vectorLearningResourcesSearchRetrieve(requestParameters: VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig) { - return VectorLearningResourcesSearchApiFp(this.configuration).vectorLearningResourcesSearchRetrieve(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.hybrid_search, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.published, requestParameters.q, requestParameters.readable_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.score_cutoff, requestParameters.sortby, requestParameters.title__isnull, requestParameters.topic, requestParameters.url__isnull, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Vector Search for learning resources + * @summary Vector Search + * @param {VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VectorLearningResourcesSearchApi + */ + public vectorLearningResourcesSearchRetrieve( + requestParameters: VectorLearningResourcesSearchApiVectorLearningResourcesSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return VectorLearningResourcesSearchApiFp(this.configuration) + .vectorLearningResourcesSearchRetrieve( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.hybrid_search, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.published, + requestParameters.q, + requestParameters.readable_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.score_cutoff, + requestParameters.sortby, + requestParameters.title__isnull, + requestParameters.topic, + requestParameters.url__isnull, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const VectorLearningResourcesSearchRetrieveAggregationsEnum = { - ReadableId: 'readable_id', - ResourceType: 'resource_type', - Certification: 'certification', - CertificationType: 'certification_type', - Professional: 'professional', - Free: 'free', - CourseFeature: 'course_feature', - Topic: 'topic', - OcwTopic: 'ocw_topic', - Level: 'level', - Department: 'department', - Platform: 'platform', - OfferedBy: 'offered_by', - Delivery: 'delivery', - Title: 'title', - Url: 'url', - ResourceTypeGroup: 'resource_type_group', - ResourceCategory: 'resource_category', - Published: 'published', - NextStartDate: 'next_start_date', - Views: 'views', - CreatedOn: 'created_on' -} as const; -export type VectorLearningResourcesSearchRetrieveAggregationsEnum = typeof VectorLearningResourcesSearchRetrieveAggregationsEnum[keyof typeof VectorLearningResourcesSearchRetrieveAggregationsEnum]; + ReadableId: "readable_id", + ResourceType: "resource_type", + Certification: "certification", + CertificationType: "certification_type", + Professional: "professional", + Free: "free", + CourseFeature: "course_feature", + Topic: "topic", + OcwTopic: "ocw_topic", + Level: "level", + Department: "department", + Platform: "platform", + OfferedBy: "offered_by", + Delivery: "delivery", + Title: "title", + Url: "url", + ResourceTypeGroup: "resource_type_group", + ResourceCategory: "resource_category", + Published: "published", + NextStartDate: "next_start_date", + Views: "views", + CreatedOn: "created_on", +} as const +export type VectorLearningResourcesSearchRetrieveAggregationsEnum = + (typeof VectorLearningResourcesSearchRetrieveAggregationsEnum)[keyof typeof VectorLearningResourcesSearchRetrieveAggregationsEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type VectorLearningResourcesSearchRetrieveCertificationTypeEnum = typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum[keyof typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum]; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type VectorLearningResourcesSearchRetrieveCertificationTypeEnum = + (typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum)[keyof typeof VectorLearningResourcesSearchRetrieveCertificationTypeEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type VectorLearningResourcesSearchRetrieveDeliveryEnum = typeof VectorLearningResourcesSearchRetrieveDeliveryEnum[keyof typeof VectorLearningResourcesSearchRetrieveDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type VectorLearningResourcesSearchRetrieveDeliveryEnum = + (typeof VectorLearningResourcesSearchRetrieveDeliveryEnum)[keyof typeof VectorLearningResourcesSearchRetrieveDeliveryEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type VectorLearningResourcesSearchRetrieveDepartmentEnum = typeof VectorLearningResourcesSearchRetrieveDepartmentEnum[keyof typeof VectorLearningResourcesSearchRetrieveDepartmentEnum]; + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type VectorLearningResourcesSearchRetrieveDepartmentEnum = + (typeof VectorLearningResourcesSearchRetrieveDepartmentEnum)[keyof typeof VectorLearningResourcesSearchRetrieveDepartmentEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type VectorLearningResourcesSearchRetrieveLevelEnum = typeof VectorLearningResourcesSearchRetrieveLevelEnum[keyof typeof VectorLearningResourcesSearchRetrieveLevelEnum]; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type VectorLearningResourcesSearchRetrieveLevelEnum = + (typeof VectorLearningResourcesSearchRetrieveLevelEnum)[keyof typeof VectorLearningResourcesSearchRetrieveLevelEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type VectorLearningResourcesSearchRetrieveOfferedByEnum = typeof VectorLearningResourcesSearchRetrieveOfferedByEnum[keyof typeof VectorLearningResourcesSearchRetrieveOfferedByEnum]; + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type VectorLearningResourcesSearchRetrieveOfferedByEnum = + (typeof VectorLearningResourcesSearchRetrieveOfferedByEnum)[keyof typeof VectorLearningResourcesSearchRetrieveOfferedByEnum] /** * @export */ export const VectorLearningResourcesSearchRetrievePlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type VectorLearningResourcesSearchRetrievePlatformEnum = typeof VectorLearningResourcesSearchRetrievePlatformEnum[keyof typeof VectorLearningResourcesSearchRetrievePlatformEnum]; + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type VectorLearningResourcesSearchRetrievePlatformEnum = + (typeof VectorLearningResourcesSearchRetrievePlatformEnum)[keyof typeof VectorLearningResourcesSearchRetrievePlatformEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type VectorLearningResourcesSearchRetrieveResourceTypeEnum = typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum]; + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type VectorLearningResourcesSearchRetrieveResourceTypeEnum = + (typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum)[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum = typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum]; + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum = + (typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum)[keyof typeof VectorLearningResourcesSearchRetrieveResourceTypeGroupEnum] /** * @export */ export const VectorLearningResourcesSearchRetrieveSortbyEnum = { - NextStartDate: 'next_start_date', - Views: 'views', - CreatedOn: 'created_on', - NextStartDate2: '-next_start_date', - Views2: '-views', - CreatedOn2: '-created_on' -} as const; -export type VectorLearningResourcesSearchRetrieveSortbyEnum = typeof VectorLearningResourcesSearchRetrieveSortbyEnum[keyof typeof VectorLearningResourcesSearchRetrieveSortbyEnum]; - + NextStartDate: "next_start_date", + Views: "views", + CreatedOn: "created_on", + NextStartDate2: "-next_start_date", + Views2: "-views", + CreatedOn2: "-created_on", +} as const +export type VectorLearningResourcesSearchRetrieveSortbyEnum = + (typeof VectorLearningResourcesSearchRetrieveSortbyEnum)[keyof typeof VectorLearningResourcesSearchRetrieveSortbyEnum] /** * WebsitesApi - axios parameter creator * @export */ -export const WebsitesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * View for user websites - * @param {UserWebsiteRequest} UserWebsiteRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websitesCreate: async (UserWebsiteRequest: UserWebsiteRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'UserWebsiteRequest' is not null or undefined - assertParamExists('websitesCreate', 'UserWebsiteRequest', UserWebsiteRequest) - const localVarPath = `/api/v0/websites/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(UserWebsiteRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for user websites - * @param {number} id A unique integer value identifying this user website. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websitesDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('websitesDestroy', 'id', id) - const localVarPath = `/api/v0/websites/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const WebsitesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * View for user websites + * @param {UserWebsiteRequest} UserWebsiteRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + websitesCreate: async ( + UserWebsiteRequest: UserWebsiteRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'UserWebsiteRequest' is not null or undefined + assertParamExists( + "websitesCreate", + "UserWebsiteRequest", + UserWebsiteRequest, + ) + const localVarPath = `/api/v0/websites/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + UserWebsiteRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * View for user websites + * @param {number} id A unique integer value identifying this user website. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + websitesDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("websitesDestroy", "id", id) + const localVarPath = `/api/v0/websites/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} /** * WebsitesApi - functional programming interface * @export */ -export const WebsitesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WebsitesApiAxiosParamCreator(configuration) - return { - /** - * View for user websites - * @param {UserWebsiteRequest} UserWebsiteRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websitesCreate(UserWebsiteRequest: UserWebsiteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websitesCreate(UserWebsiteRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsitesApi.websitesCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for user websites - * @param {number} id A unique integer value identifying this user website. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websitesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websitesDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsitesApi.websitesDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const WebsitesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = WebsitesApiAxiosParamCreator(configuration) + return { + /** + * View for user websites + * @param {UserWebsiteRequest} UserWebsiteRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async websitesCreate( + UserWebsiteRequest: UserWebsiteRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.websitesCreate( + UserWebsiteRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsitesApi.websitesCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * View for user websites + * @param {number} id A unique integer value identifying this user website. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async websitesDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.websitesDestroy( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsitesApi.websitesDestroy"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** * WebsitesApi - factory interface * @export */ -export const WebsitesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WebsitesApiFp(configuration) - return { - /** - * View for user websites - * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websitesCreate(requestParameters: WebsitesApiWebsitesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websitesCreate(requestParameters.UserWebsiteRequest, options).then((request) => request(axios, basePath)); - }, - /** - * View for user websites - * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websitesDestroy(requestParameters: WebsitesApiWebsitesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websitesDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const WebsitesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = WebsitesApiFp(configuration) + return { + /** + * View for user websites + * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + websitesCreate( + requestParameters: WebsitesApiWebsitesCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websitesCreate(requestParameters.UserWebsiteRequest, options) + .then((request) => request(axios, basePath)) + }, + /** + * View for user websites + * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + websitesDestroy( + requestParameters: WebsitesApiWebsitesDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websitesDestroy(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } +} /** * Request parameters for websitesCreate operation in WebsitesApi. @@ -10087,12 +11652,12 @@ export const WebsitesApiFactory = function (configuration?: Configuration, baseP * @interface WebsitesApiWebsitesCreateRequest */ export interface WebsitesApiWebsitesCreateRequest { - /** - * - * @type {UserWebsiteRequest} - * @memberof WebsitesApiWebsitesCreate - */ - readonly UserWebsiteRequest: UserWebsiteRequest + /** + * + * @type {UserWebsiteRequest} + * @memberof WebsitesApiWebsitesCreate + */ + readonly UserWebsiteRequest: UserWebsiteRequest } /** @@ -10101,12 +11666,12 @@ export interface WebsitesApiWebsitesCreateRequest { * @interface WebsitesApiWebsitesDestroyRequest */ export interface WebsitesApiWebsitesDestroyRequest { - /** - * A unique integer value identifying this user website. - * @type {number} - * @memberof WebsitesApiWebsitesDestroy - */ - readonly id: number + /** + * A unique integer value identifying this user website. + * @type {number} + * @memberof WebsitesApiWebsitesDestroy + */ + readonly id: number } /** @@ -10116,231 +11681,365 @@ export interface WebsitesApiWebsitesDestroyRequest { * @extends {BaseAPI} */ export class WebsitesApi extends BaseAPI { + /** + * View for user websites + * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsitesApi + */ + public websitesCreate( + requestParameters: WebsitesApiWebsitesCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsitesApiFp(this.configuration) + .websitesCreate(requestParameters.UserWebsiteRequest, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for user websites + * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsitesApi + */ + public websitesDestroy( + requestParameters: WebsitesApiWebsitesDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsitesApiFp(this.configuration) + .websitesDestroy(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} + +/** + * WidgetListsApi - axios parameter creator + * @export + */ +export const WidgetListsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * View for user websites - * @param {WebsitesApiWebsitesCreateRequest} requestParameters Request parameters. + * 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} - * @memberof WebsitesApi */ - public websitesCreate(requestParameters: WebsitesApiWebsitesCreateRequest, options?: RawAxiosRequestConfig) { - return WebsitesApiFp(this.configuration).websitesCreate(requestParameters.UserWebsiteRequest, options).then((request) => request(this.axios, this.basePath)); - } - + widgetListsPartialUpdate: async ( + id: number, + PatchedWidgetListRequest?: PatchedWidgetListRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("widgetListsPartialUpdate", "id", id) + const localVarPath = `/api/v0/widget_lists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedWidgetListRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * View for user websites - * @param {WebsitesApiWebsitesDestroyRequest} requestParameters Request parameters. + * 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: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("widgetListsRetrieve", "id", id) + const localVarPath = `/api/v0/widget_lists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * 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} - * @memberof WebsitesApi */ - public websitesDestroy(requestParameters: WebsitesApiWebsitesDestroyRequest, options?: RawAxiosRequestConfig) { - return WebsitesApiFp(this.configuration).websitesDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + widgetListsUpdate: async ( + id: number, + WidgetListRequest?: WidgetListRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("widgetListsUpdate", "id", id) + const localVarPath = `/api/v0/widget_lists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PUT", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + WidgetListRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } - - -/** - * WidgetListsApi - axios parameter creator - * @export - */ -export const WidgetListsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * 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: async (id: number, PatchedWidgetListRequest?: PatchedWidgetListRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('widgetListsPartialUpdate', 'id', id) - const localVarPath = `/api/v0/widget_lists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedWidgetListRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('widgetListsRetrieve', 'id', id) - const localVarPath = `/api/v0/widget_lists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * 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: async (id: number, WidgetListRequest?: WidgetListRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('widgetListsUpdate', 'id', id) - const localVarPath = `/api/v0/widget_lists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(WidgetListRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - /** * WidgetListsApi - functional programming interface * @export */ -export const WidgetListsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WidgetListsApiAxiosParamCreator(configuration) - return { - /** - * 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} - */ - async widgetListsPartialUpdate(id: number, PatchedWidgetListRequest?: PatchedWidgetListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.widgetListsPartialUpdate(id, PatchedWidgetListRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WidgetListsApi.widgetListsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * API for managing widget lists - * @param {number} id A unique integer value identifying this widget list. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async widgetListsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.widgetListsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WidgetListsApi.widgetListsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * 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} - */ - async widgetListsUpdate(id: number, WidgetListRequest?: WidgetListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.widgetListsUpdate(id, WidgetListRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WidgetListsApi.widgetListsUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const WidgetListsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + WidgetListsApiAxiosParamCreator(configuration) + return { + /** + * 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} + */ + async widgetListsPartialUpdate( + id: number, + PatchedWidgetListRequest?: PatchedWidgetListRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.widgetListsPartialUpdate( + id, + PatchedWidgetListRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WidgetListsApi.widgetListsPartialUpdate"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * API for managing widget lists + * @param {number} id A unique integer value identifying this widget list. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async widgetListsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.widgetListsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WidgetListsApi.widgetListsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * 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} + */ + async widgetListsUpdate( + id: number, + WidgetListRequest?: WidgetListRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.widgetListsUpdate( + id, + WidgetListRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WidgetListsApi.widgetListsUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** * WidgetListsApi - factory interface * @export */ -export const WidgetListsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WidgetListsApiFp(configuration) - return { - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - widgetListsPartialUpdate(requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.widgetListsPartialUpdate(requestParameters.id, requestParameters.PatchedWidgetListRequest, options).then((request) => request(axios, basePath)); - }, - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - widgetListsRetrieve(requestParameters: WidgetListsApiWidgetListsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.widgetListsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - widgetListsUpdate(requestParameters: WidgetListsApiWidgetListsUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.widgetListsUpdate(requestParameters.id, requestParameters.WidgetListRequest, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const WidgetListsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = WidgetListsApiFp(configuration) + return { + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + widgetListsPartialUpdate( + requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .widgetListsPartialUpdate( + requestParameters.id, + requestParameters.PatchedWidgetListRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + widgetListsRetrieve( + requestParameters: WidgetListsApiWidgetListsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .widgetListsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + widgetListsUpdate( + requestParameters: WidgetListsApiWidgetListsUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .widgetListsUpdate( + requestParameters.id, + requestParameters.WidgetListRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} /** * Request parameters for widgetListsPartialUpdate operation in WidgetListsApi. @@ -10348,19 +12047,19 @@ export const WidgetListsApiFactory = function (configuration?: Configuration, ba * @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 + /** + * A unique integer value identifying this widget list. + * @type {number} + * @memberof WidgetListsApiWidgetListsPartialUpdate + */ + readonly id: number + + /** + * + * @type {PatchedWidgetListRequest} + * @memberof WidgetListsApiWidgetListsPartialUpdate + */ + readonly PatchedWidgetListRequest?: PatchedWidgetListRequest } /** @@ -10369,12 +12068,12 @@ export interface WidgetListsApiWidgetListsPartialUpdateRequest { * @interface WidgetListsApiWidgetListsRetrieveRequest */ export interface WidgetListsApiWidgetListsRetrieveRequest { - /** - * A unique integer value identifying this widget list. - * @type {number} - * @memberof WidgetListsApiWidgetListsRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this widget list. + * @type {number} + * @memberof WidgetListsApiWidgetListsRetrieve + */ + readonly id: number } /** @@ -10383,19 +12082,19 @@ export interface WidgetListsApiWidgetListsRetrieveRequest { * @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 + /** + * A unique integer value identifying this widget list. + * @type {number} + * @memberof WidgetListsApiWidgetListsUpdate + */ + readonly id: number + + /** + * + * @type {WidgetListRequest} + * @memberof WidgetListsApiWidgetListsUpdate + */ + readonly WidgetListRequest?: WidgetListRequest } /** @@ -10405,39 +12104,59 @@ export interface WidgetListsApiWidgetListsUpdateRequest { * @extends {BaseAPI} */ export class WidgetListsApi extends BaseAPI { - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WidgetListsApi - */ - public widgetListsPartialUpdate(requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return WidgetListsApiFp(this.configuration).widgetListsPartialUpdate(requestParameters.id, requestParameters.PatchedWidgetListRequest, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WidgetListsApi - */ - public widgetListsRetrieve(requestParameters: WidgetListsApiWidgetListsRetrieveRequest, options?: RawAxiosRequestConfig) { - return WidgetListsApiFp(this.configuration).widgetListsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * API for managing widget lists - * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WidgetListsApi - */ - public widgetListsUpdate(requestParameters: WidgetListsApiWidgetListsUpdateRequest, options?: RawAxiosRequestConfig) { - return WidgetListsApiFp(this.configuration).widgetListsUpdate(requestParameters.id, requestParameters.WidgetListRequest, options).then((request) => request(this.axios, this.basePath)); - } + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WidgetListsApi + */ + public widgetListsPartialUpdate( + requestParameters: WidgetListsApiWidgetListsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return WidgetListsApiFp(this.configuration) + .widgetListsPartialUpdate( + requestParameters.id, + requestParameters.PatchedWidgetListRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WidgetListsApi + */ + public widgetListsRetrieve( + requestParameters: WidgetListsApiWidgetListsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return WidgetListsApiFp(this.configuration) + .widgetListsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * API for managing widget lists + * @param {WidgetListsApiWidgetListsUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WidgetListsApi + */ + public widgetListsUpdate( + requestParameters: WidgetListsApiWidgetListsUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return WidgetListsApiFp(this.configuration) + .widgetListsUpdate( + requestParameters.id, + requestParameters.WidgetListRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } - - - diff --git a/src/typescript/mit-learn-api-axios/src/v0/base.ts b/src/typescript/mit-learn-api-axios/src/v0/base.ts index c96f3b5..c8312e8 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/base.ts +++ b/src/typescript/mit-learn-api-axios/src/v0/base.ts @@ -5,32 +5,31 @@ * 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 { Configuration } from "./configuration" // Some imports not used depending on template conditions // @ts-ignore -import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; -import globalAxios from 'axios'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios" +import globalAxios from "axios" -export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); +export const BASE_PATH = "http://localhost".replace(/\/+$/, "") /** * * @export */ export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +} /** * @@ -38,8 +37,8 @@ export const COLLECTION_FORMATS = { * @interface RequestArgs */ export interface RequestArgs { - url: string; - options: RawAxiosRequestConfig; + url: string + options: RawAxiosRequestConfig } /** @@ -48,15 +47,19 @@ export interface RequestArgs { * @class BaseAPI */ export class BaseAPI { - protected configuration: Configuration | undefined; + protected configuration: Configuration | undefined - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath ?? basePath; - } + constructor( + configuration?: Configuration, + protected basePath: string = BASE_PATH, + protected axios: AxiosInstance = globalAxios, + ) { + if (configuration) { + this.configuration = configuration + this.basePath = configuration.basePath ?? basePath } -}; + } +} /** * @@ -65,22 +68,24 @@ export class BaseAPI { * @extends {Error} */ export class RequiredError extends Error { - constructor(public field: string, msg?: string) { - super(msg); - this.name = "RequiredError" - } + constructor( + public field: string, + msg?: string, + ) { + super(msg) + this.name = "RequiredError" + } } interface ServerMap { - [key: string]: { - url: string, - description: string, - }[]; + [key: string]: { + url: string + description: string + }[] } /** * * @export */ -export const operationServerMap: ServerMap = { -} +export const operationServerMap: ServerMap = {} diff --git a/src/typescript/mit-learn-api-axios/src/v0/common.ts b/src/typescript/mit-learn-api-axios/src/v0/common.ts index 886678a..6297706 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/common.ts +++ b/src/typescript/mit-learn-api-axios/src/v0/common.ts @@ -5,105 +5,139 @@ * 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 { RequestArgs } from "./base"; -import type { AxiosInstance, AxiosResponse } from 'axios'; -import { RequiredError } from "./base"; +import type { Configuration } from "./configuration" +import type { RequestArgs } from "./base" +import type { AxiosInstance, AxiosResponse } from "axios" +import { RequiredError } from "./base" /** * * @export */ -export const DUMMY_BASE_URL = 'https://example.com' +export const DUMMY_BASE_URL = "https://example.com" /** * * @throws {RequiredError} * @export */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } +export const assertParamExists = function ( + functionName: string, + paramName: string, + paramValue: unknown, +) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError( + paramName, + `Required parameter ${paramName} was null or undefined when calling ${functionName}.`, + ) + } } /** * * @export */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } +export const setApiKeyToObject = async function ( + object: any, + keyParamName: string, + configuration?: Configuration, +) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = + typeof configuration.apiKey === "function" + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey + object[keyParamName] = localVarApiKeyValue + } } /** * * @export */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; +export const setBasicAuthToObject = function ( + object: any, + configuration?: Configuration, +) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { + username: configuration.username, + password: configuration.password, } + } } /** * * @export */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } +export const setBearerAuthToObject = async function ( + object: any, + configuration?: Configuration, +) { + if (configuration && configuration.accessToken) { + const accessToken = + typeof configuration.accessToken === "function" + ? await configuration.accessToken() + : await configuration.accessToken + object["Authorization"] = "Bearer " + accessToken + } } /** * * @export */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } +export const setOAuthToObject = async function ( + object: any, + name: string, + scopes: string[], + configuration?: Configuration, +) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = + typeof configuration.accessToken === "function" + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken + object["Authorization"] = "Bearer " + localVarAccessTokenValue + } } -function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { - if (parameter == null) return; - if (typeof parameter === "object") { - if (Array.isArray(parameter)) { - (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } - else { - Object.keys(parameter).forEach(currentKey => - setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) - ); - } - } - else { - if (urlSearchParams.has(key)) { - urlSearchParams.append(key, parameter); - } - else { - urlSearchParams.set(key, parameter); - } +function setFlattenedQueryParams( + urlSearchParams: URLSearchParams, + parameter: any, + key: string = "", +): void { + if (parameter == null) return + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + ;(parameter as any[]).forEach((item) => + setFlattenedQueryParams(urlSearchParams, item, key), + ) + } else { + Object.keys(parameter).forEach((currentKey) => + setFlattenedQueryParams( + urlSearchParams, + parameter[currentKey], + `${key}${key !== "" ? "." : ""}${currentKey}`, + ), + ) } + } else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter) + } else { + urlSearchParams.set(key, parameter) + } + } } /** @@ -111,23 +145,28 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an * @export */ export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - setFlattenedQueryParams(searchParams, objects); - url.search = searchParams.toString(); + const searchParams = new URLSearchParams(url.search) + setFlattenedQueryParams(searchParams, objects) + url.search = searchParams.toString() } /** * * @export */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); +export const serializeDataIfNeeded = function ( + value: any, + requestOptions: any, + configuration?: Configuration, +) { + const nonString = typeof value !== "string" + const needsSerialization = + nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers["Content-Type"]) + : nonString + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : value || "" } /** @@ -135,16 +174,29 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, * @export */ export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash + return url.pathname + url.search + url.hash } /** * * @export */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; +export const createRequestFunction = function ( + axiosArgs: RequestArgs, + globalAxios: AxiosInstance, + BASE_PATH: string, + configuration?: Configuration, +) { + return >( + axios: AxiosInstance = globalAxios, + basePath: string = BASE_PATH, + ) => { + const axiosRequestArgs = { + ...axiosArgs.options, + url: + (axios.defaults.baseURL ? "" : configuration?.basePath ?? basePath) + + axiosArgs.url, + } + return axios.request(axiosRequestArgs) + } } diff --git a/src/typescript/mit-learn-api-axios/src/v0/configuration.ts b/src/typescript/mit-learn-api-axios/src/v0/configuration.ts index 2a4d963..e175572 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/configuration.ts +++ b/src/typescript/mit-learn-api-axios/src/v0/configuration.ts @@ -5,106 +5,128 @@ * 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. */ - export interface ConfigurationParameters { - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - username?: string; - password?: string; - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - basePath?: string; - serverIndex?: number; - baseOptions?: any; - formDataCtor?: new () => any; + apiKey?: + | string + | Promise + | ((name: string) => string) + | ((name: string) => Promise) + username?: string + password?: string + accessToken?: + | string + | Promise + | ((name?: string, scopes?: string[]) => string) + | ((name?: string, scopes?: string[]) => Promise) + basePath?: string + serverIndex?: number + baseOptions?: any + formDataCtor?: new () => any } export class Configuration { - /** - * parameter for apiKey security - * @param name security name - * @memberof Configuration - */ - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - username?: string; - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - password?: string; - /** - * parameter for oauth2 security - * @param name security name - * @param scopes oauth2 scope - * @memberof Configuration - */ - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - /** - * override base path - * - * @type {string} - * @memberof Configuration - */ - basePath?: string; - /** - * override server index - * - * @type {number} - * @memberof Configuration - */ - serverIndex?: number; - /** - * base options for axios calls - * - * @type {any} - * @memberof Configuration - */ - baseOptions?: any; - /** - * The FormData constructor that will be used to create multipart form data - * requests. You can inject this here so that execution environments that - * do not support the FormData class can still run the generated client. - * - * @type {new () => FormData} - */ - formDataCtor?: new () => any; + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: + | string + | Promise + | ((name: string) => string) + | ((name: string) => Promise) + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: + | string + | Promise + | ((name?: string, scopes?: string[]) => string) + | ((name?: string, scopes?: string[]) => Promise) + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.serverIndex = param.serverIndex; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey + this.username = param.username + this.password = param.password + this.accessToken = param.accessToken + this.basePath = param.basePath + this.serverIndex = param.serverIndex + this.baseOptions = param.baseOptions + this.formDataCtor = param.formDataCtor + } - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - public isJsonMime(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp( + "^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$", + "i", + ) + return ( + mime !== null && + (jsonMime.test(mime) || + mime.toLowerCase() === "application/json-patch+json") + ) + } } diff --git a/src/typescript/mit-learn-api-axios/src/v0/index.ts b/src/typescript/mit-learn-api-axios/src/v0/index.ts index a2ad950..80a30a8 100644 --- a/src/typescript/mit-learn-api-axios/src/v0/index.ts +++ b/src/typescript/mit-learn-api-axios/src/v0/index.ts @@ -5,14 +5,12 @@ * 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. */ - -export * from "./api"; -export * from "./configuration"; - +export * from "./api" +export * from "./configuration" diff --git a/src/typescript/mit-learn-api-axios/src/v1/.openapi-generator/VERSION b/src/typescript/mit-learn-api-axios/src/v1/.openapi-generator/VERSION index 4b49d9b..0ee843c 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/.openapi-generator/VERSION +++ b/src/typescript/mit-learn-api-axios/src/v1/.openapi-generator/VERSION @@ -1 +1 @@ -7.2.0 \ No newline at end of file +7.2.0 diff --git a/src/typescript/mit-learn-api-axios/src/v1/api.ts b/src/typescript/mit-learn-api-axios/src/v1/api.ts index 9bd1995..1a82763 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/api.ts +++ b/src/typescript/mit-learn-api-axios/src/v1/api.ts @@ -5,23 +5,39 @@ * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - -import type { Configuration } from './configuration'; -import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; -import globalAxios from 'axios'; +import type { Configuration } from "./configuration" +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios" +import globalAxios from "axios" // Some imports not used depending on template conditions // @ts-ignore -import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; -import type { RequestArgs } from './base'; +import { + DUMMY_BASE_URL, + assertParamExists, + setApiKeyToObject, + setBasicAuthToObject, + setBearerAuthToObject, + setOAuthToObject, + setSearchParams, + serializeDataIfNeeded, + toPathString, + createRequestFunction, +} from "./common" +import type { RequestArgs } from "./base" // @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; +import { + BASE_PATH, + COLLECTION_FORMATS, + BaseAPI, + RequiredError, + operationServerMap, +} from "./base" /** * * `resource_type` - resource_type * `certification` - certification * `certification_type` - certification_type * `offered_by` - offered_by * `platform` - platform * `topic` - topic * `department` - department * `level` - level * `course_feature` - course_feature * `professional` - professional * `free` - free * `delivery` - delivery * `resource_type_group` - resource_type_group * `resource_category` - resource_category @@ -30,66 +46,66 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM */ export const AggregationsEnum = { - /** - * resource_type - */ - ResourceType: 'resource_type', - /** - * certification - */ - Certification: 'certification', - /** - * certification_type - */ - CertificationType: 'certification_type', - /** - * offered_by - */ - OfferedBy: 'offered_by', - /** - * platform - */ - Platform: 'platform', - /** - * topic - */ - Topic: 'topic', - /** - * department - */ - Department: 'department', - /** - * level - */ - Level: 'level', - /** - * course_feature - */ - CourseFeature: 'course_feature', - /** - * professional - */ - Professional: 'professional', - /** - * free - */ - Free: 'free', - /** - * delivery - */ - Delivery: 'delivery', - /** - * resource_type_group - */ - ResourceTypeGroup: 'resource_type_group', - /** - * resource_category - */ - ResourceCategory: 'resource_category' -} as const; - -export type AggregationsEnum = typeof AggregationsEnum[keyof typeof AggregationsEnum]; - + /** + * resource_type + */ + ResourceType: "resource_type", + /** + * certification + */ + Certification: "certification", + /** + * certification_type + */ + CertificationType: "certification_type", + /** + * offered_by + */ + OfferedBy: "offered_by", + /** + * platform + */ + Platform: "platform", + /** + * topic + */ + Topic: "topic", + /** + * department + */ + Department: "department", + /** + * level + */ + Level: "level", + /** + * course_feature + */ + CourseFeature: "course_feature", + /** + * professional + */ + Professional: "professional", + /** + * free + */ + Free: "free", + /** + * delivery + */ + Delivery: "delivery", + /** + * resource_type_group + */ + ResourceTypeGroup: "resource_type_group", + /** + * resource_category + */ + ResourceCategory: "resource_category", +} as const + +export type AggregationsEnum = + (typeof AggregationsEnum)[keyof typeof AggregationsEnum] /** * * `dated` - Dated * `anytime` - Anytime @@ -98,18 +114,18 @@ export type AggregationsEnum = typeof AggregationsEnum[keyof typeof Aggregations */ export const AvailabilityEnum = { - /** - * Dated - */ - Dated: 'dated', - /** - * Anytime - */ - Anytime: 'anytime' -} as const; - -export type AvailabilityEnum = typeof AvailabilityEnum[keyof typeof AvailabilityEnum]; + /** + * Dated + */ + Dated: "dated", + /** + * Anytime + */ + Anytime: "anytime", +} as const +export type AvailabilityEnum = + (typeof AvailabilityEnum)[keyof typeof AvailabilityEnum] /** * Serializer for caption URL entries @@ -117,24 +133,24 @@ export type AvailabilityEnum = typeof AvailabilityEnum[keyof typeof Availability * @interface CaptionUrl */ export interface CaptionUrl { - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'language': string; - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'language_name': string; - /** - * - * @type {string} - * @memberof CaptionUrl - */ - 'url': string; + /** + * + * @type {string} + * @memberof CaptionUrl + */ + language: string + /** + * + * @type {string} + * @memberof CaptionUrl + */ + language_name: string + /** + * + * @type {string} + * @memberof CaptionUrl + */ + url: string } /** * Serializer for caption URL entries @@ -142,24 +158,24 @@ export interface CaptionUrl { * @interface CaptionUrlRequest */ export interface CaptionUrlRequest { - /** - * - * @type {string} - * @memberof CaptionUrlRequest - */ - 'language': string; - /** - * - * @type {string} - * @memberof CaptionUrlRequest - */ - 'language_name': string; - /** - * - * @type {string} - * @memberof CaptionUrlRequest - */ - 'url': string; + /** + * + * @type {string} + * @memberof CaptionUrlRequest + */ + language: string + /** + * + * @type {string} + * @memberof CaptionUrlRequest + */ + language_name: string + /** + * + * @type {string} + * @memberof CaptionUrlRequest + */ + url: string } /** * * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate @@ -168,26 +184,26 @@ export interface CaptionUrlRequest { */ export const CertificationTypeEnum = { - /** - * MicroMasters Credential - */ - Micromasters: 'micromasters', - /** - * Professional Certificate - */ - Professional: 'professional', - /** - * Certificate of Completion - */ - Completion: 'completion', - /** - * No Certificate - */ - None: 'none' -} as const; - -export type CertificationTypeEnum = typeof CertificationTypeEnum[keyof typeof CertificationTypeEnum]; - + /** + * MicroMasters Credential + */ + Micromasters: "micromasters", + /** + * Professional Certificate + */ + Professional: "professional", + /** + * Certificate of Completion + */ + Completion: "completion", + /** + * No Certificate + */ + None: "none", +} as const + +export type CertificationTypeEnum = + (typeof CertificationTypeEnum)[keyof typeof CertificationTypeEnum] /** * Serializer class for course run ContentFiles @@ -195,225 +211,224 @@ export type CertificationTypeEnum = typeof CertificationTypeEnum[keyof typeof Ce * @interface ContentFile */ export interface ContentFile { - /** - * - * @type {number} - * @memberof ContentFile - */ - 'id': number; - /** - * - * @type {number} - * @memberof ContentFile - */ - 'run_id'?: number; - /** - * - * @type {number} - * @memberof ContentFile - */ - 'direct_learning_resource_id'?: number | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'run_title'?: string; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'run_slug'?: string; - /** - * - * @type {Array} - * @memberof ContentFile - */ - 'departments': Array; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'semester'?: string; - /** - * - * @type {number} - * @memberof ContentFile - */ - 'year'?: number; - /** - * - * @type {Array} - * @memberof ContentFile - */ - 'topics': Array; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'key'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'uid'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'title'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'description'?: string | null; - /** - * - * @type {boolean} - * @memberof ContentFile - */ - 'require_summaries': boolean; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof ContentFile - */ - 'content_feature_type': Array; - /** - * - * @type {ContentFileContentTypeEnum} - * @memberof ContentFile - */ - 'content_type'?: ContentFileContentTypeEnum; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'content'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'content_title'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'content_author'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'content_language'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'checksum'?: string; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'image_src'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'resource_id': string; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'resource_readable_id': string; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'source_path'?: string; - /** - * Extract the course number(s) from the associated course - * @type {Array} - * @memberof ContentFile - */ - 'course_number': Array; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'file_type'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'file_extension'?: string | null; - /** - * - * @type {LearningResourceOfferor} - * @memberof ContentFile - */ - 'offered_by': LearningResourceOfferor; - /** - * - * @type {LearningResourcePlatform} - * @memberof ContentFile - */ - 'platform': LearningResourcePlatform; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'run_readable_id'?: string; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'edx_module_id'?: string | null; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'summary'?: string; - /** - * - * @type {any} - * @memberof ContentFile - */ - 'flashcards'?: any; - /** - * - * @type {string} - * @memberof ContentFile - */ - 'youtube_id'?: string | null; + /** + * + * @type {number} + * @memberof ContentFile + */ + id: number + /** + * + * @type {number} + * @memberof ContentFile + */ + run_id?: number + /** + * + * @type {number} + * @memberof ContentFile + */ + direct_learning_resource_id?: number | null + /** + * + * @type {string} + * @memberof ContentFile + */ + run_title?: string + /** + * + * @type {string} + * @memberof ContentFile + */ + run_slug?: string + /** + * + * @type {Array} + * @memberof ContentFile + */ + departments: Array + /** + * + * @type {string} + * @memberof ContentFile + */ + semester?: string + /** + * + * @type {number} + * @memberof ContentFile + */ + year?: number + /** + * + * @type {Array} + * @memberof ContentFile + */ + topics: Array + /** + * + * @type {string} + * @memberof ContentFile + */ + key?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + uid?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + title?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + description?: string | null + /** + * + * @type {boolean} + * @memberof ContentFile + */ + require_summaries: boolean + /** + * + * @type {string} + * @memberof ContentFile + */ + url?: string | null + /** + * + * @type {Array} + * @memberof ContentFile + */ + content_feature_type: Array + /** + * + * @type {ContentFileContentTypeEnum} + * @memberof ContentFile + */ + content_type?: ContentFileContentTypeEnum + /** + * + * @type {string} + * @memberof ContentFile + */ + content?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + content_title?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + content_author?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + content_language?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + checksum?: string + /** + * + * @type {string} + * @memberof ContentFile + */ + image_src?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + resource_id: string + /** + * + * @type {string} + * @memberof ContentFile + */ + resource_readable_id: string + /** + * + * @type {string} + * @memberof ContentFile + */ + source_path?: string + /** + * Extract the course number(s) from the associated course + * @type {Array} + * @memberof ContentFile + */ + course_number: Array + /** + * + * @type {string} + * @memberof ContentFile + */ + file_type?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + file_extension?: string | null + /** + * + * @type {LearningResourceOfferor} + * @memberof ContentFile + */ + offered_by: LearningResourceOfferor + /** + * + * @type {LearningResourcePlatform} + * @memberof ContentFile + */ + platform: LearningResourcePlatform + /** + * + * @type {string} + * @memberof ContentFile + */ + run_readable_id?: string + /** + * + * @type {string} + * @memberof ContentFile + */ + edx_module_id?: string | null + /** + * + * @type {string} + * @memberof ContentFile + */ + summary?: string + /** + * + * @type {any} + * @memberof ContentFile + */ + flashcards?: any + /** + * + * @type {string} + * @memberof ContentFile + */ + youtube_id?: string | null } - /** * * `page` - page * `file` - file * `video` - video * `pdf` - pdf * @export @@ -421,26 +436,26 @@ export interface ContentFile { */ export const ContentFileContentTypeEnum = { - /** - * page - */ - Page: 'page', - /** - * file - */ - File: 'file', - /** - * video - */ - Video: 'video', - /** - * pdf - */ - Pdf: 'pdf' -} as const; - -export type ContentFileContentTypeEnum = typeof ContentFileContentTypeEnum[keyof typeof ContentFileContentTypeEnum]; - + /** + * page + */ + Page: "page", + /** + * file + */ + File: "file", + /** + * video + */ + Video: "video", + /** + * pdf + */ + Pdf: "pdf", +} as const + +export type ContentFileContentTypeEnum = + (typeof ContentFileContentTypeEnum)[keyof typeof ContentFileContentTypeEnum] /** * SearchResponseSerializer with OpenAPI annotations for Content Files search @@ -448,74 +463,78 @@ export type ContentFileContentTypeEnum = typeof ContentFileContentTypeEnum[keyof * @interface ContentFileSearchResponse */ export interface ContentFileSearchResponse { - /** - * - * @type {number} - * @memberof ContentFileSearchResponse - */ - 'count': number; - /** - * - * @type {string} - * @memberof ContentFileSearchResponse - */ - 'next': string | null; - /** - * - * @type {string} - * @memberof ContentFileSearchResponse - */ - 'previous': string | null; - /** - * - * @type {Array} - * @memberof ContentFileSearchResponse - */ - 'results': Array; - /** - * - * @type {ContentFileSearchResponseMetadata} - * @memberof ContentFileSearchResponse - */ - 'metadata': ContentFileSearchResponseMetadata; + /** + * + * @type {number} + * @memberof ContentFileSearchResponse + */ + count: number + /** + * + * @type {string} + * @memberof ContentFileSearchResponse + */ + next: string | null + /** + * + * @type {string} + * @memberof ContentFileSearchResponse + */ + previous: string | null + /** + * + * @type {Array} + * @memberof ContentFileSearchResponse + */ + results: Array + /** + * + * @type {ContentFileSearchResponseMetadata} + * @memberof ContentFileSearchResponse + */ + metadata: ContentFileSearchResponseMetadata } /** - * + * * @export * @interface ContentFileSearchResponseMetadata */ export interface ContentFileSearchResponseMetadata { - /** - * - * @type {{ [key: string]: Array; }} - * @memberof ContentFileSearchResponseMetadata - */ - 'aggregations': { [key: string]: Array; }; - /** - * - * @type {Array} - * @memberof ContentFileSearchResponseMetadata - */ - 'suggestions': Array; + /** + * + * @type {{ [key: string]: Array; }} + * @memberof ContentFileSearchResponseMetadata + */ + aggregations: { + [ + key: string + ]: Array + } + /** + * + * @type {Array} + * @memberof ContentFileSearchResponseMetadata + */ + suggestions: Array } /** - * + * * @export * @interface ContentFileSearchResponseMetadataAggregationsValueInner */ export interface ContentFileSearchResponseMetadataAggregationsValueInner { - /** - * - * @type {string} - * @memberof ContentFileSearchResponseMetadataAggregationsValueInner - */ - 'key': string; - /** - * - * @type {number} - * @memberof ContentFileSearchResponseMetadataAggregationsValueInner - */ - 'doc_count': number; + /** + * + * @type {string} + * @memberof ContentFileSearchResponseMetadataAggregationsValueInner + */ + key: string + /** + * + * @type {number} + * @memberof ContentFileSearchResponseMetadataAggregationsValueInner + */ + doc_count: number } /** * Serializer for ContentFile webhook requests. @@ -523,78 +542,76 @@ export interface ContentFileSearchResponseMetadataAggregationsValueInner { * @interface ContentFileWebHookRequest */ export interface ContentFileWebHookRequest { - /** - * - * @type {string} - * @memberof ContentFileWebHookRequest - */ - 'content_path'?: string; - /** - * - * @type {SourceEnum} - * @memberof ContentFileWebHookRequest - */ - 'source': SourceEnum; - /** - * - * @type {string} - * @memberof ContentFileWebHookRequest - */ - 'course_id'?: string; - /** - * - * @type {string} - * @memberof ContentFileWebHookRequest - */ - 'course_readable_id'?: string; + /** + * + * @type {string} + * @memberof ContentFileWebHookRequest + */ + content_path?: string + /** + * + * @type {SourceEnum} + * @memberof ContentFileWebHookRequest + */ + source: SourceEnum + /** + * + * @type {string} + * @memberof ContentFileWebHookRequest + */ + course_id?: string + /** + * + * @type {string} + * @memberof ContentFileWebHookRequest + */ + course_readable_id?: string } - /** * Serializer for ContentFile webhook requests. * @export * @interface ContentFileWebHookRequestRequest */ export interface ContentFileWebHookRequestRequest { - /** - * - * @type {string} - * @memberof ContentFileWebHookRequestRequest - */ - 'content_path'?: string; - /** - * - * @type {SourceEnum} - * @memberof ContentFileWebHookRequestRequest - */ - 'source': SourceEnum; - /** - * - * @type {string} - * @memberof ContentFileWebHookRequestRequest - */ - 'course_id'?: string; - /** - * - * @type {string} - * @memberof ContentFileWebHookRequestRequest - */ - 'course_readable_id'?: string; + /** + * + * @type {string} + * @memberof ContentFileWebHookRequestRequest + */ + content_path?: string + /** + * + * @type {SourceEnum} + * @memberof ContentFileWebHookRequestRequest + */ + source: SourceEnum + /** + * + * @type {string} + * @memberof ContentFileWebHookRequestRequest + */ + course_id?: string + /** + * + * @type {string} + * @memberof ContentFileWebHookRequestRequest + */ + course_readable_id?: string } - /** * Serializer for the Course model * @export * @interface Course */ export interface Course { - /** - * - * @type {Array} - * @memberof Course - */ - 'course_numbers': Array | null; + /** + * + * @type {Array} + * @memberof Course + */ + course_numbers: Array | null } /** * Serializer for CourseNumber @@ -602,24 +619,24 @@ export interface Course { * @interface CourseNumber */ export interface CourseNumber { - /** - * - * @type {string} - * @memberof CourseNumber - */ - 'value': string; - /** - * - * @type {LearningResourceDepartment} - * @memberof CourseNumber - */ - 'department': LearningResourceDepartment; - /** - * - * @type {string} - * @memberof CourseNumber - */ - 'listing_type': string; + /** + * + * @type {string} + * @memberof CourseNumber + */ + value: string + /** + * + * @type {LearningResourceDepartment} + * @memberof CourseNumber + */ + department: LearningResourceDepartment + /** + * + * @type {string} + * @memberof CourseNumber + */ + listing_type: string } /** * Serializer for CourseNumber @@ -627,24 +644,24 @@ export interface CourseNumber { * @interface CourseNumberRequest */ export interface CourseNumberRequest { - /** - * - * @type {string} - * @memberof CourseNumberRequest - */ - 'value': string; - /** - * - * @type {LearningResourceDepartmentRequest} - * @memberof CourseNumberRequest - */ - 'department': LearningResourceDepartmentRequest; - /** - * - * @type {string} - * @memberof CourseNumberRequest - */ - 'listing_type': string; + /** + * + * @type {string} + * @memberof CourseNumberRequest + */ + value: string + /** + * + * @type {LearningResourceDepartmentRequest} + * @memberof CourseNumberRequest + */ + department: LearningResourceDepartmentRequest + /** + * + * @type {string} + * @memberof CourseNumberRequest + */ + listing_type: string } /** * Serializer for the Course model @@ -652,12 +669,12 @@ export interface CourseNumberRequest { * @interface CourseRequest */ export interface CourseRequest { - /** - * - * @type {Array} - * @memberof CourseRequest - */ - 'course_numbers': Array | null; + /** + * + * @type {Array} + * @memberof CourseRequest + */ + course_numbers: Array | null } /** * Serializer for course resources @@ -665,408 +682,411 @@ export interface CourseRequest { * @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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof CourseResourceCertificationType + */ + code: CourseResourceCertificationTypeCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceCertificationType + */ + name: string } export const CourseResourceCertificationTypeCodeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const -export type CourseResourceCertificationTypeCodeEnum = typeof CourseResourceCertificationTypeCodeEnum[keyof typeof CourseResourceCertificationTypeCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourceDeliveryInner + */ + code: CourseResourceDeliveryInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceDeliveryInner + */ + name: string } export const CourseResourceDeliveryInnerCodeEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const -export type CourseResourceDeliveryInnerCodeEnum = typeof CourseResourceDeliveryInnerCodeEnum[keyof typeof CourseResourceDeliveryInnerCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourceFormatInner + */ + code: CourseResourceFormatInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourceFormatInner + */ + name: string } export const CourseResourceFormatInnerCodeEnum = { - Synchronous: 'synchronous', - Asynchronous: 'asynchronous' -} as const; + Synchronous: "synchronous", + Asynchronous: "asynchronous", +} as const -export type CourseResourceFormatInnerCodeEnum = typeof CourseResourceFormatInnerCodeEnum[keyof typeof CourseResourceFormatInnerCodeEnum]; +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; + /** + * + * @type {string} + * @memberof CourseResourcePaceInner + */ + code: CourseResourcePaceInnerCodeEnum + /** + * + * @type {string} + * @memberof CourseResourcePaceInner + */ + name: string } export const CourseResourcePaceInnerCodeEnum = { - SelfPaced: 'self_paced', - InstructorPaced: 'instructor_paced' -} as const; + SelfPaced: "self_paced", + InstructorPaced: "instructor_paced", +} as const -export type CourseResourcePaceInnerCodeEnum = typeof CourseResourcePaceInnerCodeEnum[keyof typeof CourseResourcePaceInnerCodeEnum]; +export type CourseResourcePaceInnerCodeEnum = + (typeof CourseResourcePaceInnerCodeEnum)[keyof typeof CourseResourcePaceInnerCodeEnum] /** * Serializer for course resources @@ -1074,153 +1094,152 @@ export type CourseResourcePaceInnerCodeEnum = typeof CourseResourcePaceInnerCode * @interface CourseResourceRequest */ export interface CourseResourceRequest { - /** - * - * @type {Array} - * @memberof CourseResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof CourseResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof CourseResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof CourseResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof CourseResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof CourseResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof CourseResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof CourseResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof CourseResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof CourseResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof CourseResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof CourseResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof CourseResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof CourseResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof CourseResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof CourseResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof CourseResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof CourseResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof CourseResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof CourseResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof CourseResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof CourseResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof CourseResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof CourseResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof CourseResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof CourseResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const CourseResourceResourceTypeEnum = { - Course: 'course' -} as const; - -export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEnum[keyof typeof CourseResourceResourceTypeEnum]; + Course: "course", +} as const +export type CourseResourceResourceTypeEnum = + (typeof CourseResourceResourceTypeEnum)[keyof typeof CourseResourceResourceTypeEnum] /** * * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline @@ -1229,26 +1248,25 @@ export type CourseResourceResourceTypeEnum = typeof CourseResourceResourceTypeEn */ export const DeliveryEnum = { - /** - * Online - */ - Online: 'online', - /** - * Hybrid - */ - Hybrid: 'hybrid', - /** - * In person - */ - InPerson: 'in_person', - /** - * Offline - */ - Offline: 'offline' -} as const; - -export type DeliveryEnum = typeof DeliveryEnum[keyof typeof DeliveryEnum]; - + /** + * Online + */ + Online: "online", + /** + * Hybrid + */ + Hybrid: "hybrid", + /** + * In person + */ + InPerson: "in_person", + /** + * Offline + */ + Offline: "offline", +} as const + +export type DeliveryEnum = (typeof DeliveryEnum)[keyof typeof DeliveryEnum] /** * * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies @@ -1257,158 +1275,158 @@ export type DeliveryEnum = typeof DeliveryEnum[keyof typeof DeliveryEnum]; */ export const DepartmentEnum = { - /** - * Civil and Environmental Engineering - */ - _1: '1', - /** - * Mechanical Engineering - */ - _2: '2', - /** - * Materials Science and Engineering - */ - _3: '3', - /** - * Architecture - */ - _4: '4', - /** - * Chemistry - */ - _5: '5', - /** - * Electrical Engineering and Computer Science - */ - _6: '6', - /** - * Biology - */ - _7: '7', - /** - * Physics - */ - _8: '8', - /** - * Brain and Cognitive Sciences - */ - _9: '9', - /** - * Chemical Engineering - */ - _10: '10', - /** - * Urban Studies and Planning - */ - _11: '11', - /** - * Earth, Atmospheric, and Planetary Sciences - */ - _12: '12', - /** - * Economics - */ - _14: '14', - /** - * Management - */ - _15: '15', - /** - * Aeronautics and Astronautics - */ - _16: '16', - /** - * Political Science - */ - _17: '17', - /** - * Mathematics - */ - _18: '18', - /** - * Biological Engineering - */ - _20: '20', - /** - * Anthropology - */ - _21A: '21A', - /** - * Global Languages - */ - _21G: '21G', - /** - * History - */ - _21H: '21H', - /** - * Literature - */ - _21L: '21L', - /** - * Music and Theater Arts - */ - _21M: '21M', - /** - * Nuclear Science and Engineering - */ - _22: '22', - /** - * Linguistics and Philosophy - */ - _24: '24', - /** - * Concourse - */ - Cc: 'CC', - /** - * Comparative Media Studies/Writing - */ - CmsW: 'CMS-W', - /** - * Edgerton Center - */ - Ec: 'EC', - /** - * Experimental Study Group - */ - Es: 'ES', - /** - * Engineering Systems Division - */ - Esd: 'ESD', - /** - * Medical Engineering and Science - */ - Hst: 'HST', - /** - * Data, Systems, and Society - */ - Ids: 'IDS', - /** - * Media Arts and Sciences - */ - Mas: 'MAS', - /** - * Athletics, Physical Education and Recreation - */ - Pe: 'PE', - /** - * Special Programs - */ - Sp: 'SP', - /** - * Science, Technology, and Society - */ - Sts: 'STS', - /** - * Women's and Gender Studies - */ - Wgs: 'WGS' -} as const; - -export type DepartmentEnum = typeof DepartmentEnum[keyof typeof DepartmentEnum]; - + /** + * Civil and Environmental Engineering + */ + _1: "1", + /** + * Mechanical Engineering + */ + _2: "2", + /** + * Materials Science and Engineering + */ + _3: "3", + /** + * Architecture + */ + _4: "4", + /** + * Chemistry + */ + _5: "5", + /** + * Electrical Engineering and Computer Science + */ + _6: "6", + /** + * Biology + */ + _7: "7", + /** + * Physics + */ + _8: "8", + /** + * Brain and Cognitive Sciences + */ + _9: "9", + /** + * Chemical Engineering + */ + _10: "10", + /** + * Urban Studies and Planning + */ + _11: "11", + /** + * Earth, Atmospheric, and Planetary Sciences + */ + _12: "12", + /** + * Economics + */ + _14: "14", + /** + * Management + */ + _15: "15", + /** + * Aeronautics and Astronautics + */ + _16: "16", + /** + * Political Science + */ + _17: "17", + /** + * Mathematics + */ + _18: "18", + /** + * Biological Engineering + */ + _20: "20", + /** + * Anthropology + */ + _21A: "21A", + /** + * Global Languages + */ + _21G: "21G", + /** + * History + */ + _21H: "21H", + /** + * Literature + */ + _21L: "21L", + /** + * Music and Theater Arts + */ + _21M: "21M", + /** + * Nuclear Science and Engineering + */ + _22: "22", + /** + * Linguistics and Philosophy + */ + _24: "24", + /** + * Concourse + */ + Cc: "CC", + /** + * Comparative Media Studies/Writing + */ + CmsW: "CMS-W", + /** + * Edgerton Center + */ + Ec: "EC", + /** + * Experimental Study Group + */ + Es: "ES", + /** + * Engineering Systems Division + */ + Esd: "ESD", + /** + * Medical Engineering and Science + */ + Hst: "HST", + /** + * Data, Systems, and Society + */ + Ids: "IDS", + /** + * Media Arts and Sciences + */ + Mas: "MAS", + /** + * Athletics, Physical Education and Recreation + */ + Pe: "PE", + /** + * Special Programs + */ + Sp: "SP", + /** + * Science, Technology, and Society + */ + Sts: "STS", + /** + * Women's and Gender Studies + */ + Wgs: "WGS", +} as const + +export type DepartmentEnum = + (typeof DepartmentEnum)[keyof typeof DepartmentEnum] /** * Serializer for document resources @@ -1416,1555 +1434,1553 @@ export type DepartmentEnum = typeof DepartmentEnum[keyof typeof DepartmentEnum]; * @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; + /** + * + * @type {number} + * @memberof DocumentResource + */ + id: number + /** + * + * @type {Array} + * @memberof DocumentResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof DocumentResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof DocumentResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof DocumentResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof DocumentResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof DocumentResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof DocumentResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof DocumentResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof DocumentResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof DocumentResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof DocumentResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof DocumentResource + */ + views: number + /** + * + * @type {Array} + * @memberof DocumentResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof DocumentResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof DocumentResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof DocumentResource + */ + format: Array + /** + * + * @type {Array} + * @memberof DocumentResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof DocumentResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof DocumentResource + */ + best_run_id: number | null + /** + * + * @type {DocumentResourceResourceTypeEnum} + * @memberof DocumentResource + */ + resource_type: DocumentResourceResourceTypeEnum + /** + * + * @type {Array} + * @memberof DocumentResource + */ + content_files: Array | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + description: string | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof DocumentResource + */ + title: string + /** + * + * @type {string} + * @memberof DocumentResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof DocumentResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof DocumentResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof DocumentResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof DocumentResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof DocumentResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof DocumentResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof DocumentResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + location?: string + /** + * + * @type {string} + * @memberof DocumentResource + */ + duration?: string + /** + * + * @type {number} + * @memberof DocumentResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof DocumentResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof DocumentResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof DocumentResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof DocumentResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof DocumentResource + */ + require_summaries: boolean } - /** * Serializer for document resources * @export * @interface DocumentResourceRequest */ export interface DocumentResourceRequest { - /** - * - * @type {Array} - * @memberof DocumentResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof DocumentResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof DocumentResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof DocumentResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof DocumentResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof DocumentResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof DocumentResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof DocumentResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof DocumentResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof DocumentResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof DocumentResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof DocumentResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof DocumentResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof DocumentResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof DocumentResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof DocumentResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof DocumentResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof DocumentResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof DocumentResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof DocumentResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof DocumentResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof DocumentResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof DocumentResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof DocumentResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof DocumentResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof DocumentResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const DocumentResourceResourceTypeEnum = { - Document: 'document' -} as const; - -export type DocumentResourceResourceTypeEnum = typeof DocumentResourceResourceTypeEnum[keyof typeof DocumentResourceResourceTypeEnum]; + Document: "document", +} as const +export type DocumentResourceResourceTypeEnum = + (typeof DocumentResourceResourceTypeEnum)[keyof typeof DocumentResourceResourceTypeEnum] /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPaging */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPaging { - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging - */ - 'paging'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging - */ - 'results'?: Array; + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging + */ + paging?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPaging + */ + results?: Array } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging { - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging - */ - 'next'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext; + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPaging + */ + next?: HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext - */ - 'link'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext - */ - 'after'?: string | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext + */ + link?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingPagingNext + */ + after?: string | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'form_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'id'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'name'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'created_at'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'updated_at'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'archived'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'archived_at'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'field_groups'?: Array; - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'configuration'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration; - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'display_options'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions; - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem - */ - 'legal_consent_options'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + form_type?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + id?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + name?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + created_at?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + updated_at?: string | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + archived?: boolean | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + archived_at?: string | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + field_groups?: Array + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + configuration?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + display_options?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItem + */ + legal_consent_options?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration { - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'create_new_contact_for_new_email'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'editable'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'allow_link_to_reset_known_values'?: boolean | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'lifecycle_stages'?: Array; - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'post_submit_action'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'language'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'pre_populate_known_values'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'cloneable'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'notify_contact_owner'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'recaptcha_enabled'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'archivable'?: boolean | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration - */ - 'notify_recipients'?: Array; + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + create_new_contact_for_new_email?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + editable?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + allow_link_to_reset_known_values?: boolean | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + lifecycle_stages?: Array + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + post_submit_action?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + language?: string | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + pre_populate_known_values?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + cloneable?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + notify_contact_owner?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + recaptcha_enabled?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + archivable?: boolean | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfiguration + */ + notify_recipients?: Array } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem - */ - 'object_type_id'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem - */ - 'value'?: string | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem + */ + object_type_id?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationLifecycleStageItem + */ + value?: string | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction - */ - 'type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction - */ - 'value'?: string | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction + */ + type?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemConfigurationPostSubmitAction + */ + value?: string | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions { - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions - */ - 'render_raw_html'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions - */ - 'css_class'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions - */ - 'theme'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions - */ - 'submit_button_text'?: string | null; - /** - * - * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions - */ - 'style'?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle; + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + */ + render_raw_html?: boolean | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + */ + css_class?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + */ + theme?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + */ + submit_button_text?: string | null + /** + * + * @type {HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptions + */ + style?: HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'label_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'legal_consent_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'font_family'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'legal_consent_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'background_width'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'help_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'submit_font_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'label_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'submit_alignment'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'submit_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'help_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle - */ - 'submit_color'?: string | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + label_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + legal_consent_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + font_family?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + legal_consent_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + background_width?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + help_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + submit_font_color?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + label_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + submit_alignment?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + submit_size?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + help_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemDisplayOptionsStyle + */ + submit_color?: string | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem - */ - 'group_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem - */ - 'rich_text_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem - */ - 'rich_text'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem - */ - 'fields'?: Array; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem + */ + group_type?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem + */ + rich_text_type?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem + */ + rich_text?: string | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItem + */ + fields?: Array } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'object_type_id'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'hidden'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'default_value'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'name'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'label'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'placeholder'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'field_type'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'required'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'use_country_code_select'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated - */ - 'allow_multiple_files'?: boolean | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + object_type_id?: string | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + hidden?: boolean | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + default_value?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + name?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + description?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + label?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + placeholder?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + field_type?: string | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + required?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + use_country_code_select?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemFieldGroupItemFieldItemTruncated + */ + allow_multiple_files?: boolean | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions { - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'type'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'subscription_type_ids'?: Array; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'lawful_basis'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'privacy_text'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'communications_checkboxes'?: Array; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'communication_consent_text'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'consent_to_process_checkbox_label'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'consent_to_process_footer_text'?: string | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions - */ - 'consent_to_process_text'?: string | null; + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + type?: string | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + subscription_type_ids?: Array + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + lawful_basis?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + privacy_text?: string | null + /** + * + * @type {Array} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + communications_checkboxes?: Array + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + communication_consent_text?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + consent_to_process_checkbox_label?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + consent_to_process_footer_text?: string | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptions + */ + consent_to_process_text?: string | null } /** - * + * * @export * @interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem */ export interface HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem { - /** - * - * @type {number} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem - */ - 'subscription_type_id'?: number | null; - /** - * - * @type {string} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem - */ - 'label'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem - */ - 'required'?: boolean | null; + /** + * + * @type {number} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem + */ + subscription_type_id?: number | null + /** + * + * @type {string} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem + */ + label?: string | null + /** + * + * @type {boolean} + * @memberof HubspotCollectionResponseFormDefinitionBaseForwardPagingResultItemLegalConsentOptionsCommunicationsCheckboxItem + */ + required?: boolean | null } /** - * + * * @export * @interface HubspotFormDefinition */ export interface HubspotFormDefinition { - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'form_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'id'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'name'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'created_at'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'updated_at'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinition - */ - 'archived'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinition - */ - 'archived_at'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinition - */ - 'field_groups'?: Array; - /** - * - * @type {HubspotFormDefinitionConfiguration} - * @memberof HubspotFormDefinition - */ - 'configuration'?: HubspotFormDefinitionConfiguration; - /** - * - * @type {HubspotFormDefinitionDisplayOptions} - * @memberof HubspotFormDefinition - */ - 'display_options'?: HubspotFormDefinitionDisplayOptions; - /** - * - * @type {HubspotFormDefinitionLegalConsentOptions} - * @memberof HubspotFormDefinition - */ - 'legal_consent_options'?: HubspotFormDefinitionLegalConsentOptions; + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + form_type?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + id?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + name?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + created_at?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + updated_at?: string | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinition + */ + archived?: boolean | null + /** + * + * @type {string} + * @memberof HubspotFormDefinition + */ + archived_at?: string | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinition + */ + field_groups?: Array + /** + * + * @type {HubspotFormDefinitionConfiguration} + * @memberof HubspotFormDefinition + */ + configuration?: HubspotFormDefinitionConfiguration + /** + * + * @type {HubspotFormDefinitionDisplayOptions} + * @memberof HubspotFormDefinition + */ + display_options?: HubspotFormDefinitionDisplayOptions + /** + * + * @type {HubspotFormDefinitionLegalConsentOptions} + * @memberof HubspotFormDefinition + */ + legal_consent_options?: HubspotFormDefinitionLegalConsentOptions } /** - * + * * @export * @interface HubspotFormDefinitionConfiguration */ export interface HubspotFormDefinitionConfiguration { - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'create_new_contact_for_new_email'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'editable'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'allow_link_to_reset_known_values'?: boolean | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionConfiguration - */ - 'lifecycle_stages'?: Array; - /** - * - * @type {HubspotFormDefinitionConfigurationPostSubmitAction} - * @memberof HubspotFormDefinitionConfiguration - */ - 'post_submit_action'?: HubspotFormDefinitionConfigurationPostSubmitAction; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionConfiguration - */ - 'language'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'pre_populate_known_values'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'cloneable'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'notify_contact_owner'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'recaptcha_enabled'?: boolean | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionConfiguration - */ - 'archivable'?: boolean | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionConfiguration - */ - 'notify_recipients'?: Array; + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + create_new_contact_for_new_email?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + editable?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + allow_link_to_reset_known_values?: boolean | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionConfiguration + */ + lifecycle_stages?: Array + /** + * + * @type {HubspotFormDefinitionConfigurationPostSubmitAction} + * @memberof HubspotFormDefinitionConfiguration + */ + post_submit_action?: HubspotFormDefinitionConfigurationPostSubmitAction + /** + * + * @type {string} + * @memberof HubspotFormDefinitionConfiguration + */ + language?: string | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + pre_populate_known_values?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + cloneable?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + notify_contact_owner?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + recaptcha_enabled?: boolean | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionConfiguration + */ + archivable?: boolean | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionConfiguration + */ + notify_recipients?: Array } /** - * + * * @export * @interface HubspotFormDefinitionConfigurationLifecycleStageItem */ export interface HubspotFormDefinitionConfigurationLifecycleStageItem { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem - */ - 'object_type_id'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem - */ - 'value'?: string | null; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem + */ + object_type_id?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionConfigurationLifecycleStageItem + */ + value?: string | null } /** - * + * * @export * @interface HubspotFormDefinitionConfigurationPostSubmitAction */ export interface HubspotFormDefinitionConfigurationPostSubmitAction { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionConfigurationPostSubmitAction - */ - 'type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionConfigurationPostSubmitAction - */ - 'value'?: string | null; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionConfigurationPostSubmitAction + */ + type?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionConfigurationPostSubmitAction + */ + value?: string | null } /** - * + * * @export * @interface HubspotFormDefinitionDisplayOptions */ export interface HubspotFormDefinitionDisplayOptions { - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionDisplayOptions - */ - 'render_raw_html'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptions - */ - 'css_class'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptions - */ - 'theme'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptions - */ - 'submit_button_text'?: string | null; - /** - * - * @type {HubspotFormDefinitionDisplayOptionsStyle} - * @memberof HubspotFormDefinitionDisplayOptions - */ - 'style'?: HubspotFormDefinitionDisplayOptionsStyle; + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionDisplayOptions + */ + render_raw_html?: boolean | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptions + */ + css_class?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptions + */ + theme?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptions + */ + submit_button_text?: string | null + /** + * + * @type {HubspotFormDefinitionDisplayOptionsStyle} + * @memberof HubspotFormDefinitionDisplayOptions + */ + style?: HubspotFormDefinitionDisplayOptionsStyle } /** - * + * * @export * @interface HubspotFormDefinitionDisplayOptionsStyle */ export interface HubspotFormDefinitionDisplayOptionsStyle { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'label_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'legal_consent_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'font_family'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'legal_consent_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'background_width'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'help_text_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'submit_font_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'label_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'submit_alignment'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'submit_size'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'help_text_color'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionDisplayOptionsStyle - */ - 'submit_color'?: string | null; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + label_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + legal_consent_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + font_family?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + legal_consent_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + background_width?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + help_text_size?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + submit_font_color?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + label_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + submit_alignment?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + submit_size?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + help_text_color?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionDisplayOptionsStyle + */ + submit_color?: string | null } /** - * + * * @export * @interface HubspotFormDefinitionFieldGroupItem */ export interface HubspotFormDefinitionFieldGroupItem { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItem - */ - 'group_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItem - */ - 'rich_text_type'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItem - */ - 'rich_text'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionFieldGroupItem - */ - 'fields'?: Array; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItem + */ + group_type?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItem + */ + rich_text_type?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItem + */ + rich_text?: string | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionFieldGroupItem + */ + fields?: Array } /** - * + * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItem */ export interface HubspotFormDefinitionFieldGroupItemFieldItem { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'object_type_id'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'hidden'?: boolean | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'default_value'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'name'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'label'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'placeholder'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'field_type'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'required'?: boolean | null; - /** - * - * @type {HubspotFormDefinitionFieldGroupItemFieldItemValidation} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'validation'?: HubspotFormDefinitionFieldGroupItemFieldItemValidation; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'use_country_code_select'?: boolean | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'options'?: Array; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'default_values'?: Array; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItem - */ - 'allow_multiple_files'?: boolean | null; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + object_type_id?: string | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + hidden?: boolean | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + default_value?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + name?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + description?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + label?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + placeholder?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + field_type?: string | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + required?: boolean | null + /** + * + * @type {HubspotFormDefinitionFieldGroupItemFieldItemValidation} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + validation?: HubspotFormDefinitionFieldGroupItemFieldItemValidation + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + use_country_code_select?: boolean | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + options?: Array + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + default_values?: Array + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItem + */ + allow_multiple_files?: boolean | null } /** - * + * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated */ export interface HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated { - /** - * - * @type {number} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated - */ - 'display_order'?: number | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated - */ - 'label'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated - */ - 'value'?: string | null; + /** + * + * @type {number} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated + */ + display_order?: number | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated + */ + description?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated + */ + label?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemOptionItemTruncated + */ + value?: string | null } /** - * + * * @export * @interface HubspotFormDefinitionFieldGroupItemFieldItemValidation */ export interface HubspotFormDefinitionFieldGroupItemFieldItemValidation { - /** - * - * @type {number} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation - */ - 'min_allowed_digits'?: number | null; - /** - * - * @type {number} - * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation - */ - 'max_allowed_digits'?: number | null; + /** + * + * @type {number} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation + */ + min_allowed_digits?: number | null + /** + * + * @type {number} + * @memberof HubspotFormDefinitionFieldGroupItemFieldItemValidation + */ + max_allowed_digits?: number | null } /** - * + * * @export * @interface HubspotFormDefinitionLegalConsentOptions */ export interface HubspotFormDefinitionLegalConsentOptions { - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'type'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'subscription_type_ids'?: Array; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'lawful_basis'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'privacy_text'?: string | null; - /** - * - * @type {Array} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'communications_checkboxes'?: Array; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'communication_consent_text'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'consent_to_process_checkbox_label'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'consent_to_process_footer_text'?: string | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptions - */ - 'consent_to_process_text'?: string | null; + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + type?: string | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + subscription_type_ids?: Array + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + lawful_basis?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + privacy_text?: string | null + /** + * + * @type {Array} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + communications_checkboxes?: Array + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + communication_consent_text?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + consent_to_process_checkbox_label?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + consent_to_process_footer_text?: string | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptions + */ + consent_to_process_text?: string | null } /** - * + * * @export * @interface HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem */ export interface HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem { - /** - * - * @type {number} - * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem - */ - 'subscription_type_id'?: number | null; - /** - * - * @type {string} - * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem - */ - 'label'?: string | null; - /** - * - * @type {boolean} - * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem - */ - 'required'?: boolean | null; + /** + * + * @type {number} + * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem + */ + subscription_type_id?: number | null + /** + * + * @type {string} + * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem + */ + label?: string | null + /** + * + * @type {boolean} + * @memberof HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxItem + */ + required?: boolean | null } /** * Serializer for individual form field values in submission. @@ -2972,18 +2988,18 @@ export interface HubspotFormDefinitionLegalConsentOptionsCommunicationsCheckboxI * @interface HubspotFormFieldValueRequest */ export interface HubspotFormFieldValueRequest { - /** - * - * @type {string} - * @memberof HubspotFormFieldValueRequest - */ - 'name': string; - /** - * - * @type {any} - * @memberof HubspotFormFieldValueRequest - */ - 'value': any | null; + /** + * + * @type {string} + * @memberof HubspotFormFieldValueRequest + */ + name: string + /** + * + * @type {any} + * @memberof HubspotFormFieldValueRequest + */ + value: any | null } /** * Serializer for HubSpot form submission requests. @@ -2991,54 +3007,54 @@ export interface HubspotFormFieldValueRequest { * @interface HubspotFormSubmitRequestRequest */ export interface HubspotFormSubmitRequestRequest { - /** - * - * @type {Array} - * @memberof HubspotFormSubmitRequestRequest - */ - 'fields': Array; - /** - * - * @type {string} - * @memberof HubspotFormSubmitRequestRequest - */ - 'page_uri'?: string; - /** - * - * @type {string} - * @memberof HubspotFormSubmitRequestRequest - */ - 'hutk'?: string; - /** - * - * @type {string} - * @memberof HubspotFormSubmitRequestRequest - */ - 'page_name'?: string; - /** - * - * @type {number} - * @memberof HubspotFormSubmitRequestRequest - */ - 'submitted_at'?: number; - /** - * - * @type {string} - * @memberof HubspotFormSubmitRequestRequest - */ - 'recaptcha_token'?: string; - /** - * - * @type {string} - * @memberof HubspotFormSubmitRequestRequest - */ - 'page_title'?: string; - /** - * - * @type {number} - * @memberof HubspotFormSubmitRequestRequest - */ - 'timestamp'?: number; + /** + * + * @type {Array} + * @memberof HubspotFormSubmitRequestRequest + */ + fields: Array + /** + * + * @type {string} + * @memberof HubspotFormSubmitRequestRequest + */ + page_uri?: string + /** + * + * @type {string} + * @memberof HubspotFormSubmitRequestRequest + */ + hutk?: string + /** + * + * @type {string} + * @memberof HubspotFormSubmitRequestRequest + */ + page_name?: string + /** + * + * @type {number} + * @memberof HubspotFormSubmitRequestRequest + */ + submitted_at?: number + /** + * + * @type {string} + * @memberof HubspotFormSubmitRequestRequest + */ + recaptcha_token?: string + /** + * + * @type {string} + * @memberof HubspotFormSubmitRequestRequest + */ + page_title?: string + /** + * + * @type {number} + * @memberof HubspotFormSubmitRequestRequest + */ + timestamp?: number } /** * Serializer for HubSpot form submission response. @@ -3046,12 +3062,12 @@ export interface HubspotFormSubmitRequestRequest { * @interface HubspotFormSubmitResponse */ export interface HubspotFormSubmitResponse { - /** - * - * @type {string} - * @memberof HubspotFormSubmitResponse - */ - 'status'?: string; + /** + * + * @type {string} + * @memberof HubspotFormSubmitResponse + */ + status?: string } /** * Serializer for the LearningPath model @@ -3059,18 +3075,18 @@ export interface HubspotFormSubmitResponse { * @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; + /** + * + * @type {number} + * @memberof LearningPath + */ + id: number + /** + * Number of published items in the list. + * @type {number} + * @memberof LearningPath + */ + item_count: number } /** * Specialized serializer for a LearningPath relationship @@ -3078,36 +3094,36 @@ export interface LearningPath { * @interface LearningPathRelationship */ export interface LearningPathRelationship { - /** - * - * @type {number} - * @memberof LearningPathRelationship - */ - 'id': number; - /** - * - * @type {LearningResource} - * @memberof LearningPathRelationship - */ - 'resource': LearningResource; - /** - * - * @type {number} - * @memberof LearningPathRelationship - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof LearningPathRelationship - */ - 'parent': number; - /** - * - * @type {number} - * @memberof LearningPathRelationship - */ - 'child': number; + /** + * + * @type {number} + * @memberof LearningPathRelationship + */ + id: number + /** + * + * @type {LearningResource} + * @memberof LearningPathRelationship + */ + resource: LearningResource + /** + * + * @type {number} + * @memberof LearningPathRelationship + */ + position?: number + /** + * + * @type {number} + * @memberof LearningPathRelationship + */ + parent: number + /** + * + * @type {number} + * @memberof LearningPathRelationship + */ + child: number } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. @@ -3115,36 +3131,36 @@ export interface LearningPathRelationship { * @interface LearningPathRelationshipCreate */ export interface LearningPathRelationshipCreate { - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreate - */ - 'id': number; - /** - * - * @type {LearningResource} - * @memberof LearningPathRelationshipCreate - */ - 'resource': LearningResource; - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreate - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreate - */ - 'parent': number; - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreate - */ - 'child': number; + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreate + */ + id: number + /** + * + * @type {LearningResource} + * @memberof LearningPathRelationshipCreate + */ + resource: LearningResource + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreate + */ + position?: number + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreate + */ + parent: number + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreate + */ + child: number } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. @@ -3152,18 +3168,18 @@ export interface LearningPathRelationshipCreate { * @interface LearningPathRelationshipCreateRequest */ export interface LearningPathRelationshipCreateRequest { - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreateRequest - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof LearningPathRelationshipCreateRequest - */ - 'child': number; + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreateRequest + */ + position?: number + /** + * + * @type {number} + * @memberof LearningPathRelationshipCreateRequest + */ + child: number } /** * CRUD serializer for LearningPath resources @@ -3171,456 +3187,462 @@ export interface LearningPathRelationshipCreateRequest { * @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; + /** + * + * @type {number} + * @memberof LearningPathResource + */ + id: number + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof LearningPathResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof LearningPathResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof LearningPathResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof LearningPathResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof LearningPathResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof LearningPathResource + */ + views: number + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof LearningPathResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof LearningPathResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + format: Array + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof LearningPathResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof LearningPathResource + */ + best_run_id: number | null + /** + * + * @type {LearningPathResourceResourceTypeEnum} + * @memberof LearningPathResource + */ + resource_type: LearningPathResourceResourceTypeEnum + /** + * The display category for this resource. + * @type {string} + * @memberof LearningPathResource + */ + resource_category: string + /** + * + * @type {LearningPath} + * @memberof LearningPathResource + */ + learning_path: LearningPath + /** + * + * @type {string} + * @memberof LearningPathResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof LearningPathResource + */ + title: string + /** + * + * @type {string} + * @memberof LearningPathResource + */ + description?: string | null + /** + * + * @type {string} + * @memberof LearningPathResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof LearningPathResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof LearningPathResource + */ + url?: string | null + /** + * + * @type {Array} + * @memberof LearningPathResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof LearningPathResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof LearningPathResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof LearningPathResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof LearningPathResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof LearningPathResource + */ + location?: string + /** + * + * @type {string} + * @memberof LearningPathResource + */ + duration?: string + /** + * + * @type {number} + * @memberof LearningPathResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof LearningPathResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof LearningPathResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof LearningPathResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof LearningPathResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof LearningPathResource + */ + require_summaries: boolean } - /** * CRUD serializer for LearningPath resources * @export * @interface LearningPathResourceRequest */ export interface LearningPathResourceRequest { - /** - * - * @type {Array} - * @memberof LearningPathResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof LearningPathResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof LearningPathResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof LearningPathResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof LearningPathResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof LearningPathResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof LearningPathResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof LearningPathResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof LearningPathResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof LearningPathResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof LearningPathResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof LearningPathResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof LearningPathResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof LearningPathResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof LearningPathResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof LearningPathResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof LearningPathResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof LearningPathResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof LearningPathResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof LearningPathResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof LearningPathResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof LearningPathResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof LearningPathResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof LearningPathResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof LearningPathResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof LearningPathResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const LearningPathResourceResourceTypeEnum = { - LearningPath: 'learning_path' -} as const; - -export type LearningPathResourceResourceTypeEnum = typeof LearningPathResourceResourceTypeEnum[keyof typeof LearningPathResourceResourceTypeEnum]; + LearningPath: "learning_path", +} as const +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; +export type LearningResource = + | ({ resource_type: "course" } & CourseResource) + | ({ resource_type: "document" } & DocumentResource) + | ({ resource_type: "learning_path" } & LearningPathResource) + | ({ resource_type: "podcast" } & PodcastResource) + | ({ resource_type: "podcast_episode" } & PodcastEpisodeResource) + | ({ resource_type: "program" } & ProgramResource) + | ({ resource_type: "video" } & VideoResource) + | ({ resource_type: "video_playlist" } & VideoPlaylistResource) /** * Serializer for LearningResourceDepartment, minus school The absence of the departments list is to avoid a circular serialization structure. @@ -3628,24 +3650,24 @@ export type LearningResource = { resource_type: 'course' } & CourseResource | { * @interface LearningResourceBaseDepartment */ export interface LearningResourceBaseDepartment { - /** - * - * @type {string} - * @memberof LearningResourceBaseDepartment - */ - 'department_id': string; - /** - * - * @type {string} - * @memberof LearningResourceBaseDepartment - */ - 'name': string; - /** - * - * @type {string} - * @memberof LearningResourceBaseDepartment - */ - 'channel_url': string | null; + /** + * + * @type {string} + * @memberof LearningResourceBaseDepartment + */ + department_id: string + /** + * + * @type {string} + * @memberof LearningResourceBaseDepartment + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceBaseDepartment + */ + channel_url: string | null } /** * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. @@ -3653,24 +3675,24 @@ export interface LearningResourceBaseDepartment { * @interface LearningResourceBaseSchool */ export interface LearningResourceBaseSchool { - /** - * - * @type {number} - * @memberof LearningResourceBaseSchool - */ - 'id': number; - /** - * - * @type {string} - * @memberof LearningResourceBaseSchool - */ - 'name': string; - /** - * - * @type {string} - * @memberof LearningResourceBaseSchool - */ - 'url': string; + /** + * + * @type {number} + * @memberof LearningResourceBaseSchool + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceBaseSchool + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceBaseSchool + */ + url: string } /** * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. @@ -3678,18 +3700,18 @@ export interface LearningResourceBaseSchool { * @interface LearningResourceBaseSchoolRequest */ export interface LearningResourceBaseSchoolRequest { - /** - * - * @type {string} - * @memberof LearningResourceBaseSchoolRequest - */ - 'name': string; - /** - * - * @type {string} - * @memberof LearningResourceBaseSchoolRequest - */ - 'url': string; + /** + * + * @type {string} + * @memberof LearningResourceBaseSchoolRequest + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceBaseSchoolRequest + */ + url: string } /** * Serializer for LearningResourceContentTag @@ -3697,18 +3719,18 @@ export interface LearningResourceBaseSchoolRequest { * @interface LearningResourceContentTag */ export interface LearningResourceContentTag { - /** - * - * @type {number} - * @memberof LearningResourceContentTag - */ - 'id': number; - /** - * - * @type {string} - * @memberof LearningResourceContentTag - */ - 'name': string; + /** + * + * @type {number} + * @memberof LearningResourceContentTag + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceContentTag + */ + name: string } /** * Full serializer for LearningResourceDepartment, including school @@ -3716,30 +3738,30 @@ export interface LearningResourceContentTag { * @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; + /** + * + * @type {string} + * @memberof LearningResourceDepartment + */ + department_id: string + /** + * + * @type {string} + * @memberof LearningResourceDepartment + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceDepartment + */ + channel_url: string | null + /** + * + * @type {LearningResourceBaseSchool} + * @memberof LearningResourceDepartment + */ + school: LearningResourceBaseSchool | null } /** * Full serializer for LearningResourceDepartment, including school @@ -3747,18 +3769,18 @@ export interface LearningResourceDepartment { * @interface LearningResourceDepartmentRequest */ export interface LearningResourceDepartmentRequest { - /** - * - * @type {string} - * @memberof LearningResourceDepartmentRequest - */ - 'department_id': string; - /** - * - * @type {string} - * @memberof LearningResourceDepartmentRequest - */ - 'name': string; + /** + * + * @type {string} + * @memberof LearningResourceDepartmentRequest + */ + department_id: string + /** + * + * @type {string} + * @memberof LearningResourceDepartmentRequest + */ + name: string } /** * Serializer for the response of the display info endpoint @@ -3766,199 +3788,199 @@ export interface LearningResourceDepartmentRequest { * @interface LearningResourceDisplayInfoResponse */ export interface LearningResourceDisplayInfoResponse { - /** - * Title - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'title': string; - /** - * Description - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'description': string; - /** - * Full Description - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'full_description': string | null; - /** - * Website - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'url': string; - /** - * Free - * @type {boolean} - * @memberof LearningResourceDisplayInfoResponse - */ - 'free': boolean | null; - /** - * Topics - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'topics': Array; - /** - * Price - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'price': string | null; - /** - * Extra Price Information - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'extra_price_info': string | null; - /** - * Certificate - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'certification': string | null; - /** - * Instructors - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'instructors': Array | null; - /** - * Runs/Sessions - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'runs': Array | null; - /** - * Offered By - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'offered_by': string | null; - /** - * Languages - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'languages': Array | null; - /** - * Levels - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'levels': Array | null; - /** - * Departments - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'departments': Array; - /** - * Platform - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'platform': string | null; - /** - * Number of Courses - * @type {number} - * @memberof LearningResourceDisplayInfoResponse - */ - 'number_of_courses': number | null; - /** - * Number of Programs - * @type {number} - * @memberof LearningResourceDisplayInfoResponse - */ - 'number_of_programs': number | null; - /** - * Child courses and programs included in this learning resource - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'program_courses': Array | null; - /** - * Location - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'location': string | null; - /** - * Starts - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'starts': Array | null; - /** - * Format - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'format_type': Array | null; - /** - * As Taught In - * @type {Array} - * @memberof LearningResourceDisplayInfoResponse - */ - 'as_taught_in': Array | null; - /** - * Duration - * @type {string} - * @memberof LearningResourceDisplayInfoResponse - */ - 'duration': string | null; - /** - * - * @type {number} - * @memberof LearningResourceDisplayInfoResponse - */ - 'id': number; + /** + * Title + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + title: string + /** + * Description + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + description: string + /** + * Full Description + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + full_description: string | null + /** + * Website + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + url: string + /** + * Free + * @type {boolean} + * @memberof LearningResourceDisplayInfoResponse + */ + free: boolean | null + /** + * Topics + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + topics: Array + /** + * Price + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + price: string | null + /** + * Extra Price Information + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + extra_price_info: string | null + /** + * Certificate + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + certification: string | null + /** + * Instructors + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + instructors: Array | null + /** + * Runs/Sessions + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + runs: Array | null + /** + * Offered By + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + offered_by: string | null + /** + * Languages + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + languages: Array | null + /** + * Levels + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + levels: Array | null + /** + * Departments + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + departments: Array + /** + * Platform + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + platform: string | null + /** + * Number of Courses + * @type {number} + * @memberof LearningResourceDisplayInfoResponse + */ + number_of_courses: number | null + /** + * Number of Programs + * @type {number} + * @memberof LearningResourceDisplayInfoResponse + */ + number_of_programs: number | null + /** + * Child courses and programs included in this learning resource + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + program_courses: Array | null + /** + * Location + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + location: string | null + /** + * Starts + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + starts: Array | null + /** + * Format + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + format_type: Array | null + /** + * As Taught In + * @type {Array} + * @memberof LearningResourceDisplayInfoResponse + */ + as_taught_in: Array | null + /** + * Duration + * @type {string} + * @memberof LearningResourceDisplayInfoResponse + */ + duration: string | null + /** + * + * @type {number} + * @memberof LearningResourceDisplayInfoResponse + */ + id: number } /** - * + * * @export * @interface LearningResourceDisplayInfoResponseRunsInner */ export interface LearningResourceDisplayInfoResponseRunsInner { - /** - * - * @type {string} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'start_date'?: string; - /** - * - * @type {Array} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'instructors'?: Array; - /** - * - * @type {string} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'duration'?: string; - /** - * - * @type {string} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'price'?: string; - /** - * - * @type {Array} - * @memberof LearningResourceDisplayInfoResponseRunsInner - */ - 'format'?: Array; + /** + * + * @type {string} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + location?: string + /** + * + * @type {string} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + start_date?: string + /** + * + * @type {Array} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + instructors?: Array + /** + * + * @type {string} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + duration?: string + /** + * + * @type {string} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + price?: string + /** + * + * @type {Array} + * @memberof LearningResourceDisplayInfoResponseRunsInner + */ + format?: Array } /** * Serializer for LearningResourceImage @@ -3966,30 +3988,30 @@ export interface LearningResourceDisplayInfoResponseRunsInner { * @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; + /** + * + * @type {number} + * @memberof LearningResourceImage + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceImage + */ + url: string + /** + * + * @type {string} + * @memberof LearningResourceImage + */ + description?: string | null + /** + * + * @type {string} + * @memberof LearningResourceImage + */ + alt?: string | null } /** * Serializer for LearningResourceImage @@ -3997,24 +4019,24 @@ export interface LearningResourceImage { * @interface LearningResourceImageRequest */ export interface LearningResourceImageRequest { - /** - * - * @type {string} - * @memberof LearningResourceImageRequest - */ - 'url': string; - /** - * - * @type {string} - * @memberof LearningResourceImageRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceImageRequest - */ - 'alt'?: string | null; + /** + * + * @type {string} + * @memberof LearningResourceImageRequest + */ + url: string + /** + * + * @type {string} + * @memberof LearningResourceImageRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof LearningResourceImageRequest + */ + alt?: string | null } /** * Serializer for LearningResourceInstructor model @@ -4022,30 +4044,30 @@ export interface LearningResourceImageRequest { * @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; + /** + * + * @type {number} + * @memberof LearningResourceInstructor + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceInstructor + */ + first_name?: string | null + /** + * + * @type {string} + * @memberof LearningResourceInstructor + */ + last_name?: string | null + /** + * + * @type {string} + * @memberof LearningResourceInstructor + */ + full_name?: string | null } /** * Serializer for LearningResourceInstructor model @@ -4053,24 +4075,24 @@ export interface LearningResourceInstructor { * @interface LearningResourceInstructorRequest */ export interface LearningResourceInstructorRequest { - /** - * - * @type {string} - * @memberof LearningResourceInstructorRequest - */ - 'first_name'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceInstructorRequest - */ - 'last_name'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceInstructorRequest - */ - 'full_name'?: string | null; + /** + * + * @type {string} + * @memberof LearningResourceInstructorRequest + */ + first_name?: string | null + /** + * + * @type {string} + * @memberof LearningResourceInstructorRequest + */ + last_name?: string | null + /** + * + * @type {string} + * @memberof LearningResourceInstructorRequest + */ + full_name?: string | null } /** * Serializer for LearningResourceOfferor with basic details @@ -4078,30 +4100,30 @@ export interface LearningResourceInstructorRequest { * @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; + /** + * + * @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 @@ -4109,84 +4131,84 @@ export interface LearningResourceOfferor { * @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; + /** + * + * @type {string} + * @memberof LearningResourceOfferorDetail + */ + code: string + /** + * + * @type {string} + * @memberof LearningResourceOfferorDetail + */ + channel_url: string | null + /** + * + * @type {string} + * @memberof LearningResourceOfferorDetail + */ + name: string + /** + * + * @type {boolean} + * @memberof LearningResourceOfferorDetail + */ + professional?: boolean + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + offerings?: Array + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + audience?: Array + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + formats?: Array + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + fee?: Array + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + certifications?: Array + /** + * + * @type {Array} + * @memberof LearningResourceOfferorDetail + */ + content_types?: Array + /** + * + * @type {string} + * @memberof LearningResourceOfferorDetail + */ + more_information?: string + /** + * + * @type {string} + * @memberof LearningResourceOfferorDetail + */ + value_prop?: string + /** + * + * @type {boolean} + * @memberof LearningResourceOfferorDetail + */ + display_facet?: boolean } /** * Serializer for LearningResourceOfferor with basic details @@ -4194,24 +4216,24 @@ export interface LearningResourceOfferorDetail { * @interface LearningResourceOfferorRequest */ export interface LearningResourceOfferorRequest { - /** - * - * @type {string} - * @memberof LearningResourceOfferorRequest - */ - 'code': string; - /** - * - * @type {string} - * @memberof LearningResourceOfferorRequest - */ - 'name': string; - /** - * - * @type {boolean} - * @memberof LearningResourceOfferorRequest - */ - 'display_facet'?: boolean; + /** + * + * @type {string} + * @memberof LearningResourceOfferorRequest + */ + code: string + /** + * + * @type {string} + * @memberof LearningResourceOfferorRequest + */ + name: string + /** + * + * @type {boolean} + * @memberof LearningResourceOfferorRequest + */ + display_facet?: boolean } /** * Serializer for LearningResourcePlatform @@ -4219,18 +4241,18 @@ export interface LearningResourceOfferorRequest { * @interface LearningResourcePlatform */ export interface LearningResourcePlatform { - /** - * - * @type {string} - * @memberof LearningResourcePlatform - */ - 'code': string; - /** - * - * @type {string} - * @memberof LearningResourcePlatform - */ - 'name'?: string; + /** + * + * @type {string} + * @memberof LearningResourcePlatform + */ + code: string + /** + * + * @type {string} + * @memberof LearningResourcePlatform + */ + name?: string } /** * Serializer for LearningResourcePlatform @@ -4238,18 +4260,18 @@ export interface LearningResourcePlatform { * @interface LearningResourcePlatformRequest */ export interface LearningResourcePlatformRequest { - /** - * - * @type {string} - * @memberof LearningResourcePlatformRequest - */ - 'code': string; - /** - * - * @type {string} - * @memberof LearningResourcePlatformRequest - */ - 'name'?: string; + /** + * + * @type {string} + * @memberof LearningResourcePlatformRequest + */ + code: string + /** + * + * @type {string} + * @memberof LearningResourcePlatformRequest + */ + name?: string } /** * Serializer for LearningResourcePrice model @@ -4257,18 +4279,18 @@ export interface LearningResourcePlatformRequest { * @interface LearningResourcePrice */ export interface LearningResourcePrice { - /** - * - * @type {string} - * @memberof LearningResourcePrice - */ - 'amount': string; - /** - * - * @type {string} - * @memberof LearningResourcePrice - */ - 'currency': string; + /** + * + * @type {string} + * @memberof LearningResourcePrice + */ + amount: string + /** + * + * @type {string} + * @memberof LearningResourcePrice + */ + currency: string } /** * Serializer for LearningResourcePrice model @@ -4276,18 +4298,18 @@ export interface LearningResourcePrice { * @interface LearningResourcePriceRequest */ export interface LearningResourcePriceRequest { - /** - * - * @type {string} - * @memberof LearningResourcePriceRequest - */ - 'amount': string; - /** - * - * @type {string} - * @memberof LearningResourcePriceRequest - */ - 'currency': string; + /** + * + * @type {string} + * @memberof LearningResourcePriceRequest + */ + amount: string + /** + * + * @type {string} + * @memberof LearningResourcePriceRequest + */ + currency: string } /** * CRUD serializer for LearningResourceRelationship @@ -4295,89 +4317,95 @@ export interface LearningResourcePriceRequest { * @interface LearningResourceRelationship */ export interface LearningResourceRelationship { - /** - * - * @type {number} - * @memberof LearningResourceRelationship - */ - 'id': number; - /** - * - * @type {LearningResource} - * @memberof LearningResourceRelationship - */ - 'resource': LearningResource; - /** - * - * @type {number} - * @memberof LearningResourceRelationship - */ - 'position'?: number; - /** - * - * @type {RelationTypeEnum} - * @memberof LearningResourceRelationship - */ - 'relation_type'?: RelationTypeEnum; - /** - * - * @type {number} - * @memberof LearningResourceRelationship - */ - 'parent': number; - /** - * - * @type {number} - * @memberof LearningResourceRelationship - */ - 'child': number; + /** + * + * @type {number} + * @memberof LearningResourceRelationship + */ + id: number + /** + * + * @type {LearningResource} + * @memberof LearningResourceRelationship + */ + resource: LearningResource + /** + * + * @type {number} + * @memberof LearningResourceRelationship + */ + position?: number + /** + * + * @type {RelationTypeEnum} + * @memberof LearningResourceRelationship + */ + relation_type?: RelationTypeEnum + /** + * + * @type {number} + * @memberof LearningResourceRelationship + */ + parent: number + /** + * + * @type {number} + * @memberof LearningResourceRelationship + */ + child: number } - /** * Serializer field for the LearningResourceRelationship model that uses the LearningResourceSerializer to serialize the child resources * @export * @interface LearningResourceRelationshipChildField */ export interface LearningResourceRelationshipChildField { - /** - * - * @type {number} - * @memberof LearningResourceRelationshipChildField - */ - 'child': number; - /** - * - * @type {number} - * @memberof LearningResourceRelationshipChildField - */ - 'position'?: number; - /** - * - * @type {RelationTypeEnum} - * @memberof LearningResourceRelationshipChildField - */ - 'relation_type'?: RelationTypeEnum; - /** - * - * @type {string} - * @memberof LearningResourceRelationshipChildField - */ - 'title': string; - /** - * - * @type {string} - * @memberof LearningResourceRelationshipChildField - */ - 'readable_id': string; + /** + * + * @type {number} + * @memberof LearningResourceRelationshipChildField + */ + child: number + /** + * + * @type {number} + * @memberof LearningResourceRelationshipChildField + */ + position?: number + /** + * + * @type {RelationTypeEnum} + * @memberof LearningResourceRelationshipChildField + */ + relation_type?: RelationTypeEnum + /** + * + * @type {string} + * @memberof LearningResourceRelationshipChildField + */ + title: string + /** + * + * @type {string} + * @memberof LearningResourceRelationshipChildField + */ + readable_id: string } - /** * @type LearningResourceRequest * @export */ -export type LearningResourceRequest = { resource_type: 'course' } & CourseResourceRequest | { resource_type: 'document' } & DocumentResourceRequest | { resource_type: 'learning_path' } & LearningPathResourceRequest | { resource_type: 'podcast' } & PodcastResourceRequest | { resource_type: 'podcast_episode' } & PodcastEpisodeResourceRequest | { resource_type: 'program' } & ProgramResourceRequest | { resource_type: 'video' } & VideoResourceRequest | { resource_type: 'video_playlist' } & VideoPlaylistResourceRequest; +export type LearningResourceRequest = + | ({ resource_type: "course" } & CourseResourceRequest) + | ({ resource_type: "document" } & DocumentResourceRequest) + | ({ resource_type: "learning_path" } & LearningPathResourceRequest) + | ({ resource_type: "podcast" } & PodcastResourceRequest) + | ({ resource_type: "podcast_episode" } & PodcastEpisodeResourceRequest) + | ({ resource_type: "program" } & ProgramResourceRequest) + | ({ resource_type: "video" } & VideoResourceRequest) + | ({ resource_type: "video_playlist" } & VideoPlaylistResourceRequest) /** * Serializer for the LearningResourceRun model @@ -4385,238 +4413,238 @@ export type LearningResourceRequest = { resource_type: 'course' } & CourseResour * @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; + /** + * + * @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; + /** + * + * @type {string} + * @memberof LearningResourceRunLevelInner + */ + code: LearningResourceRunLevelInnerCodeEnum + /** + * + * @type {string} + * @memberof LearningResourceRunLevelInner + */ + name: string } export const LearningResourceRunLevelInnerCodeEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const -export type LearningResourceRunLevelInnerCodeEnum = typeof LearningResourceRunLevelInnerCodeEnum[keyof typeof LearningResourceRunLevelInnerCodeEnum]; +export type LearningResourceRunLevelInnerCodeEnum = + (typeof LearningResourceRunLevelInnerCodeEnum)[keyof typeof LearningResourceRunLevelInnerCodeEnum] /** * Serializer for the LearningResourceRun model @@ -4624,195 +4652,194 @@ export type LearningResourceRunLevelInnerCodeEnum = typeof LearningResourceRunLe * @interface LearningResourceRunRequest */ export interface LearningResourceRunRequest { - /** - * - * @type {Array} - * @memberof LearningResourceRunRequest - */ - 'level': Array; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'run_id': string; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof LearningResourceRunRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof LearningResourceRunRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'url'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'slug'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'semester'?: string | null; - /** - * - * @type {number} - * @memberof LearningResourceRunRequest - */ - 'year'?: number | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'start_date'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'end_date'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'enrollment_start'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'enrollment_end'?: string | null; - /** - * - * @type {Array} - * @memberof LearningResourceRunRequest - */ - 'prices'?: Array | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'checksum'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof LearningResourceRunRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof LearningResourceRunRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof LearningResourceRunRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof LearningResourceRunRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof LearningResourceRunRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof LearningResourceRunRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof LearningResourceRunRequest + */ + level: Array + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + run_id: string + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + title: string + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof LearningResourceRunRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof LearningResourceRunRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + url?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + slug?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + semester?: string | null + /** + * + * @type {number} + * @memberof LearningResourceRunRequest + */ + year?: number | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + start_date?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + end_date?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + enrollment_start?: string | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + enrollment_end?: string | null + /** + * + * @type {Array} + * @memberof LearningResourceRunRequest + */ + prices?: Array | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + checksum?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof LearningResourceRunRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + location?: string + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof LearningResourceRunRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof LearningResourceRunRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof LearningResourceRunRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof LearningResourceRunRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof LearningResourceRunRequest + */ + max_weekly_hours?: number | null } - /** * Serializer for LearningResourceSchool model, including list of departments * @export * @interface LearningResourceSchool */ export interface LearningResourceSchool { - /** - * - * @type {number} - * @memberof LearningResourceSchool - */ - 'id': number; - /** - * - * @type {string} - * @memberof LearningResourceSchool - */ - 'name': string; - /** - * - * @type {string} - * @memberof LearningResourceSchool - */ - 'url': string; - /** - * - * @type {Array} - * @memberof LearningResourceSchool - */ - 'departments': Array; + /** + * + * @type {number} + * @memberof LearningResourceSchool + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceSchool + */ + name: string + /** + * + * @type {string} + * @memberof LearningResourceSchool + */ + url: string + /** + * + * @type {Array} + * @memberof LearningResourceSchool + */ + departments: Array } /** * Minimal serializer for LearningResource - returns only essential fields for sitemap generation and other use cases requiring minimal data transfer. @@ -4820,30 +4847,30 @@ export interface LearningResourceSchool { * @interface LearningResourceSummary */ export interface LearningResourceSummary { - /** - * - * @type {number} - * @memberof LearningResourceSummary - */ - 'id': number; - /** - * - * @type {string} - * @memberof LearningResourceSummary - */ - 'last_modified'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceSummary - */ - 'url'?: string | null; - /** - * - * @type {string} - * @memberof LearningResourceSummary - */ - 'title': string; + /** + * + * @type {number} + * @memberof LearningResourceSummary + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceSummary + */ + last_modified?: string | null + /** + * + * @type {string} + * @memberof LearningResourceSummary + */ + url?: string | null + /** + * + * @type {string} + * @memberof LearningResourceSummary + */ + title: string } /** * Serializer for LearningResourceTopic model @@ -4851,36 +4878,36 @@ export interface LearningResourceSummary { * @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; + /** + * + * @type {number} + * @memberof LearningResourceTopic + */ + id: number + /** + * + * @type {string} + * @memberof LearningResourceTopic + */ + name: string + /** + * The icon to display for the topic. + * @type {string} + * @memberof LearningResourceTopic + */ + icon?: string + /** + * + * @type {number} + * @memberof LearningResourceTopic + */ + parent?: number | null + /** + * + * @type {string} + * @memberof LearningResourceTopic + */ + channel_url: string | null } /** * SearchResponseSerializer with OpenAPI annotations for Learning Resources search @@ -4888,36 +4915,36 @@ export interface LearningResourceTopic { * @interface LearningResourcesSearchResponse */ export interface LearningResourcesSearchResponse { - /** - * - * @type {number} - * @memberof LearningResourcesSearchResponse - */ - 'count': number; - /** - * - * @type {string} - * @memberof LearningResourcesSearchResponse - */ - 'next': string | null; - /** - * - * @type {string} - * @memberof LearningResourcesSearchResponse - */ - 'previous': string | null; - /** - * - * @type {Array} - * @memberof LearningResourcesSearchResponse - */ - 'results': Array; - /** - * - * @type {ContentFileSearchResponseMetadata} - * @memberof LearningResourcesSearchResponse - */ - 'metadata': ContentFileSearchResponseMetadata; + /** + * + * @type {number} + * @memberof LearningResourcesSearchResponse + */ + count: number + /** + * + * @type {string} + * @memberof LearningResourcesSearchResponse + */ + next: string | null + /** + * + * @type {string} + * @memberof LearningResourcesSearchResponse + */ + previous: string | null + /** + * + * @type {Array} + * @memberof LearningResourcesSearchResponse + */ + results: Array + /** + * + * @type {ContentFileSearchResponseMetadata} + * @memberof LearningResourcesSearchResponse + */ + metadata: ContentFileSearchResponseMetadata } /** * * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory @@ -4926,51 +4953,50 @@ export interface LearningResourcesSearchResponse { */ export const LevelEnum = { - /** - * Undergraduate - */ - Undergraduate: 'undergraduate', - /** - * Graduate - */ - Graduate: 'graduate', - /** - * High School - */ - HighSchool: 'high_school', - /** - * Non-Credit - */ - Noncredit: 'noncredit', - /** - * Advanced - */ - Advanced: 'advanced', - /** - * Intermediate - */ - Intermediate: 'intermediate', - /** - * Introductory - */ - Introductory: 'introductory' -} as const; - -export type LevelEnum = typeof LevelEnum[keyof typeof LevelEnum]; - + /** + * Undergraduate + */ + Undergraduate: "undergraduate", + /** + * Graduate + */ + Graduate: "graduate", + /** + * High School + */ + HighSchool: "high_school", + /** + * Non-Credit + */ + Noncredit: "noncredit", + /** + * Advanced + */ + Advanced: "advanced", + /** + * Intermediate + */ + Intermediate: "intermediate", + /** + * Introductory + */ + Introductory: "introductory", +} as const + +export type LevelEnum = (typeof LevelEnum)[keyof typeof LevelEnum] /** - * + * * @export * @interface MediaUpload201Response */ export interface MediaUpload201Response { - /** - * - * @type {string} - * @memberof MediaUpload201Response - */ - 'url'?: string; + /** + * + * @type {string} + * @memberof MediaUpload201Response + */ + url?: string } /** * Serializer containing only parent and child ids for a learning path relationship @@ -4978,24 +5004,24 @@ export interface MediaUpload201Response { * @interface MicroLearningPathRelationship */ export interface MicroLearningPathRelationship { - /** - * - * @type {number} - * @memberof MicroLearningPathRelationship - */ - 'id': number; - /** - * The id of the parent learning resource - * @type {number} - * @memberof MicroLearningPathRelationship - */ - 'parent': number; - /** - * - * @type {number} - * @memberof MicroLearningPathRelationship - */ - 'child': number; + /** + * + * @type {number} + * @memberof MicroLearningPathRelationship + */ + id: number + /** + * The id of the parent learning resource + * @type {number} + * @memberof MicroLearningPathRelationship + */ + parent: number + /** + * + * @type {number} + * @memberof MicroLearningPathRelationship + */ + child: number } /** * Serializer containing only parent and child ids for a user list relationship @@ -5003,37 +5029,36 @@ export interface MicroLearningPathRelationship { * @interface MicroUserListRelationship */ export interface MicroUserListRelationship { - /** - * - * @type {number} - * @memberof MicroUserListRelationship - */ - 'id': number; - /** - * The id of the parent learning resource - * @type {number} - * @memberof MicroUserListRelationship - */ - 'parent': number; - /** - * - * @type {number} - * @memberof MicroUserListRelationship - */ - 'child': number; + /** + * + * @type {number} + * @memberof MicroUserListRelationship + */ + id: number + /** + * The id of the parent learning resource + * @type {number} + * @memberof MicroUserListRelationship + */ + parent: number + /** + * + * @type {number} + * @memberof MicroUserListRelationship + */ + child: number } /** - * + * * @export * @enum {string} */ export const NullEnum = { - Null: 'null' -} as const; - -export type NullEnum = typeof NullEnum[keyof typeof NullEnum]; + Null: "null", +} as const +export type NullEnum = (typeof NullEnum)[keyof typeof NullEnum] /** * Serializer for OVS video webhook requests. Accepts either an OVS video upsert payload (full result dict from the OVS public videos API; `key` is required) or a delete payload (`video_id` plus `delete: true`). @@ -5041,24 +5066,24 @@ export type NullEnum = typeof NullEnum[keyof typeof NullEnum]; * @interface OVSVideoWebhookRequestRequest */ export interface OVSVideoWebhookRequestRequest { - /** - * - * @type {string} - * @memberof OVSVideoWebhookRequestRequest - */ - 'key'?: string; - /** - * - * @type {string} - * @memberof OVSVideoWebhookRequestRequest - */ - 'video_id'?: string; - /** - * - * @type {boolean} - * @memberof OVSVideoWebhookRequestRequest - */ - 'delete'?: boolean; + /** + * + * @type {string} + * @memberof OVSVideoWebhookRequestRequest + */ + key?: string + /** + * + * @type {string} + * @memberof OVSVideoWebhookRequestRequest + */ + video_id?: string + /** + * + * @type {boolean} + * @memberof OVSVideoWebhookRequestRequest + */ + delete?: boolean } /** * * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate @@ -5067,720 +5092,719 @@ export interface OVSVideoWebhookRequestRequest { */ export const OfferedByEnum = { - /** - * MITx - */ - Mitx: 'mitx', - /** - * MIT OpenCourseWare - */ - Ocw: 'ocw', - /** - * Bootcamps - */ - Bootcamps: 'bootcamps', - /** - * MIT xPRO - */ - Xpro: 'xpro', - /** - * MIT Professional Education - */ - Mitpe: 'mitpe', - /** - * MIT Sloan Executive Education - */ - See: 'see', - /** - * MIT Climate - */ - Climate: 'climate' -} as const; - -export type OfferedByEnum = typeof OfferedByEnum[keyof typeof OfferedByEnum]; - + /** + * MITx + */ + Mitx: "mitx", + /** + * MIT OpenCourseWare + */ + Ocw: "ocw", + /** + * Bootcamps + */ + Bootcamps: "bootcamps", + /** + * MIT xPRO + */ + Xpro: "xpro", + /** + * MIT Professional Education + */ + Mitpe: "mitpe", + /** + * MIT Sloan Executive Education + */ + See: "see", + /** + * MIT Climate + */ + Climate: "climate", +} as const + +export type OfferedByEnum = (typeof OfferedByEnum)[keyof typeof OfferedByEnum] /** - * + * * @export * @interface PaginatedContentFileList */ export interface PaginatedContentFileList { - /** - * - * @type {number} - * @memberof PaginatedContentFileList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedContentFileList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedContentFileList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedContentFileList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedContentFileList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedContentFileList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedContentFileList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedContentFileList + */ + results: Array } /** - * + * * @export * @interface PaginatedCourseResourceList */ export interface PaginatedCourseResourceList { - /** - * - * @type {number} - * @memberof PaginatedCourseResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedCourseResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedCourseResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedCourseResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedCourseResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedCourseResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedCourseResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedCourseResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningPathRelationshipList */ export interface PaginatedLearningPathRelationshipList { - /** - * - * @type {number} - * @memberof PaginatedLearningPathRelationshipList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningPathRelationshipList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningPathRelationshipList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningPathRelationshipList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningPathRelationshipList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningPathRelationshipList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningPathRelationshipList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningPathRelationshipList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningPathResourceList */ export interface PaginatedLearningPathResourceList { - /** - * - * @type {number} - * @memberof PaginatedLearningPathResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningPathResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningPathResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningPathResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningPathResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningPathResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningPathResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningPathResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceContentTagList */ export interface PaginatedLearningResourceContentTagList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceContentTagList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceContentTagList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceContentTagList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceContentTagList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceContentTagList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceContentTagList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceContentTagList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceContentTagList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceDepartmentList */ export interface PaginatedLearningResourceDepartmentList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceDepartmentList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceDepartmentList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceDepartmentList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceDepartmentList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceDepartmentList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceDepartmentList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceDepartmentList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceDepartmentList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceDisplayInfoResponseList */ export interface PaginatedLearningResourceDisplayInfoResponseList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceDisplayInfoResponseList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceDisplayInfoResponseList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceDisplayInfoResponseList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceDisplayInfoResponseList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceDisplayInfoResponseList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceDisplayInfoResponseList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceDisplayInfoResponseList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceDisplayInfoResponseList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceList */ export interface PaginatedLearningResourceList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceOfferorDetailList */ export interface PaginatedLearningResourceOfferorDetailList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceOfferorDetailList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceOfferorDetailList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceOfferorDetailList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceOfferorDetailList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceOfferorDetailList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceOfferorDetailList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceOfferorDetailList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceOfferorDetailList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourcePlatformList */ export interface PaginatedLearningResourcePlatformList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourcePlatformList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourcePlatformList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourcePlatformList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourcePlatformList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourcePlatformList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourcePlatformList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourcePlatformList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourcePlatformList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceRelationshipList */ export interface PaginatedLearningResourceRelationshipList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceRelationshipList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceRelationshipList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceRelationshipList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceRelationshipList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceRelationshipList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceRelationshipList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceRelationshipList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceRelationshipList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceSchoolList */ export interface PaginatedLearningResourceSchoolList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceSchoolList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceSchoolList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceSchoolList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceSchoolList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceSchoolList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceSchoolList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceSchoolList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceSchoolList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceSummaryList */ export interface PaginatedLearningResourceSummaryList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceSummaryList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceSummaryList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceSummaryList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceSummaryList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceSummaryList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceSummaryList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceSummaryList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceSummaryList + */ + results: Array } /** - * + * * @export * @interface PaginatedLearningResourceTopicList */ export interface PaginatedLearningResourceTopicList { - /** - * - * @type {number} - * @memberof PaginatedLearningResourceTopicList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceTopicList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedLearningResourceTopicList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedLearningResourceTopicList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedLearningResourceTopicList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedLearningResourceTopicList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedLearningResourceTopicList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedLearningResourceTopicList + */ + results: Array } /** - * + * * @export * @interface PaginatedPodcastEpisodeResourceList */ export interface PaginatedPodcastEpisodeResourceList { - /** - * - * @type {number} - * @memberof PaginatedPodcastEpisodeResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedPodcastEpisodeResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedPodcastEpisodeResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedPodcastEpisodeResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedPodcastEpisodeResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedPodcastEpisodeResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedPodcastEpisodeResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedPodcastEpisodeResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedPodcastResourceList */ export interface PaginatedPodcastResourceList { - /** - * - * @type {number} - * @memberof PaginatedPodcastResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedPodcastResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedPodcastResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedPodcastResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedPodcastResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedPodcastResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedPodcastResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedPodcastResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedProgramResourceList */ export interface PaginatedProgramResourceList { - /** - * - * @type {number} - * @memberof PaginatedProgramResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedProgramResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedProgramResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedProgramResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedProgramResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedProgramResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedProgramResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedProgramResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedUserListList */ export interface PaginatedUserListList { - /** - * - * @type {number} - * @memberof PaginatedUserListList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedUserListList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedUserListList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedUserListList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedUserListList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedUserListList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedUserListList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedUserListList + */ + results: Array } /** - * + * * @export * @interface PaginatedUserListRelationshipList */ export interface PaginatedUserListRelationshipList { - /** - * - * @type {number} - * @memberof PaginatedUserListRelationshipList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedUserListRelationshipList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedUserListRelationshipList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedUserListRelationshipList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedUserListRelationshipList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedUserListRelationshipList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedUserListRelationshipList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedUserListRelationshipList + */ + results: Array } /** - * + * * @export * @interface PaginatedVideoPlaylistResourceList */ export interface PaginatedVideoPlaylistResourceList { - /** - * - * @type {number} - * @memberof PaginatedVideoPlaylistResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedVideoPlaylistResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedVideoPlaylistResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedVideoPlaylistResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedVideoPlaylistResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedVideoPlaylistResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedVideoPlaylistResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedVideoPlaylistResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedVideoResourceList */ export interface PaginatedVideoResourceList { - /** - * - * @type {number} - * @memberof PaginatedVideoResourceList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedVideoResourceList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedVideoResourceList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedVideoResourceList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedVideoResourceList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedVideoResourceList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedVideoResourceList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedVideoResourceList + */ + results: Array } /** - * + * * @export * @interface PaginatedWebsiteContentList */ export interface PaginatedWebsiteContentList { - /** - * - * @type {number} - * @memberof PaginatedWebsiteContentList - */ - 'count': number; - /** - * - * @type {string} - * @memberof PaginatedWebsiteContentList - */ - 'next'?: string | null; - /** - * - * @type {string} - * @memberof PaginatedWebsiteContentList - */ - 'previous'?: string | null; - /** - * - * @type {Array} - * @memberof PaginatedWebsiteContentList - */ - 'results': Array; + /** + * + * @type {number} + * @memberof PaginatedWebsiteContentList + */ + count: number + /** + * + * @type {string} + * @memberof PaginatedWebsiteContentList + */ + next?: string | null + /** + * + * @type {string} + * @memberof PaginatedWebsiteContentList + */ + previous?: string | null + /** + * + * @type {Array} + * @memberof PaginatedWebsiteContentList + */ + results: Array } /** * Create serializer for nested learning path items. The parent is derived from the nested route and must not be client-supplied. @@ -5788,18 +5812,18 @@ export interface PaginatedWebsiteContentList { * @interface PatchedLearningPathRelationshipCreateRequest */ export interface PatchedLearningPathRelationshipCreateRequest { - /** - * - * @type {number} - * @memberof PatchedLearningPathRelationshipCreateRequest - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof PatchedLearningPathRelationshipCreateRequest - */ - 'child'?: number; + /** + * + * @type {number} + * @memberof PatchedLearningPathRelationshipCreateRequest + */ + position?: number + /** + * + * @type {number} + * @memberof PatchedLearningPathRelationshipCreateRequest + */ + child?: number } /** * CRUD serializer for LearningPath resources @@ -5807,198 +5831,196 @@ export interface PatchedLearningPathRelationshipCreateRequest { * @interface PatchedLearningPathResourceRequest */ export interface PatchedLearningPathResourceRequest { - /** - * - * @type {Array} - * @memberof PatchedLearningPathResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof PatchedLearningPathResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof PatchedLearningPathResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof PatchedLearningPathResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof PatchedLearningPathResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof PatchedLearningPathResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof PatchedLearningPathResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof PatchedLearningPathResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof PatchedLearningPathResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof PatchedLearningPathResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof PatchedLearningPathResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof PatchedLearningPathResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof PatchedLearningPathResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof PatchedLearningPathResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + title?: string + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof PatchedLearningPathResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof PatchedLearningPathResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof PatchedLearningPathResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof PatchedLearningPathResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof PatchedLearningPathResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof PatchedLearningPathResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof PatchedLearningPathResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof PatchedLearningPathResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof PatchedLearningPathResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof PatchedLearningPathResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof PatchedLearningPathResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof PatchedLearningPathResourceRequest + */ + max_weekly_hours?: number | null } - /** * CRUD serializer for LearningResourceRelationship * @export * @interface PatchedLearningResourceRelationshipRequest */ export interface PatchedLearningResourceRelationshipRequest { - /** - * - * @type {number} - * @memberof PatchedLearningResourceRelationshipRequest - */ - 'position'?: number; - /** - * - * @type {RelationTypeEnum} - * @memberof PatchedLearningResourceRelationshipRequest - */ - 'relation_type'?: RelationTypeEnum; - /** - * - * @type {number} - * @memberof PatchedLearningResourceRelationshipRequest - */ - 'parent'?: number; - /** - * - * @type {number} - * @memberof PatchedLearningResourceRelationshipRequest - */ - 'child'?: number; + /** + * + * @type {number} + * @memberof PatchedLearningResourceRelationshipRequest + */ + position?: number + /** + * + * @type {RelationTypeEnum} + * @memberof PatchedLearningResourceRelationshipRequest + */ + relation_type?: RelationTypeEnum + /** + * + * @type {number} + * @memberof PatchedLearningResourceRelationshipRequest + */ + parent?: number + /** + * + * @type {number} + * @memberof PatchedLearningResourceRelationshipRequest + */ + child?: number } - /** * Serializer for UserListRelationship model * @export * @interface PatchedUserListRelationshipRequest */ export interface PatchedUserListRelationshipRequest { - /** - * - * @type {number} - * @memberof PatchedUserListRelationshipRequest - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof PatchedUserListRelationshipRequest - */ - 'parent'?: number; - /** - * - * @type {number} - * @memberof PatchedUserListRelationshipRequest - */ - 'child'?: number; + /** + * + * @type {number} + * @memberof PatchedUserListRelationshipRequest + */ + position?: number + /** + * + * @type {number} + * @memberof PatchedUserListRelationshipRequest + */ + parent?: number + /** + * + * @type {number} + * @memberof PatchedUserListRelationshipRequest + */ + child?: number } /** * Simplified serializer for UserList model. @@ -6006,318 +6028,314 @@ export interface PatchedUserListRelationshipRequest { * @interface PatchedUserListRequest */ export interface PatchedUserListRequest { - /** - * - * @type {Array} - * @memberof PatchedUserListRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof PatchedUserListRequest - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof PatchedUserListRequest - */ - 'description'?: string; - /** - * - * @type {PrivacyLevelEnum} - * @memberof PatchedUserListRequest - */ - 'privacy_level'?: PrivacyLevelEnum; + /** + * + * @type {Array} + * @memberof PatchedUserListRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof PatchedUserListRequest + */ + title?: string + /** + * + * @type {string} + * @memberof PatchedUserListRequest + */ + description?: string + /** + * + * @type {PrivacyLevelEnum} + * @memberof PatchedUserListRequest + */ + privacy_level?: PrivacyLevelEnum } - /** * Serializer for WebsiteContent model. * @export * @interface PatchedWebsiteContentRequest */ export interface PatchedWebsiteContentRequest { - /** - * - * @type {string} - * @memberof PatchedWebsiteContentRequest - */ - 'title'?: string; - /** - * - * @type {string} - * @memberof PatchedWebsiteContentRequest - */ - 'author_name'?: string; - /** - * - * @type {any} - * @memberof PatchedWebsiteContentRequest - */ - 'content'?: any; - /** - * - * @type {WebsiteContentContentTypeEnum} - * @memberof PatchedWebsiteContentRequest - */ - 'content_type'?: WebsiteContentContentTypeEnum; - /** - * - * @type {boolean} - * @memberof PatchedWebsiteContentRequest - */ - 'is_published'?: boolean; - /** - * - * @type {string} - * @memberof PatchedWebsiteContentRequest - */ - 'slug'?: string; + /** + * + * @type {string} + * @memberof PatchedWebsiteContentRequest + */ + title?: string + /** + * + * @type {string} + * @memberof PatchedWebsiteContentRequest + */ + author_name?: string + /** + * + * @type {any} + * @memberof PatchedWebsiteContentRequest + */ + content?: any + /** + * + * @type {WebsiteContentContentTypeEnum} + * @memberof PatchedWebsiteContentRequest + */ + content_type?: WebsiteContentContentTypeEnum + /** + * + * @type {boolean} + * @memberof PatchedWebsiteContentRequest + */ + is_published?: boolean + /** + * + * @type {string} + * @memberof PatchedWebsiteContentRequest + */ + slug?: string } - /** * Serializer for PercolateQuery objects * @export * @interface PercolateQuery */ export interface PercolateQuery { - /** - * - * @type {number} - * @memberof PercolateQuery - */ - 'id': number; - /** - * - * @type {string} - * @memberof PercolateQuery - */ - 'source_description': string; - /** - * - * @type {string} - * @memberof PercolateQuery - */ - 'source_label': string; - /** - * - * @type {any} - * @memberof PercolateQuery - */ - 'original_query': any; - /** - * - * @type {any} - * @memberof PercolateQuery - */ - 'query': any; - /** - * - * @type {SourceTypeEnum} - * @memberof PercolateQuery - */ - 'source_type': SourceTypeEnum; - /** - * Friendly display label for the query - * @type {string} - * @memberof PercolateQuery - */ - 'display_label'?: string; + /** + * + * @type {number} + * @memberof PercolateQuery + */ + id: number + /** + * + * @type {string} + * @memberof PercolateQuery + */ + source_description: string + /** + * + * @type {string} + * @memberof PercolateQuery + */ + source_label: string + /** + * + * @type {any} + * @memberof PercolateQuery + */ + original_query: any + /** + * + * @type {any} + * @memberof PercolateQuery + */ + query: any + /** + * + * @type {SourceTypeEnum} + * @memberof PercolateQuery + */ + source_type: SourceTypeEnum + /** + * Friendly display label for the query + * @type {string} + * @memberof PercolateQuery + */ + display_label?: string } - /** * PercolateQuerySubscriptionRequestSerializer with OpenAPI annotations for Percolate Subscription requests * @export * @interface PercolateQuerySubscriptionRequestRequest */ export interface PercolateQuerySubscriptionRequestRequest { - /** - * The search text - * @type {string} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'q'?: string; - /** - * The initial index from which to return the results - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'offset'?: number; - /** - * Number of results to return per page - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'limit'?: number; - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'offered_by'?: Array; - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'platform'?: Array; - /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'topic'?: Array; - /** - * The ocw topic name. - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'ocw_topic'?: Array; - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'dev_mode'?: boolean | null; - /** - * The id value for the learning resource - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'id'?: Array; - /** - * - * @type {SortbyEnum} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'sortby'?: SortbyEnum; - /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'resource_type'?: Array; - /** - * - * @type {boolean} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'free'?: boolean | null; - /** - * - * @type {boolean} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'professional'?: boolean | null; - /** - * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'yearly_decay_percent'?: number | null; - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'certification'?: boolean | null; - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'certification_type'?: Array; - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'department'?: Array; - /** - * - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'level'?: Array; - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'course_feature'?: Array; - /** - * Show resource counts by category - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'aggregations'?: Array; - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'delivery'?: Array; - /** - * - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'resource_type_group'?: Array; - /** - * The resource category for the resource - * @type {Array} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'resource_category'?: Array; - /** - * - * @type {SearchModeEnum} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'search_mode'?: SearchModeEnum; - /** - * Allowed distance for phrase search - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'slop'?: number | null; - /** - * Minimum score value a text query result needs to have to be displayed - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'min_score'?: number | null; - /** - * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'max_incompleteness_penalty'?: number | null; - /** - * Score weight for content file data. 1 is the default. 0 means content files are ignored - * @type {number} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'content_file_score_weight'?: number | null; - /** - * Whether to include select OCW content files in search results. - * @type {boolean} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'show_ocw_files'?: boolean | null; - /** - * - * @type {SourceTypeEnum} - * @memberof PercolateQuerySubscriptionRequestRequest - */ - 'source_type'?: SourceTypeEnum; + /** + * The search text + * @type {string} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + q?: string + /** + * The initial index from which to return the results + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + offset?: number + /** + * Number of results to return per page + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + limit?: number + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + offered_by?: Array + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + platform?: Array + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + topic?: Array + /** + * The ocw topic name. + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + ocw_topic?: Array + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + dev_mode?: boolean | null + /** + * The id value for the learning resource + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + id?: Array + /** + * + * @type {SortbyEnum} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + sortby?: SortbyEnum + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + resource_type?: Array + /** + * + * @type {boolean} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + free?: boolean | null + /** + * + * @type {boolean} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + professional?: boolean | null + /** + * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + yearly_decay_percent?: number | null + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + certification?: boolean | null + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + certification_type?: Array + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + department?: Array + /** + * + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + level?: Array + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + course_feature?: Array + /** + * Show resource counts by category + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + aggregations?: Array + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + delivery?: Array + /** + * + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + resource_type_group?: Array + /** + * The resource category for the resource + * @type {Array} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + resource_category?: Array + /** + * + * @type {SearchModeEnum} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + search_mode?: SearchModeEnum + /** + * Allowed distance for phrase search + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + slop?: number | null + /** + * Minimum score value a text query result needs to have to be displayed + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + min_score?: number | null + /** + * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + max_incompleteness_penalty?: number | null + /** + * Score weight for content file data. 1 is the default. 0 means content files are ignored + * @type {number} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + content_file_score_weight?: number | null + /** + * Whether to include select OCW content files in search results. + * @type {boolean} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + show_ocw_files?: boolean | null + /** + * + * @type {SourceTypeEnum} + * @memberof PercolateQuerySubscriptionRequestRequest + */ + source_type?: SourceTypeEnum } - /** * * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document * @export @@ -6325,42 +6343,42 @@ export interface PercolateQuerySubscriptionRequestRequest { */ export const PercolateQuerySubscriptionRequestResourceTypeEnum = { - /** - * course - */ - Course: 'course', - /** - * program - */ - Program: 'program', - /** - * learning path - */ - LearningPath: 'learning_path', - /** - * podcast - */ - Podcast: 'podcast', - /** - * podcast episode - */ - PodcastEpisode: 'podcast_episode', - /** - * video - */ - Video: 'video', - /** - * video playlist - */ - VideoPlaylist: 'video_playlist', - /** - * document - */ - Document: 'document' -} as const; - -export type PercolateQuerySubscriptionRequestResourceTypeEnum = typeof PercolateQuerySubscriptionRequestResourceTypeEnum[keyof typeof PercolateQuerySubscriptionRequestResourceTypeEnum]; - + /** + * course + */ + Course: "course", + /** + * program + */ + Program: "program", + /** + * learning path + */ + LearningPath: "learning_path", + /** + * podcast + */ + Podcast: "podcast", + /** + * podcast episode + */ + PodcastEpisode: "podcast_episode", + /** + * video + */ + Video: "video", + /** + * video playlist + */ + VideoPlaylist: "video_playlist", + /** + * document + */ + Document: "document", +} as const + +export type PercolateQuerySubscriptionRequestResourceTypeEnum = + (typeof PercolateQuerySubscriptionRequestResourceTypeEnum)[keyof typeof PercolateQuerySubscriptionRequestResourceTypeEnum] /** * * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service @@ -6369,94 +6387,93 @@ export type PercolateQuerySubscriptionRequestResourceTypeEnum = typeof Percolate */ export const PlatformEnum = { - /** - * edX - */ - Edx: 'edx', - /** - * MIT OpenCourseWare - */ - Ocw: 'ocw', - /** - * Open Learning Library - */ - Oll: 'oll', - /** - * MITx Online - */ - Mitxonline: 'mitxonline', - /** - * Bootcamps - */ - Bootcamps: 'bootcamps', - /** - * MIT xPRO - */ - Xpro: 'xpro', - /** - * CSAIL - */ - Csail: 'csail', - /** - * MIT Professional Education - */ - Mitpe: 'mitpe', - /** - * MIT Sloan Executive Education - */ - See: 'see', - /** - * Schwarzman College of Computing - */ - Scc: 'scc', - /** - * Center for Transportation & Logistics - */ - Ctl: 'ctl', - /** - * WHU - */ - Whu: 'whu', - /** - * Susskind - */ - Susskind: 'susskind', - /** - * Global Alumni - */ - Globalalumni: 'globalalumni', - /** - * Simplilearn - */ - Simplilearn: 'simplilearn', - /** - * Emeritus - */ - Emeritus: 'emeritus', - /** - * Podcast - */ - Podcast: 'podcast', - /** - * YouTube - */ - Youtube: 'youtube', - /** - * Canvas - */ - Canvas: 'canvas', - /** - * MIT Climate - */ - Climate: 'climate', - /** - * ODL Video Service - */ - Ovs: 'ovs' -} as const; - -export type PlatformEnum = typeof PlatformEnum[keyof typeof PlatformEnum]; - + /** + * edX + */ + Edx: "edx", + /** + * MIT OpenCourseWare + */ + Ocw: "ocw", + /** + * Open Learning Library + */ + Oll: "oll", + /** + * MITx Online + */ + Mitxonline: "mitxonline", + /** + * Bootcamps + */ + Bootcamps: "bootcamps", + /** + * MIT xPRO + */ + Xpro: "xpro", + /** + * CSAIL + */ + Csail: "csail", + /** + * MIT Professional Education + */ + Mitpe: "mitpe", + /** + * MIT Sloan Executive Education + */ + See: "see", + /** + * Schwarzman College of Computing + */ + Scc: "scc", + /** + * Center for Transportation & Logistics + */ + Ctl: "ctl", + /** + * WHU + */ + Whu: "whu", + /** + * Susskind + */ + Susskind: "susskind", + /** + * Global Alumni + */ + Globalalumni: "globalalumni", + /** + * Simplilearn + */ + Simplilearn: "simplilearn", + /** + * Emeritus + */ + Emeritus: "emeritus", + /** + * Podcast + */ + Podcast: "podcast", + /** + * YouTube + */ + Youtube: "youtube", + /** + * Canvas + */ + Canvas: "canvas", + /** + * MIT Climate + */ + Climate: "climate", + /** + * ODL Video Service + */ + Ovs: "ovs", +} as const + +export type PlatformEnum = (typeof PlatformEnum)[keyof typeof PlatformEnum] /** * Serializer for Podcasts @@ -6464,36 +6481,36 @@ export type PlatformEnum = typeof PlatformEnum[keyof typeof PlatformEnum]; * @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; + /** + * + * @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 @@ -6501,48 +6518,48 @@ export interface Podcast { * @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; + /** + * + * @type {number} + * @memberof PodcastEpisode + */ + id: number + /** + * Get the podcast id(s) the episode belongs to + * @type {Array} + * @memberof PodcastEpisode + */ + podcasts: Array + /** + * + * @type {string} + * @memberof PodcastEpisode + */ + transcript?: string + /** + * + * @type {string} + * @memberof PodcastEpisode + */ + audio_url: string + /** + * + * @type {string} + * @memberof PodcastEpisode + */ + episode_link?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisode + */ + duration?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisode + */ + rss?: string | null } /** * Serializer for PodcastEpisode @@ -6550,36 +6567,36 @@ export interface PodcastEpisode { * @interface PodcastEpisodeRequest */ export interface PodcastEpisodeRequest { - /** - * - * @type {string} - * @memberof PodcastEpisodeRequest - */ - 'transcript'?: string; - /** - * - * @type {string} - * @memberof PodcastEpisodeRequest - */ - 'audio_url': string; - /** - * - * @type {string} - * @memberof PodcastEpisodeRequest - */ - 'episode_link'?: string | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeRequest - */ - 'duration'?: string | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeRequest - */ - 'rss'?: string | null; + /** + * + * @type {string} + * @memberof PodcastEpisodeRequest + */ + transcript?: string + /** + * + * @type {string} + * @memberof PodcastEpisodeRequest + */ + audio_url: string + /** + * + * @type {string} + * @memberof PodcastEpisodeRequest + */ + episode_link?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeRequest + */ + duration?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeRequest + */ + rss?: string | null } /** * Serializer for podcast episode resources @@ -6587,450 +6604,448 @@ export interface PodcastEpisodeRequest { * @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; + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + id: number + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof PodcastEpisodeResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof PodcastEpisodeResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof PodcastEpisodeResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof PodcastEpisodeResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + views: number + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof PodcastEpisodeResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + format: Array + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof PodcastEpisodeResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof PodcastEpisodeResource + */ + best_run_id: number | null + /** + * + * @type {PodcastEpisodeResourceResourceTypeEnum} + * @memberof PodcastEpisodeResource + */ + resource_type: PodcastEpisodeResourceResourceTypeEnum + /** + * + * @type {PodcastEpisode} + * @memberof PodcastEpisodeResource + */ + podcast_episode: PodcastEpisode + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + title: string + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + description?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof PodcastEpisodeResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof PodcastEpisodeResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof PodcastEpisodeResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + location?: string + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + duration?: string + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResource + */ + require_summaries: boolean } - /** * Serializer for podcast episode resources * @export * @interface PodcastEpisodeResourceRequest */ export interface PodcastEpisodeResourceRequest { - /** - * - * @type {Array} - * @memberof PodcastEpisodeResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof PodcastEpisodeResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof PodcastEpisodeResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof PodcastEpisodeResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof PodcastEpisodeResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof PodcastEpisodeResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof PodcastEpisodeResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof PodcastEpisodeResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof PodcastEpisodeResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof PodcastEpisodeResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof PodcastEpisodeResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof PodcastEpisodeResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof PodcastEpisodeResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof PodcastEpisodeResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof PodcastEpisodeResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof PodcastEpisodeResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof PodcastEpisodeResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof PodcastEpisodeResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof PodcastEpisodeResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof PodcastEpisodeResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof PodcastEpisodeResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof PodcastEpisodeResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const PodcastEpisodeResourceResourceTypeEnum = { - PodcastEpisode: 'podcast_episode' -} as const; - -export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResourceResourceTypeEnum[keyof typeof PodcastEpisodeResourceResourceTypeEnum]; + PodcastEpisode: "podcast_episode", +} as const +export type PodcastEpisodeResourceResourceTypeEnum = + (typeof PodcastEpisodeResourceResourceTypeEnum)[keyof typeof PodcastEpisodeResourceResourceTypeEnum] /** * Serializer for Podcasts @@ -7038,30 +7053,30 @@ export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResour * @interface PodcastRequest */ export interface PodcastRequest { - /** - * - * @type {number} - * @memberof PodcastRequest - */ - 'episode_count': number; - /** - * - * @type {string} - * @memberof PodcastRequest - */ - 'apple_podcasts_url'?: string | null; - /** - * - * @type {string} - * @memberof PodcastRequest - */ - 'google_podcasts_url'?: string | null; - /** - * - * @type {string} - * @memberof PodcastRequest - */ - 'rss_url'?: string | null; + /** + * + * @type {number} + * @memberof PodcastRequest + */ + episode_count: number + /** + * + * @type {string} + * @memberof PodcastRequest + */ + apple_podcasts_url?: string | null + /** + * + * @type {string} + * @memberof PodcastRequest + */ + google_podcasts_url?: string | null + /** + * + * @type {string} + * @memberof PodcastRequest + */ + rss_url?: string | null } /** * Serializer for podcast resources @@ -7069,450 +7084,448 @@ export interface PodcastRequest { * @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; + /** + * + * @type {number} + * @memberof PodcastResource + */ + id: number + /** + * + * @type {Array} + * @memberof PodcastResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof PodcastResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof PodcastResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof PodcastResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof PodcastResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof PodcastResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof PodcastResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof PodcastResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof PodcastResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof PodcastResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof PodcastResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof PodcastResource + */ + views: number + /** + * + * @type {Array} + * @memberof PodcastResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof PodcastResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof PodcastResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof PodcastResource + */ + format: Array + /** + * + * @type {Array} + * @memberof PodcastResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof PodcastResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof PodcastResource + */ + best_run_id: number | null + /** + * + * @type {PodcastResourceResourceTypeEnum} + * @memberof PodcastResource + */ + resource_type: PodcastResourceResourceTypeEnum + /** + * + * @type {Podcast} + * @memberof PodcastResource + */ + podcast: Podcast + /** + * + * @type {string} + * @memberof PodcastResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof PodcastResource + */ + title: string + /** + * + * @type {string} + * @memberof PodcastResource + */ + description?: string | null + /** + * + * @type {string} + * @memberof PodcastResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof PodcastResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof PodcastResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof PodcastResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof PodcastResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof PodcastResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof PodcastResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof PodcastResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof PodcastResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof PodcastResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof PodcastResource + */ + location?: string + /** + * + * @type {string} + * @memberof PodcastResource + */ + duration?: string + /** + * + * @type {number} + * @memberof PodcastResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof PodcastResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof PodcastResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof PodcastResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof PodcastResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof PodcastResource + */ + require_summaries: boolean } - /** * Serializer for podcast resources * @export * @interface PodcastResourceRequest */ export interface PodcastResourceRequest { - /** - * - * @type {Array} - * @memberof PodcastResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof PodcastResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof PodcastResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof PodcastResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof PodcastResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof PodcastResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof PodcastResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof PodcastResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof PodcastResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof PodcastResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof PodcastResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof PodcastResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof PodcastResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof PodcastResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof PodcastResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof PodcastResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof PodcastResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof PodcastResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof PodcastResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof PodcastResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof PodcastResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof PodcastResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof PodcastResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof PodcastResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof PodcastResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof PodcastResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const PodcastResourceResourceTypeEnum = { - Podcast: 'podcast' -} as const; - -export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceTypeEnum[keyof typeof PodcastResourceResourceTypeEnum]; + Podcast: "podcast", +} as const +export type PodcastResourceResourceTypeEnum = + (typeof PodcastResourceResourceTypeEnum)[keyof typeof PodcastResourceResourceTypeEnum] /** * * `private` - private * `unlisted` - unlisted @@ -7521,18 +7534,18 @@ export type PodcastResourceResourceTypeEnum = typeof PodcastResourceResourceType */ export const PrivacyLevelEnum = { - /** - * private - */ - Private: 'private', - /** - * unlisted - */ - Unlisted: 'unlisted' -} as const; - -export type PrivacyLevelEnum = typeof PrivacyLevelEnum[keyof typeof PrivacyLevelEnum]; + /** + * private + */ + Private: "private", + /** + * unlisted + */ + Unlisted: "unlisted", +} as const +export type PrivacyLevelEnum = + (typeof PrivacyLevelEnum)[keyof typeof PrivacyLevelEnum] /** * Serializer for the Program model @@ -7540,18 +7553,18 @@ export type PrivacyLevelEnum = typeof PrivacyLevelEnum[keyof typeof PrivacyLevel * @interface Program */ export interface Program { - /** - * - * @type {number} - * @memberof Program - */ - 'course_count': number; - /** - * - * @type {number} - * @memberof Program - */ - 'program_count': number; + /** + * + * @type {number} + * @memberof Program + */ + course_count: number + /** + * + * @type {number} + * @memberof Program + */ + program_count: number } /** * Serializer for Program Certificates @@ -7559,132 +7572,132 @@ export interface Program { * @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; + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + record_hash: string + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + program_letter_generate_url: string + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + program_letter_share_url: string + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + program_title: string + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_full_name?: string + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_email: string + /** + * + * @type {number} + * @memberof ProgramCertificate + */ + user_edxorg_id?: number | null + /** + * + * @type {number} + * @memberof ProgramCertificate + */ + micromasters_program_id?: number | null + /** + * + * @type {number} + * @memberof ProgramCertificate + */ + mitxonline_program_id?: number | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_edxorg_username?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_gender?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_address_city?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_first_name?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_last_name?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_year_of_birth?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_country?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_address_postal_code?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_street_address?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_address_state_or_territory?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + user_mitxonline_username?: string | null + /** + * + * @type {string} + * @memberof ProgramCertificate + */ + program_completion_timestamp?: string | null } /** * Serializer for Program Letters @@ -7692,24 +7705,24 @@ export interface ProgramCertificate { * @interface ProgramLetter */ export interface ProgramLetter { - /** - * - * @type {string} - * @memberof ProgramLetter - */ - 'id': string; - /** - * - * @type {ProgramLetterTemplateField} - * @memberof ProgramLetter - */ - 'template_fields': ProgramLetterTemplateField; - /** - * - * @type {ProgramCertificate} - * @memberof ProgramLetter - */ - 'certificate': ProgramCertificate; + /** + * + * @type {string} + * @memberof ProgramLetter + */ + id: string + /** + * + * @type {ProgramLetterTemplateField} + * @memberof ProgramLetter + */ + template_fields: ProgramLetterTemplateField + /** + * + * @type {ProgramCertificate} + * @memberof ProgramLetter + */ + certificate: ProgramCertificate } /** * Seriializer for program letter template data which is configured in micromasters @@ -7717,66 +7730,66 @@ export interface ProgramLetter { * @interface ProgramLetterTemplateField */ export interface ProgramLetterTemplateField { - /** - * - * @type {number} - * @memberof ProgramLetterTemplateField - */ - 'id': number; - /** - * - * @type {any} - * @memberof ProgramLetterTemplateField - */ - 'meta': any; - /** - * - * @type {string} - * @memberof ProgramLetterTemplateField - */ - 'title': string; - /** - * - * @type {number} - * @memberof ProgramLetterTemplateField - */ - 'program_id': number; - /** - * - * @type {any} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_footer': any; - /** - * - * @type {string} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_footer_text': string; - /** - * - * @type {string} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_header_text': string; - /** - * - * @type {string} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_text': string; - /** - * - * @type {any} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_logo': any; - /** - * - * @type {Array} - * @memberof ProgramLetterTemplateField - */ - 'program_letter_signatories': Array; + /** + * + * @type {number} + * @memberof ProgramLetterTemplateField + */ + id: number + /** + * + * @type {any} + * @memberof ProgramLetterTemplateField + */ + meta: any + /** + * + * @type {string} + * @memberof ProgramLetterTemplateField + */ + title: string + /** + * + * @type {number} + * @memberof ProgramLetterTemplateField + */ + program_id: number + /** + * + * @type {any} + * @memberof ProgramLetterTemplateField + */ + program_letter_footer: any + /** + * + * @type {string} + * @memberof ProgramLetterTemplateField + */ + program_letter_footer_text: string + /** + * + * @type {string} + * @memberof ProgramLetterTemplateField + */ + program_letter_header_text: string + /** + * + * @type {string} + * @memberof ProgramLetterTemplateField + */ + program_letter_text: string + /** + * + * @type {any} + * @memberof ProgramLetterTemplateField + */ + program_letter_logo: any + /** + * + * @type {Array} + * @memberof ProgramLetterTemplateField + */ + program_letter_signatories: Array } /** * Serializer for program resources @@ -7784,450 +7797,448 @@ export interface ProgramLetterTemplateField { * @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; + /** + * + * @type {number} + * @memberof ProgramResource + */ + id: number + /** + * + * @type {Array} + * @memberof ProgramResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof ProgramResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof ProgramResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof ProgramResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof ProgramResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof ProgramResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof ProgramResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof ProgramResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof ProgramResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof ProgramResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof ProgramResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof ProgramResource + */ + views: number + /** + * + * @type {Array} + * @memberof ProgramResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof ProgramResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof ProgramResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof ProgramResource + */ + format: Array + /** + * + * @type {Array} + * @memberof ProgramResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof ProgramResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof ProgramResource + */ + best_run_id: number | null + /** + * + * @type {ProgramResourceResourceTypeEnum} + * @memberof ProgramResource + */ + resource_type: ProgramResourceResourceTypeEnum + /** + * + * @type {Program} + * @memberof ProgramResource + */ + program: Program + /** + * + * @type {string} + * @memberof ProgramResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof ProgramResource + */ + title: string + /** + * + * @type {string} + * @memberof ProgramResource + */ + description?: string | null + /** + * + * @type {string} + * @memberof ProgramResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof ProgramResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof ProgramResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof ProgramResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof ProgramResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof ProgramResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof ProgramResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof ProgramResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof ProgramResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof ProgramResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof ProgramResource + */ + location?: string + /** + * + * @type {string} + * @memberof ProgramResource + */ + duration?: string + /** + * + * @type {number} + * @memberof ProgramResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof ProgramResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof ProgramResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof ProgramResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof ProgramResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof ProgramResource + */ + require_summaries: boolean } - /** * Serializer for program resources * @export * @interface ProgramResourceRequest */ export interface ProgramResourceRequest { - /** - * - * @type {Array} - * @memberof ProgramResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof ProgramResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof ProgramResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof ProgramResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof ProgramResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof ProgramResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof ProgramResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof ProgramResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof ProgramResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof ProgramResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof ProgramResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof ProgramResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof ProgramResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof ProgramResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof ProgramResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof ProgramResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof ProgramResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof ProgramResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof ProgramResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof ProgramResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof ProgramResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof ProgramResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof ProgramResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof ProgramResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof ProgramResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof ProgramResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const ProgramResourceResourceTypeEnum = { - Program: 'program' -} as const; - -export type ProgramResourceResourceTypeEnum = typeof ProgramResourceResourceTypeEnum[keyof typeof ProgramResourceResourceTypeEnum]; + Program: "program", +} as const +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 @@ -8236,34 +8247,34 @@ export type ProgramResourceResourceTypeEnum = typeof ProgramResourceResourceType */ export const RelationTypeEnum = { - /** - * Program Courses - */ - ProgramCourses: 'PROGRAM_COURSES', - /** - * Program Programs - */ - ProgramPrograms: 'PROGRAM_PROGRAMS', - /** - * Learning Path Items - */ - LearningPathItems: 'LEARNING_PATH_ITEMS', - /** - * Podcast Episodes - */ - PodcastEpisodes: 'PODCAST_EPISODES', - /** - * Playlist Videos - */ - PlaylistVideos: 'PLAYLIST_VIDEOS', - /** - * Course Learning Materials - */ - CourseLearningMaterials: 'COURSE_LEARNING_MATERIALS' -} as const; - -export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationTypeEnum]; - + /** + * Program Courses + */ + ProgramCourses: "PROGRAM_COURSES", + /** + * Program Programs + */ + ProgramPrograms: "PROGRAM_PROGRAMS", + /** + * Learning Path Items + */ + LearningPathItems: "LEARNING_PATH_ITEMS", + /** + * Podcast Episodes + */ + PodcastEpisodes: "PODCAST_EPISODES", + /** + * Playlist Videos + */ + PlaylistVideos: "PLAYLIST_VIDEOS", + /** + * Course Learning Materials + */ + CourseLearningMaterials: "COURSE_LEARNING_MATERIALS", +} as const + +export type RelationTypeEnum = + (typeof RelationTypeEnum)[keyof typeof RelationTypeEnum] /** * Serializer for child course/program entries within a program. @@ -8271,42 +8282,42 @@ export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationType * @interface ResourceChildSummary */ export interface ResourceChildSummary { - /** - * - * @type {string} - * @memberof ResourceChildSummary - */ - 'title': string; - /** - * - * @type {string} - * @memberof ResourceChildSummary - */ - 'readable_id': string; - /** - * - * @type {string} - * @memberof ResourceChildSummary - */ - 'description': string; - /** - * - * @type {string} - * @memberof ResourceChildSummary - */ - 'resource_type': string; - /** - * - * @type {Array} - * @memberof ResourceChildSummary - */ - 'topics': Array; - /** - * - * @type {string} - * @memberof ResourceChildSummary - */ - 'parent_program'?: string; + /** + * + * @type {string} + * @memberof ResourceChildSummary + */ + title: string + /** + * + * @type {string} + * @memberof ResourceChildSummary + */ + readable_id: string + /** + * + * @type {string} + * @memberof ResourceChildSummary + */ + description: string + /** + * + * @type {string} + * @memberof ResourceChildSummary + */ + resource_type: string + /** + * + * @type {Array} + * @memberof ResourceChildSummary + */ + topics: Array + /** + * + * @type {string} + * @memberof ResourceChildSummary + */ + parent_program?: string } /** * * `course` - course * `program` - program * `learning_path` - learning_path * `podcast` - podcast * `podcast_episode` - podcast_episode * `video` - video * `video_playlist` - video_playlist * `document` - document @@ -8315,42 +8326,42 @@ export interface ResourceChildSummary { */ export const ResourceTypeEnum = { - /** - * course - */ - Course: 'course', - /** - * program - */ - Program: 'program', - /** - * learning_path - */ - LearningPath: 'learning_path', - /** - * podcast - */ - Podcast: 'podcast', - /** - * podcast_episode - */ - PodcastEpisode: 'podcast_episode', - /** - * video - */ - Video: 'video', - /** - * video_playlist - */ - VideoPlaylist: 'video_playlist', - /** - * document - */ - Document: 'document' -} as const; - -export type ResourceTypeEnum = typeof ResourceTypeEnum[keyof typeof ResourceTypeEnum]; - + /** + * course + */ + Course: "course", + /** + * program + */ + Program: "program", + /** + * learning_path + */ + LearningPath: "learning_path", + /** + * podcast + */ + Podcast: "podcast", + /** + * podcast_episode + */ + PodcastEpisode: "podcast_episode", + /** + * video + */ + Video: "video", + /** + * video_playlist + */ + VideoPlaylist: "video_playlist", + /** + * document + */ + Document: "document", +} as const + +export type ResourceTypeEnum = + (typeof ResourceTypeEnum)[keyof typeof ResourceTypeEnum] /** * * `course` - Course * `program` - Program * `learning_material` - Learning Material @@ -8359,22 +8370,22 @@ export type ResourceTypeEnum = typeof ResourceTypeEnum[keyof typeof ResourceType */ export const ResourceTypeGroupEnum = { - /** - * Course - */ - Course: 'course', - /** - * Program - */ - Program: 'program', - /** - * Learning Material - */ - LearningMaterial: 'learning_material' -} as const; - -export type ResourceTypeGroupEnum = typeof ResourceTypeGroupEnum[keyof typeof ResourceTypeGroupEnum]; - + /** + * Course + */ + Course: "course", + /** + * Program + */ + Program: "program", + /** + * Learning Material + */ + LearningMaterial: "learning_material", +} as const + +export type ResourceTypeGroupEnum = + (typeof ResourceTypeGroupEnum)[keyof typeof ResourceTypeGroupEnum] /** * * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid @@ -8383,26 +8394,26 @@ export type ResourceTypeGroupEnum = typeof ResourceTypeGroupEnum[keyof typeof Re */ export const SearchModeEnum = { - /** - * phrase - */ - Phrase: 'phrase', - /** - * best_fields - */ - BestFields: 'best_fields', - /** - * most_fields - */ - MostFields: 'most_fields', - /** - * hybrid - */ - Hybrid: 'hybrid' -} as const; - -export type SearchModeEnum = typeof SearchModeEnum[keyof typeof SearchModeEnum]; - + /** + * phrase + */ + Phrase: "phrase", + /** + * best_fields + */ + BestFields: "best_fields", + /** + * most_fields + */ + MostFields: "most_fields", + /** + * hybrid + */ + Hybrid: "hybrid", +} as const + +export type SearchModeEnum = + (typeof SearchModeEnum)[keyof typeof SearchModeEnum] /** * * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending @@ -8411,70 +8422,69 @@ export type SearchModeEnum = typeof SearchModeEnum[keyof typeof SearchModeEnum]; */ export const SortbyEnum = { - /** - * Featured - */ - Featured: 'featured', - /** - * Object ID ascending - */ - Id: 'id', - /** - * Object ID descending - */ - Id2: '-id', - /** - * Readable ID ascending - */ - ReadableId: 'readable_id', - /** - * Readable ID descending - */ - ReadableId2: '-readable_id', - /** - * Last Modified Date ascending - */ - LastModified: 'last_modified', - /** - * Last Modified Date descending - */ - LastModified2: '-last_modified', - /** - * Newest resources first - */ - New: 'new', - /** - * Start Date ascending - */ - StartDate: 'start_date', - /** - * Start Date descending - */ - StartDate2: '-start_date', - /** - * MIT course number ascending - */ - Mitcoursenumber: 'mitcoursenumber', - /** - * MIT course number descending - */ - Mitcoursenumber2: '-mitcoursenumber', - /** - * Popularity ascending - */ - Views: 'views', - /** - * Popularity descending - */ - Views2: '-views', - /** - * Next start date ascending - */ - Upcoming: 'upcoming' -} as const; - -export type SortbyEnum = typeof SortbyEnum[keyof typeof SortbyEnum]; - + /** + * Featured + */ + Featured: "featured", + /** + * Object ID ascending + */ + Id: "id", + /** + * Object ID descending + */ + Id2: "-id", + /** + * Readable ID ascending + */ + ReadableId: "readable_id", + /** + * Readable ID descending + */ + ReadableId2: "-readable_id", + /** + * Last Modified Date ascending + */ + LastModified: "last_modified", + /** + * Last Modified Date descending + */ + LastModified2: "-last_modified", + /** + * Newest resources first + */ + New: "new", + /** + * Start Date ascending + */ + StartDate: "start_date", + /** + * Start Date descending + */ + StartDate2: "-start_date", + /** + * MIT course number ascending + */ + Mitcoursenumber: "mitcoursenumber", + /** + * MIT course number descending + */ + Mitcoursenumber2: "-mitcoursenumber", + /** + * Popularity ascending + */ + Views: "views", + /** + * Popularity descending + */ + Views2: "-views", + /** + * Next start date ascending + */ + Upcoming: "upcoming", +} as const + +export type SortbyEnum = (typeof SortbyEnum)[keyof typeof SortbyEnum] /** * * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs @@ -8483,62 +8493,61 @@ export type SortbyEnum = typeof SortbyEnum[keyof typeof SortbyEnum]; */ export const SourceEnum = { - /** - * micromasters - */ - Micromasters: 'micromasters', - /** - * mit_edx - */ - MitEdx: 'mit_edx', - /** - * mitpe - */ - Mitpe: 'mitpe', - /** - * mitxonline - */ - Mitxonline: 'mitxonline', - /** - * oll - */ - Oll: 'oll', - /** - * ocw - */ - Ocw: 'ocw', - /** - * podcast - */ - Podcast: 'podcast', - /** - * mit_climate - */ - MitClimate: 'mit_climate', - /** - * see - */ - See: 'see', - /** - * xpro - */ - Xpro: 'xpro', - /** - * youtube - */ - Youtube: 'youtube', - /** - * canvas - */ - Canvas: 'canvas', - /** - * ovs - */ - Ovs: 'ovs' -} as const; - -export type SourceEnum = typeof SourceEnum[keyof typeof SourceEnum]; - + /** + * micromasters + */ + Micromasters: "micromasters", + /** + * mit_edx + */ + MitEdx: "mit_edx", + /** + * mitpe + */ + Mitpe: "mitpe", + /** + * mitxonline + */ + Mitxonline: "mitxonline", + /** + * oll + */ + Oll: "oll", + /** + * ocw + */ + Ocw: "ocw", + /** + * podcast + */ + Podcast: "podcast", + /** + * mit_climate + */ + MitClimate: "mit_climate", + /** + * see + */ + See: "see", + /** + * xpro + */ + Xpro: "xpro", + /** + * youtube + */ + Youtube: "youtube", + /** + * canvas + */ + Canvas: "canvas", + /** + * ovs + */ + Ovs: "ovs", +} as const + +export type SourceEnum = (typeof SourceEnum)[keyof typeof SourceEnum] /** * * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type @@ -8547,37 +8556,37 @@ export type SourceEnum = typeof SourceEnum[keyof typeof SourceEnum]; */ export const SourceTypeEnum = { - /** - * search_subscription_type - */ - SearchSubscriptionType: 'search_subscription_type', - /** - * channel_subscription_type - */ - ChannelSubscriptionType: 'channel_subscription_type' -} as const; - -export type SourceTypeEnum = typeof SourceTypeEnum[keyof typeof SourceTypeEnum]; + /** + * search_subscription_type + */ + SearchSubscriptionType: "search_subscription_type", + /** + * channel_subscription_type + */ + ChannelSubscriptionType: "channel_subscription_type", +} as const +export type SourceTypeEnum = + (typeof SourceTypeEnum)[keyof typeof SourceTypeEnum] /** - * + * * @export * @interface User */ export interface User { - /** - * - * @type {string} - * @memberof User - */ - 'first_name'?: string; - /** - * - * @type {string} - * @memberof User - */ - 'last_name'?: string; + /** + * + * @type {string} + * @memberof User + */ + first_name?: string + /** + * + * @type {string} + * @memberof User + */ + last_name?: string } /** * Simplified serializer for UserList model. @@ -8585,93 +8594,92 @@ export interface User { * @interface UserList */ export interface UserList { - /** - * - * @type {number} - * @memberof UserList - */ - 'id': number; - /** - * - * @type {Array} - * @memberof UserList - */ - 'topics'?: Array; - /** - * Number of published items in the list. - * @type {number} - * @memberof UserList - */ - 'item_count': number; - /** - * Return the image of the first item - * @type {{ [key: string]: any; }} - * @memberof UserList - */ - 'image': { [key: string]: any; }; - /** - * - * @type {string} - * @memberof UserList - */ - 'title': string; - /** - * - * @type {string} - * @memberof UserList - */ - 'description'?: string; - /** - * - * @type {PrivacyLevelEnum} - * @memberof UserList - */ - 'privacy_level'?: PrivacyLevelEnum; - /** - * - * @type {number} - * @memberof UserList - */ - 'author': number; + /** + * + * @type {number} + * @memberof UserList + */ + id: number + /** + * + * @type {Array} + * @memberof UserList + */ + topics?: Array + /** + * Number of published items in the list. + * @type {number} + * @memberof UserList + */ + item_count: number + /** + * Return the image of the first item + * @type {{ [key: string]: any; }} + * @memberof UserList + */ + image: { [key: string]: any } + /** + * + * @type {string} + * @memberof UserList + */ + title: string + /** + * + * @type {string} + * @memberof UserList + */ + description?: string + /** + * + * @type {PrivacyLevelEnum} + * @memberof UserList + */ + privacy_level?: PrivacyLevelEnum + /** + * + * @type {number} + * @memberof UserList + */ + author: number } - /** * Serializer for UserListRelationship model * @export * @interface UserListRelationship */ export interface UserListRelationship { - /** - * - * @type {number} - * @memberof UserListRelationship - */ - 'id': number; - /** - * - * @type {LearningResource} - * @memberof UserListRelationship - */ - 'resource': LearningResource; - /** - * - * @type {number} - * @memberof UserListRelationship - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof UserListRelationship - */ - 'parent': number; - /** - * - * @type {number} - * @memberof UserListRelationship - */ - 'child': number; + /** + * + * @type {number} + * @memberof UserListRelationship + */ + id: number + /** + * + * @type {LearningResource} + * @memberof UserListRelationship + */ + resource: LearningResource + /** + * + * @type {number} + * @memberof UserListRelationship + */ + position?: number + /** + * + * @type {number} + * @memberof UserListRelationship + */ + parent: number + /** + * + * @type {number} + * @memberof UserListRelationship + */ + child: number } /** * Serializer for UserListRelationship model @@ -8679,24 +8687,24 @@ export interface UserListRelationship { * @interface UserListRelationshipRequest */ export interface UserListRelationshipRequest { - /** - * - * @type {number} - * @memberof UserListRelationshipRequest - */ - 'position'?: number; - /** - * - * @type {number} - * @memberof UserListRelationshipRequest - */ - 'parent': number; - /** - * - * @type {number} - * @memberof UserListRelationshipRequest - */ - 'child': number; + /** + * + * @type {number} + * @memberof UserListRelationshipRequest + */ + position?: number + /** + * + * @type {number} + * @memberof UserListRelationshipRequest + */ + parent: number + /** + * + * @type {number} + * @memberof UserListRelationshipRequest + */ + child: number } /** * Simplified serializer for UserList model. @@ -8704,51 +8712,50 @@ export interface UserListRelationshipRequest { * @interface UserListRequest */ export interface UserListRequest { - /** - * - * @type {Array} - * @memberof UserListRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof UserListRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof UserListRequest - */ - 'description'?: string; - /** - * - * @type {PrivacyLevelEnum} - * @memberof UserListRequest - */ - 'privacy_level'?: PrivacyLevelEnum; + /** + * + * @type {Array} + * @memberof UserListRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof UserListRequest + */ + title: string + /** + * + * @type {string} + * @memberof UserListRequest + */ + description?: string + /** + * + * @type {PrivacyLevelEnum} + * @memberof UserListRequest + */ + privacy_level?: PrivacyLevelEnum } - /** - * + * * @export * @interface UserRequest */ export interface UserRequest { - /** - * - * @type {string} - * @memberof UserRequest - */ - 'first_name'?: string; - /** - * - * @type {string} - * @memberof UserRequest - */ - 'last_name'?: string; + /** + * + * @type {string} + * @memberof UserRequest + */ + first_name?: string + /** + * + * @type {string} + * @memberof UserRequest + */ + last_name?: string } /** * Serializer for the Video model @@ -8756,36 +8763,36 @@ export interface UserRequest { * @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; + /** + * + * @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 @@ -8793,18 +8800,18 @@ export interface Video { * @interface VideoChannel */ export interface VideoChannel { - /** - * - * @type {string} - * @memberof VideoChannel - */ - 'channel_id': string; - /** - * - * @type {string} - * @memberof VideoChannel - */ - 'title': string; + /** + * + * @type {string} + * @memberof VideoChannel + */ + channel_id: string + /** + * + * @type {string} + * @memberof VideoChannel + */ + title: string } /** * Serializer for the VideoChannel model @@ -8812,18 +8819,18 @@ export interface VideoChannel { * @interface VideoChannelRequest */ export interface VideoChannelRequest { - /** - * - * @type {string} - * @memberof VideoChannelRequest - */ - 'channel_id': string; - /** - * - * @type {string} - * @memberof VideoChannelRequest - */ - 'title': string; + /** + * + * @type {string} + * @memberof VideoChannelRequest + */ + channel_id: string + /** + * + * @type {string} + * @memberof VideoChannelRequest + */ + title: string } /** * Serializer for the VideoPlaylist model @@ -8831,48 +8838,48 @@ export interface VideoChannelRequest { * @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; - /** - * - * @type {number} - * @memberof VideoPlaylist - */ - 'parent_learning_resource_id': number | null; - /** - * - * @type {string} - * @memberof VideoPlaylist - */ - 'parent_title': string | null; - /** - * - * @type {string} - * @memberof VideoPlaylist - */ - 'parent_url': string | null; - /** - * Extract the course number(s) from the parent course, if any - * @type {Array} - * @memberof VideoPlaylist - */ - 'parent_course_numbers': Array; + /** + * + * @type {number} + * @memberof VideoPlaylist + */ + id: number + /** + * + * @type {VideoChannel} + * @memberof VideoPlaylist + */ + channel: VideoChannel | null + /** + * + * @type {number} + * @memberof VideoPlaylist + */ + video_count: number + /** + * + * @type {number} + * @memberof VideoPlaylist + */ + parent_learning_resource_id: number | null + /** + * + * @type {string} + * @memberof VideoPlaylist + */ + parent_title: string | null + /** + * + * @type {string} + * @memberof VideoPlaylist + */ + parent_url: string | null + /** + * Extract the course number(s) from the parent course, if any + * @type {Array} + * @memberof VideoPlaylist + */ + parent_course_numbers: Array } /** * Serializer for the VideoPlaylist model @@ -8880,12 +8887,12 @@ export interface VideoPlaylist { * @interface VideoPlaylistRequest */ export interface VideoPlaylistRequest { - /** - * - * @type {number} - * @memberof VideoPlaylistRequest - */ - 'video_count': number; + /** + * + * @type {number} + * @memberof VideoPlaylistRequest + */ + video_count: number } /** * Serializer for video playlist resources @@ -8893,450 +8900,448 @@ export interface VideoPlaylistRequest { * @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; + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + id: number + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof VideoPlaylistResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof VideoPlaylistResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof VideoPlaylistResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof VideoPlaylistResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + views: number + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof VideoPlaylistResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof VideoPlaylistResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + format: Array + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof VideoPlaylistResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof VideoPlaylistResource + */ + best_run_id: number | null + /** + * + * @type {VideoPlaylistResourceResourceTypeEnum} + * @memberof VideoPlaylistResource + */ + resource_type: VideoPlaylistResourceResourceTypeEnum + /** + * + * @type {VideoPlaylist} + * @memberof VideoPlaylistResource + */ + video_playlist: VideoPlaylist + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + title: string + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + description?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof VideoPlaylistResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof VideoPlaylistResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof VideoPlaylistResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + location?: string + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + duration?: string + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof VideoPlaylistResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof VideoPlaylistResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof VideoPlaylistResource + */ + require_summaries: boolean } - /** * Serializer for video playlist resources * @export * @interface VideoPlaylistResourceRequest */ export interface VideoPlaylistResourceRequest { - /** - * - * @type {Array} - * @memberof VideoPlaylistResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'description'?: string | null; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof VideoPlaylistResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof VideoPlaylistResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof VideoPlaylistResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof VideoPlaylistResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof VideoPlaylistResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof VideoPlaylistResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof VideoPlaylistResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'location'?: string; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'duration'?: string; - /** - * - * @type {number} - * @memberof VideoPlaylistResourceRequest - */ - 'min_weeks'?: number | null; - /** - * - * @type {number} - * @memberof VideoPlaylistResourceRequest - */ - 'max_weeks'?: number | null; - /** - * - * @type {string} - * @memberof VideoPlaylistResourceRequest - */ - 'time_commitment'?: string; - /** - * - * @type {number} - * @memberof VideoPlaylistResourceRequest - */ - 'min_weekly_hours'?: number | null; - /** - * - * @type {number} - * @memberof VideoPlaylistResourceRequest - */ - 'max_weekly_hours'?: number | null; + /** + * + * @type {Array} + * @memberof VideoPlaylistResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + description?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof VideoPlaylistResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof VideoPlaylistResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof VideoPlaylistResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof VideoPlaylistResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof VideoPlaylistResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof VideoPlaylistResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof VideoPlaylistResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof VideoPlaylistResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof VideoPlaylistResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof VideoPlaylistResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof VideoPlaylistResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof VideoPlaylistResourceRequest + */ + max_weekly_hours?: number | null } - /** - * + * * @export * @enum {string} */ export const VideoPlaylistResourceResourceTypeEnum = { - VideoPlaylist: 'video_playlist' -} as const; - -export type VideoPlaylistResourceResourceTypeEnum = typeof VideoPlaylistResourceResourceTypeEnum[keyof typeof VideoPlaylistResourceResourceTypeEnum]; + VideoPlaylist: "video_playlist", +} as const +export type VideoPlaylistResourceResourceTypeEnum = + (typeof VideoPlaylistResourceResourceTypeEnum)[keyof typeof VideoPlaylistResourceResourceTypeEnum] /** * Serializer for the Video model @@ -9344,12 +9349,12 @@ export type VideoPlaylistResourceResourceTypeEnum = typeof VideoPlaylistResource * @interface VideoRequest */ export interface VideoRequest { - /** - * - * @type {string} - * @memberof VideoRequest - */ - 'duration': string; + /** + * + * @type {string} + * @memberof VideoRequest + */ + duration: string } /** * Serializer for video resources @@ -9357,2641 +9362,3541 @@ export interface VideoRequest { * @interface VideoResource */ export interface VideoResource { + /** + * + * @type {number} + * @memberof VideoResource + */ + id: number + /** + * + * @type {Array} + * @memberof VideoResource + */ + topics?: Array + /** + * + * @type {number} + * @memberof VideoResource + */ + position: number | null + /** + * + * @type {LearningResourceOfferor} + * @memberof VideoResource + */ + offered_by: LearningResourceOfferor | null + /** + * + * @type {LearningResourcePlatform} + * @memberof VideoResource + */ + platform: LearningResourcePlatform | null + /** + * + * @type {Array} + * @memberof VideoResource + */ + course_feature: Array | null + /** + * + * @type {Array} + * @memberof VideoResource + */ + departments: Array | null + /** + * + * @type {boolean} + * @memberof VideoResource + */ + certification: boolean + /** + * + * @type {CourseResourceCertificationType} + * @memberof VideoResource + */ + certification_type: CourseResourceCertificationType + /** + * + * @type {Array} + * @memberof VideoResource + */ + prices: Array + /** + * + * @type {Array} + * @memberof VideoResource + */ + resource_prices: Array + /** + * + * @type {Array} + * @memberof VideoResource + */ + runs: Array | null + /** + * + * @type {LearningResourceImage} + * @memberof VideoResource + */ + image: LearningResourceImage | null + /** + * + * @type {number} + * @memberof VideoResource + */ + views: number + /** + * + * @type {Array} + * @memberof VideoResource + */ + delivery: Array + /** + * Return true if the resource is free/has a free option + * @type {boolean} + * @memberof VideoResource + */ + free: boolean + /** + * + * @type {ResourceTypeGroupEnum} + * @memberof VideoResource + */ + resource_type_group: ResourceTypeGroupEnum + /** + * + * @type {Array} + * @memberof VideoResource + */ + format: Array + /** + * + * @type {Array} + * @memberof VideoResource + */ + pace: Array + /** + * + * @type {LearningResourceRelationshipChildField} + * @memberof VideoResource + */ + children: LearningResourceRelationshipChildField | null + /** + * Return the best run id for the resource, if it has runs + * @type {number} + * @memberof VideoResource + */ + best_run_id: number | null + /** + * + * @type {VideoResourceResourceTypeEnum} + * @memberof VideoResource + */ + resource_type: VideoResourceResourceTypeEnum + /** + * + * @type {Video} + * @memberof VideoResource + */ + video: Video | null + /** + * Get the playlist id(s) the video belongs to + * @type {Array} + * @memberof VideoResource + */ + playlists: Array + /** + * + * @type {Array} + * @memberof VideoResource + */ + content_files: Array | null + /** + * + * @type {string} + * @memberof VideoResource + */ + description: string | null + /** + * + * @type {string} + * @memberof VideoResource + */ + readable_id: string + /** + * + * @type {string} + * @memberof VideoResource + */ + title: string + /** + * + * @type {string} + * @memberof VideoResource + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof VideoResource + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof VideoResource + */ + published?: boolean + /** + * + * @type {Array} + * @memberof VideoResource + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof VideoResource + */ + url?: string | null + /** + * The display category for this resource. + * @type {string} + * @memberof VideoResource + */ + resource_category: string + /** + * + * @type {Array} + * @memberof VideoResource + */ + ocw_topics?: Array + /** + * + * @type {boolean} + * @memberof VideoResource + */ + professional: boolean + /** + * + * @type {string} + * @memberof VideoResource + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof VideoResource + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof VideoResource + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof VideoResource + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof VideoResource + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof VideoResource + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof VideoResource + */ + location?: string + /** + * + * @type {string} + * @memberof VideoResource + */ + duration?: string + /** + * + * @type {number} + * @memberof VideoResource + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof VideoResource + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof VideoResource + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof VideoResource + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof VideoResource + */ + max_weekly_hours?: number | null + /** + * + * @type {boolean} + * @memberof VideoResource + */ + require_summaries: boolean +} + +/** + * Serializer for video resources + * @export + * @interface VideoResourceRequest + */ +export interface VideoResourceRequest { + /** + * + * @type {Array} + * @memberof VideoResourceRequest + */ + topics?: Array + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + title: string + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + full_description?: string | null + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + last_modified?: string | null + /** + * + * @type {boolean} + * @memberof VideoResourceRequest + */ + published?: boolean + /** + * + * @type {Array} + * @memberof VideoResourceRequest + */ + languages?: Array | null + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + url?: string | null + /** + * + * @type {Array} + * @memberof VideoResourceRequest + */ + ocw_topics?: Array + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + next_start_date?: string | null + /** + * + * @type {AvailabilityEnum} + * @memberof VideoResourceRequest + */ + availability?: AvailabilityEnum | null + /** + * + * @type {number} + * @memberof VideoResourceRequest + */ + completeness?: number + /** + * + * @type {boolean} + * @memberof VideoResourceRequest + */ + license_cc?: boolean + /** + * + * @type {boolean} + * @memberof VideoResourceRequest + */ + test_mode?: boolean + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + continuing_ed_credits?: string | null + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + location?: string + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + duration?: string + /** + * + * @type {number} + * @memberof VideoResourceRequest + */ + min_weeks?: number | null + /** + * + * @type {number} + * @memberof VideoResourceRequest + */ + max_weeks?: number | null + /** + * + * @type {string} + * @memberof VideoResourceRequest + */ + time_commitment?: string + /** + * + * @type {number} + * @memberof VideoResourceRequest + */ + min_weekly_hours?: number | null + /** + * + * @type {number} + * @memberof VideoResourceRequest + */ + max_weekly_hours?: number | null +} + +/** + * + * @export + * @enum {string} + */ + +export const VideoResourceResourceTypeEnum = { + Video: "video", +} as const + +export type VideoResourceResourceTypeEnum = + (typeof VideoResourceResourceTypeEnum)[keyof typeof VideoResourceResourceTypeEnum] + +/** + * Serializer for webhook responses. + * @export + * @interface WebhookResponse + */ +export interface WebhookResponse { + /** + * + * @type {string} + * @memberof WebhookResponse + */ + status: string + /** + * + * @type {string} + * @memberof WebhookResponse + */ + message?: string + /** + * + * @type {string} + * @memberof WebhookResponse + */ + error?: string +} +/** + * Serializer for WebsiteContent model. + * @export + * @interface WebsiteContent + */ +export interface WebsiteContent { + /** + * + * @type {number} + * @memberof WebsiteContent + */ + id: number + /** + * + * @type {string} + * @memberof WebsiteContent + */ + title: string + /** + * + * @type {string} + * @memberof WebsiteContent + */ + author_name?: string + /** + * + * @type {any} + * @memberof WebsiteContent + */ + content?: any + /** + * + * @type {WebsiteContentContentTypeEnum} + * @memberof WebsiteContent + */ + content_type?: WebsiteContentContentTypeEnum + /** + * + * @type {User} + * @memberof WebsiteContent + */ + user: User + /** + * + * @type {string} + * @memberof WebsiteContent + */ + created_on: string + /** + * + * @type {string} + * @memberof WebsiteContent + */ + updated_on: string + /** + * + * @type {string} + * @memberof WebsiteContent + */ + publish_date: string + /** + * + * @type {boolean} + * @memberof WebsiteContent + */ + is_published?: boolean + /** + * + * @type {string} + * @memberof WebsiteContent + */ + slug?: string + /** + * + * @type {string} + * @memberof WebsiteContent + */ + cover_image: string +} + +/** + * * `news` - News * `article` - Article + * @export + * @enum {string} + */ + +export const WebsiteContentContentTypeEnum = { + /** + * News + */ + News: "news", + /** + * Article + */ + Article: "article", +} as const + +export type WebsiteContentContentTypeEnum = + (typeof WebsiteContentContentTypeEnum)[keyof typeof WebsiteContentContentTypeEnum] + +/** + * Serializer for WebsiteContent model. + * @export + * @interface WebsiteContentRequest + */ +export interface WebsiteContentRequest { + /** + * + * @type {string} + * @memberof WebsiteContentRequest + */ + title: string + /** + * + * @type {string} + * @memberof WebsiteContentRequest + */ + author_name?: string + /** + * + * @type {any} + * @memberof WebsiteContentRequest + */ + content?: any + /** + * + * @type {WebsiteContentContentTypeEnum} + * @memberof WebsiteContentRequest + */ + content_type?: WebsiteContentContentTypeEnum + /** + * + * @type {boolean} + * @memberof WebsiteContentRequest + */ + is_published?: boolean + /** + * + * @type {string} + * @memberof WebsiteContentRequest + */ + slug?: string +} + +/** + * ArticlesApi - axios parameter creator + * @export + */ +export const ArticlesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {number} - * @memberof VideoResource - */ - 'id': number; - /** - * - * @type {Array} - * @memberof VideoResource + * Create a new content item + * @summary Create + * @param {WebsiteContentRequest} WebsiteContentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'topics'?: Array; + articlesCreate: async ( + WebsiteContentRequest: WebsiteContentRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'WebsiteContentRequest' is not null or undefined + assertParamExists( + "articlesCreate", + "WebsiteContentRequest", + WebsiteContentRequest, + ) + const localVarPath = `/api/v1/articles/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + WebsiteContentRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {number} - * @memberof VideoResource + * Delete a content item + * @summary Destroy + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'position': number | null; + articlesDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("articlesDestroy", "id", id) + const localVarPath = `/api/v1/articles/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {LearningResourceOfferor} - * @memberof VideoResource + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {string} identifier Numeric ID or slug of the content item + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'offered_by': LearningResourceOfferor | null; + articlesDetailRetrieve: async ( + identifier: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'identifier' is not null or undefined + assertParamExists("articlesDetailRetrieve", "identifier", identifier) + const localVarPath = `/api/v1/articles/detail/{identifier}/`.replace( + `{${"identifier"}}`, + encodeURIComponent(String(identifier)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {LearningResourcePlatform} - * @memberof VideoResource + * Get a paginated list of website content items + * @summary List + * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article + * @param {boolean} [draft] Filter to show only draft (unpublished) items + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'platform': LearningResourcePlatform | null; + articlesList: async ( + content_type?: ArticlesListContentTypeEnum, + draft?: boolean, + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/articles/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_type !== undefined) { + localVarQueryParameter["content_type"] = content_type + } + + if (draft !== undefined) { + localVarQueryParameter["draft"] = draft + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {Array} - * @memberof VideoResource + * Update a content item + * @summary Update + * @param {number} id A unique integer value identifying this website content. + * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'course_feature': Array | null; + articlesPartialUpdate: async ( + id: number, + PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("articlesPartialUpdate", "id", id) + const localVarPath = `/api/v1/articles/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedWebsiteContentRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {Array} - * @memberof VideoResource + * Retrieve a single content item + * @summary Retrieve + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'departments': Array | null; + articlesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("articlesRetrieve", "id", id) + const localVarPath = `/api/v1/articles/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} + +/** + * ArticlesApi - functional programming interface + * @export + */ +export const ArticlesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = ArticlesApiAxiosParamCreator(configuration) + return { /** - * - * @type {boolean} - * @memberof VideoResource + * Create a new content item + * @summary Create + * @param {WebsiteContentRequest} WebsiteContentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'certification': boolean; + async articlesCreate( + WebsiteContentRequest: WebsiteContentRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.articlesCreate( + WebsiteContentRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {CourseResourceCertificationType} - * @memberof VideoResource + * Delete a content item + * @summary Destroy + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'certification_type': CourseResourceCertificationType; + async articlesDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.articlesDestroy( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesDestroy"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {Array} - * @memberof VideoResource + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {string} identifier Numeric ID or slug of the content item + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'prices': Array; + async articlesDetailRetrieve( + identifier: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.articlesDetailRetrieve( + identifier, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesDetailRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {Array} - * @memberof VideoResource + * Get a paginated list of website content items + * @summary List + * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article + * @param {boolean} [draft] Filter to show only draft (unpublished) items + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'resource_prices': Array; + async articlesList( + content_type?: ArticlesListContentTypeEnum, + draft?: boolean, + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.articlesList( + content_type, + draft, + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {Array} - * @memberof VideoResource + * Update a content item + * @summary Update + * @param {number} id A unique integer value identifying this website content. + * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'runs': Array | null; + async articlesPartialUpdate( + id: number, + PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.articlesPartialUpdate( + id, + PatchedWebsiteContentRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesPartialUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @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 + * Retrieve a single content item + * @summary Retrieve + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'require_summaries': boolean; + async articlesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.articlesRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ArticlesApi.articlesRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } - /** - * Serializer for video resources + * ArticlesApi - factory interface * @export - * @interface VideoResourceRequest */ -export interface VideoResourceRequest { - /** - * - * @type {Array} - * @memberof VideoResourceRequest - */ - 'topics'?: Array; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'full_description'?: string | null; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'last_modified'?: string | null; - /** - * - * @type {boolean} - * @memberof VideoResourceRequest - */ - 'published'?: boolean; - /** - * - * @type {Array} - * @memberof VideoResourceRequest - */ - 'languages'?: Array | null; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'url'?: string | null; - /** - * - * @type {Array} - * @memberof VideoResourceRequest - */ - 'ocw_topics'?: Array; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'next_start_date'?: string | null; - /** - * - * @type {AvailabilityEnum} - * @memberof VideoResourceRequest - */ - 'availability'?: AvailabilityEnum | null; - /** - * - * @type {number} - * @memberof VideoResourceRequest - */ - 'completeness'?: number; - /** - * - * @type {boolean} - * @memberof VideoResourceRequest - */ - 'license_cc'?: boolean; - /** - * - * @type {boolean} - * @memberof VideoResourceRequest - */ - 'test_mode'?: boolean; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'continuing_ed_credits'?: string | null; - /** - * - * @type {string} - * @memberof VideoResourceRequest - */ - 'location'?: string; +export const ArticlesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ArticlesApiFp(configuration) + return { /** - * - * @type {string} - * @memberof VideoResourceRequest + * Create a new content item + * @summary Create + * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'duration'?: string; + articlesCreate( + requestParameters: ArticlesApiArticlesCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesCreate(requestParameters.WebsiteContentRequest, options) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {number} - * @memberof VideoResourceRequest + * Delete a content item + * @summary Destroy + * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'min_weeks'?: number | null; + articlesDestroy( + requestParameters: ArticlesApiArticlesDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesDestroy(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {number} - * @memberof VideoResourceRequest + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'max_weeks'?: number | null; + articlesDetailRetrieve( + requestParameters: ArticlesApiArticlesDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesDetailRetrieve(requestParameters.identifier, options) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {string} - * @memberof VideoResourceRequest + * Get a paginated list of website content items + * @summary List + * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'time_commitment'?: string; + articlesList( + requestParameters: ArticlesApiArticlesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesList( + requestParameters.content_type, + requestParameters.draft, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {number} - * @memberof VideoResourceRequest + * Update a content item + * @summary Update + * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'min_weekly_hours'?: number | null; + articlesPartialUpdate( + requestParameters: ArticlesApiArticlesPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesPartialUpdate( + requestParameters.id, + requestParameters.PatchedWebsiteContentRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {number} - * @memberof VideoResourceRequest + * Retrieve a single content item + * @summary Retrieve + * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - 'max_weekly_hours'?: number | null; + articlesRetrieve( + requestParameters: ArticlesApiArticlesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .articlesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - /** - * + * Request parameters for articlesCreate operation in ArticlesApi. * @export - * @enum {string} + * @interface ArticlesApiArticlesCreateRequest */ - -export const VideoResourceResourceTypeEnum = { - Video: 'video' -} as const; - -export type VideoResourceResourceTypeEnum = typeof VideoResourceResourceTypeEnum[keyof typeof VideoResourceResourceTypeEnum]; - +export interface ArticlesApiArticlesCreateRequest { + /** + * + * @type {WebsiteContentRequest} + * @memberof ArticlesApiArticlesCreate + */ + readonly WebsiteContentRequest: WebsiteContentRequest +} /** - * Serializer for webhook responses. + * Request parameters for articlesDestroy operation in ArticlesApi. * @export - * @interface WebhookResponse + * @interface ArticlesApiArticlesDestroyRequest */ -export interface WebhookResponse { - /** - * - * @type {string} - * @memberof WebhookResponse - */ - 'status': string; - /** - * - * @type {string} - * @memberof WebhookResponse - */ - 'message'?: string; - /** - * - * @type {string} - * @memberof WebhookResponse - */ - 'error'?: string; +export interface ArticlesApiArticlesDestroyRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof ArticlesApiArticlesDestroy + */ + readonly id: number } + /** - * Serializer for WebsiteContent model. + * Request parameters for articlesDetailRetrieve operation in ArticlesApi. * @export - * @interface WebsiteContent + * @interface ArticlesApiArticlesDetailRetrieveRequest */ -export interface WebsiteContent { - /** - * - * @type {number} - * @memberof WebsiteContent - */ - 'id': number; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'title': string; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'author_name'?: string; - /** - * - * @type {any} - * @memberof WebsiteContent - */ - 'content'?: any; - /** - * - * @type {WebsiteContentContentTypeEnum} - * @memberof WebsiteContent - */ - 'content_type'?: WebsiteContentContentTypeEnum; - /** - * - * @type {User} - * @memberof WebsiteContent - */ - 'user': User; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'created_on': string; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'updated_on': string; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'publish_date': string; - /** - * - * @type {boolean} - * @memberof WebsiteContent - */ - 'is_published'?: boolean; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'slug'?: string; - /** - * - * @type {string} - * @memberof WebsiteContent - */ - 'cover_image': string; +export interface ArticlesApiArticlesDetailRetrieveRequest { + /** + * Numeric ID or slug of the content item + * @type {string} + * @memberof ArticlesApiArticlesDetailRetrieve + */ + readonly identifier: string } - /** - * * `news` - News * `article` - Article + * Request parameters for articlesList operation in ArticlesApi. * @export - * @enum {string} + * @interface ArticlesApiArticlesListRequest */ - -export const WebsiteContentContentTypeEnum = { - /** - * News - */ - News: 'news', - /** - * Article - */ - Article: 'article' -} as const; - -export type WebsiteContentContentTypeEnum = typeof WebsiteContentContentTypeEnum[keyof typeof WebsiteContentContentTypeEnum]; - +export interface ArticlesApiArticlesListRequest { + /** + * Filter by content type * `news` - News * `article` - Article + * @type {'article' | 'news'} + * @memberof ArticlesApiArticlesList + */ + readonly content_type?: ArticlesListContentTypeEnum + + /** + * Filter to show only draft (unpublished) items + * @type {boolean} + * @memberof ArticlesApiArticlesList + */ + readonly draft?: boolean + + /** + * Number of results to return per page. + * @type {number} + * @memberof ArticlesApiArticlesList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof ArticlesApiArticlesList + */ + readonly offset?: number +} /** - * Serializer for WebsiteContent model. + * Request parameters for articlesPartialUpdate operation in ArticlesApi. * @export - * @interface WebsiteContentRequest + * @interface ArticlesApiArticlesPartialUpdateRequest */ -export interface WebsiteContentRequest { - /** - * - * @type {string} - * @memberof WebsiteContentRequest - */ - 'title': string; - /** - * - * @type {string} - * @memberof WebsiteContentRequest - */ - 'author_name'?: string; - /** - * - * @type {any} - * @memberof WebsiteContentRequest - */ - 'content'?: any; - /** - * - * @type {WebsiteContentContentTypeEnum} - * @memberof WebsiteContentRequest - */ - 'content_type'?: WebsiteContentContentTypeEnum; - /** - * - * @type {boolean} - * @memberof WebsiteContentRequest - */ - 'is_published'?: boolean; - /** - * - * @type {string} - * @memberof WebsiteContentRequest - */ - 'slug'?: string; -} - +export interface ArticlesApiArticlesPartialUpdateRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof ArticlesApiArticlesPartialUpdate + */ + readonly id: number + /** + * + * @type {PatchedWebsiteContentRequest} + * @memberof ArticlesApiArticlesPartialUpdate + */ + readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest +} /** - * ArticlesApi - axios parameter creator + * Request parameters for articlesRetrieve operation in ArticlesApi. * @export + * @interface ArticlesApiArticlesRetrieveRequest */ -export const ArticlesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new content item - * @summary Create - * @param {WebsiteContentRequest} WebsiteContentRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesCreate: async (WebsiteContentRequest: WebsiteContentRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'WebsiteContentRequest' is not null or undefined - assertParamExists('articlesCreate', 'WebsiteContentRequest', WebsiteContentRequest) - const localVarPath = `/api/v1/articles/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(WebsiteContentRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Delete a content item - * @summary Destroy - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('articlesDestroy', 'id', id) - const localVarPath = `/api/v1/articles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {string} identifier Numeric ID or slug of the content item - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesDetailRetrieve: async (identifier: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identifier' is not null or undefined - assertParamExists('articlesDetailRetrieve', 'identifier', identifier) - const localVarPath = `/api/v1/articles/detail/{identifier}/` - .replace(`{${"identifier"}}`, encodeURIComponent(String(identifier))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article - * @param {boolean} [draft] Filter to show only draft (unpublished) items - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesList: async (content_type?: ArticlesListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/articles/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_type !== undefined) { - localVarQueryParameter['content_type'] = content_type; - } - - if (draft !== undefined) { - localVarQueryParameter['draft'] = draft; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Update a content item - * @summary Update - * @param {number} id A unique integer value identifying this website content. - * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesPartialUpdate: async (id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('articlesPartialUpdate', 'id', id) - const localVarPath = `/api/v1/articles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedWebsiteContentRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('articlesRetrieve', 'id', id) - const localVarPath = `/api/v1/articles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface ArticlesApiArticlesRetrieveRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof ArticlesApiArticlesRetrieve + */ + readonly id: number +} /** - * ArticlesApi - functional programming interface + * ArticlesApi - object-oriented interface * @export + * @class ArticlesApi + * @extends {BaseAPI} */ -export const ArticlesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ArticlesApiAxiosParamCreator(configuration) - return { - /** - * Create a new content item - * @summary Create - * @param {WebsiteContentRequest} WebsiteContentRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesCreate(WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesCreate(WebsiteContentRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Delete a content item - * @summary Destroy - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {string} identifier Numeric ID or slug of the content item - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesDetailRetrieve(identifier: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesDetailRetrieve(identifier, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesDetailRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {ArticlesListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article - * @param {boolean} [draft] Filter to show only draft (unpublished) items - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesList(content_type?: ArticlesListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesList(content_type, draft, limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Update a content item - * @summary Update - * @param {number} id A unique integer value identifying this website content. - * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesPartialUpdate(id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesPartialUpdate(id, PatchedWebsiteContentRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async articlesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.articlesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ArticlesApi.articlesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export class ArticlesApi extends BaseAPI { + /** + * Create a new content item + * @summary Create + * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesCreate( + requestParameters: ArticlesApiArticlesCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesCreate(requestParameters.WebsiteContentRequest, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Delete a content item + * @summary Destroy + * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesDestroy( + requestParameters: ArticlesApiArticlesDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesDestroy(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesDetailRetrieve( + requestParameters: ArticlesApiArticlesDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesDetailRetrieve(requestParameters.identifier, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of website content items + * @summary List + * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesList( + requestParameters: ArticlesApiArticlesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesList( + requestParameters.content_type, + requestParameters.draft, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Update a content item + * @summary Update + * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesPartialUpdate( + requestParameters: ArticlesApiArticlesPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesPartialUpdate( + requestParameters.id, + requestParameters.PatchedWebsiteContentRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single content item + * @summary Retrieve + * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArticlesApi + */ + public articlesRetrieve( + requestParameters: ArticlesApiArticlesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ArticlesApiFp(this.configuration) + .articlesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * ArticlesApi - factory interface * @export */ -export const ArticlesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ArticlesApiFp(configuration) - return { - /** - * Create a new content item - * @summary Create - * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesCreate(requestParameters: ArticlesApiArticlesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesCreate(requestParameters.WebsiteContentRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Delete a content item - * @summary Destroy - * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesDestroy(requestParameters: ArticlesApiArticlesDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesDetailRetrieve(requestParameters: ArticlesApiArticlesDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesDetailRetrieve(requestParameters.identifier, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesList(requestParameters: ArticlesApiArticlesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesList(requestParameters.content_type, requestParameters.draft, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Update a content item - * @summary Update - * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesPartialUpdate(requestParameters: ArticlesApiArticlesPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesPartialUpdate(requestParameters.id, requestParameters.PatchedWebsiteContentRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - articlesRetrieve(requestParameters: ArticlesApiArticlesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.articlesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const ArticlesListContentTypeEnum = { + Article: "article", + News: "news", +} as const +export type ArticlesListContentTypeEnum = + (typeof ArticlesListContentTypeEnum)[keyof typeof ArticlesListContentTypeEnum] /** - * Request parameters for articlesCreate operation in ArticlesApi. + * ContentFileSearchApi - axios parameter creator * @export - * @interface ArticlesApiArticlesCreateRequest */ -export interface ArticlesApiArticlesCreateRequest { +export const ContentFileSearchApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {WebsiteContentRequest} - * @memberof ArticlesApiArticlesCreate + * Search for content files + * @summary Search + * @param {Array} [aggregations] Show resource counts by category + * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {Array} [id] The id value for the content file + * @param {number} [limit] Number of results to return per page + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {string} [q] The search text + * @param {Array} [resource_id] The id value of the parent learning resource for the content file + * @param {Array} [run_id] The id value of the run that the content file belongs to + * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly WebsiteContentRequest: WebsiteContentRequest + contentFileSearchRetrieve: async ( + aggregations?: Array, + content_feature_type?: Array, + dev_mode?: boolean | null, + id?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + q?: string, + resource_id?: Array, + run_id?: Array, + sortby?: ContentFileSearchRetrieveSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/content_file_search/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (content_feature_type) { + localVarQueryParameter["content_feature_type"] = content_feature_type + } + + if (dev_mode !== undefined) { + localVarQueryParameter["dev_mode"] = dev_mode + } + + if (id) { + localVarQueryParameter["id"] = id + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (run_id) { + localVarQueryParameter["run_id"] = run_id + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for articlesDestroy operation in ArticlesApi. + * ContentFileSearchApi - functional programming interface * @export - * @interface ArticlesApiArticlesDestroyRequest */ -export interface ArticlesApiArticlesDestroyRequest { +export const ContentFileSearchApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + ContentFileSearchApiAxiosParamCreator(configuration) + return { /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof ArticlesApiArticlesDestroy - */ - readonly id: number + * Search for content files + * @summary Search + * @param {Array} [aggregations] Show resource counts by category + * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {Array} [id] The id value for the content file + * @param {number} [limit] Number of results to return per page + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {string} [q] The search text + * @param {Array} [resource_id] The id value of the parent learning resource for the content file + * @param {Array} [run_id] The id value of the run that the content file belongs to + * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async contentFileSearchRetrieve( + aggregations?: Array, + content_feature_type?: Array, + dev_mode?: boolean | null, + id?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + q?: string, + resource_id?: Array, + run_id?: Array, + sortby?: ContentFileSearchRetrieveSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.contentFileSearchRetrieve( + aggregations, + content_feature_type, + dev_mode, + id, + limit, + ocw_topic, + offered_by, + offset, + platform, + q, + resource_id, + run_id, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ContentFileSearchApi.contentFileSearchRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * Request parameters for articlesDetailRetrieve operation in ArticlesApi. + * ContentFileSearchApi - factory interface * @export - * @interface ArticlesApiArticlesDetailRetrieveRequest */ -export interface ArticlesApiArticlesDetailRetrieveRequest { +export const ContentFileSearchApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ContentFileSearchApiFp(configuration) + return { /** - * Numeric ID or slug of the content item - * @type {string} - * @memberof ArticlesApiArticlesDetailRetrieve + * Search for content files + * @summary Search + * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly identifier: string + contentFileSearchRetrieve( + requestParameters: ContentFileSearchApiContentFileSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .contentFileSearchRetrieve( + requestParameters.aggregations, + requestParameters.content_feature_type, + requestParameters.dev_mode, + requestParameters.id, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.q, + requestParameters.resource_id, + requestParameters.run_id, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } /** - * Request parameters for articlesList operation in ArticlesApi. + * Request parameters for contentFileSearchRetrieve operation in ContentFileSearchApi. * @export - * @interface ArticlesApiArticlesListRequest + * @interface ContentFileSearchApiContentFileSearchRetrieveRequest */ -export interface ArticlesApiArticlesListRequest { - /** - * Filter by content type * `news` - News * `article` - Article - * @type {'article' | 'news'} - * @memberof ArticlesApiArticlesList - */ - readonly content_type?: ArticlesListContentTypeEnum - - /** - * Filter to show only draft (unpublished) items - * @type {boolean} - * @memberof ArticlesApiArticlesList - */ - readonly draft?: boolean - - /** - * Number of results to return per page. - * @type {number} - * @memberof ArticlesApiArticlesList - */ - readonly limit?: number - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof ArticlesApiArticlesList - */ - readonly offset?: number +export interface ContentFileSearchApiContentFileSearchRetrieveRequest { + /** + * Show resource counts by category + * @type {Array<'topic' | 'content_feature_type' | 'platform' | 'offered_by'>} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly aggregations?: Array + + /** + * The feature type of the content file. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly content_feature_type?: Array + + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly dev_mode?: boolean | null + + /** + * The id value for the content file + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly id?: Array + + /** + * Number of results to return per page + * @type {number} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly limit?: number + + /** + * The ocw topic name. + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results + * @type {number} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly offset?: number + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly platform?: Array + + /** + * The search text + * @type {string} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly q?: string + + /** + * The id value of the parent learning resource for the content file + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly resource_id?: Array + + /** + * The id value of the run that the content file belongs to + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly run_id?: Array + + /** + * if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id + * @type {'id' | '-id' | 'resource_readable_id' | '-resource_readable_id'} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly sortby?: ContentFileSearchRetrieveSortbyEnum + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof ContentFileSearchApiContentFileSearchRetrieve + */ + readonly topic?: Array } /** - * Request parameters for articlesPartialUpdate operation in ArticlesApi. + * ContentFileSearchApi - object-oriented interface * @export - * @interface ArticlesApiArticlesPartialUpdateRequest + * @class ContentFileSearchApi + * @extends {BaseAPI} */ -export interface ArticlesApiArticlesPartialUpdateRequest { - /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof ArticlesApiArticlesPartialUpdate - */ - readonly id: number - - /** - * - * @type {PatchedWebsiteContentRequest} - * @memberof ArticlesApiArticlesPartialUpdate - */ - readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest +export class ContentFileSearchApi extends BaseAPI { + /** + * Search for content files + * @summary Search + * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ContentFileSearchApi + */ + public contentFileSearchRetrieve( + requestParameters: ContentFileSearchApiContentFileSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return ContentFileSearchApiFp(this.configuration) + .contentFileSearchRetrieve( + requestParameters.aggregations, + requestParameters.content_feature_type, + requestParameters.dev_mode, + requestParameters.id, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.q, + requestParameters.resource_id, + requestParameters.run_id, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } /** - * Request parameters for articlesRetrieve operation in ArticlesApi. * @export - * @interface ArticlesApiArticlesRetrieveRequest */ -export interface ArticlesApiArticlesRetrieveRequest { - /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof ArticlesApiArticlesRetrieve - */ - readonly id: number -} +export const ContentFileSearchRetrieveAggregationsEnum = { + Topic: "topic", + ContentFeatureType: "content_feature_type", + Platform: "platform", + OfferedBy: "offered_by", +} as const +export type ContentFileSearchRetrieveAggregationsEnum = + (typeof ContentFileSearchRetrieveAggregationsEnum)[keyof typeof ContentFileSearchRetrieveAggregationsEnum] +/** + * @export + */ +export const ContentFileSearchRetrieveOfferedByEnum = { + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type ContentFileSearchRetrieveOfferedByEnum = + (typeof ContentFileSearchRetrieveOfferedByEnum)[keyof typeof ContentFileSearchRetrieveOfferedByEnum] +/** + * @export + */ +export const ContentFileSearchRetrievePlatformEnum = { + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type ContentFileSearchRetrievePlatformEnum = + (typeof ContentFileSearchRetrievePlatformEnum)[keyof typeof ContentFileSearchRetrievePlatformEnum] +/** + * @export + */ +export const ContentFileSearchRetrieveSortbyEnum = { + Id: "id", + Id2: "-id", + ResourceReadableId: "resource_readable_id", + ResourceReadableId2: "-resource_readable_id", +} as const +export type ContentFileSearchRetrieveSortbyEnum = + (typeof ContentFileSearchRetrieveSortbyEnum)[keyof typeof ContentFileSearchRetrieveSortbyEnum] /** - * ArticlesApi - object-oriented interface + * ContentfilesApi - axios parameter creator * @export - * @class ArticlesApi - * @extends {BaseAPI} */ -export class ArticlesApi extends BaseAPI { +export const ContentfilesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * Create a new content item - * @summary Create - * @param {ArticlesApiArticlesCreateRequest} requestParameters Request parameters. + * Viewset for ContentFiles + * @summary List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesCreate(requestParameters: ArticlesApiArticlesCreateRequest, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesCreate(requestParameters.WebsiteContentRequest, options).then((request) => request(this.axios, this.basePath)); - } - + contentfilesList: async ( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "contentfilesList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = `/api/v1/contentfiles/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_feature_type) { + localVarQueryParameter["content_feature_type"] = content_feature_type + } + + if (edx_module_id) { + localVarQueryParameter["edx_module_id"] = edx_module_id + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (run_id) { + localVarQueryParameter["run_id"] = run_id + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Delete a content item - * @summary Destroy - * @param {ArticlesApiArticlesDestroyRequest} requestParameters Request parameters. + * Viewset for ContentFiles + * @summary Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesDestroy(requestParameters: ArticlesApiArticlesDestroyRequest, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + contentfilesRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("contentfilesRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "contentfilesRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = `/api/v1/contentfiles/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * ContentfilesApi - functional programming interface + * @export + */ +export const ContentfilesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + ContentfilesApiAxiosParamCreator(configuration) + return { /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {ArticlesApiArticlesDetailRetrieveRequest} requestParameters Request parameters. + * Viewset for ContentFiles + * @summary List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesDetailRetrieve(requestParameters: ArticlesApiArticlesDetailRetrieveRequest, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesDetailRetrieve(requestParameters.identifier, options).then((request) => request(this.axios, this.basePath)); - } - + async contentfilesList( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.contentfilesList( + learning_resource_id, + content_feature_type, + edx_module_id, + limit, + offered_by, + offset, + platform, + resource_id, + run_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ContentfilesApi.contentfilesList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Get a paginated list of website content items - * @summary List - * @param {ArticlesApiArticlesListRequest} requestParameters Request parameters. + * Viewset for ContentFiles + * @summary Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesList(requestParameters: ArticlesApiArticlesListRequest = {}, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesList(requestParameters.content_type, requestParameters.draft, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } + async contentfilesRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.contentfilesRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ContentfilesApi.contentfilesRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * ContentfilesApi - factory interface + * @export + */ +export const ContentfilesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ContentfilesApiFp(configuration) + return { /** - * Update a content item - * @summary Update - * @param {ArticlesApiArticlesPartialUpdateRequest} requestParameters Request parameters. + * Viewset for ContentFiles + * @summary List + * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesPartialUpdate(requestParameters: ArticlesApiArticlesPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesPartialUpdate(requestParameters.id, requestParameters.PatchedWebsiteContentRequest, options).then((request) => request(this.axios, this.basePath)); - } - + contentfilesList( + requestParameters: ContentfilesApiContentfilesListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .contentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Retrieve a single content item + * Viewset for ContentFiles * @summary Retrieve - * @param {ArticlesApiArticlesRetrieveRequest} requestParameters Request parameters. + * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ArticlesApi */ - public articlesRetrieve(requestParameters: ArticlesApiArticlesRetrieveRequest, options?: RawAxiosRequestConfig) { - return ArticlesApiFp(this.configuration).articlesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + contentfilesRetrieve( + requestParameters: ContentfilesApiContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .contentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for contentfilesList operation in ContentfilesApi. * @export + * @interface ContentfilesApiContentfilesListRequest */ -export const ArticlesListContentTypeEnum = { - Article: 'article', - News: 'news' -} as const; -export type ArticlesListContentTypeEnum = typeof ArticlesListContentTypeEnum[keyof typeof ArticlesListContentTypeEnum]; - +export interface ContentfilesApiContentfilesListRequest { + /** + * id of the parent learning resource + * @type {number} + * @memberof ContentfilesApiContentfilesList + */ + readonly learning_resource_id: number + + /** + * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof ContentfilesApiContentfilesList + */ + readonly content_feature_type?: Array + + /** + * The edx module id of the content file + * @type {Array} + * @memberof ContentfilesApiContentfilesList + */ + readonly edx_module_id?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof ContentfilesApiContentfilesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof ContentfilesApiContentfilesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof ContentfilesApiContentfilesList + */ + readonly offset?: number + + /** + * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof ContentfilesApiContentfilesList + */ + readonly platform?: Array + + /** + * The id of the learning resource the content file belongs to + * @type {Array} + * @memberof ContentfilesApiContentfilesList + */ + readonly resource_id?: Array + + /** + * The id of the learning resource run the content file belongs to + * @type {Array} + * @memberof ContentfilesApiContentfilesList + */ + readonly run_id?: Array +} /** - * ContentFileSearchApi - axios parameter creator + * Request parameters for contentfilesRetrieve operation in ContentfilesApi. * @export + * @interface ContentfilesApiContentfilesRetrieveRequest */ -export const ContentFileSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Search for content files - * @summary Search - * @param {Array} [aggregations] Show resource counts by category - * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {Array} [id] The id value for the content file - * @param {number} [limit] Number of results to return per page - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {string} [q] The search text - * @param {Array} [resource_id] The id value of the parent learning resource for the content file - * @param {Array} [run_id] The id value of the run that the content file belongs to - * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentFileSearchRetrieve: async (aggregations?: Array, content_feature_type?: Array, dev_mode?: boolean | null, id?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_id?: Array, run_id?: Array, sortby?: ContentFileSearchRetrieveSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/content_file_search/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (content_feature_type) { - localVarQueryParameter['content_feature_type'] = content_feature_type; - } - - if (dev_mode !== undefined) { - localVarQueryParameter['dev_mode'] = dev_mode; - } - - if (id) { - localVarQueryParameter['id'] = id; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (run_id) { - localVarQueryParameter['run_id'] = run_id; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface ContentfilesApiContentfilesRetrieveRequest { + /** + * A unique integer value identifying this contentfile. + * @type {number} + * @memberof ContentfilesApiContentfilesRetrieve + */ + readonly id: number + + /** + * id of the parent learning resource + * @type {number} + * @memberof ContentfilesApiContentfilesRetrieve + */ + readonly learning_resource_id: number +} /** - * ContentFileSearchApi - functional programming interface + * ContentfilesApi - object-oriented interface * @export + * @class ContentfilesApi + * @extends {BaseAPI} */ -export const ContentFileSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ContentFileSearchApiAxiosParamCreator(configuration) - return { - /** - * Search for content files - * @summary Search - * @param {Array} [aggregations] Show resource counts by category - * @param {Array} [content_feature_type] The feature type of the content file. Possible options are at api/v1/course_features/ - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {Array} [id] The id value for the content file - * @param {number} [limit] Number of results to return per page - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {string} [q] The search text - * @param {Array} [resource_id] The id value of the parent learning resource for the content file - * @param {Array} [run_id] The id value of the run that the content file belongs to - * @param {ContentFileSearchRetrieveSortbyEnum} [sortby] if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async contentFileSearchRetrieve(aggregations?: Array, content_feature_type?: Array, dev_mode?: boolean | null, id?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, q?: string, resource_id?: Array, run_id?: Array, sortby?: ContentFileSearchRetrieveSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.contentFileSearchRetrieve(aggregations, content_feature_type, dev_mode, id, limit, ocw_topic, offered_by, offset, platform, q, resource_id, run_id, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ContentFileSearchApi.contentFileSearchRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export class ContentfilesApi extends BaseAPI { + /** + * Viewset for ContentFiles + * @summary List + * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ContentfilesApi + */ + public contentfilesList( + requestParameters: ContentfilesApiContentfilesListRequest, + options?: RawAxiosRequestConfig, + ) { + return ContentfilesApiFp(this.configuration) + .contentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for ContentFiles + * @summary Retrieve + * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ContentfilesApi + */ + public contentfilesRetrieve( + requestParameters: ContentfilesApiContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ContentfilesApiFp(this.configuration) + .contentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * ContentFileSearchApi - factory interface * @export */ -export const ContentFileSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ContentFileSearchApiFp(configuration) - return { - /** - * Search for content files - * @summary Search - * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentFileSearchRetrieve(requestParameters: ContentFileSearchApiContentFileSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.contentFileSearchRetrieve(requestParameters.aggregations, requestParameters.content_feature_type, requestParameters.dev_mode, requestParameters.id, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.q, requestParameters.resource_id, requestParameters.run_id, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - }; -}; - +export const ContentfilesListOfferedByEnum = { + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type ContentfilesListOfferedByEnum = + (typeof ContentfilesListOfferedByEnum)[keyof typeof ContentfilesListOfferedByEnum] /** - * Request parameters for contentFileSearchRetrieve operation in ContentFileSearchApi. * @export - * @interface ContentFileSearchApiContentFileSearchRetrieveRequest */ -export interface ContentFileSearchApiContentFileSearchRetrieveRequest { - /** - * Show resource counts by category - * @type {Array<'topic' | 'content_feature_type' | 'platform' | 'offered_by'>} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly aggregations?: Array - - /** - * The feature type of the content file. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly content_feature_type?: Array - - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly dev_mode?: boolean | null - - /** - * The id value for the content file - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly id?: Array - - /** - * Number of results to return per page - * @type {number} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly limit?: number - - /** - * The ocw topic name. - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly ocw_topic?: Array - - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results - * @type {number} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly offset?: number - - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly platform?: Array - - /** - * The search text - * @type {string} - * @memberof ContentFileSearchApiContentFileSearchRetrieve - */ - readonly q?: string +export const ContentfilesListPlatformEnum = { + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type ContentfilesListPlatformEnum = + (typeof ContentfilesListPlatformEnum)[keyof typeof ContentfilesListPlatformEnum] +/** + * CourseFeaturesApi - axios parameter creator + * @export + */ +export const CourseFeaturesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The id value of the parent learning resource for the content file - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve + * Course Features and Content Feature Types + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + courseFeaturesList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/course_features/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The id value of the run that the content file belongs to - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve + * Course Features and Content Feature Types + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource content tag. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly run_id?: Array + courseFeaturesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("courseFeaturesRetrieve", "id", id) + const localVarPath = `/api/v1/course_features/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * CourseFeaturesApi - functional programming interface + * @export + */ +export const CourseFeaturesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + CourseFeaturesApiAxiosParamCreator(configuration) + return { /** - * if the parameter starts with \'-\' the sort is in descending order * `id` - id * `-id` - -id * `resource_readable_id` - resource_readable_id * `-resource_readable_id` - -resource_readable_id - * @type {'id' | '-id' | 'resource_readable_id' | '-resource_readable_id'} - * @memberof ContentFileSearchApiContentFileSearchRetrieve + * Course Features and Content Feature Types + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: ContentFileSearchRetrieveSortbyEnum - + async courseFeaturesList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.courseFeaturesList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CourseFeaturesApi.courseFeaturesList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof ContentFileSearchApiContentFileSearchRetrieve + * Course Features and Content Feature Types + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource content tag. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array + async courseFeaturesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.courseFeaturesRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CourseFeaturesApi.courseFeaturesRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * ContentFileSearchApi - object-oriented interface + * CourseFeaturesApi - factory interface * @export - * @class ContentFileSearchApi - * @extends {BaseAPI} */ -export class ContentFileSearchApi extends BaseAPI { +export const CourseFeaturesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = CourseFeaturesApiFp(configuration) + return { /** - * Search for content files - * @summary Search - * @param {ContentFileSearchApiContentFileSearchRetrieveRequest} requestParameters Request parameters. + * Course Features and Content Feature Types + * @summary List + * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + courseFeaturesList( + requestParameters: CourseFeaturesApiCourseFeaturesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .courseFeaturesList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * Course Features and Content Feature Types + * @summary Retrieve + * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ContentFileSearchApi */ - public contentFileSearchRetrieve(requestParameters: ContentFileSearchApiContentFileSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig) { - return ContentFileSearchApiFp(this.configuration).contentFileSearchRetrieve(requestParameters.aggregations, requestParameters.content_feature_type, requestParameters.dev_mode, requestParameters.id, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.q, requestParameters.resource_id, requestParameters.run_id, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } + courseFeaturesRetrieve( + requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .courseFeaturesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for courseFeaturesList operation in CourseFeaturesApi. * @export + * @interface CourseFeaturesApiCourseFeaturesListRequest */ -export const ContentFileSearchRetrieveAggregationsEnum = { - Topic: 'topic', - ContentFeatureType: 'content_feature_type', - Platform: 'platform', - OfferedBy: 'offered_by' -} as const; -export type ContentFileSearchRetrieveAggregationsEnum = typeof ContentFileSearchRetrieveAggregationsEnum[keyof typeof ContentFileSearchRetrieveAggregationsEnum]; -/** - * @export - */ -export const ContentFileSearchRetrieveOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type ContentFileSearchRetrieveOfferedByEnum = typeof ContentFileSearchRetrieveOfferedByEnum[keyof typeof ContentFileSearchRetrieveOfferedByEnum]; -/** - * @export - */ -export const ContentFileSearchRetrievePlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type ContentFileSearchRetrievePlatformEnum = typeof ContentFileSearchRetrievePlatformEnum[keyof typeof ContentFileSearchRetrievePlatformEnum]; -/** - * @export - */ -export const ContentFileSearchRetrieveSortbyEnum = { - Id: 'id', - Id2: '-id', - ResourceReadableId: 'resource_readable_id', - ResourceReadableId2: '-resource_readable_id' -} as const; -export type ContentFileSearchRetrieveSortbyEnum = typeof ContentFileSearchRetrieveSortbyEnum[keyof typeof ContentFileSearchRetrieveSortbyEnum]; - +export interface CourseFeaturesApiCourseFeaturesListRequest { + /** + * Number of results to return per page. + * @type {number} + * @memberof CourseFeaturesApiCourseFeaturesList + */ + readonly limit?: number -/** - * ContentfilesApi - axios parameter creator - * @export - */ -export const ContentfilesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Viewset for ContentFiles - * @summary List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentfilesList: async (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('contentfilesList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/contentfiles/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_feature_type) { - localVarQueryParameter['content_feature_type'] = content_feature_type; - } - - if (edx_module_id) { - localVarQueryParameter['edx_module_id'] = edx_module_id; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (run_id) { - localVarQueryParameter['run_id'] = run_id; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for ContentFiles - * @summary Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentfilesRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('contentfilesRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('contentfilesRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/contentfiles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; + /** + * The initial index from which to return the results. + * @type {number} + * @memberof CourseFeaturesApiCourseFeaturesList + */ + readonly offset?: number +} /** - * ContentfilesApi - functional programming interface + * Request parameters for courseFeaturesRetrieve operation in CourseFeaturesApi. * @export + * @interface CourseFeaturesApiCourseFeaturesRetrieveRequest */ -export const ContentfilesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ContentfilesApiAxiosParamCreator(configuration) - return { - /** - * Viewset for ContentFiles - * @summary List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async contentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.contentfilesList(learning_resource_id, content_feature_type, edx_module_id, limit, offered_by, offset, platform, resource_id, run_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ContentfilesApi.contentfilesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for ContentFiles - * @summary Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async contentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.contentfilesRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ContentfilesApi.contentfilesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface CourseFeaturesApiCourseFeaturesRetrieveRequest { + /** + * A unique integer value identifying this learning resource content tag. + * @type {number} + * @memberof CourseFeaturesApiCourseFeaturesRetrieve + */ + readonly id: number +} /** - * ContentfilesApi - factory interface + * CourseFeaturesApi - object-oriented interface * @export + * @class CourseFeaturesApi + * @extends {BaseAPI} */ -export const ContentfilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ContentfilesApiFp(configuration) - return { - /** - * Viewset for ContentFiles - * @summary List - * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentfilesList(requestParameters: ContentfilesApiContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.contentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for ContentFiles - * @summary Retrieve - * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - contentfilesRetrieve(requestParameters: ContentfilesApiContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.contentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class CourseFeaturesApi extends BaseAPI { + /** + * Course Features and Content Feature Types + * @summary List + * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CourseFeaturesApi + */ + public courseFeaturesList( + requestParameters: CourseFeaturesApiCourseFeaturesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return CourseFeaturesApiFp(this.configuration) + .courseFeaturesList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Course Features and Content Feature Types + * @summary Retrieve + * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CourseFeaturesApi + */ + public courseFeaturesRetrieve( + requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return CourseFeaturesApiFp(this.configuration) + .courseFeaturesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for contentfilesList operation in ContentfilesApi. + * CoursesApi - axios parameter creator * @export - * @interface ContentfilesApiContentfilesListRequest */ -export interface ContentfilesApiContentfilesListRequest { +export const CoursesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * id of the parent learning resource - * @type {number} - * @memberof ContentfilesApiContentfilesList + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number - + coursesContentfilesList: async ( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "coursesContentfilesList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/courses/{learning_resource_id}/contentfiles/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_feature_type) { + localVarQueryParameter["content_feature_type"] = content_feature_type + } + + if (edx_module_id) { + localVarQueryParameter["edx_module_id"] = edx_module_id + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (run_id) { + localVarQueryParameter["run_id"] = run_id + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof ContentfilesApiContentfilesList + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly content_feature_type?: Array - + coursesContentfilesRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("coursesContentfilesRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "coursesContentfilesRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/courses/{learning_resource_id}/contentfiles/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The edx module id of the content file - * @type {Array} - * @memberof ContentfilesApiContentfilesList - */ - readonly edx_module_id?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof ContentfilesApiContentfilesList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof ContentfilesApiContentfilesList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof ContentfilesApiContentfilesList - */ - readonly offset?: number - - /** - * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof ContentfilesApiContentfilesList - */ - readonly platform?: Array - - /** - * The id of the learning resource the content file belongs to - * @type {Array} - * @memberof ContentfilesApiContentfilesList + * Get a paginated list of courses + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + coursesList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: CoursesListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/courses/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The id of the learning resource run the content file belongs to - * @type {Array} - * @memberof ContentfilesApiContentfilesList + * Retrieve a single course + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly run_id?: Array + coursesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("coursesRetrieve", "id", id) + const localVarPath = `/api/v1/courses/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for contentfilesRetrieve operation in ContentfilesApi. + * CoursesApi - functional programming interface * @export - * @interface ContentfilesApiContentfilesRetrieveRequest */ -export interface ContentfilesApiContentfilesRetrieveRequest { +export const CoursesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = CoursesApiAxiosParamCreator(configuration) + return { /** - * A unique integer value identifying this contentfile. - * @type {number} - * @memberof ContentfilesApiContentfilesRetrieve + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + async coursesContentfilesList( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.coursesContentfilesList( + learning_resource_id, + content_feature_type, + edx_module_id, + limit, + offered_by, + offset, + platform, + resource_id, + run_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CoursesApi.coursesContentfilesList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * id of the parent learning resource - * @type {number} - * @memberof ContentfilesApiContentfilesRetrieve + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number -} - -/** - * ContentfilesApi - object-oriented interface - * @export - * @class ContentfilesApi - * @extends {BaseAPI} - */ -export class ContentfilesApi extends BaseAPI { + async coursesContentfilesRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.coursesContentfilesRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CoursesApi.coursesContentfilesRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for ContentFiles + * Get a paginated list of courses * @summary List - * @param {ContentfilesApiContentfilesListRequest} requestParameters Request parameters. + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ContentfilesApi */ - public contentfilesList(requestParameters: ContentfilesApiContentfilesListRequest, options?: RawAxiosRequestConfig) { - return ContentfilesApiFp(this.configuration).contentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(this.axios, this.basePath)); - } - + async coursesList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: CoursesListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.coursesList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CoursesApi.coursesList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for ContentFiles + * Retrieve a single course * @summary Retrieve - * @param {ContentfilesApiContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ContentfilesApi */ - public contentfilesRetrieve(requestParameters: ContentfilesApiContentfilesRetrieveRequest, options?: RawAxiosRequestConfig) { - return ContentfilesApiFp(this.configuration).contentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } + async coursesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.coursesRetrieve( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["CoursesApi.coursesRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** + * CoursesApi - factory interface * @export */ -export const ContentfilesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type ContentfilesListOfferedByEnum = typeof ContentfilesListOfferedByEnum[keyof typeof ContentfilesListOfferedByEnum]; -/** - * @export - */ -export const ContentfilesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type ContentfilesListPlatformEnum = typeof ContentfilesListPlatformEnum[keyof typeof ContentfilesListPlatformEnum]; - - -/** - * CourseFeaturesApi - axios parameter creator - * @export - */ -export const CourseFeaturesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Course Features and Content Feature Types - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - courseFeaturesList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/course_features/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Course Features and Content Feature Types - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource content tag. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - courseFeaturesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('courseFeaturesRetrieve', 'id', id) - const localVarPath = `/api/v1/course_features/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * CourseFeaturesApi - functional programming interface - * @export - */ -export const CourseFeaturesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CourseFeaturesApiAxiosParamCreator(configuration) - return { - /** - * Course Features and Content Feature Types - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async courseFeaturesList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.courseFeaturesList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CourseFeaturesApi.courseFeaturesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Course Features and Content Feature Types - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource content tag. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async courseFeaturesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.courseFeaturesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CourseFeaturesApi.courseFeaturesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * CourseFeaturesApi - factory interface - * @export - */ -export const CourseFeaturesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CourseFeaturesApiFp(configuration) - return { - /** - * Course Features and Content Feature Types - * @summary List - * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - courseFeaturesList(requestParameters: CourseFeaturesApiCourseFeaturesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.courseFeaturesList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Course Features and Content Feature Types - * @summary Retrieve - * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - courseFeaturesRetrieve(requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.courseFeaturesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for courseFeaturesList operation in CourseFeaturesApi. - * @export - * @interface CourseFeaturesApiCourseFeaturesListRequest - */ -export interface CourseFeaturesApiCourseFeaturesListRequest { - /** - * Number of results to return per page. - * @type {number} - * @memberof CourseFeaturesApiCourseFeaturesList - */ - readonly limit?: number - +export const CoursesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = CoursesApiFp(configuration) + return { /** - * The initial index from which to return the results. - * @type {number} - * @memberof CourseFeaturesApiCourseFeaturesList + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number -} - -/** - * Request parameters for courseFeaturesRetrieve operation in CourseFeaturesApi. - * @export - * @interface CourseFeaturesApiCourseFeaturesRetrieveRequest - */ -export interface CourseFeaturesApiCourseFeaturesRetrieveRequest { + coursesContentfilesList( + requestParameters: CoursesApiCoursesContentfilesListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .coursesContentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * A unique integer value identifying this learning resource content tag. - * @type {number} - * @memberof CourseFeaturesApiCourseFeaturesRetrieve + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * CourseFeaturesApi - object-oriented interface - * @export - * @class CourseFeaturesApi - * @extends {BaseAPI} - */ -export class CourseFeaturesApi extends BaseAPI { + coursesContentfilesRetrieve( + requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .coursesContentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Course Features and Content Feature Types + * Get a paginated list of courses * @summary List - * @param {CourseFeaturesApiCourseFeaturesListRequest} requestParameters Request parameters. + * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CourseFeaturesApi */ - public courseFeaturesList(requestParameters: CourseFeaturesApiCourseFeaturesListRequest = {}, options?: RawAxiosRequestConfig) { - return CourseFeaturesApiFp(this.configuration).courseFeaturesList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + coursesList( + requestParameters: CoursesApiCoursesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .coursesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Course Features and Content Feature Types + * Retrieve a single course * @summary Retrieve - * @param {CourseFeaturesApiCourseFeaturesRetrieveRequest} requestParameters Request parameters. + * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof CourseFeaturesApi */ - public courseFeaturesRetrieve(requestParameters: CourseFeaturesApiCourseFeaturesRetrieveRequest, options?: RawAxiosRequestConfig) { - return CourseFeaturesApiFp(this.configuration).courseFeaturesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + coursesRetrieve( + requestParameters: CoursesApiCoursesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .coursesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - -/** - * CoursesApi - axios parameter creator - * @export - */ -export const CoursesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesContentfilesList: async (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('coursesContentfilesList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/courses/{learning_resource_id}/contentfiles/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_feature_type) { - localVarQueryParameter['content_feature_type'] = content_feature_type; - } - - if (edx_module_id) { - localVarQueryParameter['edx_module_id'] = edx_module_id; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (run_id) { - localVarQueryParameter['run_id'] = run_id; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesContentfilesRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('coursesContentfilesRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('coursesContentfilesRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/courses/{learning_resource_id}/contentfiles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of courses - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: CoursesListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/courses/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single course - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('coursesRetrieve', 'id', id) - const localVarPath = `/api/v1/courses/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * CoursesApi - functional programming interface - * @export - */ -export const CoursesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = CoursesApiAxiosParamCreator(configuration) - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async coursesContentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.coursesContentfilesList(learning_resource_id, content_feature_type, edx_module_id, limit, offered_by, offset, platform, resource_id, run_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CoursesApi.coursesContentfilesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async coursesContentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.coursesContentfilesRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CoursesApi.coursesContentfilesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of courses - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {CoursesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async coursesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: CoursesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.coursesList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CoursesApi.coursesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single course - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async coursesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.coursesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['CoursesApi.coursesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * CoursesApi - factory interface - * @export - */ -export const CoursesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = CoursesApiFp(configuration) - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesContentfilesList(requestParameters: CoursesApiCoursesContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.coursesContentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(axios, basePath)); - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesContentfilesRetrieve(requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.coursesContentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of courses - * @summary List - * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesList(requestParameters: CoursesApiCoursesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.coursesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single course - * @summary Retrieve - * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - coursesRetrieve(requestParameters: CoursesApiCoursesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.coursesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - /** * Request parameters for coursesContentfilesList operation in CoursesApi. * @export * @interface CoursesApiCoursesContentfilesListRequest */ export interface CoursesApiCoursesContentfilesListRequest { - /** - * id of the parent learning resource - * @type {number} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly learning_resource_id: number - - /** - * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly content_feature_type?: Array - - /** - * The edx module id of the content file - * @type {Array} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly edx_module_id?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly offset?: number - - /** - * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly platform?: Array - - /** - * The id of the learning resource the content file belongs to - * @type {Array} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly resource_id?: Array - - /** - * The id of the learning resource run the content file belongs to - * @type {Array} - * @memberof CoursesApiCoursesContentfilesList - */ - readonly run_id?: Array + /** + * id of the parent learning resource + * @type {number} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly learning_resource_id: number + + /** + * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly content_feature_type?: Array + + /** + * The edx module id of the content file + * @type {Array} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly edx_module_id?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly offset?: number + + /** + * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly platform?: Array + + /** + * The id of the learning resource the content file belongs to + * @type {Array} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly resource_id?: Array + + /** + * The id of the learning resource run the content file belongs to + * @type {Array} + * @memberof CoursesApiCoursesContentfilesList + */ + readonly run_id?: Array } /** @@ -12000,19 +12905,19 @@ export interface CoursesApiCoursesContentfilesListRequest { * @interface CoursesApiCoursesContentfilesRetrieveRequest */ export interface CoursesApiCoursesContentfilesRetrieveRequest { - /** - * A unique integer value identifying this contentfile. - * @type {number} - * @memberof CoursesApiCoursesContentfilesRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this contentfile. + * @type {number} + * @memberof CoursesApiCoursesContentfilesRetrieve + */ + readonly id: number - /** - * id of the parent learning resource - * @type {number} - * @memberof CoursesApiCoursesContentfilesRetrieve - */ - readonly learning_resource_id: number + /** + * id of the parent learning resource + * @type {number} + * @memberof CoursesApiCoursesContentfilesRetrieve + */ + readonly learning_resource_id: number } /** @@ -12021,131 +12926,131 @@ export interface CoursesApiCoursesContentfilesRetrieveRequest { * @interface CoursesApiCoursesListRequest */ export interface CoursesApiCoursesListRequest { - /** - * - * @type {boolean} - * @memberof CoursesApiCoursesList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof CoursesApiCoursesList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof CoursesApiCoursesList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof CoursesApiCoursesList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof CoursesApiCoursesList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof CoursesApiCoursesList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof CoursesApiCoursesList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof CoursesApiCoursesList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof CoursesApiCoursesList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof CoursesApiCoursesList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof CoursesApiCoursesList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof CoursesApiCoursesList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof CoursesApiCoursesList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof CoursesApiCoursesList - */ - readonly resource_id?: Array - - /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof CoursesApiCoursesList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof CoursesApiCoursesList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof CoursesApiCoursesList - */ - readonly sortby?: CoursesListSortbyEnum - - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof CoursesApiCoursesList - */ - readonly topic?: Array + /** + * + * @type {boolean} + * @memberof CoursesApiCoursesList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof CoursesApiCoursesList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof CoursesApiCoursesList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof CoursesApiCoursesList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof CoursesApiCoursesList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof CoursesApiCoursesList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof CoursesApiCoursesList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof CoursesApiCoursesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof CoursesApiCoursesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof CoursesApiCoursesList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof CoursesApiCoursesList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof CoursesApiCoursesList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof CoursesApiCoursesList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof CoursesApiCoursesList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof CoursesApiCoursesList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof CoursesApiCoursesList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof CoursesApiCoursesList + */ + readonly sortby?: CoursesListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof CoursesApiCoursesList + */ + readonly topic?: Array } /** @@ -12154,12 +13059,12 @@ export interface CoursesApiCoursesListRequest { * @interface CoursesApiCoursesRetrieveRequest */ export interface CoursesApiCoursesRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof CoursesApiCoursesRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof CoursesApiCoursesRetrieve + */ + readonly id: number } /** @@ -12169,852 +13074,1155 @@ export interface CoursesApiCoursesRetrieveRequest { * @extends {BaseAPI} */ export class CoursesApi extends BaseAPI { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CoursesApi - */ - public coursesContentfilesList(requestParameters: CoursesApiCoursesContentfilesListRequest, options?: RawAxiosRequestConfig) { - return CoursesApiFp(this.configuration).coursesContentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CoursesApi - */ - public coursesContentfilesRetrieve(requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig) { - return CoursesApiFp(this.configuration).coursesContentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a paginated list of courses - * @summary List - * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CoursesApi - */ - public coursesList(requestParameters: CoursesApiCoursesListRequest = {}, options?: RawAxiosRequestConfig) { - return CoursesApiFp(this.configuration).coursesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a single course - * @summary Retrieve - * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof CoursesApi - */ - public coursesRetrieve(requestParameters: CoursesApiCoursesRetrieveRequest, options?: RawAxiosRequestConfig) { - return CoursesApiFp(this.configuration).coursesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {CoursesApiCoursesContentfilesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CoursesApi + */ + public coursesContentfilesList( + requestParameters: CoursesApiCoursesContentfilesListRequest, + options?: RawAxiosRequestConfig, + ) { + return CoursesApiFp(this.configuration) + .coursesContentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {CoursesApiCoursesContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CoursesApi + */ + public coursesContentfilesRetrieve( + requestParameters: CoursesApiCoursesContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return CoursesApiFp(this.configuration) + .coursesContentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of courses + * @summary List + * @param {CoursesApiCoursesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CoursesApi + */ + public coursesList( + requestParameters: CoursesApiCoursesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return CoursesApiFp(this.configuration) + .coursesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single course + * @summary Retrieve + * @param {CoursesApiCoursesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CoursesApi + */ + public coursesRetrieve( + requestParameters: CoursesApiCoursesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return CoursesApiFp(this.configuration) + .coursesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const CoursesContentfilesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type CoursesContentfilesListOfferedByEnum = typeof CoursesContentfilesListOfferedByEnum[keyof typeof CoursesContentfilesListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type CoursesContentfilesListOfferedByEnum = + (typeof CoursesContentfilesListOfferedByEnum)[keyof typeof CoursesContentfilesListOfferedByEnum] /** * @export */ export const CoursesContentfilesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type CoursesContentfilesListPlatformEnum = typeof CoursesContentfilesListPlatformEnum[keyof typeof CoursesContentfilesListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type CoursesContentfilesListPlatformEnum = + (typeof CoursesContentfilesListPlatformEnum)[keyof typeof CoursesContentfilesListPlatformEnum] /** * @export */ export const CoursesListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type CoursesListCertificationTypeEnum = typeof CoursesListCertificationTypeEnum[keyof typeof CoursesListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type CoursesListCertificationTypeEnum = + (typeof CoursesListCertificationTypeEnum)[keyof typeof CoursesListCertificationTypeEnum] /** * @export */ export const CoursesListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type CoursesListDeliveryEnum = typeof CoursesListDeliveryEnum[keyof typeof CoursesListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type CoursesListDeliveryEnum = + (typeof CoursesListDeliveryEnum)[keyof typeof CoursesListDeliveryEnum] /** * @export */ export const CoursesListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type CoursesListDepartmentEnum = typeof CoursesListDepartmentEnum[keyof typeof CoursesListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type CoursesListDepartmentEnum = + (typeof CoursesListDepartmentEnum)[keyof typeof CoursesListDepartmentEnum] /** * @export */ export const CoursesListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type CoursesListLevelEnum = typeof CoursesListLevelEnum[keyof typeof CoursesListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type CoursesListLevelEnum = + (typeof CoursesListLevelEnum)[keyof typeof CoursesListLevelEnum] /** * @export */ export const CoursesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type CoursesListOfferedByEnum = typeof CoursesListOfferedByEnum[keyof typeof CoursesListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type CoursesListOfferedByEnum = + (typeof CoursesListOfferedByEnum)[keyof typeof CoursesListOfferedByEnum] /** * @export */ export const CoursesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type CoursesListPlatformEnum = typeof CoursesListPlatformEnum[keyof typeof CoursesListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type CoursesListPlatformEnum = + (typeof CoursesListPlatformEnum)[keyof typeof CoursesListPlatformEnum] /** * @export */ export const CoursesListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type CoursesListResourceTypeEnum = typeof CoursesListResourceTypeEnum[keyof typeof CoursesListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type CoursesListResourceTypeEnum = + (typeof CoursesListResourceTypeEnum)[keyof typeof CoursesListResourceTypeEnum] /** * @export */ export const CoursesListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type CoursesListResourceTypeGroupEnum = typeof CoursesListResourceTypeGroupEnum[keyof typeof CoursesListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type CoursesListResourceTypeGroupEnum = + (typeof CoursesListResourceTypeGroupEnum)[keyof typeof CoursesListResourceTypeGroupEnum] /** * @export */ export const CoursesListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type CoursesListSortbyEnum = typeof CoursesListSortbyEnum[keyof typeof CoursesListSortbyEnum]; - + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type CoursesListSortbyEnum = + (typeof CoursesListSortbyEnum)[keyof typeof CoursesListSortbyEnum] /** * DepartmentsApi - axios parameter creator * @export */ -export const DepartmentsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * MIT academic departments - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - departmentsList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/departments/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * MIT academic departments - * @summary Retrieve - * @param {string} department_id A unique value identifying this learning resource department. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - departmentsRetrieve: async (department_id: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'department_id' is not null or undefined - assertParamExists('departmentsRetrieve', 'department_id', department_id) - const localVarPath = `/api/v1/departments/{department_id}/` - .replace(`{${"department_id"}}`, encodeURIComponent(String(department_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * DepartmentsApi - functional programming interface - * @export - */ -export const DepartmentsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DepartmentsApiAxiosParamCreator(configuration) - return { - /** - * MIT academic departments - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async departmentsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.departmentsList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['DepartmentsApi.departmentsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * MIT academic departments - * @summary Retrieve - * @param {string} department_id A unique value identifying this learning resource department. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async departmentsRetrieve(department_id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.departmentsRetrieve(department_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['DepartmentsApi.departmentsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * DepartmentsApi - factory interface - * @export - */ -export const DepartmentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DepartmentsApiFp(configuration) - return { - /** - * MIT academic departments - * @summary List - * @param {DepartmentsApiDepartmentsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - departmentsList(requestParameters: DepartmentsApiDepartmentsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.departmentsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * MIT academic departments - * @summary Retrieve - * @param {DepartmentsApiDepartmentsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - departmentsRetrieve(requestParameters: DepartmentsApiDepartmentsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.departmentsRetrieve(requestParameters.department_id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for departmentsList operation in DepartmentsApi. - * @export - * @interface DepartmentsApiDepartmentsListRequest - */ -export interface DepartmentsApiDepartmentsListRequest { +export const DepartmentsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * Number of results to return per page. - * @type {number} - * @memberof DepartmentsApiDepartmentsList + * MIT academic departments + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + departmentsList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/departments/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof DepartmentsApiDepartmentsList + * MIT academic departments + * @summary Retrieve + * @param {string} department_id A unique value identifying this learning resource department. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number + departmentsRetrieve: async ( + department_id: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'department_id' is not null or undefined + assertParamExists("departmentsRetrieve", "department_id", department_id) + const localVarPath = `/api/v1/departments/{department_id}/`.replace( + `{${"department_id"}}`, + encodeURIComponent(String(department_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for departmentsRetrieve operation in DepartmentsApi. + * DepartmentsApi - functional programming interface * @export - * @interface DepartmentsApiDepartmentsRetrieveRequest */ -export interface DepartmentsApiDepartmentsRetrieveRequest { +export const DepartmentsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + DepartmentsApiAxiosParamCreator(configuration) + return { + /** + * MIT academic departments + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async departmentsList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.departmentsList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["DepartmentsApi.departmentsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique value identifying this learning resource department. - * @type {string} - * @memberof DepartmentsApiDepartmentsRetrieve + * MIT academic departments + * @summary Retrieve + * @param {string} department_id A unique value identifying this learning resource department. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly department_id: string + async departmentsRetrieve( + department_id: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.departmentsRetrieve( + department_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["DepartmentsApi.departmentsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * DepartmentsApi - object-oriented interface + * DepartmentsApi - factory interface * @export - * @class DepartmentsApi - * @extends {BaseAPI} */ -export class DepartmentsApi extends BaseAPI { +export const DepartmentsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = DepartmentsApiFp(configuration) + return { /** * MIT academic departments * @summary List * @param {DepartmentsApiDepartmentsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DepartmentsApi */ - public departmentsList(requestParameters: DepartmentsApiDepartmentsListRequest = {}, options?: RawAxiosRequestConfig) { - return DepartmentsApiFp(this.configuration).departmentsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + departmentsList( + requestParameters: DepartmentsApiDepartmentsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .departmentsList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * MIT academic departments * @summary Retrieve * @param {DepartmentsApiDepartmentsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DepartmentsApi */ - public departmentsRetrieve(requestParameters: DepartmentsApiDepartmentsRetrieveRequest, options?: RawAxiosRequestConfig) { - return DepartmentsApiFp(this.configuration).departmentsRetrieve(requestParameters.department_id, options).then((request) => request(this.axios, this.basePath)); - } + departmentsRetrieve( + requestParameters: DepartmentsApiDepartmentsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .departmentsRetrieve(requestParameters.department_id, options) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * FeaturedApi - axios parameter creator + * Request parameters for departmentsList operation in DepartmentsApi. * @export + * @interface DepartmentsApiDepartmentsListRequest */ -export const FeaturedApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a paginated list of featured resources - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - featuredList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: FeaturedListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/featured/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single featured resource - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - featuredRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('featuredRetrieve', 'id', id) - const localVarPath = `/api/v1/featured/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface DepartmentsApiDepartmentsListRequest { + /** + * Number of results to return per page. + * @type {number} + * @memberof DepartmentsApiDepartmentsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof DepartmentsApiDepartmentsList + */ + readonly offset?: number +} /** - * FeaturedApi - functional programming interface + * Request parameters for departmentsRetrieve operation in DepartmentsApi. * @export + * @interface DepartmentsApiDepartmentsRetrieveRequest */ -export const FeaturedApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = FeaturedApiAxiosParamCreator(configuration) - return { - /** - * Get a paginated list of featured resources - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async featuredList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: FeaturedListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.featuredList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['FeaturedApi.featuredList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single featured resource - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async featuredRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.featuredRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['FeaturedApi.featuredRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface DepartmentsApiDepartmentsRetrieveRequest { + /** + * A unique value identifying this learning resource department. + * @type {string} + * @memberof DepartmentsApiDepartmentsRetrieve + */ + readonly department_id: string +} /** - * FeaturedApi - factory interface + * DepartmentsApi - object-oriented interface * @export + * @class DepartmentsApi + * @extends {BaseAPI} */ -export const FeaturedApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = FeaturedApiFp(configuration) - return { - /** - * Get a paginated list of featured resources - * @summary List - * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - featuredList(requestParameters: FeaturedApiFeaturedListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.featuredList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single featured resource - * @summary Retrieve - * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - featuredRetrieve(requestParameters: FeaturedApiFeaturedRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.featuredRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class DepartmentsApi extends BaseAPI { + /** + * MIT academic departments + * @summary List + * @param {DepartmentsApiDepartmentsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DepartmentsApi + */ + public departmentsList( + requestParameters: DepartmentsApiDepartmentsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return DepartmentsApiFp(this.configuration) + .departmentsList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * MIT academic departments + * @summary Retrieve + * @param {DepartmentsApiDepartmentsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DepartmentsApi + */ + public departmentsRetrieve( + requestParameters: DepartmentsApiDepartmentsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return DepartmentsApiFp(this.configuration) + .departmentsRetrieve(requestParameters.department_id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for featuredList operation in FeaturedApi. + * FeaturedApi - axios parameter creator * @export - * @interface FeaturedApiFeaturedListRequest */ -export interface FeaturedApiFeaturedListRequest { - /** - * - * @type {boolean} - * @memberof FeaturedApiFeaturedList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof FeaturedApiFeaturedList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof FeaturedApiFeaturedList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof FeaturedApiFeaturedList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof FeaturedApiFeaturedList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof FeaturedApiFeaturedList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof FeaturedApiFeaturedList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof FeaturedApiFeaturedList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof FeaturedApiFeaturedList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof FeaturedApiFeaturedList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof FeaturedApiFeaturedList - */ - readonly platform?: Array - +export const FeaturedApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {boolean} - * @memberof FeaturedApiFeaturedList + * Get a paginated list of featured resources + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean - + featuredList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: FeaturedListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/featured/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * A unique text identifier for the resources - * @type {Array} - * @memberof FeaturedApiFeaturedList + * Retrieve a single featured resource + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly readable_id?: Array + featuredRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("featuredRetrieve", "id", id) + const localVarPath = `/api/v1/featured/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * FeaturedApi - functional programming interface + * @export + */ +export const FeaturedApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = FeaturedApiAxiosParamCreator(configuration) + return { /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof FeaturedApiFeaturedList + * Get a paginated list of featured resources + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {FeaturedListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + async featuredList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: FeaturedListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.featuredList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["FeaturedApi.featuredList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof FeaturedApiFeaturedList + * Retrieve a single featured resource + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array + async featuredRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.featuredRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["FeaturedApi.featuredRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * FeaturedApi - factory interface + * @export + */ +export const FeaturedApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = FeaturedApiFp(configuration) + return { /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof FeaturedApiFeaturedList + * Get a paginated list of featured resources + * @summary List + * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + featuredList( + requestParameters: FeaturedApiFeaturedListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .featuredList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof FeaturedApiFeaturedList + * Retrieve a single featured resource + * @summary Retrieve + * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: FeaturedListSortbyEnum + featuredRetrieve( + requestParameters: FeaturedApiFeaturedRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .featuredRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } +} - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof FeaturedApiFeaturedList - */ - readonly topic?: Array +/** + * Request parameters for featuredList operation in FeaturedApi. + * @export + * @interface FeaturedApiFeaturedListRequest + */ +export interface FeaturedApiFeaturedListRequest { + /** + * + * @type {boolean} + * @memberof FeaturedApiFeaturedList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof FeaturedApiFeaturedList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof FeaturedApiFeaturedList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof FeaturedApiFeaturedList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof FeaturedApiFeaturedList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof FeaturedApiFeaturedList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof FeaturedApiFeaturedList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof FeaturedApiFeaturedList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof FeaturedApiFeaturedList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof FeaturedApiFeaturedList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof FeaturedApiFeaturedList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof FeaturedApiFeaturedList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof FeaturedApiFeaturedList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof FeaturedApiFeaturedList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof FeaturedApiFeaturedList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof FeaturedApiFeaturedList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof FeaturedApiFeaturedList + */ + readonly sortby?: FeaturedListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof FeaturedApiFeaturedList + */ + readonly topic?: Array } /** @@ -13023,12 +14231,12 @@ export interface FeaturedApiFeaturedListRequest { * @interface FeaturedApiFeaturedRetrieveRequest */ export interface FeaturedApiFeaturedRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof FeaturedApiFeaturedRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof FeaturedApiFeaturedRetrieve + */ + readonly id: number } /** @@ -13038,912 +14246,1282 @@ export interface FeaturedApiFeaturedRetrieveRequest { * @extends {BaseAPI} */ export class FeaturedApi extends BaseAPI { - /** - * Get a paginated list of featured resources - * @summary List - * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FeaturedApi - */ - public featuredList(requestParameters: FeaturedApiFeaturedListRequest = {}, options?: RawAxiosRequestConfig) { - return FeaturedApiFp(this.configuration).featuredList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a single featured resource - * @summary Retrieve - * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FeaturedApi - */ - public featuredRetrieve(requestParameters: FeaturedApiFeaturedRetrieveRequest, options?: RawAxiosRequestConfig) { - return FeaturedApiFp(this.configuration).featuredRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Get a paginated list of featured resources + * @summary List + * @param {FeaturedApiFeaturedListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FeaturedApi + */ + public featuredList( + requestParameters: FeaturedApiFeaturedListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return FeaturedApiFp(this.configuration) + .featuredList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single featured resource + * @summary Retrieve + * @param {FeaturedApiFeaturedRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FeaturedApi + */ + public featuredRetrieve( + requestParameters: FeaturedApiFeaturedRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return FeaturedApiFp(this.configuration) + .featuredRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const FeaturedListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type FeaturedListCertificationTypeEnum = typeof FeaturedListCertificationTypeEnum[keyof typeof FeaturedListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type FeaturedListCertificationTypeEnum = + (typeof FeaturedListCertificationTypeEnum)[keyof typeof FeaturedListCertificationTypeEnum] /** * @export */ export const FeaturedListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type FeaturedListDeliveryEnum = typeof FeaturedListDeliveryEnum[keyof typeof FeaturedListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type FeaturedListDeliveryEnum = + (typeof FeaturedListDeliveryEnum)[keyof typeof FeaturedListDeliveryEnum] /** * @export */ export const FeaturedListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type FeaturedListDepartmentEnum = typeof FeaturedListDepartmentEnum[keyof typeof FeaturedListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type FeaturedListDepartmentEnum = + (typeof FeaturedListDepartmentEnum)[keyof typeof FeaturedListDepartmentEnum] /** * @export */ export const FeaturedListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type FeaturedListLevelEnum = typeof FeaturedListLevelEnum[keyof typeof FeaturedListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type FeaturedListLevelEnum = + (typeof FeaturedListLevelEnum)[keyof typeof FeaturedListLevelEnum] /** * @export */ export const FeaturedListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type FeaturedListOfferedByEnum = typeof FeaturedListOfferedByEnum[keyof typeof FeaturedListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type FeaturedListOfferedByEnum = + (typeof FeaturedListOfferedByEnum)[keyof typeof FeaturedListOfferedByEnum] /** * @export */ export const FeaturedListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type FeaturedListPlatformEnum = typeof FeaturedListPlatformEnum[keyof typeof FeaturedListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type FeaturedListPlatformEnum = + (typeof FeaturedListPlatformEnum)[keyof typeof FeaturedListPlatformEnum] /** * @export */ export const FeaturedListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type FeaturedListResourceTypeEnum = typeof FeaturedListResourceTypeEnum[keyof typeof FeaturedListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type FeaturedListResourceTypeEnum = + (typeof FeaturedListResourceTypeEnum)[keyof typeof FeaturedListResourceTypeEnum] /** * @export */ export const FeaturedListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type FeaturedListResourceTypeGroupEnum = typeof FeaturedListResourceTypeGroupEnum[keyof typeof FeaturedListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type FeaturedListResourceTypeGroupEnum = + (typeof FeaturedListResourceTypeGroupEnum)[keyof typeof FeaturedListResourceTypeGroupEnum] /** * @export */ export const FeaturedListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type FeaturedListSortbyEnum = typeof FeaturedListSortbyEnum[keyof typeof FeaturedListSortbyEnum]; - + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type FeaturedListSortbyEnum = + (typeof FeaturedListSortbyEnum)[keyof typeof FeaturedListSortbyEnum] /** * HubspotApi - axios parameter creator * @export */ -export const HubspotApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get one HubSpot form by id from the backend. - * @param {string} form_id - * @param {boolean} [archived] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsDetailRetrieve: async (form_id: string, archived?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'form_id' is not null or undefined - assertParamExists('hubspotFormsDetailRetrieve', 'form_id', form_id) - const localVarPath = `/api/v1/hubspot/forms/{form_id}/` - .replace(`{${"form_id"}}`, encodeURIComponent(String(form_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (archived !== undefined) { - localVarQueryParameter['archived'] = archived; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * List HubSpot forms from the backend. - * @param {string} [after] - * @param {boolean} [archived] - * @param {Array} [form_types] - * @param {number} [limit] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsList: async (after?: string, archived?: boolean, form_types?: Array, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/hubspot/forms/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (after !== undefined) { - localVarQueryParameter['after'] = after; - } - - if (archived !== undefined) { - localVarQueryParameter['archived'] = archived; - } - - if (form_types) { - localVarQueryParameter['form_types'] = form_types; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Submit a form to HubSpot. - * @param {string} form_id - * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsSubmit: async (form_id: string, HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'form_id' is not null or undefined - assertParamExists('hubspotFormsSubmit', 'form_id', form_id) - // verify required parameter 'HubspotFormSubmitRequestRequest' is not null or undefined - assertParamExists('hubspotFormsSubmit', 'HubspotFormSubmitRequestRequest', HubspotFormSubmitRequestRequest) - const localVarPath = `/api/v1/hubspot/forms/{form_id}/submit/` - .replace(`{${"form_id"}}`, encodeURIComponent(String(form_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(HubspotFormSubmitRequestRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * HubspotApi - functional programming interface - * @export - */ -export const HubspotApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = HubspotApiAxiosParamCreator(configuration) - return { - /** - * Get one HubSpot form by id from the backend. - * @param {string} form_id - * @param {boolean} [archived] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async hubspotFormsDetailRetrieve(form_id: string, archived?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.hubspotFormsDetailRetrieve(form_id, archived, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['HubspotApi.hubspotFormsDetailRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * List HubSpot forms from the backend. - * @param {string} [after] - * @param {boolean} [archived] - * @param {Array} [form_types] - * @param {number} [limit] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async hubspotFormsList(after?: string, archived?: boolean, form_types?: Array, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.hubspotFormsList(after, archived, form_types, limit, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['HubspotApi.hubspotFormsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Submit a form to HubSpot. - * @param {string} form_id - * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async hubspotFormsSubmit(form_id: string, HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.hubspotFormsSubmit(form_id, HubspotFormSubmitRequestRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['HubspotApi.hubspotFormsSubmit']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * HubspotApi - factory interface - * @export - */ -export const HubspotApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = HubspotApiFp(configuration) - return { - /** - * Get one HubSpot form by id from the backend. - * @param {HubspotApiHubspotFormsDetailRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsDetailRetrieve(requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.hubspotFormsDetailRetrieve(requestParameters.form_id, requestParameters.archived, options).then((request) => request(axios, basePath)); - }, - /** - * List HubSpot forms from the backend. - * @param {HubspotApiHubspotFormsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsList(requestParameters: HubspotApiHubspotFormsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.hubspotFormsList(requestParameters.after, requestParameters.archived, requestParameters.form_types, requestParameters.limit, options).then((request) => request(axios, basePath)); - }, - /** - * Submit a form to HubSpot. - * @param {HubspotApiHubspotFormsSubmitRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - hubspotFormsSubmit(requestParameters: HubspotApiHubspotFormsSubmitRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.hubspotFormsSubmit(requestParameters.form_id, requestParameters.HubspotFormSubmitRequestRequest, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for hubspotFormsDetailRetrieve operation in HubspotApi. - * @export - * @interface HubspotApiHubspotFormsDetailRetrieveRequest - */ -export interface HubspotApiHubspotFormsDetailRetrieveRequest { - /** - * - * @type {string} - * @memberof HubspotApiHubspotFormsDetailRetrieve - */ - readonly form_id: string - - /** - * - * @type {boolean} - * @memberof HubspotApiHubspotFormsDetailRetrieve - */ - readonly archived?: boolean -} - -/** - * Request parameters for hubspotFormsList operation in HubspotApi. - * @export - * @interface HubspotApiHubspotFormsListRequest - */ -export interface HubspotApiHubspotFormsListRequest { - /** - * - * @type {string} - * @memberof HubspotApiHubspotFormsList - */ - readonly after?: string - +export const HubspotApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {boolean} - * @memberof HubspotApiHubspotFormsList + * Get one HubSpot form by id from the backend. + * @param {string} form_id + * @param {boolean} [archived] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly archived?: boolean - + hubspotFormsDetailRetrieve: async ( + form_id: string, + archived?: boolean, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'form_id' is not null or undefined + assertParamExists("hubspotFormsDetailRetrieve", "form_id", form_id) + const localVarPath = `/api/v1/hubspot/forms/{form_id}/`.replace( + `{${"form_id"}}`, + encodeURIComponent(String(form_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (archived !== undefined) { + localVarQueryParameter["archived"] = archived + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {Array} - * @memberof HubspotApiHubspotFormsList + * List HubSpot forms from the backend. + * @param {string} [after] + * @param {boolean} [archived] + * @param {Array} [form_types] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly form_types?: Array - + hubspotFormsList: async ( + after?: string, + archived?: boolean, + form_types?: Array, + limit?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/hubspot/forms/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (after !== undefined) { + localVarQueryParameter["after"] = after + } + + if (archived !== undefined) { + localVarQueryParameter["archived"] = archived + } + + if (form_types) { + localVarQueryParameter["form_types"] = form_types + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {number} - * @memberof HubspotApiHubspotFormsList + * Submit a form to HubSpot. + * @param {string} form_id + * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number + hubspotFormsSubmit: async ( + form_id: string, + HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'form_id' is not null or undefined + assertParamExists("hubspotFormsSubmit", "form_id", form_id) + // verify required parameter 'HubspotFormSubmitRequestRequest' is not null or undefined + assertParamExists( + "hubspotFormsSubmit", + "HubspotFormSubmitRequestRequest", + HubspotFormSubmitRequestRequest, + ) + const localVarPath = `/api/v1/hubspot/forms/{form_id}/submit/`.replace( + `{${"form_id"}}`, + encodeURIComponent(String(form_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + HubspotFormSubmitRequestRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for hubspotFormsSubmit operation in HubspotApi. + * HubspotApi - functional programming interface * @export - * @interface HubspotApiHubspotFormsSubmitRequest */ -export interface HubspotApiHubspotFormsSubmitRequest { +export const HubspotApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = HubspotApiAxiosParamCreator(configuration) + return { + /** + * Get one HubSpot form by id from the backend. + * @param {string} form_id + * @param {boolean} [archived] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hubspotFormsDetailRetrieve( + form_id: string, + archived?: boolean, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.hubspotFormsDetailRetrieve( + form_id, + archived, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["HubspotApi.hubspotFormsDetailRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {string} - * @memberof HubspotApiHubspotFormsSubmit + * List HubSpot forms from the backend. + * @param {string} [after] + * @param {boolean} [archived] + * @param {Array} [form_types] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly form_id: string - + async hubspotFormsList( + after?: string, + archived?: boolean, + form_types?: Array, + limit?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.hubspotFormsList( + after, + archived, + form_types, + limit, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["HubspotApi.hubspotFormsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {HubspotFormSubmitRequestRequest} - * @memberof HubspotApiHubspotFormsSubmit + * Submit a form to HubSpot. + * @param {string} form_id + * @param {HubspotFormSubmitRequestRequest} HubspotFormSubmitRequestRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest + async hubspotFormsSubmit( + form_id: string, + HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.hubspotFormsSubmit( + form_id, + HubspotFormSubmitRequestRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["HubspotApi.hubspotFormsSubmit"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * HubspotApi - object-oriented interface + * HubspotApi - factory interface * @export - * @class HubspotApi - * @extends {BaseAPI} */ -export class HubspotApi extends BaseAPI { +export const HubspotApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = HubspotApiFp(configuration) + return { /** * Get one HubSpot form by id from the backend. * @param {HubspotApiHubspotFormsDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof HubspotApi */ - public hubspotFormsDetailRetrieve(requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, options?: RawAxiosRequestConfig) { - return HubspotApiFp(this.configuration).hubspotFormsDetailRetrieve(requestParameters.form_id, requestParameters.archived, options).then((request) => request(this.axios, this.basePath)); - } - + hubspotFormsDetailRetrieve( + requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .hubspotFormsDetailRetrieve( + requestParameters.form_id, + requestParameters.archived, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * List HubSpot forms from the backend. * @param {HubspotApiHubspotFormsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof HubspotApi */ - public hubspotFormsList(requestParameters: HubspotApiHubspotFormsListRequest = {}, options?: RawAxiosRequestConfig) { - return HubspotApiFp(this.configuration).hubspotFormsList(requestParameters.after, requestParameters.archived, requestParameters.form_types, requestParameters.limit, options).then((request) => request(this.axios, this.basePath)); - } - + hubspotFormsList( + requestParameters: HubspotApiHubspotFormsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .hubspotFormsList( + requestParameters.after, + requestParameters.archived, + requestParameters.form_types, + requestParameters.limit, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Submit a form to HubSpot. * @param {HubspotApiHubspotFormsSubmitRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof HubspotApi */ - public hubspotFormsSubmit(requestParameters: HubspotApiHubspotFormsSubmitRequest, options?: RawAxiosRequestConfig) { - return HubspotApiFp(this.configuration).hubspotFormsSubmit(requestParameters.form_id, requestParameters.HubspotFormSubmitRequestRequest, options).then((request) => request(this.axios, this.basePath)); - } + hubspotFormsSubmit( + requestParameters: HubspotApiHubspotFormsSubmitRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .hubspotFormsSubmit( + requestParameters.form_id, + requestParameters.HubspotFormSubmitRequestRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * LearningResourceDisplayInfoApi - axios parameter creator + * Request parameters for hubspotFormsDetailRetrieve operation in HubspotApi. * @export + * @interface HubspotApiHubspotFormsDetailRetrieveRequest */ -export const LearningResourceDisplayInfoApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a paginated list of learning resource display info - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourceDisplayInfoList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourceDisplayInfoListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resource_display_info/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve display info for a learning resource. - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourceDisplayInfoRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourceDisplayInfoRetrieve', 'id', id) - const localVarPath = `/api/v1/learning_resource_display_info/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface HubspotApiHubspotFormsDetailRetrieveRequest { + /** + * + * @type {string} + * @memberof HubspotApiHubspotFormsDetailRetrieve + */ + readonly form_id: string + + /** + * + * @type {boolean} + * @memberof HubspotApiHubspotFormsDetailRetrieve + */ + readonly archived?: boolean +} /** - * LearningResourceDisplayInfoApi - functional programming interface + * Request parameters for hubspotFormsList operation in HubspotApi. * @export + * @interface HubspotApiHubspotFormsListRequest */ -export const LearningResourceDisplayInfoApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningResourceDisplayInfoApiAxiosParamCreator(configuration) - return { - /** - * Get a paginated list of learning resource display info - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourceDisplayInfoList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourceDisplayInfoListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourceDisplayInfoList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourceDisplayInfoApi.learningResourceDisplayInfoList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve display info for a learning resource. - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourceDisplayInfoRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourceDisplayInfoRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourceDisplayInfoApi.learningResourceDisplayInfoRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface HubspotApiHubspotFormsListRequest { + /** + * + * @type {string} + * @memberof HubspotApiHubspotFormsList + */ + readonly after?: string + + /** + * + * @type {boolean} + * @memberof HubspotApiHubspotFormsList + */ + readonly archived?: boolean + + /** + * + * @type {Array} + * @memberof HubspotApiHubspotFormsList + */ + readonly form_types?: Array + + /** + * + * @type {number} + * @memberof HubspotApiHubspotFormsList + */ + readonly limit?: number +} /** - * LearningResourceDisplayInfoApi - factory interface + * Request parameters for hubspotFormsSubmit operation in HubspotApi. * @export + * @interface HubspotApiHubspotFormsSubmitRequest */ -export const LearningResourceDisplayInfoApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningResourceDisplayInfoApiFp(configuration) - return { - /** - * Get a paginated list of learning resource display info - * @summary List - * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourceDisplayInfoList(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourceDisplayInfoList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve display info for a learning resource. - * @summary Retrieve - * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourceDisplayInfoRetrieve(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourceDisplayInfoRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface HubspotApiHubspotFormsSubmitRequest { + /** + * + * @type {string} + * @memberof HubspotApiHubspotFormsSubmit + */ + readonly form_id: string + + /** + * + * @type {HubspotFormSubmitRequestRequest} + * @memberof HubspotApiHubspotFormsSubmit + */ + readonly HubspotFormSubmitRequestRequest: HubspotFormSubmitRequestRequest +} /** - * Request parameters for learningResourceDisplayInfoList operation in LearningResourceDisplayInfoApi. + * HubspotApi - object-oriented interface * @export - * @interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest + * @class HubspotApi + * @extends {BaseAPI} */ -export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest { - /** - * - * @type {boolean} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly platform?: Array +export class HubspotApi extends BaseAPI { + /** + * Get one HubSpot form by id from the backend. + * @param {HubspotApiHubspotFormsDetailRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HubspotApi + */ + public hubspotFormsDetailRetrieve( + requestParameters: HubspotApiHubspotFormsDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return HubspotApiFp(this.configuration) + .hubspotFormsDetailRetrieve( + requestParameters.form_id, + requestParameters.archived, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * List HubSpot forms from the backend. + * @param {HubspotApiHubspotFormsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HubspotApi + */ + public hubspotFormsList( + requestParameters: HubspotApiHubspotFormsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return HubspotApiFp(this.configuration) + .hubspotFormsList( + requestParameters.after, + requestParameters.archived, + requestParameters.form_types, + requestParameters.limit, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Submit a form to HubSpot. + * @param {HubspotApiHubspotFormsSubmitRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HubspotApi + */ + public hubspotFormsSubmit( + requestParameters: HubspotApiHubspotFormsSubmitRequest, + options?: RawAxiosRequestConfig, + ) { + return HubspotApiFp(this.configuration) + .hubspotFormsSubmit( + requestParameters.form_id, + requestParameters.HubspotFormSubmitRequestRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} +/** + * LearningResourceDisplayInfoApi - axios parameter creator + * @export + */ +export const LearningResourceDisplayInfoApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {boolean} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Get a paginated list of learning resource display info + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean - + learningResourceDisplayInfoList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourceDisplayInfoListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resource_display_info/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * A unique text identifier for the resources - * @type {Array} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Retrieve display info for a learning resource. + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly readable_id?: Array + learningResourceDisplayInfoRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourceDisplayInfoRetrieve", "id", id) + const localVarPath = + `/api/v1/learning_resource_display_info/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * LearningResourceDisplayInfoApi - functional programming interface + * @export + */ +export const LearningResourceDisplayInfoApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + LearningResourceDisplayInfoApiAxiosParamCreator(configuration) + return { /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Get a paginated list of learning resource display info + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourceDisplayInfoListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + async learningResourceDisplayInfoList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourceDisplayInfoListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourceDisplayInfoList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourceDisplayInfoApi.learningResourceDisplayInfoList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Retrieve display info for a learning resource. + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array + async learningResourceDisplayInfoRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourceDisplayInfoRetrieve( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourceDisplayInfoApi.learningResourceDisplayInfoRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * LearningResourceDisplayInfoApi - factory interface + * @export + */ +export const LearningResourceDisplayInfoApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningResourceDisplayInfoApiFp(configuration) + return { /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Get a paginated list of learning resource display info + * @summary List + * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + learningResourceDisplayInfoList( + requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourceDisplayInfoList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + * Retrieve display info for a learning resource. + * @summary Retrieve + * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: LearningResourceDisplayInfoListSortbyEnum + learningResourceDisplayInfoRetrieve( + requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourceDisplayInfoRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } +} - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList - */ - readonly topic?: Array +/** + * Request parameters for learningResourceDisplayInfoList operation in LearningResourceDisplayInfoApi. + * @export + * @interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest + */ +export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest { + /** + * + * @type {boolean} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly sortby?: LearningResourceDisplayInfoListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoList + */ + readonly topic?: Array } /** @@ -13952,12 +15530,12 @@ export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRe * @interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest */ export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieve + */ + readonly id: number } /** @@ -13967,1771 +15545,2610 @@ export interface LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrie * @extends {BaseAPI} */ export class LearningResourceDisplayInfoApi extends BaseAPI { - /** - * Get a paginated list of learning resource display info - * @summary List - * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourceDisplayInfoApi - */ - public learningResourceDisplayInfoList(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourceDisplayInfoApiFp(this.configuration).learningResourceDisplayInfoList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve display info for a learning resource. - * @summary Retrieve - * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourceDisplayInfoApi - */ - public learningResourceDisplayInfoRetrieve(requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningResourceDisplayInfoApiFp(this.configuration).learningResourceDisplayInfoRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Get a paginated list of learning resource display info + * @summary List + * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourceDisplayInfoApi + */ + public learningResourceDisplayInfoList( + requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourceDisplayInfoApiFp(this.configuration) + .learningResourceDisplayInfoList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve display info for a learning resource. + * @summary Retrieve + * @param {LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourceDisplayInfoApi + */ + public learningResourceDisplayInfoRetrieve( + requestParameters: LearningResourceDisplayInfoApiLearningResourceDisplayInfoRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourceDisplayInfoApiFp(this.configuration) + .learningResourceDisplayInfoRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const LearningResourceDisplayInfoListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type LearningResourceDisplayInfoListCertificationTypeEnum = typeof LearningResourceDisplayInfoListCertificationTypeEnum[keyof typeof LearningResourceDisplayInfoListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type LearningResourceDisplayInfoListCertificationTypeEnum = + (typeof LearningResourceDisplayInfoListCertificationTypeEnum)[keyof typeof LearningResourceDisplayInfoListCertificationTypeEnum] /** * @export */ export const LearningResourceDisplayInfoListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourceDisplayInfoListDeliveryEnum = typeof LearningResourceDisplayInfoListDeliveryEnum[keyof typeof LearningResourceDisplayInfoListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourceDisplayInfoListDeliveryEnum = + (typeof LearningResourceDisplayInfoListDeliveryEnum)[keyof typeof LearningResourceDisplayInfoListDeliveryEnum] /** * @export */ export const LearningResourceDisplayInfoListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourceDisplayInfoListDepartmentEnum = typeof LearningResourceDisplayInfoListDepartmentEnum[keyof typeof LearningResourceDisplayInfoListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourceDisplayInfoListDepartmentEnum = + (typeof LearningResourceDisplayInfoListDepartmentEnum)[keyof typeof LearningResourceDisplayInfoListDepartmentEnum] /** * @export */ export const LearningResourceDisplayInfoListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type LearningResourceDisplayInfoListLevelEnum = typeof LearningResourceDisplayInfoListLevelEnum[keyof typeof LearningResourceDisplayInfoListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type LearningResourceDisplayInfoListLevelEnum = + (typeof LearningResourceDisplayInfoListLevelEnum)[keyof typeof LearningResourceDisplayInfoListLevelEnum] /** * @export */ export const LearningResourceDisplayInfoListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type LearningResourceDisplayInfoListOfferedByEnum = typeof LearningResourceDisplayInfoListOfferedByEnum[keyof typeof LearningResourceDisplayInfoListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type LearningResourceDisplayInfoListOfferedByEnum = + (typeof LearningResourceDisplayInfoListOfferedByEnum)[keyof typeof LearningResourceDisplayInfoListOfferedByEnum] /** * @export */ export const LearningResourceDisplayInfoListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type LearningResourceDisplayInfoListPlatformEnum = typeof LearningResourceDisplayInfoListPlatformEnum[keyof typeof LearningResourceDisplayInfoListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type LearningResourceDisplayInfoListPlatformEnum = + (typeof LearningResourceDisplayInfoListPlatformEnum)[keyof typeof LearningResourceDisplayInfoListPlatformEnum] /** * @export */ export const LearningResourceDisplayInfoListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type LearningResourceDisplayInfoListResourceTypeEnum = typeof LearningResourceDisplayInfoListResourceTypeEnum[keyof typeof LearningResourceDisplayInfoListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type LearningResourceDisplayInfoListResourceTypeEnum = + (typeof LearningResourceDisplayInfoListResourceTypeEnum)[keyof typeof LearningResourceDisplayInfoListResourceTypeEnum] /** * @export */ export const LearningResourceDisplayInfoListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type LearningResourceDisplayInfoListResourceTypeGroupEnum = typeof LearningResourceDisplayInfoListResourceTypeGroupEnum[keyof typeof LearningResourceDisplayInfoListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type LearningResourceDisplayInfoListResourceTypeGroupEnum = + (typeof LearningResourceDisplayInfoListResourceTypeGroupEnum)[keyof typeof LearningResourceDisplayInfoListResourceTypeGroupEnum] /** * @export */ export const LearningResourceDisplayInfoListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type LearningResourceDisplayInfoListSortbyEnum = typeof LearningResourceDisplayInfoListSortbyEnum[keyof typeof LearningResourceDisplayInfoListSortbyEnum]; - + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type LearningResourceDisplayInfoListSortbyEnum = + (typeof LearningResourceDisplayInfoListSortbyEnum)[keyof typeof LearningResourceDisplayInfoListSortbyEnum] /** * LearningResourcesApi - axios parameter creator * @export */ -export const LearningResourcesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesContentfilesList: async (learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningResourcesContentfilesList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learning_resources/{learning_resource_id}/contentfiles/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_feature_type) { - localVarQueryParameter['content_feature_type'] = content_feature_type; - } - - if (edx_module_id) { - localVarQueryParameter['edx_module_id'] = edx_module_id; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (run_id) { - localVarQueryParameter['run_id'] = run_id; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesContentfilesRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesContentfilesRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningResourcesContentfilesRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learning_resources/{learning_resource_id}/contentfiles/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesItemsList: async (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningResourcesItemsList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learning_resources/{learning_resource_id}/items/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesItemsRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesItemsRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningResourcesItemsRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learning_resources/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Set Learning Path Relationships on a given Learning Resource. - * @summary Set Learning Path Relationships - * @param {number} id id of the learning resource - * @param {Array} [learning_path_id] id of the parent learning path - * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesLearningPathsPartialUpdate: async (id: number, learning_path_id?: Array, PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesLearningPathsPartialUpdate', 'id', id) - const localVarPath = `/api/v1/learning_resources/{id}/learning_paths/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (learning_path_id) { - localVarQueryParameter['learning_path_id'] = learning_path_id; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedLearningResourceRelationshipRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of learning resources. - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single learning resource. - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesRetrieve', 'id', id) - const localVarPath = `/api/v1/learning_resources/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources - * @param {number} id - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [free] - * @param {Array} [level] - * @param {number} [limit] - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSimilarList: async (id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesSimilarList', 'id', id) - const localVarPath = `/api/v1/learning_resources/{id}/similar/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of learning resources with summary fields - * @summary Get learning resources summary - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSummaryList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesSummaryListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources/summary/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Set User List Relationships on a given Learning Resource. - * @summary Set User List Relationships - * @param {number} id id of the learning resource - * @param {Array} [userlist_id] id of the parent user list - * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserlistsPartialUpdate: async (id: number, userlist_id?: Array, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesUserlistsPartialUpdate', 'id', id) - const localVarPath = `/api/v1/learning_resources/{id}/userlists/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (userlist_id) { - localVarQueryParameter['userlist_id'] = userlist_id; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedUserListRelationshipRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources using vector embeddings - * @param {number} id - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [free] - * @param {Array} [level] - * @param {number} [limit] - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesVectorSimilarList: async (id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesVectorSimilarList', 'id', id) - const localVarPath = `/api/v1/learning_resources/{id}/vector_similar/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * LearningResourcesApi - functional programming interface - * @export - */ -export const LearningResourcesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningResourcesApiAxiosParamCreator(configuration) - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {number} learning_resource_id id of the parent learning resource - * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array} [edx_module_id] The edx module id of the content file - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {Array} [resource_id] The id of the learning resource the content file belongs to - * @param {Array} [run_id] The id of the learning resource run the content file belongs to - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesContentfilesList(learning_resource_id: number, content_feature_type?: Array, edx_module_id?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, resource_id?: Array, run_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesContentfilesList(learning_resource_id, content_feature_type, edx_module_id, limit, offered_by, offset, platform, resource_id, run_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesContentfilesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {number} id A unique integer value identifying this contentfile. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesContentfilesRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesContentfilesRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesContentfilesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesItemsList(learning_resource_id, limit, offset, sortby, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesItemsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesItemsRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesItemsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Set Learning Path Relationships on a given Learning Resource. - * @summary Set Learning Path Relationships - * @param {number} id id of the learning resource - * @param {Array} [learning_path_id] id of the parent learning path - * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesLearningPathsPartialUpdate(id: number, learning_path_id?: Array, PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesLearningPathsPartialUpdate(id, learning_path_id, PatchedLearningResourceRelationshipRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesLearningPathsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of learning resources. - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single learning resource. - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources - * @param {number} id - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [free] - * @param {Array} [level] - * @param {number} [limit] - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesSimilarList(id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesSimilarList(id, certification, certification_type, course_feature, delivery, department, free, level, limit, ocw_topic, offered_by, platform, professional, resource_type, resource_type_group, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesSimilarList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of learning resources with summary fields - * @summary Get learning resources summary - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesSummaryList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningResourcesSummaryListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesSummaryList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesSummaryList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Set User List Relationships on a given Learning Resource. - * @summary Set User List Relationships - * @param {number} id id of the learning resource - * @param {Array} [userlist_id] id of the parent user list - * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesUserlistsPartialUpdate(id: number, userlist_id?: Array, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesUserlistsPartialUpdate(id, userlist_id, PatchedUserListRelationshipRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesUserlistsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources using vector embeddings - * @param {number} id - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [free] - * @param {Array} [level] - * @param {number} [limit] - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesVectorSimilarList(id: number, certification?: boolean | null, certification_type?: Array, course_feature?: Array, delivery?: Array, department?: Array, free?: boolean | null, level?: Array, limit?: number, ocw_topic?: Array, offered_by?: Array, platform?: Array, professional?: boolean | null, resource_type?: Array, resource_type_group?: Array, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesVectorSimilarList(id, certification, certification_type, course_feature, delivery, department, free, level, limit, ocw_topic, offered_by, platform, professional, resource_type, resource_type_group, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesApi.learningResourcesVectorSimilarList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * LearningResourcesApi - factory interface - * @export - */ -export const LearningResourcesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningResourcesApiFp(configuration) - return { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesContentfilesList(requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesContentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(axios, basePath)); - }, - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesContentfilesRetrieve(requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesContentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesItemsList(requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(axios, basePath)); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesItemsRetrieve(requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Set Learning Path Relationships on a given Learning Resource. - * @summary Set Learning Path Relationships - * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesLearningPathsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesLearningPathsPartialUpdate(requestParameters.id, requestParameters.learning_path_id, requestParameters.PatchedLearningResourceRelationshipRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of learning resources. - * @summary List - * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesList(requestParameters: LearningResourcesApiLearningResourcesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single learning resource. - * @summary Retrieve - * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesRetrieve(requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources - * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSimilarList(requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesSimilarList(requestParameters.id, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.platform, requestParameters.professional, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of learning resources with summary fields - * @summary Get learning resources summary - * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSummaryList(requestParameters: LearningResourcesApiLearningResourcesSummaryListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesSummaryList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Set User List Relationships on a given Learning Resource. - * @summary Set User List Relationships - * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserlistsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesUserlistsPartialUpdate(requestParameters.id, requestParameters.userlist_id, requestParameters.PatchedUserListRelationshipRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources using vector embeddings - * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesVectorSimilarList(requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesVectorSimilarList(requestParameters.id, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.platform, requestParameters.professional, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for learningResourcesContentfilesList operation in LearningResourcesApi. - * @export - * @interface LearningResourcesApiLearningResourcesContentfilesListRequest - */ -export interface LearningResourcesApiLearningResourcesContentfilesListRequest { +export const LearningResourcesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * id of the parent learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number - + learningResourcesContentfilesList: async ( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningResourcesContentfilesList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learning_resources/{learning_resource_id}/contentfiles/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_feature_type) { + localVarQueryParameter["content_feature_type"] = content_feature_type + } + + if (edx_module_id) { + localVarQueryParameter["edx_module_id"] = edx_module_id + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (run_id) { + localVarQueryParameter["run_id"] = run_id + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly content_feature_type?: Array - + learningResourcesContentfilesRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesContentfilesRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningResourcesContentfilesRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learning_resources/{learning_resource_id}/contentfiles/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The edx module id of the content file - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly edx_module_id?: Array - + learningResourcesItemsList: async ( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningResourcesItemsList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learning_resources/{learning_resource_id}/items/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Number of results to return per page. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + learningResourcesItemsRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesItemsRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningResourcesItemsRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learning_resources/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Set Learning Path Relationships on a given Learning Resource. + * @summary Set Learning Path Relationships + * @param {number} id id of the learning resource + * @param {Array} [learning_path_id] id of the parent learning path + * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offered_by?: Array - + learningResourcesLearningPathsPartialUpdate: async ( + id: number, + learning_path_id?: Array, + PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesLearningPathsPartialUpdate", "id", id) + const localVarPath = + `/api/v1/learning_resources/{id}/learning_paths/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (learning_path_id) { + localVarQueryParameter["learning_path_id"] = learning_path_id + } + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedLearningResourceRelationshipRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Get a paginated list of learning resources. + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + learningResourcesList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourcesListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Retrieve a single learning resource. + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly platform?: Array - + learningResourcesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesRetrieve", "id", id) + const localVarPath = `/api/v1/learning_resources/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The id of the learning resource the content file belongs to - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources + * @param {number} id + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [free] + * @param {Array} [level] + * @param {number} [limit] + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + learningResourcesSimilarList: async ( + id: number, + certification?: boolean | null, + certification_type?: Array, + course_feature?: Array, + delivery?: Array, + department?: Array, + free?: boolean | null, + level?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + platform?: Array, + professional?: boolean | null, + resource_type?: Array, + resource_type_group?: Array, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesSimilarList", "id", id) + const localVarPath = `/api/v1/learning_resources/{id}/similar/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The id of the learning resource run the content file belongs to - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesContentfilesList + * Get a paginated list of learning resources with summary fields + * @summary Get learning resources summary + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly run_id?: Array -} - -/** - * Request parameters for learningResourcesContentfilesRetrieve operation in LearningResourcesApi. - * @export - * @interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest - */ -export interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest { + learningResourcesSummaryList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourcesSummaryListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources/summary/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * A unique integer value identifying this contentfile. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve + * Set User List Relationships on a given Learning Resource. + * @summary Set User List Relationships + * @param {number} id id of the learning resource + * @param {Array} [userlist_id] id of the parent user list + * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + learningResourcesUserlistsPartialUpdate: async ( + id: number, + userlist_id?: Array, + PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesUserlistsPartialUpdate", "id", id) + const localVarPath = `/api/v1/learning_resources/{id}/userlists/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (userlist_id) { + localVarQueryParameter["userlist_id"] = userlist_id + } + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedUserListRelationshipRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * id of the parent learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve + * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources using vector embeddings + * @param {number} id + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [free] + * @param {Array} [level] + * @param {number} [limit] + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number + learningResourcesVectorSimilarList: async ( + id: number, + certification?: boolean | null, + certification_type?: Array, + course_feature?: Array, + delivery?: Array, + department?: Array, + free?: boolean | null, + level?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + platform?: Array, + professional?: boolean | null, + resource_type?: Array, + resource_type_group?: Array, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningResourcesVectorSimilarList", "id", id) + const localVarPath = + `/api/v1/learning_resources/{id}/vector_similar/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for learningResourcesItemsList operation in LearningResourcesApi. + * LearningResourcesApi - functional programming interface * @export - * @interface LearningResourcesApiLearningResourcesItemsListRequest */ -export interface LearningResourcesApiLearningResourcesItemsListRequest { +export const LearningResourcesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + LearningResourcesApiAxiosParamCreator(configuration) + return { /** - * id of the parent learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesItemsList + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {number} learning_resource_id id of the parent learning resource + * @param {Array} [content_feature_type] Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array} [edx_module_id] The edx module id of the content file + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {Array} [resource_id] The id of the learning resource the content file belongs to + * @param {Array} [run_id] The id of the learning resource run the content file belongs to + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number - + async learningResourcesContentfilesList( + learning_resource_id: number, + content_feature_type?: Array, + edx_module_id?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + resource_id?: Array, + run_id?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesContentfilesList( + learning_resource_id, + content_feature_type, + edx_module_id, + limit, + offered_by, + offset, + platform, + resource_id, + run_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesContentfilesList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Number of results to return per page. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesItemsList + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {number} id A unique integer value identifying this contentfile. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + async learningResourcesContentfilesRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesContentfilesRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesContentfilesRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesItemsList + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + async learningResourcesItemsList( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesItemsList( + learning_resource_id, + limit, + offset, + sortby, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningResourcesApi.learningResourcesItemsList"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Which field to use when ordering the results. - * @type {string} - * @memberof LearningResourcesApiLearningResourcesItemsList + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: string -} - -/** - * Request parameters for learningResourcesItemsRetrieve operation in LearningResourcesApi. - * @export - * @interface LearningResourcesApiLearningResourcesItemsRetrieveRequest - */ -export interface LearningResourcesApiLearningResourcesItemsRetrieveRequest { + async learningResourcesItemsRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesItemsRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesItemsRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesItemsRetrieve + * Set Learning Path Relationships on a given Learning Resource. + * @summary Set Learning Path Relationships + * @param {number} id id of the learning resource + * @param {Array} [learning_path_id] id of the parent learning path + * @param {PatchedLearningResourceRelationshipRequest} [PatchedLearningResourceRelationshipRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + async learningResourcesLearningPathsPartialUpdate( + id: number, + learning_path_id?: Array, + PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesLearningPathsPartialUpdate( + id, + learning_path_id, + PatchedLearningResourceRelationshipRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesLearningPathsPartialUpdate" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * id of the parent learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesItemsRetrieve + * Get a paginated list of learning resources. + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourcesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number -} - -/** - * Request parameters for learningResourcesLearningPathsPartialUpdate operation in LearningResourcesApi. - * @export - * @interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest - */ -export interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest { + async learningResourcesList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourcesListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningResourcesApi.learningResourcesList"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * id of the learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + * Retrieve a single learning resource. + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + async learningResourcesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningResourcesApi.learningResourcesRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * id of the parent learning path - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources + * @param {number} id + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [free] + * @param {Array} [level] + * @param {number} [limit] + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_path_id?: Array - + async learningResourcesSimilarList( + id: number, + certification?: boolean | null, + certification_type?: Array, + course_feature?: Array, + delivery?: Array, + department?: Array, + free?: boolean | null, + level?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + platform?: Array, + professional?: boolean | null, + resource_type?: Array, + resource_type_group?: Array, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesSimilarList( + id, + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + ocw_topic, + offered_by, + platform, + professional, + resource_type, + resource_type_group, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesSimilarList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {PatchedLearningResourceRelationshipRequest} - * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + * Get a paginated list of learning resources with summary fields + * @summary Get learning resources summary + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningResourcesSummaryListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest -} - -/** - * Request parameters for learningResourcesList operation in LearningResourcesApi. - * @export - * @interface LearningResourcesApiLearningResourcesListRequest - */ -export interface LearningResourcesApiLearningResourcesListRequest { + async learningResourcesSummaryList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningResourcesSummaryListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesSummaryList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesSummaryList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof LearningResourcesApiLearningResourcesList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof LearningResourcesApiLearningResourcesList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesApiLearningResourcesList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesList + * Set User List Relationships on a given Learning Resource. + * @summary Set User List Relationships + * @param {number} id id of the learning resource + * @param {Array} [userlist_id] id of the parent user list + * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly free?: boolean - + async learningResourcesUserlistsPartialUpdate( + id: number, + userlist_id?: Array, + PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesUserlistsPartialUpdate( + id, + userlist_id, + PatchedUserListRelationshipRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesUserlistsPartialUpdate" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof LearningResourcesApiLearningResourcesList + * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources using vector embeddings + * @param {number} id + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [free] + * @param {Array} [level] + * @param {number} [limit] + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly level?: Array + async learningResourcesVectorSimilarList( + id: number, + certification?: boolean | null, + certification_type?: Array, + course_feature?: Array, + delivery?: Array, + department?: Array, + free?: boolean | null, + level?: Array, + limit?: number, + ocw_topic?: Array, + offered_by?: Array, + platform?: Array, + professional?: boolean | null, + resource_type?: Array, + resource_type_group?: Array, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesVectorSimilarList( + id, + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + ocw_topic, + offered_by, + platform, + professional, + resource_type, + resource_type_group, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesApi.learningResourcesVectorSimilarList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * LearningResourcesApi - factory interface + * @export + */ +export const LearningResourcesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningResourcesApiFp(configuration) + return { /** - * Number of results to return per page. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesList + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + learningResourcesContentfilesList( + requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesContentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof LearningResourcesApiLearningResourcesList + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offered_by?: Array - + learningResourcesContentfilesRetrieve( + requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesContentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesList + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + learningResourcesItemsList( + requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof LearningResourcesApiLearningResourcesList + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly platform?: Array - + learningResourcesItemsRetrieve( + requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesList + * Set Learning Path Relationships on a given Learning Resource. + * @summary Set Learning Path Relationships + * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean - + learningResourcesLearningPathsPartialUpdate( + requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesLearningPathsPartialUpdate( + requestParameters.id, + requestParameters.learning_path_id, + requestParameters.PatchedLearningResourceRelationshipRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * A unique text identifier for the resources - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesList + * Get a paginated list of learning resources. + * @summary List + * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly readable_id?: Array - + learningResourcesList( + requestParameters: LearningResourcesApiLearningResourcesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesList + * Retrieve a single learning resource. + * @summary Retrieve + * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array - + learningResourcesRetrieve( + requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof LearningResourcesApiLearningResourcesList + * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources + * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array - + learningResourcesSimilarList( + requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesSimilarList( + requestParameters.id, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.platform, + requestParameters.professional, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof LearningResourcesApiLearningResourcesList + * Get a paginated list of learning resources with summary fields + * @summary Get learning resources summary + * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + learningResourcesSummaryList( + requestParameters: LearningResourcesApiLearningResourcesSummaryListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesSummaryList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof LearningResourcesApiLearningResourcesList + * Set User List Relationships on a given Learning Resource. + * @summary Set User List Relationships + * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: LearningResourcesListSortbyEnum - + learningResourcesUserlistsPartialUpdate( + requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesUserlistsPartialUpdate( + requestParameters.id, + requestParameters.userlist_id, + requestParameters.PatchedUserListRelationshipRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesList + * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources using vector embeddings + * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array + learningResourcesVectorSimilarList( + requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesVectorSimilarList( + requestParameters.id, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.platform, + requestParameters.professional, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } /** - * Request parameters for learningResourcesRetrieve operation in LearningResourcesApi. + * Request parameters for learningResourcesContentfilesList operation in LearningResourcesApi. * @export - * @interface LearningResourcesApiLearningResourcesRetrieveRequest + * @interface LearningResourcesApiLearningResourcesContentfilesListRequest */ -export interface LearningResourcesApiLearningResourcesRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesRetrieve - */ - readonly id: number +export interface LearningResourcesApiLearningResourcesContentfilesListRequest { + /** + * id of the parent learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly learning_resource_id: number + + /** + * Content feature type for the content file. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly content_feature_type?: Array + + /** + * The edx module id of the content file + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly edx_module_id?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource the content file belongs to * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly offset?: number + + /** + * The platform on which learning resources the content file belongs to is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly platform?: Array + + /** + * The id of the learning resource the content file belongs to + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly resource_id?: Array + + /** + * The id of the learning resource run the content file belongs to + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesContentfilesList + */ + readonly run_id?: Array } /** - * Request parameters for learningResourcesSimilarList operation in LearningResourcesApi. + * Request parameters for learningResourcesContentfilesRetrieve operation in LearningResourcesApi. * @export - * @interface LearningResourcesApiLearningResourcesSimilarListRequest + * @interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest */ -export interface LearningResourcesApiLearningResourcesSimilarListRequest { - /** - * - * @type {number} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly id: number - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly certification_type?: Array - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly department?: Array +export interface LearningResourcesApiLearningResourcesContentfilesRetrieveRequest { + /** + * A unique integer value identifying this contentfile. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve + */ + readonly id: number - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly free?: boolean | null + /** + * id of the parent learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesContentfilesRetrieve + */ + readonly learning_resource_id: number +} - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly level?: Array +/** + * Request parameters for learningResourcesItemsList operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesItemsListRequest + */ +export interface LearningResourcesApiLearningResourcesItemsListRequest { + /** + * id of the parent learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesItemsList + */ + readonly learning_resource_id: number + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesItemsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesItemsList + */ + readonly offset?: number + + /** + * Which field to use when ordering the results. + * @type {string} + * @memberof LearningResourcesApiLearningResourcesItemsList + */ + readonly sortby?: string +} - /** - * - * @type {number} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly limit?: number +/** + * Request parameters for learningResourcesItemsRetrieve operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesItemsRetrieveRequest + */ +export interface LearningResourcesApiLearningResourcesItemsRetrieveRequest { + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesItemsRetrieve + */ + readonly id: number - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly ocw_topic?: Array + /** + * id of the parent learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesItemsRetrieve + */ + readonly learning_resource_id: number +} - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly offered_by?: Array +/** + * Request parameters for learningResourcesLearningPathsPartialUpdate operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest + */ +export interface LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest { + /** + * id of the learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + */ + readonly id: number - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly platform?: Array + /** + * id of the parent learning path + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + */ + readonly learning_path_id?: Array - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly professional?: boolean | null + /** + * + * @type {PatchedLearningResourceRelationshipRequest} + * @memberof LearningResourcesApiLearningResourcesLearningPathsPartialUpdate + */ + readonly PatchedLearningResourceRelationshipRequest?: PatchedLearningResourceRelationshipRequest +} - /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly resource_type?: Array +/** + * Request parameters for learningResourcesList operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesListRequest + */ +export interface LearningResourcesApiLearningResourcesListRequest { + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly sortby?: LearningResourcesListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesList + */ + readonly topic?: Array +} - /** - * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly resource_type_group?: Array +/** + * Request parameters for learningResourcesRetrieve operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesRetrieveRequest + */ +export interface LearningResourcesApiLearningResourcesRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesRetrieve + */ + readonly id: number +} - /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSimilarList - */ - readonly topic?: Array +/** + * Request parameters for learningResourcesSimilarList operation in LearningResourcesApi. + * @export + * @interface LearningResourcesApiLearningResourcesSimilarListRequest + */ +export interface LearningResourcesApiLearningResourcesSimilarListRequest { + /** + * + * @type {number} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly id: number + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly certification_type?: Array + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly department?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly free?: boolean | null + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly level?: Array + + /** + * + * @type {number} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly limit?: number + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly offered_by?: Array + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly professional?: boolean | null + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly resource_type?: Array + + /** + * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly resource_type_group?: Array + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSimilarList + */ + readonly topic?: Array } /** @@ -15740,131 +18157,131 @@ export interface LearningResourcesApiLearningResourcesSimilarListRequest { * @interface LearningResourcesApiLearningResourcesSummaryListRequest */ export interface LearningResourcesApiLearningResourcesSummaryListRequest { - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly resource_id?: Array - - /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly sortby?: LearningResourcesSummaryListSortbyEnum - - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesSummaryList - */ - readonly topic?: Array + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly sortby?: LearningResourcesSummaryListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesSummaryList + */ + readonly topic?: Array } /** @@ -15873,26 +18290,26 @@ export interface LearningResourcesApiLearningResourcesSummaryListRequest { * @interface LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest */ export interface LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest { - /** - * id of the learning resource - * @type {number} - * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate - */ - readonly id: number + /** + * id of the learning resource + * @type {number} + * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate + */ + readonly id: number - /** - * id of the parent user list - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate - */ - readonly userlist_id?: Array + /** + * id of the parent user list + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate + */ + readonly userlist_id?: Array - /** - * - * @type {PatchedUserListRelationshipRequest} - * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate - */ - readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest + /** + * + * @type {PatchedUserListRelationshipRequest} + * @memberof LearningResourcesApiLearningResourcesUserlistsPartialUpdate + */ + readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest } /** @@ -15901,118 +18318,118 @@ export interface LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequ * @interface LearningResourcesApiLearningResourcesVectorSimilarListRequest */ export interface LearningResourcesApiLearningResourcesVectorSimilarListRequest { - /** - * - * @type {number} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly id: number - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly certification_type?: Array - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly department?: Array - - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly free?: boolean | null - - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly level?: Array - - /** - * - * @type {number} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly limit?: number - - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly ocw_topic?: Array - - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly offered_by?: Array - - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly professional?: boolean | null - - /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly resource_type?: Array - - /** - * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly resource_type_group?: Array - - /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesApiLearningResourcesVectorSimilarList - */ - readonly topic?: Array -} + /** + * + * @type {number} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly id: number + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly certification_type?: Array + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly department?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly free?: boolean | null + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly level?: Array + + /** + * + * @type {number} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly limit?: number + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly offered_by?: Array + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly professional?: boolean | null + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly resource_type?: Array + + /** + * The category of learning resource * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly resource_type_group?: Array + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesApiLearningResourcesVectorSimilarList + */ + readonly topic?: Array +} /** * LearningResourcesApi - object-oriented interface @@ -16021,1031 +18438,1394 @@ export interface LearningResourcesApiLearningResourcesVectorSimilarListRequest { * @extends {BaseAPI} */ export class LearningResourcesApi extends BaseAPI { - /** - * Show content files for a learning resource - * @summary Learning Resource Content File List - * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesContentfilesList(requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesContentfilesList(requestParameters.learning_resource_id, requestParameters.content_feature_type, requestParameters.edx_module_id, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.resource_id, requestParameters.run_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Show content files for a learning resource - * @summary Learning Resource Content File Retrieve - * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesContentfilesRetrieve(requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesContentfilesRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesItemsList(requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesItemsRetrieve(requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Set Learning Path Relationships on a given Learning Resource. - * @summary Set Learning Path Relationships - * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesLearningPathsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesLearningPathsPartialUpdate(requestParameters.id, requestParameters.learning_path_id, requestParameters.PatchedLearningResourceRelationshipRequest, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a paginated list of learning resources. - * @summary List - * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesList(requestParameters: LearningResourcesApiLearningResourcesListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a single learning resource. - * @summary Retrieve - * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesRetrieve(requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources - * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesSimilarList(requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesSimilarList(requestParameters.id, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.platform, requestParameters.professional, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a paginated list of learning resources with summary fields - * @summary Get learning resources summary - * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesSummaryList(requestParameters: LearningResourcesApiLearningResourcesSummaryListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesSummaryList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Set User List Relationships on a given Learning Resource. - * @summary Set User List Relationships - * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesUserlistsPartialUpdate(requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesUserlistsPartialUpdate(requestParameters.id, requestParameters.userlist_id, requestParameters.PatchedUserListRelationshipRequest, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter - * @summary Get similar resources using vector embeddings - * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesApi - */ - public learningResourcesVectorSimilarList(requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesApiFp(this.configuration).learningResourcesVectorSimilarList(requestParameters.id, requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.platform, requestParameters.professional, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Show content files for a learning resource + * @summary Learning Resource Content File List + * @param {LearningResourcesApiLearningResourcesContentfilesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesContentfilesList( + requestParameters: LearningResourcesApiLearningResourcesContentfilesListRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesContentfilesList( + requestParameters.learning_resource_id, + requestParameters.content_feature_type, + requestParameters.edx_module_id, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.resource_id, + requestParameters.run_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Show content files for a learning resource + * @summary Learning Resource Content File Retrieve + * @param {LearningResourcesApiLearningResourcesContentfilesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesContentfilesRetrieve( + requestParameters: LearningResourcesApiLearningResourcesContentfilesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesContentfilesRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {LearningResourcesApiLearningResourcesItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesItemsList( + requestParameters: LearningResourcesApiLearningResourcesItemsListRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {LearningResourcesApiLearningResourcesItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesItemsRetrieve( + requestParameters: LearningResourcesApiLearningResourcesItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Set Learning Path Relationships on a given Learning Resource. + * @summary Set Learning Path Relationships + * @param {LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesLearningPathsPartialUpdate( + requestParameters: LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesLearningPathsPartialUpdate( + requestParameters.id, + requestParameters.learning_path_id, + requestParameters.PatchedLearningResourceRelationshipRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of learning resources. + * @summary List + * @param {LearningResourcesApiLearningResourcesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesList( + requestParameters: LearningResourcesApiLearningResourcesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single learning resource. + * @summary Retrieve + * @param {LearningResourcesApiLearningResourcesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesRetrieve( + requestParameters: LearningResourcesApiLearningResourcesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Fetch similar learning resources, optionally narrowed by filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources + * @param {LearningResourcesApiLearningResourcesSimilarListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesSimilarList( + requestParameters: LearningResourcesApiLearningResourcesSimilarListRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesSimilarList( + requestParameters.id, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.platform, + requestParameters.professional, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of learning resources with summary fields + * @summary Get learning resources summary + * @param {LearningResourcesApiLearningResourcesSummaryListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesSummaryList( + requestParameters: LearningResourcesApiLearningResourcesSummaryListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesSummaryList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Set User List Relationships on a given Learning Resource. + * @summary Set User List Relationships + * @param {LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesUserlistsPartialUpdate( + requestParameters: LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesUserlistsPartialUpdate( + requestParameters.id, + requestParameters.userlist_id, + requestParameters.PatchedUserListRelationshipRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Fetch similar learning resources, optionally narrowed by Qdrant filters. Args: id (integer): The id of the learning resource Returns: QuerySet of similar LearningResource for the resource matching the id parameter + * @summary Get similar resources using vector embeddings + * @param {LearningResourcesApiLearningResourcesVectorSimilarListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesApi + */ + public learningResourcesVectorSimilarList( + requestParameters: LearningResourcesApiLearningResourcesVectorSimilarListRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesApiFp(this.configuration) + .learningResourcesVectorSimilarList( + requestParameters.id, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.platform, + requestParameters.professional, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const LearningResourcesContentfilesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type LearningResourcesContentfilesListOfferedByEnum = typeof LearningResourcesContentfilesListOfferedByEnum[keyof typeof LearningResourcesContentfilesListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type LearningResourcesContentfilesListOfferedByEnum = + (typeof LearningResourcesContentfilesListOfferedByEnum)[keyof typeof LearningResourcesContentfilesListOfferedByEnum] /** * @export */ export const LearningResourcesContentfilesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type LearningResourcesContentfilesListPlatformEnum = typeof LearningResourcesContentfilesListPlatformEnum[keyof typeof LearningResourcesContentfilesListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type LearningResourcesContentfilesListPlatformEnum = + (typeof LearningResourcesContentfilesListPlatformEnum)[keyof typeof LearningResourcesContentfilesListPlatformEnum] /** * @export */ export const LearningResourcesListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type LearningResourcesListCertificationTypeEnum = typeof LearningResourcesListCertificationTypeEnum[keyof typeof LearningResourcesListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type LearningResourcesListCertificationTypeEnum = + (typeof LearningResourcesListCertificationTypeEnum)[keyof typeof LearningResourcesListCertificationTypeEnum] /** * @export */ export const LearningResourcesListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesListDeliveryEnum = typeof LearningResourcesListDeliveryEnum[keyof typeof LearningResourcesListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesListDeliveryEnum = + (typeof LearningResourcesListDeliveryEnum)[keyof typeof LearningResourcesListDeliveryEnum] /** * @export */ export const LearningResourcesListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesListDepartmentEnum = typeof LearningResourcesListDepartmentEnum[keyof typeof LearningResourcesListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesListDepartmentEnum = + (typeof LearningResourcesListDepartmentEnum)[keyof typeof LearningResourcesListDepartmentEnum] /** * @export */ export const LearningResourcesListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type LearningResourcesListLevelEnum = typeof LearningResourcesListLevelEnum[keyof typeof LearningResourcesListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type LearningResourcesListLevelEnum = + (typeof LearningResourcesListLevelEnum)[keyof typeof LearningResourcesListLevelEnum] /** * @export */ export const LearningResourcesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type LearningResourcesListOfferedByEnum = typeof LearningResourcesListOfferedByEnum[keyof typeof LearningResourcesListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type LearningResourcesListOfferedByEnum = + (typeof LearningResourcesListOfferedByEnum)[keyof typeof LearningResourcesListOfferedByEnum] /** * @export */ export const LearningResourcesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type LearningResourcesListPlatformEnum = typeof LearningResourcesListPlatformEnum[keyof typeof LearningResourcesListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type LearningResourcesListPlatformEnum = + (typeof LearningResourcesListPlatformEnum)[keyof typeof LearningResourcesListPlatformEnum] /** * @export */ export const LearningResourcesListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type LearningResourcesListResourceTypeEnum = typeof LearningResourcesListResourceTypeEnum[keyof typeof LearningResourcesListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type LearningResourcesListResourceTypeEnum = + (typeof LearningResourcesListResourceTypeEnum)[keyof typeof LearningResourcesListResourceTypeEnum] /** * @export */ export const LearningResourcesListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type LearningResourcesListResourceTypeGroupEnum = typeof LearningResourcesListResourceTypeGroupEnum[keyof typeof LearningResourcesListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type LearningResourcesListResourceTypeGroupEnum = + (typeof LearningResourcesListResourceTypeGroupEnum)[keyof typeof LearningResourcesListResourceTypeGroupEnum] /** * @export */ export const LearningResourcesListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type LearningResourcesListSortbyEnum = typeof LearningResourcesListSortbyEnum[keyof typeof LearningResourcesListSortbyEnum]; + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type LearningResourcesListSortbyEnum = + (typeof LearningResourcesListSortbyEnum)[keyof typeof LearningResourcesListSortbyEnum] /** * @export */ export const LearningResourcesSimilarListCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesSimilarListCertificationTypeEnum = typeof LearningResourcesSimilarListCertificationTypeEnum[keyof typeof LearningResourcesSimilarListCertificationTypeEnum]; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type LearningResourcesSimilarListCertificationTypeEnum = + (typeof LearningResourcesSimilarListCertificationTypeEnum)[keyof typeof LearningResourcesSimilarListCertificationTypeEnum] /** * @export */ export const LearningResourcesSimilarListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesSimilarListDeliveryEnum = typeof LearningResourcesSimilarListDeliveryEnum[keyof typeof LearningResourcesSimilarListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesSimilarListDeliveryEnum = + (typeof LearningResourcesSimilarListDeliveryEnum)[keyof typeof LearningResourcesSimilarListDeliveryEnum] /** * @export */ export const LearningResourcesSimilarListDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesSimilarListDepartmentEnum = typeof LearningResourcesSimilarListDepartmentEnum[keyof typeof LearningResourcesSimilarListDepartmentEnum]; + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesSimilarListDepartmentEnum = + (typeof LearningResourcesSimilarListDepartmentEnum)[keyof typeof LearningResourcesSimilarListDepartmentEnum] /** * @export */ export const LearningResourcesSimilarListLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesSimilarListLevelEnum = typeof LearningResourcesSimilarListLevelEnum[keyof typeof LearningResourcesSimilarListLevelEnum]; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesSimilarListLevelEnum = + (typeof LearningResourcesSimilarListLevelEnum)[keyof typeof LearningResourcesSimilarListLevelEnum] /** * @export */ export const LearningResourcesSimilarListOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesSimilarListOfferedByEnum = typeof LearningResourcesSimilarListOfferedByEnum[keyof typeof LearningResourcesSimilarListOfferedByEnum]; + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesSimilarListOfferedByEnum = + (typeof LearningResourcesSimilarListOfferedByEnum)[keyof typeof LearningResourcesSimilarListOfferedByEnum] /** * @export */ export const LearningResourcesSimilarListPlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesSimilarListPlatformEnum = typeof LearningResourcesSimilarListPlatformEnum[keyof typeof LearningResourcesSimilarListPlatformEnum]; + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesSimilarListPlatformEnum = + (typeof LearningResourcesSimilarListPlatformEnum)[keyof typeof LearningResourcesSimilarListPlatformEnum] /** * @export */ export const LearningResourcesSimilarListResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesSimilarListResourceTypeEnum = typeof LearningResourcesSimilarListResourceTypeEnum[keyof typeof LearningResourcesSimilarListResourceTypeEnum]; + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type LearningResourcesSimilarListResourceTypeEnum = + (typeof LearningResourcesSimilarListResourceTypeEnum)[keyof typeof LearningResourcesSimilarListResourceTypeEnum] /** * @export */ export const LearningResourcesSimilarListResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesSimilarListResourceTypeGroupEnum = typeof LearningResourcesSimilarListResourceTypeGroupEnum[keyof typeof LearningResourcesSimilarListResourceTypeGroupEnum]; + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type LearningResourcesSimilarListResourceTypeGroupEnum = + (typeof LearningResourcesSimilarListResourceTypeGroupEnum)[keyof typeof LearningResourcesSimilarListResourceTypeGroupEnum] /** * @export */ export const LearningResourcesSummaryListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type LearningResourcesSummaryListCertificationTypeEnum = typeof LearningResourcesSummaryListCertificationTypeEnum[keyof typeof LearningResourcesSummaryListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type LearningResourcesSummaryListCertificationTypeEnum = + (typeof LearningResourcesSummaryListCertificationTypeEnum)[keyof typeof LearningResourcesSummaryListCertificationTypeEnum] /** * @export */ export const LearningResourcesSummaryListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesSummaryListDeliveryEnum = typeof LearningResourcesSummaryListDeliveryEnum[keyof typeof LearningResourcesSummaryListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesSummaryListDeliveryEnum = + (typeof LearningResourcesSummaryListDeliveryEnum)[keyof typeof LearningResourcesSummaryListDeliveryEnum] /** * @export */ export const LearningResourcesSummaryListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesSummaryListDepartmentEnum = typeof LearningResourcesSummaryListDepartmentEnum[keyof typeof LearningResourcesSummaryListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesSummaryListDepartmentEnum = + (typeof LearningResourcesSummaryListDepartmentEnum)[keyof typeof LearningResourcesSummaryListDepartmentEnum] /** * @export */ export const LearningResourcesSummaryListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type LearningResourcesSummaryListLevelEnum = typeof LearningResourcesSummaryListLevelEnum[keyof typeof LearningResourcesSummaryListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type LearningResourcesSummaryListLevelEnum = + (typeof LearningResourcesSummaryListLevelEnum)[keyof typeof LearningResourcesSummaryListLevelEnum] /** * @export */ export const LearningResourcesSummaryListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type LearningResourcesSummaryListOfferedByEnum = typeof LearningResourcesSummaryListOfferedByEnum[keyof typeof LearningResourcesSummaryListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type LearningResourcesSummaryListOfferedByEnum = + (typeof LearningResourcesSummaryListOfferedByEnum)[keyof typeof LearningResourcesSummaryListOfferedByEnum] /** * @export */ export const LearningResourcesSummaryListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type LearningResourcesSummaryListPlatformEnum = typeof LearningResourcesSummaryListPlatformEnum[keyof typeof LearningResourcesSummaryListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type LearningResourcesSummaryListPlatformEnum = + (typeof LearningResourcesSummaryListPlatformEnum)[keyof typeof LearningResourcesSummaryListPlatformEnum] /** * @export */ export const LearningResourcesSummaryListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type LearningResourcesSummaryListResourceTypeEnum = typeof LearningResourcesSummaryListResourceTypeEnum[keyof typeof LearningResourcesSummaryListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type LearningResourcesSummaryListResourceTypeEnum = + (typeof LearningResourcesSummaryListResourceTypeEnum)[keyof typeof LearningResourcesSummaryListResourceTypeEnum] /** * @export */ export const LearningResourcesSummaryListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type LearningResourcesSummaryListResourceTypeGroupEnum = typeof LearningResourcesSummaryListResourceTypeGroupEnum[keyof typeof LearningResourcesSummaryListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type LearningResourcesSummaryListResourceTypeGroupEnum = + (typeof LearningResourcesSummaryListResourceTypeGroupEnum)[keyof typeof LearningResourcesSummaryListResourceTypeGroupEnum] /** * @export */ export const LearningResourcesSummaryListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type LearningResourcesSummaryListSortbyEnum = typeof LearningResourcesSummaryListSortbyEnum[keyof typeof LearningResourcesSummaryListSortbyEnum]; + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type LearningResourcesSummaryListSortbyEnum = + (typeof LearningResourcesSummaryListSortbyEnum)[keyof typeof LearningResourcesSummaryListSortbyEnum] /** * @export */ export const LearningResourcesVectorSimilarListCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesVectorSimilarListCertificationTypeEnum = typeof LearningResourcesVectorSimilarListCertificationTypeEnum[keyof typeof LearningResourcesVectorSimilarListCertificationTypeEnum]; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type LearningResourcesVectorSimilarListCertificationTypeEnum = + (typeof LearningResourcesVectorSimilarListCertificationTypeEnum)[keyof typeof LearningResourcesVectorSimilarListCertificationTypeEnum] /** * @export */ export const LearningResourcesVectorSimilarListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesVectorSimilarListDeliveryEnum = typeof LearningResourcesVectorSimilarListDeliveryEnum[keyof typeof LearningResourcesVectorSimilarListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesVectorSimilarListDeliveryEnum = + (typeof LearningResourcesVectorSimilarListDeliveryEnum)[keyof typeof LearningResourcesVectorSimilarListDeliveryEnum] /** * @export */ export const LearningResourcesVectorSimilarListDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesVectorSimilarListDepartmentEnum = typeof LearningResourcesVectorSimilarListDepartmentEnum[keyof typeof LearningResourcesVectorSimilarListDepartmentEnum]; + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesVectorSimilarListDepartmentEnum = + (typeof LearningResourcesVectorSimilarListDepartmentEnum)[keyof typeof LearningResourcesVectorSimilarListDepartmentEnum] /** * @export */ export const LearningResourcesVectorSimilarListLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesVectorSimilarListLevelEnum = typeof LearningResourcesVectorSimilarListLevelEnum[keyof typeof LearningResourcesVectorSimilarListLevelEnum]; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesVectorSimilarListLevelEnum = + (typeof LearningResourcesVectorSimilarListLevelEnum)[keyof typeof LearningResourcesVectorSimilarListLevelEnum] /** * @export */ export const LearningResourcesVectorSimilarListOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesVectorSimilarListOfferedByEnum = typeof LearningResourcesVectorSimilarListOfferedByEnum[keyof typeof LearningResourcesVectorSimilarListOfferedByEnum]; + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesVectorSimilarListOfferedByEnum = + (typeof LearningResourcesVectorSimilarListOfferedByEnum)[keyof typeof LearningResourcesVectorSimilarListOfferedByEnum] /** * @export */ export const LearningResourcesVectorSimilarListPlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesVectorSimilarListPlatformEnum = typeof LearningResourcesVectorSimilarListPlatformEnum[keyof typeof LearningResourcesVectorSimilarListPlatformEnum]; + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesVectorSimilarListPlatformEnum = + (typeof LearningResourcesVectorSimilarListPlatformEnum)[keyof typeof LearningResourcesVectorSimilarListPlatformEnum] /** * @export */ export const LearningResourcesVectorSimilarListResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesVectorSimilarListResourceTypeEnum = typeof LearningResourcesVectorSimilarListResourceTypeEnum[keyof typeof LearningResourcesVectorSimilarListResourceTypeEnum]; + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type LearningResourcesVectorSimilarListResourceTypeEnum = + (typeof LearningResourcesVectorSimilarListResourceTypeEnum)[keyof typeof LearningResourcesVectorSimilarListResourceTypeEnum] /** * @export */ export const LearningResourcesVectorSimilarListResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesVectorSimilarListResourceTypeGroupEnum = typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum[keyof typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum]; - + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type LearningResourcesVectorSimilarListResourceTypeGroupEnum = + (typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum)[keyof typeof LearningResourcesVectorSimilarListResourceTypeGroupEnum] /** * LearningResourcesSearchApi - axios parameter creator * @export */ -export const LearningResourcesSearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Search for learning resources - * @summary Search - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSearchRetrieve: async (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesSearchRetrieveSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources_search/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (content_file_score_weight !== undefined) { - localVarQueryParameter['content_file_score_weight'] = content_file_score_weight; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (dev_mode !== undefined) { - localVarQueryParameter['dev_mode'] = dev_mode; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (id) { - localVarQueryParameter['id'] = id; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (max_incompleteness_penalty !== undefined) { - localVarQueryParameter['max_incompleteness_penalty'] = max_incompleteness_penalty; - } - - if (min_score !== undefined) { - localVarQueryParameter['min_score'] = min_score; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_category) { - localVarQueryParameter['resource_category'] = resource_category; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (search_mode !== undefined) { - localVarQueryParameter['search_mode'] = search_mode; - } - - if (show_ocw_files !== undefined) { - localVarQueryParameter['show_ocw_files'] = show_ocw_files; - } +export const LearningResourcesSearchApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * Search for learning resources + * @summary Search + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + learningResourcesSearchRetrieve: async ( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesSearchRetrieveSortbyEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources_search/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (content_file_score_weight !== undefined) { + localVarQueryParameter["content_file_score_weight"] = + content_file_score_weight + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (dev_mode !== undefined) { + localVarQueryParameter["dev_mode"] = dev_mode + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (id) { + localVarQueryParameter["id"] = id + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (max_incompleteness_penalty !== undefined) { + localVarQueryParameter["max_incompleteness_penalty"] = + max_incompleteness_penalty + } + + if (min_score !== undefined) { + localVarQueryParameter["min_score"] = min_score + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_category) { + localVarQueryParameter["resource_category"] = resource_category + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (search_mode !== undefined) { + localVarQueryParameter["search_mode"] = search_mode + } - if (slop !== undefined) { - localVarQueryParameter['slop'] = slop; - } + if (show_ocw_files !== undefined) { + localVarQueryParameter["show_ocw_files"] = show_ocw_files + } - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } + if (slop !== undefined) { + localVarQueryParameter["slop"] = slop + } - if (topic) { - localVarQueryParameter['topic'] = topic; - } + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } - if (yearly_decay_percent !== undefined) { - localVarQueryParameter['yearly_decay_percent'] = yearly_decay_percent; - } + if (topic) { + localVarQueryParameter["topic"] = topic + } + if (yearly_decay_percent !== undefined) { + localVarQueryParameter["yearly_decay_percent"] = yearly_decay_percent + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} /** * LearningResourcesSearchApi - functional programming interface * @export */ -export const LearningResourcesSearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningResourcesSearchApiAxiosParamCreator(configuration) - return { - /** - * Search for learning resources - * @summary Search - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesSearchRetrieve(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesSearchRetrieveSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesSearchRetrieve(aggregations, certification, certification_type, content_file_score_weight, course_feature, delivery, department, dev_mode, free, id, level, limit, max_incompleteness_penalty, min_score, ocw_topic, offered_by, offset, platform, professional, q, resource_category, resource_type, resource_type_group, search_mode, show_ocw_files, slop, sortby, topic, yearly_decay_percent, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesSearchApi.learningResourcesSearchRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const LearningResourcesSearchApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + LearningResourcesSearchApiAxiosParamCreator(configuration) + return { + /** + * Search for learning resources + * @summary Search + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesSearchRetrieveSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesSearchRetrieveSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async learningResourcesSearchRetrieve( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesSearchRetrieveSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesSearchRetrieveSortbyEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesSearchRetrieve( + aggregations, + certification, + certification_type, + content_file_score_weight, + course_feature, + delivery, + department, + dev_mode, + free, + id, + level, + limit, + max_incompleteness_penalty, + min_score, + ocw_topic, + offered_by, + offset, + platform, + professional, + q, + resource_category, + resource_type, + resource_type_group, + search_mode, + show_ocw_files, + slop, + sortby, + topic, + yearly_decay_percent, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesSearchApi.learningResourcesSearchRetrieve" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** * LearningResourcesSearchApi - factory interface * @export */ -export const LearningResourcesSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningResourcesSearchApiFp(configuration) - return { - /** - * Search for learning resources - * @summary Search - * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesSearchRetrieve(requestParameters: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesSearchRetrieve(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const LearningResourcesSearchApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningResourcesSearchApiFp(configuration) + return { + /** + * Search for learning resources + * @summary Search + * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + learningResourcesSearchRetrieve( + requestParameters: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesSearchRetrieve( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} /** * Request parameters for learningResourcesSearchRetrieve operation in LearningResourcesSearchApi. @@ -17053,208 +19833,208 @@ export const LearningResourcesSearchApiFactory = function (configuration?: Confi * @interface LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest */ export interface LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest { - /** - * Show resource counts by category - * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly aggregations?: Array - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly certification_type?: Array - - /** - * Score weight for content file data. 1 is the default. 0 means content files are ignored - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly content_file_score_weight?: number | null - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly department?: Array - - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly dev_mode?: boolean | null - - /** - * - * @type {boolean} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly free?: boolean | null - - /** - * The id value for the learning resource - * @type {Array} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly id?: Array - - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly level?: Array - - /** - * Number of results to return per page - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly limit?: number - - /** - * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly max_incompleteness_penalty?: number | null - - /** - * Minimum score value a text query result needs to have to be displayed - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly min_score?: number | null - - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly ocw_topic?: Array - - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly offset?: number - - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly professional?: boolean | null - - /** - * The search text - * @type {string} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly q?: string - - /** - * The resource category for the resource - * @type {Array} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly resource_category?: Array - - /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly resource_type?: Array - - /** - * - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly resource_type_group?: Array - - /** - * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly search_mode?: LearningResourcesSearchRetrieveSearchModeEnum - - /** - * Whether to include select OCW content files in search results. - * @type {boolean} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly show_ocw_files?: boolean | null - - /** - * Allowed distance for phrase search - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly slop?: number | null - - /** - * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly sortby?: LearningResourcesSearchRetrieveSortbyEnum - - /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly topic?: Array - - /** - * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve - */ - readonly yearly_decay_percent?: number | null + /** + * Show resource counts by category + * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly aggregations?: Array + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly certification_type?: Array + + /** + * Score weight for content file data. 1 is the default. 0 means content files are ignored + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly content_file_score_weight?: number | null + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly department?: Array + + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly dev_mode?: boolean | null + + /** + * + * @type {boolean} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly free?: boolean | null + + /** + * The id value for the learning resource + * @type {Array} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly id?: Array + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly level?: Array + + /** + * Number of results to return per page + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly limit?: number + + /** + * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly max_incompleteness_penalty?: number | null + + /** + * Minimum score value a text query result needs to have to be displayed + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly min_score?: number | null + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly offset?: number + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly professional?: boolean | null + + /** + * The search text + * @type {string} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly q?: string + + /** + * The resource category for the resource + * @type {Array} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly resource_category?: Array + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly resource_type?: Array + + /** + * + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly resource_type_group?: Array + + /** + * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly search_mode?: LearningResourcesSearchRetrieveSearchModeEnum + + /** + * Whether to include select OCW content files in search results. + * @type {boolean} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly show_ocw_files?: boolean | null + + /** + * Allowed distance for phrase search + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly slop?: number | null + + /** + * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly sortby?: LearningResourcesSearchRetrieveSortbyEnum + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly topic?: Array + + /** + * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesSearchApiLearningResourcesSearchRetrieve + */ + readonly yearly_decay_percent?: number | null } /** @@ -17264,1207 +20044,1777 @@ export interface LearningResourcesSearchApiLearningResourcesSearchRetrieveReques * @extends {BaseAPI} */ export class LearningResourcesSearchApi extends BaseAPI { - /** - * Search for learning resources - * @summary Search - * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LearningResourcesSearchApi - */ - public learningResourcesSearchRetrieve(requestParameters: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesSearchApiFp(this.configuration).learningResourcesSearchRetrieve(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Search for learning resources + * @summary Search + * @param {LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesSearchApi + */ + public learningResourcesSearchRetrieve( + requestParameters: LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesSearchApiFp(this.configuration) + .learningResourcesSearchRetrieve( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const LearningResourcesSearchRetrieveAggregationsEnum = { - ResourceType: 'resource_type', - Certification: 'certification', - CertificationType: 'certification_type', - OfferedBy: 'offered_by', - Platform: 'platform', - Topic: 'topic', - Department: 'department', - Level: 'level', - CourseFeature: 'course_feature', - Professional: 'professional', - Free: 'free', - Delivery: 'delivery', - ResourceTypeGroup: 'resource_type_group', - ResourceCategory: 'resource_category' -} as const; -export type LearningResourcesSearchRetrieveAggregationsEnum = typeof LearningResourcesSearchRetrieveAggregationsEnum[keyof typeof LearningResourcesSearchRetrieveAggregationsEnum]; + ResourceType: "resource_type", + Certification: "certification", + CertificationType: "certification_type", + OfferedBy: "offered_by", + Platform: "platform", + Topic: "topic", + Department: "department", + Level: "level", + CourseFeature: "course_feature", + Professional: "professional", + Free: "free", + Delivery: "delivery", + ResourceTypeGroup: "resource_type_group", + ResourceCategory: "resource_category", +} as const +export type LearningResourcesSearchRetrieveAggregationsEnum = + (typeof LearningResourcesSearchRetrieveAggregationsEnum)[keyof typeof LearningResourcesSearchRetrieveAggregationsEnum] /** * @export */ export const LearningResourcesSearchRetrieveCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesSearchRetrieveCertificationTypeEnum = typeof LearningResourcesSearchRetrieveCertificationTypeEnum[keyof typeof LearningResourcesSearchRetrieveCertificationTypeEnum]; + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type LearningResourcesSearchRetrieveCertificationTypeEnum = + (typeof LearningResourcesSearchRetrieveCertificationTypeEnum)[keyof typeof LearningResourcesSearchRetrieveCertificationTypeEnum] /** * @export */ export const LearningResourcesSearchRetrieveDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesSearchRetrieveDeliveryEnum = typeof LearningResourcesSearchRetrieveDeliveryEnum[keyof typeof LearningResourcesSearchRetrieveDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesSearchRetrieveDeliveryEnum = + (typeof LearningResourcesSearchRetrieveDeliveryEnum)[keyof typeof LearningResourcesSearchRetrieveDeliveryEnum] /** * @export */ export const LearningResourcesSearchRetrieveDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesSearchRetrieveDepartmentEnum = typeof LearningResourcesSearchRetrieveDepartmentEnum[keyof typeof LearningResourcesSearchRetrieveDepartmentEnum]; + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesSearchRetrieveDepartmentEnum = + (typeof LearningResourcesSearchRetrieveDepartmentEnum)[keyof typeof LearningResourcesSearchRetrieveDepartmentEnum] /** * @export */ export const LearningResourcesSearchRetrieveLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesSearchRetrieveLevelEnum = typeof LearningResourcesSearchRetrieveLevelEnum[keyof typeof LearningResourcesSearchRetrieveLevelEnum]; + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesSearchRetrieveLevelEnum = + (typeof LearningResourcesSearchRetrieveLevelEnum)[keyof typeof LearningResourcesSearchRetrieveLevelEnum] /** * @export */ export const LearningResourcesSearchRetrieveOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesSearchRetrieveOfferedByEnum = typeof LearningResourcesSearchRetrieveOfferedByEnum[keyof typeof LearningResourcesSearchRetrieveOfferedByEnum]; + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesSearchRetrieveOfferedByEnum = + (typeof LearningResourcesSearchRetrieveOfferedByEnum)[keyof typeof LearningResourcesSearchRetrieveOfferedByEnum] /** * @export */ export const LearningResourcesSearchRetrievePlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesSearchRetrievePlatformEnum = typeof LearningResourcesSearchRetrievePlatformEnum[keyof typeof LearningResourcesSearchRetrievePlatformEnum]; + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesSearchRetrievePlatformEnum = + (typeof LearningResourcesSearchRetrievePlatformEnum)[keyof typeof LearningResourcesSearchRetrievePlatformEnum] /** * @export */ export const LearningResourcesSearchRetrieveResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesSearchRetrieveResourceTypeEnum = typeof LearningResourcesSearchRetrieveResourceTypeEnum[keyof typeof LearningResourcesSearchRetrieveResourceTypeEnum]; + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type LearningResourcesSearchRetrieveResourceTypeEnum = + (typeof LearningResourcesSearchRetrieveResourceTypeEnum)[keyof typeof LearningResourcesSearchRetrieveResourceTypeEnum] /** * @export */ export const LearningResourcesSearchRetrieveResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesSearchRetrieveResourceTypeGroupEnum = typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum[keyof typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum]; + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type LearningResourcesSearchRetrieveResourceTypeGroupEnum = + (typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum)[keyof typeof LearningResourcesSearchRetrieveResourceTypeGroupEnum] /** * @export */ export const LearningResourcesSearchRetrieveSearchModeEnum = { - Phrase: 'phrase', - BestFields: 'best_fields', - MostFields: 'most_fields', - Hybrid: 'hybrid' -} as const; -export type LearningResourcesSearchRetrieveSearchModeEnum = typeof LearningResourcesSearchRetrieveSearchModeEnum[keyof typeof LearningResourcesSearchRetrieveSearchModeEnum]; + Phrase: "phrase", + BestFields: "best_fields", + MostFields: "most_fields", + Hybrid: "hybrid", +} as const +export type LearningResourcesSearchRetrieveSearchModeEnum = + (typeof LearningResourcesSearchRetrieveSearchModeEnum)[keyof typeof LearningResourcesSearchRetrieveSearchModeEnum] /** * @export */ export const LearningResourcesSearchRetrieveSortbyEnum = { - Featured: 'featured', - Id: 'id', - Id2: '-id', - ReadableId: 'readable_id', - ReadableId2: '-readable_id', - LastModified: 'last_modified', - LastModified2: '-last_modified', - New: 'new', - StartDate: 'start_date', - StartDate2: '-start_date', - Mitcoursenumber: 'mitcoursenumber', - Mitcoursenumber2: '-mitcoursenumber', - Views: 'views', - Views2: '-views', - Upcoming: 'upcoming' -} as const; -export type LearningResourcesSearchRetrieveSortbyEnum = typeof LearningResourcesSearchRetrieveSortbyEnum[keyof typeof LearningResourcesSearchRetrieveSortbyEnum]; - + Featured: "featured", + Id: "id", + Id2: "-id", + ReadableId: "readable_id", + ReadableId2: "-readable_id", + LastModified: "last_modified", + LastModified2: "-last_modified", + New: "new", + StartDate: "start_date", + StartDate2: "-start_date", + Mitcoursenumber: "mitcoursenumber", + Mitcoursenumber2: "-mitcoursenumber", + Views: "views", + Views2: "-views", + Upcoming: "upcoming", +} as const +export type LearningResourcesSearchRetrieveSortbyEnum = + (typeof LearningResourcesSearchRetrieveSortbyEnum)[keyof typeof LearningResourcesSearchRetrieveSortbyEnum] /** * LearningResourcesUserSubscriptionApi - axios parameter creator * @export */ -export const LearningResourcesUserSubscriptionApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * View for listing percolate query subscriptions for a user - * @summary Check if a user is subscribed to a specific query - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionCheckList: async (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources_user_subscription/check/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (content_file_score_weight !== undefined) { - localVarQueryParameter['content_file_score_weight'] = content_file_score_weight; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (dev_mode !== undefined) { - localVarQueryParameter['dev_mode'] = dev_mode; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (id) { - localVarQueryParameter['id'] = id; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (max_incompleteness_penalty !== undefined) { - localVarQueryParameter['max_incompleteness_penalty'] = max_incompleteness_penalty; - } - - if (min_score !== undefined) { - localVarQueryParameter['min_score'] = min_score; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_category) { - localVarQueryParameter['resource_category'] = resource_category; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (search_mode !== undefined) { - localVarQueryParameter['search_mode'] = search_mode; - } - - if (show_ocw_files !== undefined) { - localVarQueryParameter['show_ocw_files'] = show_ocw_files; - } - - if (slop !== undefined) { - localVarQueryParameter['slop'] = slop; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (source_type !== undefined) { - localVarQueryParameter['source_type'] = source_type; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - if (yearly_decay_percent !== undefined) { - localVarQueryParameter['yearly_decay_percent'] = yearly_decay_percent; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * View for listing percolate query subscriptions for a user - * @summary List subscribed queries - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionList: async (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionListSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources_user_subscription/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (content_file_score_weight !== undefined) { - localVarQueryParameter['content_file_score_weight'] = content_file_score_weight; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (dev_mode !== undefined) { - localVarQueryParameter['dev_mode'] = dev_mode; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (id) { - localVarQueryParameter['id'] = id; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (max_incompleteness_penalty !== undefined) { - localVarQueryParameter['max_incompleteness_penalty'] = max_incompleteness_penalty; - } - - if (min_score !== undefined) { - localVarQueryParameter['min_score'] = min_score; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_category) { - localVarQueryParameter['resource_category'] = resource_category; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (search_mode !== undefined) { - localVarQueryParameter['search_mode'] = search_mode; - } - - if (show_ocw_files !== undefined) { - localVarQueryParameter['show_ocw_files'] = show_ocw_files; - } - - if (slop !== undefined) { - localVarQueryParameter['slop'] = slop; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - if (yearly_decay_percent !== undefined) { - localVarQueryParameter['yearly_decay_percent'] = yearly_decay_percent; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Subscribe a user to query - * @summary Subscribe user to query - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionSubscribeCreate: async (aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learning_resources_user_subscription/subscribe/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (aggregations) { - localVarQueryParameter['aggregations'] = aggregations; - } - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (content_file_score_weight !== undefined) { - localVarQueryParameter['content_file_score_weight'] = content_file_score_weight; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (dev_mode !== undefined) { - localVarQueryParameter['dev_mode'] = dev_mode; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (id) { - localVarQueryParameter['id'] = id; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (max_incompleteness_penalty !== undefined) { - localVarQueryParameter['max_incompleteness_penalty'] = max_incompleteness_penalty; - } - - if (min_score !== undefined) { - localVarQueryParameter['min_score'] = min_score; - } - - if (ocw_topic) { - localVarQueryParameter['ocw_topic'] = ocw_topic; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (q !== undefined) { - localVarQueryParameter['q'] = q; - } - - if (resource_category) { - localVarQueryParameter['resource_category'] = resource_category; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (search_mode !== undefined) { - localVarQueryParameter['search_mode'] = search_mode; - } - - if (show_ocw_files !== undefined) { - localVarQueryParameter['show_ocw_files'] = show_ocw_files; - } - - if (slop !== undefined) { - localVarQueryParameter['slop'] = slop; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (source_type !== undefined) { - localVarQueryParameter['source_type'] = source_type; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - if (yearly_decay_percent !== undefined) { - localVarQueryParameter['yearly_decay_percent'] = yearly_decay_percent; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PercolateQuerySubscriptionRequestRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query - * @summary Unsubscribe user from query - * @param {number} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionUnsubscribeDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningResourcesUserSubscriptionUnsubscribeDestroy', 'id', id) - const localVarPath = `/api/v1/learning_resources_user_subscription/{id}/unsubscribe/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * LearningResourcesUserSubscriptionApi - functional programming interface - * @export - */ -export const LearningResourcesUserSubscriptionApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningResourcesUserSubscriptionApiAxiosParamCreator(configuration) - return { - /** - * View for listing percolate query subscriptions for a user - * @summary Check if a user is subscribed to a specific query - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesUserSubscriptionCheckList(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesUserSubscriptionCheckList(aggregations, certification, certification_type, content_file_score_weight, course_feature, delivery, department, dev_mode, free, id, level, limit, max_incompleteness_penalty, min_score, ocw_topic, offered_by, offset, platform, professional, q, resource_category, resource_type, resource_type_group, search_mode, show_ocw_files, slop, sortby, source_type, topic, yearly_decay_percent, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionCheckList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * View for listing percolate query subscriptions for a user - * @summary List subscribed queries - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesUserSubscriptionList(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionListSortbyEnum, topic?: Array, yearly_decay_percent?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesUserSubscriptionList(aggregations, certification, certification_type, content_file_score_weight, course_feature, delivery, department, dev_mode, free, id, level, limit, max_incompleteness_penalty, min_score, ocw_topic, offered_by, offset, platform, professional, q, resource_category, resource_type, resource_type_group, search_mode, show_ocw_files, slop, sortby, topic, yearly_decay_percent, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Subscribe a user to query - * @summary Subscribe user to query - * @param {Array} [aggregations] Show resource counts by category - * @param {boolean | null} [certification] True if the learning resource offers a certificate - * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored - * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ - * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations - * @param {boolean | null} [free] - * @param {Array} [id] The id value for the learning resource - * @param {Array} [level] - * @param {number} [limit] Number of results to return per page - * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed - * @param {Array} [ocw_topic] The ocw topic name. - * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results - * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean | null} [professional] - * @param {string} [q] The search text - * @param {Array} [resource_category] The resource category for the resource - * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @param {Array} [resource_type_group] - * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. - * @param {number | null} [slop] Allowed distance for phrase search - * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ - * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesUserSubscriptionSubscribeCreate(aggregations?: Array, certification?: boolean | null, certification_type?: Array, content_file_score_weight?: number | null, course_feature?: Array, delivery?: Array, department?: Array, dev_mode?: boolean | null, free?: boolean | null, id?: Array, level?: Array, limit?: number, max_incompleteness_penalty?: number | null, min_score?: number | null, ocw_topic?: Array, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean | null, q?: string, resource_category?: Array, resource_type?: Array, resource_type_group?: Array, search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, show_ocw_files?: boolean | null, slop?: number | null, sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, topic?: Array, yearly_decay_percent?: number | null, PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesUserSubscriptionSubscribeCreate(aggregations, certification, certification_type, content_file_score_weight, course_feature, delivery, department, dev_mode, free, id, level, limit, max_incompleteness_penalty, min_score, ocw_topic, offered_by, offset, platform, professional, q, resource_category, resource_type, resource_type_group, search_mode, show_ocw_files, slop, sortby, source_type, topic, yearly_decay_percent, PercolateQuerySubscriptionRequestRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionSubscribeCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query - * @summary Unsubscribe user from query - * @param {number} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningResourcesUserSubscriptionUnsubscribeDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningResourcesUserSubscriptionUnsubscribeDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionUnsubscribeDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * LearningResourcesUserSubscriptionApi - factory interface - * @export - */ -export const LearningResourcesUserSubscriptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningResourcesUserSubscriptionApiFp(configuration) - return { - /** - * View for listing percolate query subscriptions for a user - * @summary Check if a user is subscribed to a specific query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionCheckList(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesUserSubscriptionCheckList(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.source_type, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(axios, basePath)); - }, - /** - * View for listing percolate query subscriptions for a user - * @summary List subscribed queries - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionList(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningResourcesUserSubscriptionList(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(axios, basePath)); - }, - /** - * Subscribe a user to query - * @summary Subscribe user to query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionSubscribeCreate(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesUserSubscriptionSubscribeCreate(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.source_type, requestParameters.topic, requestParameters.yearly_decay_percent, requestParameters.PercolateQuerySubscriptionRequestRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query - * @summary Unsubscribe user from query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for learningResourcesUserSubscriptionCheckList operation in LearningResourcesUserSubscriptionApi. - * @export - * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest - */ -export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest { - /** - * Show resource counts by category - * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly aggregations?: Array - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly certification_type?: Array - - /** - * Score weight for content file data. 1 is the default. 0 means content files are ignored - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly content_file_score_weight?: number | null - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly department?: Array - - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly dev_mode?: boolean | null - - /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly free?: boolean | null - +export const LearningResourcesUserSubscriptionApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The id value for the learning resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly id?: Array - - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly level?: Array - - /** - * Number of results to return per page - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly limit?: number - - /** - * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly max_incompleteness_penalty?: number | null - - /** - * Minimum score value a text query result needs to have to be displayed - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly min_score?: number | null - - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly ocw_topic?: Array - - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly offset?: number - - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary Check if a user is subscribed to a specific query + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly platform?: Array - + learningResourcesUserSubscriptionCheckList: async ( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, + source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources_user_subscription/check/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (content_file_score_weight !== undefined) { + localVarQueryParameter["content_file_score_weight"] = + content_file_score_weight + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (dev_mode !== undefined) { + localVarQueryParameter["dev_mode"] = dev_mode + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (id) { + localVarQueryParameter["id"] = id + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (max_incompleteness_penalty !== undefined) { + localVarQueryParameter["max_incompleteness_penalty"] = + max_incompleteness_penalty + } + + if (min_score !== undefined) { + localVarQueryParameter["min_score"] = min_score + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_category) { + localVarQueryParameter["resource_category"] = resource_category + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (search_mode !== undefined) { + localVarQueryParameter["search_mode"] = search_mode + } + + if (show_ocw_files !== undefined) { + localVarQueryParameter["show_ocw_files"] = show_ocw_files + } + + if (slop !== undefined) { + localVarQueryParameter["slop"] = slop + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (source_type !== undefined) { + localVarQueryParameter["source_type"] = source_type + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + if (yearly_decay_percent !== undefined) { + localVarQueryParameter["yearly_decay_percent"] = yearly_decay_percent + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary List subscribed queries + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean | null - + learningResourcesUserSubscriptionList: async ( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionListSortbyEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources_user_subscription/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (content_file_score_weight !== undefined) { + localVarQueryParameter["content_file_score_weight"] = + content_file_score_weight + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (dev_mode !== undefined) { + localVarQueryParameter["dev_mode"] = dev_mode + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (id) { + localVarQueryParameter["id"] = id + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (max_incompleteness_penalty !== undefined) { + localVarQueryParameter["max_incompleteness_penalty"] = + max_incompleteness_penalty + } + + if (min_score !== undefined) { + localVarQueryParameter["min_score"] = min_score + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_category) { + localVarQueryParameter["resource_category"] = resource_category + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (search_mode !== undefined) { + localVarQueryParameter["search_mode"] = search_mode + } + + if (show_ocw_files !== undefined) { + localVarQueryParameter["show_ocw_files"] = show_ocw_files + } + + if (slop !== undefined) { + localVarQueryParameter["slop"] = slop + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + if (yearly_decay_percent !== undefined) { + localVarQueryParameter["yearly_decay_percent"] = yearly_decay_percent + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The search text - * @type {string} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Subscribe a user to query + * @summary Subscribe user to query + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly q?: string - + learningResourcesUserSubscriptionSubscribeCreate: async ( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, + source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, + topic?: Array, + yearly_decay_percent?: number | null, + PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learning_resources_user_subscription/subscribe/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (aggregations) { + localVarQueryParameter["aggregations"] = aggregations + } + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (content_file_score_weight !== undefined) { + localVarQueryParameter["content_file_score_weight"] = + content_file_score_weight + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (dev_mode !== undefined) { + localVarQueryParameter["dev_mode"] = dev_mode + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (id) { + localVarQueryParameter["id"] = id + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (max_incompleteness_penalty !== undefined) { + localVarQueryParameter["max_incompleteness_penalty"] = + max_incompleteness_penalty + } + + if (min_score !== undefined) { + localVarQueryParameter["min_score"] = min_score + } + + if (ocw_topic) { + localVarQueryParameter["ocw_topic"] = ocw_topic + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (q !== undefined) { + localVarQueryParameter["q"] = q + } + + if (resource_category) { + localVarQueryParameter["resource_category"] = resource_category + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (search_mode !== undefined) { + localVarQueryParameter["search_mode"] = search_mode + } + + if (show_ocw_files !== undefined) { + localVarQueryParameter["show_ocw_files"] = show_ocw_files + } + + if (slop !== undefined) { + localVarQueryParameter["slop"] = slop + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (source_type !== undefined) { + localVarQueryParameter["source_type"] = source_type + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + if (yearly_decay_percent !== undefined) { + localVarQueryParameter["yearly_decay_percent"] = yearly_decay_percent + } + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PercolateQuerySubscriptionRequestRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The resource category for the resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query + * @summary Unsubscribe user from query + * @param {number} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_category?: Array + learningResourcesUserSubscriptionUnsubscribeDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists( + "learningResourcesUserSubscriptionUnsubscribeDestroy", + "id", + id, + ) + const localVarPath = + `/api/v1/learning_resources_user_subscription/{id}/unsubscribe/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * LearningResourcesUserSubscriptionApi - functional programming interface + * @export + */ +export const LearningResourcesUserSubscriptionApiFp = function ( + configuration?: Configuration, +) { + const localVarAxiosParamCreator = + LearningResourcesUserSubscriptionApiAxiosParamCreator(configuration) + return { /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary Check if a user is subscribed to a specific query + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionCheckListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionCheckListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {LearningResourcesUserSubscriptionCheckListSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array - + async learningResourcesUserSubscriptionCheckList( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum, + source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesUserSubscriptionCheckList( + aggregations, + certification, + certification_type, + content_file_score_weight, + course_feature, + delivery, + department, + dev_mode, + free, + id, + level, + limit, + max_incompleteness_penalty, + min_score, + ocw_topic, + offered_by, + offset, + platform, + professional, + q, + resource_category, + resource_type, + resource_type_group, + search_mode, + show_ocw_files, + slop, + sortby, + source_type, + topic, + yearly_decay_percent, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionCheckList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary List subscribed queries + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionListSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionListSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + async learningResourcesUserSubscriptionList( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionListSortbyEnum, + topic?: Array, + yearly_decay_percent?: number | null, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesUserSubscriptionList( + aggregations, + certification, + certification_type, + content_file_score_weight, + course_feature, + delivery, + department, + dev_mode, + free, + id, + level, + limit, + max_incompleteness_penalty, + min_score, + ocw_topic, + offered_by, + offset, + platform, + professional, + q, + resource_category, + resource_type, + resource_type_group, + search_mode, + show_ocw_files, + slop, + sortby, + topic, + yearly_decay_percent, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionList" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Subscribe a user to query + * @summary Subscribe user to query + * @param {Array} [aggregations] Show resource counts by category + * @param {boolean | null} [certification] True if the learning resource offers a certificate + * @param {Array} [certification_type] The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {number | null} [content_file_score_weight] Score weight for content file data. 1 is the default. 0 means content files are ignored + * @param {Array} [course_feature] The course feature. Possible options are at api/v1/course_features/ + * @param {Array} [delivery] The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean | null} [dev_mode] If true return raw open search results with score explanations + * @param {boolean | null} [free] + * @param {Array} [id] The id value for the learning resource + * @param {Array} [level] + * @param {number} [limit] Number of results to return per page + * @param {number | null} [max_incompleteness_penalty] Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @param {number | null} [min_score] Minimum score value a text query result needs to have to be displayed + * @param {Array} [ocw_topic] The ocw topic name. + * @param {Array} [offered_by] The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results + * @param {Array} [platform] The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean | null} [professional] + * @param {string} [q] The search text + * @param {Array} [resource_category] The resource category for the resource + * @param {Array} [resource_type] The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @param {Array} [resource_type_group] + * @param {LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum} [search_mode] The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @param {boolean | null} [show_ocw_files] Whether to include select OCW content files in search results. + * @param {number | null} [slop] Allowed distance for phrase search + * @param {LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum} [sortby] If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum} [source_type] The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @param {Array} [topic] The topic name. To see a list of options go to api/v1/topics/ + * @param {number | null} [yearly_decay_percent] Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @param {PercolateQuerySubscriptionRequestRequest} [PercolateQuerySubscriptionRequestRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum - + async learningResourcesUserSubscriptionSubscribeCreate( + aggregations?: Array, + certification?: boolean | null, + certification_type?: Array, + content_file_score_weight?: number | null, + course_feature?: Array, + delivery?: Array, + department?: Array, + dev_mode?: boolean | null, + free?: boolean | null, + id?: Array, + level?: Array, + limit?: number, + max_incompleteness_penalty?: number | null, + min_score?: number | null, + ocw_topic?: Array, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean | null, + q?: string, + resource_category?: Array, + resource_type?: Array, + resource_type_group?: Array, + search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum, + show_ocw_files?: boolean | null, + slop?: number | null, + sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum, + source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum, + topic?: Array, + yearly_decay_percent?: number | null, + PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesUserSubscriptionSubscribeCreate( + aggregations, + certification, + certification_type, + content_file_score_weight, + course_feature, + delivery, + department, + dev_mode, + free, + id, + level, + limit, + max_incompleteness_penalty, + min_score, + ocw_topic, + offered_by, + offset, + platform, + professional, + q, + resource_category, + resource_type, + resource_type_group, + search_mode, + show_ocw_files, + slop, + sortby, + source_type, + topic, + yearly_decay_percent, + PercolateQuerySubscriptionRequestRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionSubscribeCreate" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Whether to include select OCW content files in search results. - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query + * @summary Unsubscribe user from query + * @param {number} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly show_ocw_files?: boolean | null + async learningResourcesUserSubscriptionUnsubscribeDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningResourcesUserSubscriptionUnsubscribeDestroy( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningResourcesUserSubscriptionApi.learningResourcesUserSubscriptionUnsubscribeDestroy" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * LearningResourcesUserSubscriptionApi - factory interface + * @export + */ +export const LearningResourcesUserSubscriptionApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningResourcesUserSubscriptionApiFp(configuration) + return { /** - * Allowed distance for phrase search - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary Check if a user is subscribed to a specific query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly slop?: number | null - + learningResourcesUserSubscriptionCheckList( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesUserSubscriptionCheckList( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.source_type, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * View for listing percolate query subscriptions for a user + * @summary List subscribed queries + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum - + learningResourcesUserSubscriptionList( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningResourcesUserSubscriptionList( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @type {'search_subscription_type' | 'channel_subscription_type'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Subscribe a user to query + * @summary Subscribe user to query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum - + learningResourcesUserSubscriptionSubscribeCreate( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesUserSubscriptionSubscribeCreate( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.source_type, + requestParameters.topic, + requestParameters.yearly_decay_percent, + requestParameters.PercolateQuerySubscriptionRequestRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query + * @summary Unsubscribe user from query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array + learningResourcesUserSubscriptionUnsubscribeDestroy( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningResourcesUserSubscriptionUnsubscribeDestroy( + requestParameters.id, + options, + ) + .then((request) => request(axios, basePath)) + }, + } +} - /** - * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList - */ - readonly yearly_decay_percent?: number | null +/** + * Request parameters for learningResourcesUserSubscriptionCheckList operation in LearningResourcesUserSubscriptionApi. + * @export + * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest + */ +export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest { + /** + * Show resource counts by category + * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly aggregations?: Array + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly certification_type?: Array + + /** + * Score weight for content file data. 1 is the default. 0 means content files are ignored + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly content_file_score_weight?: number | null + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly department?: Array + + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly dev_mode?: boolean | null + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly free?: boolean | null + + /** + * The id value for the learning resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly id?: Array + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly level?: Array + + /** + * Number of results to return per page + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly limit?: number + + /** + * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly max_incompleteness_penalty?: number | null + + /** + * Minimum score value a text query result needs to have to be displayed + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly min_score?: number | null + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly offset?: number + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly professional?: boolean | null + + /** + * The search text + * @type {string} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly q?: string + + /** + * The resource category for the resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly resource_category?: Array + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly resource_type?: Array + + /** + * + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly resource_type_group?: Array + + /** + * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly search_mode?: LearningResourcesUserSubscriptionCheckListSearchModeEnum + + /** + * Whether to include select OCW content files in search results. + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly show_ocw_files?: boolean | null + + /** + * Allowed distance for phrase search + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly slop?: number | null + + /** + * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly sortby?: LearningResourcesUserSubscriptionCheckListSortbyEnum + + /** + * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @type {'search_subscription_type' | 'channel_subscription_type'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly source_type?: LearningResourcesUserSubscriptionCheckListSourceTypeEnum + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly topic?: Array + + /** + * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckList + */ + readonly yearly_decay_percent?: number | null } /** @@ -18473,6363 +21823,8770 @@ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscr * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest */ export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest { - /** - * Show resource counts by category - * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly aggregations?: Array - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly certification_type?: Array - - /** - * Score weight for content file data. 1 is the default. 0 means content files are ignored - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly content_file_score_weight?: number | null - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly department?: Array - - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly dev_mode?: boolean | null - - /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly free?: boolean | null - - /** - * The id value for the learning resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly id?: Array - - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly level?: Array - - /** - * Number of results to return per page - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly limit?: number - - /** - * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly max_incompleteness_penalty?: number | null - - /** - * Minimum score value a text query result needs to have to be displayed - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly min_score?: number | null + /** + * Show resource counts by category + * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly aggregations?: Array + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly certification_type?: Array + + /** + * Score weight for content file data. 1 is the default. 0 means content files are ignored + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly content_file_score_weight?: number | null + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly department?: Array + + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly dev_mode?: boolean | null + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly free?: boolean | null + + /** + * The id value for the learning resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly id?: Array + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly level?: Array + + /** + * Number of results to return per page + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly limit?: number + + /** + * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly max_incompleteness_penalty?: number | null + + /** + * Minimum score value a text query result needs to have to be displayed + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly min_score?: number | null + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly offset?: number + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly professional?: boolean | null + + /** + * The search text + * @type {string} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly q?: string + + /** + * The resource category for the resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly resource_category?: Array + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly resource_type?: Array + + /** + * + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly resource_type_group?: Array + + /** + * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum + + /** + * Whether to include select OCW content files in search results. + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly show_ocw_files?: boolean | null + + /** + * Allowed distance for phrase search + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly slop?: number | null + + /** + * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly sortby?: LearningResourcesUserSubscriptionListSortbyEnum + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly topic?: Array + + /** + * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + */ + readonly yearly_decay_percent?: number | null +} - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly ocw_topic?: Array +/** + * Request parameters for learningResourcesUserSubscriptionSubscribeCreate operation in LearningResourcesUserSubscriptionApi. + * @export + * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest + */ +export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest { + /** + * Show resource counts by category + * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly aggregations?: Array + + /** + * True if the learning resource offers a certificate + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly certification?: boolean | null + + /** + * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly certification_type?: Array + + /** + * Score weight for content file data. 1 is the default. 0 means content files are ignored + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly content_file_score_weight?: number | null + + /** + * The course feature. Possible options are at api/v1/course_features/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly course_feature?: Array + + /** + * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly delivery?: Array + + /** + * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly department?: Array + + /** + * If true return raw open search results with score explanations + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly dev_mode?: boolean | null + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly free?: boolean | null + + /** + * The id value for the learning resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly id?: Array + + /** + * + * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly level?: Array + + /** + * Number of results to return per page + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly limit?: number + + /** + * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly max_incompleteness_penalty?: number | null + + /** + * Minimum score value a text query result needs to have to be displayed + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly min_score?: number | null + + /** + * The ocw topic name. + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly ocw_topic?: Array + + /** + * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly offset?: number + + /** + * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly professional?: boolean | null + + /** + * The search text + * @type {string} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly q?: string + + /** + * The resource category for the resource + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly resource_category?: Array + + /** + * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document + * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly resource_type?: Array + + /** + * + * @type {Array<'course' | 'program' | 'learning_material'>} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly resource_type_group?: Array + + /** + * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid + * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum + + /** + * Whether to include select OCW content files in search results. + * @type {boolean} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly show_ocw_files?: boolean | null + + /** + * Allowed distance for phrase search + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly slop?: number | null + + /** + * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum + + /** + * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type + * @type {'search_subscription_type' | 'channel_subscription_type'} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum + + /** + * The topic name. To see a list of options go to api/v1/topics/ + * @type {Array} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly topic?: Array + + /** + * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly yearly_decay_percent?: number | null + + /** + * + * @type {PercolateQuerySubscriptionRequestRequest} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + */ + readonly PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest +} - /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly offered_by?: Array +/** + * Request parameters for learningResourcesUserSubscriptionUnsubscribeDestroy operation in LearningResourcesUserSubscriptionApi. + * @export + * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest + */ +export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest { + /** + * + * @type {number} + * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroy + */ + readonly id: number +} - /** - * The initial index from which to return the results - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly offset?: number +/** + * LearningResourcesUserSubscriptionApi - object-oriented interface + * @export + * @class LearningResourcesUserSubscriptionApi + * @extends {BaseAPI} + */ +export class LearningResourcesUserSubscriptionApi extends BaseAPI { + /** + * View for listing percolate query subscriptions for a user + * @summary Check if a user is subscribed to a specific query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesUserSubscriptionApi + */ + public learningResourcesUserSubscriptionCheckList( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesUserSubscriptionApiFp(this.configuration) + .learningResourcesUserSubscriptionCheckList( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.source_type, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * View for listing percolate query subscriptions for a user + * @summary List subscribed queries + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesUserSubscriptionApi + */ + public learningResourcesUserSubscriptionList( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesUserSubscriptionApiFp(this.configuration) + .learningResourcesUserSubscriptionList( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.topic, + requestParameters.yearly_decay_percent, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Subscribe a user to query + * @summary Subscribe user to query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesUserSubscriptionApi + */ + public learningResourcesUserSubscriptionSubscribeCreate( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesUserSubscriptionApiFp(this.configuration) + .learningResourcesUserSubscriptionSubscribeCreate( + requestParameters.aggregations, + requestParameters.certification, + requestParameters.certification_type, + requestParameters.content_file_score_weight, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.dev_mode, + requestParameters.free, + requestParameters.id, + requestParameters.level, + requestParameters.limit, + requestParameters.max_incompleteness_penalty, + requestParameters.min_score, + requestParameters.ocw_topic, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.q, + requestParameters.resource_category, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.search_mode, + requestParameters.show_ocw_files, + requestParameters.slop, + requestParameters.sortby, + requestParameters.source_type, + requestParameters.topic, + requestParameters.yearly_decay_percent, + requestParameters.PercolateQuerySubscriptionRequestRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query + * @summary Unsubscribe user from query + * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningResourcesUserSubscriptionApi + */ + public learningResourcesUserSubscriptionUnsubscribeDestroy( + requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningResourcesUserSubscriptionApiFp(this.configuration) + .learningResourcesUserSubscriptionUnsubscribeDestroy( + requestParameters.id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} - /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList - */ - readonly platform?: Array +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListAggregationsEnum = { + ResourceType: "resource_type", + Certification: "certification", + CertificationType: "certification_type", + OfferedBy: "offered_by", + Platform: "platform", + Topic: "topic", + Department: "department", + Level: "level", + CourseFeature: "course_feature", + Professional: "professional", + Free: "free", + Delivery: "delivery", + ResourceTypeGroup: "resource_type_group", + ResourceCategory: "resource_category", +} as const +export type LearningResourcesUserSubscriptionCheckListAggregationsEnum = + (typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListCertificationTypeEnum = { + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type LearningResourcesUserSubscriptionCheckListCertificationTypeEnum = + (typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesUserSubscriptionCheckListDeliveryEnum = + (typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListDepartmentEnum = { + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesUserSubscriptionCheckListDepartmentEnum = + (typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListLevelEnum = { + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesUserSubscriptionCheckListLevelEnum = + (typeof LearningResourcesUserSubscriptionCheckListLevelEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListLevelEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListOfferedByEnum = { + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesUserSubscriptionCheckListOfferedByEnum = + (typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListPlatformEnum = { + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesUserSubscriptionCheckListPlatformEnum = + (typeof LearningResourcesUserSubscriptionCheckListPlatformEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListPlatformEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListResourceTypeEnum = { + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type LearningResourcesUserSubscriptionCheckListResourceTypeEnum = + (typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum = { + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum = + (typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListSearchModeEnum = { + Phrase: "phrase", + BestFields: "best_fields", + MostFields: "most_fields", + Hybrid: "hybrid", +} as const +export type LearningResourcesUserSubscriptionCheckListSearchModeEnum = + (typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListSortbyEnum = { + Featured: "featured", + Id: "id", + Id2: "-id", + ReadableId: "readable_id", + ReadableId2: "-readable_id", + LastModified: "last_modified", + LastModified2: "-last_modified", + New: "new", + StartDate: "start_date", + StartDate2: "-start_date", + Mitcoursenumber: "mitcoursenumber", + Mitcoursenumber2: "-mitcoursenumber", + Views: "views", + Views2: "-views", + Upcoming: "upcoming", +} as const +export type LearningResourcesUserSubscriptionCheckListSortbyEnum = + (typeof LearningResourcesUserSubscriptionCheckListSortbyEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListSortbyEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionCheckListSourceTypeEnum = { + SearchSubscriptionType: "search_subscription_type", + ChannelSubscriptionType: "channel_subscription_type", +} as const +export type LearningResourcesUserSubscriptionCheckListSourceTypeEnum = + (typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum)[keyof typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListAggregationsEnum = { + ResourceType: "resource_type", + Certification: "certification", + CertificationType: "certification_type", + OfferedBy: "offered_by", + Platform: "platform", + Topic: "topic", + Department: "department", + Level: "level", + CourseFeature: "course_feature", + Professional: "professional", + Free: "free", + Delivery: "delivery", + ResourceTypeGroup: "resource_type_group", + ResourceCategory: "resource_category", +} as const +export type LearningResourcesUserSubscriptionListAggregationsEnum = + (typeof LearningResourcesUserSubscriptionListAggregationsEnum)[keyof typeof LearningResourcesUserSubscriptionListAggregationsEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListCertificationTypeEnum = { + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", +} as const +export type LearningResourcesUserSubscriptionListCertificationTypeEnum = + (typeof LearningResourcesUserSubscriptionListCertificationTypeEnum)[keyof typeof LearningResourcesUserSubscriptionListCertificationTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesUserSubscriptionListDeliveryEnum = + (typeof LearningResourcesUserSubscriptionListDeliveryEnum)[keyof typeof LearningResourcesUserSubscriptionListDeliveryEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListDepartmentEnum = { + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesUserSubscriptionListDepartmentEnum = + (typeof LearningResourcesUserSubscriptionListDepartmentEnum)[keyof typeof LearningResourcesUserSubscriptionListDepartmentEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListLevelEnum = { + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesUserSubscriptionListLevelEnum = + (typeof LearningResourcesUserSubscriptionListLevelEnum)[keyof typeof LearningResourcesUserSubscriptionListLevelEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListOfferedByEnum = { + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesUserSubscriptionListOfferedByEnum = + (typeof LearningResourcesUserSubscriptionListOfferedByEnum)[keyof typeof LearningResourcesUserSubscriptionListOfferedByEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListPlatformEnum = { + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesUserSubscriptionListPlatformEnum = + (typeof LearningResourcesUserSubscriptionListPlatformEnum)[keyof typeof LearningResourcesUserSubscriptionListPlatformEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListResourceTypeEnum = { + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", +} as const +export type LearningResourcesUserSubscriptionListResourceTypeEnum = + (typeof LearningResourcesUserSubscriptionListResourceTypeEnum)[keyof typeof LearningResourcesUserSubscriptionListResourceTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListResourceTypeGroupEnum = { + Course: "course", + Program: "program", + LearningMaterial: "learning_material", +} as const +export type LearningResourcesUserSubscriptionListResourceTypeGroupEnum = + (typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum)[keyof typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListSearchModeEnum = { + Phrase: "phrase", + BestFields: "best_fields", + MostFields: "most_fields", + Hybrid: "hybrid", +} as const +export type LearningResourcesUserSubscriptionListSearchModeEnum = + (typeof LearningResourcesUserSubscriptionListSearchModeEnum)[keyof typeof LearningResourcesUserSubscriptionListSearchModeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionListSortbyEnum = { + Featured: "featured", + Id: "id", + Id2: "-id", + ReadableId: "readable_id", + ReadableId2: "-readable_id", + LastModified: "last_modified", + LastModified2: "-last_modified", + New: "new", + StartDate: "start_date", + StartDate2: "-start_date", + Mitcoursenumber: "mitcoursenumber", + Mitcoursenumber2: "-mitcoursenumber", + Views: "views", + Views2: "-views", + Upcoming: "upcoming", +} as const +export type LearningResourcesUserSubscriptionListSortbyEnum = + (typeof LearningResourcesUserSubscriptionListSortbyEnum)[keyof typeof LearningResourcesUserSubscriptionListSortbyEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum = + { + ResourceType: "resource_type", + Certification: "certification", + CertificationType: "certification_type", + OfferedBy: "offered_by", + Platform: "platform", + Topic: "topic", + Department: "department", + Level: "level", + CourseFeature: "course_feature", + Professional: "professional", + Free: "free", + Delivery: "delivery", + ResourceTypeGroup: "resource_type_group", + ResourceCategory: "resource_category", + } as const +export type LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum = + { + Micromasters: "micromasters", + Professional: "professional", + Completion: "completion", + None: "none", + } as const +export type LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum = { + _1: "1", + _2: "2", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateLevelEnum = { + Undergraduate: "undergraduate", + Graduate: "graduate", + HighSchool: "high_school", + Noncredit: "noncredit", + Advanced: "advanced", + Intermediate: "intermediate", + Introductory: "introductory", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateLevelEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum = { + Mitx: "mitx", + Ocw: "ocw", + Bootcamps: "bootcamps", + Xpro: "xpro", + Mitpe: "mitpe", + See: "see", + Climate: "climate", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum = { + Edx: "edx", + Ocw: "ocw", + Oll: "oll", + Mitxonline: "mitxonline", + Bootcamps: "bootcamps", + Xpro: "xpro", + Csail: "csail", + Mitpe: "mitpe", + See: "see", + Scc: "scc", + Ctl: "ctl", + Whu: "whu", + Susskind: "susskind", + Globalalumni: "globalalumni", + Simplilearn: "simplilearn", + Emeritus: "emeritus", + Podcast: "podcast", + Youtube: "youtube", + Canvas: "canvas", + Climate: "climate", + Ovs: "ovs", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum = + { + Course: "course", + Program: "program", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Video: "video", + VideoPlaylist: "video_playlist", + Document: "document", + } as const +export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum = + { + Course: "course", + Program: "program", + LearningMaterial: "learning_material", + } as const +export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum = { + Phrase: "phrase", + BestFields: "best_fields", + MostFields: "most_fields", + Hybrid: "hybrid", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum = { + Featured: "featured", + Id: "id", + Id2: "-id", + ReadableId: "readable_id", + ReadableId2: "-readable_id", + LastModified: "last_modified", + LastModified2: "-last_modified", + New: "new", + StartDate: "start_date", + StartDate2: "-start_date", + Mitcoursenumber: "mitcoursenumber", + Mitcoursenumber2: "-mitcoursenumber", + Views: "views", + Views2: "-views", + Upcoming: "upcoming", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum] +/** + * @export + */ +export const LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum = { + SearchSubscriptionType: "search_subscription_type", + ChannelSubscriptionType: "channel_subscription_type", +} as const +export type LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum = + (typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum)[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum] +/** + * LearningpathsApi - axios parameter creator + * @export + */ +export const LearningpathsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Create a learning path + * @summary Create + * @param {LearningPathResourceRequest} LearningPathResourceRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean | null - + learningpathsCreate: async ( + LearningPathResourceRequest: LearningPathResourceRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'LearningPathResourceRequest' is not null or undefined + assertParamExists( + "learningpathsCreate", + "LearningPathResourceRequest", + LearningPathResourceRequest, + ) + const localVarPath = `/api/v1/learningpaths/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + LearningPathResourceRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The search text - * @type {string} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Remove a learning path + * @summary Destroy + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly q?: string - + learningpathsDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsDestroy", "id", id) + const localVarPath = `/api/v1/learningpaths/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The resource category for the resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Add + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_category?: Array - + learningpathsItemsCreate: async ( + learning_resource_id: number, + LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningpathsItemsCreate", + "learning_resource_id", + learning_resource_id, + ) + // verify required parameter 'LearningPathRelationshipCreateRequest' is not null or undefined + assertParamExists( + "learningpathsItemsCreate", + "LearningPathRelationshipCreateRequest", + LearningPathRelationshipCreateRequest, + ) + const localVarPath = + `/api/v1/learningpaths/{learning_resource_id}/items/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + LearningPathRelationshipCreateRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Remove + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array - + learningpathsItemsDestroy: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsItemsDestroy", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningpathsItemsDestroy", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Viewset for LearningPath related resources + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + learningpathsItemsList: async ( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningpathsItemsList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learningpaths/{learning_resource_id}/items/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Update + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly search_mode?: LearningResourcesUserSubscriptionListSearchModeEnum - + learningpathsItemsPartialUpdate: async ( + id: number, + learning_resource_id: number, + PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsItemsPartialUpdate", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningpathsItemsPartialUpdate", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedLearningPathRelationshipCreateRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Whether to include select OCW content files in search results. - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly show_ocw_files?: boolean | null - + learningpathsItemsRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsItemsRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "learningpathsItemsRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Allowed distance for phrase search - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Get a paginated list of learning paths + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly slop?: number | null - + learningpathsList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningpathsListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learningpaths/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Get a list of all learning path items + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: LearningResourcesUserSubscriptionListSortbyEnum - + learningpathsMembershipList: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/learningpaths/membership/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Update individual fields of a learning path + * @summary Update + * @param {number} id A unique integer value identifying this learning resource. + * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array - + learningpathsPartialUpdate: async ( + id: number, + PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsPartialUpdate", "id", id) + const localVarPath = `/api/v1/learningpaths/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedLearningPathResourceRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionList + * Retrive a single learning path + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly yearly_decay_percent?: number | null + learningpathsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("learningpathsRetrieve", "id", id) + const localVarPath = `/api/v1/learningpaths/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for learningResourcesUserSubscriptionSubscribeCreate operation in LearningResourcesUserSubscriptionApi. + * LearningpathsApi - functional programming interface * @export - * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest */ -export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest { - /** - * Show resource counts by category - * @type {Array<'resource_type' | 'certification' | 'certification_type' | 'offered_by' | 'platform' | 'topic' | 'department' | 'level' | 'course_feature' | 'professional' | 'free' | 'delivery' | 'resource_type_group' | 'resource_category'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly aggregations?: Array - - /** - * True if the learning resource offers a certificate - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly certification?: boolean | null - - /** - * The type of certificate * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'micromasters' | 'professional' | 'completion' | 'none'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly certification_type?: Array - - /** - * Score weight for content file data. 1 is the default. 0 means content files are ignored - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly content_file_score_weight?: number | null - - /** - * The course feature. Possible options are at api/v1/course_features/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly course_feature?: Array - - /** - * The delivery options in which the learning resource is offered * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array<'online' | 'hybrid' | 'in_person' | 'offline'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly delivery?: Array - - /** - * The department that offers the learning resource * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly department?: Array - - /** - * If true return raw open search results with score explanations - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly dev_mode?: boolean | null - - /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly free?: boolean | null - - /** - * The id value for the learning resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly id?: Array - - /** - * - * @type {Array<'undergraduate' | 'graduate' | 'high_school' | 'noncredit' | 'advanced' | 'intermediate' | 'introductory'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly level?: Array - +export const LearningpathsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + LearningpathsApiAxiosParamCreator(configuration) + return { /** - * Number of results to return per page - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly limit?: number - - /** - * Maximum score penalty for incomplete OCW courses in percent. An OCW course with completeness = 0 will have this score penalty. Partially complete courses have a linear penalty proportional to the degree of incompleteness. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly max_incompleteness_penalty?: number | null - - /** - * Minimum score value a text query result needs to have to be displayed - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate - */ - readonly min_score?: number | null - - /** - * The ocw topic name. - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Create a learning path + * @summary Create + * @param {LearningPathResourceRequest} LearningPathResourceRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly ocw_topic?: Array - + async learningpathsCreate( + LearningPathResourceRequest: LearningPathResourceRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsCreate( + LearningPathResourceRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The organization that offers the learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'mitx' | 'ocw' | 'bootcamps' | 'xpro' | 'mitpe' | 'see' | 'climate'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Remove a learning path + * @summary Destroy + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offered_by?: Array - + async learningpathsDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsDestroy(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsDestroy"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The initial index from which to return the results - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Add + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + async learningpathsItemsCreate( + learning_resource_id: number, + LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsItemsCreate( + learning_resource_id, + LearningPathRelationshipCreateRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsItemsCreate"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The platform on which the learning resource is offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'edx' | 'ocw' | 'oll' | 'mitxonline' | 'bootcamps' | 'xpro' | 'csail' | 'mitpe' | 'see' | 'scc' | 'ctl' | 'whu' | 'susskind' | 'globalalumni' | 'simplilearn' | 'emeritus' | 'podcast' | 'youtube' | 'canvas' | 'climate' | 'ovs'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Remove + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly platform?: Array - + async learningpathsItemsDestroy( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsItemsDestroy( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsItemsDestroy"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean | null - + async learningpathsItemsList( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsItemsList( + learning_resource_id, + limit, + offset, + sortby, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsItemsList"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The search text - * @type {string} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Update + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly q?: string - + async learningpathsItemsPartialUpdate( + id: number, + learning_resource_id: number, + PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsItemsPartialUpdate( + id, + learning_resource_id, + PatchedLearningPathRelationshipCreateRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap[ + "LearningpathsApi.learningpathsItemsPartialUpdate" + ]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The resource category for the resource - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id The learning resource id of the learning path + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_category?: Array - + async learningpathsItemsRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsItemsRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsItemsRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The type of learning resource * `course` - course * `program` - program * `learning_path` - learning path * `podcast` - podcast * `podcast_episode` - podcast episode * `video` - video * `video_playlist` - video playlist * `document` - document - * @type {Array<'course' | 'program' | 'learning_path' | 'podcast' | 'podcast_episode' | 'video' | 'video_playlist' | 'document'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Get a paginated list of learning paths + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array - + async learningpathsList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: LearningpathsListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {Array<'course' | 'program' | 'learning_material'>} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Get a list of all learning path items + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + async learningpathsMembershipList( + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsMembershipList(options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsMembershipList"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The open search search type for text queries * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid * `phrase` - phrase * `best_fields` - best_fields * `most_fields` - most_fields * `hybrid` - hybrid - * @type {'phrase' | 'best_fields' | 'most_fields' | 'hybrid'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Update individual fields of a learning path + * @summary Update + * @param {number} id A unique integer value identifying this learning resource. + * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly search_mode?: LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum - + async learningpathsPartialUpdate( + id: number, + PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsPartialUpdate( + id, + PatchedLearningPathResourceRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsPartialUpdate"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Whether to include select OCW content files in search results. - * @type {boolean} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Retrive a single learning path + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly show_ocw_files?: boolean | null + async learningpathsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.learningpathsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["LearningpathsApi.learningpathsRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * LearningpathsApi - factory interface + * @export + */ +export const LearningpathsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = LearningpathsApiFp(configuration) + return { /** - * Allowed distance for phrase search - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Create a learning path + * @summary Create + * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly slop?: number | null - + learningpathsCreate( + requestParameters: LearningpathsApiLearningpathsCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsCreate( + requestParameters.LearningPathResourceRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * If the parameter starts with \'-\' the sort is in descending order * `featured` - Featured * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'featured' | 'id' | '-id' | 'readable_id' | '-readable_id' | 'last_modified' | '-last_modified' | 'new' | 'start_date' | '-start_date' | 'mitcoursenumber' | '-mitcoursenumber' | 'views' | '-views' | 'upcoming'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Remove a learning path + * @summary Destroy + * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum - + learningpathsDestroy( + requestParameters: LearningpathsApiLearningpathsDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsDestroy(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** - * The subscription type * `search_subscription_type` - search_subscription_type * `channel_subscription_type` - channel_subscription_type - * @type {'search_subscription_type' | 'channel_subscription_type'} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Add + * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly source_type?: LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum - + learningpathsItemsCreate( + requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsItemsCreate( + requestParameters.learning_resource_id, + requestParameters.LearningPathRelationshipCreateRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The topic name. To see a list of options go to api/v1/topics/ - * @type {Array} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Remove + * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array - + learningpathsItemsDestroy( + requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsItemsDestroy( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Relevance score penalty percent per year for for resources without upcoming runs. Only affects results if there is a search term. - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly yearly_decay_percent?: number | null - + learningpathsItemsList( + requestParameters: LearningpathsApiLearningpathsItemsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {PercolateQuerySubscriptionRequestRequest} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreate + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Update + * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly PercolateQuerySubscriptionRequestRequest?: PercolateQuerySubscriptionRequestRequest -} - -/** - * Request parameters for learningResourcesUserSubscriptionUnsubscribeDestroy operation in LearningResourcesUserSubscriptionApi. - * @export - * @interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest - */ -export interface LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest { + learningpathsItemsPartialUpdate( + requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsItemsPartialUpdate( + requestParameters.id, + requestParameters.learning_resource_id, + requestParameters.PatchedLearningPathRelationshipCreateRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * - * @type {number} - * @memberof LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroy + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * LearningResourcesUserSubscriptionApi - object-oriented interface - * @export - * @class LearningResourcesUserSubscriptionApi - * @extends {BaseAPI} - */ -export class LearningResourcesUserSubscriptionApi extends BaseAPI { + learningpathsItemsRetrieve( + requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * View for listing percolate query subscriptions for a user - * @summary Check if a user is subscribed to a specific query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest} requestParameters Request parameters. + * Get a paginated list of learning paths + * @summary List + * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningResourcesUserSubscriptionApi */ - public learningResourcesUserSubscriptionCheckList(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionCheckListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesUserSubscriptionApiFp(this.configuration).learningResourcesUserSubscriptionCheckList(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.source_type, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(this.axios, this.basePath)); - } - + learningpathsList( + requestParameters: LearningpathsApiLearningpathsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * View for listing percolate query subscriptions for a user - * @summary List subscribed queries - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest} requestParameters Request parameters. + * Get a list of all learning path items + * @summary List * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningResourcesUserSubscriptionApi */ - public learningResourcesUserSubscriptionList(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesUserSubscriptionApiFp(this.configuration).learningResourcesUserSubscriptionList(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.topic, requestParameters.yearly_decay_percent, options).then((request) => request(this.axios, this.basePath)); - } - + learningpathsMembershipList( + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .learningpathsMembershipList(options) + .then((request) => request(axios, basePath)) + }, /** - * Subscribe a user to query - * @summary Subscribe user to query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest} requestParameters Request parameters. + * Update individual fields of a learning path + * @summary Update + * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningResourcesUserSubscriptionApi */ - public learningResourcesUserSubscriptionSubscribeCreate(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionSubscribeCreateRequest = {}, options?: RawAxiosRequestConfig) { - return LearningResourcesUserSubscriptionApiFp(this.configuration).learningResourcesUserSubscriptionSubscribeCreate(requestParameters.aggregations, requestParameters.certification, requestParameters.certification_type, requestParameters.content_file_score_weight, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.dev_mode, requestParameters.free, requestParameters.id, requestParameters.level, requestParameters.limit, requestParameters.max_incompleteness_penalty, requestParameters.min_score, requestParameters.ocw_topic, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.q, requestParameters.resource_category, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.search_mode, requestParameters.show_ocw_files, requestParameters.slop, requestParameters.sortby, requestParameters.source_type, requestParameters.topic, requestParameters.yearly_decay_percent, requestParameters.PercolateQuerySubscriptionRequestRequest, options).then((request) => request(this.axios, this.basePath)); - } - + learningpathsPartialUpdate( + requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsPartialUpdate( + requestParameters.id, + requestParameters.PatchedLearningPathResourceRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Unsubscribe a user from a query Args: pk (integer): The id of the query Returns: PercolateQuerySerializer: The percolate query - * @summary Unsubscribe user from query - * @param {LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest} requestParameters Request parameters. + * Retrive a single learning path + * @summary Retrieve + * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningResourcesUserSubscriptionApi */ - public learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters: LearningResourcesUserSubscriptionApiLearningResourcesUserSubscriptionUnsubscribeDestroyRequest, options?: RawAxiosRequestConfig) { - return LearningResourcesUserSubscriptionApiFp(this.configuration).learningResourcesUserSubscriptionUnsubscribeDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + learningpathsRetrieve( + requestParameters: LearningpathsApiLearningpathsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .learningpathsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for learningpathsCreate operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsCreateRequest */ -export const LearningResourcesUserSubscriptionCheckListAggregationsEnum = { - ResourceType: 'resource_type', - Certification: 'certification', - CertificationType: 'certification_type', - OfferedBy: 'offered_by', - Platform: 'platform', - Topic: 'topic', - Department: 'department', - Level: 'level', - CourseFeature: 'course_feature', - Professional: 'professional', - Free: 'free', - Delivery: 'delivery', - ResourceTypeGroup: 'resource_type_group', - ResourceCategory: 'resource_category' -} as const; -export type LearningResourcesUserSubscriptionCheckListAggregationsEnum = typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionCheckListAggregationsEnum]; +export interface LearningpathsApiLearningpathsCreateRequest { + /** + * + * @type {LearningPathResourceRequest} + * @memberof LearningpathsApiLearningpathsCreate + */ + readonly LearningPathResourceRequest: LearningPathResourceRequest +} + +/** + * Request parameters for learningpathsDestroy operation in LearningpathsApi. + * @export + * @interface LearningpathsApiLearningpathsDestroyRequest + */ +export interface LearningpathsApiLearningpathsDestroyRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof LearningpathsApiLearningpathsDestroy + */ + readonly id: number +} + /** + * Request parameters for learningpathsItemsCreate operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsItemsCreateRequest */ -export const LearningResourcesUserSubscriptionCheckListCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesUserSubscriptionCheckListCertificationTypeEnum = typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListCertificationTypeEnum]; +export interface LearningpathsApiLearningpathsItemsCreateRequest { + /** + * The learning resource id of the learning path + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsCreate + */ + readonly learning_resource_id: number + + /** + * + * @type {LearningPathRelationshipCreateRequest} + * @memberof LearningpathsApiLearningpathsItemsCreate + */ + readonly LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest +} + /** + * Request parameters for learningpathsItemsDestroy operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsItemsDestroyRequest */ -export const LearningResourcesUserSubscriptionCheckListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesUserSubscriptionCheckListDeliveryEnum = typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionCheckListDeliveryEnum]; +export interface LearningpathsApiLearningpathsItemsDestroyRequest { + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsDestroy + */ + readonly id: number + + /** + * The learning resource id of the learning path + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsDestroy + */ + readonly learning_resource_id: number +} + /** + * Request parameters for learningpathsItemsList operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsItemsListRequest */ -export const LearningResourcesUserSubscriptionCheckListDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesUserSubscriptionCheckListDepartmentEnum = typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionCheckListDepartmentEnum]; +export interface LearningpathsApiLearningpathsItemsListRequest { + /** + * The learning resource id of the learning path + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsList + */ + readonly learning_resource_id: number + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsList + */ + readonly offset?: number + + /** + * Which field to use when ordering the results. + * @type {string} + * @memberof LearningpathsApiLearningpathsItemsList + */ + readonly sortby?: string +} + /** + * Request parameters for learningpathsItemsPartialUpdate operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsItemsPartialUpdateRequest */ -export const LearningResourcesUserSubscriptionCheckListLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesUserSubscriptionCheckListLevelEnum = typeof LearningResourcesUserSubscriptionCheckListLevelEnum[keyof typeof LearningResourcesUserSubscriptionCheckListLevelEnum]; +export interface LearningpathsApiLearningpathsItemsPartialUpdateRequest { + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsPartialUpdate + */ + readonly id: number + + /** + * The learning resource id of the learning path + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsPartialUpdate + */ + readonly learning_resource_id: number + + /** + * + * @type {PatchedLearningPathRelationshipCreateRequest} + * @memberof LearningpathsApiLearningpathsItemsPartialUpdate + */ + readonly PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest +} + /** + * Request parameters for learningpathsItemsRetrieve operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsItemsRetrieveRequest */ -export const LearningResourcesUserSubscriptionCheckListOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesUserSubscriptionCheckListOfferedByEnum = typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionCheckListOfferedByEnum]; +export interface LearningpathsApiLearningpathsItemsRetrieveRequest { + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsRetrieve + */ + readonly id: number + + /** + * The learning resource id of the learning path + * @type {number} + * @memberof LearningpathsApiLearningpathsItemsRetrieve + */ + readonly learning_resource_id: number +} + /** + * Request parameters for learningpathsList operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsListRequest */ -export const LearningResourcesUserSubscriptionCheckListPlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesUserSubscriptionCheckListPlatformEnum = typeof LearningResourcesUserSubscriptionCheckListPlatformEnum[keyof typeof LearningResourcesUserSubscriptionCheckListPlatformEnum]; +export interface LearningpathsApiLearningpathsListRequest { + /** + * + * @type {boolean} + * @memberof LearningpathsApiLearningpathsList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof LearningpathsApiLearningpathsList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof LearningpathsApiLearningpathsList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof LearningpathsApiLearningpathsList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof LearningpathsApiLearningpathsList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof LearningpathsApiLearningpathsList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof LearningpathsApiLearningpathsList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof LearningpathsApiLearningpathsList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof LearningpathsApiLearningpathsList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof LearningpathsApiLearningpathsList + */ + readonly sortby?: LearningpathsListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof LearningpathsApiLearningpathsList + */ + readonly topic?: Array +} + /** + * Request parameters for learningpathsPartialUpdate operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsPartialUpdateRequest */ -export const LearningResourcesUserSubscriptionCheckListResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesUserSubscriptionCheckListResourceTypeEnum = typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeEnum]; +export interface LearningpathsApiLearningpathsPartialUpdateRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof LearningpathsApiLearningpathsPartialUpdate + */ + readonly id: number + + /** + * + * @type {PatchedLearningPathResourceRequest} + * @memberof LearningpathsApiLearningpathsPartialUpdate + */ + readonly PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest +} + /** + * Request parameters for learningpathsRetrieve operation in LearningpathsApi. * @export + * @interface LearningpathsApiLearningpathsRetrieveRequest */ -export const LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionCheckListResourceTypeGroupEnum]; +export interface LearningpathsApiLearningpathsRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof LearningpathsApiLearningpathsRetrieve + */ + readonly id: number +} + /** + * LearningpathsApi - object-oriented interface * @export + * @class LearningpathsApi + * @extends {BaseAPI} */ -export const LearningResourcesUserSubscriptionCheckListSearchModeEnum = { - Phrase: 'phrase', - BestFields: 'best_fields', - MostFields: 'most_fields', - Hybrid: 'hybrid' -} as const; -export type LearningResourcesUserSubscriptionCheckListSearchModeEnum = typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSearchModeEnum]; +export class LearningpathsApi extends BaseAPI { + /** + * Create a learning path + * @summary Create + * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsCreate( + requestParameters: LearningpathsApiLearningpathsCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsCreate( + requestParameters.LearningPathResourceRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Remove a learning path + * @summary Destroy + * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsDestroy( + requestParameters: LearningpathsApiLearningpathsDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsDestroy(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Add + * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsItemsCreate( + requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsItemsCreate( + requestParameters.learning_resource_id, + requestParameters.LearningPathRelationshipCreateRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Remove + * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsItemsDestroy( + requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsItemsDestroy( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for LearningPath related resources + * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsItemsList( + requestParameters: LearningpathsApiLearningpathsItemsListRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for LearningPath related resources + * @summary Learning Path Resource Relationship Update + * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsItemsPartialUpdate( + requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsItemsPartialUpdate( + requestParameters.id, + requestParameters.learning_resource_id, + requestParameters.PatchedLearningPathRelationshipCreateRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsItemsRetrieve( + requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of learning paths + * @summary List + * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsList( + requestParameters: LearningpathsApiLearningpathsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a list of all learning path items + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsMembershipList(options?: RawAxiosRequestConfig) { + return LearningpathsApiFp(this.configuration) + .learningpathsMembershipList(options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Update individual fields of a learning path + * @summary Update + * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsPartialUpdate( + requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsPartialUpdate( + requestParameters.id, + requestParameters.PatchedLearningPathResourceRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrive a single learning path + * @summary Retrieve + * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof LearningpathsApi + */ + public learningpathsRetrieve( + requestParameters: LearningpathsApiLearningpathsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return LearningpathsApiFp(this.configuration) + .learningpathsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} + /** * @export */ -export const LearningResourcesUserSubscriptionCheckListSortbyEnum = { - Featured: 'featured', - Id: 'id', - Id2: '-id', - ReadableId: 'readable_id', - ReadableId2: '-readable_id', - LastModified: 'last_modified', - LastModified2: '-last_modified', - New: 'new', - StartDate: 'start_date', - StartDate2: '-start_date', - Mitcoursenumber: 'mitcoursenumber', - Mitcoursenumber2: '-mitcoursenumber', - Views: 'views', - Views2: '-views', - Upcoming: 'upcoming' -} as const; -export type LearningResourcesUserSubscriptionCheckListSortbyEnum = typeof LearningResourcesUserSubscriptionCheckListSortbyEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSortbyEnum]; +export const LearningpathsListCertificationTypeEnum = { + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type LearningpathsListCertificationTypeEnum = + (typeof LearningpathsListCertificationTypeEnum)[keyof typeof LearningpathsListCertificationTypeEnum] /** * @export */ -export const LearningResourcesUserSubscriptionCheckListSourceTypeEnum = { - SearchSubscriptionType: 'search_subscription_type', - ChannelSubscriptionType: 'channel_subscription_type' -} as const; -export type LearningResourcesUserSubscriptionCheckListSourceTypeEnum = typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionCheckListSourceTypeEnum]; +export const LearningpathsListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type LearningpathsListDeliveryEnum = + (typeof LearningpathsListDeliveryEnum)[keyof typeof LearningpathsListDeliveryEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListAggregationsEnum = { - ResourceType: 'resource_type', - Certification: 'certification', - CertificationType: 'certification_type', - OfferedBy: 'offered_by', - Platform: 'platform', - Topic: 'topic', - Department: 'department', - Level: 'level', - CourseFeature: 'course_feature', - Professional: 'professional', - Free: 'free', - Delivery: 'delivery', - ResourceTypeGroup: 'resource_type_group', - ResourceCategory: 'resource_category' -} as const; -export type LearningResourcesUserSubscriptionListAggregationsEnum = typeof LearningResourcesUserSubscriptionListAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionListAggregationsEnum]; +export const LearningpathsListDepartmentEnum = { + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type LearningpathsListDepartmentEnum = + (typeof LearningpathsListDepartmentEnum)[keyof typeof LearningpathsListDepartmentEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesUserSubscriptionListCertificationTypeEnum = typeof LearningResourcesUserSubscriptionListCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionListCertificationTypeEnum]; +export const LearningpathsListLevelEnum = { + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type LearningpathsListLevelEnum = + (typeof LearningpathsListLevelEnum)[keyof typeof LearningpathsListLevelEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesUserSubscriptionListDeliveryEnum = typeof LearningResourcesUserSubscriptionListDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionListDeliveryEnum]; +export const LearningpathsListOfferedByEnum = { + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type LearningpathsListOfferedByEnum = + (typeof LearningpathsListOfferedByEnum)[keyof typeof LearningpathsListOfferedByEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesUserSubscriptionListDepartmentEnum = typeof LearningResourcesUserSubscriptionListDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionListDepartmentEnum]; +export const LearningpathsListPlatformEnum = { + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type LearningpathsListPlatformEnum = + (typeof LearningpathsListPlatformEnum)[keyof typeof LearningpathsListPlatformEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesUserSubscriptionListLevelEnum = typeof LearningResourcesUserSubscriptionListLevelEnum[keyof typeof LearningResourcesUserSubscriptionListLevelEnum]; +export const LearningpathsListResourceTypeEnum = { + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type LearningpathsListResourceTypeEnum = + (typeof LearningpathsListResourceTypeEnum)[keyof typeof LearningpathsListResourceTypeEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesUserSubscriptionListOfferedByEnum = typeof LearningResourcesUserSubscriptionListOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionListOfferedByEnum]; +export const LearningpathsListResourceTypeGroupEnum = { + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type LearningpathsListResourceTypeGroupEnum = + (typeof LearningpathsListResourceTypeGroupEnum)[keyof typeof LearningpathsListResourceTypeGroupEnum] /** * @export */ -export const LearningResourcesUserSubscriptionListPlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesUserSubscriptionListPlatformEnum = typeof LearningResourcesUserSubscriptionListPlatformEnum[keyof typeof LearningResourcesUserSubscriptionListPlatformEnum]; +export const LearningpathsListSortbyEnum = { + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type LearningpathsListSortbyEnum = + (typeof LearningpathsListSortbyEnum)[keyof typeof LearningpathsListSortbyEnum] + /** + * MediaApi - axios parameter creator * @export */ -export const LearningResourcesUserSubscriptionListResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesUserSubscriptionListResourceTypeEnum = typeof LearningResourcesUserSubscriptionListResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionListResourceTypeEnum]; +export const MediaApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * Upload an image (multipart/form-data) and return the storage URL. + * @param {File} image_file + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + mediaUpload: async ( + image_file: File, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'image_file' is not null or undefined + assertParamExists("mediaUpload", "image_file", image_file) + const localVarPath = `/api/v1/upload-media/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + const localVarFormParams = new ((configuration && + configuration.formDataCtor) || + FormData)() + + if (image_file !== undefined) { + localVarFormParams.append("image_file", image_file as any) + } + + localVarHeaderParameter["Content-Type"] = "multipart/form-data" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = localVarFormParams + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} + /** + * MediaApi - functional programming interface * @export */ -export const LearningResourcesUserSubscriptionListResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesUserSubscriptionListResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionListResourceTypeGroupEnum]; +export const MediaApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = MediaApiAxiosParamCreator(configuration) + return { + /** + * Upload an image (multipart/form-data) and return the storage URL. + * @param {File} image_file + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async mediaUpload( + image_file: File, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.mediaUpload( + image_file, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["MediaApi.mediaUpload"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} + /** + * MediaApi - factory interface * @export */ -export const LearningResourcesUserSubscriptionListSearchModeEnum = { - Phrase: 'phrase', - BestFields: 'best_fields', - MostFields: 'most_fields', - Hybrid: 'hybrid' -} as const; -export type LearningResourcesUserSubscriptionListSearchModeEnum = typeof LearningResourcesUserSubscriptionListSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionListSearchModeEnum]; +export const MediaApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = MediaApiFp(configuration) + return { + /** + * Upload an image (multipart/form-data) and return the storage URL. + * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + mediaUpload( + requestParameters: MediaApiMediaUploadRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .mediaUpload(requestParameters.image_file, options) + .then((request) => request(axios, basePath)) + }, + } +} + /** + * Request parameters for mediaUpload operation in MediaApi. * @export + * @interface MediaApiMediaUploadRequest */ -export const LearningResourcesUserSubscriptionListSortbyEnum = { - Featured: 'featured', - Id: 'id', - Id2: '-id', - ReadableId: 'readable_id', - ReadableId2: '-readable_id', - LastModified: 'last_modified', - LastModified2: '-last_modified', - New: 'new', - StartDate: 'start_date', - StartDate2: '-start_date', - Mitcoursenumber: 'mitcoursenumber', - Mitcoursenumber2: '-mitcoursenumber', - Views: 'views', - Views2: '-views', - Upcoming: 'upcoming' -} as const; -export type LearningResourcesUserSubscriptionListSortbyEnum = typeof LearningResourcesUserSubscriptionListSortbyEnum[keyof typeof LearningResourcesUserSubscriptionListSortbyEnum]; -/** - * @export - */ -export const LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum = { - ResourceType: 'resource_type', - Certification: 'certification', - CertificationType: 'certification_type', - OfferedBy: 'offered_by', - Platform: 'platform', - Topic: 'topic', - Department: 'department', - Level: 'level', - CourseFeature: 'course_feature', - Professional: 'professional', - Free: 'free', - Delivery: 'delivery', - ResourceTypeGroup: 'resource_type_group', - ResourceCategory: 'resource_category' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateAggregationsEnum]; -/** - * @export - */ -export const LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum = { - Micromasters: 'micromasters', - Professional: 'professional', - Completion: 'completion', - None: 'none' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateCertificationTypeEnum]; +export interface MediaApiMediaUploadRequest { + /** + * + * @type {File} + * @memberof MediaApiMediaUpload + */ + readonly image_file: File +} + /** + * MediaApi - object-oriented interface * @export + * @class MediaApi + * @extends {BaseAPI} */ -export const LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDeliveryEnum]; +export class MediaApi extends BaseAPI { + /** + * Upload an image (multipart/form-data) and return the storage URL. + * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof MediaApi + */ + public mediaUpload( + requestParameters: MediaApiMediaUploadRequest, + options?: RawAxiosRequestConfig, + ) { + return MediaApiFp(this.configuration) + .mediaUpload(requestParameters.image_file, options) + .then((request) => request(this.axios, this.basePath)) + } +} + /** + * OfferorsApi - axios parameter creator * @export */ -export const LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum = { - _1: '1', - _2: '2', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateDepartmentEnum]; +export const OfferorsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * MIT organizations that offer learning resources + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerorsList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/offerors/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * MIT organizations that offer learning resources + * @summary Retrieve + * @param {string} code A unique value identifying this learning resource offeror. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerorsRetrieve: async ( + code: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'code' is not null or undefined + assertParamExists("offerorsRetrieve", "code", code) + const localVarPath = `/api/v1/offerors/{code}/`.replace( + `{${"code"}}`, + encodeURIComponent(String(code)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} + /** + * OfferorsApi - functional programming interface * @export */ -export const LearningResourcesUserSubscriptionSubscribeCreateLevelEnum = { - Undergraduate: 'undergraduate', - Graduate: 'graduate', - HighSchool: 'high_school', - Noncredit: 'noncredit', - Advanced: 'advanced', - Intermediate: 'intermediate', - Introductory: 'introductory' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateLevelEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateLevelEnum]; +export const OfferorsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = OfferorsApiAxiosParamCreator(configuration) + return { + /** + * MIT organizations that offer learning resources + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async offerorsList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.offerorsList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["OfferorsApi.offerorsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * MIT organizations that offer learning resources + * @summary Retrieve + * @param {string} code A unique value identifying this learning resource offeror. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async offerorsRetrieve( + code: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.offerorsRetrieve(code, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["OfferorsApi.offerorsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} + /** + * OfferorsApi - factory interface * @export */ -export const LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum = { - Mitx: 'mitx', - Ocw: 'ocw', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Mitpe: 'mitpe', - See: 'see', - Climate: 'climate' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateOfferedByEnum]; +export const OfferorsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = OfferorsApiFp(configuration) + return { + /** + * MIT organizations that offer learning resources + * @summary List + * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerorsList( + requestParameters: OfferorsApiOfferorsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .offerorsList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * MIT organizations that offer learning resources + * @summary Retrieve + * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerorsRetrieve( + requestParameters: OfferorsApiOfferorsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .offerorsRetrieve(requestParameters.code, options) + .then((request) => request(axios, basePath)) + }, + } +} + /** + * Request parameters for offerorsList operation in OfferorsApi. * @export + * @interface OfferorsApiOfferorsListRequest */ -export const LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum = { - Edx: 'edx', - Ocw: 'ocw', - Oll: 'oll', - Mitxonline: 'mitxonline', - Bootcamps: 'bootcamps', - Xpro: 'xpro', - Csail: 'csail', - Mitpe: 'mitpe', - See: 'see', - Scc: 'scc', - Ctl: 'ctl', - Whu: 'whu', - Susskind: 'susskind', - Globalalumni: 'globalalumni', - Simplilearn: 'simplilearn', - Emeritus: 'emeritus', - Podcast: 'podcast', - Youtube: 'youtube', - Canvas: 'canvas', - Climate: 'climate', - Ovs: 'ovs' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum = typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreatePlatformEnum]; -/** - * @export - */ -export const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum = { - Course: 'course', - Program: 'program', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Video: 'video', - VideoPlaylist: 'video_playlist', - Document: 'document' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeEnum]; -/** - * @export - */ -export const LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum = { - Course: 'course', - Program: 'program', - LearningMaterial: 'learning_material' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateResourceTypeGroupEnum]; +export interface OfferorsApiOfferorsListRequest { + /** + * Number of results to return per page. + * @type {number} + * @memberof OfferorsApiOfferorsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof OfferorsApiOfferorsList + */ + readonly offset?: number +} + /** + * Request parameters for offerorsRetrieve operation in OfferorsApi. * @export + * @interface OfferorsApiOfferorsRetrieveRequest */ -export const LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum = { - Phrase: 'phrase', - BestFields: 'best_fields', - MostFields: 'most_fields', - Hybrid: 'hybrid' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSearchModeEnum]; +export interface OfferorsApiOfferorsRetrieveRequest { + /** + * A unique value identifying this learning resource offeror. + * @type {string} + * @memberof OfferorsApiOfferorsRetrieve + */ + readonly code: string +} + /** + * OfferorsApi - object-oriented interface * @export + * @class OfferorsApi + * @extends {BaseAPI} */ -export const LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum = { - Featured: 'featured', - Id: 'id', - Id2: '-id', - ReadableId: 'readable_id', - ReadableId2: '-readable_id', - LastModified: 'last_modified', - LastModified2: '-last_modified', - New: 'new', - StartDate: 'start_date', - StartDate2: '-start_date', - Mitcoursenumber: 'mitcoursenumber', - Mitcoursenumber2: '-mitcoursenumber', - Views: 'views', - Views2: '-views', - Upcoming: 'upcoming' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSortbyEnum]; +export class OfferorsApi extends BaseAPI { + /** + * MIT organizations that offer learning resources + * @summary List + * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OfferorsApi + */ + public offerorsList( + requestParameters: OfferorsApiOfferorsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return OfferorsApiFp(this.configuration) + .offerorsList(requestParameters.limit, requestParameters.offset, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * MIT organizations that offer learning resources + * @summary Retrieve + * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OfferorsApi + */ + public offerorsRetrieve( + requestParameters: OfferorsApiOfferorsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return OfferorsApiFp(this.configuration) + .offerorsRetrieve(requestParameters.code, options) + .then((request) => request(this.axios, this.basePath)) + } +} + /** + * PlatformsApi - axios parameter creator * @export */ -export const LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum = { - SearchSubscriptionType: 'search_subscription_type', - ChannelSubscriptionType: 'channel_subscription_type' -} as const; -export type LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum = typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum[keyof typeof LearningResourcesUserSubscriptionSubscribeCreateSourceTypeEnum]; - +export const PlatformsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * Platforms on which learning resources are hosted + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + platformsList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/platforms/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * Platforms on which learning resources are hosted + * @summary Retrieve + * @param {string} code A unique value identifying this learning resource platform. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + platformsRetrieve: async ( + code: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'code' is not null or undefined + assertParamExists("platformsRetrieve", "code", code) + const localVarPath = `/api/v1/platforms/{code}/`.replace( + `{${"code"}}`, + encodeURIComponent(String(code)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} /** - * LearningpathsApi - axios parameter creator + * PlatformsApi - functional programming interface * @export */ -export const LearningpathsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a learning path - * @summary Create - * @param {LearningPathResourceRequest} LearningPathResourceRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsCreate: async (LearningPathResourceRequest: LearningPathResourceRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'LearningPathResourceRequest' is not null or undefined - assertParamExists('learningpathsCreate', 'LearningPathResourceRequest', LearningPathResourceRequest) - const localVarPath = `/api/v1/learningpaths/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(LearningPathResourceRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Remove a learning path - * @summary Destroy - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsDestroy', 'id', id) - const localVarPath = `/api/v1/learningpaths/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Add - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsCreate: async (learning_resource_id: number, LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningpathsItemsCreate', 'learning_resource_id', learning_resource_id) - // verify required parameter 'LearningPathRelationshipCreateRequest' is not null or undefined - assertParamExists('learningpathsItemsCreate', 'LearningPathRelationshipCreateRequest', LearningPathRelationshipCreateRequest) - const localVarPath = `/api/v1/learningpaths/{learning_resource_id}/items/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(LearningPathRelationshipCreateRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Remove - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsDestroy: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsItemsDestroy', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningpathsItemsDestroy', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for LearningPath related resources - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsList: async (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningpathsItemsList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learningpaths/{learning_resource_id}/items/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Update - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsPartialUpdate: async (id: number, learning_resource_id: number, PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsItemsPartialUpdate', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningpathsItemsPartialUpdate', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedLearningPathRelationshipCreateRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsItemsRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('learningpathsItemsRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/learningpaths/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of learning paths - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningpathsListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learningpaths/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a list of all learning path items - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsMembershipList: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/learningpaths/membership/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Update individual fields of a learning path - * @summary Update - * @param {number} id A unique integer value identifying this learning resource. - * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsPartialUpdate: async (id: number, PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsPartialUpdate', 'id', id) - const localVarPath = `/api/v1/learningpaths/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedLearningPathResourceRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrive a single learning path - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('learningpathsRetrieve', 'id', id) - const localVarPath = `/api/v1/learningpaths/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export const PlatformsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = PlatformsApiAxiosParamCreator(configuration) + return { + /** + * Platforms on which learning resources are hosted + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async platformsList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.platformsList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PlatformsApi.platformsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Platforms on which learning resources are hosted + * @summary Retrieve + * @param {string} code A unique value identifying this learning resource platform. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async platformsRetrieve( + code: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.platformsRetrieve(code, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PlatformsApi.platformsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} /** - * LearningpathsApi - functional programming interface + * PlatformsApi - factory interface * @export */ -export const LearningpathsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = LearningpathsApiAxiosParamCreator(configuration) - return { - /** - * Create a learning path - * @summary Create - * @param {LearningPathResourceRequest} LearningPathResourceRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsCreate(LearningPathResourceRequest: LearningPathResourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsCreate(LearningPathResourceRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Remove a learning path - * @summary Destroy - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Add - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {LearningPathRelationshipCreateRequest} LearningPathRelationshipCreateRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsItemsCreate(learning_resource_id: number, LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsItemsCreate(learning_resource_id, LearningPathRelationshipCreateRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsItemsCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Remove - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsItemsDestroy(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsItemsDestroy(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsItemsDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for LearningPath related resources - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsItemsList(learning_resource_id, limit, offset, sortby, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsItemsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Update - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {PatchedLearningPathRelationshipCreateRequest} [PatchedLearningPathRelationshipCreateRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsItemsPartialUpdate(id: number, learning_resource_id: number, PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsItemsPartialUpdate(id, learning_resource_id, PatchedLearningPathRelationshipCreateRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsItemsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id The learning resource id of the learning path - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsItemsRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsItemsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of learning paths - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {LearningpathsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: LearningpathsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a list of all learning path items - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsMembershipList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsMembershipList(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsMembershipList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Update individual fields of a learning path - * @summary Update - * @param {number} id A unique integer value identifying this learning resource. - * @param {PatchedLearningPathResourceRequest} [PatchedLearningPathResourceRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsPartialUpdate(id: number, PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsPartialUpdate(id, PatchedLearningPathResourceRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrive a single learning path - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async learningpathsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.learningpathsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['LearningpathsApi.learningpathsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export const PlatformsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = PlatformsApiFp(configuration) + return { + /** + * Platforms on which learning resources are hosted + * @summary List + * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + platformsList( + requestParameters: PlatformsApiPlatformsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .platformsList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * Platforms on which learning resources are hosted + * @summary Retrieve + * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + platformsRetrieve( + requestParameters: PlatformsApiPlatformsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .platformsRetrieve(requestParameters.code, options) + .then((request) => request(axios, basePath)) + }, + } +} /** - * LearningpathsApi - factory interface + * Request parameters for platformsList operation in PlatformsApi. * @export + * @interface PlatformsApiPlatformsListRequest */ -export const LearningpathsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = LearningpathsApiFp(configuration) - return { - /** - * Create a learning path - * @summary Create - * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsCreate(requestParameters: LearningpathsApiLearningpathsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsCreate(requestParameters.LearningPathResourceRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Remove a learning path - * @summary Destroy - * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsDestroy(requestParameters: LearningpathsApiLearningpathsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Add - * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsCreate(requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsItemsCreate(requestParameters.learning_resource_id, requestParameters.LearningPathRelationshipCreateRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Remove - * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsDestroy(requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsItemsDestroy(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for LearningPath related resources - * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsList(requestParameters: LearningpathsApiLearningpathsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Update - * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsPartialUpdate(requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsItemsPartialUpdate(requestParameters.id, requestParameters.learning_resource_id, requestParameters.PatchedLearningPathRelationshipCreateRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsItemsRetrieve(requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of learning paths - * @summary List - * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsList(requestParameters: LearningpathsApiLearningpathsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Get a list of all learning path items - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsMembershipList(options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.learningpathsMembershipList(options).then((request) => request(axios, basePath)); - }, - /** - * Update individual fields of a learning path - * @summary Update - * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsPartialUpdate(requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsPartialUpdate(requestParameters.id, requestParameters.PatchedLearningPathResourceRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Retrive a single learning path - * @summary Retrieve - * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - learningpathsRetrieve(requestParameters: LearningpathsApiLearningpathsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.learningpathsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface PlatformsApiPlatformsListRequest { + /** + * Number of results to return per page. + * @type {number} + * @memberof PlatformsApiPlatformsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof PlatformsApiPlatformsList + */ + readonly offset?: number +} /** - * Request parameters for learningpathsCreate operation in LearningpathsApi. + * Request parameters for platformsRetrieve operation in PlatformsApi. * @export - * @interface LearningpathsApiLearningpathsCreateRequest + * @interface PlatformsApiPlatformsRetrieveRequest */ -export interface LearningpathsApiLearningpathsCreateRequest { - /** - * - * @type {LearningPathResourceRequest} - * @memberof LearningpathsApiLearningpathsCreate - */ - readonly LearningPathResourceRequest: LearningPathResourceRequest +export interface PlatformsApiPlatformsRetrieveRequest { + /** + * A unique value identifying this learning resource platform. + * @type {string} + * @memberof PlatformsApiPlatformsRetrieve + */ + readonly code: string } /** - * Request parameters for learningpathsDestroy operation in LearningpathsApi. + * PlatformsApi - object-oriented interface * @export - * @interface LearningpathsApiLearningpathsDestroyRequest + * @class PlatformsApi + * @extends {BaseAPI} */ -export interface LearningpathsApiLearningpathsDestroyRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof LearningpathsApiLearningpathsDestroy - */ - readonly id: number +export class PlatformsApi extends BaseAPI { + /** + * Platforms on which learning resources are hosted + * @summary List + * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlatformsApi + */ + public platformsList( + requestParameters: PlatformsApiPlatformsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return PlatformsApiFp(this.configuration) + .platformsList(requestParameters.limit, requestParameters.offset, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Platforms on which learning resources are hosted + * @summary Retrieve + * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PlatformsApi + */ + public platformsRetrieve( + requestParameters: PlatformsApiPlatformsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return PlatformsApiFp(this.configuration) + .platformsRetrieve(requestParameters.code, options) + .then((request) => request(this.axios, this.basePath)) + } } /** - * Request parameters for learningpathsItemsCreate operation in LearningpathsApi. + * PodcastEpisodesApi - axios parameter creator * @export - * @interface LearningpathsApiLearningpathsItemsCreateRequest */ -export interface LearningpathsApiLearningpathsItemsCreateRequest { +export const PodcastEpisodesApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The learning resource id of the learning path - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsCreate + * Get a paginated list of podcast episodes + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number - + podcastEpisodesList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: PodcastEpisodesListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/podcast_episodes/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {LearningPathRelationshipCreateRequest} - * @memberof LearningpathsApiLearningpathsItemsCreate + * Retrieve a single podcast episode + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly LearningPathRelationshipCreateRequest: LearningPathRelationshipCreateRequest + podcastEpisodesRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("podcastEpisodesRetrieve", "id", id) + const localVarPath = `/api/v1/podcast_episodes/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for learningpathsItemsDestroy operation in LearningpathsApi. + * PodcastEpisodesApi - functional programming interface * @export - * @interface LearningpathsApiLearningpathsItemsDestroyRequest */ -export interface LearningpathsApiLearningpathsItemsDestroyRequest { +export const PodcastEpisodesApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + PodcastEpisodesApiAxiosParamCreator(configuration) + return { /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsDestroy + * Get a paginated list of podcast episodes + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + async podcastEpisodesList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: PodcastEpisodesListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.podcastEpisodesList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastEpisodesApi.podcastEpisodesList"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The learning resource id of the learning path - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsDestroy + * Retrieve a single podcast episode + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly learning_resource_id: number + async podcastEpisodesRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.podcastEpisodesRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastEpisodesApi.podcastEpisodesRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * Request parameters for learningpathsItemsList operation in LearningpathsApi. + * PodcastEpisodesApi - factory interface * @export - * @interface LearningpathsApiLearningpathsItemsListRequest */ -export interface LearningpathsApiLearningpathsItemsListRequest { - /** - * The learning resource id of the learning path - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsList - */ - readonly learning_resource_id: number - - /** - * Number of results to return per page. - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsList - */ - readonly limit?: number - +export const PodcastEpisodesApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = PodcastEpisodesApiFp(configuration) + return { /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsList + * Get a paginated list of podcast episodes + * @summary List + * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + podcastEpisodesList( + requestParameters: PodcastEpisodesApiPodcastEpisodesListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastEpisodesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Which field to use when ordering the results. - * @type {string} - * @memberof LearningpathsApiLearningpathsItemsList + * Retrieve a single podcast episode + * @summary Retrieve + * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: string + podcastEpisodesRetrieve( + requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastEpisodesRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** - * Request parameters for learningpathsItemsPartialUpdate operation in LearningpathsApi. + * Request parameters for podcastEpisodesList operation in PodcastEpisodesApi. * @export - * @interface LearningpathsApiLearningpathsItemsPartialUpdateRequest + * @interface PodcastEpisodesApiPodcastEpisodesListRequest */ -export interface LearningpathsApiLearningpathsItemsPartialUpdateRequest { - /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsPartialUpdate - */ - readonly id: number - - /** - * The learning resource id of the learning path - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsPartialUpdate - */ - readonly learning_resource_id: number - - /** - * - * @type {PatchedLearningPathRelationshipCreateRequest} - * @memberof LearningpathsApiLearningpathsItemsPartialUpdate - */ - readonly PatchedLearningPathRelationshipCreateRequest?: PatchedLearningPathRelationshipCreateRequest +export interface PodcastEpisodesApiPodcastEpisodesListRequest { + /** + * + * @type {boolean} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly sortby?: PodcastEpisodesListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof PodcastEpisodesApiPodcastEpisodesList + */ + readonly topic?: Array } /** - * Request parameters for learningpathsItemsRetrieve operation in LearningpathsApi. + * Request parameters for podcastEpisodesRetrieve operation in PodcastEpisodesApi. * @export - * @interface LearningpathsApiLearningpathsItemsRetrieveRequest + * @interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest */ -export interface LearningpathsApiLearningpathsItemsRetrieveRequest { - /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsRetrieve - */ - readonly id: number - - /** - * The learning resource id of the learning path - * @type {number} - * @memberof LearningpathsApiLearningpathsItemsRetrieve - */ - readonly learning_resource_id: number +export interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof PodcastEpisodesApiPodcastEpisodesRetrieve + */ + readonly id: number } /** - * Request parameters for learningpathsList operation in LearningpathsApi. + * PodcastEpisodesApi - object-oriented interface * @export - * @interface LearningpathsApiLearningpathsListRequest + * @class PodcastEpisodesApi + * @extends {BaseAPI} */ -export interface LearningpathsApiLearningpathsListRequest { - /** - * - * @type {boolean} - * @memberof LearningpathsApiLearningpathsList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof LearningpathsApiLearningpathsList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof LearningpathsApiLearningpathsList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof LearningpathsApiLearningpathsList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof LearningpathsApiLearningpathsList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof LearningpathsApiLearningpathsList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof LearningpathsApiLearningpathsList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof LearningpathsApiLearningpathsList - */ - readonly resource_id?: Array - - /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof LearningpathsApiLearningpathsList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof LearningpathsApiLearningpathsList - */ - readonly sortby?: LearningpathsListSortbyEnum - - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof LearningpathsApiLearningpathsList - */ - readonly topic?: Array +export class PodcastEpisodesApi extends BaseAPI { + /** + * Get a paginated list of podcast episodes + * @summary List + * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastEpisodesApi + */ + public podcastEpisodesList( + requestParameters: PodcastEpisodesApiPodcastEpisodesListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return PodcastEpisodesApiFp(this.configuration) + .podcastEpisodesList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single podcast episode + * @summary Retrieve + * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastEpisodesApi + */ + public podcastEpisodesRetrieve( + requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return PodcastEpisodesApiFp(this.configuration) + .podcastEpisodesRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** - * Request parameters for learningpathsPartialUpdate operation in LearningpathsApi. * @export - * @interface LearningpathsApiLearningpathsPartialUpdateRequest */ -export interface LearningpathsApiLearningpathsPartialUpdateRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof LearningpathsApiLearningpathsPartialUpdate - */ - readonly id: number - - /** - * - * @type {PatchedLearningPathResourceRequest} - * @memberof LearningpathsApiLearningpathsPartialUpdate - */ - readonly PatchedLearningPathResourceRequest?: PatchedLearningPathResourceRequest -} - +export const PodcastEpisodesListCertificationTypeEnum = { + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type PodcastEpisodesListCertificationTypeEnum = + (typeof PodcastEpisodesListCertificationTypeEnum)[keyof typeof PodcastEpisodesListCertificationTypeEnum] /** - * Request parameters for learningpathsRetrieve operation in LearningpathsApi. * @export - * @interface LearningpathsApiLearningpathsRetrieveRequest */ -export interface LearningpathsApiLearningpathsRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof LearningpathsApiLearningpathsRetrieve - */ - readonly id: number -} +export const PodcastEpisodesListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type PodcastEpisodesListDeliveryEnum = + (typeof PodcastEpisodesListDeliveryEnum)[keyof typeof PodcastEpisodesListDeliveryEnum] +/** + * @export + */ +export const PodcastEpisodesListDepartmentEnum = { + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type PodcastEpisodesListDepartmentEnum = + (typeof PodcastEpisodesListDepartmentEnum)[keyof typeof PodcastEpisodesListDepartmentEnum] +/** + * @export + */ +export const PodcastEpisodesListLevelEnum = { + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type PodcastEpisodesListLevelEnum = + (typeof PodcastEpisodesListLevelEnum)[keyof typeof PodcastEpisodesListLevelEnum] +/** + * @export + */ +export const PodcastEpisodesListOfferedByEnum = { + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type PodcastEpisodesListOfferedByEnum = + (typeof PodcastEpisodesListOfferedByEnum)[keyof typeof PodcastEpisodesListOfferedByEnum] +/** + * @export + */ +export const PodcastEpisodesListPlatformEnum = { + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type PodcastEpisodesListPlatformEnum = + (typeof PodcastEpisodesListPlatformEnum)[keyof typeof PodcastEpisodesListPlatformEnum] +/** + * @export + */ +export const PodcastEpisodesListResourceTypeEnum = { + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type PodcastEpisodesListResourceTypeEnum = + (typeof PodcastEpisodesListResourceTypeEnum)[keyof typeof PodcastEpisodesListResourceTypeEnum] +/** + * @export + */ +export const PodcastEpisodesListResourceTypeGroupEnum = { + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type PodcastEpisodesListResourceTypeGroupEnum = + (typeof PodcastEpisodesListResourceTypeGroupEnum)[keyof typeof PodcastEpisodesListResourceTypeGroupEnum] +/** + * @export + */ +export const PodcastEpisodesListSortbyEnum = { + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type PodcastEpisodesListSortbyEnum = + (typeof PodcastEpisodesListSortbyEnum)[keyof typeof PodcastEpisodesListSortbyEnum] /** - * LearningpathsApi - object-oriented interface + * PodcastsApi - axios parameter creator * @export - * @class LearningpathsApi - * @extends {BaseAPI} */ -export class LearningpathsApi extends BaseAPI { +export const PodcastsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * Create a learning path - * @summary Create - * @param {LearningpathsApiLearningpathsCreateRequest} requestParameters Request parameters. + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsCreate(requestParameters: LearningpathsApiLearningpathsCreateRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsCreate(requestParameters.LearningPathResourceRequest, options).then((request) => request(this.axios, this.basePath)); - } - + podcastsItemsList: async ( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "podcastsItemsList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/podcasts/{learning_resource_id}/items/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Remove a learning path - * @summary Destroy - * @param {LearningpathsApiLearningpathsDestroyRequest} requestParameters Request parameters. + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsDestroy(requestParameters: LearningpathsApiLearningpathsDestroyRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - + podcastsItemsRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("podcastsItemsRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "podcastsItemsRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = `/api/v1/podcasts/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Add - * @param {LearningpathsApiLearningpathsItemsCreateRequest} requestParameters Request parameters. + * Get a paginated list of podcasts + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsItemsCreate(requestParameters: LearningpathsApiLearningpathsItemsCreateRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsItemsCreate(requestParameters.learning_resource_id, requestParameters.LearningPathRelationshipCreateRequest, options).then((request) => request(this.axios, this.basePath)); - } - + podcastsList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: PodcastsListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/podcasts/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Remove - * @param {LearningpathsApiLearningpathsItemsDestroyRequest} requestParameters Request parameters. + * Retrieve a single podcast + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsItemsDestroy(requestParameters: LearningpathsApiLearningpathsItemsDestroyRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsItemsDestroy(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } + podcastsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("podcastsRetrieve", "id", id) + const localVarPath = `/api/v1/podcasts/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * PodcastsApi - functional programming interface + * @export + */ +export const PodcastsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = PodcastsApiAxiosParamCreator(configuration) + return { /** - * Viewset for LearningPath related resources - * @param {LearningpathsApiLearningpathsItemsListRequest} requestParameters Request parameters. + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsItemsList(requestParameters: LearningpathsApiLearningpathsItemsListRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(this.axios, this.basePath)); - } - + async podcastsItemsList( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.podcastsItemsList( + learning_resource_id, + limit, + offset, + sortby, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastsApi.podcastsItemsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for LearningPath related resources - * @summary Learning Path Resource Relationship Update - * @param {LearningpathsApiLearningpathsItemsPartialUpdateRequest} requestParameters Request parameters. + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsItemsPartialUpdate(requestParameters: LearningpathsApiLearningpathsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsItemsPartialUpdate(requestParameters.id, requestParameters.learning_resource_id, requestParameters.PatchedLearningPathRelationshipCreateRequest, options).then((request) => request(this.axios, this.basePath)); - } - + async podcastsItemsRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.podcastsItemsRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastsApi.podcastsItemsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {LearningpathsApiLearningpathsItemsRetrieveRequest} requestParameters Request parameters. + * Get a paginated list of podcasts + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsItemsRetrieve(requestParameters: LearningpathsApiLearningpathsItemsRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } - + async podcastsList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: PodcastsListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.podcastsList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastsApi.podcastsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Get a paginated list of learning paths - * @summary List - * @param {LearningpathsApiLearningpathsListRequest} requestParameters Request parameters. + * Retrieve a single podcast + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsList(requestParameters: LearningpathsApiLearningpathsListRequest = {}, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } + async podcastsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.podcastsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["PodcastsApi.podcastsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * PodcastsApi - factory interface + * @export + */ +export const PodcastsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = PodcastsApiFp(configuration) + return { /** - * Get a list of all learning path items - * @summary List + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + podcastsItemsList( + requestParameters: PodcastsApiPodcastsItemsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsMembershipList(options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsMembershipList(options).then((request) => request(this.axios, this.basePath)); - } - + podcastsItemsRetrieve( + requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Update individual fields of a learning path - * @summary Update - * @param {LearningpathsApiLearningpathsPartialUpdateRequest} requestParameters Request parameters. + * Get a paginated list of podcasts + * @summary List + * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsPartialUpdate(requestParameters: LearningpathsApiLearningpathsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsPartialUpdate(requestParameters.id, requestParameters.PatchedLearningPathResourceRequest, options).then((request) => request(this.axios, this.basePath)); - } - + podcastsList( + requestParameters: PodcastsApiPodcastsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Retrive a single learning path + * Retrieve a single podcast * @summary Retrieve - * @param {LearningpathsApiLearningpathsRetrieveRequest} requestParameters Request parameters. + * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof LearningpathsApi */ - public learningpathsRetrieve(requestParameters: LearningpathsApiLearningpathsRetrieveRequest, options?: RawAxiosRequestConfig) { - return LearningpathsApiFp(this.configuration).learningpathsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + podcastsRetrieve( + requestParameters: PodcastsApiPodcastsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .podcastsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for podcastsItemsList operation in PodcastsApi. * @export + * @interface PodcastsApiPodcastsItemsListRequest */ -export const LearningpathsListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type LearningpathsListCertificationTypeEnum = typeof LearningpathsListCertificationTypeEnum[keyof typeof LearningpathsListCertificationTypeEnum]; -/** - * @export - */ -export const LearningpathsListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type LearningpathsListDeliveryEnum = typeof LearningpathsListDeliveryEnum[keyof typeof LearningpathsListDeliveryEnum]; -/** - * @export - */ -export const LearningpathsListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type LearningpathsListDepartmentEnum = typeof LearningpathsListDepartmentEnum[keyof typeof LearningpathsListDepartmentEnum]; -/** - * @export - */ -export const LearningpathsListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type LearningpathsListLevelEnum = typeof LearningpathsListLevelEnum[keyof typeof LearningpathsListLevelEnum]; -/** - * @export - */ -export const LearningpathsListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type LearningpathsListOfferedByEnum = typeof LearningpathsListOfferedByEnum[keyof typeof LearningpathsListOfferedByEnum]; -/** - * @export - */ -export const LearningpathsListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type LearningpathsListPlatformEnum = typeof LearningpathsListPlatformEnum[keyof typeof LearningpathsListPlatformEnum]; -/** - * @export - */ -export const LearningpathsListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type LearningpathsListResourceTypeEnum = typeof LearningpathsListResourceTypeEnum[keyof typeof LearningpathsListResourceTypeEnum]; -/** - * @export - */ -export const LearningpathsListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type LearningpathsListResourceTypeGroupEnum = typeof LearningpathsListResourceTypeGroupEnum[keyof typeof LearningpathsListResourceTypeGroupEnum]; -/** - * @export - */ -export const LearningpathsListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type LearningpathsListSortbyEnum = typeof LearningpathsListSortbyEnum[keyof typeof LearningpathsListSortbyEnum]; - +export interface PodcastsApiPodcastsItemsListRequest { + /** + * id of the parent learning resource + * @type {number} + * @memberof PodcastsApiPodcastsItemsList + */ + readonly learning_resource_id: number + + /** + * Number of results to return per page. + * @type {number} + * @memberof PodcastsApiPodcastsItemsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof PodcastsApiPodcastsItemsList + */ + readonly offset?: number + + /** + * Which field to use when ordering the results. + * @type {string} + * @memberof PodcastsApiPodcastsItemsList + */ + readonly sortby?: string +} /** - * MediaApi - axios parameter creator + * Request parameters for podcastsItemsRetrieve operation in PodcastsApi. * @export + * @interface PodcastsApiPodcastsItemsRetrieveRequest */ -export const MediaApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Upload an image (multipart/form-data) and return the storage URL. - * @param {File} image_file - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - mediaUpload: async (image_file: File, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'image_file' is not null or undefined - assertParamExists('mediaUpload', 'image_file', image_file) - const localVarPath = `/api/v1/upload-media/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - - - if (image_file !== undefined) { - localVarFormParams.append('image_file', image_file as any); - } - - - localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = localVarFormParams; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface PodcastsApiPodcastsItemsRetrieveRequest { + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof PodcastsApiPodcastsItemsRetrieve + */ + readonly id: number -/** - * MediaApi - functional programming interface - * @export - */ -export const MediaApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = MediaApiAxiosParamCreator(configuration) - return { - /** - * Upload an image (multipart/form-data) and return the storage URL. - * @param {File} image_file - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async mediaUpload(image_file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.mediaUpload(image_file, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['MediaApi.mediaUpload']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; + /** + * id of the parent learning resource + * @type {number} + * @memberof PodcastsApiPodcastsItemsRetrieve + */ + readonly learning_resource_id: number +} /** - * MediaApi - factory interface + * Request parameters for podcastsList operation in PodcastsApi. * @export + * @interface PodcastsApiPodcastsListRequest */ -export const MediaApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = MediaApiFp(configuration) - return { - /** - * Upload an image (multipart/form-data) and return the storage URL. - * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - mediaUpload(requestParameters: MediaApiMediaUploadRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.mediaUpload(requestParameters.image_file, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface PodcastsApiPodcastsListRequest { + /** + * + * @type {boolean} + * @memberof PodcastsApiPodcastsList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof PodcastsApiPodcastsList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof PodcastsApiPodcastsList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof PodcastsApiPodcastsList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof PodcastsApiPodcastsList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof PodcastsApiPodcastsList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof PodcastsApiPodcastsList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof PodcastsApiPodcastsList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof PodcastsApiPodcastsList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof PodcastsApiPodcastsList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof PodcastsApiPodcastsList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof PodcastsApiPodcastsList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof PodcastsApiPodcastsList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof PodcastsApiPodcastsList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof PodcastsApiPodcastsList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof PodcastsApiPodcastsList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof PodcastsApiPodcastsList + */ + readonly sortby?: PodcastsListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof PodcastsApiPodcastsList + */ + readonly topic?: Array +} /** - * Request parameters for mediaUpload operation in MediaApi. + * Request parameters for podcastsRetrieve operation in PodcastsApi. * @export - * @interface MediaApiMediaUploadRequest + * @interface PodcastsApiPodcastsRetrieveRequest */ -export interface MediaApiMediaUploadRequest { - /** - * - * @type {File} - * @memberof MediaApiMediaUpload - */ - readonly image_file: File +export interface PodcastsApiPodcastsRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof PodcastsApiPodcastsRetrieve + */ + readonly id: number } /** - * MediaApi - object-oriented interface + * PodcastsApi - object-oriented interface * @export - * @class MediaApi + * @class PodcastsApi * @extends {BaseAPI} */ -export class MediaApi extends BaseAPI { - /** - * Upload an image (multipart/form-data) and return the storage URL. - * @param {MediaApiMediaUploadRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof MediaApi - */ - public mediaUpload(requestParameters: MediaApiMediaUploadRequest, options?: RawAxiosRequestConfig) { - return MediaApiFp(this.configuration).mediaUpload(requestParameters.image_file, options).then((request) => request(this.axios, this.basePath)); - } +export class PodcastsApi extends BaseAPI { + /** + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastsApi + */ + public podcastsItemsList( + requestParameters: PodcastsApiPodcastsItemsListRequest, + options?: RawAxiosRequestConfig, + ) { + return PodcastsApiFp(this.configuration) + .podcastsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastsApi + */ + public podcastsItemsRetrieve( + requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return PodcastsApiFp(this.configuration) + .podcastsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of podcasts + * @summary List + * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastsApi + */ + public podcastsList( + requestParameters: PodcastsApiPodcastsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return PodcastsApiFp(this.configuration) + .podcastsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single podcast + * @summary Retrieve + * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PodcastsApi + */ + public podcastsRetrieve( + requestParameters: PodcastsApiPodcastsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return PodcastsApiFp(this.configuration) + .podcastsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } - - /** - * OfferorsApi - axios parameter creator * @export */ -export const OfferorsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * MIT organizations that offer learning resources - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerorsList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/offerors/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * MIT organizations that offer learning resources - * @summary Retrieve - * @param {string} code A unique value identifying this learning resource offeror. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerorsRetrieve: async (code: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'code' is not null or undefined - assertParamExists('offerorsRetrieve', 'code', code) - const localVarPath = `/api/v1/offerors/{code}/` - .replace(`{${"code"}}`, encodeURIComponent(String(code))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - +export const PodcastsListCertificationTypeEnum = { + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type PodcastsListCertificationTypeEnum = + (typeof PodcastsListCertificationTypeEnum)[keyof typeof PodcastsListCertificationTypeEnum] /** - * OfferorsApi - functional programming interface * @export */ -export const OfferorsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OfferorsApiAxiosParamCreator(configuration) - return { - /** - * MIT organizations that offer learning resources - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerorsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.offerorsList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['OfferorsApi.offerorsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * MIT organizations that offer learning resources - * @summary Retrieve - * @param {string} code A unique value identifying this learning resource offeror. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerorsRetrieve(code: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.offerorsRetrieve(code, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['OfferorsApi.offerorsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - +export const PodcastsListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type PodcastsListDeliveryEnum = + (typeof PodcastsListDeliveryEnum)[keyof typeof PodcastsListDeliveryEnum] /** - * OfferorsApi - factory interface * @export */ -export const OfferorsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OfferorsApiFp(configuration) - return { - /** - * MIT organizations that offer learning resources - * @summary List - * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerorsList(requestParameters: OfferorsApiOfferorsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.offerorsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * MIT organizations that offer learning resources - * @summary Retrieve - * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerorsRetrieve(requestParameters: OfferorsApiOfferorsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.offerorsRetrieve(requestParameters.code, options).then((request) => request(axios, basePath)); - }, - }; -}; - +export const PodcastsListDepartmentEnum = { + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type PodcastsListDepartmentEnum = + (typeof PodcastsListDepartmentEnum)[keyof typeof PodcastsListDepartmentEnum] /** - * Request parameters for offerorsList operation in OfferorsApi. * @export - * @interface OfferorsApiOfferorsListRequest */ -export interface OfferorsApiOfferorsListRequest { - /** - * Number of results to return per page. - * @type {number} - * @memberof OfferorsApiOfferorsList - */ - readonly limit?: number - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof OfferorsApiOfferorsList - */ - readonly offset?: number -} - +export const PodcastsListLevelEnum = { + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type PodcastsListLevelEnum = + (typeof PodcastsListLevelEnum)[keyof typeof PodcastsListLevelEnum] /** - * Request parameters for offerorsRetrieve operation in OfferorsApi. * @export - * @interface OfferorsApiOfferorsRetrieveRequest */ -export interface OfferorsApiOfferorsRetrieveRequest { - /** - * A unique value identifying this learning resource offeror. - * @type {string} - * @memberof OfferorsApiOfferorsRetrieve - */ - readonly code: string -} - +export const PodcastsListOfferedByEnum = { + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type PodcastsListOfferedByEnum = + (typeof PodcastsListOfferedByEnum)[keyof typeof PodcastsListOfferedByEnum] /** - * OfferorsApi - object-oriented interface * @export - * @class OfferorsApi - * @extends {BaseAPI} */ -export class OfferorsApi extends BaseAPI { - /** - * MIT organizations that offer learning resources - * @summary List - * @param {OfferorsApiOfferorsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferorsApi - */ - public offerorsList(requestParameters: OfferorsApiOfferorsListRequest = {}, options?: RawAxiosRequestConfig) { - return OfferorsApiFp(this.configuration).offerorsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * MIT organizations that offer learning resources - * @summary Retrieve - * @param {OfferorsApiOfferorsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferorsApi - */ - public offerorsRetrieve(requestParameters: OfferorsApiOfferorsRetrieveRequest, options?: RawAxiosRequestConfig) { - return OfferorsApiFp(this.configuration).offerorsRetrieve(requestParameters.code, options).then((request) => request(this.axios, this.basePath)); - } -} - - - +export const PodcastsListPlatformEnum = { + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type PodcastsListPlatformEnum = + (typeof PodcastsListPlatformEnum)[keyof typeof PodcastsListPlatformEnum] /** - * PlatformsApi - axios parameter creator * @export */ -export const PlatformsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Platforms on which learning resources are hosted - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - platformsList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/platforms/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Platforms on which learning resources are hosted - * @summary Retrieve - * @param {string} code A unique value identifying this learning resource platform. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - platformsRetrieve: async (code: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'code' is not null or undefined - assertParamExists('platformsRetrieve', 'code', code) - const localVarPath = `/api/v1/platforms/{code}/` - .replace(`{${"code"}}`, encodeURIComponent(String(code))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - +export const PodcastsListResourceTypeEnum = { + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type PodcastsListResourceTypeEnum = + (typeof PodcastsListResourceTypeEnum)[keyof typeof PodcastsListResourceTypeEnum] /** - * PlatformsApi - functional programming interface * @export */ -export const PlatformsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PlatformsApiAxiosParamCreator(configuration) - return { - /** - * Platforms on which learning resources are hosted - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async platformsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.platformsList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PlatformsApi.platformsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Platforms on which learning resources are hosted - * @summary Retrieve - * @param {string} code A unique value identifying this learning resource platform. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async platformsRetrieve(code: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.platformsRetrieve(code, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PlatformsApi.platformsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - +export const PodcastsListResourceTypeGroupEnum = { + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type PodcastsListResourceTypeGroupEnum = + (typeof PodcastsListResourceTypeGroupEnum)[keyof typeof PodcastsListResourceTypeGroupEnum] /** - * PlatformsApi - factory interface * @export */ -export const PlatformsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PlatformsApiFp(configuration) - return { - /** - * Platforms on which learning resources are hosted - * @summary List - * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - platformsList(requestParameters: PlatformsApiPlatformsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.platformsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Platforms on which learning resources are hosted - * @summary Retrieve - * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - platformsRetrieve(requestParameters: PlatformsApiPlatformsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.platformsRetrieve(requestParameters.code, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const PodcastsListSortbyEnum = { + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type PodcastsListSortbyEnum = + (typeof PodcastsListSortbyEnum)[keyof typeof PodcastsListSortbyEnum] /** - * Request parameters for platformsList operation in PlatformsApi. + * ProgramLettersApi - axios parameter creator * @export - * @interface PlatformsApiPlatformsListRequest */ -export interface PlatformsApiPlatformsListRequest { - /** - * Number of results to return per page. - * @type {number} - * @memberof PlatformsApiPlatformsList - */ - readonly limit?: number - +export const ProgramLettersApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The initial index from which to return the results. - * @type {number} - * @memberof PlatformsApiPlatformsList + * Detail only View for program letters + * @param {string} id A UUID string identifying this program letter. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number + programLettersRetrieve: async ( + id: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("programLettersRetrieve", "id", id) + const localVarPath = `/api/v1/program_letters/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for platformsRetrieve operation in PlatformsApi. + * ProgramLettersApi - functional programming interface * @export - * @interface PlatformsApiPlatformsRetrieveRequest */ -export interface PlatformsApiPlatformsRetrieveRequest { +export const ProgramLettersApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + ProgramLettersApiAxiosParamCreator(configuration) + return { /** - * A unique value identifying this learning resource platform. - * @type {string} - * @memberof PlatformsApiPlatformsRetrieve + * Detail only View for program letters + * @param {string} id A UUID string identifying this program letter. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly code: string + async programLettersRetrieve( + id: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.programLettersRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProgramLettersApi.programLettersRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * PlatformsApi - object-oriented interface + * ProgramLettersApi - factory interface * @export - * @class PlatformsApi - * @extends {BaseAPI} */ -export class PlatformsApi extends BaseAPI { - /** - * Platforms on which learning resources are hosted - * @summary List - * @param {PlatformsApiPlatformsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof PlatformsApi - */ - public platformsList(requestParameters: PlatformsApiPlatformsListRequest = {}, options?: RawAxiosRequestConfig) { - return PlatformsApiFp(this.configuration).platformsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - +export const ProgramLettersApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ProgramLettersApiFp(configuration) + return { /** - * Platforms on which learning resources are hosted - * @summary Retrieve - * @param {PlatformsApiPlatformsRetrieveRequest} requestParameters Request parameters. + * Detail only View for program letters + * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PlatformsApi */ - public platformsRetrieve(requestParameters: PlatformsApiPlatformsRetrieveRequest, options?: RawAxiosRequestConfig) { - return PlatformsApiFp(this.configuration).platformsRetrieve(requestParameters.code, options).then((request) => request(this.axios, this.basePath)); - } + programLettersRetrieve( + requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .programLettersRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - -/** - * PodcastEpisodesApi - axios parameter creator - * @export - */ -export const PodcastEpisodesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a paginated list of podcast episodes - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastEpisodesList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastEpisodesListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/podcast_episodes/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single podcast episode - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastEpisodesRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('podcastEpisodesRetrieve', 'id', id) - const localVarPath = `/api/v1/podcast_episodes/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * PodcastEpisodesApi - functional programming interface - * @export - */ -export const PodcastEpisodesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PodcastEpisodesApiAxiosParamCreator(configuration) - return { - /** - * Get a paginated list of podcast episodes - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {PodcastEpisodesListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastEpisodesList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastEpisodesListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastEpisodesList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastEpisodesApi.podcastEpisodesList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single podcast episode - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastEpisodesRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastEpisodesRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastEpisodesApi.podcastEpisodesRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - /** - * PodcastEpisodesApi - factory interface + * Request parameters for programLettersRetrieve operation in ProgramLettersApi. * @export + * @interface ProgramLettersApiProgramLettersRetrieveRequest */ -export const PodcastEpisodesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PodcastEpisodesApiFp(configuration) - return { - /** - * Get a paginated list of podcast episodes - * @summary List - * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastEpisodesList(requestParameters: PodcastEpisodesApiPodcastEpisodesListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastEpisodesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single podcast episode - * @summary Retrieve - * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastEpisodesRetrieve(requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastEpisodesRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export interface ProgramLettersApiProgramLettersRetrieveRequest { + /** + * A UUID string identifying this program letter. + * @type {string} + * @memberof ProgramLettersApiProgramLettersRetrieve + */ + readonly id: string +} /** - * Request parameters for podcastEpisodesList operation in PodcastEpisodesApi. + * ProgramLettersApi - object-oriented interface * @export - * @interface PodcastEpisodesApiPodcastEpisodesListRequest + * @class ProgramLettersApi + * @extends {BaseAPI} */ -export interface PodcastEpisodesApiPodcastEpisodesListRequest { - /** - * - * @type {boolean} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly resource_id?: Array - - /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof PodcastEpisodesApiPodcastEpisodesList - */ - readonly resource_type_group?: Array +export class ProgramLettersApi extends BaseAPI { + /** + * Detail only View for program letters + * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProgramLettersApi + */ + public programLettersRetrieve( + requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ProgramLettersApiFp(this.configuration) + .programLettersRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} +/** + * ProgramsApi - axios parameter creator + * @export + */ +export const ProgramsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof PodcastEpisodesApiPodcastEpisodesList + * Get a paginated list of programs + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: PodcastEpisodesListSortbyEnum - + programsList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: ProgramsListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/programs/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof PodcastEpisodesApiPodcastEpisodesList + * Retrieve a single program + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array + programsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("programsRetrieve", "id", id) + const localVarPath = `/api/v1/programs/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for podcastEpisodesRetrieve operation in PodcastEpisodesApi. + * ProgramsApi - functional programming interface * @export - * @interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest */ -export interface PodcastEpisodesApiPodcastEpisodesRetrieveRequest { +export const ProgramsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = ProgramsApiAxiosParamCreator(configuration) + return { + /** + * Get a paginated list of programs + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async programsList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: ProgramsListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.programsList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProgramsApi.programsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof PodcastEpisodesApiPodcastEpisodesRetrieve + * Retrieve a single program + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async programsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.programsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["ProgramsApi.programsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * PodcastEpisodesApi - object-oriented interface + * ProgramsApi - factory interface * @export - * @class PodcastEpisodesApi - * @extends {BaseAPI} */ -export class PodcastEpisodesApi extends BaseAPI { +export const ProgramsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = ProgramsApiFp(configuration) + return { /** - * Get a paginated list of podcast episodes + * Get a paginated list of programs * @summary List - * @param {PodcastEpisodesApiPodcastEpisodesListRequest} requestParameters Request parameters. + * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastEpisodesApi */ - public podcastEpisodesList(requestParameters: PodcastEpisodesApiPodcastEpisodesListRequest = {}, options?: RawAxiosRequestConfig) { - return PodcastEpisodesApiFp(this.configuration).podcastEpisodesList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - + programsList( + requestParameters: ProgramsApiProgramsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .programsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Retrieve a single podcast episode + * Retrieve a single program * @summary Retrieve - * @param {PodcastEpisodesApiPodcastEpisodesRetrieveRequest} requestParameters Request parameters. + * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastEpisodesApi */ - public podcastEpisodesRetrieve(requestParameters: PodcastEpisodesApiPodcastEpisodesRetrieveRequest, options?: RawAxiosRequestConfig) { - return PodcastEpisodesApiFp(this.configuration).podcastEpisodesRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + programsRetrieve( + requestParameters: ProgramsApiProgramsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .programsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for programsList operation in ProgramsApi. * @export + * @interface ProgramsApiProgramsListRequest */ -export const PodcastEpisodesListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type PodcastEpisodesListCertificationTypeEnum = typeof PodcastEpisodesListCertificationTypeEnum[keyof typeof PodcastEpisodesListCertificationTypeEnum]; -/** - * @export - */ -export const PodcastEpisodesListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type PodcastEpisodesListDeliveryEnum = typeof PodcastEpisodesListDeliveryEnum[keyof typeof PodcastEpisodesListDeliveryEnum]; -/** - * @export - */ -export const PodcastEpisodesListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type PodcastEpisodesListDepartmentEnum = typeof PodcastEpisodesListDepartmentEnum[keyof typeof PodcastEpisodesListDepartmentEnum]; +export interface ProgramsApiProgramsListRequest { + /** + * + * @type {boolean} + * @memberof ProgramsApiProgramsList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof ProgramsApiProgramsList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof ProgramsApiProgramsList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof ProgramsApiProgramsList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof ProgramsApiProgramsList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof ProgramsApiProgramsList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof ProgramsApiProgramsList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof ProgramsApiProgramsList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof ProgramsApiProgramsList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof ProgramsApiProgramsList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof ProgramsApiProgramsList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof ProgramsApiProgramsList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof ProgramsApiProgramsList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof ProgramsApiProgramsList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof ProgramsApiProgramsList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof ProgramsApiProgramsList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof ProgramsApiProgramsList + */ + readonly sortby?: ProgramsListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof ProgramsApiProgramsList + */ + readonly topic?: Array +} + /** + * Request parameters for programsRetrieve operation in ProgramsApi. * @export + * @interface ProgramsApiProgramsRetrieveRequest */ -export const PodcastEpisodesListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type PodcastEpisodesListLevelEnum = typeof PodcastEpisodesListLevelEnum[keyof typeof PodcastEpisodesListLevelEnum]; +export interface ProgramsApiProgramsRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof ProgramsApiProgramsRetrieve + */ + readonly id: number +} + /** + * ProgramsApi - object-oriented interface * @export + * @class ProgramsApi + * @extends {BaseAPI} */ -export const PodcastEpisodesListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type PodcastEpisodesListOfferedByEnum = typeof PodcastEpisodesListOfferedByEnum[keyof typeof PodcastEpisodesListOfferedByEnum]; +export class ProgramsApi extends BaseAPI { + /** + * Get a paginated list of programs + * @summary List + * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProgramsApi + */ + public programsList( + requestParameters: ProgramsApiProgramsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return ProgramsApiFp(this.configuration) + .programsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single program + * @summary Retrieve + * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProgramsApi + */ + public programsRetrieve( + requestParameters: ProgramsApiProgramsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return ProgramsApiFp(this.configuration) + .programsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} + /** * @export */ -export const PodcastEpisodesListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type PodcastEpisodesListPlatformEnum = typeof PodcastEpisodesListPlatformEnum[keyof typeof PodcastEpisodesListPlatformEnum]; +export const ProgramsListCertificationTypeEnum = { + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type ProgramsListCertificationTypeEnum = + (typeof ProgramsListCertificationTypeEnum)[keyof typeof ProgramsListCertificationTypeEnum] /** * @export */ -export const PodcastEpisodesListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type PodcastEpisodesListResourceTypeEnum = typeof PodcastEpisodesListResourceTypeEnum[keyof typeof PodcastEpisodesListResourceTypeEnum]; +export const ProgramsListDeliveryEnum = { + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type ProgramsListDeliveryEnum = + (typeof ProgramsListDeliveryEnum)[keyof typeof ProgramsListDeliveryEnum] /** * @export */ -export const PodcastEpisodesListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type PodcastEpisodesListResourceTypeGroupEnum = typeof PodcastEpisodesListResourceTypeGroupEnum[keyof typeof PodcastEpisodesListResourceTypeGroupEnum]; +export const ProgramsListDepartmentEnum = { + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type ProgramsListDepartmentEnum = + (typeof ProgramsListDepartmentEnum)[keyof typeof ProgramsListDepartmentEnum] /** * @export */ -export const PodcastEpisodesListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type PodcastEpisodesListSortbyEnum = typeof PodcastEpisodesListSortbyEnum[keyof typeof PodcastEpisodesListSortbyEnum]; - - +export const ProgramsListLevelEnum = { + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type ProgramsListLevelEnum = + (typeof ProgramsListLevelEnum)[keyof typeof ProgramsListLevelEnum] /** - * PodcastsApi - axios parameter creator * @export */ -export const PodcastsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsItemsList: async (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('podcastsItemsList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/podcasts/{learning_resource_id}/items/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsItemsRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('podcastsItemsRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('podcastsItemsRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/podcasts/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of podcasts - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastsListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/podcasts/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single podcast - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('podcastsRetrieve', 'id', id) - const localVarPath = `/api/v1/podcasts/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - +export const ProgramsListOfferedByEnum = { + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type ProgramsListOfferedByEnum = + (typeof ProgramsListOfferedByEnum)[keyof typeof ProgramsListOfferedByEnum] /** - * PodcastsApi - functional programming interface * @export */ -export const PodcastsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = PodcastsApiAxiosParamCreator(configuration) - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastsItemsList(learning_resource_id, limit, offset, sortby, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastsApi.podcastsItemsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastsItemsRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastsApi.podcastsItemsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of podcasts - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {PodcastsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: PodcastsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastsList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastsApi.podcastsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single podcast - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async podcastsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.podcastsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['PodcastsApi.podcastsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - +export const ProgramsListPlatformEnum = { + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type ProgramsListPlatformEnum = + (typeof ProgramsListPlatformEnum)[keyof typeof ProgramsListPlatformEnum] /** - * PodcastsApi - factory interface * @export */ -export const PodcastsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = PodcastsApiFp(configuration) - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsItemsList(requestParameters: PodcastsApiPodcastsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(axios, basePath)); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsItemsRetrieve(requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of podcasts - * @summary List - * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsList(requestParameters: PodcastsApiPodcastsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single podcast - * @summary Retrieve - * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - podcastsRetrieve(requestParameters: PodcastsApiPodcastsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.podcastsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - +export const ProgramsListResourceTypeEnum = { + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type ProgramsListResourceTypeEnum = + (typeof ProgramsListResourceTypeEnum)[keyof typeof ProgramsListResourceTypeEnum] /** - * Request parameters for podcastsItemsList operation in PodcastsApi. * @export - * @interface PodcastsApiPodcastsItemsListRequest */ -export interface PodcastsApiPodcastsItemsListRequest { - /** - * id of the parent learning resource - * @type {number} - * @memberof PodcastsApiPodcastsItemsList - */ - readonly learning_resource_id: number - - /** - * Number of results to return per page. - * @type {number} - * @memberof PodcastsApiPodcastsItemsList - */ - readonly limit?: number - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof PodcastsApiPodcastsItemsList - */ - readonly offset?: number - - /** - * Which field to use when ordering the results. - * @type {string} - * @memberof PodcastsApiPodcastsItemsList - */ - readonly sortby?: string -} - +export const ProgramsListResourceTypeGroupEnum = { + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type ProgramsListResourceTypeGroupEnum = + (typeof ProgramsListResourceTypeGroupEnum)[keyof typeof ProgramsListResourceTypeGroupEnum] /** - * Request parameters for podcastsItemsRetrieve operation in PodcastsApi. * @export - * @interface PodcastsApiPodcastsItemsRetrieveRequest */ -export interface PodcastsApiPodcastsItemsRetrieveRequest { - /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof PodcastsApiPodcastsItemsRetrieve - */ - readonly id: number - - /** - * id of the parent learning resource - * @type {number} - * @memberof PodcastsApiPodcastsItemsRetrieve - */ - readonly learning_resource_id: number -} +export const ProgramsListSortbyEnum = { + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type ProgramsListSortbyEnum = + (typeof ProgramsListSortbyEnum)[keyof typeof ProgramsListSortbyEnum] /** - * Request parameters for podcastsList operation in PodcastsApi. + * SchoolsApi - axios parameter creator * @export - * @interface PodcastsApiPodcastsListRequest */ -export interface PodcastsApiPodcastsListRequest { - /** - * - * @type {boolean} - * @memberof PodcastsApiPodcastsList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof PodcastsApiPodcastsList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof PodcastsApiPodcastsList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof PodcastsApiPodcastsList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof PodcastsApiPodcastsList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof PodcastsApiPodcastsList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof PodcastsApiPodcastsList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof PodcastsApiPodcastsList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof PodcastsApiPodcastsList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof PodcastsApiPodcastsList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof PodcastsApiPodcastsList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof PodcastsApiPodcastsList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof PodcastsApiPodcastsList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof PodcastsApiPodcastsList - */ - readonly resource_id?: Array - +export const SchoolsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof PodcastsApiPodcastsList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof PodcastsApiPodcastsList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof PodcastsApiPodcastsList - */ - readonly sortby?: PodcastsListSortbyEnum - - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof PodcastsApiPodcastsList + * MIT schools + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array -} - -/** - * Request parameters for podcastsRetrieve operation in PodcastsApi. - * @export - * @interface PodcastsApiPodcastsRetrieveRequest - */ -export interface PodcastsApiPodcastsRetrieveRequest { + schoolsList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/schools/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof PodcastsApiPodcastsRetrieve + * MIT schools + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource school. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + schoolsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("schoolsRetrieve", "id", id) + const localVarPath = `/api/v1/schools/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * PodcastsApi - object-oriented interface + * SchoolsApi - functional programming interface * @export - * @class PodcastsApi - * @extends {BaseAPI} */ -export class PodcastsApi extends BaseAPI { +export const SchoolsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = SchoolsApiAxiosParamCreator(configuration) + return { /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {PodcastsApiPodcastsItemsListRequest} requestParameters Request parameters. + * MIT schools + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastsApi */ - public podcastsItemsList(requestParameters: PodcastsApiPodcastsItemsListRequest, options?: RawAxiosRequestConfig) { - return PodcastsApiFp(this.configuration).podcastsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(this.axios, this.basePath)); - } - + async schoolsList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.schoolsList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["SchoolsApi.schoolsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {PodcastsApiPodcastsItemsRetrieveRequest} requestParameters Request parameters. + * MIT schools + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource school. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastsApi */ - public podcastsItemsRetrieve(requestParameters: PodcastsApiPodcastsItemsRetrieveRequest, options?: RawAxiosRequestConfig) { - return PodcastsApiFp(this.configuration).podcastsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } + async schoolsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.schoolsRetrieve( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["SchoolsApi.schoolsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} +/** + * SchoolsApi - factory interface + * @export + */ +export const SchoolsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = SchoolsApiFp(configuration) + return { /** - * Get a paginated list of podcasts + * MIT schools * @summary List - * @param {PodcastsApiPodcastsListRequest} requestParameters Request parameters. + * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastsApi */ - public podcastsList(requestParameters: PodcastsApiPodcastsListRequest = {}, options?: RawAxiosRequestConfig) { - return PodcastsApiFp(this.configuration).podcastsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - + schoolsList( + requestParameters: SchoolsApiSchoolsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .schoolsList(requestParameters.limit, requestParameters.offset, options) + .then((request) => request(axios, basePath)) + }, /** - * Retrieve a single podcast + * MIT schools * @summary Retrieve - * @param {PodcastsApiPodcastsRetrieveRequest} requestParameters Request parameters. + * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PodcastsApi */ - public podcastsRetrieve(requestParameters: PodcastsApiPodcastsRetrieveRequest, options?: RawAxiosRequestConfig) { - return PodcastsApiFp(this.configuration).podcastsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + schoolsRetrieve( + requestParameters: SchoolsApiSchoolsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .schoolsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for schoolsList operation in SchoolsApi. * @export + * @interface SchoolsApiSchoolsListRequest */ -export const PodcastsListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type PodcastsListCertificationTypeEnum = typeof PodcastsListCertificationTypeEnum[keyof typeof PodcastsListCertificationTypeEnum]; -/** - * @export - */ -export const PodcastsListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type PodcastsListDeliveryEnum = typeof PodcastsListDeliveryEnum[keyof typeof PodcastsListDeliveryEnum]; -/** - * @export - */ -export const PodcastsListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type PodcastsListDepartmentEnum = typeof PodcastsListDepartmentEnum[keyof typeof PodcastsListDepartmentEnum]; -/** - * @export - */ -export const PodcastsListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type PodcastsListLevelEnum = typeof PodcastsListLevelEnum[keyof typeof PodcastsListLevelEnum]; -/** - * @export - */ -export const PodcastsListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type PodcastsListOfferedByEnum = typeof PodcastsListOfferedByEnum[keyof typeof PodcastsListOfferedByEnum]; -/** - * @export - */ -export const PodcastsListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type PodcastsListPlatformEnum = typeof PodcastsListPlatformEnum[keyof typeof PodcastsListPlatformEnum]; -/** - * @export - */ -export const PodcastsListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type PodcastsListResourceTypeEnum = typeof PodcastsListResourceTypeEnum[keyof typeof PodcastsListResourceTypeEnum]; -/** - * @export - */ -export const PodcastsListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type PodcastsListResourceTypeGroupEnum = typeof PodcastsListResourceTypeGroupEnum[keyof typeof PodcastsListResourceTypeGroupEnum]; -/** - * @export - */ -export const PodcastsListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type PodcastsListSortbyEnum = typeof PodcastsListSortbyEnum[keyof typeof PodcastsListSortbyEnum]; +export interface SchoolsApiSchoolsListRequest { + /** + * Number of results to return per page. + * @type {number} + * @memberof SchoolsApiSchoolsList + */ + readonly limit?: number + /** + * The initial index from which to return the results. + * @type {number} + * @memberof SchoolsApiSchoolsList + */ + readonly offset?: number +} /** - * ProgramLettersApi - axios parameter creator + * Request parameters for schoolsRetrieve operation in SchoolsApi. * @export + * @interface SchoolsApiSchoolsRetrieveRequest */ -export const ProgramLettersApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Detail only View for program letters - * @param {string} id A UUID string identifying this program letter. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programLettersRetrieve: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('programLettersRetrieve', 'id', id) - const localVarPath = `/api/v1/program_letters/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface SchoolsApiSchoolsRetrieveRequest { + /** + * A unique integer value identifying this learning resource school. + * @type {number} + * @memberof SchoolsApiSchoolsRetrieve + */ + readonly id: number +} /** - * ProgramLettersApi - functional programming interface + * SchoolsApi - object-oriented interface * @export + * @class SchoolsApi + * @extends {BaseAPI} */ -export const ProgramLettersApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ProgramLettersApiAxiosParamCreator(configuration) - return { - /** - * Detail only View for program letters - * @param {string} id A UUID string identifying this program letter. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async programLettersRetrieve(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.programLettersRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProgramLettersApi.programLettersRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export class SchoolsApi extends BaseAPI { + /** + * MIT schools + * @summary List + * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SchoolsApi + */ + public schoolsList( + requestParameters: SchoolsApiSchoolsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return SchoolsApiFp(this.configuration) + .schoolsList(requestParameters.limit, requestParameters.offset, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * MIT schools + * @summary Retrieve + * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SchoolsApi + */ + public schoolsRetrieve( + requestParameters: SchoolsApiSchoolsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return SchoolsApiFp(this.configuration) + .schoolsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * ProgramLettersApi - factory interface + * TopicsApi - axios parameter creator * @export */ -export const ProgramLettersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ProgramLettersApiFp(configuration) - return { - /** - * Detail only View for program letters - * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programLettersRetrieve(requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.programLettersRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export const TopicsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { + /** + * Topics covered by learning resources + * @summary List + * @param {boolean} [is_toplevel] Filter top-level topics + * @param {number} [limit] Number of results to return per page. + * @param {Array} [name] Topic name + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [parent_topic_id] Parent topic ID + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + topicsList: async ( + is_toplevel?: boolean, + limit?: number, + name?: Array, + offset?: number, + parent_topic_id?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/topics/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (is_toplevel !== undefined) { + localVarQueryParameter["is_toplevel"] = is_toplevel + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (name) { + localVarQueryParameter["name"] = name + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (parent_topic_id) { + localVarQueryParameter["parent_topic_id"] = parent_topic_id + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + /** + * Topics covered by learning resources + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource topic. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + topicsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("topicsRetrieve", "id", id) + const localVarPath = `/api/v1/topics/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} /** - * Request parameters for programLettersRetrieve operation in ProgramLettersApi. + * TopicsApi - functional programming interface * @export - * @interface ProgramLettersApiProgramLettersRetrieveRequest */ -export interface ProgramLettersApiProgramLettersRetrieveRequest { +export const TopicsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = TopicsApiAxiosParamCreator(configuration) + return { + /** + * Topics covered by learning resources + * @summary List + * @param {boolean} [is_toplevel] Filter top-level topics + * @param {number} [limit] Number of results to return per page. + * @param {Array} [name] Topic name + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [parent_topic_id] Parent topic ID + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async topicsList( + is_toplevel?: boolean, + limit?: number, + name?: Array, + offset?: number, + parent_topic_id?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.topicsList( + is_toplevel, + limit, + name, + offset, + parent_topic_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TopicsApi.topicsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A UUID string identifying this program letter. - * @type {string} - * @memberof ProgramLettersApiProgramLettersRetrieve + * Topics covered by learning resources + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource topic. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: string + async topicsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.topicsRetrieve( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["TopicsApi.topicsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * ProgramLettersApi - object-oriented interface + * TopicsApi - factory interface * @export - * @class ProgramLettersApi - * @extends {BaseAPI} */ -export class ProgramLettersApi extends BaseAPI { +export const TopicsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = TopicsApiFp(configuration) + return { /** - * Detail only View for program letters - * @param {ProgramLettersApiProgramLettersRetrieveRequest} requestParameters Request parameters. + * Topics covered by learning resources + * @summary List + * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + topicsList( + requestParameters: TopicsApiTopicsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .topicsList( + requestParameters.is_toplevel, + requestParameters.limit, + requestParameters.name, + requestParameters.offset, + requestParameters.parent_topic_id, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * Topics covered by learning resources + * @summary Retrieve + * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProgramLettersApi */ - public programLettersRetrieve(requestParameters: ProgramLettersApiProgramLettersRetrieveRequest, options?: RawAxiosRequestConfig) { - return ProgramLettersApiFp(this.configuration).programLettersRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + topicsRetrieve( + requestParameters: TopicsApiTopicsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .topicsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - /** - * ProgramsApi - axios parameter creator + * Request parameters for topicsList operation in TopicsApi. * @export + * @interface TopicsApiTopicsListRequest */ -export const ProgramsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a paginated list of programs - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programsList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: ProgramsListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/programs/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single program - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('programsRetrieve', 'id', id) - const localVarPath = `/api/v1/programs/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface TopicsApiTopicsListRequest { + /** + * Filter top-level topics + * @type {boolean} + * @memberof TopicsApiTopicsList + */ + readonly is_toplevel?: boolean + + /** + * Number of results to return per page. + * @type {number} + * @memberof TopicsApiTopicsList + */ + readonly limit?: number + + /** + * Topic name + * @type {Array} + * @memberof TopicsApiTopicsList + */ + readonly name?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof TopicsApiTopicsList + */ + readonly offset?: number + + /** + * Parent topic ID + * @type {Array} + * @memberof TopicsApiTopicsList + */ + readonly parent_topic_id?: Array +} /** - * ProgramsApi - functional programming interface + * Request parameters for topicsRetrieve operation in TopicsApi. * @export + * @interface TopicsApiTopicsRetrieveRequest */ -export const ProgramsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ProgramsApiAxiosParamCreator(configuration) - return { - /** - * Get a paginated list of programs - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {ProgramsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async programsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: ProgramsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.programsList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProgramsApi.programsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single program - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async programsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.programsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['ProgramsApi.programsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface TopicsApiTopicsRetrieveRequest { + /** + * A unique integer value identifying this learning resource topic. + * @type {number} + * @memberof TopicsApiTopicsRetrieve + */ + readonly id: number +} /** - * ProgramsApi - factory interface + * TopicsApi - object-oriented interface * @export + * @class TopicsApi + * @extends {BaseAPI} */ -export const ProgramsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ProgramsApiFp(configuration) - return { - /** - * Get a paginated list of programs - * @summary List - * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programsList(requestParameters: ProgramsApiProgramsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.programsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single program - * @summary Retrieve - * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - programsRetrieve(requestParameters: ProgramsApiProgramsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.programsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class TopicsApi extends BaseAPI { + /** + * Topics covered by learning resources + * @summary List + * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TopicsApi + */ + public topicsList( + requestParameters: TopicsApiTopicsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return TopicsApiFp(this.configuration) + .topicsList( + requestParameters.is_toplevel, + requestParameters.limit, + requestParameters.name, + requestParameters.offset, + requestParameters.parent_topic_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Topics covered by learning resources + * @summary Retrieve + * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TopicsApi + */ + public topicsRetrieve( + requestParameters: TopicsApiTopicsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return TopicsApiFp(this.configuration) + .topicsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for programsList operation in ProgramsApi. + * UserlistsApi - axios parameter creator * @export - * @interface ProgramsApiProgramsListRequest */ -export interface ProgramsApiProgramsListRequest { - /** - * - * @type {boolean} - * @memberof ProgramsApiProgramsList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof ProgramsApiProgramsList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof ProgramsApiProgramsList - */ - readonly course_feature?: Array - +export const UserlistsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Create + * @param {UserListRequest} UserListRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly delivery?: Array> - + userlistsCreate: async ( + UserListRequest: UserListRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'UserListRequest' is not null or undefined + assertParamExists("userlistsCreate", "UserListRequest", UserListRequest) + const localVarPath = `/api/v1/userlists/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + UserListRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Destroy + * @param {number} id A unique integer value identifying this user list. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly department?: Array - + userlistsDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsDestroy", "id", id) + const localVarPath = `/api/v1/userlists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The course/program is offered for free - * @type {boolean} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Add + * @param {number} userlist_id id of the parent user list + * @param {UserListRelationshipRequest} UserListRelationshipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly free?: boolean - + userlistsItemsCreate: async ( + userlist_id: number, + UserListRelationshipRequest: UserListRelationshipRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'userlist_id' is not null or undefined + assertParamExists("userlistsItemsCreate", "userlist_id", userlist_id) + // verify required parameter 'UserListRelationshipRequest' is not null or undefined + assertParamExists( + "userlistsItemsCreate", + "UserListRelationshipRequest", + UserListRelationshipRequest, + ) + const localVarPath = `/api/v1/userlists/{userlist_id}/items/`.replace( + `{${"userlist_id"}}`, + encodeURIComponent(String(userlist_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + UserListRelationshipRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Remove + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly level?: Array - + userlistsItemsDestroy: async ( + id: number, + userlist_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsItemsDestroy", "id", id) + // verify required parameter 'userlist_id' is not null or undefined + assertParamExists("userlistsItemsDestroy", "userlist_id", userlist_id) + const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Number of results to return per page. - * @type {number} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resources List + * @param {number} userlist_id id of the parent user list + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + userlistsItemsList: async ( + userlist_id: number, + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'userlist_id' is not null or undefined + assertParamExists("userlistsItemsList", "userlist_id", userlist_id) + const localVarPath = `/api/v1/userlists/{userlist_id}/items/`.replace( + `{${"userlist_id"}}`, + encodeURIComponent(String(userlist_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Update + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list + * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offered_by?: Array - + userlistsItemsPartialUpdate: async ( + id: number, + userlist_id: number, + PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsItemsPartialUpdate", "id", id) + // verify required parameter 'userlist_id' is not null or undefined + assertParamExists( + "userlistsItemsPartialUpdate", + "userlist_id", + userlist_id, + ) + const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedUserListRelationshipRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resources Retrieve + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + userlistsItemsRetrieve: async ( + id: number, + userlist_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsItemsRetrieve", "id", id) + // verify required parameter 'userlist_id' is not null or undefined + assertParamExists("userlistsItemsRetrieve", "userlist_id", userlist_id) + const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly platform?: Array - + userlistsList: async ( + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/userlists/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {boolean} - * @memberof ProgramsApiProgramsList + * Get a list of all userlist items for a user + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly professional?: boolean - + userlistsMembershipList: async ( + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/userlists/membership/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * A unique text identifier for the resources - * @type {Array} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Update + * @param {number} id A unique integer value identifying this user list. + * @param {PatchedUserListRequest} [PatchedUserListRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly readable_id?: Array - + userlistsPartialUpdate: async ( + id: number, + PatchedUserListRequest?: PatchedUserListRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsPartialUpdate", "id", id) + const localVarPath = `/api/v1/userlists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedUserListRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Retrieve + * @param {number} id A unique integer value identifying this user list. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_id?: Array + userlistsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("userlistsRetrieve", "id", id) + const localVarPath = `/api/v1/userlists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * UserlistsApi - functional programming interface + * @export + */ +export const UserlistsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = UserlistsApiAxiosParamCreator(configuration) + return { /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Create + * @param {UserListRequest} UserListRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type?: Array - + async userlistsCreate( + UserListRequest: UserListRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsCreate( + UserListRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof ProgramsApiProgramsList + * Viewset for UserLists + * @summary Destroy + * @param {number} id A unique integer value identifying this user list. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly resource_type_group?: Array - + async userlistsDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsDestroy(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsDestroy"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Add + * @param {number} userlist_id id of the parent user list + * @param {UserListRelationshipRequest} UserListRelationshipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: ProgramsListSortbyEnum - + async userlistsItemsCreate( + userlist_id: number, + UserListRelationshipRequest: UserListRelationshipRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsItemsCreate( + userlist_id, + UserListRelationshipRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsItemsCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof ProgramsApiProgramsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Remove + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array -} - -/** - * Request parameters for programsRetrieve operation in ProgramsApi. - * @export - * @interface ProgramsApiProgramsRetrieveRequest - */ -export interface ProgramsApiProgramsRetrieveRequest { + async userlistsItemsDestroy( + id: number, + userlist_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsItemsDestroy( + id, + userlist_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsItemsDestroy"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof ProgramsApiProgramsRetrieve + * Viewset for UserListRelationships + * @summary User List Resources List + * @param {number} userlist_id id of the parent user list + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * ProgramsApi - object-oriented interface - * @export - * @class ProgramsApi - * @extends {BaseAPI} - */ -export class ProgramsApi extends BaseAPI { + async userlistsItemsList( + userlist_id: number, + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsItemsList( + userlist_id, + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsItemsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Get a paginated list of programs - * @summary List - * @param {ProgramsApiProgramsListRequest} requestParameters Request parameters. + * Viewset for UserListRelationships + * @summary User List Resource Relationship Update + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list + * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProgramsApi */ - public programsList(requestParameters: ProgramsApiProgramsListRequest = {}, options?: RawAxiosRequestConfig) { - return ProgramsApiFp(this.configuration).programsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - + async userlistsItemsPartialUpdate( + id: number, + userlist_id: number, + PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsItemsPartialUpdate( + id, + userlist_id, + PatchedUserListRelationshipRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsItemsPartialUpdate"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Retrieve a single program - * @summary Retrieve - * @param {ProgramsApiProgramsRetrieveRequest} requestParameters Request parameters. + * Viewset for UserListRelationships + * @summary User List Resources Retrieve + * @param {number} id A unique integer value identifying this user list relationship. + * @param {number} userlist_id id of the parent user list * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ProgramsApi */ - public programsRetrieve(requestParameters: ProgramsApiProgramsRetrieveRequest, options?: RawAxiosRequestConfig) { - return ProgramsApiFp(this.configuration).programsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } -} - -/** - * @export - */ -export const ProgramsListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type ProgramsListCertificationTypeEnum = typeof ProgramsListCertificationTypeEnum[keyof typeof ProgramsListCertificationTypeEnum]; -/** - * @export - */ -export const ProgramsListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type ProgramsListDeliveryEnum = typeof ProgramsListDeliveryEnum[keyof typeof ProgramsListDeliveryEnum]; -/** - * @export - */ -export const ProgramsListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type ProgramsListDepartmentEnum = typeof ProgramsListDepartmentEnum[keyof typeof ProgramsListDepartmentEnum]; -/** - * @export - */ -export const ProgramsListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type ProgramsListLevelEnum = typeof ProgramsListLevelEnum[keyof typeof ProgramsListLevelEnum]; -/** - * @export - */ -export const ProgramsListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type ProgramsListOfferedByEnum = typeof ProgramsListOfferedByEnum[keyof typeof ProgramsListOfferedByEnum]; -/** - * @export - */ -export const ProgramsListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type ProgramsListPlatformEnum = typeof ProgramsListPlatformEnum[keyof typeof ProgramsListPlatformEnum]; -/** - * @export - */ -export const ProgramsListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type ProgramsListResourceTypeEnum = typeof ProgramsListResourceTypeEnum[keyof typeof ProgramsListResourceTypeEnum]; -/** - * @export - */ -export const ProgramsListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type ProgramsListResourceTypeGroupEnum = typeof ProgramsListResourceTypeGroupEnum[keyof typeof ProgramsListResourceTypeGroupEnum]; -/** - * @export - */ -export const ProgramsListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type ProgramsListSortbyEnum = typeof ProgramsListSortbyEnum[keyof typeof ProgramsListSortbyEnum]; - - -/** - * SchoolsApi - axios parameter creator - * @export - */ -export const SchoolsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * MIT schools - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - schoolsList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/schools/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * MIT schools - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource school. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - schoolsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('schoolsRetrieve', 'id', id) - const localVarPath = `/api/v1/schools/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * SchoolsApi - functional programming interface - * @export - */ -export const SchoolsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SchoolsApiAxiosParamCreator(configuration) - return { - /** - * MIT schools - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async schoolsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.schoolsList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['SchoolsApi.schoolsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * MIT schools - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource school. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async schoolsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.schoolsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['SchoolsApi.schoolsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * SchoolsApi - factory interface - * @export - */ -export const SchoolsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SchoolsApiFp(configuration) - return { - /** - * MIT schools - * @summary List - * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - schoolsList(requestParameters: SchoolsApiSchoolsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.schoolsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * MIT schools - * @summary Retrieve - * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - schoolsRetrieve(requestParameters: SchoolsApiSchoolsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.schoolsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for schoolsList operation in SchoolsApi. - * @export - * @interface SchoolsApiSchoolsListRequest - */ -export interface SchoolsApiSchoolsListRequest { + async userlistsItemsRetrieve( + id: number, + userlist_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsItemsRetrieve( + id, + userlist_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsItemsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Viewset for UserLists + * @summary List + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async userlistsList( + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsList( + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Number of results to return per page. - * @type {number} - * @memberof SchoolsApiSchoolsList + * Get a list of all userlist items for a user + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + async userlistsMembershipList( + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise> + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsMembershipList(options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsMembershipList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof SchoolsApiSchoolsList + * Viewset for UserLists + * @summary Update + * @param {number} id A unique integer value identifying this user list. + * @param {PatchedUserListRequest} [PatchedUserListRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number -} - -/** - * Request parameters for schoolsRetrieve operation in SchoolsApi. - * @export - * @interface SchoolsApiSchoolsRetrieveRequest - */ -export interface SchoolsApiSchoolsRetrieveRequest { + async userlistsPartialUpdate( + id: number, + PatchedUserListRequest?: PatchedUserListRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsPartialUpdate( + id, + PatchedUserListRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsPartialUpdate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this learning resource school. - * @type {number} - * @memberof SchoolsApiSchoolsRetrieve + * Viewset for UserLists + * @summary Retrieve + * @param {number} id A unique integer value identifying this user list. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async userlistsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.userlistsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["UserlistsApi.userlistsRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * SchoolsApi - object-oriented interface + * UserlistsApi - factory interface * @export - * @class SchoolsApi - * @extends {BaseAPI} */ -export class SchoolsApi extends BaseAPI { +export const UserlistsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = UserlistsApiFp(configuration) + return { /** - * MIT schools - * @summary List - * @param {SchoolsApiSchoolsListRequest} requestParameters Request parameters. + * Viewset for UserLists + * @summary Create + * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof SchoolsApi */ - public schoolsList(requestParameters: SchoolsApiSchoolsListRequest = {}, options?: RawAxiosRequestConfig) { - return SchoolsApiFp(this.configuration).schoolsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + userlistsCreate( + requestParameters: UserlistsApiUserlistsCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsCreate(requestParameters.UserListRequest, options) + .then((request) => request(axios, basePath)) + }, /** - * MIT schools - * @summary Retrieve - * @param {SchoolsApiSchoolsRetrieveRequest} requestParameters Request parameters. + * Viewset for UserLists + * @summary Destroy + * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof SchoolsApi */ - public schoolsRetrieve(requestParameters: SchoolsApiSchoolsRetrieveRequest, options?: RawAxiosRequestConfig) { - return SchoolsApiFp(this.configuration).schoolsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } -} - - - -/** - * TopicsApi - axios parameter creator - * @export - */ -export const TopicsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Topics covered by learning resources - * @summary List - * @param {boolean} [is_toplevel] Filter top-level topics - * @param {number} [limit] Number of results to return per page. - * @param {Array} [name] Topic name - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [parent_topic_id] Parent topic ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topicsList: async (is_toplevel?: boolean, limit?: number, name?: Array, offset?: number, parent_topic_id?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/topics/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (is_toplevel !== undefined) { - localVarQueryParameter['is_toplevel'] = is_toplevel; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (name) { - localVarQueryParameter['name'] = name; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (parent_topic_id) { - localVarQueryParameter['parent_topic_id'] = parent_topic_id; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Topics covered by learning resources - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource topic. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topicsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('topicsRetrieve', 'id', id) - const localVarPath = `/api/v1/topics/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * TopicsApi - functional programming interface - * @export - */ -export const TopicsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TopicsApiAxiosParamCreator(configuration) - return { - /** - * Topics covered by learning resources - * @summary List - * @param {boolean} [is_toplevel] Filter top-level topics - * @param {number} [limit] Number of results to return per page. - * @param {Array} [name] Topic name - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [parent_topic_id] Parent topic ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topicsList(is_toplevel?: boolean, limit?: number, name?: Array, offset?: number, parent_topic_id?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.topicsList(is_toplevel, limit, name, offset, parent_topic_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TopicsApi.topicsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Topics covered by learning resources - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource topic. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topicsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.topicsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['TopicsApi.topicsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * TopicsApi - factory interface - * @export - */ -export const TopicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TopicsApiFp(configuration) - return { - /** - * Topics covered by learning resources - * @summary List - * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topicsList(requestParameters: TopicsApiTopicsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.topicsList(requestParameters.is_toplevel, requestParameters.limit, requestParameters.name, requestParameters.offset, requestParameters.parent_topic_id, options).then((request) => request(axios, basePath)); - }, - /** - * Topics covered by learning resources - * @summary Retrieve - * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topicsRetrieve(requestParameters: TopicsApiTopicsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.topicsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for topicsList operation in TopicsApi. - * @export - * @interface TopicsApiTopicsListRequest - */ -export interface TopicsApiTopicsListRequest { + userlistsDestroy( + requestParameters: UserlistsApiUserlistsDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsDestroy(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** - * Filter top-level topics - * @type {boolean} - * @memberof TopicsApiTopicsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Add + * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly is_toplevel?: boolean - + userlistsItemsCreate( + requestParameters: UserlistsApiUserlistsItemsCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsItemsCreate( + requestParameters.userlist_id, + requestParameters.UserListRelationshipRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Number of results to return per page. - * @type {number} - * @memberof TopicsApiTopicsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Remove + * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + userlistsItemsDestroy( + requestParameters: UserlistsApiUserlistsItemsDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsItemsDestroy( + requestParameters.id, + requestParameters.userlist_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Topic name - * @type {Array} - * @memberof TopicsApiTopicsList + * Viewset for UserListRelationships + * @summary User List Resources List + * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly name?: Array - + userlistsItemsList( + requestParameters: UserlistsApiUserlistsItemsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsItemsList( + requestParameters.userlist_id, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof TopicsApiTopicsList + * Viewset for UserListRelationships + * @summary User List Resource Relationship Update + * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number - + userlistsItemsPartialUpdate( + requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsItemsPartialUpdate( + requestParameters.id, + requestParameters.userlist_id, + requestParameters.PatchedUserListRelationshipRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Parent topic ID - * @type {Array} - * @memberof TopicsApiTopicsList + * Viewset for UserListRelationships + * @summary User List Resources Retrieve + * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly parent_topic_id?: Array -} - -/** - * Request parameters for topicsRetrieve operation in TopicsApi. - * @export - * @interface TopicsApiTopicsRetrieveRequest - */ -export interface TopicsApiTopicsRetrieveRequest { + userlistsItemsRetrieve( + requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsItemsRetrieve( + requestParameters.id, + requestParameters.userlist_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * A unique integer value identifying this learning resource topic. - * @type {number} - * @memberof TopicsApiTopicsRetrieve + * Viewset for UserLists + * @summary List + * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * TopicsApi - object-oriented interface - * @export - * @class TopicsApi - * @extends {BaseAPI} - */ -export class TopicsApi extends BaseAPI { + userlistsList( + requestParameters: UserlistsApiUserlistsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsList( + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Topics covered by learning resources + * Get a list of all userlist items for a user * @summary List - * @param {TopicsApiTopicsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TopicsApi */ - public topicsList(requestParameters: TopicsApiTopicsListRequest = {}, options?: RawAxiosRequestConfig) { - return TopicsApiFp(this.configuration).topicsList(requestParameters.is_toplevel, requestParameters.limit, requestParameters.name, requestParameters.offset, requestParameters.parent_topic_id, options).then((request) => request(this.axios, this.basePath)); - } - + userlistsMembershipList( + options?: RawAxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .userlistsMembershipList(options) + .then((request) => request(axios, basePath)) + }, /** - * Topics covered by learning resources + * Viewset for UserLists + * @summary Update + * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + userlistsPartialUpdate( + requestParameters: UserlistsApiUserlistsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsPartialUpdate( + requestParameters.id, + requestParameters.PatchedUserListRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + /** + * Viewset for UserLists * @summary Retrieve - * @param {TopicsApiTopicsRetrieveRequest} requestParameters Request parameters. + * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TopicsApi */ - public topicsRetrieve(requestParameters: TopicsApiTopicsRetrieveRequest, options?: RawAxiosRequestConfig) { - return TopicsApiFp(this.configuration).topicsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + userlistsRetrieve( + requestParameters: UserlistsApiUserlistsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .userlistsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - -/** - * UserlistsApi - axios parameter creator - * @export - */ -export const UserlistsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Viewset for UserLists - * @summary Create - * @param {UserListRequest} UserListRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsCreate: async (UserListRequest: UserListRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'UserListRequest' is not null or undefined - assertParamExists('userlistsCreate', 'UserListRequest', UserListRequest) - const localVarPath = `/api/v1/userlists/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(UserListRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserLists - * @summary Destroy - * @param {number} id A unique integer value identifying this user list. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsDestroy', 'id', id) - const localVarPath = `/api/v1/userlists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Add - * @param {number} userlist_id id of the parent user list - * @param {UserListRelationshipRequest} UserListRelationshipRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsCreate: async (userlist_id: number, UserListRelationshipRequest: UserListRelationshipRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'userlist_id' is not null or undefined - assertParamExists('userlistsItemsCreate', 'userlist_id', userlist_id) - // verify required parameter 'UserListRelationshipRequest' is not null or undefined - assertParamExists('userlistsItemsCreate', 'UserListRelationshipRequest', UserListRelationshipRequest) - const localVarPath = `/api/v1/userlists/{userlist_id}/items/` - .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(UserListRelationshipRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Remove - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsDestroy: async (id: number, userlist_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsItemsDestroy', 'id', id) - // verify required parameter 'userlist_id' is not null or undefined - assertParamExists('userlistsItemsDestroy', 'userlist_id', userlist_id) - const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources List - * @param {number} userlist_id id of the parent user list - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsList: async (userlist_id: number, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'userlist_id' is not null or undefined - assertParamExists('userlistsItemsList', 'userlist_id', userlist_id) - const localVarPath = `/api/v1/userlists/{userlist_id}/items/` - .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Update - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsPartialUpdate: async (id: number, userlist_id: number, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsItemsPartialUpdate', 'id', id) - // verify required parameter 'userlist_id' is not null or undefined - assertParamExists('userlistsItemsPartialUpdate', 'userlist_id', userlist_id) - const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedUserListRelationshipRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources Retrieve - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsRetrieve: async (id: number, userlist_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsItemsRetrieve', 'id', id) - // verify required parameter 'userlist_id' is not null or undefined - assertParamExists('userlistsItemsRetrieve', 'userlist_id', userlist_id) - const localVarPath = `/api/v1/userlists/{userlist_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"userlist_id"}}`, encodeURIComponent(String(userlist_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserLists - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsList: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/userlists/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a list of all userlist items for a user - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsMembershipList: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/userlists/membership/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserLists - * @summary Update - * @param {number} id A unique integer value identifying this user list. - * @param {PatchedUserListRequest} [PatchedUserListRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsPartialUpdate: async (id: number, PatchedUserListRequest?: PatchedUserListRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsPartialUpdate', 'id', id) - const localVarPath = `/api/v1/userlists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedUserListRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Viewset for UserLists - * @summary Retrieve - * @param {number} id A unique integer value identifying this user list. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('userlistsRetrieve', 'id', id) - const localVarPath = `/api/v1/userlists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * UserlistsApi - functional programming interface - * @export - */ -export const UserlistsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UserlistsApiAxiosParamCreator(configuration) - return { - /** - * Viewset for UserLists - * @summary Create - * @param {UserListRequest} UserListRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsCreate(UserListRequest: UserListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsCreate(UserListRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserLists - * @summary Destroy - * @param {number} id A unique integer value identifying this user list. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Add - * @param {number} userlist_id id of the parent user list - * @param {UserListRelationshipRequest} UserListRelationshipRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsItemsCreate(userlist_id: number, UserListRelationshipRequest: UserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsItemsCreate(userlist_id, UserListRelationshipRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsItemsCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Remove - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsItemsDestroy(id: number, userlist_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsItemsDestroy(id, userlist_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsItemsDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources List - * @param {number} userlist_id id of the parent user list - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsItemsList(userlist_id: number, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsItemsList(userlist_id, limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsItemsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Update - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {PatchedUserListRelationshipRequest} [PatchedUserListRelationshipRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsItemsPartialUpdate(id: number, userlist_id: number, PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsItemsPartialUpdate(id, userlist_id, PatchedUserListRelationshipRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsItemsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources Retrieve - * @param {number} id A unique integer value identifying this user list relationship. - * @param {number} userlist_id id of the parent user list - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsItemsRetrieve(id: number, userlist_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsItemsRetrieve(id, userlist_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsItemsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserLists - * @summary List - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsList(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsList(limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a list of all userlist items for a user - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsMembershipList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsMembershipList(options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsMembershipList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserLists - * @summary Update - * @param {number} id A unique integer value identifying this user list. - * @param {PatchedUserListRequest} [PatchedUserListRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsPartialUpdate(id: number, PatchedUserListRequest?: PatchedUserListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsPartialUpdate(id, PatchedUserListRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Viewset for UserLists - * @summary Retrieve - * @param {number} id A unique integer value identifying this user list. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userlistsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userlistsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['UserlistsApi.userlistsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * UserlistsApi - factory interface - * @export - */ -export const UserlistsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UserlistsApiFp(configuration) - return { - /** - * Viewset for UserLists - * @summary Create - * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsCreate(requestParameters: UserlistsApiUserlistsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsCreate(requestParameters.UserListRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserLists - * @summary Destroy - * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsDestroy(requestParameters: UserlistsApiUserlistsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Add - * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsCreate(requestParameters: UserlistsApiUserlistsItemsCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsItemsCreate(requestParameters.userlist_id, requestParameters.UserListRelationshipRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Remove - * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsDestroy(requestParameters: UserlistsApiUserlistsItemsDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsItemsDestroy(requestParameters.id, requestParameters.userlist_id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources List - * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsList(requestParameters: UserlistsApiUserlistsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsItemsList(requestParameters.userlist_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Update - * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsPartialUpdate(requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsItemsPartialUpdate(requestParameters.id, requestParameters.userlist_id, requestParameters.PatchedUserListRelationshipRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserListRelationships - * @summary User List Resources Retrieve - * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsItemsRetrieve(requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsItemsRetrieve(requestParameters.id, requestParameters.userlist_id, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserLists - * @summary List - * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsList(requestParameters: UserlistsApiUserlistsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Get a list of all userlist items for a user - * @summary List - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsMembershipList(options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.userlistsMembershipList(options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserLists - * @summary Update - * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsPartialUpdate(requestParameters: UserlistsApiUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsPartialUpdate(requestParameters.id, requestParameters.PatchedUserListRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Viewset for UserLists - * @summary Retrieve - * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userlistsRetrieve(requestParameters: UserlistsApiUserlistsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userlistsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - /** * Request parameters for userlistsCreate operation in UserlistsApi. * @export * @interface UserlistsApiUserlistsCreateRequest */ export interface UserlistsApiUserlistsCreateRequest { - /** - * - * @type {UserListRequest} - * @memberof UserlistsApiUserlistsCreate - */ - readonly UserListRequest: UserListRequest + /** + * + * @type {UserListRequest} + * @memberof UserlistsApiUserlistsCreate + */ + readonly UserListRequest: UserListRequest } /** @@ -24838,12 +30595,12 @@ export interface UserlistsApiUserlistsCreateRequest { * @interface UserlistsApiUserlistsDestroyRequest */ export interface UserlistsApiUserlistsDestroyRequest { - /** - * A unique integer value identifying this user list. - * @type {number} - * @memberof UserlistsApiUserlistsDestroy - */ - readonly id: number + /** + * A unique integer value identifying this user list. + * @type {number} + * @memberof UserlistsApiUserlistsDestroy + */ + readonly id: number } /** @@ -24852,19 +30609,19 @@ export interface UserlistsApiUserlistsDestroyRequest { * @interface UserlistsApiUserlistsItemsCreateRequest */ export interface UserlistsApiUserlistsItemsCreateRequest { - /** - * id of the parent user list - * @type {number} - * @memberof UserlistsApiUserlistsItemsCreate - */ - readonly userlist_id: number + /** + * id of the parent user list + * @type {number} + * @memberof UserlistsApiUserlistsItemsCreate + */ + readonly userlist_id: number - /** - * - * @type {UserListRelationshipRequest} - * @memberof UserlistsApiUserlistsItemsCreate - */ - readonly UserListRelationshipRequest: UserListRelationshipRequest + /** + * + * @type {UserListRelationshipRequest} + * @memberof UserlistsApiUserlistsItemsCreate + */ + readonly UserListRelationshipRequest: UserListRelationshipRequest } /** @@ -24873,19 +30630,19 @@ export interface UserlistsApiUserlistsItemsCreateRequest { * @interface UserlistsApiUserlistsItemsDestroyRequest */ export interface UserlistsApiUserlistsItemsDestroyRequest { - /** - * A unique integer value identifying this user list relationship. - * @type {number} - * @memberof UserlistsApiUserlistsItemsDestroy - */ - readonly id: number + /** + * A unique integer value identifying this user list relationship. + * @type {number} + * @memberof UserlistsApiUserlistsItemsDestroy + */ + readonly id: number - /** - * id of the parent user list - * @type {number} - * @memberof UserlistsApiUserlistsItemsDestroy - */ - readonly userlist_id: number + /** + * id of the parent user list + * @type {number} + * @memberof UserlistsApiUserlistsItemsDestroy + */ + readonly userlist_id: number } /** @@ -24894,26 +30651,26 @@ export interface UserlistsApiUserlistsItemsDestroyRequest { * @interface UserlistsApiUserlistsItemsListRequest */ export interface UserlistsApiUserlistsItemsListRequest { - /** - * id of the parent user list - * @type {number} - * @memberof UserlistsApiUserlistsItemsList - */ - readonly userlist_id: number + /** + * id of the parent user list + * @type {number} + * @memberof UserlistsApiUserlistsItemsList + */ + readonly userlist_id: number - /** - * Number of results to return per page. - * @type {number} - * @memberof UserlistsApiUserlistsItemsList - */ - readonly limit?: number + /** + * Number of results to return per page. + * @type {number} + * @memberof UserlistsApiUserlistsItemsList + */ + readonly limit?: number - /** - * The initial index from which to return the results. - * @type {number} - * @memberof UserlistsApiUserlistsItemsList - */ - readonly offset?: number + /** + * The initial index from which to return the results. + * @type {number} + * @memberof UserlistsApiUserlistsItemsList + */ + readonly offset?: number } /** @@ -24922,26 +30679,26 @@ export interface UserlistsApiUserlistsItemsListRequest { * @interface UserlistsApiUserlistsItemsPartialUpdateRequest */ export interface UserlistsApiUserlistsItemsPartialUpdateRequest { - /** - * A unique integer value identifying this user list relationship. - * @type {number} - * @memberof UserlistsApiUserlistsItemsPartialUpdate - */ - readonly id: number + /** + * A unique integer value identifying this user list relationship. + * @type {number} + * @memberof UserlistsApiUserlistsItemsPartialUpdate + */ + readonly id: number - /** - * id of the parent user list - * @type {number} - * @memberof UserlistsApiUserlistsItemsPartialUpdate - */ - readonly userlist_id: number + /** + * id of the parent user list + * @type {number} + * @memberof UserlistsApiUserlistsItemsPartialUpdate + */ + readonly userlist_id: number - /** - * - * @type {PatchedUserListRelationshipRequest} - * @memberof UserlistsApiUserlistsItemsPartialUpdate - */ - readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest + /** + * + * @type {PatchedUserListRelationshipRequest} + * @memberof UserlistsApiUserlistsItemsPartialUpdate + */ + readonly PatchedUserListRelationshipRequest?: PatchedUserListRelationshipRequest } /** @@ -24950,19 +30707,19 @@ export interface UserlistsApiUserlistsItemsPartialUpdateRequest { * @interface UserlistsApiUserlistsItemsRetrieveRequest */ export interface UserlistsApiUserlistsItemsRetrieveRequest { - /** - * A unique integer value identifying this user list relationship. - * @type {number} - * @memberof UserlistsApiUserlistsItemsRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this user list relationship. + * @type {number} + * @memberof UserlistsApiUserlistsItemsRetrieve + */ + readonly id: number - /** - * id of the parent user list - * @type {number} - * @memberof UserlistsApiUserlistsItemsRetrieve - */ - readonly userlist_id: number + /** + * id of the parent user list + * @type {number} + * @memberof UserlistsApiUserlistsItemsRetrieve + */ + readonly userlist_id: number } /** @@ -24971,19 +30728,19 @@ export interface UserlistsApiUserlistsItemsRetrieveRequest { * @interface UserlistsApiUserlistsListRequest */ export interface UserlistsApiUserlistsListRequest { - /** - * Number of results to return per page. - * @type {number} - * @memberof UserlistsApiUserlistsList - */ - readonly limit?: number + /** + * Number of results to return per page. + * @type {number} + * @memberof UserlistsApiUserlistsList + */ + readonly limit?: number - /** - * The initial index from which to return the results. - * @type {number} - * @memberof UserlistsApiUserlistsList - */ - readonly offset?: number + /** + * The initial index from which to return the results. + * @type {number} + * @memberof UserlistsApiUserlistsList + */ + readonly offset?: number } /** @@ -24992,19 +30749,19 @@ export interface UserlistsApiUserlistsListRequest { * @interface UserlistsApiUserlistsPartialUpdateRequest */ export interface UserlistsApiUserlistsPartialUpdateRequest { - /** - * A unique integer value identifying this user list. - * @type {number} - * @memberof UserlistsApiUserlistsPartialUpdate - */ - readonly id: number + /** + * A unique integer value identifying this user list. + * @type {number} + * @memberof UserlistsApiUserlistsPartialUpdate + */ + readonly id: number - /** - * - * @type {PatchedUserListRequest} - * @memberof UserlistsApiUserlistsPartialUpdate - */ - readonly PatchedUserListRequest?: PatchedUserListRequest + /** + * + * @type {PatchedUserListRequest} + * @memberof UserlistsApiUserlistsPartialUpdate + */ + readonly PatchedUserListRequest?: PatchedUserListRequest } /** @@ -25013,12 +30770,12 @@ export interface UserlistsApiUserlistsPartialUpdateRequest { * @interface UserlistsApiUserlistsRetrieveRequest */ export interface UserlistsApiUserlistsRetrieveRequest { - /** - * A unique integer value identifying this user list. - * @type {number} - * @memberof UserlistsApiUserlistsRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this user list. + * @type {number} + * @memberof UserlistsApiUserlistsRetrieve + */ + readonly id: number } /** @@ -25028,556 +30785,886 @@ export interface UserlistsApiUserlistsRetrieveRequest { * @extends {BaseAPI} */ export class UserlistsApi extends BaseAPI { + /** + * Viewset for UserLists + * @summary Create + * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsCreate( + requestParameters: UserlistsApiUserlistsCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsCreate(requestParameters.UserListRequest, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserLists + * @summary Destroy + * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsDestroy( + requestParameters: UserlistsApiUserlistsDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsDestroy(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserListRelationships + * @summary User List Resource Relationship Add + * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsItemsCreate( + requestParameters: UserlistsApiUserlistsItemsCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsItemsCreate( + requestParameters.userlist_id, + requestParameters.UserListRelationshipRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserListRelationships + * @summary User List Resource Relationship Remove + * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsItemsDestroy( + requestParameters: UserlistsApiUserlistsItemsDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsItemsDestroy( + requestParameters.id, + requestParameters.userlist_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserListRelationships + * @summary User List Resources List + * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsItemsList( + requestParameters: UserlistsApiUserlistsItemsListRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsItemsList( + requestParameters.userlist_id, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserListRelationships + * @summary User List Resource Relationship Update + * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsItemsPartialUpdate( + requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsItemsPartialUpdate( + requestParameters.id, + requestParameters.userlist_id, + requestParameters.PatchedUserListRelationshipRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserListRelationships + * @summary User List Resources Retrieve + * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsItemsRetrieve( + requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsItemsRetrieve( + requestParameters.id, + requestParameters.userlist_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserLists + * @summary List + * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsList( + requestParameters: UserlistsApiUserlistsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsList(requestParameters.limit, requestParameters.offset, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a list of all userlist items for a user + * @summary List + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsMembershipList(options?: RawAxiosRequestConfig) { + return UserlistsApiFp(this.configuration) + .userlistsMembershipList(options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserLists + * @summary Update + * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsPartialUpdate( + requestParameters: UserlistsApiUserlistsPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsPartialUpdate( + requestParameters.id, + requestParameters.PatchedUserListRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Viewset for UserLists + * @summary Retrieve + * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserlistsApi + */ + public userlistsRetrieve( + requestParameters: UserlistsApiUserlistsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return UserlistsApiFp(this.configuration) + .userlistsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} + +/** + * VideoPlaylistsApi - axios parameter creator + * @export + */ +export const VideoPlaylistsApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * Viewset for UserLists - * @summary Create - * @param {UserlistsApiUserlistsCreateRequest} requestParameters Request parameters. + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsCreate(requestParameters: UserlistsApiUserlistsCreateRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsCreate(requestParameters.UserListRequest, options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsItemsList: async ( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "videoPlaylistsItemsList", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/video_playlists/{learning_resource_id}/items/`.replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Viewset for UserLists - * @summary Destroy - * @param {UserlistsApiUserlistsDestroyRequest} requestParameters Request parameters. + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsDestroy(requestParameters: UserlistsApiUserlistsDestroyRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsItemsRetrieve: async ( + id: number, + learning_resource_id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("videoPlaylistsItemsRetrieve", "id", id) + // verify required parameter 'learning_resource_id' is not null or undefined + assertParamExists( + "videoPlaylistsItemsRetrieve", + "learning_resource_id", + learning_resource_id, + ) + const localVarPath = + `/api/v1/video_playlists/{learning_resource_id}/items/{id}/` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace( + `{${"learning_resource_id"}}`, + encodeURIComponent(String(learning_resource_id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Add - * @param {UserlistsApiUserlistsItemsCreateRequest} requestParameters Request parameters. + * Get a paginated list of video playlists + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsItemsCreate(requestParameters: UserlistsApiUserlistsItemsCreateRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsItemsCreate(requestParameters.userlist_id, requestParameters.UserListRelationshipRequest, options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: VideoPlaylistsListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/video_playlists/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Remove - * @param {UserlistsApiUserlistsItemsDestroyRequest} requestParameters Request parameters. + * Retrieve a single video playlist + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsItemsDestroy(requestParameters: UserlistsApiUserlistsItemsDestroyRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsItemsDestroy(requestParameters.id, requestParameters.userlist_id, options).then((request) => request(this.axios, this.basePath)); - } + videoPlaylistsRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("videoPlaylistsRetrieve", "id", id) + const localVarPath = `/api/v1/video_playlists/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } +} +/** + * VideoPlaylistsApi - functional programming interface + * @export + */ +export const VideoPlaylistsApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + VideoPlaylistsApiAxiosParamCreator(configuration) + return { /** - * Viewset for UserListRelationships - * @summary User List Resources List - * @param {UserlistsApiUserlistsItemsListRequest} requestParameters Request parameters. + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {number} learning_resource_id id of the parent learning resource + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {string} [sortby] Which field to use when ordering the results. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsItemsList(requestParameters: UserlistsApiUserlistsItemsListRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsItemsList(requestParameters.userlist_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + async videoPlaylistsItemsList( + learning_resource_id: number, + limit?: number, + offset?: number, + sortby?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.videoPlaylistsItemsList( + learning_resource_id, + limit, + offset, + sortby, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideoPlaylistsApi.videoPlaylistsItemsList"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for UserListRelationships - * @summary User List Resource Relationship Update - * @param {UserlistsApiUserlistsItemsPartialUpdateRequest} requestParameters Request parameters. + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {number} id A unique integer value identifying this learning resource relationship. + * @param {number} learning_resource_id id of the parent learning resource * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsItemsPartialUpdate(requestParameters: UserlistsApiUserlistsItemsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsItemsPartialUpdate(requestParameters.id, requestParameters.userlist_id, requestParameters.PatchedUserListRelationshipRequest, options).then((request) => request(this.axios, this.basePath)); - } - + async videoPlaylistsItemsRetrieve( + id: number, + learning_resource_id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.videoPlaylistsItemsRetrieve( + id, + learning_resource_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideoPlaylistsApi.videoPlaylistsItemsRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for UserListRelationships - * @summary User List Resources Retrieve - * @param {UserlistsApiUserlistsItemsRetrieveRequest} requestParameters Request parameters. + * Get a paginated list of video playlists + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsItemsRetrieve(requestParameters: UserlistsApiUserlistsItemsRetrieveRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsItemsRetrieve(requestParameters.id, requestParameters.userlist_id, options).then((request) => request(this.axios, this.basePath)); - } - + async videoPlaylistsList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: VideoPlaylistsListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.videoPlaylistsList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideoPlaylistsApi.videoPlaylistsList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * Viewset for UserLists - * @summary List - * @param {UserlistsApiUserlistsListRequest} requestParameters Request parameters. + * Retrieve a single video playlist + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async videoPlaylistsRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.videoPlaylistsRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideoPlaylistsApi.videoPlaylistsRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } +} + +/** + * VideoPlaylistsApi - factory interface + * @export + */ +export const VideoPlaylistsApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = VideoPlaylistsApiFp(configuration) + return { + /** + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsList(requestParameters: UserlistsApiUserlistsListRequest = {}, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsList(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsItemsList( + requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videoPlaylistsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Get a list of all userlist items for a user - * @summary List + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsMembershipList(options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsMembershipList(options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsItemsRetrieve( + requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videoPlaylistsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Viewset for UserLists - * @summary Update - * @param {UserlistsApiUserlistsPartialUpdateRequest} requestParameters Request parameters. + * Get a paginated list of video playlists + * @summary List + * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsPartialUpdate(requestParameters: UserlistsApiUserlistsPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsPartialUpdate(requestParameters.id, requestParameters.PatchedUserListRequest, options).then((request) => request(this.axios, this.basePath)); - } - + videoPlaylistsList( + requestParameters: VideoPlaylistsApiVideoPlaylistsListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videoPlaylistsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** - * Viewset for UserLists + * Retrieve a single video playlist * @summary Retrieve - * @param {UserlistsApiUserlistsRetrieveRequest} requestParameters Request parameters. + * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserlistsApi */ - public userlistsRetrieve(requestParameters: UserlistsApiUserlistsRetrieveRequest, options?: RawAxiosRequestConfig) { - return UserlistsApiFp(this.configuration).userlistsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + videoPlaylistsRetrieve( + requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videoPlaylistsRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } - - -/** - * VideoPlaylistsApi - axios parameter creator - * @export - */ -export const VideoPlaylistsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsItemsList: async (learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('videoPlaylistsItemsList', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/video_playlists/{learning_resource_id}/items/` - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsItemsRetrieve: async (id: number, learning_resource_id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('videoPlaylistsItemsRetrieve', 'id', id) - // verify required parameter 'learning_resource_id' is not null or undefined - assertParamExists('videoPlaylistsItemsRetrieve', 'learning_resource_id', learning_resource_id) - const localVarPath = `/api/v1/video_playlists/{learning_resource_id}/items/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))) - .replace(`{${"learning_resource_id"}}`, encodeURIComponent(String(learning_resource_id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of video playlists - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideoPlaylistsListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/video_playlists/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single video playlist - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('videoPlaylistsRetrieve', 'id', id) - const localVarPath = `/api/v1/video_playlists/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * VideoPlaylistsApi - functional programming interface - * @export - */ -export const VideoPlaylistsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VideoPlaylistsApiAxiosParamCreator(configuration) - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {number} learning_resource_id id of the parent learning resource - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {string} [sortby] Which field to use when ordering the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videoPlaylistsItemsList(learning_resource_id: number, limit?: number, offset?: number, sortby?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videoPlaylistsItemsList(learning_resource_id, limit, offset, sortby, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideoPlaylistsApi.videoPlaylistsItemsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {number} id A unique integer value identifying this learning resource relationship. - * @param {number} learning_resource_id id of the parent learning resource - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videoPlaylistsItemsRetrieve(id: number, learning_resource_id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videoPlaylistsItemsRetrieve(id, learning_resource_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideoPlaylistsApi.videoPlaylistsItemsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of video playlists - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {VideoPlaylistsListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videoPlaylistsList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideoPlaylistsListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videoPlaylistsList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideoPlaylistsApi.videoPlaylistsList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single video playlist - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videoPlaylistsRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videoPlaylistsRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideoPlaylistsApi.videoPlaylistsRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * VideoPlaylistsApi - factory interface - * @export - */ -export const VideoPlaylistsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VideoPlaylistsApiFp(configuration) - return { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsItemsList(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videoPlaylistsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(axios, basePath)); - }, - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsItemsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videoPlaylistsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of video playlists - * @summary List - * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsList(requestParameters: VideoPlaylistsApiVideoPlaylistsListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videoPlaylistsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single video playlist - * @summary Retrieve - * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videoPlaylistsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videoPlaylistsRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - /** * Request parameters for videoPlaylistsItemsList operation in VideoPlaylistsApi. * @export * @interface VideoPlaylistsApiVideoPlaylistsItemsListRequest */ export interface VideoPlaylistsApiVideoPlaylistsItemsListRequest { - /** - * id of the parent learning resource - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsList - */ - readonly learning_resource_id: number - - /** - * Number of results to return per page. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsList - */ - readonly limit?: number - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsList - */ - readonly offset?: number - - /** - * Which field to use when ordering the results. - * @type {string} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsList - */ - readonly sortby?: string + /** + * id of the parent learning resource + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsList + */ + readonly learning_resource_id: number + + /** + * Number of results to return per page. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsList + */ + readonly offset?: number + + /** + * Which field to use when ordering the results. + * @type {string} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsList + */ + readonly sortby?: string } /** @@ -25586,19 +31673,19 @@ export interface VideoPlaylistsApiVideoPlaylistsItemsListRequest { * @interface VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest */ export interface VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest { - /** - * A unique integer value identifying this learning resource relationship. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this learning resource relationship. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve + */ + readonly id: number - /** - * id of the parent learning resource - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve - */ - readonly learning_resource_id: number + /** + * id of the parent learning resource + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsItemsRetrieve + */ + readonly learning_resource_id: number } /** @@ -25607,131 +31694,131 @@ export interface VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest { * @interface VideoPlaylistsApiVideoPlaylistsListRequest */ export interface VideoPlaylistsApiVideoPlaylistsListRequest { - /** - * - * @type {boolean} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly resource_id?: Array - - /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly sortby?: VideoPlaylistsListSortbyEnum - - /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof VideoPlaylistsApiVideoPlaylistsList - */ - readonly topic?: Array + /** + * + * @type {boolean} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly sortby?: VideoPlaylistsListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof VideoPlaylistsApiVideoPlaylistsList + */ + readonly topic?: Array } /** @@ -25740,12 +31827,12 @@ export interface VideoPlaylistsApiVideoPlaylistsListRequest { * @interface VideoPlaylistsApiVideoPlaylistsRetrieveRequest */ export interface VideoPlaylistsApiVideoPlaylistsRetrieveRequest { - /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof VideoPlaylistsApiVideoPlaylistsRetrieve - */ - readonly id: number + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof VideoPlaylistsApiVideoPlaylistsRetrieve + */ + readonly id: number } /** @@ -25755,1751 +31842,2456 @@ export interface VideoPlaylistsApiVideoPlaylistsRetrieveRequest { * @extends {BaseAPI} */ export class VideoPlaylistsApi extends BaseAPI { - /** - * Get a list of related learning resources for a learning resource. - * @summary Nested Learning Resource List - * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VideoPlaylistsApi - */ - public videoPlaylistsItemsList(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, options?: RawAxiosRequestConfig) { - return VideoPlaylistsApiFp(this.configuration).videoPlaylistsItemsList(requestParameters.learning_resource_id, requestParameters.limit, requestParameters.offset, requestParameters.sortby, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a singe related learning resource for a learning resource. - * @summary Nested Learning Resource Retrieve - * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VideoPlaylistsApi - */ - public videoPlaylistsItemsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, options?: RawAxiosRequestConfig) { - return VideoPlaylistsApiFp(this.configuration).videoPlaylistsItemsRetrieve(requestParameters.id, requestParameters.learning_resource_id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get a paginated list of video playlists - * @summary List - * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VideoPlaylistsApi - */ - public videoPlaylistsList(requestParameters: VideoPlaylistsApiVideoPlaylistsListRequest = {}, options?: RawAxiosRequestConfig) { - return VideoPlaylistsApiFp(this.configuration).videoPlaylistsList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve a single video playlist - * @summary Retrieve - * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof VideoPlaylistsApi - */ - public videoPlaylistsRetrieve(requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, options?: RawAxiosRequestConfig) { - return VideoPlaylistsApiFp(this.configuration).videoPlaylistsRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + /** + * Get a list of related learning resources for a learning resource. + * @summary Nested Learning Resource List + * @param {VideoPlaylistsApiVideoPlaylistsItemsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideoPlaylistsApi + */ + public videoPlaylistsItemsList( + requestParameters: VideoPlaylistsApiVideoPlaylistsItemsListRequest, + options?: RawAxiosRequestConfig, + ) { + return VideoPlaylistsApiFp(this.configuration) + .videoPlaylistsItemsList( + requestParameters.learning_resource_id, + requestParameters.limit, + requestParameters.offset, + requestParameters.sortby, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a singe related learning resource for a learning resource. + * @summary Nested Learning Resource Retrieve + * @param {VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideoPlaylistsApi + */ + public videoPlaylistsItemsRetrieve( + requestParameters: VideoPlaylistsApiVideoPlaylistsItemsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return VideoPlaylistsApiFp(this.configuration) + .videoPlaylistsItemsRetrieve( + requestParameters.id, + requestParameters.learning_resource_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of video playlists + * @summary List + * @param {VideoPlaylistsApiVideoPlaylistsListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideoPlaylistsApi + */ + public videoPlaylistsList( + requestParameters: VideoPlaylistsApiVideoPlaylistsListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return VideoPlaylistsApiFp(this.configuration) + .videoPlaylistsList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single video playlist + * @summary Retrieve + * @param {VideoPlaylistsApiVideoPlaylistsRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideoPlaylistsApi + */ + public videoPlaylistsRetrieve( + requestParameters: VideoPlaylistsApiVideoPlaylistsRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return VideoPlaylistsApiFp(this.configuration) + .videoPlaylistsRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const VideoPlaylistsListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type VideoPlaylistsListCertificationTypeEnum = typeof VideoPlaylistsListCertificationTypeEnum[keyof typeof VideoPlaylistsListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type VideoPlaylistsListCertificationTypeEnum = + (typeof VideoPlaylistsListCertificationTypeEnum)[keyof typeof VideoPlaylistsListCertificationTypeEnum] /** * @export */ export const VideoPlaylistsListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type VideoPlaylistsListDeliveryEnum = typeof VideoPlaylistsListDeliveryEnum[keyof typeof VideoPlaylistsListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type VideoPlaylistsListDeliveryEnum = + (typeof VideoPlaylistsListDeliveryEnum)[keyof typeof VideoPlaylistsListDeliveryEnum] /** * @export */ export const VideoPlaylistsListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type VideoPlaylistsListDepartmentEnum = typeof VideoPlaylistsListDepartmentEnum[keyof typeof VideoPlaylistsListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type VideoPlaylistsListDepartmentEnum = + (typeof VideoPlaylistsListDepartmentEnum)[keyof typeof VideoPlaylistsListDepartmentEnum] /** * @export */ export const VideoPlaylistsListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type VideoPlaylistsListLevelEnum = typeof VideoPlaylistsListLevelEnum[keyof typeof VideoPlaylistsListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type VideoPlaylistsListLevelEnum = + (typeof VideoPlaylistsListLevelEnum)[keyof typeof VideoPlaylistsListLevelEnum] /** * @export */ export const VideoPlaylistsListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type VideoPlaylistsListOfferedByEnum = typeof VideoPlaylistsListOfferedByEnum[keyof typeof VideoPlaylistsListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type VideoPlaylistsListOfferedByEnum = + (typeof VideoPlaylistsListOfferedByEnum)[keyof typeof VideoPlaylistsListOfferedByEnum] /** * @export */ export const VideoPlaylistsListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type VideoPlaylistsListPlatformEnum = typeof VideoPlaylistsListPlatformEnum[keyof typeof VideoPlaylistsListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type VideoPlaylistsListPlatformEnum = + (typeof VideoPlaylistsListPlatformEnum)[keyof typeof VideoPlaylistsListPlatformEnum] /** * @export */ export const VideoPlaylistsListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type VideoPlaylistsListResourceTypeEnum = typeof VideoPlaylistsListResourceTypeEnum[keyof typeof VideoPlaylistsListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type VideoPlaylistsListResourceTypeEnum = + (typeof VideoPlaylistsListResourceTypeEnum)[keyof typeof VideoPlaylistsListResourceTypeEnum] /** * @export */ export const VideoPlaylistsListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type VideoPlaylistsListResourceTypeGroupEnum = typeof VideoPlaylistsListResourceTypeGroupEnum[keyof typeof VideoPlaylistsListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type VideoPlaylistsListResourceTypeGroupEnum = + (typeof VideoPlaylistsListResourceTypeGroupEnum)[keyof typeof VideoPlaylistsListResourceTypeGroupEnum] /** * @export */ export const VideoPlaylistsListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type VideoPlaylistsListSortbyEnum = typeof VideoPlaylistsListSortbyEnum[keyof typeof VideoPlaylistsListSortbyEnum]; - + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type VideoPlaylistsListSortbyEnum = + (typeof VideoPlaylistsListSortbyEnum)[keyof typeof VideoPlaylistsListSortbyEnum] /** * VideosApi - axios parameter creator * @export */ -export const VideosApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get a paginated list of videos - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videosList: async (certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideosListSortbyEnum, topic?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/videos/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (certification !== undefined) { - localVarQueryParameter['certification'] = certification; - } - - if (certification_type) { - localVarQueryParameter['certification_type'] = certification_type; - } - - if (course_feature) { - localVarQueryParameter['course_feature'] = course_feature; - } - - if (delivery) { - localVarQueryParameter['delivery'] = delivery; - } - - if (department) { - localVarQueryParameter['department'] = department; - } - - if (free !== undefined) { - localVarQueryParameter['free'] = free; - } - - if (level) { - localVarQueryParameter['level'] = level; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offered_by) { - localVarQueryParameter['offered_by'] = offered_by; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (platform) { - localVarQueryParameter['platform'] = platform; - } - - if (professional !== undefined) { - localVarQueryParameter['professional'] = professional; - } - - if (readable_id) { - localVarQueryParameter['readable_id'] = readable_id; - } - - if (resource_id) { - localVarQueryParameter['resource_id'] = resource_id; - } - - if (resource_type) { - localVarQueryParameter['resource_type'] = resource_type; - } - - if (resource_type_group) { - localVarQueryParameter['resource_type_group'] = resource_type_group; - } - - if (sortby !== undefined) { - localVarQueryParameter['sortby'] = sortby; - } - - if (topic) { - localVarQueryParameter['topic'] = topic; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single video - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videosRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('videosRetrieve', 'id', id) - const localVarPath = `/api/v1/videos/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * VideosApi - functional programming interface - * @export - */ -export const VideosApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = VideosApiAxiosParamCreator(configuration) - return { - /** - * Get a paginated list of videos - * @summary List - * @param {boolean} [certification] - * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @param {boolean} [free] The course/program is offered for free - * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @param {number} [limit] Number of results to return per page. - * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @param {number} [offset] The initial index from which to return the results. - * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @param {boolean} [professional] - * @param {Array} [readable_id] A unique text identifier for the resources - * @param {Array} [resource_id] Comma-separated list of learning resource IDs - * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videosList(certification?: boolean, certification_type?: Array, course_feature?: Array, delivery?: Array>, department?: Array, free?: boolean, level?: Array, limit?: number, offered_by?: Array, offset?: number, platform?: Array, professional?: boolean, readable_id?: Array, resource_id?: Array, resource_type?: Array, resource_type_group?: Array, sortby?: VideosListSortbyEnum, topic?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videosList(certification, certification_type, course_feature, delivery, department, free, level, limit, offered_by, offset, platform, professional, readable_id, resource_id, resource_type, resource_type_group, sortby, topic, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideosApi.videosList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single video - * @summary Retrieve - * @param {number} id A unique integer value identifying this learning resource. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async videosRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.videosRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['VideosApi.videosRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * VideosApi - factory interface - * @export - */ -export const VideosApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = VideosApiFp(configuration) - return { - /** - * Get a paginated list of videos - * @summary List - * @param {VideosApiVideosListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videosList(requestParameters: VideosApiVideosListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videosList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single video - * @summary Retrieve - * @param {VideosApiVideosRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - videosRetrieve(requestParameters: VideosApiVideosRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.videosRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for videosList operation in VideosApi. - * @export - * @interface VideosApiVideosListRequest - */ -export interface VideosApiVideosListRequest { - /** - * - * @type {boolean} - * @memberof VideosApiVideosList - */ - readonly certification?: boolean - - /** - * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate - * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} - * @memberof VideosApiVideosList - */ - readonly certification_type?: Array - - /** - * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features - * @type {Array} - * @memberof VideosApiVideosList - */ - readonly course_feature?: Array - - /** - * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline - * @type {Array>} - * @memberof VideosApiVideosList - */ - readonly delivery?: Array> - - /** - * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies - * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} - * @memberof VideosApiVideosList - */ - readonly department?: Array - - /** - * The course/program is offered for free - * @type {boolean} - * @memberof VideosApiVideosList - */ - readonly free?: boolean - - /** - * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory - * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} - * @memberof VideosApiVideosList - */ - readonly level?: Array - - /** - * Number of results to return per page. - * @type {number} - * @memberof VideosApiVideosList - */ - readonly limit?: number - - /** - * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate - * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} - * @memberof VideosApiVideosList - */ - readonly offered_by?: Array - - /** - * The initial index from which to return the results. - * @type {number} - * @memberof VideosApiVideosList - */ - readonly offset?: number - - /** - * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service - * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} - * @memberof VideosApiVideosList - */ - readonly platform?: Array - - /** - * - * @type {boolean} - * @memberof VideosApiVideosList - */ - readonly professional?: boolean - - /** - * A unique text identifier for the resources - * @type {Array} - * @memberof VideosApiVideosList - */ - readonly readable_id?: Array - - /** - * Comma-separated list of learning resource IDs - * @type {Array} - * @memberof VideosApiVideosList - */ - readonly resource_id?: Array - +export const VideosApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document - * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} - * @memberof VideosApiVideosList - */ - readonly resource_type?: Array - - /** - * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material - * @type {Array<'course' | 'learning_material' | 'program'>} - * @memberof VideosApiVideosList - */ - readonly resource_type_group?: Array - - /** - * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending - * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} - * @memberof VideosApiVideosList + * Get a paginated list of videos + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly sortby?: VideosListSortbyEnum - + videosList: async ( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: VideosListSortbyEnum, + topic?: Array, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/videos/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (certification !== undefined) { + localVarQueryParameter["certification"] = certification + } + + if (certification_type) { + localVarQueryParameter["certification_type"] = certification_type + } + + if (course_feature) { + localVarQueryParameter["course_feature"] = course_feature + } + + if (delivery) { + localVarQueryParameter["delivery"] = delivery + } + + if (department) { + localVarQueryParameter["department"] = department + } + + if (free !== undefined) { + localVarQueryParameter["free"] = free + } + + if (level) { + localVarQueryParameter["level"] = level + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offered_by) { + localVarQueryParameter["offered_by"] = offered_by + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + if (platform) { + localVarQueryParameter["platform"] = platform + } + + if (professional !== undefined) { + localVarQueryParameter["professional"] = professional + } + + if (readable_id) { + localVarQueryParameter["readable_id"] = readable_id + } + + if (resource_id) { + localVarQueryParameter["resource_id"] = resource_id + } + + if (resource_type) { + localVarQueryParameter["resource_type"] = resource_type + } + + if (resource_type_group) { + localVarQueryParameter["resource_type_group"] = resource_type_group + } + + if (sortby !== undefined) { + localVarQueryParameter["sortby"] = sortby + } + + if (topic) { + localVarQueryParameter["topic"] = topic + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics - * @type {Array} - * @memberof VideosApiVideosList + * Retrieve a single video + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly topic?: Array + videosRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("videosRetrieve", "id", id) + const localVarPath = `/api/v1/videos/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for videosRetrieve operation in VideosApi. + * VideosApi - functional programming interface * @export - * @interface VideosApiVideosRetrieveRequest */ -export interface VideosApiVideosRetrieveRequest { +export const VideosApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = VideosApiAxiosParamCreator(configuration) + return { + /** + * Get a paginated list of videos + * @summary List + * @param {boolean} [certification] + * @param {Array} [certification_type] The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @param {Array} [course_feature] Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @param {Array>} [delivery] The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @param {Array} [department] The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @param {boolean} [free] The course/program is offered for free + * @param {Array} [level] The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @param {number} [limit] Number of results to return per page. + * @param {Array} [offered_by] The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @param {number} [offset] The initial index from which to return the results. + * @param {Array} [platform] The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @param {boolean} [professional] + * @param {Array} [readable_id] A unique text identifier for the resources + * @param {Array} [resource_id] Comma-separated list of learning resource IDs + * @param {Array} [resource_type] The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @param {Array} [resource_type_group] The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @param {VideosListSortbyEnum} [sortby] Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @param {Array} [topic] Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async videosList( + certification?: boolean, + certification_type?: Array, + course_feature?: Array, + delivery?: Array>, + department?: Array, + free?: boolean, + level?: Array, + limit?: number, + offered_by?: Array, + offset?: number, + platform?: Array, + professional?: boolean, + readable_id?: Array, + resource_id?: Array, + resource_type?: Array, + resource_type_group?: Array, + sortby?: VideosListSortbyEnum, + topic?: Array, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.videosList( + certification, + certification_type, + course_feature, + delivery, + department, + free, + level, + limit, + offered_by, + offset, + platform, + professional, + readable_id, + resource_id, + resource_type, + resource_type_group, + sortby, + topic, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideosApi.videosList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this learning resource. - * @type {number} - * @memberof VideosApiVideosRetrieve + * Retrieve a single video + * @summary Retrieve + * @param {number} id A unique integer value identifying this learning resource. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async videosRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = await localVarAxiosParamCreator.videosRetrieve( + id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["VideosApi.videosRetrieve"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * VideosApi - object-oriented interface + * VideosApi - factory interface * @export - * @class VideosApi - * @extends {BaseAPI} */ -export class VideosApi extends BaseAPI { +export const VideosApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = VideosApiFp(configuration) + return { /** * Get a paginated list of videos * @summary List * @param {VideosApiVideosListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VideosApi */ - public videosList(requestParameters: VideosApiVideosListRequest = {}, options?: RawAxiosRequestConfig) { - return VideosApiFp(this.configuration).videosList(requestParameters.certification, requestParameters.certification_type, requestParameters.course_feature, requestParameters.delivery, requestParameters.department, requestParameters.free, requestParameters.level, requestParameters.limit, requestParameters.offered_by, requestParameters.offset, requestParameters.platform, requestParameters.professional, requestParameters.readable_id, requestParameters.resource_id, requestParameters.resource_type, requestParameters.resource_type_group, requestParameters.sortby, requestParameters.topic, options).then((request) => request(this.axios, this.basePath)); - } - + videosList( + requestParameters: VideosApiVideosListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videosList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a single video * @summary Retrieve * @param {VideosApiVideosRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof VideosApi */ - public videosRetrieve(requestParameters: VideosApiVideosRetrieveRequest, options?: RawAxiosRequestConfig) { - return VideosApiFp(this.configuration).videosRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + videosRetrieve( + requestParameters: VideosApiVideosRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .videosRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } +} + +/** + * Request parameters for videosList operation in VideosApi. + * @export + * @interface VideosApiVideosListRequest + */ +export interface VideosApiVideosListRequest { + /** + * + * @type {boolean} + * @memberof VideosApiVideosList + */ + readonly certification?: boolean + + /** + * The type of certification offered * `micromasters` - MicroMasters Credential * `professional` - Professional Certificate * `completion` - Certificate of Completion * `none` - No Certificate + * @type {Array<'completion' | 'micromasters' | 'none' | 'professional'>} + * @memberof VideosApiVideosList + */ + readonly certification_type?: Array + + /** + * Content feature for the resources. Load the \'api/v1/course_features\' endpoint for a list of course features + * @type {Array} + * @memberof VideosApiVideosList + */ + readonly course_feature?: Array + + /** + * The delivery of course/program resources * `online` - Online * `hybrid` - Hybrid * `in_person` - In person * `offline` - Offline + * @type {Array>} + * @memberof VideosApiVideosList + */ + readonly delivery?: Array> + + /** + * The department that offers learning resources * `1` - Civil and Environmental Engineering * `2` - Mechanical Engineering * `3` - Materials Science and Engineering * `4` - Architecture * `5` - Chemistry * `6` - Electrical Engineering and Computer Science * `7` - Biology * `8` - Physics * `9` - Brain and Cognitive Sciences * `10` - Chemical Engineering * `11` - Urban Studies and Planning * `12` - Earth, Atmospheric, and Planetary Sciences * `14` - Economics * `15` - Management * `16` - Aeronautics and Astronautics * `17` - Political Science * `18` - Mathematics * `20` - Biological Engineering * `21A` - Anthropology * `21G` - Global Languages * `21H` - History * `21L` - Literature * `21M` - Music and Theater Arts * `22` - Nuclear Science and Engineering * `24` - Linguistics and Philosophy * `CC` - Concourse * `CMS-W` - Comparative Media Studies/Writing * `EC` - Edgerton Center * `ES` - Experimental Study Group * `ESD` - Engineering Systems Division * `HST` - Medical Engineering and Science * `IDS` - Data, Systems, and Society * `MAS` - Media Arts and Sciences * `PE` - Athletics, Physical Education and Recreation * `SP` - Special Programs * `STS` - Science, Technology, and Society * `WGS` - Women\'s and Gender Studies + * @type {Array<'1' | '10' | '11' | '12' | '14' | '15' | '16' | '17' | '18' | '2' | '20' | '21A' | '21G' | '21H' | '21L' | '21M' | '22' | '24' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'CC' | 'CMS-W' | 'EC' | 'ES' | 'ESD' | 'HST' | 'IDS' | 'MAS' | 'PE' | 'SP' | 'STS' | 'WGS'>} + * @memberof VideosApiVideosList + */ + readonly department?: Array + + /** + * The course/program is offered for free + * @type {boolean} + * @memberof VideosApiVideosList + */ + readonly free?: boolean + + /** + * The academic level of the resources * `undergraduate` - Undergraduate * `graduate` - Graduate * `high_school` - High School * `noncredit` - Non-Credit * `advanced` - Advanced * `intermediate` - Intermediate * `introductory` - Introductory + * @type {Array<'advanced' | 'graduate' | 'high_school' | 'intermediate' | 'introductory' | 'noncredit' | 'undergraduate'>} + * @memberof VideosApiVideosList + */ + readonly level?: Array + + /** + * Number of results to return per page. + * @type {number} + * @memberof VideosApiVideosList + */ + readonly limit?: number + + /** + * The organization that offers a learning resource * `mitx` - MITx * `ocw` - MIT OpenCourseWare * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `climate` - MIT Climate + * @type {Array<'bootcamps' | 'climate' | 'mitpe' | 'mitx' | 'ocw' | 'see' | 'xpro'>} + * @memberof VideosApiVideosList + */ + readonly offered_by?: Array + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof VideosApiVideosList + */ + readonly offset?: number + + /** + * The platform on which learning resources are offered * `edx` - edX * `ocw` - MIT OpenCourseWare * `oll` - Open Learning Library * `mitxonline` - MITx Online * `bootcamps` - Bootcamps * `xpro` - MIT xPRO * `csail` - CSAIL * `mitpe` - MIT Professional Education * `see` - MIT Sloan Executive Education * `scc` - Schwarzman College of Computing * `ctl` - Center for Transportation & Logistics * `whu` - WHU * `susskind` - Susskind * `globalalumni` - Global Alumni * `simplilearn` - Simplilearn * `emeritus` - Emeritus * `podcast` - Podcast * `youtube` - YouTube * `canvas` - Canvas * `climate` - MIT Climate * `ovs` - ODL Video Service + * @type {Array<'bootcamps' | 'canvas' | 'climate' | 'csail' | 'ctl' | 'edx' | 'emeritus' | 'globalalumni' | 'mitpe' | 'mitxonline' | 'ocw' | 'oll' | 'ovs' | 'podcast' | 'scc' | 'see' | 'simplilearn' | 'susskind' | 'whu' | 'xpro' | 'youtube'>} + * @memberof VideosApiVideosList + */ + readonly platform?: Array + + /** + * + * @type {boolean} + * @memberof VideosApiVideosList + */ + readonly professional?: boolean + + /** + * A unique text identifier for the resources + * @type {Array} + * @memberof VideosApiVideosList + */ + readonly readable_id?: Array + + /** + * Comma-separated list of learning resource IDs + * @type {Array} + * @memberof VideosApiVideosList + */ + readonly resource_id?: Array + + /** + * The type of learning resource * `course` - Course * `program` - Program * `learning_path` - Learning Path * `podcast` - Podcast * `podcast_episode` - Podcast Episode * `video` - Video * `video_playlist` - Video Playlist * `document` - Document + * @type {Array<'course' | 'document' | 'learning_path' | 'podcast' | 'podcast_episode' | 'program' | 'video' | 'video_playlist'>} + * @memberof VideosApiVideosList + */ + readonly resource_type?: Array + + /** + * The resource type group of the learning resources * `course` - Course * `program` - Program * `learning_material` - Learning Material + * @type {Array<'course' | 'learning_material' | 'program'>} + * @memberof VideosApiVideosList + */ + readonly resource_type_group?: Array + + /** + * Sort By * `id` - Object ID ascending * `-id` - Object ID descending * `readable_id` - Readable ID ascending * `-readable_id` - Readable ID descending * `last_modified` - Last Modified Date ascending * `-last_modified` - Last Modified Date descending * `new` - Newest resources first * `start_date` - Start Date ascending * `-start_date` - Start Date descending * `mitcoursenumber` - MIT course number ascending * `-mitcoursenumber` - MIT course number descending * `views` - Popularity ascending * `-views` - Popularity descending * `upcoming` - Next start date ascending + * @type {'-id' | '-last_modified' | '-mitcoursenumber' | '-readable_id' | '-start_date' | '-views' | 'id' | 'last_modified' | 'mitcoursenumber' | 'new' | 'readable_id' | 'start_date' | 'upcoming' | 'views'} + * @memberof VideosApiVideosList + */ + readonly sortby?: VideosListSortbyEnum + + /** + * Topics covered by the resources. Load the \'/api/v1/topics\' endpoint for a list of topics + * @type {Array} + * @memberof VideosApiVideosList + */ + readonly topic?: Array +} + +/** + * Request parameters for videosRetrieve operation in VideosApi. + * @export + * @interface VideosApiVideosRetrieveRequest + */ +export interface VideosApiVideosRetrieveRequest { + /** + * A unique integer value identifying this learning resource. + * @type {number} + * @memberof VideosApiVideosRetrieve + */ + readonly id: number +} + +/** + * VideosApi - object-oriented interface + * @export + * @class VideosApi + * @extends {BaseAPI} + */ +export class VideosApi extends BaseAPI { + /** + * Get a paginated list of videos + * @summary List + * @param {VideosApiVideosListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideosApi + */ + public videosList( + requestParameters: VideosApiVideosListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return VideosApiFp(this.configuration) + .videosList( + requestParameters.certification, + requestParameters.certification_type, + requestParameters.course_feature, + requestParameters.delivery, + requestParameters.department, + requestParameters.free, + requestParameters.level, + requestParameters.limit, + requestParameters.offered_by, + requestParameters.offset, + requestParameters.platform, + requestParameters.professional, + requestParameters.readable_id, + requestParameters.resource_id, + requestParameters.resource_type, + requestParameters.resource_type_group, + requestParameters.sortby, + requestParameters.topic, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single video + * @summary Retrieve + * @param {VideosApiVideosRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof VideosApi + */ + public videosRetrieve( + requestParameters: VideosApiVideosRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return VideosApiFp(this.configuration) + .videosRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } } /** * @export */ export const VideosListCertificationTypeEnum = { - Completion: 'completion', - Micromasters: 'micromasters', - None: 'none', - Professional: 'professional' -} as const; -export type VideosListCertificationTypeEnum = typeof VideosListCertificationTypeEnum[keyof typeof VideosListCertificationTypeEnum]; + Completion: "completion", + Micromasters: "micromasters", + None: "none", + Professional: "professional", +} as const +export type VideosListCertificationTypeEnum = + (typeof VideosListCertificationTypeEnum)[keyof typeof VideosListCertificationTypeEnum] /** * @export */ export const VideosListDeliveryEnum = { - Online: 'online', - Hybrid: 'hybrid', - InPerson: 'in_person', - Offline: 'offline' -} as const; -export type VideosListDeliveryEnum = typeof VideosListDeliveryEnum[keyof typeof VideosListDeliveryEnum]; + Online: "online", + Hybrid: "hybrid", + InPerson: "in_person", + Offline: "offline", +} as const +export type VideosListDeliveryEnum = + (typeof VideosListDeliveryEnum)[keyof typeof VideosListDeliveryEnum] /** * @export */ export const VideosListDepartmentEnum = { - _1: '1', - _10: '10', - _11: '11', - _12: '12', - _14: '14', - _15: '15', - _16: '16', - _17: '17', - _18: '18', - _2: '2', - _20: '20', - _21A: '21A', - _21G: '21G', - _21H: '21H', - _21L: '21L', - _21M: '21M', - _22: '22', - _24: '24', - _3: '3', - _4: '4', - _5: '5', - _6: '6', - _7: '7', - _8: '8', - _9: '9', - Cc: 'CC', - CmsW: 'CMS-W', - Ec: 'EC', - Es: 'ES', - Esd: 'ESD', - Hst: 'HST', - Ids: 'IDS', - Mas: 'MAS', - Pe: 'PE', - Sp: 'SP', - Sts: 'STS', - Wgs: 'WGS' -} as const; -export type VideosListDepartmentEnum = typeof VideosListDepartmentEnum[keyof typeof VideosListDepartmentEnum]; + _1: "1", + _10: "10", + _11: "11", + _12: "12", + _14: "14", + _15: "15", + _16: "16", + _17: "17", + _18: "18", + _2: "2", + _20: "20", + _21A: "21A", + _21G: "21G", + _21H: "21H", + _21L: "21L", + _21M: "21M", + _22: "22", + _24: "24", + _3: "3", + _4: "4", + _5: "5", + _6: "6", + _7: "7", + _8: "8", + _9: "9", + Cc: "CC", + CmsW: "CMS-W", + Ec: "EC", + Es: "ES", + Esd: "ESD", + Hst: "HST", + Ids: "IDS", + Mas: "MAS", + Pe: "PE", + Sp: "SP", + Sts: "STS", + Wgs: "WGS", +} as const +export type VideosListDepartmentEnum = + (typeof VideosListDepartmentEnum)[keyof typeof VideosListDepartmentEnum] /** * @export */ export const VideosListLevelEnum = { - Advanced: 'advanced', - Graduate: 'graduate', - HighSchool: 'high_school', - Intermediate: 'intermediate', - Introductory: 'introductory', - Noncredit: 'noncredit', - Undergraduate: 'undergraduate' -} as const; -export type VideosListLevelEnum = typeof VideosListLevelEnum[keyof typeof VideosListLevelEnum]; + Advanced: "advanced", + Graduate: "graduate", + HighSchool: "high_school", + Intermediate: "intermediate", + Introductory: "introductory", + Noncredit: "noncredit", + Undergraduate: "undergraduate", +} as const +export type VideosListLevelEnum = + (typeof VideosListLevelEnum)[keyof typeof VideosListLevelEnum] /** * @export */ export const VideosListOfferedByEnum = { - Bootcamps: 'bootcamps', - Climate: 'climate', - Mitpe: 'mitpe', - Mitx: 'mitx', - Ocw: 'ocw', - See: 'see', - Xpro: 'xpro' -} as const; -export type VideosListOfferedByEnum = typeof VideosListOfferedByEnum[keyof typeof VideosListOfferedByEnum]; + Bootcamps: "bootcamps", + Climate: "climate", + Mitpe: "mitpe", + Mitx: "mitx", + Ocw: "ocw", + See: "see", + Xpro: "xpro", +} as const +export type VideosListOfferedByEnum = + (typeof VideosListOfferedByEnum)[keyof typeof VideosListOfferedByEnum] /** * @export */ export const VideosListPlatformEnum = { - Bootcamps: 'bootcamps', - Canvas: 'canvas', - Climate: 'climate', - Csail: 'csail', - Ctl: 'ctl', - Edx: 'edx', - Emeritus: 'emeritus', - Globalalumni: 'globalalumni', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Ocw: 'ocw', - Oll: 'oll', - Ovs: 'ovs', - Podcast: 'podcast', - Scc: 'scc', - See: 'see', - Simplilearn: 'simplilearn', - Susskind: 'susskind', - Whu: 'whu', - Xpro: 'xpro', - Youtube: 'youtube' -} as const; -export type VideosListPlatformEnum = typeof VideosListPlatformEnum[keyof typeof VideosListPlatformEnum]; + Bootcamps: "bootcamps", + Canvas: "canvas", + Climate: "climate", + Csail: "csail", + Ctl: "ctl", + Edx: "edx", + Emeritus: "emeritus", + Globalalumni: "globalalumni", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Ocw: "ocw", + Oll: "oll", + Ovs: "ovs", + Podcast: "podcast", + Scc: "scc", + See: "see", + Simplilearn: "simplilearn", + Susskind: "susskind", + Whu: "whu", + Xpro: "xpro", + Youtube: "youtube", +} as const +export type VideosListPlatformEnum = + (typeof VideosListPlatformEnum)[keyof typeof VideosListPlatformEnum] /** * @export */ export const VideosListResourceTypeEnum = { - Course: 'course', - Document: 'document', - LearningPath: 'learning_path', - Podcast: 'podcast', - PodcastEpisode: 'podcast_episode', - Program: 'program', - Video: 'video', - VideoPlaylist: 'video_playlist' -} as const; -export type VideosListResourceTypeEnum = typeof VideosListResourceTypeEnum[keyof typeof VideosListResourceTypeEnum]; + Course: "course", + Document: "document", + LearningPath: "learning_path", + Podcast: "podcast", + PodcastEpisode: "podcast_episode", + Program: "program", + Video: "video", + VideoPlaylist: "video_playlist", +} as const +export type VideosListResourceTypeEnum = + (typeof VideosListResourceTypeEnum)[keyof typeof VideosListResourceTypeEnum] /** * @export */ export const VideosListResourceTypeGroupEnum = { - Course: 'course', - LearningMaterial: 'learning_material', - Program: 'program' -} as const; -export type VideosListResourceTypeGroupEnum = typeof VideosListResourceTypeGroupEnum[keyof typeof VideosListResourceTypeGroupEnum]; + Course: "course", + LearningMaterial: "learning_material", + Program: "program", +} as const +export type VideosListResourceTypeGroupEnum = + (typeof VideosListResourceTypeGroupEnum)[keyof typeof VideosListResourceTypeGroupEnum] /** * @export */ export const VideosListSortbyEnum = { - Id: '-id', - LastModified: '-last_modified', - Mitcoursenumber: '-mitcoursenumber', - ReadableId: '-readable_id', - StartDate: '-start_date', - Views: '-views', - Id2: 'id', - LastModified2: 'last_modified', - Mitcoursenumber2: 'mitcoursenumber', - New: 'new', - ReadableId2: 'readable_id', - StartDate2: 'start_date', - Upcoming: 'upcoming', - Views2: 'views' -} as const; -export type VideosListSortbyEnum = typeof VideosListSortbyEnum[keyof typeof VideosListSortbyEnum]; - + Id: "-id", + LastModified: "-last_modified", + Mitcoursenumber: "-mitcoursenumber", + ReadableId: "-readable_id", + StartDate: "-start_date", + Views: "-views", + Id2: "id", + LastModified2: "last_modified", + Mitcoursenumber2: "mitcoursenumber", + New: "new", + ReadableId2: "readable_id", + StartDate2: "start_date", + Upcoming: "upcoming", + Views2: "views", +} as const +export type VideosListSortbyEnum = + (typeof VideosListSortbyEnum)[keyof typeof VideosListSortbyEnum] /** * WebhooksApi - axios parameter creator * @export */ -export const WebhooksApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Webhook handler for ContentFile updates - * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs - * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest - * @param {string} [content_path] - * @param {string} [course_id] - * @param {string} [course_readable_id] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksContentFilesCreate: async (source: WebhooksContentFilesCreateSourceEnum, ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, content_path?: string, course_id?: string, course_readable_id?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'source' is not null or undefined - assertParamExists('webhooksContentFilesCreate', 'source', source) - // verify required parameter 'ContentFileWebHookRequestRequest' is not null or undefined - assertParamExists('webhooksContentFilesCreate', 'ContentFileWebHookRequestRequest', ContentFileWebHookRequestRequest) - const localVarPath = `/api/v1/webhooks/content_files/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_path !== undefined) { - localVarQueryParameter['content_path'] = content_path; - } - - if (course_id !== undefined) { - localVarQueryParameter['course_id'] = course_id; - } - - if (course_readable_id !== undefined) { - localVarQueryParameter['course_readable_id'] = course_readable_id; - } - - if (source !== undefined) { - localVarQueryParameter['source'] = source; - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(ContentFileWebHookRequestRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Webhook handler for ContentFile DELETE requests - * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksContentFilesDeleteCreate: async (ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ContentFileWebHookRequestRequest' is not null or undefined - assertParamExists('webhooksContentFilesDeleteCreate', 'ContentFileWebHookRequestRequest', ContentFileWebHookRequestRequest) - const localVarPath = `/api/v1/webhooks/content_files/delete/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(ContentFileWebHookRequestRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Webhook handler for OVS video upserts and deletes from the dagster pipeline - * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksOvsVideosCreate: async (OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/webhooks/ovs_videos/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(OVSVideoWebhookRequestRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * WebhooksApi - functional programming interface - * @export - */ -export const WebhooksApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration) - return { - /** - * Webhook handler for ContentFile updates - * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs - * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest - * @param {string} [content_path] - * @param {string} [course_id] - * @param {string} [course_readable_id] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async webhooksContentFilesCreate(source: WebhooksContentFilesCreateSourceEnum, ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, content_path?: string, course_id?: string, course_readable_id?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.webhooksContentFilesCreate(source, ContentFileWebHookRequestRequest, content_path, course_id, course_readable_id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebhooksApi.webhooksContentFilesCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Webhook handler for ContentFile DELETE requests - * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async webhooksContentFilesDeleteCreate(ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.webhooksContentFilesDeleteCreate(ContentFileWebHookRequestRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebhooksApi.webhooksContentFilesDeleteCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Webhook handler for OVS video upserts and deletes from the dagster pipeline - * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async webhooksOvsVideosCreate(OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.webhooksOvsVideosCreate(OVSVideoWebhookRequestRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebhooksApi.webhooksOvsVideosCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; - -/** - * WebhooksApi - factory interface - * @export - */ -export const WebhooksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WebhooksApiFp(configuration) - return { - /** - * Webhook handler for ContentFile updates - * @param {WebhooksApiWebhooksContentFilesCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksContentFilesCreate(requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.webhooksContentFilesCreate(requestParameters.source, requestParameters.ContentFileWebHookRequestRequest, requestParameters.content_path, requestParameters.course_id, requestParameters.course_readable_id, options).then((request) => request(axios, basePath)); - }, - /** - * Webhook handler for ContentFile DELETE requests - * @param {WebhooksApiWebhooksContentFilesDeleteCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksContentFilesDeleteCreate(requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.webhooksContentFilesDeleteCreate(requestParameters.ContentFileWebHookRequestRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Webhook handler for OVS video upserts and deletes from the dagster pipeline - * @param {WebhooksApiWebhooksOvsVideosCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - webhooksOvsVideosCreate(requestParameters: WebhooksApiWebhooksOvsVideosCreateRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.webhooksOvsVideosCreate(requestParameters.OVSVideoWebhookRequestRequest, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * Request parameters for webhooksContentFilesCreate operation in WebhooksApi. - * @export - * @interface WebhooksApiWebhooksContentFilesCreateRequest - */ -export interface WebhooksApiWebhooksContentFilesCreateRequest { - /** - * * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs - * @type {'micromasters' | 'mit_edx' | 'mitpe' | 'mitxonline' | 'oll' | 'ocw' | 'podcast' | 'mit_climate' | 'see' | 'xpro' | 'youtube' | 'canvas' | 'ovs'} - * @memberof WebhooksApiWebhooksContentFilesCreate - */ - readonly source: WebhooksContentFilesCreateSourceEnum - - /** - * - * @type {ContentFileWebHookRequestRequest} - * @memberof WebhooksApiWebhooksContentFilesCreate - */ - readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest - +export const WebhooksApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * - * @type {string} - * @memberof WebhooksApiWebhooksContentFilesCreate + * Webhook handler for ContentFile updates + * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs + * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest + * @param {string} [content_path] + * @param {string} [course_id] + * @param {string} [course_readable_id] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly content_path?: string - + webhooksContentFilesCreate: async ( + source: WebhooksContentFilesCreateSourceEnum, + ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, + content_path?: string, + course_id?: string, + course_readable_id?: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'source' is not null or undefined + assertParamExists("webhooksContentFilesCreate", "source", source) + // verify required parameter 'ContentFileWebHookRequestRequest' is not null or undefined + assertParamExists( + "webhooksContentFilesCreate", + "ContentFileWebHookRequestRequest", + ContentFileWebHookRequestRequest, + ) + const localVarPath = `/api/v1/webhooks/content_files/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_path !== undefined) { + localVarQueryParameter["content_path"] = content_path + } + + if (course_id !== undefined) { + localVarQueryParameter["course_id"] = course_id + } + + if (course_readable_id !== undefined) { + localVarQueryParameter["course_readable_id"] = course_readable_id + } + + if (source !== undefined) { + localVarQueryParameter["source"] = source + } + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + ContentFileWebHookRequestRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof WebhooksApiWebhooksContentFilesCreate + * Webhook handler for ContentFile DELETE requests + * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly course_id?: string - + webhooksContentFilesDeleteCreate: async ( + ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'ContentFileWebHookRequestRequest' is not null or undefined + assertParamExists( + "webhooksContentFilesDeleteCreate", + "ContentFileWebHookRequestRequest", + ContentFileWebHookRequestRequest, + ) + const localVarPath = `/api/v1/webhooks/content_files/delete/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + ContentFileWebHookRequestRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * - * @type {string} - * @memberof WebhooksApiWebhooksContentFilesCreate + * Webhook handler for OVS video upserts and deletes from the dagster pipeline + * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly course_readable_id?: string + webhooksOvsVideosCreate: async ( + OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/webhooks/ovs_videos/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + OVSVideoWebhookRequestRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for webhooksContentFilesDeleteCreate operation in WebhooksApi. + * WebhooksApi - functional programming interface * @export - * @interface WebhooksApiWebhooksContentFilesDeleteCreateRequest */ -export interface WebhooksApiWebhooksContentFilesDeleteCreateRequest { +export const WebhooksApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration) + return { /** - * - * @type {ContentFileWebHookRequestRequest} - * @memberof WebhooksApiWebhooksContentFilesDeleteCreate + * Webhook handler for ContentFile updates + * @param {WebhooksContentFilesCreateSourceEnum} source * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs + * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest + * @param {string} [content_path] + * @param {string} [course_id] + * @param {string} [course_readable_id] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest -} - -/** - * Request parameters for webhooksOvsVideosCreate operation in WebhooksApi. - * @export - * @interface WebhooksApiWebhooksOvsVideosCreateRequest - */ -export interface WebhooksApiWebhooksOvsVideosCreateRequest { + async webhooksContentFilesCreate( + source: WebhooksContentFilesCreateSourceEnum, + ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, + content_path?: string, + course_id?: string, + course_readable_id?: string, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.webhooksContentFilesCreate( + source, + ContentFileWebHookRequestRequest, + content_path, + course_id, + course_readable_id, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebhooksApi.webhooksContentFilesCreate"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Webhook handler for ContentFile DELETE requests + * @param {ContentFileWebHookRequestRequest} ContentFileWebHookRequestRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async webhooksContentFilesDeleteCreate( + ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.webhooksContentFilesDeleteCreate( + ContentFileWebHookRequestRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebhooksApi.webhooksContentFilesDeleteCreate"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {OVSVideoWebhookRequestRequest} - * @memberof WebhooksApiWebhooksOvsVideosCreate + * Webhook handler for OVS video upserts and deletes from the dagster pipeline + * @param {OVSVideoWebhookRequestRequest} [OVSVideoWebhookRequestRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest + async webhooksOvsVideosCreate( + OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.webhooksOvsVideosCreate( + OVSVideoWebhookRequestRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebhooksApi.webhooksOvsVideosCreate"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * WebhooksApi - object-oriented interface + * WebhooksApi - factory interface * @export - * @class WebhooksApi - * @extends {BaseAPI} */ -export class WebhooksApi extends BaseAPI { +export const WebhooksApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = WebhooksApiFp(configuration) + return { /** * Webhook handler for ContentFile updates * @param {WebhooksApiWebhooksContentFilesCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebhooksApi */ - public webhooksContentFilesCreate(requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, options?: RawAxiosRequestConfig) { - return WebhooksApiFp(this.configuration).webhooksContentFilesCreate(requestParameters.source, requestParameters.ContentFileWebHookRequestRequest, requestParameters.content_path, requestParameters.course_id, requestParameters.course_readable_id, options).then((request) => request(this.axios, this.basePath)); - } - + webhooksContentFilesCreate( + requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .webhooksContentFilesCreate( + requestParameters.source, + requestParameters.ContentFileWebHookRequestRequest, + requestParameters.content_path, + requestParameters.course_id, + requestParameters.course_readable_id, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Webhook handler for ContentFile DELETE requests * @param {WebhooksApiWebhooksContentFilesDeleteCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebhooksApi */ - public webhooksContentFilesDeleteCreate(requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, options?: RawAxiosRequestConfig) { - return WebhooksApiFp(this.configuration).webhooksContentFilesDeleteCreate(requestParameters.ContentFileWebHookRequestRequest, options).then((request) => request(this.axios, this.basePath)); - } - + webhooksContentFilesDeleteCreate( + requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .webhooksContentFilesDeleteCreate( + requestParameters.ContentFileWebHookRequestRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Webhook handler for OVS video upserts and deletes from the dagster pipeline * @param {WebhooksApiWebhooksOvsVideosCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebhooksApi */ - public webhooksOvsVideosCreate(requestParameters: WebhooksApiWebhooksOvsVideosCreateRequest = {}, options?: RawAxiosRequestConfig) { - return WebhooksApiFp(this.configuration).webhooksOvsVideosCreate(requestParameters.OVSVideoWebhookRequestRequest, options).then((request) => request(this.axios, this.basePath)); - } + webhooksOvsVideosCreate( + requestParameters: WebhooksApiWebhooksOvsVideosCreateRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .webhooksOvsVideosCreate( + requestParameters.OVSVideoWebhookRequestRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for webhooksContentFilesCreate operation in WebhooksApi. * @export + * @interface WebhooksApiWebhooksContentFilesCreateRequest */ -export const WebhooksContentFilesCreateSourceEnum = { - Micromasters: 'micromasters', - MitEdx: 'mit_edx', - Mitpe: 'mitpe', - Mitxonline: 'mitxonline', - Oll: 'oll', - Ocw: 'ocw', - Podcast: 'podcast', - MitClimate: 'mit_climate', - See: 'see', - Xpro: 'xpro', - Youtube: 'youtube', - Canvas: 'canvas', - Ovs: 'ovs' -} as const; -export type WebhooksContentFilesCreateSourceEnum = typeof WebhooksContentFilesCreateSourceEnum[keyof typeof WebhooksContentFilesCreateSourceEnum]; - +export interface WebhooksApiWebhooksContentFilesCreateRequest { + /** + * * `micromasters` - micromasters * `mit_edx` - mit_edx * `mitpe` - mitpe * `mitxonline` - mitxonline * `oll` - oll * `ocw` - ocw * `podcast` - podcast * `mit_climate` - mit_climate * `see` - see * `xpro` - xpro * `youtube` - youtube * `canvas` - canvas * `ovs` - ovs + * @type {'micromasters' | 'mit_edx' | 'mitpe' | 'mitxonline' | 'oll' | 'ocw' | 'podcast' | 'mit_climate' | 'see' | 'xpro' | 'youtube' | 'canvas' | 'ovs'} + * @memberof WebhooksApiWebhooksContentFilesCreate + */ + readonly source: WebhooksContentFilesCreateSourceEnum + + /** + * + * @type {ContentFileWebHookRequestRequest} + * @memberof WebhooksApiWebhooksContentFilesCreate + */ + readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest + + /** + * + * @type {string} + * @memberof WebhooksApiWebhooksContentFilesCreate + */ + readonly content_path?: string + + /** + * + * @type {string} + * @memberof WebhooksApiWebhooksContentFilesCreate + */ + readonly course_id?: string + + /** + * + * @type {string} + * @memberof WebhooksApiWebhooksContentFilesCreate + */ + readonly course_readable_id?: string +} /** - * WebsiteContentApi - axios parameter creator + * Request parameters for webhooksContentFilesDeleteCreate operation in WebhooksApi. * @export + * @interface WebhooksApiWebhooksContentFilesDeleteCreateRequest */ -export const WebsiteContentApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Create a new content item - * @summary Create - * @param {WebsiteContentRequest} WebsiteContentRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentCreate: async (WebsiteContentRequest: WebsiteContentRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'WebsiteContentRequest' is not null or undefined - assertParamExists('websiteContentCreate', 'WebsiteContentRequest', WebsiteContentRequest) - const localVarPath = `/api/v1/website_content/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(WebsiteContentRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Delete a content item - * @summary Destroy - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentDestroy: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('websiteContentDestroy', 'id', id) - const localVarPath = `/api/v1/website_content/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {string} identifier Numeric ID or slug of the content item - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentDetailRetrieve: async (identifier: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'identifier' is not null or undefined - assertParamExists('websiteContentDetailRetrieve', 'identifier', identifier) - const localVarPath = `/api/v1/website_content/detail/{identifier}/` - .replace(`{${"identifier"}}`, encodeURIComponent(String(identifier))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article - * @param {boolean} [draft] Filter to show only draft (unpublished) items - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentList: async (content_type?: WebsiteContentListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/api/v1/website_content/`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (content_type !== undefined) { - localVarQueryParameter['content_type'] = content_type; - } - - if (draft !== undefined) { - localVarQueryParameter['draft'] = draft; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Update a content item - * @summary Update - * @param {number} id A unique integer value identifying this website content. - * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentPartialUpdate: async (id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('websiteContentPartialUpdate', 'id', id) - const localVarPath = `/api/v1/website_content/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(PatchedWebsiteContentRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentRetrieve: async (id: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('websiteContentRetrieve', 'id', id) - const localVarPath = `/api/v1/website_content/{id}/` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; +export interface WebhooksApiWebhooksContentFilesDeleteCreateRequest { + /** + * + * @type {ContentFileWebHookRequestRequest} + * @memberof WebhooksApiWebhooksContentFilesDeleteCreate + */ + readonly ContentFileWebHookRequestRequest: ContentFileWebHookRequestRequest +} /** - * WebsiteContentApi - functional programming interface + * Request parameters for webhooksOvsVideosCreate operation in WebhooksApi. * @export + * @interface WebhooksApiWebhooksOvsVideosCreateRequest */ -export const WebsiteContentApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = WebsiteContentApiAxiosParamCreator(configuration) - return { - /** - * Create a new content item - * @summary Create - * @param {WebsiteContentRequest} WebsiteContentRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentCreate(WebsiteContentRequest: WebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentCreate(WebsiteContentRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentCreate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Delete a content item - * @summary Destroy - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentDestroy(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentDestroy(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentDestroy']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {string} identifier Numeric ID or slug of the content item - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentDetailRetrieve(identifier: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentDetailRetrieve(identifier, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentDetailRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article - * @param {boolean} [draft] Filter to show only draft (unpublished) items - * @param {number} [limit] Number of results to return per page. - * @param {number} [offset] The initial index from which to return the results. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentList(content_type?: WebsiteContentListContentTypeEnum, draft?: boolean, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentList(content_type, draft, limit, offset, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentList']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Update a content item - * @summary Update - * @param {number} id A unique integer value identifying this website content. - * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentPartialUpdate(id: number, PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentPartialUpdate(id, PatchedWebsiteContentRequest, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentPartialUpdate']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {number} id A unique integer value identifying this website content. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async websiteContentRetrieve(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.websiteContentRetrieve(id, options); - const index = configuration?.serverIndex ?? 0; - const operationBasePath = operationServerMap['WebsiteContentApi.websiteContentRetrieve']?.[index]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); - }, - } -}; +export interface WebhooksApiWebhooksOvsVideosCreateRequest { + /** + * + * @type {OVSVideoWebhookRequestRequest} + * @memberof WebhooksApiWebhooksOvsVideosCreate + */ + readonly OVSVideoWebhookRequestRequest?: OVSVideoWebhookRequestRequest +} /** - * WebsiteContentApi - factory interface + * WebhooksApi - object-oriented interface * @export + * @class WebhooksApi + * @extends {BaseAPI} */ -export const WebsiteContentApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = WebsiteContentApiFp(configuration) - return { - /** - * Create a new content item - * @summary Create - * @param {WebsiteContentApiWebsiteContentCreateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentCreate(requestParameters: WebsiteContentApiWebsiteContentCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentCreate(requestParameters.WebsiteContentRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Delete a content item - * @summary Destroy - * @param {WebsiteContentApiWebsiteContentDestroyRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentDestroy(requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentDestroy(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a content item by numeric ID or slug - * @summary Retrieve by ID or slug - * @param {WebsiteContentApiWebsiteContentDetailRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentDetailRetrieve(requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentDetailRetrieve(requestParameters.identifier, options).then((request) => request(axios, basePath)); - }, - /** - * Get a paginated list of website content items - * @summary List - * @param {WebsiteContentApiWebsiteContentListRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentList(requestParameters: WebsiteContentApiWebsiteContentListRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentList(requestParameters.content_type, requestParameters.draft, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath)); - }, - /** - * Update a content item - * @summary Update - * @param {WebsiteContentApiWebsiteContentPartialUpdateRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentPartialUpdate(requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentPartialUpdate(requestParameters.id, requestParameters.PatchedWebsiteContentRequest, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve a single content item - * @summary Retrieve - * @param {WebsiteContentApiWebsiteContentRetrieveRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - websiteContentRetrieve(requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.websiteContentRetrieve(requestParameters.id, options).then((request) => request(axios, basePath)); - }, - }; -}; +export class WebhooksApi extends BaseAPI { + /** + * Webhook handler for ContentFile updates + * @param {WebhooksApiWebhooksContentFilesCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public webhooksContentFilesCreate( + requestParameters: WebhooksApiWebhooksContentFilesCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return WebhooksApiFp(this.configuration) + .webhooksContentFilesCreate( + requestParameters.source, + requestParameters.ContentFileWebHookRequestRequest, + requestParameters.content_path, + requestParameters.course_id, + requestParameters.course_readable_id, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Webhook handler for ContentFile DELETE requests + * @param {WebhooksApiWebhooksContentFilesDeleteCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public webhooksContentFilesDeleteCreate( + requestParameters: WebhooksApiWebhooksContentFilesDeleteCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return WebhooksApiFp(this.configuration) + .webhooksContentFilesDeleteCreate( + requestParameters.ContentFileWebHookRequestRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Webhook handler for OVS video upserts and deletes from the dagster pipeline + * @param {WebhooksApiWebhooksOvsVideosCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebhooksApi + */ + public webhooksOvsVideosCreate( + requestParameters: WebhooksApiWebhooksOvsVideosCreateRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return WebhooksApiFp(this.configuration) + .webhooksOvsVideosCreate( + requestParameters.OVSVideoWebhookRequestRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } +} /** - * Request parameters for websiteContentCreate operation in WebsiteContentApi. * @export - * @interface WebsiteContentApiWebsiteContentCreateRequest */ -export interface WebsiteContentApiWebsiteContentCreateRequest { - /** - * - * @type {WebsiteContentRequest} - * @memberof WebsiteContentApiWebsiteContentCreate - */ - readonly WebsiteContentRequest: WebsiteContentRequest -} +export const WebhooksContentFilesCreateSourceEnum = { + Micromasters: "micromasters", + MitEdx: "mit_edx", + Mitpe: "mitpe", + Mitxonline: "mitxonline", + Oll: "oll", + Ocw: "ocw", + Podcast: "podcast", + MitClimate: "mit_climate", + See: "see", + Xpro: "xpro", + Youtube: "youtube", + Canvas: "canvas", + Ovs: "ovs", +} as const +export type WebhooksContentFilesCreateSourceEnum = + (typeof WebhooksContentFilesCreateSourceEnum)[keyof typeof WebhooksContentFilesCreateSourceEnum] /** - * Request parameters for websiteContentDestroy operation in WebsiteContentApi. + * WebsiteContentApi - axios parameter creator * @export - * @interface WebsiteContentApiWebsiteContentDestroyRequest */ -export interface WebsiteContentApiWebsiteContentDestroyRequest { +export const WebsiteContentApiAxiosParamCreator = function ( + configuration?: Configuration, +) { + return { /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof WebsiteContentApiWebsiteContentDestroy + * Create a new content item + * @summary Create + * @param {WebsiteContentRequest} WebsiteContentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number -} - -/** - * Request parameters for websiteContentDetailRetrieve operation in WebsiteContentApi. - * @export - * @interface WebsiteContentApiWebsiteContentDetailRetrieveRequest - */ -export interface WebsiteContentApiWebsiteContentDetailRetrieveRequest { + websiteContentCreate: async ( + WebsiteContentRequest: WebsiteContentRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'WebsiteContentRequest' is not null or undefined + assertParamExists( + "websiteContentCreate", + "WebsiteContentRequest", + WebsiteContentRequest, + ) + const localVarPath = `/api/v1/website_content/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "POST", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + WebsiteContentRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Numeric ID or slug of the content item - * @type {string} - * @memberof WebsiteContentApiWebsiteContentDetailRetrieve + * Delete a content item + * @summary Destroy + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly identifier: string -} - -/** - * Request parameters for websiteContentList operation in WebsiteContentApi. - * @export - * @interface WebsiteContentApiWebsiteContentListRequest - */ -export interface WebsiteContentApiWebsiteContentListRequest { + websiteContentDestroy: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("websiteContentDestroy", "id", id) + const localVarPath = `/api/v1/website_content/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "DELETE", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Filter by content type * `news` - News * `article` - Article - * @type {'article' | 'news'} - * @memberof WebsiteContentApiWebsiteContentList + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {string} identifier Numeric ID or slug of the content item + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly content_type?: WebsiteContentListContentTypeEnum - + websiteContentDetailRetrieve: async ( + identifier: string, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'identifier' is not null or undefined + assertParamExists( + "websiteContentDetailRetrieve", + "identifier", + identifier, + ) + const localVarPath = + `/api/v1/website_content/detail/{identifier}/`.replace( + `{${"identifier"}}`, + encodeURIComponent(String(identifier)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Filter to show only draft (unpublished) items - * @type {boolean} - * @memberof WebsiteContentApiWebsiteContentList + * Get a paginated list of website content items + * @summary List + * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article + * @param {boolean} [draft] Filter to show only draft (unpublished) items + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly draft?: boolean - + websiteContentList: async ( + content_type?: WebsiteContentListContentTypeEnum, + draft?: boolean, + limit?: number, + offset?: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + const localVarPath = `/api/v1/website_content/` + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + if (content_type !== undefined) { + localVarQueryParameter["content_type"] = content_type + } + + if (draft !== undefined) { + localVarQueryParameter["draft"] = draft + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit + } + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset + } + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * Number of results to return per page. - * @type {number} - * @memberof WebsiteContentApiWebsiteContentList + * Update a content item + * @summary Update + * @param {number} id A unique integer value identifying this website content. + * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly limit?: number - + websiteContentPartialUpdate: async ( + id: number, + PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("websiteContentPartialUpdate", "id", id) + const localVarPath = `/api/v1/website_content/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "PATCH", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + localVarHeaderParameter["Content-Type"] = "application/json" + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + localVarRequestOptions.data = serializeDataIfNeeded( + PatchedWebsiteContentRequest, + localVarRequestOptions, + configuration, + ) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, /** - * The initial index from which to return the results. - * @type {number} - * @memberof WebsiteContentApiWebsiteContentList + * Retrieve a single content item + * @summary Retrieve + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly offset?: number + websiteContentRetrieve: async ( + id: number, + options: RawAxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists("websiteContentRetrieve", "id", id) + const localVarPath = `/api/v1/website_content/{id}/`.replace( + `{${"id"}}`, + encodeURIComponent(String(id)), + ) + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL) + let baseOptions + if (configuration) { + baseOptions = configuration.baseOptions + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options, + } + const localVarHeaderParameter = {} as any + const localVarQueryParameter = {} as any + + setSearchParams(localVarUrlObj, localVarQueryParameter) + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {} + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + } + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + } + }, + } } /** - * Request parameters for websiteContentPartialUpdate operation in WebsiteContentApi. + * WebsiteContentApi - functional programming interface * @export - * @interface WebsiteContentApiWebsiteContentPartialUpdateRequest */ -export interface WebsiteContentApiWebsiteContentPartialUpdateRequest { +export const WebsiteContentApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = + WebsiteContentApiAxiosParamCreator(configuration) + return { /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof WebsiteContentApiWebsiteContentPartialUpdate + * Create a new content item + * @summary Create + * @param {WebsiteContentRequest} WebsiteContentRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number - + async websiteContentCreate( + WebsiteContentRequest: WebsiteContentRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentCreate( + WebsiteContentRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentCreate"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * - * @type {PatchedWebsiteContentRequest} - * @memberof WebsiteContentApiWebsiteContentPartialUpdate + * Delete a content item + * @summary Destroy + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest -} - -/** - * Request parameters for websiteContentRetrieve operation in WebsiteContentApi. - * @export - * @interface WebsiteContentApiWebsiteContentRetrieveRequest - */ -export interface WebsiteContentApiWebsiteContentRetrieveRequest { + async websiteContentDestroy( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentDestroy(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentDestroy"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {string} identifier Numeric ID or slug of the content item + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async websiteContentDetailRetrieve( + identifier: string, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentDetailRetrieve( + identifier, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentDetailRetrieve"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Get a paginated list of website content items + * @summary List + * @param {WebsiteContentListContentTypeEnum} [content_type] Filter by content type * `news` - News * `article` - Article + * @param {boolean} [draft] Filter to show only draft (unpublished) items + * @param {number} [limit] Number of results to return per page. + * @param {number} [offset] The initial index from which to return the results. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async websiteContentList( + content_type?: WebsiteContentListContentTypeEnum, + draft?: boolean, + limit?: number, + offset?: number, + options?: RawAxiosRequestConfig, + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string, + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentList( + content_type, + draft, + limit, + offset, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentList"]?.[index]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + /** + * Update a content item + * @summary Update + * @param {number} id A unique integer value identifying this website content. + * @param {PatchedWebsiteContentRequest} [PatchedWebsiteContentRequest] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async websiteContentPartialUpdate( + id: number, + PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentPartialUpdate( + id, + PatchedWebsiteContentRequest, + options, + ) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentPartialUpdate"]?.[ + index + ]?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, /** - * A unique integer value identifying this website content. - * @type {number} - * @memberof WebsiteContentApiWebsiteContentRetrieve + * Retrieve a single content item + * @summary Retrieve + * @param {number} id A unique integer value identifying this website content. + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ - readonly id: number + async websiteContentRetrieve( + id: number, + options?: RawAxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.websiteContentRetrieve(id, options) + const index = configuration?.serverIndex ?? 0 + const operationBasePath = + operationServerMap["WebsiteContentApi.websiteContentRetrieve"]?.[index] + ?.url + return (axios, basePath) => + createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration, + )(axios, operationBasePath || basePath) + }, + } } /** - * WebsiteContentApi - object-oriented interface + * WebsiteContentApi - factory interface * @export - * @class WebsiteContentApi - * @extends {BaseAPI} */ -export class WebsiteContentApi extends BaseAPI { +export const WebsiteContentApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = WebsiteContentApiFp(configuration) + return { /** * Create a new content item * @summary Create * @param {WebsiteContentApiWebsiteContentCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentCreate(requestParameters: WebsiteContentApiWebsiteContentCreateRequest, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentCreate(requestParameters.WebsiteContentRequest, options).then((request) => request(this.axios, this.basePath)); - } - + websiteContentCreate( + requestParameters: WebsiteContentApiWebsiteContentCreateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentCreate(requestParameters.WebsiteContentRequest, options) + .then((request) => request(axios, basePath)) + }, /** * Delete a content item * @summary Destroy * @param {WebsiteContentApiWebsiteContentDestroyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentDestroy(requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentDestroy(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } - + websiteContentDestroy( + requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentDestroy(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a content item by numeric ID or slug * @summary Retrieve by ID or slug * @param {WebsiteContentApiWebsiteContentDetailRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentDetailRetrieve(requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentDetailRetrieve(requestParameters.identifier, options).then((request) => request(this.axios, this.basePath)); - } - + websiteContentDetailRetrieve( + requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentDetailRetrieve(requestParameters.identifier, options) + .then((request) => request(axios, basePath)) + }, /** * Get a paginated list of website content items * @summary List * @param {WebsiteContentApiWebsiteContentListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentList(requestParameters: WebsiteContentApiWebsiteContentListRequest = {}, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentList(requestParameters.content_type, requestParameters.draft, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath)); - } - + websiteContentList( + requestParameters: WebsiteContentApiWebsiteContentListRequest = {}, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentList( + requestParameters.content_type, + requestParameters.draft, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Update a content item * @summary Update * @param {WebsiteContentApiWebsiteContentPartialUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentPartialUpdate(requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentPartialUpdate(requestParameters.id, requestParameters.PatchedWebsiteContentRequest, options).then((request) => request(this.axios, this.basePath)); - } - + websiteContentPartialUpdate( + requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentPartialUpdate( + requestParameters.id, + requestParameters.PatchedWebsiteContentRequest, + options, + ) + .then((request) => request(axios, basePath)) + }, /** * Retrieve a single content item * @summary Retrieve * @param {WebsiteContentApiWebsiteContentRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof WebsiteContentApi */ - public websiteContentRetrieve(requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, options?: RawAxiosRequestConfig) { - return WebsiteContentApiFp(this.configuration).websiteContentRetrieve(requestParameters.id, options).then((request) => request(this.axios, this.basePath)); - } + websiteContentRetrieve( + requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, + options?: RawAxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .websiteContentRetrieve(requestParameters.id, options) + .then((request) => request(axios, basePath)) + }, + } } /** + * Request parameters for websiteContentCreate operation in WebsiteContentApi. * @export + * @interface WebsiteContentApiWebsiteContentCreateRequest */ -export const WebsiteContentListContentTypeEnum = { - Article: 'article', - News: 'news' -} as const; -export type WebsiteContentListContentTypeEnum = typeof WebsiteContentListContentTypeEnum[keyof typeof WebsiteContentListContentTypeEnum]; +export interface WebsiteContentApiWebsiteContentCreateRequest { + /** + * + * @type {WebsiteContentRequest} + * @memberof WebsiteContentApiWebsiteContentCreate + */ + readonly WebsiteContentRequest: WebsiteContentRequest +} + +/** + * Request parameters for websiteContentDestroy operation in WebsiteContentApi. + * @export + * @interface WebsiteContentApiWebsiteContentDestroyRequest + */ +export interface WebsiteContentApiWebsiteContentDestroyRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof WebsiteContentApiWebsiteContentDestroy + */ + readonly id: number +} + +/** + * Request parameters for websiteContentDetailRetrieve operation in WebsiteContentApi. + * @export + * @interface WebsiteContentApiWebsiteContentDetailRetrieveRequest + */ +export interface WebsiteContentApiWebsiteContentDetailRetrieveRequest { + /** + * Numeric ID or slug of the content item + * @type {string} + * @memberof WebsiteContentApiWebsiteContentDetailRetrieve + */ + readonly identifier: string +} + +/** + * Request parameters for websiteContentList operation in WebsiteContentApi. + * @export + * @interface WebsiteContentApiWebsiteContentListRequest + */ +export interface WebsiteContentApiWebsiteContentListRequest { + /** + * Filter by content type * `news` - News * `article` - Article + * @type {'article' | 'news'} + * @memberof WebsiteContentApiWebsiteContentList + */ + readonly content_type?: WebsiteContentListContentTypeEnum + + /** + * Filter to show only draft (unpublished) items + * @type {boolean} + * @memberof WebsiteContentApiWebsiteContentList + */ + readonly draft?: boolean + + /** + * Number of results to return per page. + * @type {number} + * @memberof WebsiteContentApiWebsiteContentList + */ + readonly limit?: number + + /** + * The initial index from which to return the results. + * @type {number} + * @memberof WebsiteContentApiWebsiteContentList + */ + readonly offset?: number +} + +/** + * Request parameters for websiteContentPartialUpdate operation in WebsiteContentApi. + * @export + * @interface WebsiteContentApiWebsiteContentPartialUpdateRequest + */ +export interface WebsiteContentApiWebsiteContentPartialUpdateRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof WebsiteContentApiWebsiteContentPartialUpdate + */ + readonly id: number + + /** + * + * @type {PatchedWebsiteContentRequest} + * @memberof WebsiteContentApiWebsiteContentPartialUpdate + */ + readonly PatchedWebsiteContentRequest?: PatchedWebsiteContentRequest +} + +/** + * Request parameters for websiteContentRetrieve operation in WebsiteContentApi. + * @export + * @interface WebsiteContentApiWebsiteContentRetrieveRequest + */ +export interface WebsiteContentApiWebsiteContentRetrieveRequest { + /** + * A unique integer value identifying this website content. + * @type {number} + * @memberof WebsiteContentApiWebsiteContentRetrieve + */ + readonly id: number +} +/** + * WebsiteContentApi - object-oriented interface + * @export + * @class WebsiteContentApi + * @extends {BaseAPI} + */ +export class WebsiteContentApi extends BaseAPI { + /** + * Create a new content item + * @summary Create + * @param {WebsiteContentApiWebsiteContentCreateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentCreate( + requestParameters: WebsiteContentApiWebsiteContentCreateRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentCreate(requestParameters.WebsiteContentRequest, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Delete a content item + * @summary Destroy + * @param {WebsiteContentApiWebsiteContentDestroyRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentDestroy( + requestParameters: WebsiteContentApiWebsiteContentDestroyRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentDestroy(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a content item by numeric ID or slug + * @summary Retrieve by ID or slug + * @param {WebsiteContentApiWebsiteContentDetailRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentDetailRetrieve( + requestParameters: WebsiteContentApiWebsiteContentDetailRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentDetailRetrieve(requestParameters.identifier, options) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Get a paginated list of website content items + * @summary List + * @param {WebsiteContentApiWebsiteContentListRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentList( + requestParameters: WebsiteContentApiWebsiteContentListRequest = {}, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentList( + requestParameters.content_type, + requestParameters.draft, + requestParameters.limit, + requestParameters.offset, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Update a content item + * @summary Update + * @param {WebsiteContentApiWebsiteContentPartialUpdateRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentPartialUpdate( + requestParameters: WebsiteContentApiWebsiteContentPartialUpdateRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentPartialUpdate( + requestParameters.id, + requestParameters.PatchedWebsiteContentRequest, + options, + ) + .then((request) => request(this.axios, this.basePath)) + } + + /** + * Retrieve a single content item + * @summary Retrieve + * @param {WebsiteContentApiWebsiteContentRetrieveRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WebsiteContentApi + */ + public websiteContentRetrieve( + requestParameters: WebsiteContentApiWebsiteContentRetrieveRequest, + options?: RawAxiosRequestConfig, + ) { + return WebsiteContentApiFp(this.configuration) + .websiteContentRetrieve(requestParameters.id, options) + .then((request) => request(this.axios, this.basePath)) + } +} +/** + * @export + */ +export const WebsiteContentListContentTypeEnum = { + Article: "article", + News: "news", +} as const +export type WebsiteContentListContentTypeEnum = + (typeof WebsiteContentListContentTypeEnum)[keyof typeof WebsiteContentListContentTypeEnum] diff --git a/src/typescript/mit-learn-api-axios/src/v1/base.ts b/src/typescript/mit-learn-api-axios/src/v1/base.ts index 98d73c2..fe62361 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/base.ts +++ b/src/typescript/mit-learn-api-axios/src/v1/base.ts @@ -5,32 +5,31 @@ * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - -import type { Configuration } from './configuration'; +import type { Configuration } from "./configuration" // Some imports not used depending on template conditions // @ts-ignore -import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; -import globalAxios from 'axios'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios" +import globalAxios from "axios" -export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); +export const BASE_PATH = "http://localhost".replace(/\/+$/, "") /** * * @export */ export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +} /** * @@ -38,8 +37,8 @@ export const COLLECTION_FORMATS = { * @interface RequestArgs */ export interface RequestArgs { - url: string; - options: RawAxiosRequestConfig; + url: string + options: RawAxiosRequestConfig } /** @@ -48,15 +47,19 @@ export interface RequestArgs { * @class BaseAPI */ export class BaseAPI { - protected configuration: Configuration | undefined; + protected configuration: Configuration | undefined - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath ?? basePath; - } + constructor( + configuration?: Configuration, + protected basePath: string = BASE_PATH, + protected axios: AxiosInstance = globalAxios, + ) { + if (configuration) { + this.configuration = configuration + this.basePath = configuration.basePath ?? basePath } -}; + } +} /** * @@ -65,22 +68,24 @@ export class BaseAPI { * @extends {Error} */ export class RequiredError extends Error { - constructor(public field: string, msg?: string) { - super(msg); - this.name = "RequiredError" - } + constructor( + public field: string, + msg?: string, + ) { + super(msg) + this.name = "RequiredError" + } } interface ServerMap { - [key: string]: { - url: string, - description: string, - }[]; + [key: string]: { + url: string + description: string + }[] } /** * * @export */ -export const operationServerMap: ServerMap = { -} +export const operationServerMap: ServerMap = {} diff --git a/src/typescript/mit-learn-api-axios/src/v1/common.ts b/src/typescript/mit-learn-api-axios/src/v1/common.ts index a2f0f6f..2e98b41 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/common.ts +++ b/src/typescript/mit-learn-api-axios/src/v1/common.ts @@ -5,105 +5,139 @@ * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - -import type { Configuration } from "./configuration"; -import type { RequestArgs } from "./base"; -import type { AxiosInstance, AxiosResponse } from 'axios'; -import { RequiredError } from "./base"; +import type { Configuration } from "./configuration" +import type { RequestArgs } from "./base" +import type { AxiosInstance, AxiosResponse } from "axios" +import { RequiredError } from "./base" /** * * @export */ -export const DUMMY_BASE_URL = 'https://example.com' +export const DUMMY_BASE_URL = "https://example.com" /** * * @throws {RequiredError} * @export */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } +export const assertParamExists = function ( + functionName: string, + paramName: string, + paramValue: unknown, +) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError( + paramName, + `Required parameter ${paramName} was null or undefined when calling ${functionName}.`, + ) + } } /** * * @export */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } +export const setApiKeyToObject = async function ( + object: any, + keyParamName: string, + configuration?: Configuration, +) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = + typeof configuration.apiKey === "function" + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey + object[keyParamName] = localVarApiKeyValue + } } /** * * @export */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; +export const setBasicAuthToObject = function ( + object: any, + configuration?: Configuration, +) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { + username: configuration.username, + password: configuration.password, } + } } /** * * @export */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } +export const setBearerAuthToObject = async function ( + object: any, + configuration?: Configuration, +) { + if (configuration && configuration.accessToken) { + const accessToken = + typeof configuration.accessToken === "function" + ? await configuration.accessToken() + : await configuration.accessToken + object["Authorization"] = "Bearer " + accessToken + } } /** * * @export */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } +export const setOAuthToObject = async function ( + object: any, + name: string, + scopes: string[], + configuration?: Configuration, +) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = + typeof configuration.accessToken === "function" + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken + object["Authorization"] = "Bearer " + localVarAccessTokenValue + } } -function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { - if (parameter == null) return; - if (typeof parameter === "object") { - if (Array.isArray(parameter)) { - (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } - else { - Object.keys(parameter).forEach(currentKey => - setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) - ); - } - } - else { - if (urlSearchParams.has(key)) { - urlSearchParams.append(key, parameter); - } - else { - urlSearchParams.set(key, parameter); - } +function setFlattenedQueryParams( + urlSearchParams: URLSearchParams, + parameter: any, + key: string = "", +): void { + if (parameter == null) return + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + ;(parameter as any[]).forEach((item) => + setFlattenedQueryParams(urlSearchParams, item, key), + ) + } else { + Object.keys(parameter).forEach((currentKey) => + setFlattenedQueryParams( + urlSearchParams, + parameter[currentKey], + `${key}${key !== "" ? "." : ""}${currentKey}`, + ), + ) } + } else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter) + } else { + urlSearchParams.set(key, parameter) + } + } } /** @@ -111,23 +145,28 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an * @export */ export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - setFlattenedQueryParams(searchParams, objects); - url.search = searchParams.toString(); + const searchParams = new URLSearchParams(url.search) + setFlattenedQueryParams(searchParams, objects) + url.search = searchParams.toString() } /** * * @export */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); +export const serializeDataIfNeeded = function ( + value: any, + requestOptions: any, + configuration?: Configuration, +) { + const nonString = typeof value !== "string" + const needsSerialization = + nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers["Content-Type"]) + : nonString + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : value || "" } /** @@ -135,16 +174,29 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, * @export */ export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash + return url.pathname + url.search + url.hash } /** * * @export */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; +export const createRequestFunction = function ( + axiosArgs: RequestArgs, + globalAxios: AxiosInstance, + BASE_PATH: string, + configuration?: Configuration, +) { + return >( + axios: AxiosInstance = globalAxios, + basePath: string = BASE_PATH, + ) => { + const axiosRequestArgs = { + ...axiosArgs.options, + url: + (axios.defaults.baseURL ? "" : configuration?.basePath ?? basePath) + + axiosArgs.url, + } + return axios.request(axiosRequestArgs) + } } diff --git a/src/typescript/mit-learn-api-axios/src/v1/configuration.ts b/src/typescript/mit-learn-api-axios/src/v1/configuration.ts index 902459a..4b9af1f 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/configuration.ts +++ b/src/typescript/mit-learn-api-axios/src/v1/configuration.ts @@ -5,106 +5,128 @@ * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - export interface ConfigurationParameters { - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - username?: string; - password?: string; - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - basePath?: string; - serverIndex?: number; - baseOptions?: any; - formDataCtor?: new () => any; + apiKey?: + | string + | Promise + | ((name: string) => string) + | ((name: string) => Promise) + username?: string + password?: string + accessToken?: + | string + | Promise + | ((name?: string, scopes?: string[]) => string) + | ((name?: string, scopes?: string[]) => Promise) + basePath?: string + serverIndex?: number + baseOptions?: any + formDataCtor?: new () => any } export class Configuration { - /** - * parameter for apiKey security - * @param name security name - * @memberof Configuration - */ - apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - username?: string; - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - password?: string; - /** - * parameter for oauth2 security - * @param name security name - * @param scopes oauth2 scope - * @memberof Configuration - */ - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); - /** - * override base path - * - * @type {string} - * @memberof Configuration - */ - basePath?: string; - /** - * override server index - * - * @type {number} - * @memberof Configuration - */ - serverIndex?: number; - /** - * base options for axios calls - * - * @type {any} - * @memberof Configuration - */ - baseOptions?: any; - /** - * The FormData constructor that will be used to create multipart form data - * requests. You can inject this here so that execution environments that - * do not support the FormData class can still run the generated client. - * - * @type {new () => FormData} - */ - formDataCtor?: new () => any; + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: + | string + | Promise + | ((name: string) => string) + | ((name: string) => Promise) + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: + | string + | Promise + | ((name?: string, scopes?: string[]) => string) + | ((name?: string, scopes?: string[]) => Promise) + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.serverIndex = param.serverIndex; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey + this.username = param.username + this.password = param.password + this.accessToken = param.accessToken + this.basePath = param.basePath + this.serverIndex = param.serverIndex + this.baseOptions = param.baseOptions + this.formDataCtor = param.formDataCtor + } - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - public isJsonMime(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp( + "^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$", + "i", + ) + return ( + mime !== null && + (jsonMime.test(mime) || + mime.toLowerCase() === "application/json-patch+json") + ) + } } diff --git a/src/typescript/mit-learn-api-axios/src/v1/index.ts b/src/typescript/mit-learn-api-axios/src/v1/index.ts index d7f2a87..d04b034 100644 --- a/src/typescript/mit-learn-api-axios/src/v1/index.ts +++ b/src/typescript/mit-learn-api-axios/src/v1/index.ts @@ -5,14 +5,12 @@ * MIT public API * * The version of the OpenAPI document: 0.0.1 (v1) - * + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - -export * from "./api"; -export * from "./configuration"; - +export * from "./api" +export * from "./configuration"