@se-uulm/snowballr-api-client 0.2.1-alpha.fba5056 → 0.2.1-beta.9bf37cd

package/dist/models/{ProjectResponse.d.ts → Project.d.ts}

@@ -13,67 +13,67 @@ import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
 /**
  *
  * @export
- * @interface ProjectResponse
+ * @interface Project
  */
-export interface ProjectResponse {
+export interface Project {
     /**
      *
      * @type {string}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     id?: string;
     /**
      *
      * @type {string}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     name?: string;
     /**
      *
      * @type {string}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
-    status?: ProjectResponseStatusEnum;
+    status?: ProjectStatusEnum;
     /**
      *
      * @type {number}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     currentStage?: number;
     /**
      *
      * @type {number}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     maxStage?: number;
     /**
      *
      * @type {number}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     similarityThreshold?: number;
     /**
      *
      * @type {string}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
-    snowballingType?: ProjectResponseSnowballingTypeEnum;
+    snowballingType?: ProjectSnowballingTypeEnum;
     /**
      *
      * @type {boolean}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     reviewMaybeAllowed?: boolean;
     /**
      *
      * @type {ReviewDecisionMatrix}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     reviewDecisionMatrix?: ReviewDecisionMatrix;
     /**
      *
      * @type {{ [key: string]: { [key: string]: string; }; }}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     fetchers?: {
         [key: string]: {
@@ -83,35 +83,35 @@ export interface ProjectResponse {
     /**
      *
      * @type {Date}
-     * @memberof ProjectResponse
+     * @memberof Project
      */
     currentStageStartedAt?: Date;
 }
 /**
  * @export
  */
-export declare const ProjectResponseStatusEnum: {
+export declare const ProjectStatusEnum: {
     readonly ACTIVE: "ACTIVE";
     readonly ACTIVE_LOCKED: "ACTIVE_LOCKED";
     readonly ARCHIVED: "ARCHIVED";
     readonly DELETED: "DELETED";
     readonly CLEARED: "CLEARED";
 };
-export type ProjectResponseStatusEnum = typeof ProjectResponseStatusEnum[keyof typeof ProjectResponseStatusEnum];
+export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
 /**
  * @export
  */
-export declare const ProjectResponseSnowballingTypeEnum: {
+export declare const ProjectSnowballingTypeEnum: {
     readonly FORWARD: "FORWARD";
     readonly BACKWARD: "BACKWARD";
     readonly BOTH: "BOTH";
 };
-export type ProjectResponseSnowballingTypeEnum = typeof ProjectResponseSnowballingTypeEnum[keyof typeof ProjectResponseSnowballingTypeEnum];
+export type ProjectSnowballingTypeEnum = typeof ProjectSnowballingTypeEnum[keyof typeof ProjectSnowballingTypeEnum];
 /**
- * Check if a given object implements the ProjectResponse interface.
+ * Check if a given object implements the Project interface.
  */
-export declare function instanceOfProjectResponse(value: object): value is ProjectResponse;
-export declare function ProjectResponseFromJSON(json: any): ProjectResponse;
-export declare function ProjectResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectResponse;
-export declare function ProjectResponseToJSON(json: any): ProjectResponse;
-export declare function ProjectResponseToJSONTyped(value?: ProjectResponse | null, ignoreDiscriminator?: boolean): any;
+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/{ProjectResponse.js → Project.js}

@@ -13,17 +13,17 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectResponseSnowballingTypeEnum = exports.ProjectResponseStatusEnum = void 0;
-exports.instanceOfProjectResponse = instanceOfProjectResponse;
-exports.ProjectResponseFromJSON = ProjectResponseFromJSON;
-exports.ProjectResponseFromJSONTyped = ProjectResponseFromJSONTyped;
-exports.ProjectResponseToJSON = ProjectResponseToJSON;
-exports.ProjectResponseToJSONTyped = ProjectResponseToJSONTyped;
+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.ProjectResponseStatusEnum = {
+exports.ProjectStatusEnum = {
     ACTIVE: 'ACTIVE',
     ACTIVE_LOCKED: 'ACTIVE_LOCKED',
     ARCHIVED: 'ARCHIVED',
@@ -33,21 +33,21 @@ exports.ProjectResponseStatusEnum = {
 /**
  * @export
  */
-exports.ProjectResponseSnowballingTypeEnum = {
+exports.ProjectSnowballingTypeEnum = {
     FORWARD: 'FORWARD',
     BACKWARD: 'BACKWARD',
     BOTH: 'BOTH'
 };
 /**
- * Check if a given object implements the ProjectResponse interface.
+ * Check if a given object implements the Project interface.
  */
-function instanceOfProjectResponse(value) {
+function instanceOfProject(value) {
     return true;
 }
-function ProjectResponseFromJSON(json) {
-    return ProjectResponseFromJSONTyped(json, false);
+function ProjectFromJSON(json) {
+    return ProjectFromJSONTyped(json, false);
 }
-function ProjectResponseFromJSONTyped(json, ignoreDiscriminator) {
+function ProjectFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
@@ -65,10 +65,10 @@ function ProjectResponseFromJSONTyped(json, ignoreDiscriminator) {
         'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
     };
 }
-function ProjectResponseToJSON(json) {
-    return ProjectResponseToJSONTyped(json, false);
+function ProjectToJSON(json) {
+    return ProjectToJSONTyped(json, false);
 }
-function ProjectResponseToJSONTyped(value, ignoreDiscriminator = false) {
+function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }

package/dist/models/index.d.ts

@@ -1,8 +1,5 @@
-export * from './ChangePasswordRequest';
 export * from './CreateProjectRequest';
 export * from './DecisionMatrixPattern';
 export * from './DecisionMatrixPatternEntry';
-export * from './LoginRequest';
-export * from './ProjectResponse';
-export * from './RegisterRequest';
+export * from './Project';
 export * from './ReviewDecisionMatrix';

package/dist/models/index.js

@@ -16,11 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
-__exportStar(require("./ChangePasswordRequest"), exports);
 __exportStar(require("./CreateProjectRequest"), exports);
 __exportStar(require("./DecisionMatrixPattern"), exports);
 __exportStar(require("./DecisionMatrixPatternEntry"), exports);
-__exportStar(require("./LoginRequest"), exports);
-__exportStar(require("./ProjectResponse"), exports);
-__exportStar(require("./RegisterRequest"), exports);
+__exportStar(require("./Project"), exports);
 __exportStar(require("./ReviewDecisionMatrix"), exports);

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@se-uulm/snowballr-api-client",
-  "version": "0.2.1-alpha.fba5056",
-  "description": "API client for the SnowballR Web Application",
-  "author": "SnowballR",
+  "version": "0.2.1-beta.9bf37cd",
+  "description": "OpenAPI client for @se-uulm/snowballr-api-client",
+  "author": "OpenAPI-Generator",
   "repository": {
     "type": "git",
     "url": "https://github.com/SE-UUlm/snowballr-backend.git"
@@ -18,11 +18,5 @@
   },
   "devDependencies": {
     "typescript": "^4.0 || ^5.0"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md"
-  ]
+  }
 }

package/src/apis/ProjectsControllerApi.ts

@@ -0,0 +1,238 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  CreateProjectRequest,
+  Project,
+} from '../models/index';
+import {
+    CreateProjectRequestFromJSON,
+    CreateProjectRequestToJSON,
+    ProjectFromJSON,
+    ProjectToJSON,
+} from '../models/index';
+
+export interface CreateProjectOperationRequest {
+    createProjectRequest: CreateProjectRequest;
+}
+
+export interface DeleteProjectRequest {
+    id: string;
+}
+
+export interface GetProjectRequest {
+    id: string;
+}
+
+/**
+ * ProjectsControllerApi - interface
+ * 
+ * @export
+ * @interface ProjectsControllerApiInterface
+ */
+export interface ProjectsControllerApiInterface {
+    /**
+     * 
+     * @param {CreateProjectRequest} createProjectRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsControllerApiInterface
+     */
+    createProjectRaw(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
+
+    /**
+     */
+    createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
+
+    /**
+     * 
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsControllerApiInterface
+     */
+    deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     */
+    deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsControllerApiInterface
+     */
+    getAllProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>>;
+
+    /**
+     */
+    getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
+
+    /**
+     * 
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsControllerApiInterface
+     */
+    getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
+
+    /**
+     */
+    getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
+
+}
+
+/**
+ * 
+ */
+export class ProjectsControllerApi extends runtime.BaseAPI implements ProjectsControllerApiInterface {
+
+    /**
+     */
+    async createProjectRaw(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>> {
+        if (requestParameters['createProjectRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createProjectRequest',
+                'Required parameter "createProjectRequest" was null or undefined when calling createProject().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/projects`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateProjectRequestToJSON(requestParameters['createProjectRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project> {
+        const response = await this.createProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     */
+    async deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteProject().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/projects/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     */
+    async deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteProjectRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     */
+    async getAllProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Project>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/projects`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ProjectFromJSON));
+    }
+
+    /**
+     */
+    async getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>> {
+        const response = await this.getAllProjectsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     */
+    async getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getProject().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/projects/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async getProject(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project> {
+        const response = await this.getProjectRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ProjectsControllerApi';

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)),
+    };
+}
+