@shapediver/sdk.geometry-api-sdk-v2 3.7.0 → 4.1.0

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.
Files changed (153) hide show
  1. package/README.md +5 -5
  2. package/dist/UtilsApi.d.ts +19 -29
  3. package/dist/UtilsApi.d.ts.map +1 -1
  4. package/dist/UtilsApi.js +140 -135
  5. package/dist/UtilsApi.js.map +1 -1
  6. package/dist/base.d.ts +2 -5
  7. package/dist/base.d.ts.map +1 -1
  8. package/dist/base.js +30 -36
  9. package/dist/base.js.map +1 -1
  10. package/dist/client/apis/AnalyticsApi.d.ts +38 -0
  11. package/dist/client/apis/AnalyticsApi.d.ts.map +1 -0
  12. package/dist/client/apis/AnalyticsApi.js +245 -0
  13. package/dist/client/apis/AnalyticsApi.js.map +1 -0
  14. package/dist/client/apis/ArSceneApi.d.ts +23 -0
  15. package/dist/client/apis/ArSceneApi.d.ts.map +1 -0
  16. package/dist/client/apis/ArSceneApi.js +140 -0
  17. package/dist/client/apis/ArSceneApi.js.map +1 -0
  18. package/dist/client/apis/AssetsApi.d.ts +54 -0
  19. package/dist/client/apis/AssetsApi.d.ts.map +1 -0
  20. package/dist/client/apis/AssetsApi.js +329 -0
  21. package/dist/client/apis/AssetsApi.js.map +1 -0
  22. package/dist/client/apis/AuthApi.d.ts +8 -0
  23. package/dist/client/apis/AuthApi.d.ts.map +1 -0
  24. package/dist/client/apis/AuthApi.js +77 -0
  25. package/dist/client/apis/AuthApi.js.map +1 -0
  26. package/dist/client/apis/AuthGroupApi.d.ts +12 -0
  27. package/dist/client/apis/AuthGroupApi.d.ts.map +1 -0
  28. package/dist/client/apis/AuthGroupApi.js +89 -0
  29. package/dist/client/apis/AuthGroupApi.js.map +1 -0
  30. package/dist/client/apis/ExportApi.d.ts +38 -0
  31. package/dist/client/apis/ExportApi.d.ts.map +1 -0
  32. package/dist/client/apis/ExportApi.js +230 -0
  33. package/dist/client/apis/ExportApi.js.map +1 -0
  34. package/dist/client/apis/FileApi.d.ts +45 -0
  35. package/dist/client/apis/FileApi.d.ts.map +1 -0
  36. package/dist/client/apis/FileApi.js +271 -0
  37. package/dist/client/apis/FileApi.js.map +1 -0
  38. package/dist/client/apis/GltfApi.d.ts +14 -0
  39. package/dist/client/apis/GltfApi.d.ts.map +1 -0
  40. package/dist/client/apis/GltfApi.js +96 -0
  41. package/dist/client/apis/GltfApi.js.map +1 -0
  42. package/dist/client/apis/LogApi.d.ts +13 -0
  43. package/dist/client/apis/LogApi.d.ts.map +1 -0
  44. package/dist/client/apis/LogApi.js +93 -0
  45. package/dist/client/apis/LogApi.js.map +1 -0
  46. package/dist/client/apis/ModelApi.d.ts +129 -0
  47. package/dist/client/apis/ModelApi.d.ts.map +1 -0
  48. package/dist/client/apis/ModelApi.js +762 -0
  49. package/dist/client/apis/ModelApi.js.map +1 -0
  50. package/dist/client/apis/ModelStateApi.d.ts +57 -0
  51. package/dist/client/apis/ModelStateApi.d.ts.map +1 -0
  52. package/dist/client/apis/ModelStateApi.js +328 -0
  53. package/dist/client/apis/ModelStateApi.js.map +1 -0
  54. package/dist/client/apis/OutputApi.d.ts +38 -0
  55. package/dist/client/apis/OutputApi.d.ts.map +1 -0
  56. package/dist/client/apis/OutputApi.js +230 -0
  57. package/dist/client/apis/OutputApi.js.map +1 -0
  58. package/dist/client/apis/ScriptApi.d.ts +17 -0
  59. package/dist/client/apis/ScriptApi.d.ts.map +1 -0
  60. package/dist/client/apis/ScriptApi.js +127 -0
  61. package/dist/client/apis/ScriptApi.js.map +1 -0
  62. package/dist/client/apis/SdtfApi.d.ts +37 -0
  63. package/dist/client/apis/SdtfApi.d.ts.map +1 -0
  64. package/dist/client/apis/SdtfApi.js +227 -0
  65. package/dist/client/apis/SdtfApi.js.map +1 -0
  66. package/dist/client/apis/SessionApi.d.ts +51 -0
  67. package/dist/client/apis/SessionApi.d.ts.map +1 -0
  68. package/dist/client/apis/SessionApi.js +300 -0
  69. package/dist/client/apis/SessionApi.js.map +1 -0
  70. package/dist/client/apis/SystemApi.d.ts +28 -0
  71. package/dist/client/apis/SystemApi.d.ts.map +1 -0
  72. package/dist/client/apis/SystemApi.js +235 -0
  73. package/dist/client/apis/SystemApi.js.map +1 -0
  74. package/dist/client/apis/TextureApi.d.ts +13 -0
  75. package/dist/client/apis/TextureApi.d.ts.map +1 -0
  76. package/dist/client/apis/TextureApi.js +91 -0
  77. package/dist/client/apis/TextureApi.js.map +1 -0
  78. package/dist/client/apis/index.d.ts +18 -0
  79. package/dist/client/apis/index.d.ts.map +1 -0
  80. package/dist/client/apis/index.js +34 -0
  81. package/dist/client/apis/index.js.map +1 -0
  82. package/dist/client/index.d.ts +3 -2
  83. package/dist/client/index.d.ts.map +1 -1
  84. package/dist/client/index.js +3 -2
  85. package/dist/client/index.js.map +1 -1
  86. package/dist/client/models/index.d.ts +1671 -0
  87. package/dist/client/models/index.d.ts.map +1 -0
  88. package/dist/client/models/index.js +239 -0
  89. package/dist/client/models/index.js.map +1 -0
  90. package/dist/client/runtime.d.ts +154 -0
  91. package/dist/client/runtime.d.ts.map +1 -0
  92. package/dist/client/runtime.js +323 -0
  93. package/dist/client/runtime.js.map +1 -0
  94. package/dist/configuration.d.ts +2 -7
  95. package/dist/configuration.d.ts.map +1 -1
  96. package/dist/configuration.js +21 -16
  97. package/dist/configuration.js.map +1 -1
  98. package/dist/index.d.ts +2 -1
  99. package/dist/index.d.ts.map +1 -1
  100. package/dist/index.js +2 -1
  101. package/dist/index.js.map +1 -1
  102. package/dist/utils.d.ts +2 -3
  103. package/dist/utils.d.ts.map +1 -1
  104. package/dist/utils.js +16 -13
  105. package/dist/utils.js.map +1 -1
  106. package/package.json +3 -9
  107. package/src/UtilsApi.ts +265 -318
  108. package/src/base.ts +48 -46
  109. package/src/client/apis/AnalyticsApi.ts +347 -0
  110. package/src/client/apis/ArSceneApi.ts +172 -0
  111. package/src/client/apis/AssetsApi.ts +474 -0
  112. package/src/client/apis/AuthApi.ts +63 -0
  113. package/src/client/apis/AuthGroupApi.ts +89 -0
  114. package/src/client/apis/ExportApi.ts +332 -0
  115. package/src/client/apis/FileApi.ts +401 -0
  116. package/src/client/apis/GltfApi.ts +101 -0
  117. package/src/client/apis/LogApi.ts +96 -0
  118. package/src/client/apis/ModelApi.ts +1206 -0
  119. package/src/client/apis/ModelStateApi.ts +479 -0
  120. package/src/client/apis/OutputApi.ts +333 -0
  121. package/src/client/apis/ScriptApi.ts +142 -0
  122. package/src/client/apis/SdtfApi.ts +327 -0
  123. package/src/client/apis/SessionApi.ts +435 -0
  124. package/src/client/apis/SystemApi.ts +301 -0
  125. package/src/client/apis/TextureApi.ts +91 -0
  126. package/src/client/apis/index.ts +19 -0
  127. package/src/client/index.ts +3 -16
  128. package/src/client/models/index.ts +7367 -0
  129. package/src/client/runtime.ts +442 -0
  130. package/src/configuration.ts +31 -38
  131. package/src/error.ts +2 -2
  132. package/src/index.ts +2 -1
  133. package/src/utils.ts +53 -25
  134. package/dist/client/api.d.ts +0 -2111
  135. package/dist/client/api.d.ts.map +0 -1
  136. package/dist/client/api.js +0 -3576
  137. package/dist/client/api.js.map +0 -1
  138. package/dist/client/base.d.ts +0 -32
  139. package/dist/client/base.d.ts.map +0 -1
  140. package/dist/client/base.js +0 -37
  141. package/dist/client/base.js.map +0 -1
  142. package/dist/client/common.d.ts +0 -15
  143. package/dist/client/common.d.ts.map +0 -1
  144. package/dist/client/common.js +0 -117
  145. package/dist/client/common.js.map +0 -1
  146. package/dist/client/configuration.d.ts +0 -37
  147. package/dist/client/configuration.d.ts.map +0 -1
  148. package/dist/client/configuration.js +0 -23
  149. package/dist/client/configuration.js.map +0 -1
  150. package/src/client/api.ts +0 -11052
  151. package/src/client/base.ts +0 -62
  152. package/src/client/common.ts +0 -127
  153. package/src/client/configuration.ts +0 -121
