/** * 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 { AddContentRequest } from '../models'; import { AddContentResponse } from '../models'; import { DeleteContentResponse } from '../models'; import { Filters } from '../models'; import { GetContentByProfileIdResponse } from '../models'; import { GetContentResponse } from '../models'; import { GetVTTResponse } from '../models'; import { ReportContentRequest } from '../models'; import { SuccessResponse } from '../models'; import { UpdateContent } from '../models'; import { UpdateContentResponse } from '../models'; import { UpdateVTTResponse } from '../models'; import { UpdateVttByIdRequest } from '../models'; /** * ContentApi - axios parameter creator * @export */ export declare const ContentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add content. * @summary Add content * @param {AddContentRequest} addContentRequest Add content * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContent: (addContentRequest: AddContentRequest, options?: AxiosRequestConfig) => Promise; /** * Delete content. * @summary Delete content * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContent: (contentId: string, options?: AxiosRequestConfig) => Promise; /** * Get content details. * @summary Get content details * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContent: (contentId: string, options?: AxiosRequestConfig) => Promise; /** * Get content by profile Id * @summary Get content by profile 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 content for * @param {Filters} [filters] Filters for which content is returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentByProfileid: (offset: number, limit: number, profileId: string, filters?: Filters, options?: AxiosRequestConfig) => Promise; /** * Get vtt. * @summary Get vtt * @param {string} id Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVtt: (id: string, options?: AxiosRequestConfig) => Promise; /** * Report content. * @summary Report content * @param {ReportContentRequest} reportContentRequest Report content * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportContent: (reportContentRequest: ReportContentRequest, options?: AxiosRequestConfig) => Promise; /** * Update content. * @summary Update content * @param {string} contentId Content ID * @param {UpdateContent} updateContent Update content * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContent: (contentId: string, updateContent: UpdateContent, options?: AxiosRequestConfig) => Promise; /** * Update vtt. * @summary Update vtt * @param {string} id Content ID * @param {UpdateVttByIdRequest} updateVttByIdRequest Update vtt * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVtt: (id: string, updateVttByIdRequest: UpdateVttByIdRequest, options?: AxiosRequestConfig) => Promise; }; /** * ContentApi - functional programming interface * @export */ export declare const ContentApiFp: (configuration?: Configuration) => { /** * Add content. * @summary Add content * @param {AddContentRequest} addContentRequest Add content * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContent(addContentRequest: AddContentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete content. * @summary Delete content * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContent(contentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get content details. * @summary Get content details * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContent(contentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get content by profile Id * @summary Get content by profile 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 content for * @param {Filters} [filters] Filters for which content is returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentByProfileid(offset: number, limit: number, profileId: string, filters?: Filters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get vtt. * @summary Get vtt * @param {string} id Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVtt(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Report content. * @summary Report content * @param {ReportContentRequest} reportContentRequest Report content * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportContent(reportContentRequest: ReportContentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update content. * @summary Update content * @param {string} contentId Content ID * @param {UpdateContent} updateContent Update content * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContent(contentId: string, updateContent: UpdateContent, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update vtt. * @summary Update vtt * @param {string} id Content ID * @param {UpdateVttByIdRequest} updateVttByIdRequest Update vtt * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVtt(id: string, updateVttByIdRequest: UpdateVttByIdRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContentApi - factory interface * @export */ export declare const ContentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add content. * @summary Add content * @param {AddContentRequest} addContentRequest Add content * @param {*} [options] Override http request option. * @throws {RequiredError} */ addContent(addContentRequest: AddContentRequest, options?: any): AxiosPromise; /** * Delete content. * @summary Delete content * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteContent(contentId: string, options?: any): AxiosPromise; /** * Get content details. * @summary Get content details * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContent(contentId: string, options?: any): AxiosPromise; /** * Get content by profile Id * @summary Get content by profile 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 content for * @param {Filters} [filters] Filters for which content is returned * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContentByProfileid(offset: number, limit: number, profileId: string, filters?: Filters, options?: any): AxiosPromise; /** * Get vtt. * @summary Get vtt * @param {string} id Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVtt(id: string, options?: any): AxiosPromise; /** * Report content. * @summary Report content * @param {ReportContentRequest} reportContentRequest Report content * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportContent(reportContentRequest: ReportContentRequest, options?: any): AxiosPromise; /** * Update content. * @summary Update content * @param {string} contentId Content ID * @param {UpdateContent} updateContent Update content * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateContent(contentId: string, updateContent: UpdateContent, options?: any): AxiosPromise; /** * Update vtt. * @summary Update vtt * @param {string} id Content ID * @param {UpdateVttByIdRequest} updateVttByIdRequest Update vtt * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateVtt(id: string, updateVttByIdRequest: UpdateVttByIdRequest, options?: any): AxiosPromise; }; /** * ContentApi - interface * @export * @interface ContentApi */ export interface ContentApiInterface { /** * Add content. * @summary Add content * @param {AddContentRequest} addContentRequest Add content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ addContent(addContentRequest: AddContentRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Delete content. * @summary Delete content * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ deleteContent(contentId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get content details. * @summary Get content details * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ getContent(contentId: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get content by profile Id * @summary Get content by profile 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 content for * @param {Filters} [filters] Filters for which content is returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ getContentByProfileid(offset: number, limit: number, profileId: string, filters?: Filters, options?: AxiosRequestConfig): AxiosPromise; /** * Get vtt. * @summary Get vtt * @param {string} id Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ getVtt(id: string, options?: AxiosRequestConfig): AxiosPromise; /** * Report content. * @summary Report content * @param {ReportContentRequest} reportContentRequest Report content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ reportContent(reportContentRequest: ReportContentRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Update content. * @summary Update content * @param {string} contentId Content ID * @param {UpdateContent} updateContent Update content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ updateContent(contentId: string, updateContent: UpdateContent, options?: AxiosRequestConfig): AxiosPromise; /** * Update vtt. * @summary Update vtt * @param {string} id Content ID * @param {UpdateVttByIdRequest} updateVttByIdRequest Update vtt * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApiInterface */ updateVtt(id: string, updateVttByIdRequest: UpdateVttByIdRequest, options?: AxiosRequestConfig): AxiosPromise; } /** * ContentApi - object-oriented interface * @export * @class ContentApi * @extends {BaseAPI} */ export declare class ContentApi extends BaseAPI implements ContentApiInterface { /** * Add content. * @summary Add content * @param {AddContentRequest} addContentRequest Add content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ addContent(addContentRequest: AddContentRequest, options?: AxiosRequestConfig): Promise>; /** * Delete content. * @summary Delete content * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ deleteContent(contentId: string, options?: AxiosRequestConfig): Promise>; /** * Get content details. * @summary Get content details * @param {string} contentId Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ getContent(contentId: string, options?: AxiosRequestConfig): Promise>; /** * Get content by profile Id * @summary Get content by profile 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 content for * @param {Filters} [filters] Filters for which content is returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ getContentByProfileid(offset: number, limit: number, profileId: string, filters?: Filters, options?: AxiosRequestConfig): Promise>; /** * Get vtt. * @summary Get vtt * @param {string} id Content ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ getVtt(id: string, options?: AxiosRequestConfig): Promise>; /** * Report content. * @summary Report content * @param {ReportContentRequest} reportContentRequest Report content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ reportContent(reportContentRequest: ReportContentRequest, options?: AxiosRequestConfig): Promise>; /** * Update content. * @summary Update content * @param {string} contentId Content ID * @param {UpdateContent} updateContent Update content * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ updateContent(contentId: string, updateContent: UpdateContent, options?: AxiosRequestConfig): Promise>; /** * Update vtt. * @summary Update vtt * @param {string} id Content ID * @param {UpdateVttByIdRequest} updateVttByIdRequest Update vtt * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContentApi */ updateVtt(id: string, updateVttByIdRequest: UpdateVttByIdRequest, options?: AxiosRequestConfig): Promise>; }