@easyedu/js-lsm-api 1.108.0 → 1.110.0

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

@@ -10,20 +10,29 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type ContentLibraryTag } from '../models/ContentLibraryTag';
+import { type GetContentLibraryTagItemList } from '../models/GetContentLibraryTagItemList';
+import { type GetContentLibraryTagList } from '../models/GetContentLibraryTagList';
 import { type GetContentLibraryVersion } from '../models/GetContentLibraryVersion';
 import { type GetResource } from '../models/GetResource';
 import { type GetResourceList } from '../models/GetResourceList';
 import { type GetResourceSession } from '../models/GetResourceSession';
 import { type GetResourceUsage } from '../models/GetResourceUsage';
 import { type GetResourceVersionUpload } from '../models/GetResourceVersionUpload';
+import { type PostContentLibraryTag } from '../models/PostContentLibraryTag';
+import { type PostContentLibraryTagMerge } from '../models/PostContentLibraryTagMerge';
 import { type PostResource } from '../models/PostResource';
 import { type PostResourceVersion } from '../models/PostResourceVersion';
 import { type PostResourceVersionComplete } from '../models/PostResourceVersionComplete';
 import { type PostResourceVersionSession } from '../models/PostResourceVersionSession';
 import { type PostResourceVersionUpload } from '../models/PostResourceVersionUpload';
+import { type PutContentLibraryTag } from '../models/PutContentLibraryTag';
 import { type PutResource } from '../models/PutResource';
 import { type PutResourceVersion } from '../models/PutResourceVersion';
 import { type ResourceType } from '../models/ResourceType';
