@tapis/tapis-typescript-systems 0.0.2 → 0.0.4

package/dist/models/TapisSystem.d.ts

@@ -2,7 +2,7 @@
  * Tapis Systems API
  * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
  *
- * The version of the OpenAPI document: 1.0.0-rc1
+ * The version of the OpenAPI document: 1.6.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,13 +23,13 @@ export interface TapisSystem {
      */
     tenant?: string;
     /**
-     *
+     * Short descriptive name for the system that is unique within the tenant.
      * @type {string}
      * @memberof TapisSystem
      */
     id?: string;
     /**
-     *
+     * Optional more verbose description.
      * @type {string}
      * @memberof TapisSystem
      */
@@ -47,19 +47,19 @@ export interface TapisSystem {
      */
     owner?: string;
     /**
-     *
+     * FQDN, IP address, Globus endpoint ID or Globus collection ID.
      * @type {string}
      * @memberof TapisSystem
      */
     host?: string;
     /**
-     *
+     * Indicates if system is currently considered active and available for use.
      * @type {boolean}
      * @memberof TapisSystem
      */
     enabled?: boolean;
     /**
-     *
+     * Username to use when accessing the system. A specific user (such as a service account) or the dynamic user ``${apiUserId}``.
      * @type {string}
      * @memberof TapisSystem
      */
@@ -77,13 +77,13 @@ export interface TapisSystem {
      */
     authnCredential?: Credential;
     /**
-     *
+     * Name of the bucket for an S3 type system.
      * @type {string}
      * @memberof TapisSystem
      */
     bucketName?: string;
     /**
-     *
+     * Effective root directory to be used when listing files or moving files to and from the system.
      * @type {string}
      * @memberof TapisSystem
      */
@@ -113,47 +113,59 @@ export interface TapisSystem {
      */
     proxyPort?: number;
     /**
-     *
+     * An alternate system to use as a Data Transfer Node (DTN) during job execution.
      * @type {string}
      * @memberof TapisSystem
      */
     dtnSystemId?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof TapisSystem
      */
-    dtnMountPoint?: string;
+    isPublic?: boolean;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof TapisSystem
      */
-    dtnMountSourcePath?: string;
+    isDynamicEffectiveUser?: boolean;
     /**
-     *
+     * Indicates if system can be used to execute jobs.
      * @type {boolean}
      * @memberof TapisSystem
      */
-    isDtn?: boolean;
+    canExec?: boolean;
     /**
-     *
+     * Indicates if system supports running jobs using a batch scheduler.
      * @type {boolean}
      * @memberof TapisSystem
      */
-    canExec?: boolean;
+    canRunBatch?: boolean;
     /**
      *
      * @type {boolean}
      * @memberof TapisSystem
      */
-    canRunBatch?: boolean;
+    enableCmdPrefix?: boolean;
+    /**
+     * Indicates if system allows for the creation of child systems.
+     * @type {boolean}
+     * @memberof TapisSystem
+     */
+    allowChildren?: boolean;
     /**
      *
-     * @type {Set<JobRuntime>}
+     * @type {string}
      * @memberof TapisSystem
      */
-    jobRuntimes?: Set<JobRuntime>;
+    mpiCmd?: string;
+    /**
+     *
+     * @type {Array<JobRuntime>}
+     * @memberof TapisSystem
+     */
+    jobRuntimes?: Array<JobRuntime>;
     /**
      *
      * @type {string}
@@ -202,6 +214,12 @@ export interface TapisSystem {
      * @memberof TapisSystem
      */
     batchSchedulerProfile?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof TapisSystem
+     */
+    sharedWithUsers?: Array<string>;
     /**
      *
      * @type {Array<Capability>}
@@ -220,12 +238,6 @@ export interface TapisSystem {
      * @memberof TapisSystem
      */
     notes?: object;
-    /**
-     *
-     * @type {string}
-     * @memberof TapisSystem
-     */
-    importRefId?: string;
     /**
      *
      * @type {string}

package/dist/models/TapisSystem.js

@@ -5,7 +5,7 @@
  * Tapis Systems API
  * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
  *
- * The version of the OpenAPI document: 1.0.0-rc1
+ * The version of the OpenAPI document: 1.6.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -41,12 +41,14 @@ function TapisSystemFromJSONTyped(json, ignoreDiscriminator) {
         'proxyHost': !runtime_1.exists(json, 'proxyHost') ? undefined : json['proxyHost'],
         'proxyPort': !runtime_1.exists(json, 'proxyPort') ? undefined : json['proxyPort'],
         'dtnSystemId': !runtime_1.exists(json, 'dtnSystemId') ? undefined : json['dtnSystemId'],
-        'dtnMountPoint': !runtime_1.exists(json, 'dtnMountPoint') ? undefined : json['dtnMountPoint'],
-        'dtnMountSourcePath': !runtime_1.exists(json, 'dtnMountSourcePath') ? undefined : json['dtnMountSourcePath'],
-        'isDtn': !runtime_1.exists(json, 'isDtn') ? undefined : json['isDtn'],
+        'isPublic': !runtime_1.exists(json, 'isPublic') ? undefined : json['isPublic'],
+        'isDynamicEffectiveUser': !runtime_1.exists(json, 'isDynamicEffectiveUser') ? undefined : json['isDynamicEffectiveUser'],
         'canExec': !runtime_1.exists(json, 'canExec') ? undefined : json['canExec'],
         'canRunBatch': !runtime_1.exists(json, 'canRunBatch') ? undefined : json['canRunBatch'],
-        'jobRuntimes': !runtime_1.exists(json, 'jobRuntimes') ? undefined : (new Set(json['jobRuntimes'].map(_1.JobRuntimeFromJSON))),
+        'enableCmdPrefix': !runtime_1.exists(json, 'enableCmdPrefix') ? undefined : json['enableCmdPrefix'],
+        'allowChildren': !runtime_1.exists(json, 'allowChildren') ? undefined : json['allowChildren'],
+        'mpiCmd': !runtime_1.exists(json, 'mpiCmd') ? undefined : json['mpiCmd'],
+        'jobRuntimes': !runtime_1.exists(json, 'jobRuntimes') ? undefined : (json['jobRuntimes'].map(_1.JobRuntimeFromJSON)),
         'jobWorkingDir': !runtime_1.exists(json, 'jobWorkingDir') ? undefined : json['jobWorkingDir'],
         'jobEnvVariables': !runtime_1.exists(json, 'jobEnvVariables') ? undefined : (json['jobEnvVariables'].map(_1.KeyValuePairFromJSON)),
         'jobMaxJobs': !runtime_1.exists(json, 'jobMaxJobs') ? undefined : json['jobMaxJobs'],
@@ -55,10 +57,10 @@ function TapisSystemFromJSONTyped(json, ignoreDiscriminator) {
         'batchLogicalQueues': !runtime_1.exists(json, 'batchLogicalQueues') ? undefined : (json['batchLogicalQueues'].map(_1.LogicalQueueFromJSON)),
         'batchDefaultLogicalQueue': !runtime_1.exists(json, 'batchDefaultLogicalQueue') ? undefined : json['batchDefaultLogicalQueue'],
         'batchSchedulerProfile': !runtime_1.exists(json, 'batchSchedulerProfile') ? undefined : json['batchSchedulerProfile'],
+        'sharedWithUsers': !runtime_1.exists(json, 'sharedWithUsers') ? undefined : json['sharedWithUsers'],
         'jobCapabilities': !runtime_1.exists(json, 'jobCapabilities') ? undefined : (json['jobCapabilities'].map(_1.CapabilityFromJSON)),
         'tags': !runtime_1.exists(json, 'tags') ? undefined : json['tags'],
         'notes': !runtime_1.exists(json, 'notes') ? undefined : json['notes'],
-        'importRefId': !runtime_1.exists(json, 'importRefId') ? undefined : json['importRefId'],
         'uuid': !runtime_1.exists(json, 'uuid') ? undefined : json['uuid'],
         'deleted': !runtime_1.exists(json, 'deleted') ? undefined : json['deleted'],
         'created': !runtime_1.exists(json, 'created') ? undefined : json['created'],
@@ -91,12 +93,14 @@ function TapisSystemToJSON(value) {
         'proxyHost': value.proxyHost,
         'proxyPort': value.proxyPort,
         'dtnSystemId': value.dtnSystemId,
-        'dtnMountPoint': value.dtnMountPoint,
-        'dtnMountSourcePath': value.dtnMountSourcePath,
-        'isDtn': value.isDtn,
+        'isPublic': value.isPublic,
+        'isDynamicEffectiveUser': value.isDynamicEffectiveUser,
         'canExec': value.canExec,
         'canRunBatch': value.canRunBatch,
-        'jobRuntimes': value.jobRuntimes === undefined ? undefined : (Array.from(value.jobRuntimes).map(_1.JobRuntimeToJSON)),
+        'enableCmdPrefix': value.enableCmdPrefix,
+        'allowChildren': value.allowChildren,
+        'mpiCmd': value.mpiCmd,
+        'jobRuntimes': value.jobRuntimes === undefined ? undefined : (value.jobRuntimes.map(_1.JobRuntimeToJSON)),
         'jobWorkingDir': value.jobWorkingDir,
         'jobEnvVariables': value.jobEnvVariables === undefined ? undefined : (value.jobEnvVariables.map(_1.KeyValuePairToJSON)),
         'jobMaxJobs': value.jobMaxJobs,
@@ -105,10 +109,10 @@ function TapisSystemToJSON(value) {
         'batchLogicalQueues': value.batchLogicalQueues === undefined ? undefined : (value.batchLogicalQueues.map(_1.LogicalQueueToJSON)),
         'batchDefaultLogicalQueue': value.batchDefaultLogicalQueue,
         'batchSchedulerProfile': value.batchSchedulerProfile,
+        'sharedWithUsers': value.sharedWithUsers,
         'jobCapabilities': value.jobCapabilities === undefined ? undefined : (value.jobCapabilities.map(_1.CapabilityToJSON)),
         'tags': value.tags,
         'notes': value.notes,
-        'importRefId': value.importRefId,
         'uuid': value.uuid,
         'deleted': value.deleted,
         'created': value.created,

package/dist/models/index.d.ts

@@ -4,34 +4,48 @@ export * from './CategoryEnum';
 export * from './Credential';
 export * from './DatatypeEnum';
 export * from './JobRuntime';
+export * from './KeyValueInputModeEnum';
 export * from './KeyValuePair';
+export * from './ListTypeEnum';
 export * from './LogicalQueue';
-export * from './ReqCreateCredential';
-export * from './ReqCreateSchedulerProfile';
-export * from './ReqCreateSystem';
+export * from './ModuleLoadSpec';
+export * from './OperationTypeEnum';
 export * from './ReqMatchConstraints';
 export * from './ReqPatchSystem';
 export * from './ReqPerms';
+export * from './ReqPostChildSystem';
+export * from './ReqPostPutCredential';
+export * from './ReqPostSchedulerProfile';
+export * from './ReqPostSystem';
 export * from './ReqPutSystem';
 export * from './ReqSearchSystems';
+export * from './ReqShareUpdate';
+export * from './ReqUnlinkChildren';
+export * from './ReqUpdateCredential';
 export * from './RespBasic';
 export * from './RespBoolean';
 export * from './RespChangeCount';
 export * from './RespCredential';
+export * from './RespGlobusAuthUrl';
 export * from './RespNameArray';
 export * from './RespResourceUrl';
 export * from './RespSchedulerProfile';
 export * from './RespSchedulerProfiles';
+export * from './RespShareInfo';
 export * from './RespSystem';
+export * from './RespSystemHistory';
 export * from './RespSystems';
 export * from './RespSystemsMetadata';
 export * from './ResultBoolean';
 export * from './ResultChangeCount';
+export * from './ResultGlobusAuthUrl';
 export * from './ResultNameArray';
 export * from './ResultResourceUrl';
 export * from './RuntimeTypeEnum';
 export * from './SchedulerHiddenOptionEnum';
 export * from './SchedulerProfile';
 export * from './SchedulerTypeEnum';
+export * from './ShareInfo';
+export * from './SystemHistory';
 export * from './SystemTypeEnum';
 export * from './TapisSystem';

package/dist/models/index.js

@@ -11,34 +11,48 @@ __export(require("./CategoryEnum"));
 __export(require("./Credential"));
 __export(require("./DatatypeEnum"));
 __export(require("./JobRuntime"));
+__export(require("./KeyValueInputModeEnum"));
 __export(require("./KeyValuePair"));
+__export(require("./ListTypeEnum"));
 __export(require("./LogicalQueue"));
-__export(require("./ReqCreateCredential"));
-__export(require("./ReqCreateSchedulerProfile"));
-__export(require("./ReqCreateSystem"));
+__export(require("./ModuleLoadSpec"));
+__export(require("./OperationTypeEnum"));
 __export(require("./ReqMatchConstraints"));
 __export(require("./ReqPatchSystem"));
 __export(require("./ReqPerms"));
+__export(require("./ReqPostChildSystem"));
+__export(require("./ReqPostPutCredential"));
+__export(require("./ReqPostSchedulerProfile"));
+__export(require("./ReqPostSystem"));
 __export(require("./ReqPutSystem"));
 __export(require("./ReqSearchSystems"));
+__export(require("./ReqShareUpdate"));
+__export(require("./ReqUnlinkChildren"));
+__export(require("./ReqUpdateCredential"));
 __export(require("./RespBasic"));
 __export(require("./RespBoolean"));
 __export(require("./RespChangeCount"));
 __export(require("./RespCredential"));
+__export(require("./RespGlobusAuthUrl"));
 __export(require("./RespNameArray"));
 __export(require("./RespResourceUrl"));
 __export(require("./RespSchedulerProfile"));
 __export(require("./RespSchedulerProfiles"));
+__export(require("./RespShareInfo"));
 __export(require("./RespSystem"));
+__export(require("./RespSystemHistory"));
 __export(require("./RespSystems"));
 __export(require("./RespSystemsMetadata"));
 __export(require("./ResultBoolean"));
 __export(require("./ResultChangeCount"));
+__export(require("./ResultGlobusAuthUrl"));
 __export(require("./ResultNameArray"));
 __export(require("./ResultResourceUrl"));
 __export(require("./RuntimeTypeEnum"));
 __export(require("./SchedulerHiddenOptionEnum"));
 __export(require("./SchedulerProfile"));
 __export(require("./SchedulerTypeEnum"));
+__export(require("./ShareInfo"));
+__export(require("./SystemHistory"));
 __export(require("./SystemTypeEnum"));
 __export(require("./TapisSystem"));

package/dist/runtime.d.ts

@@ -2,7 +2,7 @@
  * Tapis Systems API
  * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
  *
- * The version of the OpenAPI document: 1.0.0-rc1
+ * The version of the OpenAPI document: 1.6.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime.js

@@ -5,7 +5,7 @@
  * Tapis Systems API
  * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
  *
- * The version of the OpenAPI document: 1.0.0-rc1
+ * The version of the OpenAPI document: 1.6.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapis/tapis-typescript-systems",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "OpenAPI client for @tapis/tapis-typescript-systems",
   "author": "OpenAPI-Generator",
   "main": "./dist/index.js",

package/src/apis/ChildSystemsApi.ts

@@ -0,0 +1,171 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Tapis Systems API
+ * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
+ *
+ * The version of the OpenAPI document: 1.6.3
+ * Contact: cicsupport@tacc.utexas.edu
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    ReqPostChildSystem,
+    ReqPostChildSystemFromJSON,
+    ReqPostChildSystemToJSON,
+    ReqUnlinkChildren,
+    ReqUnlinkChildrenFromJSON,
+    ReqUnlinkChildrenToJSON,
+    RespBasic,
+    RespBasicFromJSON,
+    RespBasicToJSON,
+    RespChangeCount,
+    RespChangeCountFromJSON,
+    RespChangeCountToJSON,
+    RespResourceUrl,
+    RespResourceUrlFromJSON,
+    RespResourceUrlToJSON,
+} from '../models';
+
+export interface CreateChildSystemRequest {
+    parentId: string;
+    reqPostChildSystem: ReqPostChildSystem;
+}
+
+export interface UnlinkChildrenRequest {
+    parentSystemId: string;
+    all?: boolean;
+    reqUnlinkChildren?: ReqUnlinkChildren;
+}
+
+export interface UnlinkFromParentRequest {
+    childSystemId: string;
+}
+
+/**
+ * 
+ */
+export class ChildSystemsApi extends runtime.BaseAPI {
+
+    /**
+     * Create a child system based on a parent system. The child system inherits most attributes from the parent. The following fields are filled in when the child system is created:   - *id*   - *effectiveUserId*   - *rootDir*   - *owner*  The owner will be the user who is creating the system. The caller must have read permission on the parent system. 
+     */
+    async createChildSystemRaw(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
+        if (requestParameters.parentId === null || requestParameters.parentId === undefined) {
+            throw new runtime.RequiredError('parentId','Required parameter requestParameters.parentId was null or undefined when calling createChildSystem.');
+        }
+
+        if (requestParameters.reqPostChildSystem === null || requestParameters.reqPostChildSystem === undefined) {
+            throw new runtime.RequiredError('reqPostChildSystem','Required parameter requestParameters.reqPostChildSystem was null or undefined when calling createChildSystem.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
+        }
+
+        const response = await this.request({
+            path: `/v3/systems/{parentId}/createChildSystem`.replace(`{${"parentId"}}`, encodeURIComponent(String(requestParameters.parentId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReqPostChildSystemToJSON(requestParameters.reqPostChildSystem),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespResourceUrlFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a child system based on a parent system. The child system inherits most attributes from the parent. The following fields are filled in when the child system is created:   - *id*   - *effectiveUserId*   - *rootDir*   - *owner*  The owner will be the user who is creating the system. The caller must have read permission on the parent system. 
+     */
+    async createChildSystem(requestParameters: CreateChildSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
+        const response = await this.createChildSystemRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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. 
+     */
+    async unlinkChildrenRaw(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
+        if (requestParameters.parentSystemId === null || requestParameters.parentSystemId === undefined) {
+            throw new runtime.RequiredError('parentSystemId','Required parameter requestParameters.parentSystemId was null or undefined when calling unlinkChildren.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.all !== undefined) {
+            queryParameters['all'] = requestParameters.all;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
+        }
+
+        const response = await this.request({
+            path: `/v3/systems/{parentSystemId}/unlinkChildren`.replace(`{${"parentSystemId"}}`, encodeURIComponent(String(requestParameters.parentSystemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReqUnlinkChildrenToJSON(requestParameters.reqUnlinkChildren),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespChangeCountFromJSON(jsonValue));
+    }
+
+    /**
+     * 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. 
+     */
+    async unlinkChildren(requestParameters: UnlinkChildrenRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
+        const response = await this.unlinkChildrenRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Make a child system a standalone system. This will break the connection with it\'s parent. From this point on, the child system will not be connected to the parent. **WARNING** This cannot be undone. 
+     */
+    async unlinkFromParentRaw(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
+        if (requestParameters.childSystemId === null || requestParameters.childSystemId === undefined) {
+            throw new runtime.RequiredError('childSystemId','Required parameter requestParameters.childSystemId was null or undefined when calling unlinkFromParent.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
+        }
+
+        const response = await this.request({
+            path: `/v3/systems/{childSystemId}/unlinkFromParent`.replace(`{${"childSystemId"}}`, encodeURIComponent(String(requestParameters.childSystemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespChangeCountFromJSON(jsonValue));
+    }
+
+    /**
+     * Make a child system a standalone system. This will break the connection with it\'s parent. From this point on, the child system will not be connected to the parent. **WARNING** This cannot be undone. 
+     */
+    async unlinkFromParent(requestParameters: UnlinkFromParentRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
+        const response = await this.unlinkFromParentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}