@tapis/tapis-typescript-systems 0.0.2 → 0.0.3

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 (185) hide show
  1. package/.openapi-generator/FILES +18 -3
  2. package/README.md +2 -2
  3. package/dist/apis/ChildSystemsApi.d.ts +54 -0
  4. package/dist/apis/ChildSystemsApi.js +224 -0
  5. package/dist/apis/CredentialsApi.d.ts +48 -15
  6. package/dist/apis/CredentialsApi.js +167 -16
  7. package/dist/apis/GeneralApi.d.ts +5 -5
  8. package/dist/apis/GeneralApi.js +5 -5
  9. package/dist/apis/PermissionsApi.d.ts +3 -11
  10. package/dist/apis/PermissionsApi.js +3 -11
  11. package/dist/apis/SchedulerProfilesApi.d.ts +5 -13
  12. package/dist/apis/SchedulerProfilesApi.js +6 -14
  13. package/dist/apis/SharingApi.d.ts +85 -0
  14. package/dist/apis/SharingApi.js +328 -0
  15. package/dist/apis/SystemsApi.d.ts +33 -44
  16. package/dist/apis/SystemsApi.js +84 -47
  17. package/dist/apis/index.d.ts +2 -0
  18. package/dist/apis/index.js +2 -0
  19. package/dist/models/AuthnEnum.d.ts +2 -1
  20. package/dist/models/AuthnEnum.js +2 -1
  21. package/dist/models/Capability.d.ts +1 -1
  22. package/dist/models/Capability.js +1 -1
  23. package/dist/models/CategoryEnum.d.ts +1 -1
  24. package/dist/models/CategoryEnum.js +1 -1
  25. package/dist/models/Credential.d.ts +19 -1
  26. package/dist/models/Credential.js +7 -1
  27. package/dist/models/DatatypeEnum.d.ts +1 -1
  28. package/dist/models/DatatypeEnum.js +1 -1
  29. package/dist/models/JobRuntime.d.ts +1 -1
  30. package/dist/models/JobRuntime.js +1 -1
  31. package/dist/models/KeyValuePair.d.ts +7 -1
  32. package/dist/models/KeyValuePair.js +3 -1
  33. package/dist/models/ListTypeEnum.d.ts +24 -0
  34. package/dist/models/ListTypeEnum.js +38 -0
  35. package/dist/models/LogicalQueue.d.ts +1 -1
  36. package/dist/models/LogicalQueue.js +1 -1
  37. package/dist/models/ModuleLoadSpec.d.ts +33 -0
  38. package/dist/models/ModuleLoadSpec.js +43 -0
  39. package/dist/models/OperationTypeEnum.d.ts +35 -0
  40. package/dist/models/OperationTypeEnum.js +49 -0
  41. package/dist/models/ReqMatchConstraints.d.ts +1 -1
  42. package/dist/models/ReqMatchConstraints.js +1 -1
  43. package/dist/models/ReqPatchSystem.d.ts +19 -1
  44. package/dist/models/ReqPatchSystem.js +7 -1
  45. package/dist/models/ReqPerms.d.ts +1 -1
  46. package/dist/models/ReqPerms.js +1 -1
  47. package/dist/models/ReqPostChildSystem.d.ts +39 -0
  48. package/dist/models/ReqPostChildSystem.js +45 -0
  49. package/dist/models/ReqPostPutCredential.d.ts +69 -0
  50. package/dist/models/{ReqCreateCredential.js → ReqPostPutCredential.js} +12 -8
  51. package/dist/models/ReqPostSchedulerProfile.d.ts +52 -0
  52. package/dist/models/{ReqCreateSchedulerProfile.js → ReqPostSchedulerProfile.js} +10 -12
  53. package/dist/models/{ReqCreateSystem.d.ts → ReqPostSystem.d.ts} +55 -43
  54. package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +14 -10
  55. package/dist/models/ReqPutSystem.d.ts +16 -4
  56. package/dist/models/ReqPutSystem.js +7 -3
  57. package/dist/models/ReqSearchSystems.d.ts +1 -1
  58. package/dist/models/ReqSearchSystems.js +1 -1
  59. package/dist/models/ReqShareUpdate.d.ts +27 -0
  60. package/dist/models/ReqShareUpdate.js +40 -0
  61. package/dist/models/ReqUnlinkChildren.d.ts +27 -0
  62. package/dist/models/ReqUnlinkChildren.js +41 -0
  63. package/dist/models/ReqUpdateCredential.d.ts +75 -0
  64. package/dist/models/ReqUpdateCredential.js +57 -0
  65. package/dist/models/RespBasic.d.ts +13 -1
  66. package/dist/models/RespBasic.js +5 -1
  67. package/dist/models/RespBoolean.d.ts +13 -1
  68. package/dist/models/RespBoolean.js +5 -1
  69. package/dist/models/RespChangeCount.d.ts +13 -1
  70. package/dist/models/RespChangeCount.js +5 -1
  71. package/dist/models/RespCredential.d.ts +13 -1
  72. package/dist/models/RespCredential.js +5 -1
  73. package/dist/models/RespGlobusAuthUrl.d.ts +64 -0
  74. package/dist/models/RespGlobusAuthUrl.js +54 -0
  75. package/dist/models/RespNameArray.d.ts +13 -1
  76. package/dist/models/RespNameArray.js +5 -1
  77. package/dist/models/RespResourceUrl.d.ts +13 -1
  78. package/dist/models/RespResourceUrl.js +5 -1
  79. package/dist/models/RespSchedulerProfile.d.ts +13 -1
  80. package/dist/models/RespSchedulerProfile.js +5 -1
  81. package/dist/models/RespSchedulerProfiles.d.ts +13 -1
  82. package/dist/models/RespSchedulerProfiles.js +5 -1
  83. package/dist/models/RespShareInfo.d.ts +64 -0
  84. package/dist/models/RespShareInfo.js +54 -0
  85. package/dist/models/RespSystem.d.ts +13 -1
  86. package/dist/models/RespSystem.js +5 -1
  87. package/dist/models/RespSystemHistory.d.ts +64 -0
  88. package/dist/models/RespSystemHistory.js +54 -0
  89. package/dist/models/RespSystems.d.ts +13 -1
  90. package/dist/models/RespSystems.js +5 -1
  91. package/dist/models/RespSystemsMetadata.d.ts +1 -1
  92. package/dist/models/RespSystemsMetadata.js +1 -1
  93. package/dist/models/ResultBoolean.d.ts +1 -1
  94. package/dist/models/ResultBoolean.js +1 -1
  95. package/dist/models/ResultChangeCount.d.ts +1 -1
  96. package/dist/models/ResultChangeCount.js +1 -1
  97. package/dist/models/ResultGlobusAuthUrl.d.ts +33 -0
  98. package/dist/models/ResultGlobusAuthUrl.js +43 -0
  99. package/dist/models/ResultNameArray.d.ts +1 -1
  100. package/dist/models/ResultNameArray.js +1 -1
  101. package/dist/models/ResultResourceUrl.d.ts +1 -1
  102. package/dist/models/ResultResourceUrl.js +1 -1
  103. package/dist/models/RuntimeTypeEnum.d.ts +1 -1
  104. package/dist/models/RuntimeTypeEnum.js +1 -1
  105. package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
  106. package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
  107. package/dist/models/SchedulerProfile.d.ts +4 -10
  108. package/dist/models/SchedulerProfile.js +3 -5
  109. package/dist/models/SchedulerTypeEnum.d.ts +1 -1
  110. package/dist/models/SchedulerTypeEnum.js +1 -1
  111. package/dist/models/ShareInfo.d.ts +33 -0
  112. package/dist/models/ShareInfo.js +42 -0
  113. package/dist/models/SystemHistory.d.ts +64 -0
  114. package/dist/models/SystemHistory.js +54 -0
  115. package/dist/models/SystemTypeEnum.d.ts +1 -1
  116. package/dist/models/SystemTypeEnum.js +1 -1
  117. package/dist/models/TapisSystem.d.ts +27 -3
  118. package/dist/models/TapisSystem.js +11 -3
  119. package/dist/models/index.d.ts +16 -3
  120. package/dist/models/index.js +16 -3
  121. package/dist/runtime.d.ts +1 -1
  122. package/dist/runtime.js +1 -1
  123. package/package.json +1 -1
  124. package/src/apis/ChildSystemsApi.ts +171 -0
  125. package/src/apis/CredentialsApi.ts +152 -20
  126. package/src/apis/GeneralApi.ts +5 -5
  127. package/src/apis/PermissionsApi.ts +3 -11
  128. package/src/apis/SchedulerProfilesApi.ts +10 -18
  129. package/src/apis/SharingApi.ts +250 -0
  130. package/src/apis/SystemsApi.ts +99 -53
  131. package/src/apis/index.ts +2 -0
  132. package/src/models/AuthnEnum.ts +2 -1
  133. package/src/models/Capability.ts +1 -1
  134. package/src/models/CategoryEnum.ts +1 -1
  135. package/src/models/Credential.ts +25 -1
  136. package/src/models/DatatypeEnum.ts +1 -1
  137. package/src/models/JobRuntime.ts +1 -1
  138. package/src/models/KeyValuePair.ts +9 -1
  139. package/src/models/ListTypeEnum.ts +37 -0
  140. package/src/models/LogicalQueue.ts +1 -1
  141. package/src/models/ModuleLoadSpec.ts +64 -0
  142. package/src/models/OperationTypeEnum.ts +48 -0
  143. package/src/models/ReqMatchConstraints.ts +1 -1
  144. package/src/models/ReqPatchSystem.ts +25 -1
  145. package/src/models/ReqPerms.ts +1 -1
  146. package/src/models/ReqPostChildSystem.ts +72 -0
  147. package/src/models/{ReqCreateCredential.ts → ReqPostPutCredential.ts} +29 -13
  148. package/src/models/{ReqCreateSchedulerProfile.ts → ReqPostSchedulerProfile.ts} +20 -24
  149. package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +65 -49
  150. package/src/models/ReqPutSystem.ts +25 -9
  151. package/src/models/ReqSearchSystems.ts +1 -1
  152. package/src/models/ReqShareUpdate.ts +56 -0
  153. package/src/models/ReqUnlinkChildren.ts +56 -0
  154. package/src/models/ReqUpdateCredential.ts +120 -0
  155. package/src/models/RespBasic.ts +17 -1
  156. package/src/models/RespBoolean.ts +17 -1
  157. package/src/models/RespChangeCount.ts +17 -1
  158. package/src/models/RespCredential.ts +17 -1
  159. package/src/models/RespGlobusAuthUrl.ts +111 -0
  160. package/src/models/RespNameArray.ts +17 -1
  161. package/src/models/RespResourceUrl.ts +17 -1
  162. package/src/models/RespSchedulerProfile.ts +17 -1
  163. package/src/models/RespSchedulerProfiles.ts +17 -1
  164. package/src/models/RespShareInfo.ts +111 -0
  165. package/src/models/RespSystem.ts +17 -1
  166. package/src/models/RespSystemHistory.ts +111 -0
  167. package/src/models/RespSystems.ts +17 -1
  168. package/src/models/RespSystemsMetadata.ts +1 -1
  169. package/src/models/ResultBoolean.ts +1 -1
  170. package/src/models/ResultChangeCount.ts +1 -1
  171. package/src/models/ResultGlobusAuthUrl.ts +64 -0
  172. package/src/models/ResultNameArray.ts +1 -1
  173. package/src/models/ResultResourceUrl.ts +1 -1
  174. package/src/models/RuntimeTypeEnum.ts +1 -1
  175. package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
  176. package/src/models/SchedulerProfile.ts +9 -13
  177. package/src/models/SchedulerTypeEnum.ts +1 -1
  178. package/src/models/ShareInfo.ts +64 -0
  179. package/src/models/SystemHistory.ts +111 -0
  180. package/src/models/SystemTypeEnum.ts +1 -1
  181. package/src/models/TapisSystem.ts +37 -5
  182. package/src/models/index.ts +16 -3
  183. package/src/runtime.ts +1 -1
  184. package/dist/models/ReqCreateCredential.d.ts +0 -57
  185. package/dist/models/ReqCreateSchedulerProfile.d.ts +0 -58
