@cirrobio/api-client 0.12.5 → 0.12.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -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 @cirrobio/api-client@0.12.5 --save
39
+ npm install @cirrobio/api-client@0.12.7 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
13
+ import type { CreateResponse, PostponeWorkspaceAutostopInput, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
14
14
  export interface ConnectWorkspaceRequest {
15
15
  projectId: string;
16
16
  workspaceId: string;
@@ -35,6 +35,11 @@ export interface GetWorkspaceRequest {
35
35
  export interface GetWorkspacesRequest {
36
36
  projectId: string;
37
37
  }
38
+ export interface PostponeAutoStopRequest {
39
+ projectId: string;
40
+ workspaceId: string;
41
+ postponeWorkspaceAutostopInput: PostponeWorkspaceAutostopInput;
42
+ }
38
43
  export interface StartWorkspaceRequest {
39
44
  projectId: string;
40
45
  workspaceId: string;
@@ -122,6 +127,16 @@ export declare class WorkspacesApi extends runtime.BaseAPI {
122
127
  * Get workspaces
123
128
  */
124
129
  getWorkspaces(requestParameters: GetWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Workspace>>;
130
+ /**
131
+ * Postpone autostop for the given workspace
132
+ * Postpone workspace autostop
133
+ */
134
+ postponeAutoStopRaw(requestParameters: PostponeAutoStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
135
+ /**
136
+ * Postpone autostop for the given workspace
137
+ * Postpone workspace autostop
138
+ */
139
+ postponeAutoStop(requestParameters: PostponeAutoStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
125
140
  /**
126
141
  * Starts a workspace instance
127
142
  * Start workspace
@@ -306,6 +306,51 @@ class WorkspacesApi extends runtime.BaseAPI {
306
306
  return yield response.value();
307
307
  });
308
308
  }
309
+ /**
310
+ * Postpone autostop for the given workspace
311
+ * Postpone workspace autostop
312
+ */
313
+ postponeAutoStopRaw(requestParameters, initOverrides) {
314
+ return __awaiter(this, void 0, void 0, function* () {
315
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
316
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling postponeAutoStop.');
317
+ }
318
+ if (requestParameters.workspaceId === null || requestParameters.workspaceId === undefined) {
319
+ throw new runtime.RequiredError('workspaceId', 'Required parameter requestParameters.workspaceId was null or undefined when calling postponeAutoStop.');
320
+ }
321
+ if (requestParameters.postponeWorkspaceAutostopInput === null || requestParameters.postponeWorkspaceAutostopInput === undefined) {
322
+ throw new runtime.RequiredError('postponeWorkspaceAutostopInput', 'Required parameter requestParameters.postponeWorkspaceAutostopInput was null or undefined when calling postponeAutoStop.');
323
+ }
324
+ const queryParameters = {};
325
+ const headerParameters = {};
326
+ headerParameters['Content-Type'] = 'application/json';
327
+ if (this.configuration && this.configuration.accessToken) {
328
+ const token = this.configuration.accessToken;
329
+ const tokenString = yield token("accessToken", []);
330
+ if (tokenString) {
331
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
332
+ }
333
+ }
334
+ const response = yield this.request({
335
+ path: `/projects/{projectId}/workspaces/{workspaceId}:postpone-auto-stop`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"workspaceId"}}`, encodeURIComponent(String(requestParameters.workspaceId))),
336
+ method: 'POST',
337
+ headers: headerParameters,
338
+ query: queryParameters,
339
+ body: (0, index_1.PostponeWorkspaceAutostopInputToJSON)(requestParameters.postponeWorkspaceAutostopInput),
340
+ }, initOverrides);
341
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkspaceFromJSON)(jsonValue));
342
+ });
343
+ }
344
+ /**
345
+ * Postpone autostop for the given workspace
346
+ * Postpone workspace autostop
347
+ */
348
+ postponeAutoStop(requestParameters, initOverrides) {
349
+ return __awaiter(this, void 0, void 0, function* () {
350
+ const response = yield this.postponeAutoStopRaw(requestParameters, initOverrides);
351
+ return yield response.value();
352
+ });
353
+ }
309
354
  /**
310
355
  * Starts a workspace instance
311
356
  * Start workspace
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateResponse, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
13
+ import type { CreateResponse, PostponeWorkspaceAutostopInput, Workspace, WorkspaceConnectionResponse, WorkspaceEnvironment, WorkspaceInput } from '../models/index';
14
14
  export interface ConnectWorkspaceRequest {
15
15
  projectId: string;
16
16
  workspaceId: string;
@@ -35,6 +35,11 @@ export interface GetWorkspaceRequest {
35
35
  export interface GetWorkspacesRequest {
36
36
  projectId: string;
37
37
  }
38
+ export interface PostponeAutoStopRequest {
39
+ projectId: string;
40
+ workspaceId: string;
41
+ postponeWorkspaceAutostopInput: PostponeWorkspaceAutostopInput;
42
+ }
38
43
  export interface StartWorkspaceRequest {
39
44
  projectId: string;
40
45
  workspaceId: string;
@@ -122,6 +127,16 @@ export declare class WorkspacesApi extends runtime.BaseAPI {
122
127
  * Get workspaces
123
128
  */
124
129
  getWorkspaces(requestParameters: GetWorkspacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Workspace>>;
130
+ /**
131
+ * Postpone autostop for the given workspace
132
+ * Postpone workspace autostop
133
+ */
134
+ postponeAutoStopRaw(requestParameters: PostponeAutoStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Workspace>>;
135
+ /**
136
+ * Postpone autostop for the given workspace
137
+ * Postpone workspace autostop
138
+ */
139
+ postponeAutoStop(requestParameters: PostponeAutoStopRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Workspace>;
125
140
  /**
126
141
  * Starts a workspace instance
127
142
  * Start workspace
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { CreateResponseFromJSON, WorkspaceFromJSON, WorkspaceConnectionResponseFromJSON, WorkspaceEnvironmentFromJSON, WorkspaceInputToJSON, } from '../models/index';
24
+ import { CreateResponseFromJSON, PostponeWorkspaceAutostopInputToJSON, WorkspaceFromJSON, WorkspaceConnectionResponseFromJSON, WorkspaceEnvironmentFromJSON, WorkspaceInputToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -303,6 +303,51 @@ export class WorkspacesApi extends runtime.BaseAPI {
303
303
  return yield response.value();
304
304
  });
305
305
  }
306
+ /**
307
+ * Postpone autostop for the given workspace
308
+ * Postpone workspace autostop
309
+ */
310
+ postponeAutoStopRaw(requestParameters, initOverrides) {
311
+ return __awaiter(this, void 0, void 0, function* () {
312
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
313
+ throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling postponeAutoStop.');
314
+ }
315
+ if (requestParameters.workspaceId === null || requestParameters.workspaceId === undefined) {
316
+ throw new runtime.RequiredError('workspaceId', 'Required parameter requestParameters.workspaceId was null or undefined when calling postponeAutoStop.');
317
+ }
318
+ if (requestParameters.postponeWorkspaceAutostopInput === null || requestParameters.postponeWorkspaceAutostopInput === undefined) {
319
+ throw new runtime.RequiredError('postponeWorkspaceAutostopInput', 'Required parameter requestParameters.postponeWorkspaceAutostopInput was null or undefined when calling postponeAutoStop.');
320
+ }
321
+ const queryParameters = {};
322
+ const headerParameters = {};
323
+ headerParameters['Content-Type'] = 'application/json';
324
+ if (this.configuration && this.configuration.accessToken) {
325
+ const token = this.configuration.accessToken;
326
+ const tokenString = yield token("accessToken", []);
327
+ if (tokenString) {
328
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
329
+ }
330
+ }
331
+ const response = yield this.request({
332
+ path: `/projects/{projectId}/workspaces/{workspaceId}:postpone-auto-stop`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"workspaceId"}}`, encodeURIComponent(String(requestParameters.workspaceId))),
333
+ method: 'POST',
334
+ headers: headerParameters,
335
+ query: queryParameters,
336
+ body: PostponeWorkspaceAutostopInputToJSON(requestParameters.postponeWorkspaceAutostopInput),
337
+ }, initOverrides);
338
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkspaceFromJSON(jsonValue));
339
+ });
340
+ }
341
+ /**
342
+ * Postpone autostop for the given workspace
343
+ * Postpone workspace autostop
344
+ */
345
+ postponeAutoStop(requestParameters, initOverrides) {
346
+ return __awaiter(this, void 0, void 0, function* () {
347
+ const response = yield this.postponeAutoStopRaw(requestParameters, initOverrides);
348
+ return yield response.value();
349
+ });
350
+ }
306
351
  /**
307
352
  * Starts a workspace instance
308
353
  * Start workspace
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Cirro Data
3
+ * Cirro Data Platform service API
4
+ *
5
+ * The version of the OpenAPI document: latest
6
+ * Contact: support@cirro.bio
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostponeWorkspaceAutostopInput
16
+ */
17
+ export interface PostponeWorkspaceAutostopInput {
18
+ /**
19
+ * Time period (in hours) to automatically stop the workspace if running
20
+ * @type {number}
21
+ * @memberof PostponeWorkspaceAutostopInput
22
+ */
23
+ autoStopTimeout?: number;
24
+ }
25
+ /**
26
+ * Check if a given object implements the PostponeWorkspaceAutostopInput interface.
27
+ */
28
+ export declare function instanceOfPostponeWorkspaceAutostopInput(value: object): boolean;
29
+ export declare function PostponeWorkspaceAutostopInputFromJSON(json: any): PostponeWorkspaceAutostopInput;
30
+ export declare function PostponeWorkspaceAutostopInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostponeWorkspaceAutostopInput;
31
+ export declare function PostponeWorkspaceAutostopInputToJSON(value?: PostponeWorkspaceAutostopInput | null): any;
@@ -0,0 +1,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Cirro Data
5
+ * Cirro Data Platform service API
6
+ *
7
+ * The version of the OpenAPI document: latest
8
+ * Contact: support@cirro.bio
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { exists } from '../runtime';
15
+ /**
16
+ * Check if a given object implements the PostponeWorkspaceAutostopInput interface.
17
+ */
18
+ export function instanceOfPostponeWorkspaceAutostopInput(value) {
19
+ let isInstance = true;
20
+ return isInstance;
21
+ }
22
+ export function PostponeWorkspaceAutostopInputFromJSON(json) {
23
+ return PostponeWorkspaceAutostopInputFromJSONTyped(json, false);
24
+ }
25
+ export function PostponeWorkspaceAutostopInputFromJSONTyped(json, ignoreDiscriminator) {
26
+ if ((json === undefined) || (json === null)) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'autoStopTimeout': !exists(json, 'autoStopTimeout') ? undefined : json['autoStopTimeout'],
31
+ };
32
+ }
33
+ export function PostponeWorkspaceAutostopInputToJSON(value) {
34
+ if (value === undefined) {
35
+ return undefined;
36
+ }
37
+ if (value === null) {
38
+ return null;
39
+ }
40
+ return {
41
+ 'autoStopTimeout': value.autoStopTimeout,
42
+ };
43
+ }
@@ -104,6 +104,12 @@ export interface Workspace {
104
104
  * @memberof Workspace
105
105
  */
106
106
  startedAt?: Date | null;
107
+ /**
108
+ *
109
+ * @type {Date}
110
+ * @memberof Workspace
111
+ */
112
+ autoStopTime?: Date | null;
107
113
  /**
108
114
  *
109
115
  * @type {Date}
@@ -58,6 +58,7 @@ export function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
58
58
  'createdBy': json['createdBy'],
59
59
  'createdAt': (new Date(json['createdAt'])),
60
60
  'startedAt': !exists(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
61
+ 'autoStopTime': !exists(json, 'autoStopTime') ? undefined : (json['autoStopTime'] === null ? null : new Date(json['autoStopTime'])),
61
62
  'updatedAt': (new Date(json['updatedAt'])),
62
63
  };
63
64
  }
@@ -83,6 +84,7 @@ export function WorkspaceToJSON(value) {
83
84
  'createdBy': value.createdBy,
84
85
  'createdAt': (value.createdAt.toISOString()),
85
86
  'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
87
+ 'autoStopTime': value.autoStopTime === undefined ? undefined : (value.autoStopTime === null ? null : value.autoStopTime.toISOString()),
86
88
  'updatedAt': (value.updatedAt.toISOString()),
87
89
  };
88
90
  }
@@ -95,6 +95,7 @@ export * from './PaginatedResponseUserDto';
95
95
  export * from './PipelineCode';
96
96
  export * from './PipelineCost';
97
97
  export * from './PortalErrorResponse';
98
+ export * from './PostponeWorkspaceAutostopInput';
98
99
  export * from './Process';
99
100
  export * from './ProcessDetail';
100
101
  export * from './Project';
@@ -97,6 +97,7 @@ export * from './PaginatedResponseUserDto';
97
97
  export * from './PipelineCode';
98
98
  export * from './PipelineCost';
99
99
  export * from './PortalErrorResponse';
100
+ export * from './PostponeWorkspaceAutostopInput';
100
101
  export * from './Process';
101
102
  export * from './ProcessDetail';
102
103
  export * from './Project';
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Cirro Data
3
+ * Cirro Data Platform service API
4
+ *
5
+ * The version of the OpenAPI document: latest
6
+ * Contact: support@cirro.bio
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
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostponeWorkspaceAutostopInput
16
+ */
17
+ export interface PostponeWorkspaceAutostopInput {
18
+ /**
19
+ * Time period (in hours) to automatically stop the workspace if running
20
+ * @type {number}
21
+ * @memberof PostponeWorkspaceAutostopInput
22
+ */
23
+ autoStopTimeout?: number;
24
+ }
25
+ /**
26
+ * Check if a given object implements the PostponeWorkspaceAutostopInput interface.
27
+ */
28
+ export declare function instanceOfPostponeWorkspaceAutostopInput(value: object): boolean;
29
+ export declare function PostponeWorkspaceAutostopInputFromJSON(json: any): PostponeWorkspaceAutostopInput;
30
+ export declare function PostponeWorkspaceAutostopInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostponeWorkspaceAutostopInput;
31
+ export declare function PostponeWorkspaceAutostopInputToJSON(value?: PostponeWorkspaceAutostopInput | null): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Cirro Data
6
+ * Cirro Data Platform service API
7
+ *
8
+ * The version of the OpenAPI document: latest
9
+ * Contact: support@cirro.bio
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
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PostponeWorkspaceAutostopInputToJSON = exports.PostponeWorkspaceAutostopInputFromJSONTyped = exports.PostponeWorkspaceAutostopInputFromJSON = exports.instanceOfPostponeWorkspaceAutostopInput = void 0;
17
+ const runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the PostponeWorkspaceAutostopInput interface.
20
+ */
21
+ function instanceOfPostponeWorkspaceAutostopInput(value) {
22
+ let isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfPostponeWorkspaceAutostopInput = instanceOfPostponeWorkspaceAutostopInput;
26
+ function PostponeWorkspaceAutostopInputFromJSON(json) {
27
+ return PostponeWorkspaceAutostopInputFromJSONTyped(json, false);
28
+ }
29
+ exports.PostponeWorkspaceAutostopInputFromJSON = PostponeWorkspaceAutostopInputFromJSON;
30
+ function PostponeWorkspaceAutostopInputFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'autoStopTimeout': !(0, runtime_1.exists)(json, 'autoStopTimeout') ? undefined : json['autoStopTimeout'],
36
+ };
37
+ }
38
+ exports.PostponeWorkspaceAutostopInputFromJSONTyped = PostponeWorkspaceAutostopInputFromJSONTyped;
39
+ function PostponeWorkspaceAutostopInputToJSON(value) {
40
+ if (value === undefined) {
41
+ return undefined;
42
+ }
43
+ if (value === null) {
44
+ return null;
45
+ }
46
+ return {
47
+ 'autoStopTimeout': value.autoStopTimeout,
48
+ };
49
+ }
50
+ exports.PostponeWorkspaceAutostopInputToJSON = PostponeWorkspaceAutostopInputToJSON;
@@ -104,6 +104,12 @@ export interface Workspace {
104
104
  * @memberof Workspace
105
105
  */
106
106
  startedAt?: Date | null;
107
+ /**
108
+ *
109
+ * @type {Date}
110
+ * @memberof Workspace
111
+ */
112
+ autoStopTime?: Date | null;
107
113
  /**
108
114
  *
109
115
  * @type {Date}
@@ -63,6 +63,7 @@ function WorkspaceFromJSONTyped(json, ignoreDiscriminator) {
63
63
  'createdBy': json['createdBy'],
64
64
  'createdAt': (new Date(json['createdAt'])),
65
65
  'startedAt': !(0, runtime_1.exists)(json, 'startedAt') ? undefined : (json['startedAt'] === null ? null : new Date(json['startedAt'])),
66
+ 'autoStopTime': !(0, runtime_1.exists)(json, 'autoStopTime') ? undefined : (json['autoStopTime'] === null ? null : new Date(json['autoStopTime'])),
66
67
  'updatedAt': (new Date(json['updatedAt'])),
67
68
  };
68
69
  }
@@ -89,6 +90,7 @@ function WorkspaceToJSON(value) {
89
90
  'createdBy': value.createdBy,
90
91
  'createdAt': (value.createdAt.toISOString()),
91
92
  'startedAt': value.startedAt === undefined ? undefined : (value.startedAt === null ? null : value.startedAt.toISOString()),
93
+ 'autoStopTime': value.autoStopTime === undefined ? undefined : (value.autoStopTime === null ? null : value.autoStopTime.toISOString()),
92
94
  'updatedAt': (value.updatedAt.toISOString()),
93
95
  };
94
96
  }
@@ -95,6 +95,7 @@ export * from './PaginatedResponseUserDto';
95
95
  export * from './PipelineCode';
96
96
  export * from './PipelineCost';
97
97
  export * from './PortalErrorResponse';
98
+ export * from './PostponeWorkspaceAutostopInput';
98
99
  export * from './Process';
99
100
  export * from './ProcessDetail';
100
101
  export * from './Project';
@@ -113,6 +113,7 @@ __exportStar(require("./PaginatedResponseUserDto"), exports);
113
113
  __exportStar(require("./PipelineCode"), exports);
114
114
  __exportStar(require("./PipelineCost"), exports);
115
115
  __exportStar(require("./PortalErrorResponse"), exports);
116
+ __exportStar(require("./PostponeWorkspaceAutostopInput"), exports);
116
117
  __exportStar(require("./Process"), exports);
117
118
  __exportStar(require("./ProcessDetail"), exports);
118
119
  __exportStar(require("./Project"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.12.5",
3
+ "version": "0.12.7",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {