Revize b80a6919

Document finalization

webapp/api/api.ts

@@ -47 +47 @@
      */
     'note'?: string | null;
 }
+/**
+ * 
+ * @export
+ * @interface Annotation
+ */
+export interface Annotation {
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Document}
+     * @memberof Annotation
+     */
+    'document'?: Document;
+    /**
+     * 
+     * @type {User}
+     * @memberof Annotation
+     */
+    'user'?: User;
+    /**
+     * 
+     * @type {User}
+     * @memberof Annotation
+     */
+    'userAssigned'?: User;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'dateAssigned'?: string;
+    /**
+     * 
+     * @type {EState}
+     * @memberof Annotation
+     */
+    'state'?: EState;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'dateLastChanged'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'note'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedDocumentHTML'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedStartPositions'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedLengths'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedClosingPositions'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedClosingLengths'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'cachedCSS'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Annotation
+     */
+    'lastModifiedTagId'?: string | null;
+    /**
+     * 
+     * @type {EModified}
+     * @memberof Annotation
+     */
+    'modifiedType'?: EModified;
+    /**
+     * 
+     * @type {Array<Class>}
+     * @memberof Annotation
+     */
+    'classes'?: Array<Class> | null;
+    /**
+     * 
+     * @type {Array<FinalAnnotation>}
+     * @memberof Annotation
+     */
+    'finalAnnotations'?: Array<FinalAnnotation> | null;
+}
 /**
  * 
  * @export
@@ -245 +360 @@
      */
     'role'?: ERole;
 }
+/**
+ * 
+ * @export
+ * @interface Class
+ */
+export interface Class {
+    /**
+     * 
+     * @type {string}
+     * @memberof Class
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Class
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Class
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Class
+     */
+    'color'?: string | null;
+    /**
+     * 
+     * @type {Array<Annotation>}
+     * @memberof Class
+     */
+    'annotations'?: Array<Annotation> | null;
+}
 /**
  * 
  * @export
@@ -419 +571 @@
      */
     'role'?: ERole;
 }
+/**
+ * 
+ * @export
+ * @interface Document
+ */
+export interface Document {
+    /**
+     * 
+     * @type {string}
+     * @memberof Document
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Document
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Document
+     */
+    'length'?: number;
+    /**
+     * 
+     * @type {DocumentContent}
+     * @memberof Document
+     */
+    'content'?: DocumentContent;
+    /**
+     * 
+     * @type {string}
+     * @memberof Document
+     */
+    'dateAdded'?: string;
+    /**
+     * 
+     * @type {User}
+     * @memberof Document
+     */
+    'userAdded'?: User;
+    /**
+     * 
+     * @type {number}
+     * @memberof Document
+     */
+    'requiredAnnotations'?: number;
+}
 /**
  * 
  * @export
@@ -494 +695 @@
      */
     'username'?: string | null;
 }