@@ -3,10 +3,12 @@
3
3
  .openapi-generator-ignore
4
4
  README.md
5
5
  package.json
6
+ src/apis/ChildSystemsApi.ts
6
7
  src/apis/CredentialsApi.ts
7
8
  src/apis/GeneralApi.ts
8
9
  src/apis/PermissionsApi.ts
9
10
  src/apis/SchedulerProfilesApi.ts
11
+ src/apis/SharingApi.ts
10
12
  src/apis/SystemsApi.ts
11
13
  src/apis/index.ts
12
14
  src/index.ts
@@ -17,34 +19,47 @@ src/models/Credential.ts
17
19
  src/models/DatatypeEnum.ts
18
20
  src/models/JobRuntime.ts
19
21
  src/models/KeyValuePair.ts
22
+ src/models/ListTypeEnum.ts
20
23
  src/models/LogicalQueue.ts
21
- src/models/ReqCreateCredential.ts
22
- src/models/ReqCreateSchedulerProfile.ts
23
- src/models/ReqCreateSystem.ts
24
+ src/models/ModuleLoadSpec.ts
25
+ src/models/OperationTypeEnum.ts
24
26
  src/models/ReqMatchConstraints.ts
25
27
  src/models/ReqPatchSystem.ts
26
28
  src/models/ReqPerms.ts
