@tapis/tapis-typescript-systems 0.0.2 → 0.0.3

package/src/apis/SystemsApi.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,15 +15,18 @@
 
 import * as runtime from '../runtime';
 import {
-    ReqCreateSystem,
-    ReqCreateSystemFromJSON,
-    ReqCreateSystemToJSON,
+    ListTypeEnum,
+    ListTypeEnumFromJSON,
+    ListTypeEnumToJSON,
     ReqMatchConstraints,
     ReqMatchConstraintsFromJSON,
     ReqMatchConstraintsToJSON,
     ReqPatchSystem,
     ReqPatchSystemFromJSON,
     ReqPatchSystemToJSON,
+    ReqPostSystem,
+    ReqPostSystemFromJSON,
+    ReqPostSystemToJSON,
     ReqPutSystem,
     ReqPutSystemFromJSON,
     ReqPutSystemToJSON,
@@ -45,6 +48,9 @@ import {
     RespSystem,
     RespSystemFromJSON,
     RespSystemToJSON,
+    RespSystemHistory,
+    RespSystemHistoryFromJSON,
+    RespSystemHistoryToJSON,
     RespSystems,
     RespSystemsFromJSON,
     RespSystemsToJSON,
@@ -56,7 +62,7 @@ export interface ChangeSystemOwnerRequest {
 }
 
 export interface CreateSystemRequest {
-    reqCreateSystem: ReqCreateSystem;
+    reqPostSystem: ReqPostSystem;
     skipCredentialCheck?: boolean;
 }
 
@@ -72,16 +78,24 @@ export interface EnableSystemRequest {
     systemId: string;
 }
 
+export interface GetHistoryRequest {
+    systemId: string;
+}
+
 export interface GetSystemRequest {
     systemId: string;
-    returnCredentials?: boolean;
     authnMethod?: string;
     requireExecPerm?: boolean;
     select?: string;
+    returnCredentials?: boolean;
+    impersonationId?: string;
+    sharedAppCtx?: string;
+    resourceTenant?: string;
 }
 
 export interface GetSystemsRequest {
     search?: string;
+    listType?: ListTypeEnum;
     limit?: number;
     orderBy?: string;
     skip?: number;
@@ -112,6 +126,7 @@ export interface PutSystemRequest {
 
 export interface SearchSystemsQueryParametersRequest {
     freeFormParameterName?: { [key: string]: string; };
+    listType?: ListTypeEnum;
     limit?: number;
     orderBy?: string;
     skip?: number;
@@ -122,6 +137,7 @@ export interface SearchSystemsQueryParametersRequest {
 
 export interface SearchSystemsRequestBodyRequest {
     reqSearchSystems: ReqSearchSystems;
+    listType?: ListTypeEnum;
     limit?: number;
     orderBy?: string;
     skip?: number;
@@ -141,7 +157,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Change owner of a system. 
-     * Change system owner
      */
     async changeSystemOwnerRaw(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -172,7 +187,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Change owner of a system. 
-     * Change system owner
      */
     async changeSystemOwner(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.changeSystemOwnerRaw(requestParameters, initOverrides);
@@ -180,12 +194,11 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.  By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are    - tenant   - uuid   - deleted   - created   - updated 
-     * Create a system
+     * Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.  The attribute *effectiveUserId* determines the user that is used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT).  If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel.  By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory.  Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are    - tenant   - uuid   - deleted   - created   - updated 
      */
     async createSystemRaw(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
-        if (requestParameters.reqCreateSystem === null || requestParameters.reqCreateSystem === undefined) {
-            throw new runtime.RequiredError('reqCreateSystem','Required parameter requestParameters.reqCreateSystem was null or undefined when calling createSystem.');
+        if (requestParameters.reqPostSystem === null || requestParameters.reqPostSystem === undefined) {
+            throw new runtime.RequiredError('reqPostSystem','Required parameter requestParameters.reqPostSystem was null or undefined when calling createSystem.');
         }
 
         const queryParameters: any = {};
@@ -207,15 +220,14 @@ export class SystemsApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: ReqCreateSystemToJSON(requestParameters.reqCreateSystem),
+            body: ReqPostSystemToJSON(requestParameters.reqPostSystem),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => RespResourceUrlFromJSON(jsonValue));
     }
 
     /**
-     * Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.  By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are    - tenant   - uuid   - deleted   - created   - updated 
-     * Create a system
+     * Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.  The attribute *effectiveUserId* determines the user that is used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT).  If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel.  By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory.  Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are    - tenant   - uuid   - deleted   - created   - updated 
      */
     async createSystem(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
         const response = await this.createSystemRaw(requestParameters, initOverrides);
@@ -224,7 +236,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system as deleted. System will not appear in queries unless explicitly requested. 
-     * Mark a system as deleted
      */
     async deleteSystemRaw(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -251,7 +262,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system as deleted. System will not appear in queries unless explicitly requested. 
-     * Mark a system as deleted
      */
     async deleteSystem(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.deleteSystemRaw(requestParameters, initOverrides);
@@ -260,7 +270,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system unavailable for use. 
-     * Mark a system unavailabe for use
      */
     async disableSystemRaw(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -287,7 +296,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system unavailable for use. 
-     * Mark a system unavailabe for use
      */
     async disableSystem(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.disableSystemRaw(requestParameters, initOverrides);
@@ -296,7 +304,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system available for use. 
-     * Mark a system availabe for use
      */
     async enableSystemRaw(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -323,7 +330,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system available for use. 
-     * Mark a system availabe for use
      */
     async enableSystem(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.enableSystemRaw(requestParameters, initOverrides);
@@ -331,20 +337,49 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve information for a system given the system name. Use query parameter returnCredentials=true to have effectiveUserId credentials included in the response. Use query parameter authnMethod=<method> to override default authn method. 
-     * Retrieve system details
+     * Retrieve history of changes for a given systemId. 
      */
-    async getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystem>> {
+    async getHistoryRaw(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystemHistory>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
-            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling getSystem.');
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling getHistory.');
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters.returnCredentials !== undefined) {
-            queryParameters['returnCredentials'] = requestParameters.returnCredentials;
+        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/{systemId}/history`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespSystemHistoryFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve history of changes for a given systemId. 
+     */
+    async getHistory(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<RespSystemHistory> {
+        const response = await this.getHistoryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve information for a system given the system Id.  Use query parameter authnMethod=<method> to override the default authentication method.  Certain services may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.  Certain services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed. 
+     */
+    async getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystem>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling getSystem.');
+        }
+
+        const queryParameters: any = {};
+
         if (requestParameters.authnMethod !== undefined) {
             queryParameters['authnMethod'] = requestParameters.authnMethod;
         }
@@ -357,6 +392,22 @@ export class SystemsApi extends runtime.BaseAPI {
             queryParameters['select'] = requestParameters.select;
         }
 
+        if (requestParameters.returnCredentials !== undefined) {
+            queryParameters['returnCredentials'] = requestParameters.returnCredentials;
+        }
+
+        if (requestParameters.impersonationId !== undefined) {
+            queryParameters['impersonationId'] = requestParameters.impersonationId;
+        }
+
+        if (requestParameters.sharedAppCtx !== undefined) {
+            queryParameters['sharedAppCtx'] = requestParameters.sharedAppCtx;
+        }
+
+        if (requestParameters.resourceTenant !== undefined) {
+            queryParameters['resourceTenant'] = requestParameters.resourceTenant;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.apiKey) {
@@ -374,8 +425,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve information for a system given the system name. Use query parameter returnCredentials=true to have effectiveUserId credentials included in the response. Use query parameter authnMethod=<method> to override default authn method. 
-     * Retrieve system details
+     * Retrieve information for a system given the system Id.  Use query parameter authnMethod=<method> to override the default authentication method.  Certain services may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.  Certain services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed. 
      */
     async getSystem(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<RespSystem> {
         const response = await this.getSystemRaw(requestParameters, initOverrides);
@@ -383,8 +433,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve list of systems. Use search and select query parameters to limit results.
-     * Retrieve systems
+     * Retrieve list of systems. Use *listType*, *search* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async getSystemsRaw(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>> {
         const queryParameters: any = {};
@@ -393,6 +442,10 @@ export class SystemsApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters.search;
         }
 
+        if (requestParameters.listType !== undefined) {
+            queryParameters['listType'] = requestParameters.listType;
+        }
+
         if (requestParameters.limit !== undefined) {
             queryParameters['limit'] = requestParameters.limit;
         }
@@ -438,8 +491,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve list of systems. Use search and select query parameters to limit results.
-     * Retrieve systems
+     * Retrieve list of systems. Use *listType*, *search* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async getSystems(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<RespSystems> {
         const response = await this.getSystemsRaw(requestParameters, initOverrides);
@@ -448,7 +500,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Check if a system is currently enabled, i.e. available for use. 
-     * Check if system is currently enabled
      */
     async isEnabledRaw(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBoolean>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -475,7 +526,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Check if a system is currently enabled, i.e. available for use. 
-     * Check if system is currently enabled
      */
     async isEnabled(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<RespBoolean> {
         const response = await this.isEnabledRaw(requestParameters, initOverrides);
@@ -484,7 +534,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * *WARNING Capability constraint matching is not yet supported.* Retrieve details for systems. Use request body to specify constraint conditions as an SQL-like WHERE clause. 
-     * Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
      */
     async matchConstraintsRaw(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>> {
         if (requestParameters.reqMatchConstraints === null || requestParameters.reqMatchConstraints === undefined) {
@@ -514,7 +563,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * *WARNING Capability constraint matching is not yet supported.* Retrieve details for systems. Use request body to specify constraint conditions as an SQL-like WHERE clause. 
-     * Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
      */
     async matchConstraints(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<RespSystems> {
         const response = await this.matchConstraintsRaw(requestParameters, initOverrides);
@@ -523,7 +571,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Update selected attributes of a system. Request body may only contain updatable attributes. System must exist.  Attributes that may not be updated via PATCH are    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
-     * Update selected attributes of a system
      */
     async patchSystemRaw(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -557,7 +604,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Update selected attributes of a system. Request body may only contain updatable attributes. System must exist.  Attributes that may not be updated via PATCH are    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
-     * Update selected attributes of a system
      */
     async patchSystem(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
         const response = await this.patchSystemRaw(requestParameters, initOverrides);
@@ -565,8 +611,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update all updatable attributes of a system using a request body identical to POST. System must exist.  By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system.  The attributes that are allowed but ignored for both PUT and POST are    - tenant   - uuid   - deleted   - created   - updated  In addition for a PUT operation the following non-updatable attributes are allowed but ignored    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
-     * Update all updatable attributes of a system
+     * Update all updatable attributes of a system using a request body identical to POST. System must exist.  If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel.   By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system.  The attributes that are allowed but ignored for both PUT and POST are    - tenant   - uuid   - deleted   - created   - updated  In addition for a PUT operation the following non-updatable attributes are allowed but ignored    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
      */
     async putSystemRaw(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -603,8 +648,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update all updatable attributes of a system using a request body identical to POST. System must exist.  By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system.  The attributes that are allowed but ignored for both PUT and POST are    - tenant   - uuid   - deleted   - created   - updated  In addition for a PUT operation the following non-updatable attributes are allowed but ignored    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
-     * Update all updatable attributes of a system
+     * Update all updatable attributes of a system using a request body identical to POST. System must exist.  If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel.   By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials.  Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system.  The attributes that are allowed but ignored for both PUT and POST are    - tenant   - uuid   - deleted   - created   - updated  In addition for a PUT operation the following non-updatable attributes are allowed but ignored    - id   - systemType   - owner   - enabled   - bucketName   - rootDir   - isDtn   - canExec  Note that the attributes owner and enabled may be modified using other endpoints. 
      */
     async putSystem(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
         const response = await this.putSystemRaw(requestParameters, initOverrides);
@@ -612,8 +656,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
-     * Retrieve list of systems matching search conditions specified as query parameters
+     * Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async searchSystemsQueryParametersRaw(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>> {
         const queryParameters: any = {};
@@ -622,6 +665,10 @@ export class SystemsApi extends runtime.BaseAPI {
             queryParameters['freeFormParameterName'] = requestParameters.freeFormParameterName;
         }
 
+        if (requestParameters.listType !== undefined) {
+            queryParameters['listType'] = requestParameters.listType;
+        }
+
         if (requestParameters.limit !== undefined) {
             queryParameters['limit'] = requestParameters.limit;
         }
@@ -663,8 +710,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
-     * Retrieve list of systems matching search conditions specified as query parameters
+     * Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async searchSystemsQueryParameters(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<RespSystems> {
         const response = await this.searchSystemsQueryParametersRaw(requestParameters, initOverrides);
@@ -672,8 +718,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve details for systems. Use request body to specify SQL-like search conditions. 
-     * Retrieve list of systems matching search conditions
+     * Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async searchSystemsRequestBodyRaw(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>> {
         if (requestParameters.reqSearchSystems === null || requestParameters.reqSearchSystems === undefined) {
@@ -682,6 +727,10 @@ export class SystemsApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters.listType !== undefined) {
+            queryParameters['listType'] = requestParameters.listType;
+        }
+
         if (requestParameters.limit !== undefined) {
             queryParameters['limit'] = requestParameters.limit;
         }
@@ -726,8 +775,7 @@ export class SystemsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Retrieve details for systems. Use request body to specify SQL-like search conditions. 
-     * Retrieve list of systems matching search conditions
+     * Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are    - *OWNED* Include only items owned by requester (Default)   - *SHARED_PUBLIC* Include only items shared publicly   - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. 
      */
     async searchSystemsRequestBody(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<RespSystems> {
         const response = await this.searchSystemsRequestBodyRaw(requestParameters, initOverrides);
@@ -736,7 +784,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system as not deleted. System will appear in queries. 
-     * Mark a system as not deleted
      */
     async undeleteSystemRaw(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
@@ -763,7 +810,6 @@ export class SystemsApi extends runtime.BaseAPI {
 
     /**
      * Mark a system as not deleted. System will appear in queries. 
-     * Mark a system as not deleted
      */
     async undeleteSystem(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.undeleteSystemRaw(requestParameters, initOverrides);

package/src/apis/index.ts

@@ -1,7 +1,9 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './ChildSystemsApi';
 export * from './CredentialsApi';
 export * from './GeneralApi';
 export * from './PermissionsApi';
 export * from './SchedulerProfilesApi';
+export * from './SharingApi';
 export * from './SystemsApi';

package/src/models/AuthnEnum.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,6 +21,7 @@ export enum AuthnEnum {
     Password = 'PASSWORD',
     PkiKeys = 'PKI_KEYS',
     AccessKey = 'ACCESS_KEY',
+    Token = 'TOKEN',
     Cert = 'CERT'
 }
 

package/src/models/Capability.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/CategoryEnum.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/Credential.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,12 @@ export interface Credential {
      * @memberof Credential
      */
     authnMethod?: AuthnEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Credential
+     */
+    loginUser?: string;
     /**
      * 
      * @type {string}
@@ -62,6 +68,18 @@ export interface Credential {
      * @memberof Credential
      */
     accessSecret?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Credential
+     */
+    accessToken?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Credential
+     */
+    refreshToken?: string;
     /**
      * 
      * @type {string}
@@ -81,11 +99,14 @@ export function CredentialFromJSONTyped(json: any, ignoreDiscriminator: boolean)
     return {
         
         'authnMethod': !exists(json, 'authnMethod') ? undefined : AuthnEnumFromJSON(json['authnMethod']),
+        'loginUser': !exists(json, 'loginUser') ? undefined : json['loginUser'],
         'password': !exists(json, 'password') ? undefined : json['password'],
         'privateKey': !exists(json, 'privateKey') ? undefined : json['privateKey'],
         'publicKey': !exists(json, 'publicKey') ? undefined : json['publicKey'],
         'accessKey': !exists(json, 'accessKey') ? undefined : json['accessKey'],
         'accessSecret': !exists(json, 'accessSecret') ? undefined : json['accessSecret'],
+        'accessToken': !exists(json, 'accessToken') ? undefined : json['accessToken'],
+        'refreshToken': !exists(json, 'refreshToken') ? undefined : json['refreshToken'],
         'certificate': !exists(json, 'certificate') ? undefined : json['certificate'],
     };
 }
@@ -100,11 +121,14 @@ export function CredentialToJSON(value?: Credential | null): any {
     return {
         
         'authnMethod': AuthnEnumToJSON(value.authnMethod),
+        'loginUser': value.loginUser,
         'password': value.password,
         'privateKey': value.privateKey,
         'publicKey': value.publicKey,
         'accessKey': value.accessKey,
         'accessSecret': value.accessSecret,
+        'accessToken': value.accessToken,
+        'refreshToken': value.refreshToken,
         'certificate': value.certificate,
     };
 }

package/src/models/DatatypeEnum.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/JobRuntime.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/models/KeyValuePair.ts

@@ -4,7 +4,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.3.3
  * Contact: cicsupport@tacc.utexas.edu
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,6 +31,12 @@ export interface KeyValuePair {
      * @memberof KeyValuePair
      */
     value?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KeyValuePair
+     */
+    description?: string;
 }
 
 export function KeyValuePairFromJSON(json: any): KeyValuePair {
@@ -45,6 +51,7 @@ export function KeyValuePairFromJSONTyped(json: any, ignoreDiscriminator: boolea
         
         'key': json['key'],
         'value': !exists(json, 'value') ? undefined : json['value'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
     };
 }
 
@@ -59,6 +66,7 @@ export function KeyValuePairToJSON(value?: KeyValuePair | null): any {
         
         'key': value.key,
         'value': value.value,
+        'description': value.description,
     };
 }