@cirrobio/api-client 0.0.10-alpha → 0.0.12-alpha

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.
Files changed (89) hide show
  1. package/.openapi-generator/FILES +7 -2
  2. package/README.md +1 -1
  3. package/dist/apis/BillingApi.d.ts +15 -2
  4. package/dist/apis/BillingApi.js +57 -3
  5. package/dist/apis/DashboardsApi.d.ts +88 -0
  6. package/dist/apis/DashboardsApi.js +374 -0
  7. package/dist/apis/DatasetsApi.d.ts +19 -5
  8. package/dist/apis/DatasetsApi.js +64 -4
  9. package/dist/apis/MetadataApi.d.ts +24 -1
  10. package/dist/apis/MetadataApi.js +112 -1
  11. package/dist/apis/NotebooksApi.d.ts +3 -3
  12. package/dist/apis/NotebooksApi.js +1 -7
  13. package/dist/apis/ProjectsApi.d.ts +13 -0
  14. package/dist/apis/ProjectsApi.js +53 -0
  15. package/dist/apis/index.d.ts +1 -0
  16. package/dist/apis/index.js +1 -0
  17. package/dist/models/BillingAccount.d.ts +6 -0
  18. package/dist/models/BillingAccount.js +3 -0
  19. package/dist/models/BudgetPeriod.d.ts +1 -1
  20. package/dist/models/BudgetPeriod.js +1 -1
  21. package/dist/models/CloudAccount.d.ts +3 -10
  22. package/dist/models/CloudAccount.js +0 -3
  23. package/dist/models/Contact.d.ts +4 -4
  24. package/dist/models/Contact.js +8 -5
  25. package/dist/models/CreateDashboardRequest.d.ts +31 -0
  26. package/dist/models/CreateDashboardRequest.js +50 -0
  27. package/dist/models/CustomPipelineSettings.d.ts +6 -6
  28. package/dist/models/CustomPipelineSettings.js +13 -8
  29. package/dist/models/CustomerType.d.ts +2 -4
  30. package/dist/models/CustomerType.js +2 -4
  31. package/dist/models/Dashboard.d.ts +77 -0
  32. package/dist/models/Dashboard.js +71 -0
  33. package/dist/models/DashboardRequest.d.ts +53 -0
  34. package/dist/models/DashboardRequest.js +59 -0
  35. package/dist/models/Dataset.d.ts +8 -7
  36. package/dist/models/Dataset.js +10 -9
  37. package/dist/models/DatasetDetail.d.ts +11 -10
  38. package/dist/models/DatasetDetail.js +13 -12
  39. package/dist/models/FormSchema.d.ts +1 -1
  40. package/dist/models/NotebookInstanceStatusResponse.d.ts +31 -0
  41. package/dist/models/NotebookInstanceStatusResponse.js +50 -0
  42. package/dist/models/PaginatedResponseDatasetListDto.d.ts +38 -0
  43. package/dist/models/PaginatedResponseDatasetListDto.js +54 -0
  44. package/dist/models/Project.d.ts +9 -2
  45. package/dist/models/Project.js +6 -2
  46. package/dist/models/ProjectDetail.d.ts +7 -6
  47. package/dist/models/ProjectDetail.js +7 -6
  48. package/dist/models/ProjectSettings.d.ts +26 -26
  49. package/dist/models/ProjectSettings.js +14 -26
  50. package/dist/models/RegisterDatasetRequest.d.ts +20 -2
  51. package/dist/models/RegisterDatasetRequest.js +11 -2
  52. package/dist/models/RegisterPublicDataRequest.d.ts +43 -0
  53. package/dist/models/RegisterPublicDataRequest.js +56 -0
  54. package/dist/models/Sample.d.ts +18 -0
  55. package/dist/models/Sample.js +9 -0
  56. package/dist/models/Status.d.ts +29 -0
  57. package/dist/models/Status.js +44 -0
  58. package/dist/models/index.d.ts +6 -2
  59. package/dist/models/index.js +6 -2
  60. package/package.json +1 -1
  61. package/src/apis/BillingApi.ts +46 -3
  62. package/src/apis/DashboardsApi.ts +287 -0
  63. package/src/apis/DatasetsApi.ts +64 -9
  64. package/src/apis/MetadataApi.ts +96 -1
  65. package/src/apis/NotebooksApi.ts +6 -7
  66. package/src/apis/ProjectsApi.ts +43 -0
  67. package/src/apis/index.ts +1 -0
  68. package/src/models/BillingAccount.ts +9 -0
  69. package/src/models/BudgetPeriod.ts +1 -1
  70. package/src/models/CloudAccount.ts +3 -18
  71. package/src/models/Contact.ts +12 -8
  72. package/src/models/CreateDashboardRequest.ts +65 -0
  73. package/src/models/CustomPipelineSettings.ts +19 -13
  74. package/src/models/CustomerType.ts +2 -4
  75. package/src/models/Dashboard.ts +129 -0
  76. package/src/models/DashboardRequest.ts +93 -0
  77. package/src/models/Dataset.ts +22 -16
  78. package/src/models/DatasetDetail.ts +28 -22
  79. package/src/models/FormSchema.ts +1 -1
  80. package/src/models/NotebookInstanceStatusResponse.ts +66 -0
  81. package/src/models/PaginatedResponseDatasetListDto.ts +82 -0
  82. package/src/models/Project.ts +19 -4
  83. package/src/models/ProjectDetail.ts +18 -12
  84. package/src/models/ProjectSettings.ts +39 -52
  85. package/src/models/RegisterDatasetRequest.ts +31 -4
  86. package/src/models/RegisterPublicDataRequest.ts +83 -0
  87. package/src/models/Sample.ts +27 -0
  88. package/src/models/Status.ts +43 -0
  89. package/src/models/index.ts +6 -2
