@se-uulm/snowballr-api-client 0.2.1-alpha.fba5056 → 0.2.1-alpha.fd8901d

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/CreateProjectRequest.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateProjectRequest
+ */
+export interface CreateProjectRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateProjectRequest
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the CreateProjectRequest interface.
+ */
+export function instanceOfCreateProjectRequest(value: object): value is CreateProjectRequest {
+    return true;
+}
+
+export function CreateProjectRequestFromJSON(json: any): CreateProjectRequest {
+    return CreateProjectRequestFromJSONTyped(json, false);
+}
+
+export function CreateProjectRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProjectRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function CreateProjectRequestToJSON(json: any): CreateProjectRequest {
+    return CreateProjectRequestToJSONTyped(json, false);
+}
+
+export function CreateProjectRequestToJSONTyped(value?: CreateProjectRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+    };
+}
+

package/src/models/DecisionMatrixPattern.ts

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DecisionMatrixPatternEntry } from './DecisionMatrixPatternEntry';
+import {
+    DecisionMatrixPatternEntryFromJSON,
+    DecisionMatrixPatternEntryFromJSONTyped,
+    DecisionMatrixPatternEntryToJSON,
+    DecisionMatrixPatternEntryToJSONTyped,
+} from './DecisionMatrixPatternEntry';
+
+/**
+ * 
+ * @export
+ * @interface DecisionMatrixPattern
+ */
+export interface DecisionMatrixPattern {
+    /**
+     * 
+     * @type {string}
+     * @memberof DecisionMatrixPattern
+     */
+    decision?: DecisionMatrixPatternDecisionEnum;
+    /**
+     * 
+     * @type {Array<DecisionMatrixPatternEntry>}
+     * @memberof DecisionMatrixPattern
+     */
+    entries?: Array<DecisionMatrixPatternEntry>;
+}
+
+
+/**
+ * @export
+ */
+export const DecisionMatrixPatternDecisionEnum = {
+    UNREVIEWED: 'UNREVIEWED',
+    IN_REVIEW: 'IN_REVIEW',
+    DECLINED: 'DECLINED',
+    ACCEPTED: 'ACCEPTED'
+} as const;
+export type DecisionMatrixPatternDecisionEnum = typeof DecisionMatrixPatternDecisionEnum[keyof typeof DecisionMatrixPatternDecisionEnum];
+
+
+/**
+ * Check if a given object implements the DecisionMatrixPattern interface.
+ */
+export function instanceOfDecisionMatrixPattern(value: object): value is DecisionMatrixPattern {
+    return true;
+}
+
+export function DecisionMatrixPatternFromJSON(json: any): DecisionMatrixPattern {
+    return DecisionMatrixPatternFromJSONTyped(json, false);
+}
+
+export function DecisionMatrixPatternFromJSONTyped(json: any, ignoreDiscriminator: boolean): DecisionMatrixPattern {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'decision': json['decision'] == null ? undefined : json['decision'],
+        'entries': json['entries'] == null ? undefined : ((json['entries'] as Array<any>).map(DecisionMatrixPatternEntryFromJSON)),
+    };
+}
+
+export function DecisionMatrixPatternToJSON(json: any): DecisionMatrixPattern {
+    return DecisionMatrixPatternToJSONTyped(json, false);
+}
+
+export function DecisionMatrixPatternToJSONTyped(value?: DecisionMatrixPattern | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'decision': value['decision'],
+        'entries': value['entries'] == null ? undefined : ((value['entries'] as Array<any>).map(DecisionMatrixPatternEntryToJSON)),
+    };
+}
+

