@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/dist/esm/apis/ContentLibraryApi.d.ts

@@ -0,0 +1,290 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type GetContentLibraryVersion } from '../models/GetContentLibraryVersion';
+import { type GetResource } from '../models/GetResource';
+import { type GetResourceList } from '../models/GetResourceList';
+import { type GetResourceUsage } from '../models/GetResourceUsage';
+import { type GetResourceVersionUpload } from '../models/GetResourceVersionUpload';
+import { type PostResource } from '../models/PostResource';
+import { type PostResourceVersion } from '../models/PostResourceVersion';
+import { type PostResourceVersionComplete } from '../models/PostResourceVersionComplete';
+import { type PostResourceVersionUpload } from '../models/PostResourceVersionUpload';
+import { type PutResource } from '../models/PutResource';
+import { type PutResourceVersion } from '../models/PutResourceVersion';
+import { type ResourceType } from '../models/ResourceType';
+export interface DeleteResourceVersionRequest {
+    resourceId: string;
+    versionId: string;
+}
+export interface GetContentLibraryItemListRequest {
+    kind?: string;
+    search?: string;
+    resourceType?: ResourceType;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetResourceRequest {
+    resourceId: string;
+}
+export interface GetResourceListRequest {
+    search?: string;
+    resourceType?: ResourceType;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetResourceUsageRequest {
+    resourceId: string;
+}
+export interface GetResourceVersionRequest {
+    resourceId: string;
+    versionId: string;
+}
+export interface PostResourceRequest {
+    postResource: PostResource;
+}
+export interface PostResourceArchiveRequest {
+    resourceId: string;
+}
+export interface PostResourceVersionRequest {
+    resourceId: string;
+    postResourceVersion?: PostResourceVersion;
+}
+export interface PostResourceVersionArchiveRequest {
+    resourceId: string;
+    versionId: string;
+}
+export interface PostResourceVersionPublishRequest {
+    resourceId: string;
+    versionId: string;
+}
+export interface PostResourceVersionUploadRequest {
+    resourceId: string;
+    versionId: string;
+    postResourceVersionUpload: PostResourceVersionUpload;
+}
+export interface PostResourceVersionUploadCompleteRequest {
+    resourceId: string;
+    versionId: string;
+    postResourceVersionComplete: PostResourceVersionComplete;
+}
+export interface PutResourceRequest {
+    resourceId: string;
+    putResource: PutResource;
+}
+export interface PutResourceVersionRequest {
+    resourceId: string;
+    versionId: string;
+    putResourceVersion: PutResourceVersion;
+}
+export interface PutResourceVersionUploadFileRequest {
+    resourceId: string;
+    versionId: string;
+    body: Blob;
+}
+/**
+ *
+ */
+export declare class ContentLibraryApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteResourceVersion without sending the request
+     */
+    deleteResourceVersionRequestOpts(requestParameters: DeleteResourceVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Discard an unreferenced draft resource version
+     */
+    deleteResourceVersionRaw(requestParameters: DeleteResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Discard an unreferenced draft resource version
+     */
+    deleteResourceVersion(requestParameters: DeleteResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getContentLibraryItemList without sending the request
+     */
+    getContentLibraryItemListRequestOpts(requestParameters: GetContentLibraryItemListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Search Content Library items
+     */
+    getContentLibraryItemListRaw(requestParameters: GetContentLibraryItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceList>>;
+    /**
+     * Search Content Library items
+     */
+    getContentLibraryItemList(requestParameters?: GetContentLibraryItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceList>;
+    /**
+     * Creates request options for getResource without sending the request
+     */
+    getResourceRequestOpts(requestParameters: GetResourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a resource and all versions
+     */
+    getResourceRaw(requestParameters: GetResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResource>>;
+    /**
+     * Get a resource and all versions
+     */
+    getResource(requestParameters: GetResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResource>;
+    /**
+     * Creates request options for getResourceList without sending the request
+     */
+    getResourceListRequestOpts(requestParameters: GetResourceListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List reusable resources
+     */
+    getResourceListRaw(requestParameters: GetResourceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceList>>;
+    /**
+     * List reusable resources
+     */
+    getResourceList(requestParameters?: GetResourceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceList>;
+    /**
+     * Creates request options for getResourceUsage without sending the request
+     */
+    getResourceUsageRequestOpts(requestParameters: GetResourceUsageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get course and learner usage for a resource
+     */
+    getResourceUsageRaw(requestParameters: GetResourceUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceUsage>>;
+    /**
+     * Get course and learner usage for a resource
+     */
+    getResourceUsage(requestParameters: GetResourceUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceUsage>;
+    /**
+     * Creates request options for getResourceVersion without sending the request
+     */
+    getResourceVersionRequestOpts(requestParameters: GetResourceVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a resource version
+     */
+    getResourceVersionRaw(requestParameters: GetResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Get a resource version
+     */
+    getResourceVersion(requestParameters: GetResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postResource without sending the request
+     */
+    postResourceRequestOpts(requestParameters: PostResourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a resource and its first draft version
+     */
+    postResourceRaw(requestParameters: PostResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResource>>;
+    /**
+     * Create a resource and its first draft version
+     */
+    postResource(requestParameters: PostResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResource>;
+    /**
+     * Creates request options for postResourceArchive without sending the request
+     */
+    postResourceArchiveRequestOpts(requestParameters: PostResourceArchiveRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Archive a logical resource
+     */
+    postResourceArchiveRaw(requestParameters: PostResourceArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResource>>;
+    /**
+     * Archive a logical resource
+     */
+    postResourceArchive(requestParameters: PostResourceArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResource>;
+    /**
+     * Creates request options for postResourceVersion without sending the request
+     */
+    postResourceVersionRequestOpts(requestParameters: PostResourceVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create the next draft resource version
+     */
+    postResourceVersionRaw(requestParameters: PostResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Create the next draft resource version
+     */
+    postResourceVersion(requestParameters: PostResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postResourceVersionArchive without sending the request
+     */
+    postResourceVersionArchiveRequestOpts(requestParameters: PostResourceVersionArchiveRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Archive a published resource version
+     */
+    postResourceVersionArchiveRaw(requestParameters: PostResourceVersionArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Archive a published resource version
+     */
+    postResourceVersionArchive(requestParameters: PostResourceVersionArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postResourceVersionPublish without sending the request
+     */
+    postResourceVersionPublishRequestOpts(requestParameters: PostResourceVersionPublishRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Publish an immutable resource version
+     */
+    postResourceVersionPublishRaw(requestParameters: PostResourceVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Publish an immutable resource version
+     */
+    postResourceVersionPublish(requestParameters: PostResourceVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postResourceVersionUpload without sending the request
+     */
+    postResourceVersionUploadRequestOpts(requestParameters: PostResourceVersionUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Initialize a version-scoped file upload
+     */
+    postResourceVersionUploadRaw(requestParameters: PostResourceVersionUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceVersionUpload>>;
+    /**
+     * Initialize a version-scoped file upload
+     */
+    postResourceVersionUpload(requestParameters: PostResourceVersionUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceVersionUpload>;
+    /**
+     * Creates request options for postResourceVersionUploadComplete without sending the request
+     */
+    postResourceVersionUploadCompleteRequestOpts(requestParameters: PostResourceVersionUploadCompleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Verify and complete a resource upload
+     */
+    postResourceVersionUploadCompleteRaw(requestParameters: PostResourceVersionUploadCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Verify and complete a resource upload
+     */
+    postResourceVersionUploadComplete(requestParameters: PostResourceVersionUploadCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for putResource without sending the request
+     */
+    putResourceRequestOpts(requestParameters: PutResourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update resource library metadata
+     */
+    putResourceRaw(requestParameters: PutResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResource>>;
+    /**
+     * Update resource library metadata
+     */
+    putResource(requestParameters: PutResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResource>;
+    /**
+     * Creates request options for putResourceVersion without sending the request
+     */
+    putResourceVersionRequestOpts(requestParameters: PutResourceVersionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Edit a draft resource version
+     */
+    putResourceVersionRaw(requestParameters: PutResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryVersion>>;
+    /**
+     * Edit a draft resource version
+     */
+    putResourceVersion(requestParameters: PutResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for putResourceVersionUploadFile without sending the request
+     */
+    putResourceVersionUploadFileRequestOpts(requestParameters: PutResourceVersionUploadFileRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload bytes for a draft resource version
+     */
+    putResourceVersionUploadFileRaw(requestParameters: PutResourceVersionUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Upload bytes for a draft resource version
+     */
+    putResourceVersionUploadFile(requestParameters: PutResourceVersionUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}