@@ -0,0 +1,43 @@
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 RegisterPublicDataRequest
16
+ */
17
+ export interface RegisterPublicDataRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RegisterPublicDataRequest
22
+ */
23
+ name: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof RegisterPublicDataRequest
28
+ */
29
+ description: string;
30
+ /**
31
+ * List of SRA/ENA/DDBJ/GEO/Synapse IDs
32
+ * @type {Array<string>}
33
+ * @memberof RegisterPublicDataRequest
34
+ */
35
+ publicIds?: Array<string>;
36
+ }
37
+ /**
38
+ * Check if a given object implements the RegisterPublicDataRequest interface.
39
+ */
40
+ export declare function instanceOfRegisterPublicDataRequest(value: object): boolean;
41
+ export declare function RegisterPublicDataRequestFromJSON(json: any): RegisterPublicDataRequest;
42
+ export declare function RegisterPublicDataRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegisterPublicDataRequest;
43
+ export declare function RegisterPublicDataRequestToJSON(value?: RegisterPublicDataRequest | null): any;
@@ -0,0 +1,56 @@
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.RegisterPublicDataRequestToJSON = exports.RegisterPublicDataRequestFromJSONTyped = exports.RegisterPublicDataRequestFromJSON = exports.instanceOfRegisterPublicDataRequest = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the RegisterPublicDataRequest interface.
20
+ */
21
+ function instanceOfRegisterPublicDataRequest(value) {
22
+ var isInstance = true;
23
+ isInstance = isInstance && "name" in value;
24
+ isInstance = isInstance && "description" in value;
25
+ return isInstance;
26
+ }
27
+ exports.instanceOfRegisterPublicDataRequest = instanceOfRegisterPublicDataRequest;
28
+ function RegisterPublicDataRequestFromJSON(json) {
29
+ return RegisterPublicDataRequestFromJSONTyped(json, false);
30
+ }
31
+ exports.RegisterPublicDataRequestFromJSON = RegisterPublicDataRequestFromJSON;
32
+ function RegisterPublicDataRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if ((json === undefined) || (json === null)) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'name': json['name'],
38
+ 'description': json['description'],
39
+ 'publicIds': !(0, runtime_1.exists)(json, 'publicIds') ? undefined : json['publicIds'],
40
+ };
41
+ }
42
+ exports.RegisterPublicDataRequestFromJSONTyped = RegisterPublicDataRequestFromJSONTyped;
43
+ function RegisterPublicDataRequestToJSON(value) {
44
+ if (value === undefined) {
45
+ return undefined;
46
+ }
47
+ if (value === null) {
48
+ return null;
49
+ }
50
+ return {
51
+ 'name': value.name,
52
+ 'description': value.description,
53
+ 'publicIds': value.publicIds,
54
+ };
55
+ }
56
+ exports.RegisterPublicDataRequestToJSON = RegisterPublicDataRequestToJSON;
@@ -15,6 +15,12 @@
15
15
  * @interface Sample