+export interface DeleteContentLibraryTagRequest {
+    tagId: string;
+}
 export interface DeleteResourceVersionRequest {
     resourceId: string;
     versionId: string;
@@ -32,6 +41,26 @@ export interface GetContentLibraryItemListRequest {
     kind?: string;
     search?: string;
     resourceType?: ResourceType;
+    tagId?: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetContentLibraryTagRequest {
+    tagId: string;
+}
+export interface GetContentLibraryTagItemListRequest {
+    tagId: string;
+    kind?: GetContentLibraryTagItemListKindEnum;
+    search?: string;
+    includeArchived?: boolean;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetContentLibraryTagListRequest {
+    search?: string;
+    includeArchived?: boolean;
+    orderBy?: GetContentLibraryTagListOrderByEnum;
+    order?: GetContentLibraryTagListOrderEnum;
     page?: number;
     pageSize?: number;
 }
@@ -41,6 +70,7 @@ export interface GetResourceRequest {
 export interface GetResourceListRequest {
     search?: string;
     resourceType?: ResourceType;
+    tagId?: string;
     page?: number;
     pageSize?: number;
 }
@@ -51,6 +81,19 @@ export interface GetResourceVersionRequest {
     resourceId: string;
     versionId: string;
 }
+export interface PostContentLibraryTagRequest {
+    postContentLibraryTag: PostContentLibraryTag;
+}
+export interface PostContentLibraryTagArchiveRequest {
+    tagId: string;
+}
+export interface PostContentLibraryTagMergeRequest {
+    tagId: string;
+    postContentLibraryTagMerge: PostContentLibraryTagMerge;
+}
+export interface PostContentLibraryTagRestoreRequest {
+    tagId: string;
+}
 export interface PostResourceRequest {
     postResource: PostResource;
 }
@@ -84,6 +127,10 @@ export interface PostResourceVersionUploadCompleteRequest {
     versionId: string;
     postResourceVersionComplete: PostResourceVersionComplete;
 }
+export interface PutContentLibraryTagRequest {
+    tagId: string;
+    putContentLibraryTag: PutContentLibraryTag;
+}
 export interface PutResourceRequest {
     resourceId: string;
     putResource: PutResource;
@@ -102,6 +149,18 @@ export interface PutResourceVersionUploadFileRequest {
  *
  */
 export declare class ContentLibraryApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteContentLibraryTag without sending the request
+     */
+    deleteContentLibraryTagRequestOpts(requestParameters: DeleteContentLibraryTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a Content Library tag and remove it from associated content
+     */
+    deleteContentLibraryTagRaw(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a Content Library tag and remove it from associated content
+     */
+    deleteContentLibraryTag(requestParameters: DeleteContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for deleteResourceVersion without sending the request
      */
@@ -126,6 +185,42 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      * Search Content Library items
      */
     getContentLibraryItemList(requestParameters?: GetContentLibraryItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceList>;
+    /**
+     * Creates request options for getContentLibraryTag without sending the request
+     */
+    getContentLibraryTagRequestOpts(requestParameters: GetContentLibraryTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a Content Library tag
+     */
+    getContentLibraryTagRaw(requestParameters: GetContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Get a Content Library tag
+     */
+    getContentLibraryTag(requestParameters: GetContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
+    /**
+     * Creates request options for getContentLibraryTagItemList without sending the request
+     */
+    getContentLibraryTagItemListRequestOpts(requestParameters: GetContentLibraryTagItemListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List resources, quizzes, and questions associated with a tag
+     */
+    getContentLibraryTagItemListRaw(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryTagItemList>>;
+    /**
+     * List resources, quizzes, and questions associated with a tag
+     */
+    getContentLibraryTagItemList(requestParameters: GetContentLibraryTagItemListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryTagItemList>;
+    /**
+     * Creates request options for getContentLibraryTagList without sending the request
+     */
+    getContentLibraryTagListRequestOpts(requestParameters: GetContentLibraryTagListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List portal Content Library tags
+     */
+    getContentLibraryTagListRaw(requestParameters: GetContentLibraryTagListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentLibraryTagList>>;
+    /**
+     * List portal Content Library tags
+     */
+    getContentLibraryTagList(requestParameters?: GetContentLibraryTagListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryTagList>;
     /**
      * Creates request options for getResource without sending the request
      */
@@ -174,6 +269,54 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      * Get a resource version
      */
     getResourceVersion(requestParameters: GetResourceVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postContentLibraryTag without sending the request
+     */
+    postContentLibraryTagRequestOpts(requestParameters: PostContentLibraryTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a portal Content Library tag
+     */
+    postContentLibraryTagRaw(requestParameters: PostContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Create a portal Content Library tag
+     */
+    postContentLibraryTag(requestParameters: PostContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
+    /**
+     * Creates request options for postContentLibraryTagArchive without sending the request
+     */
+    postContentLibraryTagArchiveRequestOpts(requestParameters: PostContentLibraryTagArchiveRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Archive a Content Library tag
+     */
+    postContentLibraryTagArchiveRaw(requestParameters: PostContentLibraryTagArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Archive a Content Library tag
+     */
+    postContentLibraryTagArchive(requestParameters: PostContentLibraryTagArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
+    /**
+     * Creates request options for postContentLibraryTagMerge without sending the request
+     */
+    postContentLibraryTagMergeRequestOpts(requestParameters: PostContentLibraryTagMergeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Merge a Content Library tag into another tag
+     */
+    postContentLibraryTagMergeRaw(requestParameters: PostContentLibraryTagMergeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Merge a Content Library tag into another tag
+     */
+    postContentLibraryTagMerge(requestParameters: PostContentLibraryTagMergeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
+    /**
+     * Creates request options for postContentLibraryTagRestore without sending the request
+     */
+    postContentLibraryTagRestoreRequestOpts(requestParameters: PostContentLibraryTagRestoreRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Restore a Content Library tag
+     */
+    postContentLibraryTagRestoreRaw(requestParameters: PostContentLibraryTagRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Restore a Content Library tag
+     */
+    postContentLibraryTagRestore(requestParameters: PostContentLibraryTagRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
     /**
      * Creates request options for postResource without sending the request
      */
@@ -270,6 +413,18 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      * Verify and complete a resource upload
      */
     postResourceVersionUploadComplete(requestParameters: PostResourceVersionUploadCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for putContentLibraryTag without sending the request
+     */
+    putContentLibraryTagRequestOpts(requestParameters: PutContentLibraryTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Rename a Content Library tag
+     */
+    putContentLibraryTagRaw(requestParameters: PutContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContentLibraryTag>>;
+    /**
+     * Rename a Content Library tag
+     */
+    putContentLibraryTag(requestParameters: PutContentLibraryTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContentLibraryTag>;
     /**
      * Creates request options for putResource without sending the request
      */
@@ -307,3 +462,28 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      */
     putResourceVersionUploadFile(requestParameters: PutResourceVersionUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetContentLibraryTagItemListKindEnum: {
+    readonly Resource: "resource";
+    readonly Quiz: "quiz";
+    readonly Question: "question";
+};
+export type GetContentLibraryTagItemListKindEnum = typeof GetContentLibraryTagItemListKindEnum[keyof typeof GetContentLibraryTagItemListKindEnum];
+/**
+ * @export
+ */
+export declare const GetContentLibraryTagListOrderByEnum: {
+    readonly Name: "name";
+    readonly UsageCount: "usage_count";
+};
+export type GetContentLibraryTagListOrderByEnum = typeof GetContentLibraryTagListOrderByEnum[keyof typeof GetContentLibraryTagListOrderByEnum];
+/**
+ * @export
+ */
+export declare const GetContentLibraryTagListOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GetContentLibraryTagListOrderEnum = typeof GetContentLibraryTagListOrderEnum[keyof typeof GetContentLibraryTagListOrderEnum];