@se-uulm/snowballr-api-client 0.1.1-alpha.0f85732

package/dist/models/Project.d.ts

@@ -0,0 +1,117 @@
+/**
+ * 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 type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
+/**
+ *
+ * @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 {number}
+     * @memberof Project
+     */
+    similarityThreshold?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    snowballingType?: ProjectSnowballingTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    reviewMaybeAllowed?: boolean;
+    /**
+     *
+     * @type {ReviewDecisionMatrix}
+     * @memberof Project
+     */
+    reviewDecisionMatrix?: ReviewDecisionMatrix;
+    /**
+     *
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof Project
+     */
+    fetchers?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+    /**
+     *
+     * @type {Date}
+     * @memberof Project
+     */
+    currentStageStartedAt?: Date;
+}
+/**
+ * @export
+ */
+export declare const ProjectStatusEnum: {
+    readonly ACTIVE: "ACTIVE";
+    readonly ACTIVE_LOCKED: "ACTIVE_LOCKED";
+    readonly ARCHIVED: "ARCHIVED";
+    readonly DELETED: "DELETED";
+    readonly CLEARED: "CLEARED";
+};
+export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
+/**
+ * @export
+ */
+export declare const ProjectSnowballingTypeEnum: {
+    readonly FORWARD: "FORWARD";
+    readonly BACKWARD: "BACKWARD";
+    readonly BOTH: "BOTH";
+};
+export type ProjectSnowballingTypeEnum = typeof ProjectSnowballingTypeEnum[keyof typeof ProjectSnowballingTypeEnum];
+/**
+ * Check if a given object implements the Project interface.
+ */
+export declare function instanceOfProject(value: object): value is Project;
+export declare function ProjectFromJSON(json: any): Project;
+export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
+export declare function ProjectToJSON(json: any): Project;
+export declare function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Project.js

@@ -0,0 +1,88 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectSnowballingTypeEnum = exports.ProjectStatusEnum = void 0;
+exports.instanceOfProject = instanceOfProject;
+exports.ProjectFromJSON = ProjectFromJSON;
+exports.ProjectFromJSONTyped = ProjectFromJSONTyped;
+exports.ProjectToJSON = ProjectToJSON;
+exports.ProjectToJSONTyped = ProjectToJSONTyped;
+const ReviewDecisionMatrix_1 = require("./ReviewDecisionMatrix");
+/**
+ * @export
+ */
+exports.ProjectStatusEnum = {
+    ACTIVE: 'ACTIVE',
+    ACTIVE_LOCKED: 'ACTIVE_LOCKED',
+    ARCHIVED: 'ARCHIVED',
+    DELETED: 'DELETED',
+    CLEARED: 'CLEARED'
+};
+/**
+ * @export
+ */
+exports.ProjectSnowballingTypeEnum = {
+    FORWARD: 'FORWARD',
+    BACKWARD: 'BACKWARD',
+    BOTH: 'BOTH'
+};
+/**
+ * Check if a given object implements the Project interface.
+ */
+function instanceOfProject(value) {
+    return true;
+}
+function ProjectFromJSON(json) {
+    return ProjectFromJSONTyped(json, false);
+}
+function ProjectFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+        '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 : (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixFromJSON)(json['reviewDecisionMatrix']),
+        'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
+        'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
+    };
+}
+function ProjectToJSON(json) {
+    return ProjectToJSONTyped(json, false);
+}
+function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'status': value['status'],
+        'currentStage': value['currentStage'],
+        'maxStage': value['maxStage'],
+        'similarityThreshold': value['similarityThreshold'],
+        'snowballingType': value['snowballingType'],
+        'reviewMaybeAllowed': value['reviewMaybeAllowed'],
+        'reviewDecisionMatrix': (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixToJSON)(value['reviewDecisionMatrix']),
+        'fetchers': value['fetchers'],
+        'currentStageStartedAt': value['currentStageStartedAt'] == null ? undefined : ((value['currentStageStartedAt']).toISOString()),
+    };
+}

package/dist/models/ReviewDecisionMatrix.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 type { DecisionMatrixPattern } 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 declare function instanceOfReviewDecisionMatrix(value: object): value is ReviewDecisionMatrix;
+export declare function ReviewDecisionMatrixFromJSON(json: any): ReviewDecisionMatrix;
+export declare function ReviewDecisionMatrixFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReviewDecisionMatrix;
+export declare function ReviewDecisionMatrixToJSON(json: any): ReviewDecisionMatrix;
+export declare function ReviewDecisionMatrixToJSONTyped(value?: ReviewDecisionMatrix | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReviewDecisionMatrix.js

@@ -0,0 +1,51 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReviewDecisionMatrix = instanceOfReviewDecisionMatrix;
+exports.ReviewDecisionMatrixFromJSON = ReviewDecisionMatrixFromJSON;
+exports.ReviewDecisionMatrixFromJSONTyped = ReviewDecisionMatrixFromJSONTyped;
+exports.ReviewDecisionMatrixToJSON = ReviewDecisionMatrixToJSON;
+exports.ReviewDecisionMatrixToJSONTyped = ReviewDecisionMatrixToJSONTyped;
+const DecisionMatrixPattern_1 = require("./DecisionMatrixPattern");
+/**
+ * Check if a given object implements the ReviewDecisionMatrix interface.
+ */
+function instanceOfReviewDecisionMatrix(value) {
+    return true;
+}
+function ReviewDecisionMatrixFromJSON(json) {
+    return ReviewDecisionMatrixFromJSONTyped(json, false);
+}
+function ReviewDecisionMatrixFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'numberOfReviewers': json['numberOfReviewers'] == null ? undefined : json['numberOfReviewers'],
+        'patterns': json['patterns'] == null ? undefined : (json['patterns'].map(DecisionMatrixPattern_1.DecisionMatrixPatternFromJSON)),
+    };
+}
+function ReviewDecisionMatrixToJSON(json) {
+    return ReviewDecisionMatrixToJSONTyped(json, false);
+}
+function ReviewDecisionMatrixToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'numberOfReviewers': value['numberOfReviewers'],
+        'patterns': value['patterns'] == null ? undefined : (value['patterns'].map(DecisionMatrixPattern_1.DecisionMatrixPatternToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -0,0 +1,5 @@
+export * from './CreateProjectRequest';
+export * from './DecisionMatrixPattern';
+export * from './DecisionMatrixPatternEntry';
+export * from './Project';
+export * from './ReviewDecisionMatrix';

package/dist/models/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./CreateProjectRequest"), exports);
+__exportStar(require("./DecisionMatrixPattern"), exports);
+__exportStar(require("./DecisionMatrixPatternEntry"), exports);
+__exportStar(require("./Project"), exports);
+__exportStar(require("./ReviewDecisionMatrix"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}