/** * The Association for Cube Commons * The CubeCommons API caters to each and every whim of the Frontend, i.e. it receives, bundles, packages and formats data exactly as the Frontend needs it. * * The version of the OpenAPI document: 0.9.95 * Contact: tech@cubecommons.ca * * 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, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { AddContentToPlaylistRequest } from '../models'; import { AddContentToPlaylistResponse } from '../models'; import { AddPlaylistRequest } from '../models'; import { AddPlaylistResponse } from '../models'; import { DeletePlaylistResponse } from '../models'; import { GetPlaylistByIdResponse } from '../models'; import { GetPlaylistResponse } from '../models'; import { RemoveContentFromPlaylistRequest } from '../models'; import { RemoveContentFromPlaylistResponse } from '../models'; import { UpdatePlaylist } from '../models'; import { UpdatePlaylistResponse } from '../models'; /** * PlaylistApi - axios parameter creator * @export */ export declare const PlaylistApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add content to playlist. * @summary Add content to playlist * @param {string} playlistId playlist ID * @param {AddContentToPlaylistRequest} addContentToPlaylistRequest Add content to playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContentToPlaylist: (playlistId: string, addContentToPlaylistRequest: AddContentToPlaylistRequest, options?: AxiosRequestConfig) => Promise; /** * Add playlist. * @summary Add playlist * @param {AddPlaylistRequest} addPlaylistRequest Add playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPlaylist: (addPlaylistRequest: AddPlaylistRequest, options?: AxiosRequestConfig) => Promise; /** * Delete playlist. * @summary Delete playlist * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePlaylist: (playlistId: string, options?: AxiosRequestConfig) => Promise; /** * Get get_playlist by profile or user Id * @summary Get get_playlist by profile or user Id * @param {number} offset Offset into the result set * @param {number} limit Max number of items to return * @param {string} profileId ID of profile to return playlist for * @param {string} userId ID of user to return playlist for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylist: (offset: number, limit: number, profileId: string, userId: string, options?: AxiosRequestConfig) => Promise; /** * Get playlist details. * @summary Get playlist details * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylistById: (playlistId: string, options?: AxiosRequestConfig) => Promise; /** * Remove content from playlist. * @summary Remove content from playlist * @param {string} playlistId playlist ID * @param {RemoveContentFromPlaylistRequest} removeContentFromPlaylistRequest Remove content from playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContentFromPlaylist: (playlistId: string, removeContentFromPlaylistRequest: RemoveContentFromPlaylistRequest, options?: AxiosRequestConfig) => Promise; /** * Update playlist. * @summary Update playlist * @param {string} playlistId playlist ID * @param {UpdatePlaylist} updatePlaylist Update playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePlaylist: (playlistId: string, updatePlaylist: UpdatePlaylist, options?: AxiosRequestConfig) => Promise; }; /** * PlaylistApi - functional programming interface * @export */ export declare const PlaylistApiFp: (configuration?: Configuration) => { /** * Add content to playlist. * @summary Add content to playlist * @param {string} playlistId playlist ID * @param {AddContentToPlaylistRequest} addContentToPlaylistRequest Add content to playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContentToPlaylist(playlistId: string, addContentToPlaylistRequest: AddContentToPlaylistRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add playlist. * @summary Add playlist * @param {AddPlaylistRequest} addPlaylistRequest Add playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPlaylist(addPlaylistRequest: AddPlaylistRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete playlist. * @summary Delete playlist * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePlaylist(playlistId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get get_playlist by profile or user Id * @summary Get get_playlist by profile or user Id * @param {number} offset Offset into the result set * @param {number} limit Max number of items to return * @param {string} profileId ID of profile to return playlist for * @param {string} userId ID of user to return playlist for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylist(offset: number, limit: number, profileId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get playlist details. * @summary Get playlist details * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylistById(playlistId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove content from playlist. * @summary Remove content from playlist * @param {string} playlistId playlist ID * @param {RemoveContentFromPlaylistRequest} removeContentFromPlaylistRequest Remove content from playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContentFromPlaylist(playlistId: string, removeContentFromPlaylistRequest: RemoveContentFromPlaylistRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update playlist. * @summary Update playlist * @param {string} playlistId playlist ID * @param {UpdatePlaylist} updatePlaylist Update playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePlaylist(playlistId: string, updatePlaylist: UpdatePlaylist, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PlaylistApi - factory interface * @export */ export declare const PlaylistApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add content to playlist. * @summary Add content to playlist * @param {string} playlistId playlist ID * @param {AddContentToPlaylistRequest} addContentToPlaylistRequest Add content to playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContentToPlaylist(playlistId: string, addContentToPlaylistRequest: AddContentToPlaylistRequest, options?: any): AxiosPromise; /** * Add playlist. * @summary Add playlist * @param {AddPlaylistRequest} addPlaylistRequest Add playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPlaylist(addPlaylistRequest: AddPlaylistRequest, options?: any): AxiosPromise; /** * Delete playlist. * @summary Delete playlist * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePlaylist(playlistId: string, options?: any): AxiosPromise; /** * Get get_playlist by profile or user Id * @summary Get get_playlist by profile or user Id * @param {number} offset Offset into the result set * @param {number} limit Max number of items to return * @param {string} profileId ID of profile to return playlist for * @param {string} userId ID of user to return playlist for * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylist(offset: number, limit: number, profileId: string, userId: string, options?: any): AxiosPromise; /** * Get playlist details. * @summary Get playlist details * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPlaylistById(playlistId: string, options?: any): AxiosPromise; /** * Remove content from playlist. * @summary Remove content from playlist * @param {string} playlistId playlist ID * @param {RemoveContentFromPlaylistRequest} removeContentFromPlaylistRequest Remove content from playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeContentFromPlaylist(playlistId: string, removeContentFromPlaylistRequest: RemoveContentFromPlaylistRequest, options?: any): AxiosPromise; /** * Update playlist. * @summary Update playlist * @param {string} playlistId playlist ID * @param {UpdatePlaylist} updatePlaylist Update playlist * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePlaylist(playlistId: string, updatePlaylist: UpdatePlaylist, options?: any): AxiosPromise; }; /** * PlaylistApi - interface * @export * @interface PlaylistApi */ export interface PlaylistApiInterface { /** * Add content to playlist. * @summary Add content to playlist * @param {string} playlistId playlist ID * @param {AddContentToPlaylistRequest} addContentToPlaylistRequest Add content to playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ addContentToPlaylist(playlistId: string, addContentToPlaylistRequest: AddContentToPlaylistRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Add playlist. * @summary Add playlist * @param {AddPlaylistRequest} addPlaylistRequest Add playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ addPlaylist(addPlaylistRequest: AddPlaylistRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Delete playlist. * @summary Delete playlist * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ deletePlaylist(playlistId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get get_playlist by profile or user Id * @summary Get get_playlist by profile or user Id * @param {number} offset Offset into the result set * @param {number} limit Max number of items to return * @param {string} profileId ID of profile to return playlist for * @param {string} userId ID of user to return playlist for * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ getPlaylist(offset: number, limit: number, profileId: string, userId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get playlist details. * @summary Get playlist details * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ getPlaylistById(playlistId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Remove content from playlist. * @summary Remove content from playlist * @param {string} playlistId playlist ID * @param {RemoveContentFromPlaylistRequest} removeContentFromPlaylistRequest Remove content from playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ removeContentFromPlaylist(playlistId: string, removeContentFromPlaylistRequest: RemoveContentFromPlaylistRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Update playlist. * @summary Update playlist * @param {string} playlistId playlist ID * @param {UpdatePlaylist} updatePlaylist Update playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApiInterface */ updatePlaylist(playlistId: string, updatePlaylist: UpdatePlaylist, options?: AxiosRequestConfig): AxiosPromise; } /** * PlaylistApi - object-oriented interface * @export * @class PlaylistApi * @extends {BaseAPI} */ export declare class PlaylistApi extends BaseAPI implements PlaylistApiInterface { /** * Add content to playlist. * @summary Add content to playlist * @param {string} playlistId playlist ID * @param {AddContentToPlaylistRequest} addContentToPlaylistRequest Add content to playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ addContentToPlaylist(playlistId: string, addContentToPlaylistRequest: AddContentToPlaylistRequest, options?: AxiosRequestConfig): Promise>; /** * Add playlist. * @summary Add playlist * @param {AddPlaylistRequest} addPlaylistRequest Add playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ addPlaylist(addPlaylistRequest: AddPlaylistRequest, options?: AxiosRequestConfig): Promise>; /** * Delete playlist. * @summary Delete playlist * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ deletePlaylist(playlistId: string, options?: AxiosRequestConfig): Promise>; /** * Get get_playlist by profile or user Id * @summary Get get_playlist by profile or user Id * @param {number} offset Offset into the result set * @param {number} limit Max number of items to return * @param {string} profileId ID of profile to return playlist for * @param {string} userId ID of user to return playlist for * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ getPlaylist(offset: number, limit: number, profileId: string, userId: string, options?: AxiosRequestConfig): Promise>; /** * Get playlist details. * @summary Get playlist details * @param {string} playlistId playlist ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ getPlaylistById(playlistId: string, options?: AxiosRequestConfig): Promise>; /** * Remove content from playlist. * @summary Remove content from playlist * @param {string} playlistId playlist ID * @param {RemoveContentFromPlaylistRequest} removeContentFromPlaylistRequest Remove content from playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ removeContentFromPlaylist(playlistId: string, removeContentFromPlaylistRequest: RemoveContentFromPlaylistRequest, options?: AxiosRequestConfig): Promise>; /** * Update playlist. * @summary Update playlist * @param {string} playlistId playlist ID * @param {UpdatePlaylist} updatePlaylist Update playlist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PlaylistApi */ updatePlaylist(playlistId: string, updatePlaylist: UpdatePlaylist, options?: AxiosRequestConfig): Promise>; }