+/**
+ * 
+ * @export
+ * @interface DocumentContent
+ */
+export interface DocumentContent {
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentContent
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentContent
+     */
+    'content'?: string | null;
+}
 /**
  * 
  * @export
@@ -664 +884 @@
 export type EDocumentType = typeof EDocumentType[keyof typeof EDocumentType];
 
 
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const EModified = {
+    Added: 'ADDED',
+    Removed: 'REMOVED',
+    None: 'NONE'
+} as const;
+
+export type EModified = typeof EModified[keyof typeof EModified];
+
+
 /**
  * 
  * @export
@@ -722 +957 @@
 export type ETagType = typeof ETagType[keyof typeof ETagType];
 
 
+/**
+ * 
+ * @export
+ * @interface FinalAnnotation
+ */
+export interface FinalAnnotation {
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Document}
+     * @memberof FinalAnnotation
+     */
+    'document'?: Document;
+    /**
+     * 
+     * @type {User}
+     * @memberof FinalAnnotation
+     */
+    'user'?: User;
+    /**
+     * 
+     * @type {User}
+     * @memberof FinalAnnotation
+     */
+    'userAssigned'?: User;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'dateAssigned'?: string;
+    /**
+     * 
+     * @type {EState}
+     * @memberof FinalAnnotation
+     */
+    'state'?: EState;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'dateLastChanged'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'note'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedDocumentHTML'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedStartPositions'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedLengths'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedClosingPositions'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedClosingLengths'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'cachedCSS'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotation
+     */
+    'lastModifiedTagId'?: string | null;
+    /**
+     * 
+     * @type {EModified}
+     * @memberof FinalAnnotation
+     */
+    'modifiedType'?: EModified;
+    /**
+     * 
+     * @type {Array<Class>}
+     * @memberof FinalAnnotation
+     */
+    'classes'?: Array<Class> | null;
+    /**
+     * 
+     * @type {Array<FinalAnnotation>}
+     * @memberof FinalAnnotation
+     */
+    'finalAnnotations'?: Array<FinalAnnotation> | null;
+    /**
+     * 
+     * @type {Array<Annotation>}
+     * @memberof FinalAnnotation
+     */
+    'annotations'?: Array<Annotation> | null;
+}
+/**
+ * 
+ * @export
+ * @interface FinalAnnotationTag
+ */
+export interface FinalAnnotationTag {
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotationTag
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {Tag}
+     * @memberof FinalAnnotationTag
+     */
+    'tag'?: Tag;
+    /**
+     * 
+     * @type {SubTag}
+     * @memberof FinalAnnotationTag
+     */
+    'subTag'?: SubTag;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotationTag
+     */
+    'instance'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotationTag
+     */
+    'note'?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof FinalAnnotationTag
+     */
+    'position'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof FinalAnnotationTag
+     */
+    'length'?: number;
+    /**
+     * 
+     * @type {ETagSentiment}
+     * @memberof FinalAnnotationTag
+     */
+    'sentiment'?: ETagSentiment;
+    /**
+     * 
+     * @type {string}
+     * @memberof FinalAnnotationTag
+     */
+    'selectedText'?: string | null;
+    /**
+     * 
+     * @type {FinalAnnotation}
+     * @memberof FinalAnnotationTag
+     */
+    'annotation'?: FinalAnnotation;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof FinalAnnotationTag
+     */
+    'isFinal'?: boolean;
+    /**
+     * 
+     * @type {Array<User>}
+     * @memberof FinalAnnotationTag
+     */
+    'users'?: Array<User> | null;
+}
 /**
  * 
  * @export
@@ -924 +1359 @@
      */
     'instance'?: string | null;
 }
+/**
+ * 
+ * @export
+ * @interface SetInstanceIsFinalRequest
+ */
+export interface SetInstanceIsFinalRequest {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SetInstanceIsFinalRequest
+     */
+    'isFinal'?: boolean;
+}
 /**
  * 
  * @export
@@ -969 +1417 @@
      */
     'documentIds'?: Array<string> | null;
 }
+/**
+ * 
+ * @export
+ * @interface SubTag
+ */
+export interface SubTag {
+    /**
+     * 
+     * @type {string}
+     * @memberof SubTag
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubTag
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubTag
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {Tag}
+     * @memberof SubTag
+     */
+    'tag'?: Tag;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SubTag
+     */
+    'sentimentEnabled'?: boolean;
+}
 /**
  * 
  * @export
@@ -994 +1479 @@
      */
     'description'?: string | null;
 }
+/**
+ * 
+ * @export
+ * @interface Tag
+ */
+export interface Tag {
+    /**
+     * 
+     * @type {string}
+     * @memberof Tag
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {TagCategory}
+     * @memberof Tag
+     */
+    'category'?: TagCategory;
+    /**
+     * 
+     * @type {string}
+     * @memberof Tag
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Tag
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Tag
+     */
+    'color'?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Tag
+     */
+    'sentimentEnabled'?: boolean;
+}
+/**
+ * 
+ * @export
+ * @interface TagCategory
+ */
+export interface TagCategory {
+    /**
+     * 
+     * @type {string}
+     * @memberof TagCategory
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof TagCategory
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TagCategory
+     */
+    'color'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TagCategory
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TagCategory
+     */
+    'disabledForAnnotators'?: boolean;
+}
 /**
  * 
  * @export
@@ -1183 +1748 @@
      * @memberof TagInstanceInfo
      */
     'selectedText'?: string | null;