29
+ src/models/ReqPostChildSystem.ts
30
+ src/models/ReqPostPutCredential.ts
31
+ src/models/ReqPostSchedulerProfile.ts
32
+ src/models/ReqPostSystem.ts
27
33
  src/models/ReqPutSystem.ts
28
34
  src/models/ReqSearchSystems.ts
35
+ src/models/ReqShareUpdate.ts
36
+ src/models/ReqUnlinkChildren.ts
37
+ src/models/ReqUpdateCredential.ts
29
38
  src/models/RespBasic.ts
30
39
  src/models/RespBoolean.ts
31
40
  src/models/RespChangeCount.ts
32
41
  src/models/RespCredential.ts
42
+ src/models/RespGlobusAuthUrl.ts
33
43
  src/models/RespNameArray.ts
34
44
  src/models/RespResourceUrl.ts
35
45
  src/models/RespSchedulerProfile.ts
36
46
  src/models/RespSchedulerProfiles.ts
47
+ src/models/RespShareInfo.ts
37
48
  src/models/RespSystem.ts
49
+ src/models/RespSystemHistory.ts
38
50
  src/models/RespSystems.ts
39
51
  src/models/RespSystemsMetadata.ts
40
52
  src/models/ResultBoolean.ts
41
53
  src/models/ResultChangeCount.ts
