From b87bf1bfae13724060218c53bcd1334c2a980c3e Mon Sep 17 00:00:00 2001 From: MIT Open Learning Engineering Date: Mon, 5 Aug 2024 19:52:55 +0000 Subject: [PATCH] Generated clients from rev: becf6f5ef3be0b9546ca72a49508154cb248e38d --- VERSION | 2 +- pyproject.toml | 2 +- .../mit-open-api-axios/package.json | 2 +- .../mit-open-api-axios/src/v1/api.ts | 87 +++++++++++++------ 4 files changed, 62 insertions(+), 31 deletions(-) diff --git a/VERSION b/VERSION index 11669b2..807fe5b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2024.8.1 +2024.8.5 diff --git a/pyproject.toml b/pyproject.toml index 4847dde..eb78445 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "open-api-clients" -version = "2024.8.1" +version = "2024.8.5" description = "" authors = [] readme = "README.md" diff --git a/src/typescript/mit-open-api-axios/package.json b/src/typescript/mit-open-api-axios/package.json index 900d13c..0a4976b 100644 --- a/src/typescript/mit-open-api-axios/package.json +++ b/src/typescript/mit-open-api-axios/package.json @@ -1,6 +1,6 @@ { "name": "@mitodl/open-api-axios", - "version": "2024.8.1", + "version": "2024.8.5", "description": "Library for requesting data from mit-open APIs", "main": "dist/cjs/index.js", "scripts": { diff --git a/src/typescript/mit-open-api-axios/src/v1/api.ts b/src/typescript/mit-open-api-axios/src/v1/api.ts index 343a635..c9bf029 100644 --- a/src/typescript/mit-open-api-axios/src/v1/api.ts +++ b/src/typescript/mit-open-api-axios/src/v1/api.ts @@ -602,15 +602,15 @@ export interface CourseResource { * @type {Array} * @memberof CourseResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof CourseResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof CourseResource */ @@ -1201,15 +1201,15 @@ export interface LearningPathResource { * @type {Array} * @memberof LearningPathResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof LearningPathResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof LearningPathResource */ @@ -1408,7 +1408,7 @@ export type LearningPathResourceResourceTypeEnum = typeof LearningPathResourceRe export type LearningResource = { resource_type: 'course' } & CourseResource | { 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 + * Serializer for LearningResourceDepartment, minus school The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseDepartment */ @@ -1426,14 +1426,14 @@ export interface LearningResourceBaseDepartment { */ 'name': string; /** - * Get the channel url for the department if it exists + * * @type {string} * @memberof LearningResourceBaseDepartment */ 'channel_url': string | null; } /** - * Base serializer for LearningResourceSchool model, minus departments list + * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseSchool */ @@ -1458,7 +1458,7 @@ export interface LearningResourceBaseSchool { 'url': string; } /** - * Base serializer for LearningResourceSchool model, minus departments list + * Base serializer for LearningResourceSchool model, minus departments list The absence of the departments list is to avoid a circular serialization structure. * @export * @interface LearningResourceBaseSchoolRequest */ @@ -1514,7 +1514,7 @@ export interface LearningResourceDepartment { */ 'name': string; /** - * Get the channel url for the department if it exists + * * @type {string} * @memberof LearningResourceDepartment */ @@ -3202,6 +3202,18 @@ export interface PercolateQuery { * @memberof PercolateQuery */ 'id': number; + /** + * + * @type {string} + * @memberof PercolateQuery + */ + 'source_description': string; + /** + * + * @type {string} + * @memberof PercolateQuery + */ + 'source_label': string; /** * * @type {any} @@ -3501,7 +3513,7 @@ export interface Podcast { */ 'id': number; /** - * Return the number of episodes in the podcast + * * @type {number} * @memberof Podcast */ @@ -3670,15 +3682,15 @@ export interface PodcastEpisodeResource { * @type {Array} * @memberof PodcastEpisodeResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof PodcastEpisodeResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof PodcastEpisodeResource */ @@ -3876,6 +3888,12 @@ export type PodcastEpisodeResourceResourceTypeEnum = typeof PodcastEpisodeResour * @interface PodcastRequest */ export interface PodcastRequest { + /** + * + * @type {number} + * @memberof PodcastRequest + */ + 'episode_count': number; /** * * @type {string} @@ -3972,15 +3990,15 @@ export interface PodcastResource { * @type {Array} * @memberof PodcastResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof PodcastResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof PodcastResource */ @@ -4495,15 +4513,15 @@ export interface ProgramResource { * @type {Array} * @memberof ProgramResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof ProgramResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof ProgramResource */ @@ -5109,12 +5127,25 @@ export interface VideoPlaylist { */ 'channel': VideoChannel | null; /** - * Return the number of videos in the playlist + * * @type {number} * @memberof VideoPlaylist */ 'video_count': number; } +/** + * Serializer for the VideoPlaylist model + * @export + * @interface VideoPlaylistRequest + */ +export interface VideoPlaylistRequest { + /** + * + * @type {number} + * @memberof VideoPlaylistRequest + */ + 'video_count': number; +} /** * Serializer for video playlist resources * @export @@ -5192,15 +5223,15 @@ export interface VideoPlaylistResource { * @type {Array} * @memberof VideoPlaylistResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof VideoPlaylistResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof VideoPlaylistResource */ @@ -5488,15 +5519,15 @@ export interface VideoResource { * @type {Array} * @memberof VideoResource */ - 'learning_path_parents': Array | null; + 'learning_path_parents': Array; /** * * @type {Array} * @memberof VideoResource */ - 'user_list_parents': Array | null; + 'user_list_parents': Array; /** - * Return the number of views for the resource. + * * @type {number} * @memberof VideoResource */