@emilgroup/tenant-sdk 1.29.1-beta.1 → 1.29.1-beta.2
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 +2 -2
- package/api/custom-schema-api.ts +40 -40
- package/api/dashboard-api.ts +76 -76
- package/api/dashboard-group-api.ts +40 -40
- package/api/data-report-api.ts +40 -40
- package/api/invite-users-api.ts +19 -19
- package/api/list-organization-invitations-api.ts +40 -40
- package/api/organizations-api.ts +40 -40
- package/api/users-api.ts +19 -19
- package/dist/api/custom-schema-api.d.ts +40 -40
- package/dist/api/custom-schema-api.js +21 -21
- package/dist/api/dashboard-api.d.ts +76 -76
- package/dist/api/dashboard-api.js +57 -57
- package/dist/api/dashboard-group-api.d.ts +40 -40
- package/dist/api/dashboard-group-api.js +21 -21
- package/dist/api/data-report-api.d.ts +40 -40
- package/dist/api/data-report-api.js +21 -21
- package/dist/api/invite-users-api.d.ts +19 -19
- package/dist/api/invite-users-api.js +9 -9
- package/dist/api/list-organization-invitations-api.d.ts +40 -40
- package/dist/api/list-organization-invitations-api.js +21 -21
- package/dist/api/organizations-api.d.ts +40 -40
- package/dist/api/organizations-api.js +21 -21
- package/dist/api/users-api.d.ts +19 -19
- package/dist/api/users-api.js +9 -9
- package/dist/models/list-org-invitations-response-class.d.ts +12 -0
- package/dist/models/list-organizations-response-class.d.ts +12 -0
- package/models/list-org-invitations-response-class.ts +12 -0
- package/models/list-organizations-response-class.ts +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/tenant-sdk@1.29.1-beta.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.29.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.29.1-beta.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.29.1-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/custom-schema-api.ts
CHANGED
|
@@ -139,17 +139,17 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
|
|
|
139
139
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
140
140
|
* @summary List custom-schemas
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
-
* @param {
|
|
143
|
-
* @param {
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
142
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
144
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
145
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
146
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
147
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
148
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
152
|
-
listCustomSchemas: async (authorization?: string, pageSize?:
|
|
152
|
+
listCustomSchemas: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153
153
|
const localVarPath = `/tenantservice/v1/custom-schemas`;
|
|
154
154
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
155
155
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -301,17 +301,17 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
|
|
|
301
301
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
302
302
|
* @summary List custom-schemas
|
|
303
303
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
304
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
306
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
307
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
308
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
309
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
310
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
311
311
|
* @param {*} [options] Override http request option.
|
|
312
312
|
* @throws {RequiredError}
|
|
313
313
|
*/
|
|
314
|
-
async listCustomSchemas(authorization?: string, pageSize?:
|
|
314
|
+
async listCustomSchemas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>> {
|
|
315
315
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
316
316
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
317
317
|
},
|
|
@@ -365,17 +365,17 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
|
|
|
365
365
|
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.custom-schemas.view\"
|
|
366
366
|
* @summary List custom-schemas
|
|
367
367
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
-
* @param {
|
|
369
|
-
* @param {
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {
|
|
372
|
-
* @param {
|
|
373
|
-
* @param {
|
|
374
|
-
* @param {
|
|
368
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
369
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
370
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
371
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
372
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
373
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
374
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
375
375
|
* @param {*} [options] Override http request option.
|
|
376
376
|
* @throws {RequiredError}
|
|
377
377
|
*/
|
|
378
|
-
listCustomSchemas(authorization?: string, pageSize?:
|
|
378
|
+
listCustomSchemas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
|
|
379
379
|
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
380
380
|
},
|
|
381
381
|
/**
|
|
@@ -457,52 +457,52 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
457
457
|
|
|
458
458
|
/**
|
|
459
459
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
460
|
-
* @type {
|
|
460
|
+
* @type {number}
|
|
461
461
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
462
462
|
*/
|
|
463
|
-
readonly pageSize?:
|
|
463
|
+
readonly pageSize?: number
|
|
464
464
|
|
|
465
465
|
/**
|
|
466
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
467
|
-
* @type {
|
|
466
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
467
|
+
* @type {string}
|
|
468
468
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
469
469
|
*/
|
|
470
|
-
readonly pageToken?:
|
|
470
|
+
readonly pageToken?: string
|
|
471
471
|
|
|
472
472
|
/**
|
|
473
473
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
474
|
-
* @type {
|
|
474
|
+
* @type {string}
|
|
475
475
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
476
476
|
*/
|
|
477
|
-
readonly filter?:
|
|
477
|
+
readonly filter?: string
|
|
478
478
|
|
|
479
479
|
/**
|
|
480
480
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
481
|
-
* @type {
|
|
481
|
+
* @type {string}
|
|
482
482
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
483
483
|
*/
|
|
484
|
-
readonly search?:
|
|
484
|
+
readonly search?: string
|
|
485
485
|
|
|
486
486
|
/**
|
|
487
487
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
488
|
-
* @type {
|
|
488
|
+
* @type {string}
|
|
489
489
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
490
490
|
*/
|
|
491
|
-
readonly order?:
|
|
491
|
+
readonly order?: string
|
|
492
492
|
|
|
493
493
|
/**
|
|
494
|
-
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in
|
|
495
|
-
* @type {
|
|
494
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
495
|
+
* @type {string}
|
|
496
496
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
497
497
|
*/
|
|
498
|
-
readonly expand?:
|
|
498
|
+
readonly expand?: string
|
|
499
499
|
|
|
500
500
|
/**
|
|
501
501
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
502
|
-
* @type {
|
|
502
|
+
* @type {string}
|
|
503
503
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
504
504
|
*/
|
|
505
|
-
readonly filters?:
|
|
505
|
+
readonly filters?: string
|
|
506
506
|
}
|
|
507
507
|
|
|
508
508
|
/**
|
package/api/dashboard-api.ts
CHANGED
|
@@ -47,7 +47,7 @@ import { UpdateDashboardResponseClass } from '../models';
|
|
|
47
47
|
export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
|
-
* undefined **Required Permissions** \"
|
|
50
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
51
51
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
52
52
|
* @param {string} [authorization] Bearer Token
|
|
53
53
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
93
93
|
};
|
|
94
94
|
},
|
|
95
95
|
/**
|
|
96
|
-
* undefined **Required Permissions** \"
|
|
96
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
97
97
|
* @param {string} code
|
|
98
98
|
* @param {string} [authorization] Bearer Token
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +137,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
137
137
|
};
|
|
138
138
|
},
|
|
139
139
|
/**
|
|
140
|
-
* undefined **Required Permissions** \"
|
|
140
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
141
141
|
* @param {string} providerDashboardId
|
|
142
142
|
* @param {string} [authorization] Bearer Token
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
@@ -181,7 +181,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
181
181
|
};
|
|
182
182
|
},
|
|
183
183
|
/**
|
|
184
|
-
* undefined **Required Permissions** \"
|
|
184
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
185
185
|
* @param {string} code
|
|
186
186
|
* @param {string} [authorization] Bearer Token
|
|
187
187
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +225,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
225
225
|
};
|
|
226
226
|
},
|
|
227
227
|
/**
|
|
228
|
-
* undefined **Required Permissions** \"
|
|
228
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
229
229
|
* @param {string} providerDashboardId
|
|
230
230
|
* @param {string} [authorization] Bearer Token
|
|
231
231
|
* @param {*} [options] Override http request option.
|
|
@@ -269,19 +269,19 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
269
269
|
};
|
|
270
270
|
},
|
|
271
271
|
/**
|
|
272
|
-
* undefined **Required Permissions** \"
|
|
272
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
273
273
|
* @param {string} [authorization] Bearer Token
|
|
274
|
-
* @param {
|
|
275
|
-
* @param {
|
|
276
|
-
* @param {
|
|
277
|
-
* @param {
|
|
278
|
-
* @param {
|
|
279
|
-
* @param {
|
|
280
|
-
* @param {
|
|
274
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
276
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
277
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
278
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
279
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
280
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
281
281
|
* @param {*} [options] Override http request option.
|
|
282
282
|
* @throws {RequiredError}
|
|
283
283
|
*/
|
|
284
|
-
listDashboards: async (authorization?: string, pageSize?:
|
|
284
|
+
listDashboards: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
285
285
|
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
286
286
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
287
287
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -344,7 +344,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
344
344
|
};
|
|
345
345
|
},
|
|
346
346
|
/**
|
|
347
|
-
* undefined **Required Permissions** \"
|
|
347
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
348
348
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
349
349
|
* @param {string} [authorization] Bearer Token
|
|
350
350
|
* @param {*} [options] Override http request option.
|
|
@@ -390,7 +390,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
390
390
|
};
|
|
391
391
|
},
|
|
392
392
|
/**
|
|
393
|
-
* undefined **Required Permissions** \"
|
|
393
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
394
394
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
395
395
|
* @param {string} [authorization] Bearer Token
|
|
396
396
|
* @param {*} [options] Override http request option.
|
|
@@ -436,7 +436,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
436
436
|
};
|
|
437
437
|
},
|
|
438
438
|
/**
|
|
439
|
-
* undefined **Required Permissions** \"
|
|
439
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
440
440
|
* @param {string} code
|
|
441
441
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
442
442
|
* @param {string} [authorization] Bearer Token
|
|
@@ -496,7 +496,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
496
496
|
const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
|
|
497
497
|
return {
|
|
498
498
|
/**
|
|
499
|
-
* undefined **Required Permissions** \"
|
|
499
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
500
500
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
501
501
|
* @param {string} [authorization] Bearer Token
|
|
502
502
|
* @param {*} [options] Override http request option.
|
|
@@ -507,7 +507,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
507
507
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
508
508
|
},
|
|
509
509
|
/**
|
|
510
|
-
* undefined **Required Permissions** \"
|
|
510
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
511
511
|
* @param {string} code
|
|
512
512
|
* @param {string} [authorization] Bearer Token
|
|
513
513
|
* @param {*} [options] Override http request option.
|
|
@@ -518,7 +518,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
518
518
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
519
519
|
},
|
|
520
520
|
/**
|
|
521
|
-
* undefined **Required Permissions** \"
|
|
521
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
522
522
|
* @param {string} providerDashboardId
|
|
523
523
|
* @param {string} [authorization] Bearer Token
|
|
524
524
|
* @param {*} [options] Override http request option.
|
|
@@ -529,7 +529,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
529
529
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
530
|
},
|
|
531
531
|
/**
|
|
532
|
-
* undefined **Required Permissions** \"
|
|
532
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
533
533
|
* @param {string} code
|
|
534
534
|
* @param {string} [authorization] Bearer Token
|
|
535
535
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +540,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
540
540
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
541
541
|
},
|
|
542
542
|
/**
|
|
543
|
-
* undefined **Required Permissions** \"
|
|
543
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
544
544
|
* @param {string} providerDashboardId
|
|
545
545
|
* @param {string} [authorization] Bearer Token
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
@@ -551,24 +551,24 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
551
551
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
552
552
|
},
|
|
553
553
|
/**
|
|
554
|
-
* undefined **Required Permissions** \"
|
|
554
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
555
555
|
* @param {string} [authorization] Bearer Token
|
|
556
|
-
* @param {
|
|
557
|
-
* @param {
|
|
558
|
-
* @param {
|
|
559
|
-
* @param {
|
|
560
|
-
* @param {
|
|
561
|
-
* @param {
|
|
562
|
-
* @param {
|
|
556
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
557
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
558
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
559
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
560
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
561
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
562
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
565
565
|
*/
|
|
566
|
-
async listDashboards(authorization?: string, pageSize?:
|
|
566
|
+
async listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDashboardsResponseClass>> {
|
|
567
567
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
568
568
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
569
569
|
},
|
|
570
570
|
/**
|
|
571
|
-
* undefined **Required Permissions** \"
|
|
571
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
572
572
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
573
573
|
* @param {string} [authorization] Bearer Token
|
|
574
574
|
* @param {*} [options] Override http request option.
|
|
@@ -579,7 +579,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
579
579
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
580
580
|
},
|
|
581
581
|
/**
|
|
582
|
-
* undefined **Required Permissions** \"
|
|
582
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
583
583
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
584
584
|
* @param {string} [authorization] Bearer Token
|
|
585
585
|
* @param {*} [options] Override http request option.
|
|
@@ -590,7 +590,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
590
590
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
591
591
|
},
|
|
592
592
|
/**
|
|
593
|
-
* undefined **Required Permissions** \"
|
|
593
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
594
594
|
* @param {string} code
|
|
595
595
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
596
596
|
* @param {string} [authorization] Bearer Token
|
|
@@ -612,7 +612,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
612
612
|
const localVarFp = DashboardApiFp(configuration)
|
|
613
613
|
return {
|
|
614
614
|
/**
|
|
615
|
-
* undefined **Required Permissions** \"
|
|
615
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
616
616
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
617
617
|
* @param {string} [authorization] Bearer Token
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
@@ -622,7 +622,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
622
622
|
return localVarFp.createDashboard(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
623
623
|
},
|
|
624
624
|
/**
|
|
625
|
-
* undefined **Required Permissions** \"
|
|
625
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
626
626
|
* @param {string} code
|
|
627
627
|
* @param {string} [authorization] Bearer Token
|
|
628
628
|
* @param {*} [options] Override http request option.
|
|
@@ -632,7 +632,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
632
632
|
return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
633
633
|
},
|
|
634
634
|
/**
|
|
635
|
-
* undefined **Required Permissions** \"
|
|
635
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
636
636
|
* @param {string} providerDashboardId
|
|
637
637
|
* @param {string} [authorization] Bearer Token
|
|
638
638
|
* @param {*} [options] Override http request option.
|
|
@@ -642,7 +642,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
642
642
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
643
643
|
},
|
|
644
644
|
/**
|
|
645
|
-
* undefined **Required Permissions** \"
|
|
645
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
646
646
|
* @param {string} code
|
|
647
647
|
* @param {string} [authorization] Bearer Token
|
|
648
648
|
* @param {*} [options] Override http request option.
|
|
@@ -652,7 +652,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
652
652
|
return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
653
653
|
},
|
|
654
654
|
/**
|
|
655
|
-
* undefined **Required Permissions** \"
|
|
655
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
656
656
|
* @param {string} providerDashboardId
|
|
657
657
|
* @param {string} [authorization] Bearer Token
|
|
658
658
|
* @param {*} [options] Override http request option.
|
|
@@ -662,23 +662,23 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
662
662
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
663
663
|
},
|
|
664
664
|
/**
|
|
665
|
-
* undefined **Required Permissions** \"
|
|
665
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
666
666
|
* @param {string} [authorization] Bearer Token
|
|
667
|
-
* @param {
|
|
668
|
-
* @param {
|
|
669
|
-
* @param {
|
|
670
|
-
* @param {
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {
|
|
673
|
-
* @param {
|
|
667
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
668
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
669
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
670
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
671
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
672
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
673
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
675
675
|
* @throws {RequiredError}
|
|
676
676
|
*/
|
|
677
|
-
listDashboards(authorization?: string, pageSize?:
|
|
677
|
+
listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDashboardsResponseClass> {
|
|
678
678
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
679
679
|
},
|
|
680
680
|
/**
|
|
681
|
-
* undefined **Required Permissions** \"
|
|
681
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
682
682
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
683
683
|
* @param {string} [authorization] Bearer Token
|
|
684
684
|
* @param {*} [options] Override http request option.
|
|
@@ -688,7 +688,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
688
688
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
689
689
|
},
|
|
690
690
|
/**
|
|
691
|
-
* undefined **Required Permissions** \"
|
|
691
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
692
692
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
693
693
|
* @param {string} [authorization] Bearer Token
|
|
694
694
|
* @param {*} [options] Override http request option.
|
|
@@ -698,7 +698,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
698
698
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
699
699
|
},
|
|
700
700
|
/**
|
|
701
|
-
* undefined **Required Permissions** \"
|
|
701
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
702
702
|
* @param {string} code
|
|
703
703
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
704
704
|
* @param {string} [authorization] Bearer Token
|
|
@@ -831,52 +831,52 @@ export interface DashboardApiListDashboardsRequest {
|
|
|
831
831
|
|
|
832
832
|
/**
|
|
833
833
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
834
|
-
* @type {
|
|
834
|
+
* @type {number}
|
|
835
835
|
* @memberof DashboardApiListDashboards
|
|
836
836
|
*/
|
|
837
|
-
readonly pageSize?:
|
|
837
|
+
readonly pageSize?: number
|
|
838
838
|
|
|
839
839
|
/**
|
|
840
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
841
|
-
* @type {
|
|
840
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
841
|
+
* @type {string}
|
|
842
842
|
* @memberof DashboardApiListDashboards
|
|
843
843
|
*/
|
|
844
|
-
readonly pageToken?:
|
|
844
|
+
readonly pageToken?: string
|
|
845
845
|
|
|
846
846
|
/**
|
|
847
847
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
848
|
-
* @type {
|
|
848
|
+
* @type {string}
|
|
849
849
|
* @memberof DashboardApiListDashboards
|
|
850
850
|
*/
|
|
851
|
-
readonly filter?:
|
|
851
|
+
readonly filter?: string
|
|
852
852
|
|
|
853
853
|
/**
|
|
854
854
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
855
|
-
* @type {
|
|
855
|
+
* @type {string}
|
|
856
856
|
* @memberof DashboardApiListDashboards
|
|
857
857
|
*/
|
|
858
|
-
readonly search?:
|
|
858
|
+
readonly search?: string
|
|
859
859
|
|
|
860
860
|
/**
|
|
861
861
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
862
|
-
* @type {
|
|
862
|
+
* @type {string}
|
|
863
863
|
* @memberof DashboardApiListDashboards
|
|
864
864
|
*/
|
|
865
|
-
readonly order?:
|
|
865
|
+
readonly order?: string
|
|
866
866
|
|
|
867
867
|
/**
|
|
868
|
-
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in
|
|
869
|
-
* @type {
|
|
868
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
869
|
+
* @type {string}
|
|
870
870
|
* @memberof DashboardApiListDashboards
|
|
871
871
|
*/
|
|
872
|
-
readonly expand?:
|
|
872
|
+
readonly expand?: string
|
|
873
873
|
|
|
874
874
|
/**
|
|
875
875
|
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
876
|
-
* @type {
|
|
876
|
+
* @type {string}
|
|
877
877
|
* @memberof DashboardApiListDashboards
|
|
878
878
|
*/
|
|
879
|
-
readonly filters?:
|
|
879
|
+
readonly filters?: string
|
|
880
880
|
}
|
|
881
881
|
|
|
882
882
|
/**
|
|
@@ -957,7 +957,7 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
957
957
|
*/
|
|
958
958
|
export class DashboardApi extends BaseAPI {
|
|
959
959
|
/**
|
|
960
|
-
* undefined **Required Permissions** \"
|
|
960
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
961
961
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
962
962
|
* @param {*} [options] Override http request option.
|
|
963
963
|
* @throws {RequiredError}
|
|
@@ -968,7 +968,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
968
968
|
}
|
|
969
969
|
|
|
970
970
|
/**
|
|
971
|
-
* undefined **Required Permissions** \"
|
|
971
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
972
972
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
973
973
|
* @param {*} [options] Override http request option.
|
|
974
974
|
* @throws {RequiredError}
|
|
@@ -979,7 +979,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
979
979
|
}
|
|
980
980
|
|
|
981
981
|
/**
|
|
982
|
-
* undefined **Required Permissions** \"
|
|
982
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
983
983
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
984
984
|
* @param {*} [options] Override http request option.
|
|
985
985
|
* @throws {RequiredError}
|
|
@@ -990,7 +990,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
990
990
|
}
|
|
991
991
|
|
|
992
992
|
/**
|
|
993
|
-
* undefined **Required Permissions** \"
|
|
993
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
994
994
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
995
995
|
* @param {*} [options] Override http request option.
|
|
996
996
|
* @throws {RequiredError}
|
|
@@ -1001,7 +1001,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1001
1001
|
}
|
|
1002
1002
|
|
|
1003
1003
|
/**
|
|
1004
|
-
* undefined **Required Permissions** \"
|
|
1004
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
1005
1005
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
1006
1006
|
* @param {*} [options] Override http request option.
|
|
1007
1007
|
* @throws {RequiredError}
|
|
@@ -1012,7 +1012,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1012
1012
|
}
|
|
1013
1013
|
|
|
1014
1014
|
/**
|
|
1015
|
-
* undefined **Required Permissions** \"
|
|
1015
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
1016
1016
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
1017
1017
|
* @param {*} [options] Override http request option.
|
|
1018
1018
|
* @throws {RequiredError}
|
|
@@ -1023,7 +1023,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1023
1023
|
}
|
|
1024
1024
|
|
|
1025
1025
|
/**
|
|
1026
|
-
* undefined **Required Permissions** \"
|
|
1026
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1027
1027
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
1028
1028
|
* @param {*} [options] Override http request option.
|
|
1029
1029
|
* @throws {RequiredError}
|
|
@@ -1034,7 +1034,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1034
1034
|
}
|
|
1035
1035
|
|
|
1036
1036
|
/**
|
|
1037
|
-
* undefined **Required Permissions** \"
|
|
1037
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1038
1038
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
1039
1039
|
* @param {*} [options] Override http request option.
|
|
1040
1040
|
* @throws {RequiredError}
|
|
@@ -1045,7 +1045,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1045
1045
|
}
|
|
1046
1046
|
|
|
1047
1047
|
/**
|
|
1048
|
-
* undefined **Required Permissions** \"
|
|
1048
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1049
1049
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
1050
1050
|
* @param {*} [options] Override http request option.
|
|
1051
1051
|
* @throws {RequiredError}
|