@se-uulm/snowballr-api-client 0.1.1-beta.d4b7986 → 0.2.1-alpha.07cd30f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,6 +10,7 @@ src/models/CreateProjectRequest.ts
10
10
  src/models/DecisionMatrixPattern.ts
11
11
  src/models/DecisionMatrixPatternEntry.ts
12
12
  src/models/Project.ts
13
+ src/models/ProjectSettings.ts
13
14
  src/models/ReviewDecisionMatrix.ts
14
15
  src/models/index.ts
15
16
  src/runtime.ts
package/CHANGELOG.md CHANGED
@@ -1,9 +1,58 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.2.0] - 2026-08-16
4
+
5
+ This version uses API version [v0.16.0](https://github.com/SE-UUlm/snowballr-api/releases/tag/v0.16.0).
6
+
7
+ ### Changed
8
+
9
+ - Change external ID format from a string to a list of type-value pairs ([#514](https://github.com/SE-UUlm/snowballr-backend/issues/514)) (Felix Schlegel)
10
+
11
+ ### Added
12
+
13
+ - Add paper comparison and merging functionality ([#499](https://github.com/SE-UUlm/snowballr-backend/issues/499)) (Felix Schlegel)
14
+ - Start REST migration
15
+ - add initial endpoints ([#573](https://github.com/SE-UUlm/snowballr-backend/issues/573)) (Felix Schlegel)
16
+ - publish TS client on npm as `@se-uulm/snowballr-api-client` ([#581](https://github.com/SE-UUlm/snowballr-backend/issues/581)) (Felix Schlegel)
17
+ - Add implementation of `SearchLocalProjectPaperCandidates` call ([#504](https://github.com/SE-UUlm/snowballr-backend/issues/504)) (Felix Schlegel)
18
+ - Add implementation of `SearchFetcherProjectPaperCandidates` call ([#440](https://github.com/SE-UUlm/snowballr-backend/issues/440)) (Felix Schlegel)
19
+ - Add fetcher orchestrator ([#493](https://github.com/SE-UUlm/snowballr-backend/issues/493), [#441](https://github.com/SE-UUlm/snowballr-backend/issues/441)) (Felix Schlegel)
20
+ - Add implementation of `ChangePassword` call ([#93](https://github.com/SE-UUlm/snowballr-backend/issues/93)) (Moritz Wieland)
21
+ - Add fetcher plugin system ([#123](https://github.com/SE-UUlm/snowballr-backend/issues/123), [#152](https://github.com/SE-UUlm/snowballr-backend/issues/152), [#154](https://github.com/SE-UUlm/snowballr-backend/issues/154), [#155](https://github.com/SE-UUlm/snowballr-backend/issues/155), [#468](https://github.com/SE-UUlm/snowballr-backend/issues/468), [#451](https://github.com/SE-UUlm/snowballr-backend/issues/451), [#437](https://github.com/SE-UUlm/snowballr-backend/issues/437), [#497](https://github.com/SE-UUlm/snowballr-backend/issues/497), [#529](https://github.com/SE-UUlm/snowballr-backend/issues/529)) (Luca Schlecker, Moritz Wieland, Felix Schlegel)
22
+ - IEEE Xplore fetcher ([#152](https://github.com/SE-UUlm/snowballr-backend/issues/152)) (Luca Schlecker)
23
+ - Semantic Scholar fetcher ([#513](https://github.com/SE-UUlm/snowballr-backend/issues/513)) (Felix Schlegel)
24
+ - Enable update of number of reviewers and decision matrix in project settings (`UpdateProject`) ([#433](https://github.com/SE-UUlm/snowballr-backend/issues/433)) (Felix Schlegel)
25
+ - Add more details to project invitation and account verification emails ([#364](https://github.com/SE-UUlm/snowballr-backend/issues/364)) (Felix Schlegel)
26
+ - project invitation: inviter name, project name, and invitation expiration time
27
+ - account verification: verification expiration time
28
+ - Make token lifetimes configurable via `INVITATION_TOKEN_LIFETIME_IN_DAYS` and `VERIFICATION_TOKEN_LIFETIME_IN_DAYS` ([#364](https://github.com/SE-UUlm/snowballr-backend/issues/364)) (Felix Schlegel)
29
+ - Determine the final paper decision based on the decision matrix (`CreateReview`) ([#345](https://github.com/SE-UUlm/snowballr-backend/issues/345)) (Leonhard Alkewitz)
30
+ - Add project export functionality via `GetAvailableExportFormats` and `ExportProject` ([#363](https://github.com/SE-UUlm/snowballr-backend/issues/363), [#187](https://github.com/SE-UUlm/snowballr-backend/issues/187)) (Felix Schlegel)
31
+ - Add Cron jobs ([#317](https://github.com/SE-UUlm/snowballr-backend/issues/317)) (Moritz Wieland)
32
+ - every day at 12:00 AM
33
+ - remove expired verification or invitation tokens
34
+ - clear information of soft-deleted users and projects after X days (configured by `SENSITIVE_INFORMATION_RETENTION_DAYS`)
35
+ - first day of every month at 12:00 AM
36
+ - remove soft-deleted users and projects that have been cleared
37
+
38
+ ### Fixed
39
+
40
+ - Set project status to `ACTIVE_LOCKED` after first review (`CreateReview`) ([#525](https://github.com/SE-UUlm/snowballr-backend/issues/525)) (Felix Schlegel)
41
+ - Fix privilege escalation via field-mask key mismatch (`UpdateUser`) ([#527](https://github.com/SE-UUlm/snowballr-backend/issues/527)) (Moritz Wieland)
42
+ - Return `FORBIDDEN` status when deleted project is requested by non-admin user (`GetProjectById`) ([#420](https://github.com/SE-UUlm/snowballr-backend/issues/420)) (Felix Schlegel)
43
+ - Enable update of project fetcher settings (`UpdateProject`) ([#421](https://github.com/SE-UUlm/snowballr-backend/issues/421)) (Felix Schlegel)
44
+ - Delete invitations when the related project is deleted (`SoftDeleteProject`) ([#391](https://github.com/SE-UUlm/snowballr-backend/issues/391)) (Felix Schlegel)
45
+ - Enable removal of registered non-member users (`RemoveProjectMember`) ([#417](https://github.com/SE-UUlm/snowballr-backend/issues/417)) (Felix Schlegel)
46
+ - Ignore invitations for already existent project members (`InviteUserToProject`) ([#408](https://github.com/SE-UUlm/snowballr-backend/issues/408)) (Felix Schlegel)
47
+ - Enable removal of pending invitations for not registered users (`RemoveProjectMember`) ([#361](https://github.com/SE-UUlm/snowballr-backend/issues/361)) (Felix Schlegel)
48
+ - Remove already invited users from invite candidates (`GetInviteCandidates`) ([#357](https://github.com/SE-UUlm/snowballr-backend/issues/357)) (Leonhard Alkewitz)
49
+
3
50
  ## [0.1.0] - 2025-10-31
4
51
 
5
52
  _:seedling: Initial release._
6
53
 
7
54
  This version uses API version [v0.9.0](https://github.com/SE-UUlm/snowballr-api/releases/tag/v0.9.0).
8
55
 
56
+ [0.2.0]: https://github.com/SE-UUlm/snowballr-backend/releases/tag/v0.2.0
57
+
9
58
  [0.1.0]: https://github.com/SE-UUlm/snowballr-backend/releases/tag/v0.1.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @se-uulm/snowballr-api-client@0.1.1-beta.d4b7986
1
+ ## @se-uulm/snowballr-api-client@0.2.1-alpha.07cd30f
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @se-uulm/snowballr-api-client@0.1.1-beta.d4b7986 --save
39
+ npm install @se-uulm/snowballr-api-client@0.2.1-alpha.07cd30f --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
12
+ import type { ProjectSettings } from './ProjectSettings';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -48,44 +48,16 @@ export interface Project {
48
48
  maxStage?: number;
49
49
  /**
50
50
  *
51
- * @type {number}
52
- * @memberof Project
53
- */
54
- similarityThreshold?: number;
55
- /**
56
- *
57
- * @type {string}
58
- * @memberof Project
59
- */
60
- snowballingType?: ProjectSnowballingTypeEnum;
61
- /**
62
- *
63
- * @type {boolean}
64
- * @memberof Project
65
- */
66
- reviewMaybeAllowed?: boolean;
67
- /**
68
- *
69
- * @type {ReviewDecisionMatrix}
51
+ * @type {Date}
70
52
  * @memberof Project
71
53
  */
72
- reviewDecisionMatrix?: ReviewDecisionMatrix;
54
+ currentStageStartedAt?: Date;
73
55
  /**
74
56
  *
75
- * @type {{ [key: string]: { [key: string]: string; }; }}
57
+ * @type {ProjectSettings}
76
58
  * @memberof Project
77
59
  */
78
- fetchers?: {
79
- [key: string]: {
80
- [key: string]: string;
81
- };
82
- };
83
- /**
84
- *
85
- * @type {Date}
86
- * @memberof Project
87
- */
88
- currentStageStartedAt?: Date;
60
+ settings?: ProjectSettings;
89
61
  }
90
62
  /**
91
63
  * @export
@@ -98,15 +70,6 @@ export declare const ProjectStatusEnum: {
98
70
  readonly CLEARED: "CLEARED";
99
71
  };
100
72
  export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
101
- /**
102
- * @export
103
- */
104
- export declare const ProjectSnowballingTypeEnum: {
105
- readonly FORWARD: "FORWARD";
106
- readonly BACKWARD: "BACKWARD";
107
- readonly BOTH: "BOTH";
108
- };
109
- export type ProjectSnowballingTypeEnum = typeof ProjectSnowballingTypeEnum[keyof typeof ProjectSnowballingTypeEnum];
110
73
  /**
111
74
  * Check if a given object implements the Project interface.
112
75
  */
@@ -11,7 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { ReviewDecisionMatrixFromJSON, ReviewDecisionMatrixToJSON, } from './ReviewDecisionMatrix';
14
+ import { ProjectSettingsFromJSON, ProjectSettingsToJSON, } from './ProjectSettings';
15
15
  /**
16
16
  * @export
17
17
  */
@@ -22,14 +22,6 @@ export const ProjectStatusEnum = {
22
22
  DELETED: 'DELETED',
23
23
  CLEARED: 'CLEARED'
24
24
  };
25
- /**
26
- * @export
27
- */
28
- export const ProjectSnowballingTypeEnum = {
29
- FORWARD: 'FORWARD',
30
- BACKWARD: 'BACKWARD',
31
- BOTH: 'BOTH'
32
- };
33
25
  /**
34
26
  * Check if a given object implements the Project interface.
35
27
  */
@@ -49,12 +41,8 @@ export function ProjectFromJSONTyped(json, ignoreDiscriminator) {
49
41
  'status': json['status'] == null ? undefined : json['status'],
50
42
  'currentStage': json['currentStage'] == null ? undefined : json['currentStage'],
51
43
  'maxStage': json['maxStage'] == null ? undefined : json['maxStage'],
52
- 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
53
- 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
54
- 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
55
- 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : ReviewDecisionMatrixFromJSON(json['reviewDecisionMatrix']),
56
- 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
57
44
  'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
45
+ 'settings': json['settings'] == null ? undefined : ProjectSettingsFromJSON(json['settings']),
58
46
  };
59
47
  }
60
48
  export function ProjectToJSON(json) {
@@ -70,11 +58,7 @@ export function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
70
58
  'status': value['status'],
71
59
  'currentStage': value['currentStage'],
72
60
  'maxStage': value['maxStage'],
73
- 'similarityThreshold': value['similarityThreshold'],
74
- 'snowballingType': value['snowballingType'],
75
- 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
76
- 'reviewDecisionMatrix': ReviewDecisionMatrixToJSON(value['reviewDecisionMatrix']),
77
- 'fetchers': value['fetchers'],
78
61
  'currentStageStartedAt': value['currentStageStartedAt'] == null ? undefined : ((value['currentStageStartedAt']).toISOString()),
62
+ 'settings': ProjectSettingsToJSON(value['settings']),
79
63
  };
80
64
  }
@@ -0,0 +1,70 @@
1
+ /**
2
+ * SnowballR API
3
+ * REST API for the SnowballR Application
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ProjectSettings
17
+ */
18
+ export interface ProjectSettings {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof ProjectSettings
23
+ */
24
+ similarityThreshold?: number;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ProjectSettings
29
+ */
30
+ snowballingType?: ProjectSettingsSnowballingTypeEnum;
31
+ /**
32
+ *
33
+ * @type {boolean}
34
+ * @memberof ProjectSettings
35
+ */
36
+ reviewMaybeAllowed?: boolean;
37
+ /**
38
+ *
39
+ * @type {ReviewDecisionMatrix}
40
+ * @memberof ProjectSettings
41
+ */
42
+ reviewDecisionMatrix?: ReviewDecisionMatrix;
43
+ /**
44
+ *
45
+ * @type {{ [key: string]: { [key: string]: string; }; }}
46
+ * @memberof ProjectSettings
47
+ */
48
+ fetchers?: {
49
+ [key: string]: {
50
+ [key: string]: string;
51
+ };
52
+ };
53
+ }
54
+ /**
55
+ * @export
56
+ */
57
+ export declare const ProjectSettingsSnowballingTypeEnum: {
58
+ readonly FORWARD: "FORWARD";
59
+ readonly BACKWARD: "BACKWARD";
60
+ readonly BOTH: "BOTH";
61
+ };
62
+ export type ProjectSettingsSnowballingTypeEnum = typeof ProjectSettingsSnowballingTypeEnum[keyof typeof ProjectSettingsSnowballingTypeEnum];
63
+ /**
64
+ * Check if a given object implements the ProjectSettings interface.
65
+ */
66
+ export declare function instanceOfProjectSettings(value: object): value is ProjectSettings;
67
+ export declare function ProjectSettingsFromJSON(json: any): ProjectSettings;
68
+ export declare function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectSettings;
69
+ export declare function ProjectSettingsToJSON(json: any): ProjectSettings;
70
+ export declare function ProjectSettingsToJSONTyped(value?: ProjectSettings | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * SnowballR API
5
+ * REST API for the SnowballR Application
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ReviewDecisionMatrixFromJSON, ReviewDecisionMatrixToJSON, } from './ReviewDecisionMatrix';
15
+ /**
16
+ * @export
17
+ */
18
+ export const ProjectSettingsSnowballingTypeEnum = {
19
+ FORWARD: 'FORWARD',
20
+ BACKWARD: 'BACKWARD',
21
+ BOTH: 'BOTH'
22
+ };
23
+ /**
24
+ * Check if a given object implements the ProjectSettings interface.
25
+ */
26
+ export function instanceOfProjectSettings(value) {
27
+ return true;
28
+ }
29
+ export function ProjectSettingsFromJSON(json) {
30
+ return ProjectSettingsFromJSONTyped(json, false);
31
+ }
32
+ export function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
38
+ 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
39
+ 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
40
+ 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : ReviewDecisionMatrixFromJSON(json['reviewDecisionMatrix']),
41
+ 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
42
+ };
43
+ }
44
+ export function ProjectSettingsToJSON(json) {
45
+ return ProjectSettingsToJSONTyped(json, false);
46
+ }
47
+ export function ProjectSettingsToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'similarityThreshold': value['similarityThreshold'],
53
+ 'snowballingType': value['snowballingType'],
54
+ 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
55
+ 'reviewDecisionMatrix': ReviewDecisionMatrixToJSON(value['reviewDecisionMatrix']),
56
+ 'fetchers': value['fetchers'],
57
+ };
58
+ }
@@ -2,4 +2,5 @@ export * from './CreateProjectRequest';
2
2
  export * from './DecisionMatrixPattern';
3
3
  export * from './DecisionMatrixPatternEntry';
4
4
  export * from './Project';
5
+ export * from './ProjectSettings';
5
6
  export * from './ReviewDecisionMatrix';
@@ -4,4 +4,5 @@ export * from './CreateProjectRequest';
4
4
  export * from './DecisionMatrixPattern';
5
5
  export * from './DecisionMatrixPatternEntry';
6
6
  export * from './Project';
7
+ export * from './ProjectSettings';
7
8
  export * from './ReviewDecisionMatrix';
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
12
+ import type { ProjectSettings } from './ProjectSettings';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -48,44 +48,16 @@ export interface Project {
48
48
  maxStage?: number;
49
49
  /**
50
50
  *
51
- * @type {number}
52
- * @memberof Project
53
- */
54
- similarityThreshold?: number;
55
- /**
56
- *
57
- * @type {string}
58
- * @memberof Project
59
- */
60
- snowballingType?: ProjectSnowballingTypeEnum;
61
- /**
62
- *
63
- * @type {boolean}
64
- * @memberof Project
65
- */
66
- reviewMaybeAllowed?: boolean;
67
- /**
68
- *
69
- * @type {ReviewDecisionMatrix}
51
+ * @type {Date}
70
52
  * @memberof Project
71
53
  */
72
- reviewDecisionMatrix?: ReviewDecisionMatrix;
54
+ currentStageStartedAt?: Date;
73
55
  /**
74
56
  *
75
- * @type {{ [key: string]: { [key: string]: string; }; }}
57
+ * @type {ProjectSettings}
76
58
  * @memberof Project
77
59
  */
78
- fetchers?: {
79
- [key: string]: {
80
- [key: string]: string;
81
- };
82
- };
83
- /**
84
- *
85
- * @type {Date}
86
- * @memberof Project
87
- */
88
- currentStageStartedAt?: Date;
60
+ settings?: ProjectSettings;
89
61
  }
90
62
  /**
91
63
  * @export
@@ -98,15 +70,6 @@ export declare const ProjectStatusEnum: {
98
70
  readonly CLEARED: "CLEARED";
99
71
  };
100
72
  export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
101
- /**
102
- * @export
103
- */
104
- export declare const ProjectSnowballingTypeEnum: {
105
- readonly FORWARD: "FORWARD";
106
- readonly BACKWARD: "BACKWARD";
107
- readonly BOTH: "BOTH";
108
- };
109
- export type ProjectSnowballingTypeEnum = typeof ProjectSnowballingTypeEnum[keyof typeof ProjectSnowballingTypeEnum];
110
73
  /**
111
74
  * Check if a given object implements the Project interface.
112
75
  */
@@ -13,13 +13,13 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ProjectSnowballingTypeEnum = exports.ProjectStatusEnum = void 0;
16
+ exports.ProjectStatusEnum = void 0;
17
17
  exports.instanceOfProject = instanceOfProject;
18
18
  exports.ProjectFromJSON = ProjectFromJSON;
19
19
  exports.ProjectFromJSONTyped = ProjectFromJSONTyped;
20
20
  exports.ProjectToJSON = ProjectToJSON;
21
21
  exports.ProjectToJSONTyped = ProjectToJSONTyped;
22
- const ReviewDecisionMatrix_1 = require("./ReviewDecisionMatrix");
22
+ const ProjectSettings_1 = require("./ProjectSettings");
23
23
  /**
24
24
  * @export
25
25
  */
@@ -30,14 +30,6 @@ exports.ProjectStatusEnum = {
30
30
  DELETED: 'DELETED',
31
31
  CLEARED: 'CLEARED'
32
32
  };
33
- /**
34
- * @export
35
- */
36
- exports.ProjectSnowballingTypeEnum = {
37
- FORWARD: 'FORWARD',
38
- BACKWARD: 'BACKWARD',
39
- BOTH: 'BOTH'
40
- };
41
33
  /**
42
34
  * Check if a given object implements the Project interface.
43
35
  */
@@ -57,12 +49,8 @@ function ProjectFromJSONTyped(json, ignoreDiscriminator) {
57
49
  'status': json['status'] == null ? undefined : json['status'],
58
50
  'currentStage': json['currentStage'] == null ? undefined : json['currentStage'],
59
51
  'maxStage': json['maxStage'] == null ? undefined : json['maxStage'],
60
- 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
61
- 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
62
- 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
63
- 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixFromJSON)(json['reviewDecisionMatrix']),
64
- 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
65
52
  'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
53
+ 'settings': json['settings'] == null ? undefined : (0, ProjectSettings_1.ProjectSettingsFromJSON)(json['settings']),
66
54
  };
67
55
  }
68
56
  function ProjectToJSON(json) {
@@ -78,11 +66,7 @@ function ProjectToJSONTyped(value, ignoreDiscriminator = false) {
78
66
  'status': value['status'],
79
67
  'currentStage': value['currentStage'],
80
68
  'maxStage': value['maxStage'],
81
- 'similarityThreshold': value['similarityThreshold'],
82
- 'snowballingType': value['snowballingType'],
83
- 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
84
- 'reviewDecisionMatrix': (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixToJSON)(value['reviewDecisionMatrix']),
85
- 'fetchers': value['fetchers'],
86
69
  'currentStageStartedAt': value['currentStageStartedAt'] == null ? undefined : ((value['currentStageStartedAt']).toISOString()),
70
+ 'settings': (0, ProjectSettings_1.ProjectSettingsToJSON)(value['settings']),
87
71
  };
88
72
  }
@@ -0,0 +1,70 @@
1
+ /**
2
+ * SnowballR API
3
+ * REST API for the SnowballR Application
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ProjectSettings
17
+ */
18
+ export interface ProjectSettings {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof ProjectSettings
23
+ */
24
+ similarityThreshold?: number;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ProjectSettings
29
+ */
30
+ snowballingType?: ProjectSettingsSnowballingTypeEnum;
31
+ /**
32
+ *
33
+ * @type {boolean}
34
+ * @memberof ProjectSettings
35
+ */
36
+ reviewMaybeAllowed?: boolean;
37
+ /**
38
+ *
39
+ * @type {ReviewDecisionMatrix}
40
+ * @memberof ProjectSettings
41
+ */
42
+ reviewDecisionMatrix?: ReviewDecisionMatrix;
43
+ /**
44
+ *
45
+ * @type {{ [key: string]: { [key: string]: string; }; }}
46
+ * @memberof ProjectSettings
47
+ */
48
+ fetchers?: {
49
+ [key: string]: {
50
+ [key: string]: string;
51
+ };
52
+ };
53
+ }
54
+ /**
55
+ * @export
56
+ */
57
+ export declare const ProjectSettingsSnowballingTypeEnum: {
58
+ readonly FORWARD: "FORWARD";
59
+ readonly BACKWARD: "BACKWARD";
60
+ readonly BOTH: "BOTH";
61
+ };
62
+ export type ProjectSettingsSnowballingTypeEnum = typeof ProjectSettingsSnowballingTypeEnum[keyof typeof ProjectSettingsSnowballingTypeEnum];
63
+ /**
64
+ * Check if a given object implements the ProjectSettings interface.
65
+ */
66
+ export declare function instanceOfProjectSettings(value: object): value is ProjectSettings;
67
+ export declare function ProjectSettingsFromJSON(json: any): ProjectSettings;
68
+ export declare function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectSettings;
69
+ export declare function ProjectSettingsToJSON(json: any): ProjectSettings;
70
+ export declare function ProjectSettingsToJSONTyped(value?: ProjectSettings | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * SnowballR API
6
+ * REST API for the SnowballR Application
7
+ *
8
+ * The version of the OpenAPI document: v1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ProjectSettingsSnowballingTypeEnum = void 0;
17
+ exports.instanceOfProjectSettings = instanceOfProjectSettings;
18
+ exports.ProjectSettingsFromJSON = ProjectSettingsFromJSON;
19
+ exports.ProjectSettingsFromJSONTyped = ProjectSettingsFromJSONTyped;
20
+ exports.ProjectSettingsToJSON = ProjectSettingsToJSON;
21
+ exports.ProjectSettingsToJSONTyped = ProjectSettingsToJSONTyped;
22
+ const ReviewDecisionMatrix_1 = require("./ReviewDecisionMatrix");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.ProjectSettingsSnowballingTypeEnum = {
27
+ FORWARD: 'FORWARD',
28
+ BACKWARD: 'BACKWARD',
29
+ BOTH: 'BOTH'
30
+ };
31
+ /**
32
+ * Check if a given object implements the ProjectSettings interface.
33
+ */
34
+ function instanceOfProjectSettings(value) {
35
+ return true;
36
+ }
37
+ function ProjectSettingsFromJSON(json) {
38
+ return ProjectSettingsFromJSONTyped(json, false);
39
+ }
40
+ function ProjectSettingsFromJSONTyped(json, ignoreDiscriminator) {
41
+ if (json == null) {
42
+ return json;
43
+ }
44
+ return {
45
+ 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
46
+ 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
47
+ 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
48
+ 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixFromJSON)(json['reviewDecisionMatrix']),
49
+ 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
50
+ };
51
+ }
52
+ function ProjectSettingsToJSON(json) {
53
+ return ProjectSettingsToJSONTyped(json, false);
54
+ }
55
+ function ProjectSettingsToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ 'similarityThreshold': value['similarityThreshold'],
61
+ 'snowballingType': value['snowballingType'],
62
+ 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
63
+ 'reviewDecisionMatrix': (0, ReviewDecisionMatrix_1.ReviewDecisionMatrixToJSON)(value['reviewDecisionMatrix']),
64
+ 'fetchers': value['fetchers'],
65
+ };
66
+ }
@@ -2,4 +2,5 @@ export * from './CreateProjectRequest';
2
2
  export * from './DecisionMatrixPattern';
3
3
  export * from './DecisionMatrixPatternEntry';
4
4
  export * from './Project';
5
+ export * from './ProjectSettings';
5
6
  export * from './ReviewDecisionMatrix';
@@ -20,4 +20,5 @@ __exportStar(require("./CreateProjectRequest"), exports);
20
20
  __exportStar(require("./DecisionMatrixPattern"), exports);
21
21
  __exportStar(require("./DecisionMatrixPatternEntry"), exports);
22
22
  __exportStar(require("./Project"), exports);
23
+ __exportStar(require("./ProjectSettings"), exports);
23
24
  __exportStar(require("./ReviewDecisionMatrix"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@se-uulm/snowballr-api-client",
3
- "version": "0.1.1-beta.d4b7986",
3
+ "version": "0.2.1-alpha.07cd30f",
4
4
  "description": "OpenAPI client for @se-uulm/snowballr-api-client",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -13,13 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
16
+ import type { ProjectSettings } from './ProjectSettings';
17
17
  import {
18
- ReviewDecisionMatrixFromJSON,
19
- ReviewDecisionMatrixFromJSONTyped,
20
- ReviewDecisionMatrixToJSON,
21
- ReviewDecisionMatrixToJSONTyped,
22
- } from './ReviewDecisionMatrix';
18
+ ProjectSettingsFromJSON,
19
+ ProjectSettingsFromJSONTyped,
20
+ ProjectSettingsToJSON,
21
+ ProjectSettingsToJSONTyped,
22
+ } from './ProjectSettings';
23
23
 
24
24
  /**
25
25
  *
@@ -59,40 +59,16 @@ export interface Project {
59
59
  maxStage?: number;
60
60
  /**
61
61
  *
62
- * @type {number}
63
- * @memberof Project
64
- */
65
- similarityThreshold?: number;
66
- /**
67
- *
68
- * @type {string}
69
- * @memberof Project
70
- */
71
- snowballingType?: ProjectSnowballingTypeEnum;
72
- /**
73
- *
74
- * @type {boolean}
75
- * @memberof Project
76
- */
77
- reviewMaybeAllowed?: boolean;
78
- /**
79
- *
80
- * @type {ReviewDecisionMatrix}
81
- * @memberof Project
82
- */
83
- reviewDecisionMatrix?: ReviewDecisionMatrix;
84
- /**
85
- *
86
- * @type {{ [key: string]: { [key: string]: string; }; }}
62
+ * @type {Date}
87
63
  * @memberof Project
88
64
  */
89
- fetchers?: { [key: string]: { [key: string]: string; }; };
65
+ currentStageStartedAt?: Date;
90
66
  /**
91
67
  *
92
- * @type {Date}
68
+ * @type {ProjectSettings}
93
69
  * @memberof Project
94
70
  */
95
- currentStageStartedAt?: Date;
71
+ settings?: ProjectSettings;
96
72
  }
97
73
 
98
74
 
@@ -108,16 +84,6 @@ export const ProjectStatusEnum = {
108
84
  } as const;
109
85
  export type ProjectStatusEnum = typeof ProjectStatusEnum[keyof typeof ProjectStatusEnum];
110
86
 
111
- /**
112
- * @export
113
- */
114
- export const ProjectSnowballingTypeEnum = {
115
- FORWARD: 'FORWARD',
116
- BACKWARD: 'BACKWARD',
117
- BOTH: 'BOTH'
118
- } as const;
119
- export type ProjectSnowballingTypeEnum = typeof ProjectSnowballingTypeEnum[keyof typeof ProjectSnowballingTypeEnum];
120
-
121
87
 
122
88
  /**
123
89
  * Check if a given object implements the Project interface.
@@ -141,12 +107,8 @@ export function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
141
107
  'status': json['status'] == null ? undefined : json['status'],
142
108
  'currentStage': json['currentStage'] == null ? undefined : json['currentStage'],
143
109
  'maxStage': json['maxStage'] == null ? undefined : json['maxStage'],
144
- 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
145
- 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
146
- 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
147
- 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : ReviewDecisionMatrixFromJSON(json['reviewDecisionMatrix']),
148
- 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
149
110
  'currentStageStartedAt': json['currentStageStartedAt'] == null ? undefined : (new Date(json['currentStageStartedAt'])),
111
+ 'settings': json['settings'] == null ? undefined : ProjectSettingsFromJSON(json['settings']),
150
112
  };
151
113
  }
152
114
 
@@ -166,12 +128,8 @@ export function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator:
166
128
  'status': value['status'],
167
129
  'currentStage': value['currentStage'],
168
130
  'maxStage': value['maxStage'],
169
- 'similarityThreshold': value['similarityThreshold'],
170
- 'snowballingType': value['snowballingType'],
171
- 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
172
- 'reviewDecisionMatrix': ReviewDecisionMatrixToJSON(value['reviewDecisionMatrix']),
173
- 'fetchers': value['fetchers'],
174
131
  'currentStageStartedAt': value['currentStageStartedAt'] == null ? undefined : ((value['currentStageStartedAt']).toISOString()),
132
+ 'settings': ProjectSettingsToJSON(value['settings']),
175
133
  };
176
134
  }
177
135
 
@@ -0,0 +1,117 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * SnowballR API
5
+ * REST API for the SnowballR Application
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { ReviewDecisionMatrix } from './ReviewDecisionMatrix';
17
+ import {
18
+ ReviewDecisionMatrixFromJSON,
19
+ ReviewDecisionMatrixFromJSONTyped,
20
+ ReviewDecisionMatrixToJSON,
21
+ ReviewDecisionMatrixToJSONTyped,
22
+ } from './ReviewDecisionMatrix';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface ProjectSettings
28
+ */
29
+ export interface ProjectSettings {
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ProjectSettings
34
+ */
35
+ similarityThreshold?: number;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof ProjectSettings
40
+ */
41
+ snowballingType?: ProjectSettingsSnowballingTypeEnum;
42
+ /**
43
+ *
44
+ * @type {boolean}
45
+ * @memberof ProjectSettings
46
+ */
47
+ reviewMaybeAllowed?: boolean;
48
+ /**
49
+ *
50
+ * @type {ReviewDecisionMatrix}
51
+ * @memberof ProjectSettings
52
+ */
53
+ reviewDecisionMatrix?: ReviewDecisionMatrix;
54
+ /**
55
+ *
56
+ * @type {{ [key: string]: { [key: string]: string; }; }}
57
+ * @memberof ProjectSettings
58
+ */
59
+ fetchers?: { [key: string]: { [key: string]: string; }; };
60
+ }
61
+
62
+
63
+ /**
64
+ * @export
65
+ */
66
+ export const ProjectSettingsSnowballingTypeEnum = {
67
+ FORWARD: 'FORWARD',
68
+ BACKWARD: 'BACKWARD',
69
+ BOTH: 'BOTH'
70
+ } as const;
71
+ export type ProjectSettingsSnowballingTypeEnum = typeof ProjectSettingsSnowballingTypeEnum[keyof typeof ProjectSettingsSnowballingTypeEnum];
72
+
73
+
74
+ /**
75
+ * Check if a given object implements the ProjectSettings interface.
76
+ */
77
+ export function instanceOfProjectSettings(value: object): value is ProjectSettings {
78
+ return true;
79
+ }
80
+
81
+ export function ProjectSettingsFromJSON(json: any): ProjectSettings {
82
+ return ProjectSettingsFromJSONTyped(json, false);
83
+ }
84
+
85
+ export function ProjectSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectSettings {
86
+ if (json == null) {
87
+ return json;
88
+ }
89
+ return {
90
+
91
+ 'similarityThreshold': json['similarityThreshold'] == null ? undefined : json['similarityThreshold'],
92
+ 'snowballingType': json['snowballingType'] == null ? undefined : json['snowballingType'],
93
+ 'reviewMaybeAllowed': json['reviewMaybeAllowed'] == null ? undefined : json['reviewMaybeAllowed'],
94
+ 'reviewDecisionMatrix': json['reviewDecisionMatrix'] == null ? undefined : ReviewDecisionMatrixFromJSON(json['reviewDecisionMatrix']),
95
+ 'fetchers': json['fetchers'] == null ? undefined : json['fetchers'],
96
+ };
97
+ }
98
+
99
+ export function ProjectSettingsToJSON(json: any): ProjectSettings {
100
+ return ProjectSettingsToJSONTyped(json, false);
101
+ }
102
+
103
+ export function ProjectSettingsToJSONTyped(value?: ProjectSettings | null, ignoreDiscriminator: boolean = false): any {
104
+ if (value == null) {
105
+ return value;
106
+ }
107
+
108
+ return {
109
+
110
+ 'similarityThreshold': value['similarityThreshold'],
111
+ 'snowballingType': value['snowballingType'],
112
+ 'reviewMaybeAllowed': value['reviewMaybeAllowed'],
113
+ 'reviewDecisionMatrix': ReviewDecisionMatrixToJSON(value['reviewDecisionMatrix']),
114
+ 'fetchers': value['fetchers'],
115
+ };
116
+ }
117
+
@@ -4,4 +4,5 @@ export * from './CreateProjectRequest';
4
4
  export * from './DecisionMatrixPattern';
5
5
  export * from './DecisionMatrixPatternEntry';
6
6
  export * from './Project';
7
+ export * from './ProjectSettings';
7
8
  export * from './ReviewDecisionMatrix';