@coval/sdk 0.4.4 → 0.4.6
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/dist/CovalClient.d.ts +3 -2
- package/dist/CovalClient.d.ts.map +1 -1
- package/dist/CovalClient.js +4 -1
- package/dist/CovalClient.js.map +1 -1
- package/dist/generated/apis/MetricsApi.d.ts +4 -4
- package/dist/generated/apis/MetricsApi.js +2 -2
- package/dist/generated/apis/RunsApi.d.ts +11 -10
- package/dist/generated/apis/RunsApi.d.ts.map +1 -1
- package/dist/generated/apis/RunsApi.js +4 -3
- package/dist/generated/apis/RunsApi.js.map +1 -1
- package/dist/generated/apis/SimulationsApi.d.ts +4 -4
- package/dist/generated/apis/SimulationsApi.js +2 -2
- package/dist/generated/apis/WorkspacesApi.d.ts +256 -0
- package/dist/generated/apis/WorkspacesApi.d.ts.map +1 -0
- package/dist/generated/apis/WorkspacesApi.js +254 -0
- package/dist/generated/apis/WorkspacesApi.js.map +1 -0
- package/dist/generated/apis/index.d.ts +1 -0
- package/dist/generated/apis/index.d.ts.map +1 -1
- package/dist/generated/apis/index.js +1 -0
- package/dist/generated/apis/index.js.map +1 -1
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.d.ts +5 -6
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalAgentsAPICreateAgentRequest.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPICreateMetricRequest.d.ts +62 -3
- package/dist/generated/models/CovalMetricsAPICreateMetricRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPICreateMetricRequest.js +26 -0
- package/dist/generated/models/CovalMetricsAPICreateMetricRequest.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPIMetricResource.d.ts +51 -3
- package/dist/generated/models/CovalMetricsAPIMetricResource.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPIMetricResource.js +26 -0
- package/dist/generated/models/CovalMetricsAPIMetricResource.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPIMetricType.d.ts +3 -0
- package/dist/generated/models/CovalMetricsAPIMetricType.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPIMetricType.js +4 -1
- package/dist/generated/models/CovalMetricsAPIMetricType.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPITestMetricBatchItemResult.d.ts +52 -0
- package/dist/generated/models/CovalMetricsAPITestMetricBatchItemResult.d.ts.map +1 -0
- package/dist/generated/models/CovalMetricsAPITestMetricBatchItemResult.js +53 -0
- package/dist/generated/models/CovalMetricsAPITestMetricBatchItemResult.js.map +1 -0
- package/dist/generated/models/CovalMetricsAPITestMetricItemStatus.d.ts +34 -0
- package/dist/generated/models/CovalMetricsAPITestMetricItemStatus.d.ts.map +1 -0
- package/dist/generated/models/CovalMetricsAPITestMetricItemStatus.js +52 -0
- package/dist/generated/models/CovalMetricsAPITestMetricItemStatus.js.map +1 -0
- package/dist/generated/models/CovalMetricsAPITestMetricRequest.d.ts +10 -3
- package/dist/generated/models/CovalMetricsAPITestMetricRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPITestMetricRequest.js +3 -3
- package/dist/generated/models/CovalMetricsAPITestMetricRequest.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPITestMetricResponse.d.ts +10 -2
- package/dist/generated/models/CovalMetricsAPITestMetricResponse.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPITestMetricResponse.js +5 -0
- package/dist/generated/models/CovalMetricsAPITestMetricResponse.js.map +1 -1
- package/dist/generated/models/CovalMetricsAPIUpdateMetricRequest.d.ts +51 -1
- package/dist/generated/models/CovalMetricsAPIUpdateMetricRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalMetricsAPIUpdateMetricRequest.js +26 -0
- package/dist/generated/models/CovalMetricsAPIUpdateMetricRequest.js.map +1 -1
- package/dist/generated/models/CovalReviewsAPICreateReviewProjectRequest.d.ts +6 -0
- package/dist/generated/models/CovalReviewsAPICreateReviewProjectRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalReviewsAPICreateReviewProjectRequest.js +2 -0
- package/dist/generated/models/CovalReviewsAPICreateReviewProjectRequest.js.map +1 -1
- package/dist/generated/models/CovalReviewsAPIReviewProjectResource.d.ts +6 -0
- package/dist/generated/models/CovalReviewsAPIReviewProjectResource.d.ts.map +1 -1
- package/dist/generated/models/CovalReviewsAPIReviewProjectResource.js +2 -0
- package/dist/generated/models/CovalReviewsAPIReviewProjectResource.js.map +1 -1
- package/dist/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.d.ts +20 -0
- package/dist/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.d.ts.map +1 -1
- package/dist/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.js +11 -0
- package/dist/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.js.map +1 -1
- package/dist/generated/models/CovalRunsAPIMonitoringRunTagUpdateResource.d.ts +45 -0
- package/dist/generated/models/CovalRunsAPIMonitoringRunTagUpdateResource.d.ts.map +1 -0
- package/dist/generated/models/CovalRunsAPIMonitoringRunTagUpdateResource.js +52 -0
- package/dist/generated/models/CovalRunsAPIMonitoringRunTagUpdateResource.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPICreateWorkspaceRequest.d.ts +39 -0
- package/dist/generated/models/CovalWorkspacesAPICreateWorkspaceRequest.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPICreateWorkspaceRequest.js +48 -0
- package/dist/generated/models/CovalWorkspacesAPICreateWorkspaceRequest.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponse.d.ts +34 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponse.js +45 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponse.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponseError.d.ts +58 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponseError.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponseError.js +64 -0
- package/dist/generated/models/CovalWorkspacesAPIErrorResponseError.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIListWorkspacesResponse.d.ts +34 -0
- package/dist/generated/models/CovalWorkspacesAPIListWorkspacesResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIListWorkspacesResponse.js +45 -0
- package/dist/generated/models/CovalWorkspacesAPIListWorkspacesResponse.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIUpdateWorkspaceRequest.d.ts +33 -0
- package/dist/generated/models/CovalWorkspacesAPIUpdateWorkspaceRequest.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIUpdateWorkspaceRequest.js +44 -0
- package/dist/generated/models/CovalWorkspacesAPIUpdateWorkspaceRequest.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResource.d.ts +86 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResource.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResource.js +83 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResource.js.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResponse.d.ts +34 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResponse.d.ts.map +1 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResponse.js +45 -0
- package/dist/generated/models/CovalWorkspacesAPIWorkspaceResponse.js.map +1 -0
- package/dist/generated/models/UpdateRun200Response.d.ts +34 -0
- package/dist/generated/models/UpdateRun200Response.d.ts.map +1 -0
- package/dist/generated/models/UpdateRun200Response.js +45 -0
- package/dist/generated/models/UpdateRun200Response.js.map +1 -0
- package/dist/generated/models/UpdateRun200ResponseRun.d.ts +24 -0
- package/dist/generated/models/UpdateRun200ResponseRun.d.ts.map +1 -0
- package/dist/generated/models/UpdateRun200ResponseRun.js +52 -0
- package/dist/generated/models/UpdateRun200ResponseRun.js.map +1 -0
- package/dist/generated/models/index.d.ts +12 -0
- package/dist/generated/models/index.d.ts.map +1 -1
- package/dist/generated/models/index.js +12 -0
- package/dist/generated/models/index.js.map +1 -1
- package/package.json +1 -1
- package/src/CovalClient.ts +4 -0
- package/src/generated/apis/MetricsApi.ts +4 -4
- package/src/generated/apis/RunsApi.ts +16 -11
- package/src/generated/apis/SimulationsApi.ts +4 -4
- package/src/generated/apis/WorkspacesApi.ts +531 -0
- package/src/generated/apis/index.ts +1 -0
- package/src/generated/models/CovalAgentsAPICreateAgentRequest.ts +5 -6
- package/src/generated/models/CovalMetricsAPICreateMetricRequest.ts +74 -3
- package/src/generated/models/CovalMetricsAPIMetricResource.ts +63 -3
- package/src/generated/models/CovalMetricsAPIMetricType.ts +4 -1
- package/src/generated/models/CovalMetricsAPITestMetricBatchItemResult.ts +101 -0
- package/src/generated/models/CovalMetricsAPITestMetricItemStatus.ts +61 -0
- package/src/generated/models/CovalMetricsAPITestMetricRequest.ts +13 -5
- package/src/generated/models/CovalMetricsAPITestMetricResponse.ts +20 -2
- package/src/generated/models/CovalMetricsAPIUpdateMetricRequest.ts +63 -1
- package/src/generated/models/CovalReviewsAPICreateReviewProjectRequest.ts +8 -0
- package/src/generated/models/CovalReviewsAPIReviewProjectResource.ts +8 -0
- package/src/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.ts +27 -0
- package/src/generated/models/CovalRunsAPIMonitoringRunTagUpdateResource.ts +84 -0
- package/src/generated/models/CovalWorkspacesAPICreateWorkspaceRequest.ts +75 -0
- package/src/generated/models/CovalWorkspacesAPIErrorResponse.ts +74 -0
- package/src/generated/models/CovalWorkspacesAPIErrorResponseError.ts +107 -0
- package/src/generated/models/CovalWorkspacesAPIListWorkspacesResponse.ts +74 -0
- package/src/generated/models/CovalWorkspacesAPIUpdateWorkspaceRequest.ts +66 -0
- package/src/generated/models/CovalWorkspacesAPIWorkspaceResource.ts +141 -0
- package/src/generated/models/CovalWorkspacesAPIWorkspaceResponse.ts +74 -0
- package/src/generated/models/UpdateRun200Response.ts +74 -0
- package/src/generated/models/UpdateRun200ResponseRun.ts +76 -0
- package/src/generated/models/index.ts +12 -0
|
@@ -48,6 +48,11 @@ import {
|
|
|
48
48
|
ListRuns400ResponseFromJSON,
|
|
49
49
|
ListRuns400ResponseToJSON,
|
|
50
50
|
} from '../models/ListRuns400Response.js';
|
|
51
|
+
import {
|
|
52
|
+
type UpdateRun200Response,
|
|
53
|
+
UpdateRun200ResponseFromJSON,
|
|
54
|
+
UpdateRun200ResponseToJSON,
|
|
55
|
+
} from '../models/UpdateRun200Response.js';
|
|
51
56
|
|
|
52
57
|
export interface DeleteRunRequest {
|
|
53
58
|
runId: string;
|
|
@@ -209,7 +214,7 @@ export interface RunsApiInterface {
|
|
|
209
214
|
|
|
210
215
|
/**
|
|
211
216
|
* Creates request options for updateRun without sending the request
|
|
212
|
-
* @param {string} runId Unique identifier for the run
|
|
217
|
+
* @param {string} runId Unique identifier for the run. Simulation run ids are 22 characters; monitored conversations are their own runs and their ids may be up to 26 characters, so tagging a conversation uses its conversation id here.
|
|
213
218
|
* @param {CovalRunsAPIUpdateRunRequest} covalRunsAPIUpdateRunRequest
|
|
214
219
|
* @throws {RequiredError}
|
|
215
220
|
* @memberof RunsApiInterface
|
|
@@ -217,21 +222,21 @@ export interface RunsApiInterface {
|
|
|
217
222
|
updateRunRequestOpts(requestParameters: UpdateRunRequest): Promise<runtime.RequestOpts>;
|
|
218
223
|
|
|
219
224
|
/**
|
|
220
|
-
* Replace the tag set for an existing simulation run. Provide an empty list to clear all tags.
|
|
225
|
+
* Replace the tag set for an existing run. Works for simulation runs and for monitored conversations, which are their own runs, so PATCHing a conversation\'s run id tags exactly that conversation. Provide an empty list to clear all tags. For a monitored conversation the response is a minimal confirmation of the tag write (name, run_id, tags); conversation lifecycle fields belong to the `conversations:read` scope and are not returned here.
|
|
221
226
|
* @summary Update run
|
|
222
|
-
* @param {string} runId Unique identifier for the run
|
|
227
|
+
* @param {string} runId Unique identifier for the run. Simulation run ids are 22 characters; monitored conversations are their own runs and their ids may be up to 26 characters, so tagging a conversation uses its conversation id here.
|
|
223
228
|
* @param {CovalRunsAPIUpdateRunRequest} covalRunsAPIUpdateRunRequest
|
|
224
229
|
* @param {*} [options] Override http request option.
|
|
225
230
|
* @throws {RequiredError}
|
|
226
231
|
* @memberof RunsApiInterface
|
|
227
232
|
*/
|
|
228
|
-
updateRunRaw(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
233
|
+
updateRunRaw(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateRun200Response>>;
|
|
229
234
|
|
|
230
235
|
/**
|
|
231
|
-
* Replace the tag set for an existing simulation run. Provide an empty list to clear all tags.
|
|
236
|
+
* Replace the tag set for an existing run. Works for simulation runs and for monitored conversations, which are their own runs, so PATCHing a conversation\'s run id tags exactly that conversation. Provide an empty list to clear all tags. For a monitored conversation the response is a minimal confirmation of the tag write (name, run_id, tags); conversation lifecycle fields belong to the `conversations:read` scope and are not returned here.
|
|
232
237
|
* Update run
|
|
233
238
|
*/
|
|
234
|
-
updateRun(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
239
|
+
updateRun(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateRun200Response>;
|
|
235
240
|
|
|
236
241
|
}
|
|
237
242
|
|
|
@@ -543,21 +548,21 @@ export class RunsApi extends runtime.BaseAPI implements RunsApiInterface {
|
|
|
543
548
|
}
|
|
544
549
|
|
|
545
550
|
/**
|
|
546
|
-
* Replace the tag set for an existing simulation run. Provide an empty list to clear all tags.
|
|
551
|
+
* Replace the tag set for an existing run. Works for simulation runs and for monitored conversations, which are their own runs, so PATCHing a conversation\'s run id tags exactly that conversation. Provide an empty list to clear all tags. For a monitored conversation the response is a minimal confirmation of the tag write (name, run_id, tags); conversation lifecycle fields belong to the `conversations:read` scope and are not returned here.
|
|
547
552
|
* Update run
|
|
548
553
|
*/
|
|
549
|
-
async updateRunRaw(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
554
|
+
async updateRunRaw(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateRun200Response>> {
|
|
550
555
|
const requestOptions = await this.updateRunRequestOpts(requestParameters);
|
|
551
556
|
const response = await this.request(requestOptions, initOverrides);
|
|
552
557
|
|
|
553
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
558
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => UpdateRun200ResponseFromJSON(jsonValue));
|
|
554
559
|
}
|
|
555
560
|
|
|
556
561
|
/**
|
|
557
|
-
* Replace the tag set for an existing simulation run. Provide an empty list to clear all tags.
|
|
562
|
+
* Replace the tag set for an existing run. Works for simulation runs and for monitored conversations, which are their own runs, so PATCHing a conversation\'s run id tags exactly that conversation. Provide an empty list to clear all tags. For a monitored conversation the response is a minimal confirmation of the tag write (name, run_id, tags); conversation lifecycle fields belong to the `conversations:read` scope and are not returned here.
|
|
558
563
|
* Update run
|
|
559
564
|
*/
|
|
560
|
-
async updateRun(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
565
|
+
async updateRun(requestParameters: UpdateRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateRun200Response> {
|
|
561
566
|
const response = await this.updateRunRaw(requestParameters, initOverrides);
|
|
562
567
|
return await response.value();
|
|
563
568
|
}
|
|
@@ -238,7 +238,7 @@ export interface SimulationsApiInterface {
|
|
|
238
238
|
resimulateSimulationRequestOpts(requestParameters: ResimulateSimulationRequest): Promise<runtime.RequestOpts>;
|
|
239
239
|
|
|
240
240
|
/**
|
|
241
|
-
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes.
|
|
241
|
+
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes. The rerun executes the agent\'s current configuration, while the persona prompt and test case parameters recorded on the original run are preserved.
|
|
242
242
|
* @summary Rerun a simulation
|
|
243
243
|
* @param {string} simulationId The simulation ID to rerun
|
|
244
244
|
* @param {object} [body]
|
|
@@ -249,7 +249,7 @@ export interface SimulationsApiInterface {
|
|
|
249
249
|
resimulateSimulationRaw(requestParameters: ResimulateSimulationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalSimulationsAPIResimulateSimulationResponse>>;
|
|
250
250
|
|
|
251
251
|
/**
|
|
252
|
-
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes.
|
|
252
|
+
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes. The rerun executes the agent\'s current configuration, while the persona prompt and test case parameters recorded on the original run are preserved.
|
|
253
253
|
* Rerun a simulation
|
|
254
254
|
*/
|
|
255
255
|
resimulateSimulation(requestParameters: ResimulateSimulationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalSimulationsAPIResimulateSimulationResponse>;
|
|
@@ -591,7 +591,7 @@ export class SimulationsApi extends runtime.BaseAPI implements SimulationsApiInt
|
|
|
591
591
|
}
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes.
|
|
594
|
+
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes. The rerun executes the agent\'s current configuration, while the persona prompt and test case parameters recorded on the original run are preserved.
|
|
595
595
|
* Rerun a simulation
|
|
596
596
|
*/
|
|
597
597
|
async resimulateSimulationRaw(requestParameters: ResimulateSimulationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalSimulationsAPIResimulateSimulationResponse>> {
|
|
@@ -602,7 +602,7 @@ export class SimulationsApi extends runtime.BaseAPI implements SimulationsApiInt
|
|
|
602
602
|
}
|
|
603
603
|
|
|
604
604
|
/**
|
|
605
|
-
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes.
|
|
605
|
+
* Requeue a single existing simulation to run again in place. The currently visible result for this simulation will be overwritten when the rerun completes. The rerun executes the agent\'s current configuration, while the persona prompt and test case parameters recorded on the original run are preserved.
|
|
606
606
|
* Rerun a simulation
|
|
607
607
|
*/
|
|
608
608
|
async resimulateSimulation(requestParameters: ResimulateSimulationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalSimulationsAPIResimulateSimulationResponse> {
|
|
@@ -0,0 +1,531 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Coval Agents API
|
|
5
|
+
* Manage configurations for simulations and evaluations.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@coval.dev
|
|
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
|
+
|
|
15
|
+
import * as runtime from '../runtime.js';
|
|
16
|
+
import {
|
|
17
|
+
type CovalWorkspacesAPICreateWorkspaceRequest,
|
|
18
|
+
CovalWorkspacesAPICreateWorkspaceRequestFromJSON,
|
|
19
|
+
CovalWorkspacesAPICreateWorkspaceRequestToJSON,
|
|
20
|
+
} from '../models/CovalWorkspacesAPICreateWorkspaceRequest.js';
|
|
21
|
+
import {
|
|
22
|
+
type CovalWorkspacesAPIErrorResponse,
|
|
23
|
+
CovalWorkspacesAPIErrorResponseFromJSON,
|
|
24
|
+
CovalWorkspacesAPIErrorResponseToJSON,
|
|
25
|
+
} from '../models/CovalWorkspacesAPIErrorResponse.js';
|
|
26
|
+
import {
|
|
27
|
+
type CovalWorkspacesAPIListWorkspacesResponse,
|
|
28
|
+
CovalWorkspacesAPIListWorkspacesResponseFromJSON,
|
|
29
|
+
CovalWorkspacesAPIListWorkspacesResponseToJSON,
|
|
30
|
+
} from '../models/CovalWorkspacesAPIListWorkspacesResponse.js';
|
|
31
|
+
import {
|
|
32
|
+
type CovalWorkspacesAPIUpdateWorkspaceRequest,
|
|
33
|
+
CovalWorkspacesAPIUpdateWorkspaceRequestFromJSON,
|
|
34
|
+
CovalWorkspacesAPIUpdateWorkspaceRequestToJSON,
|
|
35
|
+
} from '../models/CovalWorkspacesAPIUpdateWorkspaceRequest.js';
|
|
36
|
+
import {
|
|
37
|
+
type CovalWorkspacesAPIWorkspaceResponse,
|
|
38
|
+
CovalWorkspacesAPIWorkspaceResponseFromJSON,
|
|
39
|
+
CovalWorkspacesAPIWorkspaceResponseToJSON,
|
|
40
|
+
} from '../models/CovalWorkspacesAPIWorkspaceResponse.js';
|
|
41
|
+
|
|
42
|
+
export interface ArchiveWorkspaceRequest {
|
|
43
|
+
workspaceId: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface CreateWorkspaceRequest {
|
|
47
|
+
covalWorkspacesAPICreateWorkspaceRequest: CovalWorkspacesAPICreateWorkspaceRequest;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface DeleteWorkspaceRequest {
|
|
51
|
+
workspaceId: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export interface GetWorkspaceRequest {
|
|
55
|
+
workspaceId: string;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface UpdateWorkspaceRequest {
|
|
59
|
+
workspaceId: string;
|
|
60
|
+
covalWorkspacesAPIUpdateWorkspaceRequest: CovalWorkspacesAPIUpdateWorkspaceRequest;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* WorkspacesApi - interface
|
|
65
|
+
*
|
|
66
|
+
* @export
|
|
67
|
+
* @interface WorkspacesApiInterface
|
|
68
|
+
*/
|
|
69
|
+
export interface WorkspacesApiInterface {
|
|
70
|
+
/**
|
|
71
|
+
* Creates request options for archiveWorkspace without sending the request
|
|
72
|
+
* @param {string} workspaceId Workspace resource ID
|
|
73
|
+
* @throws {RequiredError}
|
|
74
|
+
* @memberof WorkspacesApiInterface
|
|
75
|
+
*/
|
|
76
|
+
archiveWorkspaceRequestOpts(requestParameters: ArchiveWorkspaceRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
|
|
80
|
+
* @summary Archive workspace
|
|
81
|
+
* @param {string} workspaceId Workspace resource ID
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
* @memberof WorkspacesApiInterface
|
|
85
|
+
*/
|
|
86
|
+
archiveWorkspaceRaw(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
|
|
90
|
+
* Archive workspace
|
|
91
|
+
*/
|
|
92
|
+
archiveWorkspace(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Creates request options for createWorkspace without sending the request
|
|
96
|
+
* @param {CovalWorkspacesAPICreateWorkspaceRequest} covalWorkspacesAPICreateWorkspaceRequest
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
* @memberof WorkspacesApiInterface
|
|
99
|
+
*/
|
|
100
|
+
createWorkspaceRequestOpts(requestParameters: CreateWorkspaceRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Create a custom workspace for your organization. The slug must be unique within the organization.
|
|
104
|
+
* @summary Create workspace
|
|
105
|
+
* @param {CovalWorkspacesAPICreateWorkspaceRequest} covalWorkspacesAPICreateWorkspaceRequest
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
* @memberof WorkspacesApiInterface
|
|
109
|
+
*/
|
|
110
|
+
createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Create a custom workspace for your organization. The slug must be unique within the organization.
|
|
114
|
+
* Create workspace
|
|
115
|
+
*/
|
|
116
|
+
createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Creates request options for deleteWorkspace without sending the request
|
|
120
|
+
* @param {string} workspaceId Workspace resource ID
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
* @memberof WorkspacesApiInterface
|
|
123
|
+
*/
|
|
124
|
+
deleteWorkspaceRequestOpts(requestParameters: DeleteWorkspaceRequest): Promise<runtime.RequestOpts>;
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
|
|
128
|
+
* @summary Delete workspace
|
|
129
|
+
* @param {string} workspaceId Workspace resource ID
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof WorkspacesApiInterface
|
|
133
|
+
*/
|
|
134
|
+
deleteWorkspaceRaw(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
|
|
138
|
+
* Delete workspace
|
|
139
|
+
*/
|
|
140
|
+
deleteWorkspace(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Creates request options for getWorkspace without sending the request
|
|
144
|
+
* @param {string} workspaceId Workspace resource ID
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
* @memberof WorkspacesApiInterface
|
|
147
|
+
*/
|
|
148
|
+
getWorkspaceRequestOpts(requestParameters: GetWorkspaceRequest): Promise<runtime.RequestOpts>;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
|
|
152
|
+
* @summary Get workspace
|
|
153
|
+
* @param {string} workspaceId Workspace resource ID
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
* @memberof WorkspacesApiInterface
|
|
157
|
+
*/
|
|
158
|
+
getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
|
|
162
|
+
* Get workspace
|
|
163
|
+
*/
|
|
164
|
+
getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* Creates request options for listWorkspaces without sending the request
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
* @memberof WorkspacesApiInterface
|
|
170
|
+
*/
|
|
171
|
+
listWorkspacesRequestOpts(): Promise<runtime.RequestOpts>;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Retrieve active and archived workspaces for your organization.
|
|
175
|
+
* @summary List workspaces
|
|
176
|
+
* @param {*} [options] Override http request option.
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
* @memberof WorkspacesApiInterface
|
|
179
|
+
*/
|
|
180
|
+
listWorkspacesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIListWorkspacesResponse>>;
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* Retrieve active and archived workspaces for your organization.
|
|
184
|
+
* List workspaces
|
|
185
|
+
*/
|
|
186
|
+
listWorkspaces(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIListWorkspacesResponse>;
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Creates request options for updateWorkspace without sending the request
|
|
190
|
+
* @param {string} workspaceId Workspace resource ID
|
|
191
|
+
* @param {CovalWorkspacesAPIUpdateWorkspaceRequest} covalWorkspacesAPIUpdateWorkspaceRequest
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
* @memberof WorkspacesApiInterface
|
|
194
|
+
*/
|
|
195
|
+
updateWorkspaceRequestOpts(requestParameters: UpdateWorkspaceRequest): Promise<runtime.RequestOpts>;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Update the display name of a workspace. Default workspaces cannot be updated.
|
|
199
|
+
* @summary Update workspace
|
|
200
|
+
* @param {string} workspaceId Workspace resource ID
|
|
201
|
+
* @param {CovalWorkspacesAPIUpdateWorkspaceRequest} covalWorkspacesAPIUpdateWorkspaceRequest
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
* @memberof WorkspacesApiInterface
|
|
205
|
+
*/
|
|
206
|
+
updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Update the display name of a workspace. Default workspaces cannot be updated.
|
|
210
|
+
* Update workspace
|
|
211
|
+
*/
|
|
212
|
+
updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
|
|
213
|
+
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
*/
|
|
219
|
+
export class WorkspacesApi extends runtime.BaseAPI implements WorkspacesApiInterface {
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Creates request options for archiveWorkspace without sending the request
|
|
223
|
+
*/
|
|
224
|
+
async archiveWorkspaceRequestOpts(requestParameters: ArchiveWorkspaceRequest): Promise<runtime.RequestOpts> {
|
|
225
|
+
if (requestParameters['workspaceId'] == null) {
|
|
226
|
+
throw new runtime.RequiredError(
|
|
227
|
+
'workspaceId',
|
|
228
|
+
'Required parameter "workspaceId" was null or undefined when calling archiveWorkspace().'
|
|
229
|
+
);
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
const queryParameters: any = {};
|
|
233
|
+
|
|
234
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
235
|
+
|
|
236
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
237
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
let urlPath = `/workspaces/{workspace_id}/archive`;
|
|
242
|
+
urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
|
|
243
|
+
|
|
244
|
+
return {
|
|
245
|
+
path: urlPath,
|
|
246
|
+
method: 'POST',
|
|
247
|
+
headers: headerParameters,
|
|
248
|
+
query: queryParameters,
|
|
249
|
+
};
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
|
|
254
|
+
* Archive workspace
|
|
255
|
+
*/
|
|
256
|
+
async archiveWorkspaceRaw(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
|
|
257
|
+
const requestOptions = await this.archiveWorkspaceRequestOpts(requestParameters);
|
|
258
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
259
|
+
|
|
260
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
|
|
265
|
+
* Archive workspace
|
|
266
|
+
*/
|
|
267
|
+
async archiveWorkspace(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
|
|
268
|
+
const response = await this.archiveWorkspaceRaw(requestParameters, initOverrides);
|
|
269
|
+
return await response.value();
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/**
|
|
273
|
+
* Creates request options for createWorkspace without sending the request
|
|
274
|
+
*/
|
|
275
|
+
async createWorkspaceRequestOpts(requestParameters: CreateWorkspaceRequest): Promise<runtime.RequestOpts> {
|
|
276
|
+
if (requestParameters['covalWorkspacesAPICreateWorkspaceRequest'] == null) {
|
|
277
|
+
throw new runtime.RequiredError(
|
|
278
|
+
'covalWorkspacesAPICreateWorkspaceRequest',
|
|
279
|
+
'Required parameter "covalWorkspacesAPICreateWorkspaceRequest" was null or undefined when calling createWorkspace().'
|
|
280
|
+
);
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
const queryParameters: any = {};
|
|
284
|
+
|
|
285
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
286
|
+
|
|
287
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
288
|
+
|
|
289
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
290
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
let urlPath = `/workspaces`;
|
|
295
|
+
|
|
296
|
+
return {
|
|
297
|
+
path: urlPath,
|
|
298
|
+
method: 'POST',
|
|
299
|
+
headers: headerParameters,
|
|
300
|
+
query: queryParameters,
|
|
301
|
+
body: CovalWorkspacesAPICreateWorkspaceRequestToJSON(requestParameters['covalWorkspacesAPICreateWorkspaceRequest']),
|
|
302
|
+
};
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* Create a custom workspace for your organization. The slug must be unique within the organization.
|
|
307
|
+
* Create workspace
|
|
308
|
+
*/
|
|
309
|
+
async createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
|
|
310
|
+
const requestOptions = await this.createWorkspaceRequestOpts(requestParameters);
|
|
311
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
312
|
+
|
|
313
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
/**
|
|
317
|
+
* Create a custom workspace for your organization. The slug must be unique within the organization.
|
|
318
|
+
* Create workspace
|
|
319
|
+
*/
|
|
320
|
+
async createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
|
|
321
|
+
const response = await this.createWorkspaceRaw(requestParameters, initOverrides);
|
|
322
|
+
return await response.value();
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* Creates request options for deleteWorkspace without sending the request
|
|
327
|
+
*/
|
|
328
|
+
async deleteWorkspaceRequestOpts(requestParameters: DeleteWorkspaceRequest): Promise<runtime.RequestOpts> {
|
|
329
|
+
if (requestParameters['workspaceId'] == null) {
|
|
330
|
+
throw new runtime.RequiredError(
|
|
331
|
+
'workspaceId',
|
|
332
|
+
'Required parameter "workspaceId" was null or undefined when calling deleteWorkspace().'
|
|
333
|
+
);
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
const queryParameters: any = {};
|
|
337
|
+
|
|
338
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
339
|
+
|
|
340
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
341
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
let urlPath = `/workspaces/{workspace_id}`;
|
|
346
|
+
urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
|
|
347
|
+
|
|
348
|
+
return {
|
|
349
|
+
path: urlPath,
|
|
350
|
+
method: 'DELETE',
|
|
351
|
+
headers: headerParameters,
|
|
352
|
+
query: queryParameters,
|
|
353
|
+
};
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
/**
|
|
357
|
+
* Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
|
|
358
|
+
* Delete workspace
|
|
359
|
+
*/
|
|
360
|
+
async deleteWorkspaceRaw(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
|
|
361
|
+
const requestOptions = await this.deleteWorkspaceRequestOpts(requestParameters);
|
|
362
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
363
|
+
|
|
364
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
|
|
369
|
+
* Delete workspace
|
|
370
|
+
*/
|
|
371
|
+
async deleteWorkspace(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
|
|
372
|
+
const response = await this.deleteWorkspaceRaw(requestParameters, initOverrides);
|
|
373
|
+
return await response.value();
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
/**
|
|
377
|
+
* Creates request options for getWorkspace without sending the request
|
|
378
|
+
*/
|
|
379
|
+
async getWorkspaceRequestOpts(requestParameters: GetWorkspaceRequest): Promise<runtime.RequestOpts> {
|
|
380
|
+
if (requestParameters['workspaceId'] == null) {
|
|
381
|
+
throw new runtime.RequiredError(
|
|
382
|
+
'workspaceId',
|
|
383
|
+
'Required parameter "workspaceId" was null or undefined when calling getWorkspace().'
|
|
384
|
+
);
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
const queryParameters: any = {};
|
|
388
|
+
|
|
389
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
390
|
+
|
|
391
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
392
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
let urlPath = `/workspaces/{workspace_id}`;
|
|
397
|
+
urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
|
|
398
|
+
|
|
399
|
+
return {
|
|
400
|
+
path: urlPath,
|
|
401
|
+
method: 'GET',
|
|
402
|
+
headers: headerParameters,
|
|
403
|
+
query: queryParameters,
|
|
404
|
+
};
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
|
|
409
|
+
* Get workspace
|
|
410
|
+
*/
|
|
411
|
+
async getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
|
|
412
|
+
const requestOptions = await this.getWorkspaceRequestOpts(requestParameters);
|
|
413
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
414
|
+
|
|
415
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
|
|
420
|
+
* Get workspace
|
|
421
|
+
*/
|
|
422
|
+
async getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
|
|
423
|
+
const response = await this.getWorkspaceRaw(requestParameters, initOverrides);
|
|
424
|
+
return await response.value();
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
/**
|
|
428
|
+
* Creates request options for listWorkspaces without sending the request
|
|
429
|
+
*/
|
|
430
|
+
async listWorkspacesRequestOpts(): Promise<runtime.RequestOpts> {
|
|
431
|
+
const queryParameters: any = {};
|
|
432
|
+
|
|
433
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
434
|
+
|
|
435
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
436
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
let urlPath = `/workspaces`;
|
|
441
|
+
|
|
442
|
+
return {
|
|
443
|
+
path: urlPath,
|
|
444
|
+
method: 'GET',
|
|
445
|
+
headers: headerParameters,
|
|
446
|
+
query: queryParameters,
|
|
447
|
+
};
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* Retrieve active and archived workspaces for your organization.
|
|
452
|
+
* List workspaces
|
|
453
|
+
*/
|
|
454
|
+
async listWorkspacesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIListWorkspacesResponse>> {
|
|
455
|
+
const requestOptions = await this.listWorkspacesRequestOpts();
|
|
456
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
457
|
+
|
|
458
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIListWorkspacesResponseFromJSON(jsonValue));
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Retrieve active and archived workspaces for your organization.
|
|
463
|
+
* List workspaces
|
|
464
|
+
*/
|
|
465
|
+
async listWorkspaces(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIListWorkspacesResponse> {
|
|
466
|
+
const response = await this.listWorkspacesRaw(initOverrides);
|
|
467
|
+
return await response.value();
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* Creates request options for updateWorkspace without sending the request
|
|
472
|
+
*/
|
|
473
|
+
async updateWorkspaceRequestOpts(requestParameters: UpdateWorkspaceRequest): Promise<runtime.RequestOpts> {
|
|
474
|
+
if (requestParameters['workspaceId'] == null) {
|
|
475
|
+
throw new runtime.RequiredError(
|
|
476
|
+
'workspaceId',
|
|
477
|
+
'Required parameter "workspaceId" was null or undefined when calling updateWorkspace().'
|
|
478
|
+
);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
if (requestParameters['covalWorkspacesAPIUpdateWorkspaceRequest'] == null) {
|
|
482
|
+
throw new runtime.RequiredError(
|
|
483
|
+
'covalWorkspacesAPIUpdateWorkspaceRequest',
|
|
484
|
+
'Required parameter "covalWorkspacesAPIUpdateWorkspaceRequest" was null or undefined when calling updateWorkspace().'
|
|
485
|
+
);
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
const queryParameters: any = {};
|
|
489
|
+
|
|
490
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
491
|
+
|
|
492
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
493
|
+
|
|
494
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
495
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
let urlPath = `/workspaces/{workspace_id}`;
|
|
500
|
+
urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
|
|
501
|
+
|
|
502
|
+
return {
|
|
503
|
+
path: urlPath,
|
|
504
|
+
method: 'PATCH',
|
|
505
|
+
headers: headerParameters,
|
|
506
|
+
query: queryParameters,
|
|
507
|
+
body: CovalWorkspacesAPIUpdateWorkspaceRequestToJSON(requestParameters['covalWorkspacesAPIUpdateWorkspaceRequest']),
|
|
508
|
+
};
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Update the display name of a workspace. Default workspaces cannot be updated.
|
|
513
|
+
* Update workspace
|
|
514
|
+
*/
|
|
515
|
+
async updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
|
|
516
|
+
const requestOptions = await this.updateWorkspaceRequestOpts(requestParameters);
|
|
517
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
518
|
+
|
|
519
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* Update the display name of a workspace. Default workspaces cannot be updated.
|
|
524
|
+
* Update workspace
|
|
525
|
+
*/
|
|
526
|
+
async updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
|
|
527
|
+
const response = await this.updateWorkspaceRaw(requestParameters, initOverrides);
|
|
528
|
+
return await response.value();
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
}
|