package/src/models/DecisionMatrixPatternEntry.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface DecisionMatrixPatternEntry
+ */
+export interface DecisionMatrixPatternEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof DecisionMatrixPatternEntry
+     */
+    decision?: DecisionMatrixPatternEntryDecisionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof DecisionMatrixPatternEntry
+     */
+    count?: number;
+}
+
+
+/**
+ * @export
+ */
+export const DecisionMatrixPatternEntryDecisionEnum = {
+    DECLINED: 'DECLINED',
+    MAYBE: 'MAYBE',
+    ACCEPTED: 'ACCEPTED'
+} as const;
+export type DecisionMatrixPatternEntryDecisionEnum = typeof DecisionMatrixPatternEntryDecisionEnum[keyof typeof DecisionMatrixPatternEntryDecisionEnum];
+
+
+/**
+ * Check if a given object implements the DecisionMatrixPatternEntry interface.
+ */
+export function instanceOfDecisionMatrixPatternEntry(value: object): value is DecisionMatrixPatternEntry {
+    return true;
+}
+
+export function DecisionMatrixPatternEntryFromJSON(json: any): DecisionMatrixPatternEntry {
+    return DecisionMatrixPatternEntryFromJSONTyped(json, false);
+}
+
+export function DecisionMatrixPatternEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): DecisionMatrixPatternEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'decision': json['decision'] == null ? undefined : json['decision'],
+        'count': json['count'] == null ? undefined : json['count'],
+    };
+}
+
+export function DecisionMatrixPatternEntryToJSON(json: any): DecisionMatrixPatternEntry {
+    return DecisionMatrixPatternEntryToJSONTyped(json, false);
+}
+
+export function DecisionMatrixPatternEntryToJSONTyped(value?: DecisionMatrixPatternEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'decision': value['decision'],
+        'count': value['count'],
+    };
+}
+

package/src/models/Project.ts

@@ -0,0 +1,135 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ProjectSettings } from './ProjectSettings';
+import {
+    ProjectSettingsFromJSON,
+    ProjectSettingsFromJSONTyped,
+    ProjectSettingsToJSON,
+    ProjectSettingsToJSONTyped,
+} from './ProjectSettings';
+
+/**
+ * 
+ * @export
+ * @interface Project
+ */
+export interface Project {
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    status?: ProjectStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof Project
+     */
+    currentStage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Project
+     */
+    maxStage?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Project
+     */
+    currentStageStartedAt?: Date;
+    /**
+     * 
+     * @type {ProjectSettings}
+     * @memberof Project
+     */
+    settings?: ProjectSettings;
+}
+
+
+/**
+ * @export
+ */
+export const ProjectStatusEnum = {
+    ACTIVE: 'ACTIVE',
+    ACTIVE_LOCKED: 'ACTIVE_LOCKED',
+    ARCHIVED: 'ARCHIVED',
+    DELETED: 'DELETED',
+    CLEARED: 'CLEARED'
+} as const;
+export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
+
+
+/**
+ * Check if a given object implements the Project interface.
+ */
+export function instanceOfProject(value: object): value is Project {
+    return true;
+}
+
+export function ProjectFromJSON(json: any): Project {
+    return ProjectFromJSONTyped(json, false);
+}
+
+export function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'currentStage': json['currentStage'] == null ? undefined : json['currentStage'],
+        'maxStage': json['maxStage'] == null ? undefined : json['maxStage'],
+        'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
+        'settings': json['settings'] == null ? undefined : ProjectSettingsFromJSON(json['settings']),
+    };
+}
+
+export function ProjectToJSON(json: any): Project {
+    return ProjectToJSONTyped(json, false);
+}
+
+export function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'status': value['status'],
+        'currentStage': value['currentStage'],
+        'maxStage': value['maxStage'],
+        'currentStageStartedAt': value['currentStageStartedAt'] == null ? undefined : ((value['currentStageStartedAt']).toISOString()),
+        'settings': ProjectSettingsToJSON(value['settings']),
+    };
+}
+

package/src/models/ProjectSettings.ts

