@tapis/tapis-typescript-systems 0.0.2 → 0.0.3

package/src/apis/SchedulerProfilesApi.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,9 +15,9 @@
 
 import * as runtime from '../runtime';
 import {
-    ReqCreateSchedulerProfile,
-    ReqCreateSchedulerProfileFromJSON,
-    ReqCreateSchedulerProfileToJSON,
+    ReqPostSchedulerProfile,
+    ReqPostSchedulerProfileFromJSON,
+    ReqPostSchedulerProfileToJSON,
     RespBasic,
     RespBasicFromJSON,
     RespBasicToJSON,
@@ -36,7 +36,7 @@ import {
 } from '../models';
 
 export interface CreateSchedulerProfileRequest {
-    reqCreateSchedulerProfile: ReqCreateSchedulerProfile;
+    reqPostSchedulerProfile: ReqPostSchedulerProfile;
 }
 
 export interface DeleteSchedulerProfileRequest {
@@ -53,12 +53,11 @@ export interface GetSchedulerProfileRequest {
 export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
-     * Create a scheduler profile using a request body. 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.  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 profile. The attributes that are allowed but ignored are    - tenant   - uuid   - created   - updated 
-     * Create a scheduler profile
+     * Create a scheduler profile using a request body. 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.  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 profile. The attributes that are allowed but ignored are    - tenant   - uuid   - created   - updated 
      */
     async createSchedulerProfileRaw(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>> {
-        if (requestParameters.reqCreateSchedulerProfile === null || requestParameters.reqCreateSchedulerProfile === undefined) {
-            throw new runtime.RequiredError('reqCreateSchedulerProfile','Required parameter requestParameters.reqCreateSchedulerProfile was null or undefined when calling createSchedulerProfile.');
+        if (requestParameters.reqPostSchedulerProfile === null || requestParameters.reqPostSchedulerProfile === undefined) {
+            throw new runtime.RequiredError('reqPostSchedulerProfile','Required parameter requestParameters.reqPostSchedulerProfile was null or undefined when calling createSchedulerProfile.');
         }
 
         const queryParameters: any = {};
@@ -76,15 +75,14 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: ReqCreateSchedulerProfileToJSON(requestParameters.reqCreateSchedulerProfile),
+            body: ReqPostSchedulerProfileToJSON(requestParameters.reqPostSchedulerProfile),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => RespResourceUrlFromJSON(jsonValue));
     }
 
     /**
-     * Create a scheduler profile using a request body. 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.  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 profile. The attributes that are allowed but ignored are    - tenant   - uuid   - created   - updated 
-     * Create a scheduler profile
+     * Create a scheduler profile using a request body. 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.  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 profile. The attributes that are allowed but ignored are    - tenant   - uuid   - created   - updated 
      */
     async createSchedulerProfile(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespResourceUrl> {
         const response = await this.createSchedulerProfileRaw(requestParameters, initOverrides);
@@ -93,7 +91,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Remove a scheduler profile given the profile name. Requester must be owner of the profile. 
-     * Delete a scheduler profile
      */
     async deleteSchedulerProfileRaw(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>> {
         if (requestParameters.name === null || requestParameters.name === undefined) {
@@ -120,7 +117,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Remove a scheduler profile given the profile name. Requester must be owner of the profile. 
-     * Delete a scheduler profile
      */
     async deleteSchedulerProfile(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespChangeCount> {
         const response = await this.deleteSchedulerProfileRaw(requestParameters, initOverrides);
@@ -129,7 +125,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Retrieve information for a scheduler profile given the profile name. 
-     * Retrieve a scheduler profile
      */
     async getSchedulerProfileRaw(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfile>> {
         if (requestParameters.name === null || requestParameters.name === undefined) {
@@ -156,7 +151,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Retrieve information for a scheduler profile given the profile name. 
-     * Retrieve a scheduler profile
      */
     async getSchedulerProfile(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespSchedulerProfile> {
         const response = await this.getSchedulerProfileRaw(requestParameters, initOverrides);
@@ -165,7 +159,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Retrieve list of scheduler profiles.
-     * Retrieve scheduler profiles
      */
     async getSchedulerProfilesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfiles>> {
         const queryParameters: any = {};
@@ -188,7 +181,6 @@ export class SchedulerProfilesApi extends runtime.BaseAPI {
 
     /**
      * Retrieve list of scheduler profiles.
-     * Retrieve scheduler profiles
      */
     async getSchedulerProfiles(initOverrides?: RequestInit): Promise<RespSchedulerProfiles> {
         const response = await this.getSchedulerProfilesRaw(initOverrides);

package/src/apis/SharingApi.ts

@@ -0,0 +1,250 @@
+/* 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.3.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 {
+    ReqShareUpdate,
+    ReqShareUpdateFromJSON,
+    ReqShareUpdateToJSON,
+    RespBasic,
+    RespBasicFromJSON,
+    RespBasicToJSON,
+    RespShareInfo,
+    RespShareInfoFromJSON,
+    RespShareInfoToJSON,
+} from '../models';
+
+export interface GetShareInfoRequest {
+    systemId: string;
+}
+
+export interface ShareSystemRequest {
+    systemId: string;
+    reqShareUpdate: ReqShareUpdate;
+}
+
+export interface ShareSystemPublicRequest {
+    systemId: string;
+}
+
+export interface UnShareSystemRequest {
+    systemId: string;
+    reqShareUpdate: ReqShareUpdate;
+}
+
+export interface UnShareSystemPublicRequest {
+    systemId: string;
+}
+
+/**
+ * 
+ */
+export class SharingApi extends runtime.BaseAPI {
+
+    /**
+     * Retrieve all sharing information for a system. This includes all users with whom the system has been shared and whether or not the system has been made publicly available. 
+     * Retrieve all sharing information for a system
+     */
+    async getShareInfoRaw(requestParameters: GetShareInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespShareInfo>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling getShareInfo.');
+        }
+
+        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/share/{systemId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespShareInfoFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve all sharing information for a system. This includes all users with whom the system has been shared and whether or not the system has been made publicly available. 
+     * Retrieve all sharing information for a system
+     */
+    async getShareInfo(requestParameters: GetShareInfoRequest, initOverrides?: RequestInit): Promise<RespShareInfo> {
+        const response = await this.getShareInfoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create or update sharing information for a system. The system will be shared with the list of users provided in the request body. Sharing allows READ and EXECUTE access. Requester must be owner of the system. 
+     * Share a system with one or more users.
+     */
+    async shareSystemRaw(requestParameters: ShareSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling shareSystem.');
+        }
+
+        if (requestParameters.reqShareUpdate === null || requestParameters.reqShareUpdate === undefined) {
+            throw new runtime.RequiredError('reqShareUpdate','Required parameter requestParameters.reqShareUpdate was null or undefined when calling shareSystem.');
+        }
+
+        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/share/{systemId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReqShareUpdateToJSON(requestParameters.reqShareUpdate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
+    }
+
+    /**
+     * Create or update sharing information for a system. The system will be shared with the list of users provided in the request body. Sharing allows READ and EXECUTE access. Requester must be owner of the system. 
+     * Share a system with one or more users.
+     */
+    async shareSystem(requestParameters: ShareSystemRequest, initOverrides?: RequestInit): Promise<RespBasic> {
+        const response = await this.shareSystemRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Share a system with all users in the tenant. Sharing allows READ and EXECUTE access. Requester must be owner of the system. 
+     * Share a system publicly with all users in the tenant.
+     */
+    async shareSystemPublicRaw(requestParameters: ShareSystemPublicRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling shareSystemPublic.');
+        }
+
+        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/share_public/{systemId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
+    }
+
+    /**
+     * Share a system with all users in the tenant. Sharing allows READ and EXECUTE access. Requester must be owner of the system. 
+     * Share a system publicly with all users in the tenant.
+     */
+    async shareSystemPublic(requestParameters: ShareSystemPublicRequest, initOverrides?: RequestInit): Promise<RespBasic> {
+        const response = await this.shareSystemPublicRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create or update sharing information for a system. The system will be unshared with the list of users provided in the request body. Requester must be owner of the system. 
+     * Unshare a system with one or more users.
+     */
+    async unShareSystemRaw(requestParameters: UnShareSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling unShareSystem.');
+        }
+
+        if (requestParameters.reqShareUpdate === null || requestParameters.reqShareUpdate === undefined) {
+            throw new runtime.RequiredError('reqShareUpdate','Required parameter requestParameters.reqShareUpdate was null or undefined when calling unShareSystem.');
+        }
+
+        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/unshare/{systemId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReqShareUpdateToJSON(requestParameters.reqShareUpdate),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
+    }
+
+    /**
+     * Create or update sharing information for a system. The system will be unshared with the list of users provided in the request body. Requester must be owner of the system. 
+     * Unshare a system with one or more users.
+     */
+    async unShareSystem(requestParameters: UnShareSystemRequest, initOverrides?: RequestInit): Promise<RespBasic> {
+        const response = await this.unShareSystemRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Remove public sharing for a system. Requester must be owner of the system. 
+     * Remove public access for a system.
+     */
+    async unShareSystemPublicRaw(requestParameters: UnShareSystemPublicRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>> {
+        if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
+            throw new runtime.RequiredError('systemId','Required parameter requestParameters.systemId was null or undefined when calling unShareSystemPublic.');
+        }
+
+        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/unshare_public/{systemId}`.replace(`{${"systemId"}}`, encodeURIComponent(String(requestParameters.systemId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RespBasicFromJSON(jsonValue));
+    }
+
+    /**
+     * Remove public sharing for a system. Requester must be owner of the system. 
+     * Remove public access for a system.
+     */
+    async unShareSystemPublic(requestParameters: UnShareSystemPublicRequest, initOverrides?: RequestInit): Promise<RespBasic> {
+        const response = await this.unShareSystemPublicRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}