@cosmotech/api-ts 5.0.0-rc2 → 5.0.0-rc4

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/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 5.0.0-rc2
5
+ * The version of the OpenAPI document: 5.0.0-rc4
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Cosmo Tech Platform API
6
6
  * Cosmo Tech Platform API
7
7
  *
8
- * The version of the OpenAPI document: 5.0.0-rc2
8
+ * The version of the OpenAPI document: 5.0.0-rc4
9
9
  * Contact: platform@cosmotech.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,21 +31,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
31
31
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
32
32
  var axios_1 = require("axios");
33
33
  exports.BASE_PATH = "http://localhost:8080".replace(/\/+$/, "");
34
- /**
35
- *
36
- * @export
37
- */
38
34
  exports.COLLECTION_FORMATS = {
39
35
  csv: ",",
40
36
  ssv: " ",
41
37
  tsv: "\t",
42
38
  pipes: "|",
43
39
  };
44
- /**
45
- *
46
- * @export
47
- * @class BaseAPI
48
- */
49
40
  var BaseAPI = /** @class */ (function () {
50
41
  function BaseAPI(configuration, basePath, axios) {
51
42
  if (basePath === void 0) { basePath = exports.BASE_PATH; }
@@ -62,12 +53,6 @@ var BaseAPI = /** @class */ (function () {
62
53
  }());
63
54
  exports.BaseAPI = BaseAPI;
64
55
  ;
65
- /**
66
- *
67
- * @export
68
- * @class RequiredError
69
- * @extends {Error}
70
- */
71
56
  var RequiredError = /** @class */ (function (_super) {
72
57
  __extends(RequiredError, _super);
73
58
  function RequiredError(field, msg) {
@@ -79,8 +64,4 @@ var RequiredError = /** @class */ (function (_super) {
79
64
  return RequiredError;
80
65
  }(Error));
81
66
  exports.RequiredError = RequiredError;
82
- /**
83
- *
84
- * @export
85
- */
86
67
  exports.operationServerMap = {};
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 5.0.0-rc2
5
+ * The version of the OpenAPI document: 5.0.0-rc4
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Cosmo Tech Platform API
6
6
  * Cosmo Tech Platform API
7
7
  *
8
- * The version of the OpenAPI document: 5.0.0-rc2
8
+ * The version of the OpenAPI document: 5.0.0-rc4
9
9
  * Contact: platform@cosmotech.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,15 +62,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
62
62
  Object.defineProperty(exports, "__esModule", { value: true });
63
63
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
64
64
  var base_1 = require("./base");
65
- /**
66
- *
67
- * @export
68
- */
69
65
  exports.DUMMY_BASE_URL = 'https://example.com';
70
66
  /**
71
67
  *
72
68
  * @throws {RequiredError}
73
- * @export
74
69
  */
75
70
  var assertParamExists = function (functionName, paramName, paramValue) {
76
71
  if (paramValue === null || paramValue === undefined) {
@@ -78,10 +73,6 @@ var assertParamExists = function (functionName, paramName, paramValue) {
78
73
  }
79
74
  };
80
75
  exports.assertParamExists = assertParamExists;
81
- /**
82
- *
83
- * @export
84
- */
85
76
  var setApiKeyToObject = function (object, keyParamName, configuration) {
86
77
  return __awaiter(this, void 0, void 0, function () {
87
78
  var localVarApiKeyValue, _a;
@@ -108,20 +99,12 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
108
99
  });
109
100
  };
110
101
  exports.setApiKeyToObject = setApiKeyToObject;
111
- /**
112
- *
113
- * @export
114
- */
115
102
  var setBasicAuthToObject = function (object, configuration) {
116
103
  if (configuration && (configuration.username || configuration.password)) {
117
104
  object["auth"] = { username: configuration.username, password: configuration.password };
118
105
  }
119
106
  };
120
107
  exports.setBasicAuthToObject = setBasicAuthToObject;
121
- /**
122
- *
123
- * @export
124
- */
125
108
  var setBearerAuthToObject = function (object, configuration) {
126
109
  return __awaiter(this, void 0, void 0, function () {
127
110
  var accessToken, _a;
@@ -148,10 +131,6 @@ var setBearerAuthToObject = function (object, configuration) {
148
131
  });
149
132
  };
150
133
  exports.setBearerAuthToObject = setBearerAuthToObject;
151
- /**
152
- *
153
- * @export
154
- */
155
134
  var setOAuthToObject = function (object, name, scopes, configuration) {
156
135
  return __awaiter(this, void 0, void 0, function () {
157
136
  var localVarAccessTokenValue, _a;
@@ -201,10 +180,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
201
180
  }
202
181
  }
203
182
  }
204
- /**
205
- *
206
- * @export
207
- */
208
183
  var setSearchParams = function (url) {
209
184
  var objects = [];
210
185
  for (var _i = 1; _i < arguments.length; _i++) {
@@ -215,10 +190,6 @@ var setSearchParams = function (url) {
215
190
  url.search = searchParams.toString();
216
191
  };
217
192
  exports.setSearchParams = setSearchParams;
218
- /**
219
- *
220
- * @export
221
- */
222
193
  var serializeDataIfNeeded = function (value, requestOptions, configuration) {
223
194
  var nonString = typeof value !== 'string';
224
195
  var needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -229,18 +200,10 @@ var serializeDataIfNeeded = function (value, requestOptions, configuration) {
229
200
  : (value || "");
230
201
  };
231
202
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
232
- /**
233
- *
234
- * @export
235
- */
236
203
  var toPathString = function (url) {
237
204
  return url.pathname + url.search + url.hash;
238
205
  };
239
206
  exports.toPathString = toPathString;
240
- /**
241
- *
242
- * @export
243
- */
244
207
  var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
245
208
  return function (axios, basePath) {
246
209
  var _a;
@@ -2,18 +2,30 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 5.0.0-rc2
5
+ * The version of the OpenAPI document: 5.0.0-rc4
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -23,49 +35,43 @@ export declare class Configuration {
23
35
  /**
24
36
  * parameter for apiKey security
25
37
  * @param name security name
26
- * @memberof Configuration
27
38
  */
28
39
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
40
  /**
30
41
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
42
  */
35
43
  username?: string;
36
44
  /**
37
45
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
46
  */
42
47
  password?: string;
43
48
  /**
44
49
  * parameter for oauth2 security
45
50
  * @param name security name
46
51
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
52
  */
49
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
54
  /**
51
- * override base path
52
- *
53
- * @type {string}
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
54
62
  * @memberof Configuration
55
63
  */
64
+ awsv4?: AWSv4Configuration;
65
+ /**
66
+ * override base path
67
+ */
56
68
  basePath?: string;
57
69
  /**
58
70
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
71
  */
63
72
  serverIndex?: number;
64
73
  /**
65
74
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
75
  */
70
76
  baseOptions?: any;
71
77
  /**
@@ -89,3 +95,4 @@ export declare class Configuration {
89
95
  */
90
96
  isJsonMime(mime: string): boolean;
91
97
  }
98
+ export {};
@@ -1,11 +1,10 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
- /* eslint-disable */
4
3
  /**
5
4
  * Cosmo Tech Platform API
6
5
  * Cosmo Tech Platform API
7
6
  *
8
- * The version of the OpenAPI document: 5.0.0-rc2
7
+ * The version of the OpenAPI document: 5.0.0-rc4
9
8
  * Contact: platform@cosmotech.com
10
9
  *
11
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -33,6 +32,7 @@ var Configuration = /** @class */ (function () {
33
32
  this.username = param.username;
34
33
  this.password = param.password;
35
34
  this.accessToken = param.accessToken;
35
+ this.awsv4 = param.awsv4;
36
36
  this.basePath = param.basePath;
37
37
  this.serverIndex = param.serverIndex;
38
38
  this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Cosmo Tech Platform API
3
3
  * Cosmo Tech Platform API
4
4
  *
5
- * The version of the OpenAPI document: 5.0.0-rc2
5
+ * The version of the OpenAPI document: 5.0.0-rc4
6
6
  * Contact: platform@cosmotech.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Cosmo Tech Platform API
6
6
  * Cosmo Tech Platform API
7
7
  *
8
- * The version of the OpenAPI document: 5.0.0-rc2
8
+ * The version of the OpenAPI document: 5.0.0-rc4
9
9
  * Contact: platform@cosmotech.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -748,7 +748,7 @@ const { status, data } = await apiInstance.listDatasetSecurityUsers(
748
748
  ### HTTP request headers
749
749
 
750
750
  - **Content-Type**: Not defined
751
- - **Accept**: application/json
751
+ - **Accept**: application/json, application/yaml
752
752
 
753
753
 
754
754
  ### HTTP response details
@@ -1038,7 +1038,7 @@ const { status, data } = await apiInstance.searchDatasetParts(
1038
1038
  ### HTTP request headers
1039
1039
 
1040
1040
  - **Content-Type**: application/json, application/yaml
1041
- - **Accept**: application/json
1041
+ - **Accept**: application/json, application/yaml
1042
1042
 
1043
1043
 
1044
1044
  ### HTTP response details
@@ -1103,7 +1103,7 @@ const { status, data } = await apiInstance.searchDatasets(
1103
1103
  ### HTTP request headers
1104
1104
 
1105
1105
  - **Content-Type**: application/json, application/yaml
1106
- - **Accept**: application/json
1106
+ - **Accept**: application/json, application/yaml
1107
1107
 
1108
1108
 
1109
1109
  ### HTTP response details
@@ -1296,7 +1296,7 @@ const { status, data } = await apiInstance.updateDatasetDefaultSecurity(
1296
1296
  ### HTTP request headers
1297
1297
 
1298
1298
  - **Content-Type**: application/json, application/yaml
1299
- - **Accept**: application/json
1299
+ - **Accept**: application/json, application/yaml
1300
1300
 
1301
1301
 
1302
1302
  ### HTTP response details
package/docs/Runner.md CHANGED
@@ -22,9 +22,9 @@ Name | Type | Description | Notes
22
22
  **runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
23
23
  **additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
24
24
  **datasets** | [**RunnerDatasets**](RunnerDatasets.md) | definition of datasets used by the runner | [default to undefined]
25
- **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
25
+ **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | definition of resources needed for the runner run | [optional] [default to undefined]
26
26
  **parametersValues** | [**Array&lt;RunnerRunTemplateParameterValue&gt;**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [default to undefined]
27
- **lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) | | [default to undefined]
27
+ **lastRunInfo** | [**LastRunInfo**](LastRunInfo.md) | last run info from current runner | [default to undefined]
28
28
  **validationStatus** | [**RunnerValidationStatus**](RunnerValidationStatus.md) | | [default to undefined]
29
29
  **security** | [**RunnerSecurity**](RunnerSecurity.md) | | [default to undefined]
30
30
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **parentId** | **string** | the Runner parent id | [optional] [default to undefined]
14
14
  **runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [default to undefined]
15
15
  **datasetList** | **Array&lt;string&gt;** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
16
- **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
16
+ **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | definition of resources needed for the runner run | [optional] [default to undefined]
17
17
  **parametersValues** | [**Array&lt;RunnerRunTemplateParameterValue&gt;**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
18
18
  **additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
19
19
  **solutionName** | **string** | the Solution name | [optional] [default to undefined]
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
  **tags** | **Array&lt;string&gt;** | the list of tags | [optional] [default to undefined]
12
12
  **runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [optional] [default to undefined]
13
13
  **datasetList** | **Array&lt;string&gt;** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
14
- **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | | [optional] [default to undefined]
14
+ **runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) | definition of resources needed for the runner run | [optional] [default to undefined]
15
15
  **parametersValues** | [**Array&lt;RunnerRunTemplateParameterValue&gt;**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
16
16
  **additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
17
17
  **solutionName** | **string** | the Solution name | [optional] [default to undefined]
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Cosmo Tech Platform API
5
5
  * Cosmo Tech Platform API
6
6
  *
7
- * The version of the OpenAPI document: 5.0.0-rc2
7
+ * The version of the OpenAPI document: 5.0.0-rc4
8
8
  * Contact: platform@cosmotech.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cosmotech/api-ts",
3
- "version": "5.0.0-rc2",
3
+ "version": "5.0.0-rc4",
4
4
  "description": "OpenAPI client for @cosmotech/api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {