keplar-api 0.0.23 → 0.0.25

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.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## keplar-api@0.0.23
1
+ ## keplar-api@0.0.25
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 keplar-api@0.0.23 --save
39
+ npm install keplar-api@0.0.25 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -222,6 +222,9 @@ export interface DeleteEmailShareRequest {
222
222
  shareEntityId: string;
223
223
  email: string;
224
224
  }
225
+ export interface DeleteShareEntityRequest {
226
+ shareEntityId: string;
227
+ }
225
228
  export interface DownloadInviteResponsesRequest {
226
229
  id: string;
227
230
  statuses?: Array<InviteResponseStatus>;
@@ -910,6 +913,14 @@ export declare class DefaultApi extends runtime.BaseAPI {
910
913
  * Remove email access from a share
911
914
  */
912
915
  deleteEmailShare(requestParameters: DeleteEmailShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteArtifact200Response>;
916
+ /**
917
+ * Delete a share entity
918
+ */
919
+ deleteShareEntityRaw(requestParameters: DeleteShareEntityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteArtifact200Response>>;
920
+ /**
921
+ * Delete a share entity
922
+ */
923
+ deleteShareEntity(requestParameters: DeleteShareEntityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteArtifact200Response>;
913
924
  /**
914
925
  * Download invite responses as CSV
915
926
  */
@@ -3414,6 +3414,62 @@ var DefaultApi = /** @class */ (function (_super) {
3414
3414
  });
3415
3415
  });
3416
3416
  };
3417
+ /**
3418
+ * Delete a share entity
3419
+ */
3420
+ DefaultApi.prototype.deleteShareEntityRaw = function (requestParameters, initOverrides) {
3421
+ return __awaiter(this, void 0, void 0, function () {
3422
+ var queryParameters, headerParameters, token, tokenString, urlPath, response;
3423
+ return __generator(this, function (_a) {
3424
+ switch (_a.label) {
3425
+ case 0:
3426
+ if (requestParameters['shareEntityId'] == null) {
3427
+ throw new runtime.RequiredError('shareEntityId', 'Required parameter "shareEntityId" was null or undefined when calling deleteShareEntity().');
3428
+ }
3429
+ queryParameters = {};
3430
+ headerParameters = {};
3431
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3432
+ token = this.configuration.accessToken;
3433
+ return [4 /*yield*/, token("bearerAuth", [])];
3434
+ case 1:
3435
+ tokenString = _a.sent();
3436
+ if (tokenString) {
3437
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
3438
+ }
3439
+ _a.label = 2;
3440
+ case 2:
3441
+ urlPath = "/api/sharing/share-entities/{shareEntityId}";
3442
+ urlPath = urlPath.replace("{".concat("shareEntityId", "}"), encodeURIComponent(String(requestParameters['shareEntityId'])));
3443
+ return [4 /*yield*/, this.request({
3444
+ path: urlPath,
3445
+ method: 'DELETE',
3446
+ headers: headerParameters,
3447
+ query: queryParameters,
3448
+ }, initOverrides)];
3449
+ case 3:
3450
+ response = _a.sent();
3451
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.DeleteArtifact200ResponseFromJSON)(jsonValue); })];
3452
+ }
3453
+ });
3454
+ });
3455
+ };
3456
+ /**
3457
+ * Delete a share entity
3458
+ */
3459
+ DefaultApi.prototype.deleteShareEntity = function (requestParameters, initOverrides) {
3460
+ return __awaiter(this, void 0, void 0, function () {
3461
+ var response;
3462
+ return __generator(this, function (_a) {
3463
+ switch (_a.label) {
3464
+ case 0: return [4 /*yield*/, this.deleteShareEntityRaw(requestParameters, initOverrides)];
3465
+ case 1:
3466
+ response = _a.sent();
3467
+ return [4 /*yield*/, response.value()];
3468
+ case 2: return [2 /*return*/, _a.sent()];
3469
+ }
3470
+ });
3471
+ });
3472
+ };
3417
3473
  /**
3418
3474
  * Download invite responses as CSV
3419
3475
  */