54
+ src/models/ResultGlobusAuthUrl.ts
42
55
  src/models/ResultNameArray.ts
43
56
  src/models/ResultResourceUrl.ts
44
57
  src/models/RuntimeTypeEnum.ts
45
58
  src/models/SchedulerHiddenOptionEnum.ts
46
59
  src/models/SchedulerProfile.ts
47
60
  src/models/SchedulerTypeEnum.ts
61
+ src/models/ShareInfo.ts
62
+ src/models/SystemHistory.ts
48
63
  src/models/SystemTypeEnum.ts
49
64
  src/models/TapisSystem.ts
50
65
  src/models/index.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @tapis/tapis-typescript-systems@0.0.2
1
+ ## @tapis/tapis-typescript-systems@0.0.3
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @tapis/tapis-typescript-systems@0.0.2 --save
39
+ npm install @tapis/tapis-typescript-systems@0.0.3 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Tapis Systems API
3
+ * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
4
+ *
5
+ * The version of the OpenAPI document: 1.3.3
6
+ * Contact: cicsupport@tacc.utexas.edu
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { ReqPostChildSystem, ReqUnlinkChildren, RespChangeCount, RespResourceUrl } from '../models';
14
+ export interface CreateChildSystemRequest {
15
+ parentId: string;
16
+ reqPostChildSystem: ReqPostChildSystem;
17
+ }
18
+ export interface UnlinkChildrenRequest {
19
+ parentSystemId: string;
20
+ all?: boolean;
21
+ reqUnlinkChildren?: ReqUnlinkChildren;
22
+ }
23
+ export interface UnlinkFromParentRequest {
24
+ childSystemId: string;
25
+ }
26
+ /**
27
+ *
28
+ */
29
+ export declare class ChildSystemsApi extends runtime.BaseAPI {
30
+ /**
31
+ * Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
32
+ */
33
+ createChildSystemRaw(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
34
+ /**
35
+ * Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
36
+ */
37
+ createChildSystem(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
38
+ /**
39
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
40
+ */
41
+ unlinkChildrenRaw(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
42
+ /**
43
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
44
+ */
45
+ unlinkChildren(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
46
+ /**
47
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
48
+ */
49
+ unlinkFromParentRaw(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
50
+ /**
51
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
52
+ */
53
+ unlinkFromParent(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
54
+ }
@@ -0,0 +1,224 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Tapis Systems API
6
+ * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
7
+ *
8
+ * The version of the OpenAPI document: 1.3.3
9
+ * Contact: cicsupport@tacc.utexas.edu
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = Object.setPrototypeOf ||
17
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
18
+ function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
19
+ return function (d, b) {
20
+ extendStatics(d, b);
21
+ function __() { this.constructor = d; }
22
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
23
+ };
24
+ })();
25
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
26
+ return new (P || (P = Promise))(function (resolve, reject) {
27
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
28
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
29
+ function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
30
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
31
+ });
32
+ };
33
+ var __generator = (this && this.__generator) || function (thisArg, body) {
34
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
35
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
36
+ function verb(n) { return function (v) { return step([n, v]); }; }
37
+ function step(op) {
38
+ if (f) throw new TypeError("Generator is already executing.");
39
+ while (_) try {
40
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
41
+ if (y = 0, t) op = [op[0] & 2, t.value];
42
+ switch (op[0]) {
43
+ case 0: case 1: t = op; break;
44
+ case 4: _.label++; return { value: op[1], done: false };
45
+ case 5: _.label++; y = op[1]; op = [0]; continue;
46
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
47
+ default:
48
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
49
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
50
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
51
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
52
+ if (t[2]) _.ops.pop();
53
+ _.trys.pop(); continue;
54
+ }
55
+ op = body.call(thisArg, _);
56
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
57
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
58
+ }
59
+ };
60
+ Object.defineProperty(exports, "__esModule", { value: true });
61
+ var runtime = require("../runtime");
62
+ var models_1 = require("../models");
63
+ /**
64
+ *
65
+ */
66
+ var ChildSystemsApi = /** @class */ (function (_super) {
67
+ __extends(ChildSystemsApi, _super);
68
+ function ChildSystemsApi() {
69
+ return _super !== null && _super.apply(this, arguments) || this;
70
+ }
71
+ /**
72
+ * Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
73
+ */
74
+ ChildSystemsApi.prototype.createChildSystemRaw = function (requestParameters, initOverrides) {
75
+ return __awaiter(this, void 0, void 0, function () {
76
+ var queryParameters, headerParameters, response;
77
+ return __generator(this, function (_a) {
78
+ switch (_a.label) {
79
+ case 0:
80
+ if (requestParameters.parentId === null || requestParameters.parentId === undefined) {
81
+ throw new runtime.RequiredError('parentId', 'Required parameter requestParameters.parentId was null or undefined when calling createChildSystem.');
82
+ }
83
+ if (requestParameters.reqPostChildSystem === null || requestParameters.reqPostChildSystem === undefined) {
84
+ throw new runtime.RequiredError('reqPostChildSystem', 'Required parameter requestParameters.reqPostChildSystem was null or undefined when calling createChildSystem.');
85
+ }
86
+ queryParameters = {};
87
+ headerParameters = {};
88
+ headerParameters['Content-Type'] = 'application/json';
89
+ if (this.configuration && this.configuration.apiKey) {
90
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
91
+ }
92
+ return [4 /*yield*/, this.request({
93
+ path: "/v3/systems/{parentId}/createChildSystem".replace("{" + "parentId" + "}", encodeURIComponent(String(requestParameters.parentId))),
94
+ method: 'POST',
95
+ headers: headerParameters,
96
+ query: queryParameters,
97
+ body: models_1.ReqPostChildSystemToJSON(requestParameters.reqPostChildSystem),
98
+ }, initOverrides)];
99
+ case 1:
100
+ response = _a.sent();
101
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespResourceUrlFromJSON(jsonValue); })];
102
+ }
103
+ });
104
+ });
105
+ };
106
+ /**
107
+ * Create a child system. The child system gets all of it\'s attributes from it\'s parent except for the following fields: - *id* - *effectiveUserId* - *rootDir* - *owner* The owner will be the user who is creating the system. The caller must have read permission to the parent system.
108
+ */
109
+ ChildSystemsApi.prototype.createChildSystem = function (requestParameters, initOverrides) {
110
+ return __awaiter(this, void 0, void 0, function () {
111
+ var response;
112
+ return __generator(this, function (_a) {
113
+ switch (_a.label) {
114
+ case 0: return [4 /*yield*/, this.createChildSystemRaw(requestParameters, initOverrides)];
115
+ case 1:
116
+ response = _a.sent();
117
+ return [4 /*yield*/, response.value()];
118
+ case 2: return [2 /*return*/, _a.sent()];
119
+ }
120
+ });
121
+ });
122
+ };
123
+ /**
124
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
125
+ */
126
+ ChildSystemsApi.prototype.unlinkChildrenRaw = function (requestParameters, initOverrides) {
127
+ return __awaiter(this, void 0, void 0, function () {
128
+ var queryParameters, headerParameters, response;
129
+ return __generator(this, function (_a) {
130
+ switch (_a.label) {
131
+ case 0:
132
+ if (requestParameters.parentSystemId === null || requestParameters.parentSystemId === undefined) {
133
+ throw new runtime.RequiredError('parentSystemId', 'Required parameter requestParameters.parentSystemId was null or undefined when calling unlinkChildren.');
134
+ }
135
+ queryParameters = {};
136
+ if (requestParameters.all !== undefined) {
137
+ queryParameters['all'] = requestParameters.all;
138
+ }
139
+ headerParameters = {};
140
+ headerParameters['Content-Type'] = 'application/json';
141
+ if (this.configuration && this.configuration.apiKey) {
142
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
143
+ }
144
+ return [4 /*yield*/, this.request({
145
+ path: "/v3/systems/{parentSystemId}/unlinkChildren".replace("{" + "parentSystemId" + "}", encodeURIComponent(String(requestParameters.parentSystemId))),
146
+ method: 'POST',
147
+ headers: headerParameters,
148
+ query: queryParameters,
149
+ body: models_1.ReqUnlinkChildrenToJSON(requestParameters.reqUnlinkChildren),
150
+ }, initOverrides)];
151
+ case 1:
152
+ response = _a.sent();
153
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespChangeCountFromJSON(jsonValue); })];
154
+ }
155
+ });
156
+ });
157
+ };
158
+ /**
159
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. This is similar to unlinkFromParent, but permissions are required for the parent system rather than the child system. Warning, this cannot be undone.
160
+ */
161
+ ChildSystemsApi.prototype.unlinkChildren = function (requestParameters, initOverrides) {
162
+ return __awaiter(this, void 0, void 0, function () {
163
+ var response;
164
+ return __generator(this, function (_a) {
165
+ switch (_a.label) {
166
+ case 0: return [4 /*yield*/, this.unlinkChildrenRaw(requestParameters, initOverrides)];
167
+ case 1:
168
+ response = _a.sent();
169
+ return [4 /*yield*/, response.value()];
170
+ case 2: return [2 /*return*/, _a.sent()];
171
+ }
172
+ });
173
+ });
174
+ };
175
+ /**
176
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
177
+ */
178
+ ChildSystemsApi.prototype.unlinkFromParentRaw = function (requestParameters, initOverrides) {
179
+ return __awaiter(this, void 0, void 0, function () {
180
+ var queryParameters, headerParameters, response;
181
+ return __generator(this, function (_a) {
182
+ switch (_a.label) {
183
+ case 0:
184
+ if (requestParameters.childSystemId === null || requestParameters.childSystemId === undefined) {
185
+ throw new runtime.RequiredError('childSystemId', 'Required parameter requestParameters.childSystemId was null or undefined when calling unlinkFromParent.');
186
+ }
187
+ queryParameters = {};
188
+ headerParameters = {};
189
+ if (this.configuration && this.configuration.apiKey) {
190
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
191
+ }
192
+ return [4 /*yield*/, this.request({
193
+ path: "/v3/systems/{childSystemId}/unlinkFromParent".replace("{" + "childSystemId" + "}", encodeURIComponent(String(requestParameters.childSystemId))),
194
+ method: 'POST',
195
+ headers: headerParameters,
196
+ query: queryParameters,
197
+ }, initOverrides)];
198
+ case 1:
199
+ response = _a.sent();
200
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespChangeCountFromJSON(jsonValue); })];
201
+ }
202
+ });
203
+ });
204
+ };
205
+ /**
206
+ * Make a child system a standalone system. This will break the connection with it\'s parent, and from this point on, the child system will not be connected to the parent. Warning, this cannot be undone.
207
+ */
208
+ ChildSystemsApi.prototype.unlinkFromParent = function (requestParameters, initOverrides) {
209
+ return __awaiter(this, void 0, void 0, function () {
210
+ var response;
211
+ return __generator(this, function (_a) {
212
+ switch (_a.label) {
213
+ case 0: return [4 /*yield*/, this.unlinkFromParentRaw(requestParameters, initOverrides)];
214
+ case 1:
215
+ response = _a.sent();
216
+ return [4 /*yield*/, response.value()];
217
+ case 2: return [2 /*return*/, _a.sent()];
218
+ }
219
+ });
220
+ });
221
+ };
222
+ return ChildSystemsApi;
223
+ }(runtime.BaseAPI));
224
+ exports.ChildSystemsApi = ChildSystemsApi;
@@ -2,7 +2,7 @@
2
2
  * Tapis Systems API