16
16
  */
17
17
  export interface Sample {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof Sample
22
+ */
23
+ id: string;
18
24
  /**
19
25
  *
20
26
  * @type {string}
@@ -29,6 +35,18 @@ export interface Sample {
29
35
  metadata: {
30
36
  [key: string]: any;
31
37
  };
38
+ /**
39
+ *
40
+ * @type {Date}
41
+ * @memberof Sample
42
+ */
43
+ createdAt: Date;
44
+ /**
45
+ *
46
+ * @type {Date}
47
+ * @memberof Sample
48
+ */
49
+ updatedAt: Date;
32
50
  }
33
51
  /**
34
52
  * Check if a given object implements the Sample interface.
@@ -19,8 +19,11 @@ exports.SampleToJSON = exports.SampleFromJSONTyped = exports.SampleFromJSON = ex
19
19
  */
20
20
  function instanceOfSample(value) {
21
21
  var isInstance = true;
22
+ isInstance = isInstance && "id" in value;
22
23
  isInstance = isInstance && "name" in value;
23
24
  isInstance = isInstance && "metadata" in value;
25
+ isInstance = isInstance && "createdAt" in value;
26
+ isInstance = isInstance && "updatedAt" in value;
24
27
  return isInstance;
25
28
  }
26
29
  exports.instanceOfSample = instanceOfSample;
@@ -33,8 +36,11 @@ function SampleFromJSONTyped(json, ignoreDiscriminator) {
33
36
  return json;
34
37
  }
35
38
  return {
39
+ 'id': json['id'],
36
40
  'name': json['name'],
37
41
  'metadata': json['metadata'],
42
+ 'createdAt': (new Date(json['createdAt'])),
43
+ 'updatedAt': (new Date(json['updatedAt'])),
38
44
  };
39
45
  }
40
46
  exports.SampleFromJSONTyped = SampleFromJSONTyped;
@@ -46,8 +52,11 @@ function SampleToJSON(value) {
46
52
  return null;
47
53
  }
48
54
  return {
55
+ 'id': value.id,
49
56
  'name': value.name,
50
57
  'metadata': value.metadata,
58
+ 'createdAt': (value.createdAt.toISOString()),
59
+ 'updatedAt': (value.updatedAt.toISOString()),
51
60
  };
52
61
  }
53
62
  exports.SampleToJSON = SampleToJSON;