@@ -0,0 +1,117 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
+import {
+    ReviewDecisionMatrixFromJSON,
+    ReviewDecisionMatrixFromJSONTyped,
+    ReviewDecisionMatrixToJSON,
+    ReviewDecisionMatrixToJSONTyped,
+} from './ReviewDecisionMatrix';
+
+/**
+ * 
+ * @export
+ * @interface ProjectSettings
+ */
+export interface ProjectSettings {
+    /**
+     * 
+     * @type {number}
+     * @memberof ProjectSettings
+     */
+    similarityThreshold?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectSettings
+     */
+    snowballingType?: ProjectSettingsSnowballingTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProjectSettings
+     */
+    reviewMaybeAllowed?: boolean;
+    /**
+     * 
+     * @type {ReviewDecisionMatrix}
+     * @memberof ProjectSettings
+     */
+    reviewDecisionMatrix?: ReviewDecisionMatrix;
+    /**
+     * 
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof ProjectSettings
+     */
+    fetchers?: { [key: string]: { [key: string]: string; }; };
+}
+
+
+/**
+ * @export
+ */
+export const ProjectSettingsSnowballingTypeEnum = {
+    FORWARD: 'FORWARD',
+    BACKWARD: 'BACKWARD',
+    BOTH: 'BOTH'
+} as const;
+export type ProjectSettingsSnowballingTypeEnum = typeof ProjectSettingsSnowballingTypeEnum[keyof typeof ProjectSettingsSnowballingTypeEnum];
+
+
+/**
+ * Check if a given object implements the ProjectSettings interface.
+ */
+export function instanceOfProjectSettings(value: object): value is ProjectSettings {
+    return true;
+}
+
+export function ProjectSettingsFromJSON(json: any): ProjectSettings {
+    return ProjectSettingsFromJSONTyped(json, false);
+}
+
+export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectSettings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
+        'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
+        'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
+        'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : ReviewDecisionMatrixFromJSON(json['reviewDecisionMatrix']),
+        'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
+    };
+}
+
+export function ProjectSettingsToJSON(json: any): ProjectSettings {
+    return ProjectSettingsToJSONTyped(json, false);
+}
+
+export function ProjectSettingsToJSONTyped(value?: ProjectSettings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'similarityThreshold': value['similarityThreshold'],
+        'snowballingType': value['snowballingType'],
+        'reviewMaybeAllowed': value['reviewMaybeAllowed'],
+        'reviewDecisionMatrix': ReviewDecisionMatrixToJSON(value['reviewDecisionMatrix']),
+        'fetchers': value['fetchers'],
+    };
+}
+

package/src/models/ReviewDecisionMatrix.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnowballR API
+ * REST API for the SnowballR Application
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { DecisionMatrixPattern } from './DecisionMatrixPattern';
+import {
+    DecisionMatrixPatternFromJSON,
+    DecisionMatrixPatternFromJSONTyped,
+    DecisionMatrixPatternToJSON,
+    DecisionMatrixPatternToJSONTyped,
+} from './DecisionMatrixPattern';
+
+/**
+ * 
+ * @export
+ * @interface ReviewDecisionMatrix
+ */
+export interface ReviewDecisionMatrix {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReviewDecisionMatrix
+     */
+    numberOfReviewers?: number;
+    /**
+     * 
+     * @type {Array<DecisionMatrixPattern>}
+     * @memberof ReviewDecisionMatrix
+     */
+    patterns?: Array<DecisionMatrixPattern>;
+}
+
+/**
+ * Check if a given object implements the ReviewDecisionMatrix interface.
+ */
+export function instanceOfReviewDecisionMatrix(value: object): value is ReviewDecisionMatrix {
+    return true;
+}
+
+export function ReviewDecisionMatrixFromJSON(json: any): ReviewDecisionMatrix {
+    return ReviewDecisionMatrixFromJSONTyped(json, false);
+}
+
+export function ReviewDecisionMatrixFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewDecisionMatrix {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'numberOfReviewers': json['numberOfReviewers'] == null ? undefined : json['numberOfReviewers'],
+        'patterns': json['patterns'] == null ? undefined : ((json['patterns'] as Array<any>).map(DecisionMatrixPatternFromJSON)),
+    };
+}
+
+export function ReviewDecisionMatrixToJSON(json: any): ReviewDecisionMatrix {
+    return ReviewDecisionMatrixToJSONTyped(json, false);
+}
+
+export function ReviewDecisionMatrixToJSONTyped(value?: ReviewDecisionMatrix | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'numberOfReviewers': value['numberOfReviewers'],
+        'patterns': value['patterns'] == null ? undefined : ((value['patterns'] as Array<any>).map(DecisionMatrixPatternToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -0,0 +1,8 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './CreateProjectRequest';
+export * from './DecisionMatrixPattern';
+export * from './DecisionMatrixPatternEntry';
+export * from './Project';
+export * from './ProjectSettings';
+export * from './ReviewDecisionMatrix';