@@ -0,0 +1,1206 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Geometry Backend API v2
5
+ * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
6
+ *
7
+ * The version of the OpenAPI document: 2.5.0
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 * as runtime from '../runtime';
16
+ import { BaseAPI } from '../../base';
17
+ import type {
18
+ QueryComputationStatisticsStatus,
19
+ QueryComputationType,
20
+ QueryModelStatus,
21
+ QueryOrder,
22
+ ReqConfigure,
23
+ ReqCustomization,
24
+ ReqModel,
25
+ ReqParameterDefinitions,
26
+ ResCleanupExports,
27
+ ResCleanupOutputs,
28
+ ResCleanupTextures,
29
+ ResCreateModel,
30
+ ResCreateModelConfig,
31
+ ResDeleteModel,
32
+ ResError,
33
+ ResGetCleanupStatus,
34
+ ResGetModel,
35
+ ResGetModelComputations,
36
+ ResGetModelConfig,
37
+ ResListModels,
38
+ ResUpdateModel,
39
+ ResUpdateModelConfig,
40
+ ResUpdateParameterDefaultValues,
41
+ ResUpdateParameterDefinitions,
42
+ } from '../models/index';
43
+
44
+ export interface CleanupExportsRequest {
45
+ modelId: string;
46
+ untilLastSeen: string;
47
+ }
48
+
49
+ export interface CleanupOutputsRequest {
50
+ modelId: string;
51
+ untilLastSeen: string;
52
+ }
53
+
54
+ export interface CleanupTexturesRequest {
55
+ modelId: string;
56
+ untilLastSeen: string;
57
+ }
58
+
59
+ export interface CreateModelRequest {
60
+ reqModel: ReqModel;
61
+ }
62
+
63
+ export interface CreateModelConfigRequest {
64
+ modelId: string;
65
+ reqConfigure: ReqConfigure;
66
+ }
67
+
68
+ export interface DeleteModelRequest {
69
+ modelId: string;
70
+ }
71
+
72
+ export interface DownloadModelFileRequest {
73
+ modelId: string;
74
+ }
75
+
76
+ export interface GetCleanupStatusRequest {
77
+ modelId: string;
78
+ }
79
+
80
+ export interface GetModelRequest {
81
+ modelId: string;
82
+ }
83
+
84
+ export interface GetModelComputationsRequest {
85
+ modelId: string;
86
+ order?: QueryOrder;
87
+ timestampFrom?: string;
88
+ timestampTo?: string;
89
+ status?: QueryComputationStatisticsStatus;
90
+ type?: QueryComputationType;
91
+ limit?: number;
92
+ strictLimit?: boolean;
93
+ offset?: string;
94
+ }
95
+
96
+ export interface GetModelConfigRequest {
97
+ modelId: string;
98
+ xShapediverNoconvert?: boolean;
99
+ xShapediverUseconfigversion?: string;
100
+ xShapediverBuildversion?: string;
101
+ }
102
+
103
+ export interface ListModelsRequest {
104
+ modelStatus?: QueryModelStatus;
105
+ offset?: string;
106
+ }
107
+
108
+ export interface RestoreModelRequest {
109
+ modelId: string;
110
+ }
111
+
112
+ export interface UpdateModelRequest {
113
+ modelId: string;
114
+ reqModel: ReqModel;
115
+ }
116
+
117
+ export interface UpdateModelConfigRequest {
118
+ modelId: string;
119
+ reqConfigure: ReqConfigure;
120
+ }
121
+
122
+ export interface UpdateParameterDefaultValuesRequest {
123
+ modelId: string;
124
+ reqCustomization: ReqCustomization;
125
+ ignoreUnknownParams?: boolean;
126
+ }
127
+
128
+ export interface UpdateParameterDefinitionsRequest {
129
+ modelId: string;
130
+ reqParameterDefinitions: ReqParameterDefinitions;
131
+ }
132
+
133
+ /**
134
+ *
135
+ */
136
+ export class ModelApi extends BaseAPI {
137
+
138
+ /**
139
+ * Creates request options for cleanupExports without sending the request
140
+ */
141
+ async cleanupExportsRequestOpts(requestParameters: CleanupExportsRequest): Promise<runtime.RequestOpts> {
142
+ if (requestParameters['modelId'] == null) {
143
+ throw new runtime.RequiredError(
144
+ 'modelId',
145
+ 'Required parameter "modelId" was null or undefined when calling cleanupExports().'
146
+ );
147
+ }
148
+
149
+ if (requestParameters['untilLastSeen'] == null) {
150
+ throw new runtime.RequiredError(
151
+ 'untilLastSeen',
152
+ 'Required parameter "untilLastSeen" was null or undefined when calling cleanupExports().'
153
+ );
154
+ }
155
+
156
+ const queryParameters: any = {};
157
+
158
+ if (requestParameters['untilLastSeen'] != null) {
159
+ queryParameters['untilLastSeen'] = requestParameters['untilLastSeen'];
160
+ }
161
+
162
+ const headerParameters: runtime.HTTPHeaders = {};
163
+
164
+ if (this.configuration && this.configuration.accessToken) {
165
+ const token = this.configuration.accessToken;
166
+ const tokenString = await token("JwtAuth", []);
167
+
168
+ if (tokenString) {
169
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
170
+ }
171
+ }
172
+
173
+ let urlPath = `/api/v2/model/{modelId}/cleanup/export`;
174
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
175
+
176
+ return {
177
+ path: urlPath,
178
+ method: 'POST',
179
+ headers: headerParameters,
180
+ query: queryParameters,
181
+ };
182
+ }
183
+
184
+ /**
185
+ * Permissions: * `cache.export.delete.*` - __required__.
186
+ * Delete old export components.
187
+ */
188
+ async cleanupExportsRaw(requestParameters: CleanupExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResCleanupExports>> {
189
+ const requestOptions = await this.cleanupExportsRequestOpts(requestParameters);
190
+ const response = await this.request(requestOptions, initOverrides);
191
+
192
+ return new runtime.JSONApiResponse(response);
193
+ }
194
+
195
+ /**
196
+ * Permissions: * `cache.export.delete.*` - __required__.
197
+ * Delete old export components.
198
+ */
199
+ async cleanupExports(modelId: string, untilLastSeen: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResCleanupExports> {
200
+ const response = await this.cleanupExportsRaw({ modelId: modelId, untilLastSeen: untilLastSeen }, initOverrides);
201
+ return await response.value();
202
+ }
203
+
204
+ /**
205
+ * Creates request options for cleanupOutputs without sending the request
206
+ */
207
+ async cleanupOutputsRequestOpts(requestParameters: CleanupOutputsRequest): Promise<runtime.RequestOpts> {
208
+ if (requestParameters['modelId'] == null) {
209
+ throw new runtime.RequiredError(
210
+ 'modelId',
211
+ 'Required parameter "modelId" was null or undefined when calling cleanupOutputs().'
212
+ );
213
+ }
214
+
215
+ if (requestParameters['untilLastSeen'] == null) {
216
+ throw new runtime.RequiredError(
217
+ 'untilLastSeen',
218
+ 'Required parameter "untilLastSeen" was null or undefined when calling cleanupOutputs().'
219
+ );
220
+ }
221
+
222
+ const queryParameters: any = {};
223
+
224
+ if (requestParameters['untilLastSeen'] != null) {
225
+ queryParameters['untilLastSeen'] = requestParameters['untilLastSeen'];
226
+ }
227
+
228
+ const headerParameters: runtime.HTTPHeaders = {};
229
+
230
+ if (this.configuration && this.configuration.accessToken) {
231
+ const token = this.configuration.accessToken;
232
+ const tokenString = await token("JwtAuth", []);
233
+
234
+ if (tokenString) {
235
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
236
+ }
237
+ }
238
+
239
+ let urlPath = `/api/v2/model/{modelId}/cleanup/output`;
240
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
241
+
242
+ return {
243
+ path: urlPath,
244
+ method: 'POST',
245
+ headers: headerParameters,
246
+ query: queryParameters,
247
+ };
248
+ }
249
+
250
+ /**
251
+ * Permissions: * `cache.output.delete.*` - __required__.
252
+ * Delete old output components.
253
+ */
254
+ async cleanupOutputsRaw(requestParameters: CleanupOutputsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResCleanupOutputs>> {
255
+ const requestOptions = await this.cleanupOutputsRequestOpts(requestParameters);
256
+ const response = await this.request(requestOptions, initOverrides);
257
+
258
+ return new runtime.JSONApiResponse(response);
259
+ }
260
+
261
+ /**
262
+ * Permissions: * `cache.output.delete.*` - __required__.
263
+ * Delete old output components.
264
+ */
265
+ async cleanupOutputs(modelId: string, untilLastSeen: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResCleanupOutputs> {
266
+ const response = await this.cleanupOutputsRaw({ modelId: modelId, untilLastSeen: untilLastSeen }, initOverrides);
267
+ return await response.value();
268
+ }
269
+
270
+ /**
271
+ * Creates request options for cleanupTextures without sending the request
272
+ */
273
+ async cleanupTexturesRequestOpts(requestParameters: CleanupTexturesRequest): Promise<runtime.RequestOpts> {
274
+ if (requestParameters['modelId'] == null) {
275
+ throw new runtime.RequiredError(
276
+ 'modelId',
277
+ 'Required parameter "modelId" was null or undefined when calling cleanupTextures().'
278
+ );
279
+ }
280
+
281
+ if (requestParameters['untilLastSeen'] == null) {
282
+ throw new runtime.RequiredError(
283
+ 'untilLastSeen',
284
+ 'Required parameter "untilLastSeen" was null or undefined when calling cleanupTextures().'
285
+ );
286
+ }
287
+
288
+ const queryParameters: any = {};
289
+
290
+ if (requestParameters['untilLastSeen'] != null) {
291
+ queryParameters['untilLastSeen'] = requestParameters['untilLastSeen'];
292
+ }
293
+
294
+ const headerParameters: runtime.HTTPHeaders = {};
295
+
296
+ if (this.configuration && this.configuration.accessToken) {
297
+ const token = this.configuration.accessToken;
298
+ const tokenString = await token("JwtAuth", []);
299
+
300
+ if (tokenString) {
301
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
302
+ }
303
+ }
304
+
305
+ let urlPath = `/api/v2/model/{modelId}/cleanup/texture`;
306
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
307
+
308
+ return {
309
+ path: urlPath,
310
+ method: 'POST',
311
+ headers: headerParameters,
312
+ query: queryParameters,
313
+ };
314
+ }
315
+
316
+ /**
317
+ * Permissions: * `cache.texture.delete.*` - __required__.
318
+ * Delete old texture components.
319
+ */
320
+ async cleanupTexturesRaw(requestParameters: CleanupTexturesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResCleanupTextures>> {
321
+ const requestOptions = await this.cleanupTexturesRequestOpts(requestParameters);
322
+ const response = await this.request(requestOptions, initOverrides);
323
+
324
+ return new runtime.JSONApiResponse(response);
325
+ }
326
+
327
+ /**
328
+ * Permissions: * `cache.texture.delete.*` - __required__.
329
+ * Delete old texture components.
330
+ */
331
+ async cleanupTextures(modelId: string, untilLastSeen: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResCleanupTextures> {
332
+ const response = await this.cleanupTexturesRaw({ modelId: modelId, untilLastSeen: untilLastSeen }, initOverrides);
333
+ return await response.value();
334
+ }
335
+
336
+ /**
337
+ * Creates request options for createModel without sending the request
338
+ */
339
+ async createModelRequestOpts(requestParameters: CreateModelRequest): Promise<runtime.RequestOpts> {
340
+ if (requestParameters['reqModel'] == null) {
341
+ throw new runtime.RequiredError(
342
+ 'reqModel',
343
+ 'Required parameter "reqModel" was null or undefined when calling createModel().'
344
+ );
345
+ }
346
+
347
+ const queryParameters: any = {};
348
+
349
+ const headerParameters: runtime.HTTPHeaders = {};
350
+
351
+ headerParameters['Content-Type'] = 'application/json';
352
+
353
+ if (this.configuration && this.configuration.accessToken) {
354
+ const token = this.configuration.accessToken;
355
+ const tokenString = await token("JwtAuth", []);
356
+
357
+ if (tokenString) {
358
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
359
+ }
360
+ }
361
+
362
+ let urlPath = `/api/v2/model`;
363
+
364
+ return {
365
+ path: urlPath,
366
+ method: 'POST',
367
+ headers: headerParameters,
368
+ query: queryParameters,
369
+ body: requestParameters['reqModel'],
370
+ };
371
+ }
372
+
373
+ /**
374
+ * Subject-Restriction: __backend__. Permissions: * `create` - __required__ * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_ to response. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_ to response. * `setting.compute.get.*` - optional: adds _settings.compute_ to response. * `file.upload` - optional: adds _file.upload_ to response if no model has already been uploaded. * `file.download` - optional: adds _file.download_ to response. * `get.statistic.*` - optional: adds _statistic_ to response.
375
+ * Create model.
376
+ */
377
+ async createModelRaw(requestParameters: CreateModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResCreateModel>> {
378
+ const requestOptions = await this.createModelRequestOpts(requestParameters);
379
+ const response = await this.request(requestOptions, initOverrides);
380
+
381
+ return new runtime.JSONApiResponse(response);
382
+ }
383
+
384
+ /**
385
+ * Subject-Restriction: __backend__. Permissions: * `create` - __required__ * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_ to response. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_ to response. * `setting.compute.get.*` - optional: adds _settings.compute_ to response. * `file.upload` - optional: adds _file.upload_ to response if no model has already been uploaded. * `file.download` - optional: adds _file.download_ to response. * `get.statistic.*` - optional: adds _statistic_ to response.
386
+ * Create model.
387
+ */
388
+ async createModel(reqModel: ReqModel, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResCreateModel> {
389
+ const response = await this.createModelRaw({ reqModel: reqModel }, initOverrides);
390
+ return await response.value();
391
+ }
392
+
393
+ /**
394
+ * Creates request options for createModelConfig without sending the request
395
+ */
396
+ async createModelConfigRequestOpts(requestParameters: CreateModelConfigRequest): Promise<runtime.RequestOpts> {
397
+ if (requestParameters['modelId'] == null) {
398
+ throw new runtime.RequiredError(
399
+ 'modelId',
400
+ 'Required parameter "modelId" was null or undefined when calling createModelConfig().'
401
+ );
402
+ }
403
+
404
+ if (requestParameters['reqConfigure'] == null) {
405
+ throw new runtime.RequiredError(
406
+ 'reqConfigure',
407
+ 'Required parameter "reqConfigure" was null or undefined when calling createModelConfig().'
408
+ );
409
+ }
410
+
411
+ const queryParameters: any = {};
412
+
413
+ const headerParameters: runtime.HTTPHeaders = {};
414
+
415
+ headerParameters['Content-Type'] = 'application/json';
416
+
417
+ if (this.configuration && this.configuration.accessToken) {
418
+ const token = this.configuration.accessToken;
419
+ const tokenString = await token("JwtAuth", []);
420
+
421
+ if (tokenString) {
422
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
423
+ }
424
+ }
425
+
426
+ let urlPath = `/api/v2/model/{modelId}/config`;
427
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
428
+
429
+ return {
430
+ path: urlPath,
431
+ method: 'POST',
432
+ headers: headerParameters,
433
+ query: queryParameters,
434
+ body: requestParameters['reqConfigure'],
435
+ };
436
+ }
437
+
438
+ /**
439
+ * Permissions: * `setting.viewer.set.*` - __required__.
440
+ * Create model config.
441
+ */
442
+ async createModelConfigRaw(requestParameters: CreateModelConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResCreateModelConfig>> {
443
+ const requestOptions = await this.createModelConfigRequestOpts(requestParameters);
444
+ const response = await this.request(requestOptions, initOverrides);
445
+
446
+ return new runtime.JSONApiResponse(response);
447
+ }
448
+
449
+ /**
450
+ * Permissions: * `setting.viewer.set.*` - __required__.
451
+ * Create model config.
452
+ */
453
+ async createModelConfig(modelId: string, reqConfigure: ReqConfigure, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResCreateModelConfig> {
454
+ const response = await this.createModelConfigRaw({ modelId: modelId, reqConfigure: reqConfigure }, initOverrides);
455
+ return await response.value();
456
+ }
457
+
458
+ /**
459
+ * Creates request options for deleteModel without sending the request
460
+ */
461
+ async deleteModelRequestOpts(requestParameters: DeleteModelRequest): Promise<runtime.RequestOpts> {
462
+ if (requestParameters['modelId'] == null) {
463
+ throw new runtime.RequiredError(
464
+ 'modelId',
465
+ 'Required parameter "modelId" was null or undefined when calling deleteModel().'
466
+ );
467
+ }
468
+
469
+ const queryParameters: any = {};
470
+
471
+ const headerParameters: runtime.HTTPHeaders = {};
472
+
473
+ if (this.configuration && this.configuration.accessToken) {
474
+ const token = this.configuration.accessToken;
475
+ const tokenString = await token("JwtAuth", []);
476
+
477
+ if (tokenString) {
478
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
479
+ }
480
+ }
481
+
482
+ let urlPath = `/api/v2/model/{modelId}`;
483
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
484
+
485
+ return {
486
+ path: urlPath,
487
+ method: 'DELETE',
488
+ headers: headerParameters,
489
+ query: queryParameters,
490
+ };
491
+ }
492
+
493
+ /**
494
+ * Subject-Restriction: __backend__. Permissions: * `delete.soft` - __required__.
495
+ * Delete model.
496
+ */
497
+ async deleteModelRaw(requestParameters: DeleteModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResDeleteModel>> {
498
+ const requestOptions = await this.deleteModelRequestOpts(requestParameters);
499
+ const response = await this.request(requestOptions, initOverrides);
500
+
501
+ return new runtime.JSONApiResponse(response);
502
+ }
503
+
504
+ /**
505
+ * Subject-Restriction: __backend__. Permissions: * `delete.soft` - __required__.
506
+ * Delete model.
507
+ */
508
+ async deleteModel(modelId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResDeleteModel> {
509
+ const response = await this.deleteModelRaw({ modelId: modelId }, initOverrides);
510
+ return await response.value();
511
+ }
512
+
513
+ /**
514
+ * Creates request options for downloadModelFile without sending the request
515
+ */
516
+ async downloadModelFileRequestOpts(requestParameters: DownloadModelFileRequest): Promise<runtime.RequestOpts> {
517
+ if (requestParameters['modelId'] == null) {
518
+ throw new runtime.RequiredError(
519
+ 'modelId',
520
+ 'Required parameter "modelId" was null or undefined when calling downloadModelFile().'
521
+ );
522
+ }
523
+
524
+ const queryParameters: any = {};
525
+
526
+ const headerParameters: runtime.HTTPHeaders = {};
527
+
528
+ if (this.configuration && this.configuration.accessToken) {
529
+ const token = this.configuration.accessToken;
530
+ const tokenString = await token("JwtAuth", []);
531
+
532
+ if (tokenString) {
533
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
534
+ }
535
+ }
536
+
537
+ let urlPath = `/api/v2/model/{modelId}/file/download`;
538
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
539
+
540
+ return {
541
+ path: urlPath,
542
+ method: 'GET',
543
+ headers: headerParameters,
544
+ query: queryParameters,
545
+ };
546
+ }
547
+
548
+ /**
549
+ * Permissions: * `file.download` - __required__.
550
+ * Download Grasshopper file.
551
+ */
552
+ async downloadModelFileRaw(requestParameters: DownloadModelFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
553
+ const requestOptions = await this.downloadModelFileRequestOpts(requestParameters);
554
+ const response = await this.request(requestOptions, initOverrides);
555
+
556
+ return new runtime.BlobApiResponse(response);
557
+ }
558
+
559
+ /**
560
+ * Permissions: * `file.download` - __required__.
561
+ * Download Grasshopper file.
562
+ */
563
+ async downloadModelFile(modelId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
564
+ const response = await this.downloadModelFileRaw({ modelId: modelId }, initOverrides);
565
+ return await response.value();
566
+ }
567
+
568
+ /**
569
+ * Creates request options for getCleanupStatus without sending the request
570
+ */
571
+ async getCleanupStatusRequestOpts(requestParameters: GetCleanupStatusRequest): Promise<runtime.RequestOpts> {
572
+ if (requestParameters['modelId'] == null) {
573
+ throw new runtime.RequiredError(
574
+ 'modelId',
575
+ 'Required parameter "modelId" was null or undefined when calling getCleanupStatus().'
576
+ );
577
+ }
578
+
579
+ const queryParameters: any = {};
580
+
581
+ const headerParameters: runtime.HTTPHeaders = {};
582
+
583
+ if (this.configuration && this.configuration.accessToken) {
584
+ const token = this.configuration.accessToken;
585
+ const tokenString = await token("JwtAuth", []);
586
+
587
+ if (tokenString) {
588
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
589
+ }
590
+ }
591
+
592
+ let urlPath = `/api/v2/model/{modelId}/cleanup/status`;
593
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
594
+
595
+ return {
596
+ path: urlPath,
597
+ method: 'GET',
598
+ headers: headerParameters,
599
+ query: queryParameters,
600
+ };
601
+ }
602
+
603
+ /**
604
+ *
605
+ * Get the status of all running model cleanup processes.
606
+ */
607
+ async getCleanupStatusRaw(requestParameters: GetCleanupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResGetCleanupStatus>> {
608
+ const requestOptions = await this.getCleanupStatusRequestOpts(requestParameters);
609
+ const response = await this.request(requestOptions, initOverrides);
610
+
611
+ return new runtime.JSONApiResponse(response);
612
+ }
613
+
614
+ /**
615
+ *
616
+ * Get the status of all running model cleanup processes.
617
+ */
618
+ async getCleanupStatus(modelId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResGetCleanupStatus> {
619
+ const response = await this.getCleanupStatusRaw({ modelId: modelId }, initOverrides);
620
+ return await response.value();
621
+ }
622
+
623
+ /**
624
+ * Creates request options for getModel without sending the request
625
+ */
626
+ async getModelRequestOpts(requestParameters: GetModelRequest): Promise<runtime.RequestOpts> {
627
+ if (requestParameters['modelId'] == null) {
628
+ throw new runtime.RequiredError(
629
+ 'modelId',
630
+ 'Required parameter "modelId" was null or undefined when calling getModel().'
631
+ );
632
+ }
633
+
634
+ const queryParameters: any = {};
635
+
636
+ const headerParameters: runtime.HTTPHeaders = {};
637
+
638
+ if (this.configuration && this.configuration.accessToken) {
639
+ const token = this.configuration.accessToken;
640
+ const tokenString = await token("JwtAuth", []);
641
+
642
+ if (tokenString) {
643
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
644
+ }
645
+ }
646
+
647
+ let urlPath = `/api/v2/model/{modelId}`;
648
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
649
+
650
+ return {
651
+ path: urlPath,
652
+ method: 'GET',
653
+ headers: headerParameters,
654
+ query: queryParameters,
655
+ };
656
+ }
657
+
658
+ /**
659
+ * Permissions: * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_. * `setting.compute.get.*` - optional: adds _settings.compute_. * `file.upload` - optional: adds _file.upload_. * `file.download` - optional: adds _file.download_. * `get.statistic.*` - optional: adds _statistic_. * `setting.viewer.get.*` - optional: adds _viewer_. * `get.parameter.*` - optional: adds _parameters_. * `get.output*` - optional: adds _output definitions_. * `get.export*` - optional: adds _export definitions_.
660
+ * Get model.
661
+ */
662
+ async getModelRaw(requestParameters: GetModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResGetModel>> {
663
+ const requestOptions = await this.getModelRequestOpts(requestParameters);
664
+ const response = await this.request(requestOptions, initOverrides);
665
+
666
+ return new runtime.JSONApiResponse(response);
667
+ }
668
+
669
+ /**
670
+ * Permissions: * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_. * `setting.compute.get.*` - optional: adds _settings.compute_. * `file.upload` - optional: adds _file.upload_. * `file.download` - optional: adds _file.download_. * `get.statistic.*` - optional: adds _statistic_. * `setting.viewer.get.*` - optional: adds _viewer_. * `get.parameter.*` - optional: adds _parameters_. * `get.output*` - optional: adds _output definitions_. * `get.export*` - optional: adds _export definitions_.
671
+ * Get model.
672
+ */
673
+ async getModel(modelId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResGetModel> {
674
+ const response = await this.getModelRaw({ modelId: modelId }, initOverrides);
675
+ return await response.value();
676
+ }
677
+
678
+ /**
679
+ * Creates request options for getModelComputations without sending the request
680
+ */
681
+ async getModelComputationsRequestOpts(requestParameters: GetModelComputationsRequest): Promise<runtime.RequestOpts> {
682
+ if (requestParameters['modelId'] == null) {
683
+ throw new runtime.RequiredError(
684
+ 'modelId',
685
+ 'Required parameter "modelId" was null or undefined when calling getModelComputations().'
686
+ );
687
+ }
688
+
689
+ const queryParameters: any = {};
690
+
691
+ if (requestParameters['order'] != null) {
692
+ queryParameters['order'] = requestParameters['order'];
693
+ }
694
+
695
+ if (requestParameters['timestampFrom'] != null) {
696
+ queryParameters['timestamp_from'] = requestParameters['timestampFrom'];
697
+ }
698
+
699
+ if (requestParameters['timestampTo'] != null) {
700
+ queryParameters['timestamp_to'] = requestParameters['timestampTo'];
701
+ }
702
+
703
+ if (requestParameters['status'] != null) {
704
+ queryParameters['status'] = requestParameters['status'];
705
+ }
706
+
707
+ if (requestParameters['type'] != null) {
708
+ queryParameters['type'] = requestParameters['type'];
709
+ }
710
+
711
+ if (requestParameters['limit'] != null) {
712
+ queryParameters['limit'] = requestParameters['limit'];
713
+ }
714
+
715
+ if (requestParameters['strictLimit'] != null) {
716
+ queryParameters['strict_limit'] = requestParameters['strictLimit'];
717
+ }
718
+
719
+ if (requestParameters['offset'] != null) {
720
+ queryParameters['offset'] = requestParameters['offset'];
721
+ }
722
+
723
+ const headerParameters: runtime.HTTPHeaders = {};
724
+
725
+ if (this.configuration && this.configuration.accessToken) {
726
+ const token = this.configuration.accessToken;
727
+ const tokenString = await token("JwtAuth", []);
728
+
729
+ if (tokenString) {
730
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
731
+ }
732
+ }
733
+
734
+ let urlPath = `/api/v2/model/{modelId}/computations`;
735
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
736
+
737
+ return {
738
+ path: urlPath,
739
+ method: 'GET',
740
+ headers: headerParameters,
741
+ query: queryParameters,
742
+ };
743
+ }
744
+
745
+ /**
746
+ * Permissions: * `analytics.model.get.*` - __required__.
747
+ * Get model computation statistics.
748
+ */
749
+ async getModelComputationsRaw(requestParameters: GetModelComputationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResGetModelComputations>> {
750
+ const requestOptions = await this.getModelComputationsRequestOpts(requestParameters);
751
+ const response = await this.request(requestOptions, initOverrides);
752
+
753
+ return new runtime.JSONApiResponse(response);
754
+ }
755
+
756
+ /**
757
+ * Permissions: * `analytics.model.get.*` - __required__.
758
+ * Get model computation statistics.
759
+ */
760
+ async getModelComputations(modelId: string, order?: QueryOrder, timestampFrom?: string, timestampTo?: string, status?: QueryComputationStatisticsStatus, type?: QueryComputationType, limit?: number, strictLimit?: boolean, offset?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResGetModelComputations> {
761
+ const response = await this.getModelComputationsRaw({ modelId: modelId, order: order, timestampFrom: timestampFrom, timestampTo: timestampTo, status: status, type: type, limit: limit, strictLimit: strictLimit, offset: offset }, initOverrides);
762
+ return await response.value();
763
+ }
764
+
765
+ /**
766
+ * Creates request options for getModelConfig without sending the request
767
+ */
768
+ async getModelConfigRequestOpts(requestParameters: GetModelConfigRequest): Promise<runtime.RequestOpts> {
769
+ if (requestParameters['modelId'] == null) {
770
+ throw new runtime.RequiredError(
771
+ 'modelId',
772
+ 'Required parameter "modelId" was null or undefined when calling getModelConfig().'
773
+ );
774
+ }
775
+
776
+ const queryParameters: any = {};
777
+
778
+ const headerParameters: runtime.HTTPHeaders = {};
779
+
780
+ if (requestParameters['xShapediverNoconvert'] != null) {
781
+ headerParameters['x-shapediver-noconvert'] = String(requestParameters['xShapediverNoconvert']);
782
+ }
783
+
784
+ if (requestParameters['xShapediverUseconfigversion'] != null) {
785
+ headerParameters['x-shapediver-useconfigversion'] = String(requestParameters['xShapediverUseconfigversion']);
786
+ }
787
+
788
+ if (requestParameters['xShapediverBuildversion'] != null) {
789
+ headerParameters['x-shapediver-buildversion'] = String(requestParameters['xShapediverBuildversion']);
790
+ }
791
+
792
+ if (this.configuration && this.configuration.accessToken) {
793
+ const token = this.configuration.accessToken;
794
+ const tokenString = await token("JwtAuth", []);
795
+
796
+ if (tokenString) {
797
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
798
+ }
799
+ }
800
+
801
+ let urlPath = `/api/v2/model/{modelId}/config`;
802
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
803
+
804
+ return {
805
+ path: urlPath,
806
+ method: 'GET',
807
+ headers: headerParameters,
808
+ query: queryParameters,
809
+ };
810
+ }
811
+
812
+ /**
813
+ * Permissions: * `setting.viewer.get.*` - __required__.
814
+ * Get model config.
815
+ */
816
+ async getModelConfigRaw(requestParameters: GetModelConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResGetModelConfig>> {
817
+ const requestOptions = await this.getModelConfigRequestOpts(requestParameters);
818
+ const response = await this.request(requestOptions, initOverrides);
819
+
820
+ return new runtime.JSONApiResponse(response);
821
+ }
822
+
823
+ /**
824
+ * Permissions: * `setting.viewer.get.*` - __required__.
825
+ * Get model config.
826
+ */
827
+ async getModelConfig(modelId: string, xShapediverNoconvert?: boolean, xShapediverUseconfigversion?: string, xShapediverBuildversion?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResGetModelConfig> {
828
+ const response = await this.getModelConfigRaw({ modelId: modelId, xShapediverNoconvert: xShapediverNoconvert, xShapediverUseconfigversion: xShapediverUseconfigversion, xShapediverBuildversion: xShapediverBuildversion }, initOverrides);
829
+ return await response.value();
830
+ }
831
+
832
+ /**
833
+ * Creates request options for listModels without sending the request
834
+ */
835
+ async listModelsRequestOpts(requestParameters: ListModelsRequest): Promise<runtime.RequestOpts> {
836
+ const queryParameters: any = {};
837
+
838
+ if (requestParameters['modelStatus'] != null) {
839
+ queryParameters['modelStatus'] = requestParameters['modelStatus'];
840
+ }
841
+
842
+ if (requestParameters['offset'] != null) {
843
+ queryParameters['offset'] = requestParameters['offset'];
844
+ }
845
+
846
+ const headerParameters: runtime.HTTPHeaders = {};
847
+
848
+ if (this.configuration && this.configuration.accessToken) {
849
+ const token = this.configuration.accessToken;
850
+ const tokenString = await token("JwtAuth", []);
851
+
852
+ if (tokenString) {
853
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
854
+ }
855
+ }
856
+
857
+ let urlPath = `/api/v2/model/list`;
858
+
859
+ return {
860
+ path: urlPath,
861
+ method: 'GET',
862
+ headers: headerParameters,
863
+ query: queryParameters,
864
+ };
865
+ }
866
+
867
+ /**
868
+ * Subject-Restriction: __backend__.
869
+ * List models.
870
+ */
871
+ async listModelsRaw(requestParameters: ListModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResListModels>> {
872
+ const requestOptions = await this.listModelsRequestOpts(requestParameters);
873
+ const response = await this.request(requestOptions, initOverrides);
874
+
875
+ return new runtime.JSONApiResponse(response);
876
+ }
877
+
878
+ /**
879
+ * Subject-Restriction: __backend__.
880
+ * List models.
881
+ */
882
+ async listModels(modelStatus?: QueryModelStatus, offset?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResListModels> {
883
+ const response = await this.listModelsRaw({ modelStatus: modelStatus, offset: offset }, initOverrides);
884
+ return await response.value();
885
+ }
886
+
887
+ /**
888
+ * Creates request options for restoreModel without sending the request
889
+ */
890
+ async restoreModelRequestOpts(requestParameters: RestoreModelRequest): Promise<runtime.RequestOpts> {
891
+ if (requestParameters['modelId'] == null) {
892
+ throw new runtime.RequiredError(
893
+ 'modelId',
894
+ 'Required parameter "modelId" was null or undefined when calling restoreModel().'
895
+ );
896
+ }
897
+
898
+ const queryParameters: any = {};
899
+
900
+ const headerParameters: runtime.HTTPHeaders = {};
901
+
902
+ if (this.configuration && this.configuration.accessToken) {
903
+ const token = this.configuration.accessToken;
904
+ const tokenString = await token("JwtAuth", []);
905
+
906
+ if (tokenString) {
907
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
908
+ }
909
+ }
910
+
911
+ let urlPath = `/api/v2/model/{modelId}/restore`;
912
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
913
+
914
+ return {
915
+ path: urlPath,
916
+ method: 'PUT',
917
+ headers: headerParameters,
918
+ query: queryParameters,
919
+ };
920
+ }
921
+
922
+ /**
923
+ * Subject-Restriction: __backend__.
924
+ * Restore a soft-deleted model.
925
+ */
926
+ async restoreModelRaw(requestParameters: RestoreModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResDeleteModel>> {
927
+ const requestOptions = await this.restoreModelRequestOpts(requestParameters);
928
+ const response = await this.request(requestOptions, initOverrides);
929
+
930
+ return new runtime.JSONApiResponse(response);
931
+ }
932
+
933
+ /**
934
+ * Subject-Restriction: __backend__.
935
+ * Restore a soft-deleted model.
936
+ */
937
+ async restoreModel(modelId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResDeleteModel> {
938
+ const response = await this.restoreModelRaw({ modelId: modelId }, initOverrides);
939
+ return await response.value();
940
+ }
941
+
942
+ /**
943
+ * Creates request options for updateModel without sending the request
944
+ */
945
+ async updateModelRequestOpts(requestParameters: UpdateModelRequest): Promise<runtime.RequestOpts> {
946
+ if (requestParameters['modelId'] == null) {
947
+ throw new runtime.RequiredError(
948
+ 'modelId',
949
+ 'Required parameter "modelId" was null or undefined when calling updateModel().'
950
+ );
951
+ }
952
+
953
+ if (requestParameters['reqModel'] == null) {
954
+ throw new runtime.RequiredError(
955
+ 'reqModel',
956
+ 'Required parameter "reqModel" was null or undefined when calling updateModel().'
957
+ );
958
+ }
959
+
960
+ const queryParameters: any = {};
961
+
962
+ const headerParameters: runtime.HTTPHeaders = {};
963
+
964
+ headerParameters['Content-Type'] = 'application/json';
965
+
966
+ if (this.configuration && this.configuration.accessToken) {
967
+ const token = this.configuration.accessToken;
968
+ const tokenString = await token("JwtAuth", []);
969
+
970
+ if (tokenString) {
971
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
972
+ }
973
+ }
974
+
975
+ let urlPath = `/api/v2/model/{modelId}`;
976
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
977
+
978
+ return {
979
+ path: urlPath,
980
+ method: 'PUT',
981
+ headers: headerParameters,
982
+ query: queryParameters,
983
+ body: requestParameters['reqModel'],
984
+ };
985
+ }
986
+
987
+ /**
988
+ * Permissions: * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_ to response. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_ to response. * `setting.compute.get.*` - optional: adds _settings.compute_ to response. * `file.upload` - optional: adds _file.upload_ to response. * `file.download` - optional: adds _file.download_ to response. * `get.statistic.*` - optional: adds _statistic_ to response.
989
+ * Update model.
990
+ */
991
+ async updateModelRaw(requestParameters: UpdateModelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResUpdateModel>> {
992
+ const requestOptions = await this.updateModelRequestOpts(requestParameters);
993
+ const response = await this.request(requestOptions, initOverrides);
994
+
995
+ return new runtime.JSONApiResponse(response);
996
+ }
997
+
998
+ /**
999
+ * Permissions: * `setting.auth.ticket.get.*` - optional: adds _settings.auth.ticket_ to response. * `setting.auth.token.get.*` - optional: adds _settings.auth.token_ to response. * `setting.compute.get.*` - optional: adds _settings.compute_ to response. * `file.upload` - optional: adds _file.upload_ to response. * `file.download` - optional: adds _file.download_ to response. * `get.statistic.*` - optional: adds _statistic_ to response.
1000
+ * Update model.
1001
+ */
1002
+ async updateModel(modelId: string, reqModel: ReqModel, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResUpdateModel> {
1003
+ const response = await this.updateModelRaw({ modelId: modelId, reqModel: reqModel }, initOverrides);
1004
+ return await response.value();
1005
+ }
1006
+
1007
+ /**
1008
+ * Creates request options for updateModelConfig without sending the request
1009
+ */
1010
+ async updateModelConfigRequestOpts(requestParameters: UpdateModelConfigRequest): Promise<runtime.RequestOpts> {
1011
+ if (requestParameters['modelId'] == null) {
1012
+ throw new runtime.RequiredError(
1013
+ 'modelId',
1014
+ 'Required parameter "modelId" was null or undefined when calling updateModelConfig().'
1015
+ );
1016
+ }
1017
+
1018
+ if (requestParameters['reqConfigure'] == null) {
1019
+ throw new runtime.RequiredError(
1020
+ 'reqConfigure',
1021
+ 'Required parameter "reqConfigure" was null or undefined when calling updateModelConfig().'
1022
+ );
1023
+ }
1024
+
1025
+ const queryParameters: any = {};
1026
+
1027
+ const headerParameters: runtime.HTTPHeaders = {};
1028
+
1029
+ headerParameters['Content-Type'] = 'application/json';
1030
+
1031
+ if (this.configuration && this.configuration.accessToken) {
1032
+ const token = this.configuration.accessToken;
1033
+ const tokenString = await token("JwtAuth", []);
1034
+
1035
+ if (tokenString) {
1036
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1037
+ }
1038
+ }
1039
+
1040
+ let urlPath = `/api/v2/model/{modelId}/config`;
1041
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
1042
+
1043
+ return {
1044
+ path: urlPath,
1045
+ method: 'PATCH',
1046
+ headers: headerParameters,
1047
+ query: queryParameters,
1048
+ body: requestParameters['reqConfigure'],
1049
+ };
1050
+ }
1051
+
1052
+ /**
1053
+ * Updating the model configuration requires _model authoring privilege_. Permissions: * `setting.viewer.set.*` - __required__.
1054
+ * Update model config.
1055
+ */
1056
+ async updateModelConfigRaw(requestParameters: UpdateModelConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResUpdateModelConfig>> {
1057
+ const requestOptions = await this.updateModelConfigRequestOpts(requestParameters);
1058
+ const response = await this.request(requestOptions, initOverrides);
1059
+
1060
+ return new runtime.JSONApiResponse(response);
1061
+ }
1062
+
1063
+ /**
1064
+ * Updating the model configuration requires _model authoring privilege_. Permissions: * `setting.viewer.set.*` - __required__.
1065
+ * Update model config.
1066
+ */
1067
+ async updateModelConfig(modelId: string, reqConfigure: ReqConfigure, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResUpdateModelConfig> {
1068
+ const response = await this.updateModelConfigRaw({ modelId: modelId, reqConfigure: reqConfigure }, initOverrides);
1069
+ return await response.value();
1070
+ }
1071
+
1072
+ /**
1073
+ * Creates request options for updateParameterDefaultValues without sending the request
1074
+ */
1075
+ async updateParameterDefaultValuesRequestOpts(requestParameters: UpdateParameterDefaultValuesRequest): Promise<runtime.RequestOpts> {
1076
+ if (requestParameters['modelId'] == null) {
1077
+ throw new runtime.RequiredError(
1078
+ 'modelId',
1079
+ 'Required parameter "modelId" was null or undefined when calling updateParameterDefaultValues().'
1080
+ );
1081
+ }
1082
+
1083
+ if (requestParameters['reqCustomization'] == null) {
1084
+ throw new runtime.RequiredError(
1085
+ 'reqCustomization',
1086
+ 'Required parameter "reqCustomization" was null or undefined when calling updateParameterDefaultValues().'
1087
+ );
1088
+ }
1089
+
1090
+ const queryParameters: any = {};
1091
+
1092
+ if (requestParameters['ignoreUnknownParams'] != null) {
1093
+ queryParameters['ignoreUnknownParams'] = requestParameters['ignoreUnknownParams'];
1094
+ }
1095
+
1096
+ const headerParameters: runtime.HTTPHeaders = {};
1097
+
1098
+ headerParameters['Content-Type'] = 'application/json';
1099
+
1100
+ if (this.configuration && this.configuration.accessToken) {
1101
+ const token = this.configuration.accessToken;
1102
+ const tokenString = await token("JwtAuth", []);
1103
+
1104
+ if (tokenString) {
1105
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1106
+ }
1107
+ }
1108
+
1109
+ let urlPath = `/api/v2/model/{modelId}/parameter/defval`;
1110
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
1111
+
1112
+ return {
1113
+ path: urlPath,
1114
+ method: 'PATCH',
1115
+ headers: headerParameters,
1116
+ query: queryParameters,
1117
+ body: requestParameters['reqCustomization'],
1118
+ };
1119
+ }
1120
+
1121
+ /**
1122
+ * Updating default parameter values requires model authoring privilege. Permissions: * `set.parameter.defval` - __required__.
1123
+ * Update default value of parameters.
1124
+ */
1125
+ async updateParameterDefaultValuesRaw(requestParameters: UpdateParameterDefaultValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResUpdateParameterDefaultValues>> {
1126
+ const requestOptions = await this.updateParameterDefaultValuesRequestOpts(requestParameters);
1127
+ const response = await this.request(requestOptions, initOverrides);
1128
+
1129
+ return new runtime.JSONApiResponse(response);
1130
+ }
1131
+
1132
+ /**
1133
+ * Updating default parameter values requires model authoring privilege. Permissions: * `set.parameter.defval` - __required__.
1134
+ * Update default value of parameters.
1135
+ */
1136
+ async updateParameterDefaultValues(modelId: string, reqCustomization: ReqCustomization, ignoreUnknownParams?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResUpdateParameterDefaultValues> {
1137
+ const response = await this.updateParameterDefaultValuesRaw({ modelId: modelId, reqCustomization: reqCustomization, ignoreUnknownParams: ignoreUnknownParams }, initOverrides);
1138
+ return await response.value();
1139
+ }
1140
+
1141
+ /**
1142
+ * Creates request options for updateParameterDefinitions without sending the request
1143
+ */
1144
+ async updateParameterDefinitionsRequestOpts(requestParameters: UpdateParameterDefinitionsRequest): Promise<runtime.RequestOpts> {
1145
+ if (requestParameters['modelId'] == null) {
1146
+ throw new runtime.RequiredError(
1147
+ 'modelId',
1148
+ 'Required parameter "modelId" was null or undefined when calling updateParameterDefinitions().'
1149
+ );
1150
+ }
1151
+
1152
+ if (requestParameters['reqParameterDefinitions'] == null) {
1153
+ throw new runtime.RequiredError(
1154
+ 'reqParameterDefinitions',
1155
+ 'Required parameter "reqParameterDefinitions" was null or undefined when calling updateParameterDefinitions().'
1156
+ );
1157
+ }
1158
+
1159
+ const queryParameters: any = {};
1160
+
1161
+ const headerParameters: runtime.HTTPHeaders = {};
1162
+
1163
+ headerParameters['Content-Type'] = 'application/json';
1164
+
1165
+ if (this.configuration && this.configuration.accessToken) {
1166
+ const token = this.configuration.accessToken;
1167
+ const tokenString = await token("JwtAuth", []);
1168
+
1169
+ if (tokenString) {
1170
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1171
+ }
1172
+ }
1173
+
1174
+ let urlPath = `/api/v2/model/{modelId}/parameter`;
1175
+ urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
1176
+
1177
+ return {
1178
+ path: urlPath,
1179
+ method: 'PATCH',
1180
+ headers: headerParameters,
1181
+ query: queryParameters,
1182
+ body: requestParameters['reqParameterDefinitions'],
1183
+ };
1184
+ }
1185
+
1186
+ /**
1187
+ * Permissions: * `set.parameter.ui` - __required__.
1188
+ * Update definition of parameters.
1189
+ */
1190
+ async updateParameterDefinitionsRaw(requestParameters: UpdateParameterDefinitionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResUpdateParameterDefinitions>> {
1191
+ const requestOptions = await this.updateParameterDefinitionsRequestOpts(requestParameters);
1192
+ const response = await this.request(requestOptions, initOverrides);
1193
+
1194
+ return new runtime.JSONApiResponse(response);
1195
+ }
1196
+
1197
+ /**
1198
+ * Permissions: * `set.parameter.ui` - __required__.
1199
+ * Update definition of parameters.
1200
+ */
1201
+ async updateParameterDefinitions(modelId: string, reqParameterDefinitions: ReqParameterDefinitions, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResUpdateParameterDefinitions> {
1202
+ const response = await this.updateParameterDefinitionsRaw({ modelId: modelId, reqParameterDefinitions: reqParameterDefinitions }, initOverrides);
1203
+ return await response.value();
1204
+ }
1205
+
1206
+ }