@@ -0,0 +1,29 @@
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
+ * @enum {string}
16
+ */
17
+ export declare enum Status {
18
+ Completed = "COMPLETED",
19
+ Pending = "PENDING",
20
+ Running = "RUNNING",
21
+ Archived = "ARCHIVED",
22
+ Deleted = "DELETED",
23
+ Deleting = "DELETING",
24
+ Delete = "DELETE",
25
+ Failed = "FAILED"
26
+ }
27
+ export declare function StatusFromJSON(json: any): Status;
28
+ export declare function StatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): Status;
29
+ export declare function StatusToJSON(value?: Status | null): any;
@@ -0,0 +1,44 @@
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.StatusToJSON = exports.StatusFromJSONTyped = exports.StatusFromJSON = exports.Status = void 0;
17
+ /**
18
+ *
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ var Status;
23
+ (function (Status) {
24
+ Status["Completed"] = "COMPLETED";
25
+ Status["Pending"] = "PENDING";
26
+ Status["Running"] = "RUNNING";
27
+ Status["Archived"] = "ARCHIVED";
28
+ Status["Deleted"] = "DELETED";
29
+ Status["Deleting"] = "DELETING";
30
+ Status["Delete"] = "DELETE";
31
+ Status["Failed"] = "FAILED";
32
+ })(Status = exports.Status || (exports.Status = {}));
33
+ function StatusFromJSON(json) {
34
+ return StatusFromJSONTyped(json, false);
35
+ }
36
+ exports.StatusFromJSON = StatusFromJSON;
37
+ function StatusFromJSONTyped(json, ignoreDiscriminator) {
38
+ return json;
39
+ }
40
+ exports.StatusFromJSONTyped = StatusFromJSONTyped;
41
+ function StatusToJSON(value) {
42
+ return value;
43
+ }
44
+ exports.StatusToJSON = StatusToJSON;
@@ -7,16 +7,19 @@ export * from './CreateNotebookInstanceRequest';
7
7
  export * from './CreateResponse';
8
8
  export * from './CustomPipelineSettings';
9
9
  export * from './CustomerType';
10
+ export * from './Dashboard';
11
+ export * from './DashboardRequest';
10
12
  export * from './Dataset';
11
13
  export * from './DatasetDetail';
12
- export * from './DatasetType';
13
14
  export * from './Executor';
14
15
  export * from './FormSchema';
15
16
  export * from './GetExecutionLogsResponse';
16
17
  export * from './LogEntry';
17
18
  export * from './MetricRecord';
18
19
  export * from './NotebookInstance';
20
+ export * from './NotebookInstanceStatusResponse';
19
21
  export * from './OpenNotebookInstanceResponse';
22
+ export * from './PaginatedResponseDatasetListDto';
20
23
  export * from './Process';
21
24
  export * from './ProcessDetail';
22
25
  export * from './Project';
@@ -28,11 +31,12 @@ export * from './ProjectSettings';
28
31
  export * from './ProjectUser';
29
32
  export * from './Reference';
30
33
  export * from './ReferenceType';
31
- export * from './Region';
32
34
  export * from './RegisterDatasetRequest';
35
+ export * from './RegisterPublicDataRequest';
33
36
  export * from './Sample';
34
37
  export * from './ServiceConnection';
35
38
  export * from './SetUserProjectRoleRequest';
39
+ export * from './Status';
36
40
  export * from './StopExecutionResponse';
37
41
  export * from './SystemInfoResponse';
38
42
  export * from './Tag';
@@ -25,16 +25,19 @@ __exportStar(require("./CreateNotebookInstanceRequest"), exports);
25
25
  __exportStar(require("./CreateResponse"), exports);
26
26
  __exportStar(require("./CustomPipelineSettings"), exports);
27
27
  __exportStar(require("./CustomerType"), exports);
28
+ __exportStar(require("./Dashboard"), exports);
29
+ __exportStar(require("./DashboardRequest"), exports);
28
30
  __exportStar(require("./Dataset"), exports);
29
31
  __exportStar(require("./DatasetDetail"), exports);
30
- __exportStar(require("./DatasetType"), exports);
31
32
  __exportStar(require("./Executor"), exports);
32
33
  __exportStar(require("./FormSchema"), exports);
33
34
  __exportStar(require("./GetExecutionLogsResponse"), exports);
34
35
  __exportStar(require("./LogEntry"), exports);
35
36
  __exportStar(require("./MetricRecord"), exports);
36
37
  __exportStar(require("./NotebookInstance"), exports);
38
+ __exportStar(require("./NotebookInstanceStatusResponse"), exports);
37
39
  __exportStar(require("./OpenNotebookInstanceResponse"), exports);
40
+ __exportStar(require("./PaginatedResponseDatasetListDto"), exports);
38
41
  __exportStar(require("./Process"), exports);
39
42
  __exportStar(require("./ProcessDetail"), exports);
40
43
  __exportStar(require("./Project"), exports);
@@ -46,11 +49,12 @@ __exportStar(require("./ProjectSettings"), exports);
46
49
  __exportStar(require("./ProjectUser"), exports);
47
50
  __exportStar(require("./Reference"), exports);
48
51
  __exportStar(require("./ReferenceType"), exports);
49
- __exportStar(require("./Region"), exports);
50
52
  __exportStar(require("./RegisterDatasetRequest"), exports);
53
+ __exportStar(require("./RegisterPublicDataRequest"), exports);
51
54
  __exportStar(require("./Sample"), exports);
52
55
  __exportStar(require("./ServiceConnection"), exports);
53
56
  __exportStar(require("./SetUserProjectRoleRequest"), exports);
57
+ __exportStar(require("./Status"), exports);
54
58
  __exportStar(require("./StopExecutionResponse"), exports);
55
59
  __exportStar(require("./SystemInfoResponse"), exports);
56
60
  __exportStar(require("./Tag"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cirrobio/api-client",
3
- "version": "0.0.10-alpha",
3
+ "version": "0.0.12-alpha",
4
4
  "description": "API client for Cirro",
5
5
  "author": "CirroBio",
6
6
  "repository": {
@@ -33,6 +33,10 @@ export interface DeleteBillingAccountRequest {
33
33
  billingAccountId: string;
34
34
  }
35
35
 
36
+ export interface GetBillingAccountsRequest {
37
+ includeArchived?: boolean;
38
+ }
39
+
36
40
  export interface UpdateBillingAccountRequest {
37
41
  billingAccountId: string;
38
42
  billingAccount: BillingAccount;
@@ -125,13 +129,52 @@ export class BillingApi extends runtime.BaseAPI {
125
129
  await this.deleteBillingAccountRaw(requestParameters, initOverrides);
126
130
  }
127
131
 
132
+ /**
133
+ * Generates a billing report xlsx with cost information
134
+ * Generate billing report
135
+ */
136
+ async generateBillingReportRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
137
+ const queryParameters: any = {};
138
+
139
+ const headerParameters: runtime.HTTPHeaders = {};
140
+
141
+ if (this.configuration && this.configuration.accessToken) {
142
+ const token = this.configuration.accessToken;
143
+ const tokenString = await token("accessToken", []);
144
+
145
+ if (tokenString) {
146
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
147
+ }
148
+ }
149
+ const response = await this.request({
150
+ path: `/billing-report`,
151
+ method: 'GET',
152
+ headers: headerParameters,
153
+ query: queryParameters,
154
+ }, initOverrides);
155
+
156
+ return new runtime.VoidApiResponse(response);
157
+ }
158
+
159
+ /**
160
+ * Generates a billing report xlsx with cost information
161
+ * Generate billing report
162
+ */
163
+ async generateBillingReport(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
164
+ await this.generateBillingReportRaw(initOverrides);
165
+ }
166
+
128
167
  /**
129
168
  * Gets a list of billing accounts the current user has access to
130
169
  * List billing accounts
131
170
  */
132
- async getBillingAccountsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BillingAccount>>> {
171
+ async getBillingAccountsRaw(requestParameters: GetBillingAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BillingAccount>>> {
133
172
  const queryParameters: any = {};
134
173
 
174
+ if (requestParameters.includeArchived !== undefined) {
175
+ queryParameters['includeArchived'] = requestParameters.includeArchived;
176
+ }
177
+
135
178
  const headerParameters: runtime.HTTPHeaders = {};
136
179
 
137
180
  if (this.configuration && this.configuration.accessToken) {
@@ -156,8 +199,8 @@ export class BillingApi extends runtime.BaseAPI {
156
199
  * Gets a list of billing accounts the current user has access to
157
200
  * List billing accounts
158
201
  */
159
- async getBillingAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BillingAccount>> {
160
- const response = await this.getBillingAccountsRaw(initOverrides);
202
+ async getBillingAccounts(requestParameters: GetBillingAccountsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BillingAccount>> {
203
+ const response = await this.getBillingAccountsRaw(requestParameters, initOverrides);
161
204
  return await response.value();
162
205
  }
163
206
 
@@ -0,0 +1,287 @@
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
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ CreateResponse,
19
+ Dashboard,
20
+ DashboardRequest,
21
+ } from '../models/index';
22
+ import {
23
+ CreateResponseFromJSON,
24
+ CreateResponseToJSON,
25
+ DashboardFromJSON,
26
+ DashboardToJSON,
27
+ DashboardRequestFromJSON,
28
+ DashboardRequestToJSON,
29
+ } from '../models/index';
30
+
31
+ export interface CreateDashboardRequest {
32
+ projectId: string;
33
+ dashboardRequest: DashboardRequest;
34
+ }
35
+
36
+ export interface DeleteDashboardRequest {
37
+ projectId: string;
38
+ dashboardId: string;
39
+ }
40
+
41
+ export interface GetDashboardRequest {
42
+ projectId: string;
43
+ dashboardId: string;
44
+ }
45
+
46
+ export interface GetDashboardsRequest {
47
+ projectId: string;
48
+ }
49
+
50
+ export interface UpdateDashboardRequest {
51
+ projectId: string;
52
+ dashboardId: string;
53
+ dashboardRequest: DashboardRequest;
54
+ }
55
+
56
+ /**
57
+ *
58
+ */
59
+ export class DashboardsApi extends runtime.BaseAPI {
60
+
61
+ /**
62
+ * Creates a dashboard
63
+ * Create dashboard
64
+ */
65
+ async createDashboardRaw(requestParameters: CreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
66
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
67
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling createDashboard.');
68
+ }
69
+
70
+ if (requestParameters.dashboardRequest === null || requestParameters.dashboardRequest === undefined) {
71
+ throw new runtime.RequiredError('dashboardRequest','Required parameter requestParameters.dashboardRequest was null or undefined when calling createDashboard.');
72
+ }
73
+
74
+ const queryParameters: any = {};
75
+
76
+ const headerParameters: runtime.HTTPHeaders = {};
77
+
78
+ headerParameters['Content-Type'] = 'application/json';
79
+
80
+ if (this.configuration && this.configuration.accessToken) {
81
+ const token = this.configuration.accessToken;
82
+ const tokenString = await token("accessToken", []);
83
+
84
+ if (tokenString) {
85
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
86
+ }
87
+ }
88
+ const response = await this.request({
89
+ path: `/projects/{projectId}/dashboards`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
90
+ method: 'POST',
91
+ headers: headerParameters,
92
+ query: queryParameters,
93
+ body: DashboardRequestToJSON(requestParameters.dashboardRequest),
94
+ }, initOverrides);
95
+
96
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
97
+ }
98
+
99
+ /**
100
+ * Creates a dashboard
101
+ * Create dashboard
102
+ */
103
+ async createDashboard(requestParameters: CreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
104
+ const response = await this.createDashboardRaw(requestParameters, initOverrides);
105
+ return await response.value();
106
+ }
107
+
108
+ /**
109
+ * Deletes a dashboard
110
+ * Delete dashboard
111
+ */
112
+ async deleteDashboardRaw(requestParameters: DeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>> {
113
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
114
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling deleteDashboard.');
115
+ }
116
+
117
+ if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
118
+ throw new runtime.RequiredError('dashboardId','Required parameter requestParameters.dashboardId was null or undefined when calling deleteDashboard.');
119
+ }
120
+
121
+ const queryParameters: any = {};
122
+
123
+ const headerParameters: runtime.HTTPHeaders = {};
124
+
125
+ if (this.configuration && this.configuration.accessToken) {
126
+ const token = this.configuration.accessToken;
127
+ const tokenString = await token("accessToken", []);
128
+
129
+ if (tokenString) {
130
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
131
+ }
132
+ }
133
+ const response = await this.request({
134
+ path: `/projects/{projectId}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
135
+ method: 'DELETE',
136
+ headers: headerParameters,
137
+ query: queryParameters,
138
+ }, initOverrides);
139
+
140
+ return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
141
+ }
142
+
143
+ /**
144
+ * Deletes a dashboard
145
+ * Delete dashboard
146
+ */
147
+ async deleteDashboard(requestParameters: DeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard> {
148
+ const response = await this.deleteDashboardRaw(requestParameters, initOverrides);
149
+ return await response.value();
150
+ }
151
+
152
+ /**
153
+ * Retrieves a dashboard
154
+ * Get dashboard
155
+ */
156
+ async getDashboardRaw(requestParameters: GetDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>> {
157
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
158
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getDashboard.');
159
+ }
160
+
161
+ if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
162
+ throw new runtime.RequiredError('dashboardId','Required parameter requestParameters.dashboardId was null or undefined when calling getDashboard.');
163
+ }
164
+
165
+ const queryParameters: any = {};
166
+
167
+ const headerParameters: runtime.HTTPHeaders = {};
168
+
169
+ if (this.configuration && this.configuration.accessToken) {
170
+ const token = this.configuration.accessToken;
171
+ const tokenString = await token("accessToken", []);
172
+
173
+ if (tokenString) {
174
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
175
+ }
176
+ }
177
+ const response = await this.request({
178
+ path: `/projects/{projectId}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
179
+ method: 'GET',
180
+ headers: headerParameters,
181
+ query: queryParameters,
182
+ }, initOverrides);
183
+
184
+ return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
185
+ }
186
+
187
+ /**
188
+ * Retrieves a dashboard
189
+ * Get dashboard
190
+ */
191
+ async getDashboard(requestParameters: GetDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard> {
192
+ const response = await this.getDashboardRaw(requestParameters, initOverrides);
193
+ return await response.value();
194
+ }
195
+
196
+ /**
197
+ * Retrieves a list of dashboards for a given project
198
+ * List dashboards
199
+ */
200
+ async getDashboardsRaw(requestParameters: GetDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Dashboard>>> {
201
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
202
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getDashboards.');
203
+ }
204
+
205
+ const queryParameters: any = {};
206
+
207
+ const headerParameters: runtime.HTTPHeaders = {};
208
+
209
+ if (this.configuration && this.configuration.accessToken) {
210
+ const token = this.configuration.accessToken;
211
+ const tokenString = await token("accessToken", []);
212
+
213
+ if (tokenString) {
214
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
215
+ }
216
+ }
217
+ const response = await this.request({
218
+ path: `/projects/{projectId}/dashboards`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
219
+ method: 'GET',
220
+ headers: headerParameters,
221
+ query: queryParameters,
222
+ }, initOverrides);
223
+
224
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(DashboardFromJSON));
225
+ }
226
+
227
+ /**
228
+ * Retrieves a list of dashboards for a given project
229
+ * List dashboards
230
+ */
231
+ async getDashboards(requestParameters: GetDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Dashboard>> {
232
+ const response = await this.getDashboardsRaw(requestParameters, initOverrides);
233
+ return await response.value();
234
+ }
235
+
236
+ /**
237
+ * Updates a dashboard
238
+ * Update dashboard
239
+ */
240
+ async updateDashboardRaw(requestParameters: UpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Dashboard>> {
241
+ if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
242
+ throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling updateDashboard.');
243
+ }
244
+
245
+ if (requestParameters.dashboardId === null || requestParameters.dashboardId === undefined) {
246
+ throw new runtime.RequiredError('dashboardId','Required parameter requestParameters.dashboardId was null or undefined when calling updateDashboard.');
247
+ }
248
+
249
+ if (requestParameters.dashboardRequest === null || requestParameters.dashboardRequest === undefined) {
250
+ throw new runtime.RequiredError('dashboardRequest','Required parameter requestParameters.dashboardRequest was null or undefined when calling updateDashboard.');
251
+ }
252
+
253
+ const queryParameters: any = {};
254
+
255
+ const headerParameters: runtime.HTTPHeaders = {};
256
+
257
+ headerParameters['Content-Type'] = 'application/json';
258
+
259
+ if (this.configuration && this.configuration.accessToken) {
260
+ const token = this.configuration.accessToken;
261
+ const tokenString = await token("accessToken", []);
262
+
263
+ if (tokenString) {
264
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
265
+ }
266
+ }
267
+ const response = await this.request({
268
+ path: `/projects/{projectId}/dashboards/{dashboardId}`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"dashboardId"}}`, encodeURIComponent(String(requestParameters.dashboardId))),
269
+ method: 'PUT',
270
+ headers: headerParameters,
271
+ query: queryParameters,
272
+ body: DashboardRequestToJSON(requestParameters.dashboardRequest),
273
+ }, initOverrides);
274
+
275
+ return new runtime.JSONApiResponse(response, (jsonValue) => DashboardFromJSON(jsonValue));
276
+ }
277
+
278
+ /**
279
+ * Updates a dashboard
280
+ * Update dashboard
281
+ */
282
+ async updateDashboard(requestParameters: UpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Dashboard> {
283
+ const response = await this.updateDashboardRaw(requestParameters, initOverrides);
284
+ return await response.value();
285
+ }
286
+
287
+ }