3
3
  * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
4
4
  *
5
- * The version of the OpenAPI document: 1.0.0-rc1
5
+ * The version of the OpenAPI document: 1.3.3
6
6
  * Contact: cicsupport@tacc.utexas.edu
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,13 +10,24 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ReqCreateCredential, RespBasic, RespCredential } from '../models';
13
+ import { ReqUpdateCredential, RespBasic, RespCredential, RespGlobusAuthUrl } from '../models';
14
+ export interface CheckUserCredentialRequest {
15
+ systemId: string;
16
+ userName: string;
17
+ authnMethod?: string;
18
+ }
14
19
  export interface CreateUserCredentialRequest {
15
20
  systemId: string;
16
21
  userName: string;
17
- reqCreateCredential: ReqCreateCredential;
22
+ reqUpdateCredential: ReqUpdateCredential;
18
23
  skipCredentialCheck?: boolean;
19
24
  }
25
+ export interface GenerateGlobusTokensRequest {
26
+ systemId: string;
27
+ userName: string;
28
+ authCode: string;
29
+ sessionId: string;
30
+ }
20
31
  export interface GetUserCredentialRequest {
21
32
  systemId: string;
22
33
  userName: string;
@@ -31,33 +42,55 @@ export interface RemoveUserCredentialRequest {
31
42
  */
32
43
  export declare class CredentialsApi extends runtime.BaseAPI {
33
44
  /**
34
- * Create or update credentials in the Security Kernel for given system and *target user* using a request body. Requester must be owner of the system. Credentials for multiple authentication methods may be provided. Note that user making the request and *target user* may be different and frequently are different. By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. Note that the attribute authnMethod is allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST to update credentials.
35
- * Create or update user credentials for a system and target user
45
+ * Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is ignored and a search is made for credentials associated with *effectiveUserId*. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter authnMethod=<method>. If not specified then credentials for the system\'s default authentication method are verified.
46
+ */
47
+ checkUserCredentialRaw(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
48
+ /**
49
+ * Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is ignored and a search is made for credentials associated with *effectiveUserId*. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter authnMethod=<method>. If not specified then credentials for the system\'s default authentication method are verified.
50
+ */
51
+ checkUserCredential(requestParameters: CheckUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic>;
52
+ /**
53
+ * Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
36
54
  */
37
55
  createUserCredentialRaw(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
38
56
  /**
39
- * Create or update credentials in the Security Kernel for given system and *target user* using a request body. Requester must be owner of the system. Credentials for multiple authentication methods may be provided. Note that user making the request and *target user* may be different and frequently are different. By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. Note that the attribute authnMethod is allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST to update credentials.
40
- * Create or update user credentials for a system and target user
57
+ * Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
41
58
  */
42
59
  createUserCredential(requestParameters: CreateUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic>;
43
60
  /**
44
- * Highly restricted. Only certain Tapis services authorized. Retrieve credentials for given system, *target user* and authentication method. Note that user making the request and *target user* may be different and frequently are different. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the field authnMethod indicating the authentication method associated with the returned credentials.
45
- * Retrieve user credentials for a system and target user
61
+ * Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
62
+ * Use a Globus authorization code + Tapis session Id to generate tokens
63
+ */
64
+ generateGlobusTokensRaw(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
65
+ /**
66
+ * Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
67
+ * Use a Globus authorization code + Tapis session Id to generate tokens
68
+ */
69
+ generateGlobusTokens(requestParameters: GenerateGlobusTokensRequest, initOverrides?: RequestInit): Promise<RespBasic>;
70
+ /**
71
+ * Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code. In Globus the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Endpoint Id. Once a user has obtained an authorization code the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
72
+ * Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
73
+ */
74
+ getGlobusAuthUrlRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespGlobusAuthUrl>>;
75
+ /**
76
+ * Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code. In Globus the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Endpoint Id. Once a user has obtained an authorization code the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. Note that the authorization code as per Globus documentation is valid for 10 minutes.
77
+ * Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
78
+ */
79
+ getGlobusAuthUrl(initOverrides?: RequestInit): Promise<RespGlobusAuthUrl>;
80
+ /**
81
+ * Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that their may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
46
82
  */
47
83
  getUserCredentialRaw(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespCredential>>;
48
84
  /**
49
- * Highly restricted. Only certain Tapis services authorized. Retrieve credentials for given system, *target user* and authentication method. Note that user making the request and *target user* may be different and frequently are different. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the field authnMethod indicating the authentication method associated with the returned credentials.
50
- * Retrieve user credentials for a system and target user
85
+ * Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that their may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
51
86
  */
52
87
  getUserCredential(requestParameters: GetUserCredentialRequest, initOverrides?: RequestInit): Promise<RespCredential>;
53
88
  /**
54
- * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Note that user making the request and *target user* may be different and frequently are different.
55
- * Remove user credentials for a system and target user
89
+ * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
56
90
  */
57
91
  removeUserCredentialRaw(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
58
92
  /**
59
- * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Note that user making the request and *target user* may be different and frequently are different.
60
- * Remove user credentials for a system and target user
93
+ * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
61
94
  */
62
95
  removeUserCredential(requestParameters: RemoveUserCredentialRequest, initOverrides?: RequestInit): Promise<RespBasic>;
63
96
  }