@@ -17,6 +17,7 @@ export declare const ProjectFileCategory: {
17
17
  readonly Transcript: "transcript";
18
18
  readonly Attachment: "attachment";
19
19
  readonly VisualAsset: "visual_asset";
20
+ readonly ScreenerQuestionImage: "screener_question_image";
20
21
  readonly Report: "report";
21
22
  readonly Analysis: "analysis";
22
23
  readonly Other: "other";
@@ -27,6 +27,7 @@ exports.ProjectFileCategory = {
27
27
  Transcript: 'transcript',
28
28
  Attachment: 'attachment',
29
29
  VisualAsset: 'visual_asset',
30
+ ScreenerQuestionImage: 'screener_question_image',
30
31
  Report: 'report',
31
32
  Analysis: 'analysis',
32
33
  Other: 'other'
@@ -28,6 +28,12 @@ export interface ScreenerQuestionChooseMultiple {
28
28
  * @memberof ScreenerQuestionChooseMultiple
29
29
  */
30
30
  question: string;
31
+ /**
32
+ * File ID for question image
33
+ * @type {string}
34
+ * @memberof ScreenerQuestionChooseMultiple
35
+ */
36
+ imageFileId?: string;
31
37
  /**
32
38
  *
33
39
  * @type {{ [key: string]: ScreenerQuestionChooseMultipleOptionsValue; }}
@@ -55,6 +55,7 @@ function ScreenerQuestionChooseMultipleFromJSONTyped(json, ignoreDiscriminator)
55
55
  return {
56
56
  'type': json['type'],
57
57
  'question': json['question'],
58
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
58
59
  'options': ((0, runtime_1.mapValues)(json['options'], ScreenerQuestionChooseMultipleOptionsValue_1.ScreenerQuestionChooseMultipleOptionsValueFromJSON)),
59
60
  'minPassingOptions': json['minPassingOptions'],
60
61
  'randomizeOrder': json['randomizeOrder'] == null ? undefined : json['randomizeOrder'],
@@ -73,6 +74,7 @@ function ScreenerQuestionChooseMultipleToJSONTyped(value, ignoreDiscriminator) {
73
74
  return {
74
75
  'type': value['type'],
75
76
  'question': value['question'],
77
+ 'imageFileId': value['imageFileId'],
76
78
  'options': ((0, runtime_1.mapValues)(value['options'], ScreenerQuestionChooseMultipleOptionsValue_1.ScreenerQuestionChooseMultipleOptionsValueToJSON)),
77
79
  'minPassingOptions': value['minPassingOptions'],
78
80
  'randomizeOrder': value['randomizeOrder'],
@@ -28,6 +28,12 @@ export interface ScreenerQuestionChooseMultiplePublic {
28
28
  * @memberof ScreenerQuestionChooseMultiplePublic
29
29
  */
30
30
  question: string;
31
+ /**
32
+ * File ID for question image
33
+ * @type {string}
34
+ * @memberof ScreenerQuestionChooseMultiplePublic
35
+ */
36
+ imageFileId?: string;
31
37
  /**
32
38
  *
33
39
  * @type {{ [key: string]: ScreenerQuestionChooseMultipleOptionsValue; }}
@@ -54,6 +60,12 @@ export interface ScreenerQuestionChooseMultiplePublic {
54
60
  * @memberof ScreenerQuestionChooseMultiplePublic
55
61
  */
56
62
  showSelectNoneOfAbove: boolean;
63
+ /**
64
+ * Signed URL for question image (enriched for participant view)
65
+ * @type {string}
66
+ * @memberof ScreenerQuestionChooseMultiplePublic
67
+ */
68
+ imageUrl?: string;
57
69
  }
58
70
  /**
59
71
  * @export
@@ -53,10 +53,12 @@ function ScreenerQuestionChooseMultiplePublicFromJSONTyped(json, ignoreDiscrimin
53
53
  return {
54
54
  'type': json['type'],
55
55
  'question': json['question'],
56
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
56
57
  'options': ((0, runtime_1.mapValues)(json['options'], ScreenerQuestionChooseMultipleOptionsValue_1.ScreenerQuestionChooseMultipleOptionsValueFromJSON)),
57
58
  'randomizeOrder': json['randomizeOrder'] == null ? undefined : json['randomizeOrder'],
58
59
  'showSelectAllOfAbove': json['showSelectAllOfAbove'],
59
60
  'showSelectNoneOfAbove': json['showSelectNoneOfAbove'],
61
+ 'imageUrl': json['imageUrl'] == null ? undefined : json['imageUrl'],
60
62
  };
61
63
  }
62
64
  function ScreenerQuestionChooseMultiplePublicToJSON(json) {
@@ -70,9 +72,11 @@ function ScreenerQuestionChooseMultiplePublicToJSONTyped(value, ignoreDiscrimina
70
72
  return {
71
73
  'type': value['type'],
72
74
  'question': value['question'],
75
+ 'imageFileId': value['imageFileId'],
73
76
  'options': ((0, runtime_1.mapValues)(value['options'], ScreenerQuestionChooseMultipleOptionsValue_1.ScreenerQuestionChooseMultipleOptionsValueToJSON)),
74
77
  'randomizeOrder': value['randomizeOrder'],
75
78
  'showSelectAllOfAbove': value['showSelectAllOfAbove'],
76
79
  'showSelectNoneOfAbove': value['showSelectNoneOfAbove'],
80
+ 'imageUrl': value['imageUrl'],
77
81
  };
78
82
  }
@@ -27,6 +27,12 @@ export interface ScreenerQuestionChooseOne {
27
27
  * @memberof ScreenerQuestionChooseOne
28
28
  */
29
29
  question: string;
30
+ /**
31
+ * File ID for question image
32
+ * @type {string}
33
+ * @memberof ScreenerQuestionChooseOne
34
+ */
35
+ imageFileId?: string;
30
36
  /**
31
37
  *
32
38
  * @type {Array<string>}
@@ -49,6 +49,7 @@ function ScreenerQuestionChooseOneFromJSONTyped(json, ignoreDiscriminator) {
49
49
  return {
50
50
  'type': json['type'],
51
51
  'question': json['question'],
52
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
52
53
  'options': json['options'],
53
54
  'passingOptions': json['passingOptions'],
54
55
  };
@@ -64,6 +65,7 @@ function ScreenerQuestionChooseOneToJSONTyped(value, ignoreDiscriminator) {
64
65
  return {
65
66
  'type': value['type'],
66
67
  'question': value['question'],
68
+ 'imageFileId': value['imageFileId'],
67
69
  'options': value['options'],
68
70
  'passingOptions': value['passingOptions'],
69
71
  };
@@ -27,12 +27,24 @@ export interface ScreenerQuestionChooseOnePublic {
27
27
  * @memberof ScreenerQuestionChooseOnePublic
28
28
  */
29
29
  question: string;
30
+ /**
31
+ * File ID for question image
32
+ * @type {string}
33
+ * @memberof ScreenerQuestionChooseOnePublic
34
+ */
35
+ imageFileId?: string;
30
36
  /**
31
37
  *
32
38
  * @type {Array<string>}
33
39
  * @memberof ScreenerQuestionChooseOnePublic
34
40
  */
35
41
  options: Array<string>;
42
+ /**
43
+ * Signed URL for question image (enriched for participant view)
44
+ * @type {string}
45
+ * @memberof ScreenerQuestionChooseOnePublic
46
+ */
47
+ imageUrl?: string;
36
48
  }
37
49
  /**
38
50
  * @export
@@ -47,7 +47,9 @@ function ScreenerQuestionChooseOnePublicFromJSONTyped(json, ignoreDiscriminator)
47
47
  return {
48
48
  'type': json['type'],
49
49
  'question': json['question'],
50
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
50
51
  'options': json['options'],
52
+ 'imageUrl': json['imageUrl'] == null ? undefined : json['imageUrl'],
51
53
  };
52
54
  }
53
55
  function ScreenerQuestionChooseOnePublicToJSON(json) {
@@ -61,6 +63,8 @@ function ScreenerQuestionChooseOnePublicToJSONTyped(value, ignoreDiscriminator)
61
63
  return {
62
64
  'type': value['type'],
63
65
  'question': value['question'],
66
+ 'imageFileId': value['imageFileId'],
64
67
  'options': value['options'],
68
+ 'imageUrl': value['imageUrl'],
65
69
  };
66
70
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "keplar-api",
3
- "version": "0.0.23",
3
+ "version": "0.0.25",
4
4
  "description": "OpenAPI client for keplar-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -553,6 +553,10 @@ export interface DeleteEmailShareRequest {
553
553
  email: string;
554
554
  }
555
555
 
556
+ export interface DeleteShareEntityRequest {
557
+ shareEntityId: string;
558
+ }
559
+
556
560
  export interface DownloadInviteResponsesRequest {
557
561
  id: string;
558
562
  statuses?: Array<InviteResponseStatus>;
@@ -3648,6 +3652,51 @@ export class DefaultApi extends runtime.BaseAPI {
3648
3652
  return await response.value();
3649
3653
  }
3650
3654
 
3655
+ /**
3656
+ * Delete a share entity
3657
+ */
3658
+ async deleteShareEntityRaw(requestParameters: DeleteShareEntityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteArtifact200Response>> {
3659
+ if (requestParameters['shareEntityId'] == null) {
3660
+ throw new runtime.RequiredError(
3661
+ 'shareEntityId',
3662
+ 'Required parameter "shareEntityId" was null or undefined when calling deleteShareEntity().'
3663
+ );
3664
+ }
3665
+
3666
+ const queryParameters: any = {};
3667
+
3668
+ const headerParameters: runtime.HTTPHeaders = {};
3669
+
3670
+ if (this.configuration && this.configuration.accessToken) {
3671
+ const token = this.configuration.accessToken;
3672
+ const tokenString = await token("bearerAuth", []);
3673
+
3674
+ if (tokenString) {
3675
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
3676
+ }
3677
+ }
3678
+
3679
+ let urlPath = `/api/sharing/share-entities/{shareEntityId}`;
3680
+ urlPath = urlPath.replace(`{${"shareEntityId"}}`, encodeURIComponent(String(requestParameters['shareEntityId'])));
3681
+
3682
+ const response = await this.request({
3683
+ path: urlPath,
3684
+ method: 'DELETE',
3685
+ headers: headerParameters,
3686
+ query: queryParameters,
3687
+ }, initOverrides);
3688
+
3689
+ return new runtime.JSONApiResponse(response, (jsonValue) => DeleteArtifact200ResponseFromJSON(jsonValue));
3690
+ }
3691
+
3692
+ /**
3693
+ * Delete a share entity
3694
+ */
3695
+ async deleteShareEntity(requestParameters: DeleteShareEntityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteArtifact200Response> {
3696
+ const response = await this.deleteShareEntityRaw(requestParameters, initOverrides);
3697
+ return await response.value();
3698
+ }
3699
+
3651
3700
  /**
3652
3701
  * Download invite responses as CSV
3653
3702
  */
@@ -21,6 +21,7 @@ export const ProjectFileCategory = {
21
21
  Transcript: 'transcript',
22
22
  Attachment: 'attachment',
23
23
  VisualAsset: 'visual_asset',
24
+ ScreenerQuestionImage: 'screener_question_image',
24
25
  Report: 'report',
25
26
  Analysis: 'analysis',
26
27
  Other: 'other'
@@ -39,6 +39,12 @@ export interface ScreenerQuestionChooseMultiple {
39
39
  * @memberof ScreenerQuestionChooseMultiple
40
40
  */
41
41
  question: string;
42
+ /**
43
+ * File ID for question image
44
+ * @type {string}
45
+ * @memberof ScreenerQuestionChooseMultiple
46
+ */
47
+ imageFileId?: string;
42
48
  /**
43
49
  *
44
50
  * @type {{ [key: string]: ScreenerQuestionChooseMultipleOptionsValue; }}
@@ -106,6 +112,7 @@ export function ScreenerQuestionChooseMultipleFromJSONTyped(json: any, ignoreDis
106
112
 
107
113
  'type': json['type'],
108
114
  'question': json['question'],
115
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
109
116
  'options': (mapValues(json['options'], ScreenerQuestionChooseMultipleOptionsValueFromJSON)),
110
117
  'minPassingOptions': json['minPassingOptions'],
111
118
  'randomizeOrder': json['randomizeOrder'] == null ? undefined : json['randomizeOrder'],
@@ -127,6 +134,7 @@ export function ScreenerQuestionChooseMultipleToJSONTyped(value?: ScreenerQuesti
127
134
 
128
135
  'type': value['type'],
129
136
  'question': value['question'],
137
+ 'imageFileId': value['imageFileId'],
130
138
  'options': (mapValues(value['options'], ScreenerQuestionChooseMultipleOptionsValueToJSON)),
131
139
  'minPassingOptions': value['minPassingOptions'],
132
140
  'randomizeOrder': value['randomizeOrder'],
@@ -39,6 +39,12 @@ export interface ScreenerQuestionChooseMultiplePublic {
39
39
  * @memberof ScreenerQuestionChooseMultiplePublic
40
40
  */
41
41
  question: string;
42
+ /**
43
+ * File ID for question image
44
+ * @type {string}
45
+ * @memberof ScreenerQuestionChooseMultiplePublic
46
+ */
47
+ imageFileId?: string;
42
48
  /**
43
49
  *
44
50
  * @type {{ [key: string]: ScreenerQuestionChooseMultipleOptionsValue; }}
@@ -63,6 +69,12 @@ export interface ScreenerQuestionChooseMultiplePublic {
63
69
  * @memberof ScreenerQuestionChooseMultiplePublic
64
70
  */
65
71
  showSelectNoneOfAbove: boolean;
72
+ /**
73
+ * Signed URL for question image (enriched for participant view)
74
+ * @type {string}
75
+ * @memberof ScreenerQuestionChooseMultiplePublic
76
+ */
77
+ imageUrl?: string;
66
78
  }
67
79
 
68
80
 
@@ -99,10 +111,12 @@ export function ScreenerQuestionChooseMultiplePublicFromJSONTyped(json: any, ign
99
111
 
100
112
  'type': json['type'],
101
113
  'question': json['question'],
114
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
102
115
  'options': (mapValues(json['options'], ScreenerQuestionChooseMultipleOptionsValueFromJSON)),
103
116
  'randomizeOrder': json['randomizeOrder'] == null ? undefined : json['randomizeOrder'],
104
117
  'showSelectAllOfAbove': json['showSelectAllOfAbove'],
105
118
  'showSelectNoneOfAbove': json['showSelectNoneOfAbove'],
119
+ 'imageUrl': json['imageUrl'] == null ? undefined : json['imageUrl'],
106
120
  };
107
121
  }
108
122
 
@@ -119,10 +133,12 @@ export function ScreenerQuestionChooseMultiplePublicToJSONTyped(value?: Screener
119
133
 
120
134
  'type': value['type'],
121
135
  'question': value['question'],
136
+ 'imageFileId': value['imageFileId'],
122
137
  'options': (mapValues(value['options'], ScreenerQuestionChooseMultipleOptionsValueToJSON)),
123
138
  'randomizeOrder': value['randomizeOrder'],
124
139
  'showSelectAllOfAbove': value['showSelectAllOfAbove'],
125
140
  'showSelectNoneOfAbove': value['showSelectNoneOfAbove'],
141
+ 'imageUrl': value['imageUrl'],
126
142
  };
127
143
  }
128
144
 
@@ -31,6 +31,12 @@ export interface ScreenerQuestionChooseOne {
31
31
  * @memberof ScreenerQuestionChooseOne
32
32
  */
33
33
  question: string;
34
+ /**
35
+ * File ID for question image
36
+ * @type {string}
37
+ * @memberof ScreenerQuestionChooseOne
38
+ */
39
+ imageFileId?: string;
34
40
  /**
35
41
  *
36
42
  * @type {Array<string>}
@@ -78,6 +84,7 @@ export function ScreenerQuestionChooseOneFromJSONTyped(json: any, ignoreDiscrimi
78
84
 
79
85
  'type': json['type'],
80
86
  'question': json['question'],
87
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
81
88
  'options': json['options'],
82
89
  'passingOptions': json['passingOptions'],
83
90
  };
@@ -96,6 +103,7 @@ export function ScreenerQuestionChooseOneToJSONTyped(value?: ScreenerQuestionCho
96
103
 
97
104
  'type': value['type'],
98
105
  'question': value['question'],
106
+ 'imageFileId': value['imageFileId'],
99
107
  'options': value['options'],
100
108
  'passingOptions': value['passingOptions'],
101
109
  };
@@ -31,12 +31,24 @@ export interface ScreenerQuestionChooseOnePublic {
31
31
  * @memberof ScreenerQuestionChooseOnePublic
32
32
  */
33
33
  question: string;
34
+ /**
35
+ * File ID for question image
36
+ * @type {string}
37
+ * @memberof ScreenerQuestionChooseOnePublic
38
+ */
39
+ imageFileId?: string;
34
40
  /**
35
41
  *
36
42
  * @type {Array<string>}
37
43
  * @memberof ScreenerQuestionChooseOnePublic
38
44
  */
39
45
  options: Array<string>;
46
+ /**
47
+ * Signed URL for question image (enriched for participant view)
48
+ * @type {string}
49
+ * @memberof ScreenerQuestionChooseOnePublic
50
+ */
51
+ imageUrl?: string;
40
52
  }
41
53
 
42
54
 
@@ -71,7 +83,9 @@ export function ScreenerQuestionChooseOnePublicFromJSONTyped(json: any, ignoreDi
71
83
 
72
84
  'type': json['type'],
73
85
  'question': json['question'],
86
+ 'imageFileId': json['imageFileId'] == null ? undefined : json['imageFileId'],
74
87
  'options': json['options'],
88
+ 'imageUrl': json['imageUrl'] == null ? undefined : json['imageUrl'],
75
89
  };
76
90
  }
77
91
 
@@ -88,7 +102,9 @@ export function ScreenerQuestionChooseOnePublicToJSONTyped(value?: ScreenerQuest
88
102
 
89
103
  'type': value['type'],
90
104
  'question': value['question'],
105
+ 'imageFileId': value['imageFileId'],
91
106
  'options': value['options'],
107
+ 'imageUrl': value['imageUrl'],
92
108
  };
93
109
  }
94
110