@cirrobio/api-client 0.1.13 → 0.1.15

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
@@ -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 @cirrobio/api-client@0.1.13 --save
39
+ npm install @cirrobio/api-client@0.1.15 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -14,6 +14,11 @@ import type { CreateResponse, CustomPipelineSettings, FileRequirements, FormSche
14
14
  export interface ArchiveCustomProcessRequest {
15
15
  processId: string;
16
16
  }
17
+ export interface AuthorizeCustomProcessRequest {
18
+ processId: string;
19
+ code: string;
20
+ state: string;
21
+ }
17
22
  export interface CalculatePipelineCostRequest {
18
23
  processId: string;
19
24
  body: object;
@@ -55,6 +60,16 @@ export declare class ProcessesApi extends runtime.BaseAPI {
55
60
  * Archive custom process
56
61
  */
57
62
  archiveCustomProcess(requestParameters: ArchiveCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
63
+ /**
64
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
65
+ * Authorize custom process
66
+ */
67
+ authorizeCustomProcessRaw(requestParameters: AuthorizeCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
68
+ /**
69
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
70
+ * Authorize custom process
71
+ */
72
+ authorizeCustomProcess(requestParameters: AuthorizeCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
58
73
  /**
59
74
  * Retrieves the cost of running the pipeline
60
75
  * Calculate pipeline cost
@@ -128,6 +128,71 @@ var ProcessesApi = /** @class */ (function (_super) {
128
128
  });
129
129
  });
130
130
  };
131
+ /**
132
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
133
+ * Authorize custom process
134
+ */
135
+ ProcessesApi.prototype.authorizeCustomProcessRaw = function (requestParameters, initOverrides) {
136
+ return __awaiter(this, void 0, void 0, function () {
137
+ var queryParameters, headerParameters, token, tokenString, response;
138
+ return __generator(this, function (_a) {
139
+ switch (_a.label) {
140
+ case 0:
141
+ if (requestParameters.processId === null || requestParameters.processId === undefined) {
142
+ throw new runtime.RequiredError('processId', 'Required parameter requestParameters.processId was null or undefined when calling authorizeCustomProcess.');
143
+ }
144
+ if (requestParameters.code === null || requestParameters.code === undefined) {
145
+ throw new runtime.RequiredError('code', 'Required parameter requestParameters.code was null or undefined when calling authorizeCustomProcess.');
146
+ }
147
+ if (requestParameters.state === null || requestParameters.state === undefined) {
148
+ throw new runtime.RequiredError('state', 'Required parameter requestParameters.state was null or undefined when calling authorizeCustomProcess.');
149
+ }
150
+ queryParameters = {};
151
+ if (requestParameters.code !== undefined) {
152
+ queryParameters['code'] = requestParameters.code;
153
+ }
154
+ if (requestParameters.state !== undefined) {
155
+ queryParameters['state'] = requestParameters.state;
156
+ }
157
+ headerParameters = {};
158
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
159
+ token = this.configuration.accessToken;
160
+ return [4 /*yield*/, token("accessToken", [])];
161
+ case 1:
162
+ tokenString = _a.sent();
163
+ if (tokenString) {
164
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
165
+ }
166
+ _a.label = 2;
167
+ case 2: return [4 /*yield*/, this.request({
168
+ path: "/processes/{processId}:authorize".replace("{".concat("processId", "}"), encodeURIComponent(String(requestParameters.processId))),
169
+ method: 'PUT',
170
+ headers: headerParameters,
171
+ query: queryParameters,
172
+ }, initOverrides)];
173
+ case 3:
174
+ response = _a.sent();
175
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
176
+ }
177
+ });
178
+ });
179
+ };
180
+ /**
181
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
182
+ * Authorize custom process
183
+ */
184
+ ProcessesApi.prototype.authorizeCustomProcess = function (requestParameters, initOverrides) {
185
+ return __awaiter(this, void 0, void 0, function () {
186
+ return __generator(this, function (_a) {
187
+ switch (_a.label) {
188
+ case 0: return [4 /*yield*/, this.authorizeCustomProcessRaw(requestParameters, initOverrides)];
189
+ case 1:
190
+ _a.sent();
191
+ return [2 /*return*/];
192
+ }
193
+ });
194
+ });
195
+ };
131
196
  /**
132
197
  * Retrieves the cost of running the pipeline
133
198
  * Calculate pipeline cost
@@ -52,6 +52,12 @@ export interface CustomPipelineSettings {
52
52
  * @memberof CustomPipelineSettings
53
53
  */
54
54
  commitHash?: string | null;
55
+ /**
56
+ * Whether we are authorized to access the repository
57
+ * @type {boolean}
58
+ * @memberof CustomPipelineSettings
59
+ */
60
+ isAuthorized?: boolean;
55
61
  }
56
62
  /**
57
63
  * Check if a given object implements the CustomPipelineSettings interface.
@@ -40,6 +40,7 @@ function CustomPipelineSettingsFromJSONTyped(json, ignoreDiscriminator) {
40
40
  'lastSync': !(0, runtime_1.exists)(json, 'lastSync') ? undefined : (json['lastSync'] === null ? null : new Date(json['lastSync'])),
41
41
  'syncStatus': !(0, runtime_1.exists)(json, 'syncStatus') ? undefined : (0, SyncStatus_1.SyncStatusFromJSON)(json['syncStatus']),
42
42
  'commitHash': !(0, runtime_1.exists)(json, 'commitHash') ? undefined : json['commitHash'],
43
+ 'isAuthorized': !(0, runtime_1.exists)(json, 'isAuthorized') ? undefined : json['isAuthorized'],
43
44
  };
44
45
  }
45
46
  exports.CustomPipelineSettingsFromJSONTyped = CustomPipelineSettingsFromJSONTyped;
@@ -57,6 +58,7 @@ function CustomPipelineSettingsToJSON(value) {
57
58
  'lastSync': value.lastSync === undefined ? undefined : (value.lastSync === null ? null : value.lastSync.toISOString()),
58
59
  'syncStatus': (0, SyncStatus_1.SyncStatusToJSON)(value.syncStatus),
59
60
  'commitHash': value.commitHash,
61
+ 'isAuthorized': value.isAuthorized,
60
62
  };
61
63
  }
62
64
  exports.CustomPipelineSettingsToJSON = CustomPipelineSettingsToJSON;
@@ -46,6 +46,12 @@ export interface Process {
46
46
  * @memberof Process
47
47
  */
48
48
  executor: Executor;
49
+ /**
50
+ * Category of the pipeline
51
+ * @type {string}
52
+ * @memberof Process
53
+ */
54
+ category: string;
49
55
  /**
50
56
  * Link to pipeline documentation
51
57
  * @type {string}
@@ -24,6 +24,7 @@ function instanceOfProcess(value) {
24
24
  isInstance = isInstance && "id" in value;
25
25
  isInstance = isInstance && "name" in value;
26
26
  isInstance = isInstance && "executor" in value;
27
+ isInstance = isInstance && "category" in value;
27
28
  return isInstance;
28
29
  }
29
30
  exports.instanceOfProcess = instanceOfProcess;
@@ -41,6 +42,7 @@ function ProcessFromJSONTyped(json, ignoreDiscriminator) {
41
42
  'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
42
43
  'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
43
44
  'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
45
+ 'category': json['category'],
44
46
  'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
45
47
  'fileRequirementsMessage': !(0, runtime_1.exists)(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
46
48
  'childProcessIds': !(0, runtime_1.exists)(json, 'childProcessIds') ? undefined : json['childProcessIds'],
@@ -65,6 +67,7 @@ function ProcessToJSON(value) {
65
67
  'description': value.description,
66
68
  'dataType': value.dataType,
67
69
  'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
70
+ 'category': value.category,
68
71
  'documentationUrl': value.documentationUrl,
69
72
  'fileRequirementsMessage': value.fileRequirementsMessage,
70
73
  'childProcessIds': value.childProcessIds,
@@ -49,6 +49,12 @@ export interface ProcessDetail {
49
49
  * @memberof ProcessDetail
50
50
  */
51
51
  executor: Executor;
52
+ /**
53
+ * Category of the pipeline
54
+ * @type {string}
55
+ * @memberof ProcessDetail
56
+ */
57
+ category: string;
52
58
  /**
53
59
  * IDs of pipelines that can be run downstream
54
60
  * @type {Array<string>}
@@ -28,6 +28,7 @@ function instanceOfProcessDetail(value) {
28
28
  isInstance = isInstance && "name" in value;
29
29
  isInstance = isInstance && "description" in value;
30
30
  isInstance = isInstance && "executor" in value;
31
+ isInstance = isInstance && "category" in value;
31
32
  isInstance = isInstance && "childProcessIds" in value;
32
33
  isInstance = isInstance && "parentProcessIds" in value;
33
34
  isInstance = isInstance && "linkedProjectIds" in value;
@@ -48,6 +49,7 @@ function ProcessDetailFromJSONTyped(json, ignoreDiscriminator) {
48
49
  'description': json['description'],
49
50
  'dataType': !(0, runtime_1.exists)(json, 'dataType') ? undefined : json['dataType'],
50
51
  'executor': (0, Executor_1.ExecutorFromJSON)(json['executor']),
52
+ 'category': json['category'],
51
53
  'childProcessIds': json['childProcessIds'],
52
54
  'parentProcessIds': json['parentProcessIds'],
53
55
  'documentationUrl': !(0, runtime_1.exists)(json, 'documentationUrl') ? undefined : json['documentationUrl'],
@@ -75,6 +77,7 @@ function ProcessDetailToJSON(value) {
75
77
  'description': value.description,
76
78
  'dataType': value.dataType,
77
79
  'executor': (0, Executor_1.ExecutorToJSON)(value.executor),
80
+ 'category': value.category,
78
81
  'childProcessIds': value.childProcessIds,
79
82
  'parentProcessIds': value.parentProcessIds,
80
83
  'documentationUrl': value.documentationUrl,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.1.13",
3
+ "version": "0.1.15",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {
@@ -53,6 +53,12 @@ export interface ArchiveCustomProcessRequest {
53
53
  processId: string;
54
54
  }
55
55
 
56
+ export interface AuthorizeCustomProcessRequest {
57
+ processId: string;
58
+ code: string;
59
+ state: string;
60
+ }
61
+
56
62
  export interface CalculatePipelineCostRequest {
57
63
  processId: string;
58
64
  body: object;
@@ -132,6 +138,61 @@ export class ProcessesApi extends runtime.BaseAPI {
132
138
  await this.archiveCustomProcessRaw(requestParameters, initOverrides);
133
139
  }
134
140
 
141
+ /**
142
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
143
+ * Authorize custom process
144
+ */
145
+ async authorizeCustomProcessRaw(requestParameters: AuthorizeCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
146
+ if (requestParameters.processId === null || requestParameters.processId === undefined) {
147
+ throw new runtime.RequiredError('processId','Required parameter requestParameters.processId was null or undefined when calling authorizeCustomProcess.');
148
+ }
149
+
150
+ if (requestParameters.code === null || requestParameters.code === undefined) {
151
+ throw new runtime.RequiredError('code','Required parameter requestParameters.code was null or undefined when calling authorizeCustomProcess.');
152
+ }
153
+
154
+ if (requestParameters.state === null || requestParameters.state === undefined) {
155
+ throw new runtime.RequiredError('state','Required parameter requestParameters.state was null or undefined when calling authorizeCustomProcess.');
156
+ }
157
+
158
+ const queryParameters: any = {};
159
+
160
+ if (requestParameters.code !== undefined) {
161
+ queryParameters['code'] = requestParameters.code;
162
+ }
163
+
164
+ if (requestParameters.state !== undefined) {
165
+ queryParameters['state'] = requestParameters.state;
166
+ }
167
+
168
+ const headerParameters: runtime.HTTPHeaders = {};
169
+
170
+ if (this.configuration && this.configuration.accessToken) {
171
+ const token = this.configuration.accessToken;
172
+ const tokenString = await token("accessToken", []);
173
+
174
+ if (tokenString) {
175
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
176
+ }
177
+ }
178
+ const response = await this.request({
179
+ path: `/processes/{processId}:authorize`.replace(`{${"processId"}}`, encodeURIComponent(String(requestParameters.processId))),
180
+ method: 'PUT',
181
+ headers: headerParameters,
182
+ query: queryParameters,
183
+ }, initOverrides);
184
+
185
+ return new runtime.VoidApiResponse(response);
186
+ }
187
+
188
+ /**
189
+ * Authorizes the GitHub repository connection for the process (only for private repositories)
190
+ * Authorize custom process
191
+ */
192
+ async authorizeCustomProcess(requestParameters: AuthorizeCustomProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
193
+ await this.authorizeCustomProcessRaw(requestParameters, initOverrides);
194
+ }
195
+
135
196
  /**
136
197
  * Retrieves the cost of running the pipeline
137
198
  * Calculate pipeline cost
@@ -62,6 +62,12 @@ export interface CustomPipelineSettings {
62
62
  * @memberof CustomPipelineSettings
63
63
  */
64
64
  commitHash?: string | null;
65
+ /**
66
+ * Whether we are authorized to access the repository
67
+ * @type {boolean}
68
+ * @memberof CustomPipelineSettings
69
+ */
70
+ isAuthorized?: boolean;
65
71
  }
66
72
 
67
73
  /**
@@ -90,6 +96,7 @@ export function CustomPipelineSettingsFromJSONTyped(json: any, ignoreDiscriminat
90
96
  'lastSync': !exists(json, 'lastSync') ? undefined : (json['lastSync'] === null ? null : new Date(json['lastSync'])),
91
97
  'syncStatus': !exists(json, 'syncStatus') ? undefined : SyncStatusFromJSON(json['syncStatus']),
92
98
  'commitHash': !exists(json, 'commitHash') ? undefined : json['commitHash'],
99
+ 'isAuthorized': !exists(json, 'isAuthorized') ? undefined : json['isAuthorized'],
93
100
  };
94
101
  }
95
102
 
@@ -108,6 +115,7 @@ export function CustomPipelineSettingsToJSON(value?: CustomPipelineSettings | nu
108
115
  'lastSync': value.lastSync === undefined ? undefined : (value.lastSync === null ? null : value.lastSync.toISOString()),
109
116
  'syncStatus': SyncStatusToJSON(value.syncStatus),
110
117
  'commitHash': value.commitHash,
118
+ 'isAuthorized': value.isAuthorized,
111
119
  };
112
120
  }
113
121
 
@@ -56,6 +56,12 @@ export interface Process {
56
56
  * @memberof Process
57
57
  */
58
58
  executor: Executor;
59
+ /**
60
+ * Category of the pipeline
61
+ * @type {string}
62
+ * @memberof Process
63
+ */
64
+ category: string;
59
65
  /**
60
66
  * Link to pipeline documentation
61
67
  * @type {string}
@@ -114,6 +120,7 @@ export function instanceOfProcess(value: object): boolean {
114
120
  isInstance = isInstance && "id" in value;
115
121
  isInstance = isInstance && "name" in value;
116
122
  isInstance = isInstance && "executor" in value;
123
+ isInstance = isInstance && "category" in value;
117
124
 
118
125
  return isInstance;
119
126
  }
@@ -133,6 +140,7 @@ export function ProcessFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
133
140
  'description': !exists(json, 'description') ? undefined : json['description'],
134
141
  'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
135
142
  'executor': ExecutorFromJSON(json['executor']),
143
+ 'category': json['category'],
136
144
  'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
137
145
  'fileRequirementsMessage': !exists(json, 'fileRequirementsMessage') ? undefined : json['fileRequirementsMessage'],
138
146
  'childProcessIds': !exists(json, 'childProcessIds') ? undefined : json['childProcessIds'],
@@ -158,6 +166,7 @@ export function ProcessToJSON(value?: Process | null): any {
158
166
  'description': value.description,
159
167
  'dataType': value.dataType,
160
168
  'executor': ExecutorToJSON(value.executor),
169
+ 'category': value.category,
161
170
  'documentationUrl': value.documentationUrl,
162
171
  'fileRequirementsMessage': value.fileRequirementsMessage,
163
172
  'childProcessIds': value.childProcessIds,
@@ -74,6 +74,12 @@ export interface ProcessDetail {
74
74
  * @memberof ProcessDetail
75
75
  */
76
76
  executor: Executor;
77
+ /**
78
+ * Category of the pipeline
79
+ * @type {string}
80
+ * @memberof ProcessDetail
81
+ */
82
+ category: string;
77
83
  /**
78
84
  * IDs of pipelines that can be run downstream
79
85
  * @type {Array<string>}
@@ -151,6 +157,7 @@ export function instanceOfProcessDetail(value: object): boolean {
151
157
  isInstance = isInstance && "name" in value;
152
158
  isInstance = isInstance && "description" in value;
153
159
  isInstance = isInstance && "executor" in value;
160
+ isInstance = isInstance && "category" in value;
154
161
  isInstance = isInstance && "childProcessIds" in value;
155
162
  isInstance = isInstance && "parentProcessIds" in value;
156
163
  isInstance = isInstance && "linkedProjectIds" in value;
@@ -173,6 +180,7 @@ export function ProcessDetailFromJSONTyped(json: any, ignoreDiscriminator: boole
173
180
  'description': json['description'],
174
181
  'dataType': !exists(json, 'dataType') ? undefined : json['dataType'],
175
182
  'executor': ExecutorFromJSON(json['executor']),
183
+ 'category': json['category'],
176
184
  'childProcessIds': json['childProcessIds'],
177
185
  'parentProcessIds': json['parentProcessIds'],
178
186
  'documentationUrl': !exists(json, 'documentationUrl') ? undefined : json['documentationUrl'],
@@ -201,6 +209,7 @@ export function ProcessDetailToJSON(value?: ProcessDetail | null): any {
201
209
  'description': value.description,
202
210
  'dataType': value.dataType,
203
211
  'executor': ExecutorToJSON(value.executor),
212
+ 'category': value.category,
204
213
  'childProcessIds': value.childProcessIds,
205
214
  'parentProcessIds': value.parentProcessIds,
206
215
  'documentationUrl': value.documentationUrl,