+    /**
+     * 
+     * @type {Array<UserInfo>}
+     * @memberof TagInstanceInfo
+     */
+    'users'?: Array<UserInfo> | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof TagInstanceInfo
+     */
+    'isFinal'?: boolean | null;
 }
 /**
  * 
@@ -1233 +1810 @@
      * @memberof User
      */
     'role'?: ERole;
+    /**
+     * 
+     * @type {Array<FinalAnnotationTag>}
+     * @memberof User
+     */
+    'finalAnnotationTags'?: Array<FinalAnnotationTag> | null;
 }
 /**
  * 
@@ -1507 +2090 @@
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 
+         * @param {string} annotationId 
+         * @param {string} occurenceId 
+         * @param {SetInstanceIsFinalRequest} [setInstanceIsFinalRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        annotationAnnotationIdOccurenceIdFinalPut: async (annotationId: string, occurenceId: string, setInstanceIsFinalRequest?: SetInstanceIsFinalRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'annotationId' is not null or undefined
+            assertParamExists('annotationAnnotationIdOccurenceIdFinalPut', 'annotationId', annotationId)
+            // verify required parameter 'occurenceId' is not null or undefined
+            assertParamExists('annotationAnnotationIdOccurenceIdFinalPut', 'occurenceId', occurenceId)
+            const localVarPath = `/annotation/{annotationId}/{occurenceId}/final`
+                .replace(`{${"annotationId"}}`, encodeURIComponent(String(annotationId)))
+                .replace(`{${"occurenceId"}}`, encodeURIComponent(String(occurenceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(setInstanceIsFinalRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @param {string} annotationId 
@@ -1698 +2322 @@
             const localVarAxiosArgs = await localVarAxiosParamCreator.annotationAnnotationIdOccurenceIdDelete(annotationId, occurenceId, isFinal, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * 
+         * @param {string} annotationId 
+         * @param {string} occurenceId 
+         * @param {SetInstanceIsFinalRequest} [setInstanceIsFinalRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async annotationAnnotationIdOccurenceIdFinalPut(annotationId: string, occurenceId: string, setInstanceIsFinalRequest?: SetInstanceIsFinalRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.annotationAnnotationIdOccurenceIdFinalPut(annotationId, occurenceId, setInstanceIsFinalRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * 
          * @param {string} annotationId 
@@ -1798 +2434 @@
         annotationAnnotationIdOccurenceIdDelete(annotationId: string, occurenceId: string, isFinal?: boolean, options?: any): AxiosPromise<void> {
             return localVarFp.annotationAnnotationIdOccurenceIdDelete(annotationId, occurenceId, isFinal, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @param {string} annotationId 
+         * @param {string} occurenceId 
+         * @param {SetInstanceIsFinalRequest} [setInstanceIsFinalRequest] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        annotationAnnotationIdOccurenceIdFinalPut(annotationId: string, occurenceId: string, setInstanceIsFinalRequest?: SetInstanceIsFinalRequest, options?: any): AxiosPromise<void> {
+            return localVarFp.annotationAnnotationIdOccurenceIdFinalPut(annotationId, occurenceId, setInstanceIsFinalRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @param {string} annotationId 
@@ -1905 +2552 @@
         return AnnotationApiFp(this.configuration).annotationAnnotationIdOccurenceIdDelete(annotationId, occurenceId, isFinal, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @param {string} annotationId 
+     * @param {string} occurenceId 
+     * @param {SetInstanceIsFinalRequest} [setInstanceIsFinalRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AnnotationApi
+     */
+    public annotationAnnotationIdOccurenceIdFinalPut(annotationId: string, occurenceId: string, setInstanceIsFinalRequest?: SetInstanceIsFinalRequest, options?: AxiosRequestConfig) {
+        return AnnotationApiFp(this.configuration).annotationAnnotationIdOccurenceIdFinalPut(annotationId, occurenceId, setInstanceIsFinalRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @param {string} annotationId