@emilgroup/tenant-sdk-node 1.28.1-beta.1 → 1.28.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-node@1.28.1-beta.
|
|
20
|
+
npm install @emilgroup/tenant-sdk-node@1.28.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk-node@1.28.1-beta.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk-node@1.28.1-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/custom-schema-api.ts
CHANGED
|
@@ -143,17 +143,17 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
|
|
|
143
143
|
* 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\"
|
|
144
144
|
* @summary List custom-schemas
|
|
145
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
146
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
147
|
+
* @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.
|
|
148
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
149
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
150
|
+
* @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.
|
|
151
|
+
* @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.
|
|
152
|
+
* @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.
|
|
153
153
|
* @param {*} [options] Override http request option.
|
|
154
154
|
* @throws {RequiredError}
|
|
155
155
|
*/
|
|
156
|
-
listCustomSchemas: async (authorization?: string, pageSize?:
|
|
156
|
+
listCustomSchemas: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
157
157
|
const localVarPath = `/tenantservice/v1/custom-schemas`;
|
|
158
158
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
159
159
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -305,17 +305,17 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
|
|
|
305
305
|
* 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\"
|
|
306
306
|
* @summary List custom-schemas
|
|
307
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
311
|
-
* @param {
|
|
312
|
-
* @param {
|
|
313
|
-
* @param {
|
|
314
|
-
* @param {
|
|
308
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
|
+
* @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.
|
|
310
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
311
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
|
+
* @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.
|
|
313
|
+
* @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.
|
|
314
|
+
* @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.
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
async listCustomSchemas(authorization?: string, pageSize?:
|
|
318
|
+
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>> {
|
|
319
319
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
320
320
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
321
321
|
},
|
|
@@ -369,17 +369,17 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
|
|
|
369
369
|
* 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\"
|
|
370
370
|
* @summary List custom-schemas
|
|
371
371
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
|
-
* @param {
|
|
373
|
-
* @param {
|
|
374
|
-
* @param {
|
|
375
|
-
* @param {
|
|
376
|
-
* @param {
|
|
377
|
-
* @param {
|
|
378
|
-
* @param {
|
|
372
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
373
|
+
* @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.
|
|
374
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
375
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
376
|
+
* @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.
|
|
377
|
+
* @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.
|
|
378
|
+
* @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.
|
|
379
379
|
* @param {*} [options] Override http request option.
|
|
380
380
|
* @throws {RequiredError}
|
|
381
381
|
*/
|
|
382
|
-
listCustomSchemas(authorization?: string, pageSize?:
|
|
382
|
+
listCustomSchemas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
|
|
383
383
|
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
384
384
|
},
|
|
385
385
|
/**
|
|
@@ -461,52 +461,52 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
461
461
|
|
|
462
462
|
/**
|
|
463
463
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
464
|
-
* @type {
|
|
464
|
+
* @type {number}
|
|
465
465
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
466
466
|
*/
|
|
467
|
-
readonly pageSize?:
|
|
467
|
+
readonly pageSize?: number
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
|
-
* 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,
|
|
471
|
-
* @type {
|
|
470
|
+
* 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.
|
|
471
|
+
* @type {string}
|
|
472
472
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
473
473
|
*/
|
|
474
|
-
readonly pageToken?:
|
|
474
|
+
readonly pageToken?: string
|
|
475
475
|
|
|
476
476
|
/**
|
|
477
477
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
478
|
-
* @type {
|
|
478
|
+
* @type {string}
|
|
479
479
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
480
480
|
*/
|
|
481
|
-
readonly filter?:
|
|
481
|
+
readonly filter?: string
|
|
482
482
|
|
|
483
483
|
/**
|
|
484
484
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
485
|
-
* @type {
|
|
485
|
+
* @type {string}
|
|
486
486
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
487
487
|
*/
|
|
488
|
-
readonly search?:
|
|
488
|
+
readonly search?: string
|
|
489
489
|
|
|
490
490
|
/**
|
|
491
491
|
* 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.
|
|
492
|
-
* @type {
|
|
492
|
+
* @type {string}
|
|
493
493
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
494
494
|
*/
|
|
495
|
-
readonly order?:
|
|
495
|
+
readonly order?: string
|
|
496
496
|
|
|
497
497
|
/**
|
|
498
|
-
* 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
|
|
499
|
-
* @type {
|
|
498
|
+
* 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.
|
|
499
|
+
* @type {string}
|
|
500
500
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
501
501
|
*/
|
|
502
|
-
readonly expand?:
|
|
502
|
+
readonly expand?: string
|
|
503
503
|
|
|
504
504
|
/**
|
|
505
505
|
* 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.
|
|
506
|
-
* @type {
|
|
506
|
+
* @type {string}
|
|
507
507
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
508
508
|
*/
|
|
509
|
-
readonly filters?:
|
|
509
|
+
readonly filters?: string
|
|
510
510
|
}
|
|
511
511
|
|
|
512
512
|
/**
|
package/api/dashboard-api.ts
CHANGED
|
@@ -51,7 +51,7 @@ const FormData = require('form-data');
|
|
|
51
51
|
export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
52
52
|
return {
|
|
53
53
|
/**
|
|
54
|
-
* undefined **Required Permissions** \"
|
|
54
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
55
55
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
56
56
|
* @param {string} [authorization] Bearer Token
|
|
57
57
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
97
97
|
};
|
|
98
98
|
},
|
|
99
99
|
/**
|
|
100
|
-
* undefined **Required Permissions** \"
|
|
100
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
101
101
|
* @param {string} code
|
|
102
102
|
* @param {string} [authorization] Bearer Token
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -141,7 +141,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* undefined **Required Permissions** \"
|
|
144
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
145
145
|
* @param {string} providerDashboardId
|
|
146
146
|
* @param {string} [authorization] Bearer Token
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
@@ -185,7 +185,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
185
185
|
};
|
|
186
186
|
},
|
|
187
187
|
/**
|
|
188
|
-
* undefined **Required Permissions** \"
|
|
188
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
189
189
|
* @param {string} code
|
|
190
190
|
* @param {string} [authorization] Bearer Token
|
|
191
191
|
* @param {*} [options] Override http request option.
|
|
@@ -229,7 +229,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
229
229
|
};
|
|
230
230
|
},
|
|
231
231
|
/**
|
|
232
|
-
* undefined **Required Permissions** \"
|
|
232
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
233
233
|
* @param {string} providerDashboardId
|
|
234
234
|
* @param {string} [authorization] Bearer Token
|
|
235
235
|
* @param {*} [options] Override http request option.
|
|
@@ -273,19 +273,19 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
273
273
|
};
|
|
274
274
|
},
|
|
275
275
|
/**
|
|
276
|
-
* undefined **Required Permissions** \"
|
|
276
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
277
277
|
* @param {string} [authorization] Bearer Token
|
|
278
|
-
* @param {
|
|
279
|
-
* @param {
|
|
280
|
-
* @param {
|
|
281
|
-
* @param {
|
|
282
|
-
* @param {
|
|
283
|
-
* @param {
|
|
284
|
-
* @param {
|
|
278
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
279
|
+
* @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.
|
|
280
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
281
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
282
|
+
* @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.
|
|
283
|
+
* @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.
|
|
284
|
+
* @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.
|
|
285
285
|
* @param {*} [options] Override http request option.
|
|
286
286
|
* @throws {RequiredError}
|
|
287
287
|
*/
|
|
288
|
-
listDashboards: async (authorization?: string, pageSize?:
|
|
288
|
+
listDashboards: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
289
289
|
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
290
290
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
291
291
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -348,7 +348,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
348
348
|
};
|
|
349
349
|
},
|
|
350
350
|
/**
|
|
351
|
-
* undefined **Required Permissions** \"
|
|
351
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
352
352
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
353
353
|
* @param {string} [authorization] Bearer Token
|
|
354
354
|
* @param {*} [options] Override http request option.
|
|
@@ -394,7 +394,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
394
394
|
};
|
|
395
395
|
},
|
|
396
396
|
/**
|
|
397
|
-
* undefined **Required Permissions** \"
|
|
397
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
398
398
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
399
399
|
* @param {string} [authorization] Bearer Token
|
|
400
400
|
* @param {*} [options] Override http request option.
|
|
@@ -440,7 +440,7 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
440
440
|
};
|
|
441
441
|
},
|
|
442
442
|
/**
|
|
443
|
-
* undefined **Required Permissions** \"
|
|
443
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
444
444
|
* @param {string} code
|
|
445
445
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
446
446
|
* @param {string} [authorization] Bearer Token
|
|
@@ -500,7 +500,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
500
500
|
const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
|
|
501
501
|
return {
|
|
502
502
|
/**
|
|
503
|
-
* undefined **Required Permissions** \"
|
|
503
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
504
504
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
505
505
|
* @param {string} [authorization] Bearer Token
|
|
506
506
|
* @param {*} [options] Override http request option.
|
|
@@ -511,7 +511,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
511
511
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
512
512
|
},
|
|
513
513
|
/**
|
|
514
|
-
* undefined **Required Permissions** \"
|
|
514
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
515
515
|
* @param {string} code
|
|
516
516
|
* @param {string} [authorization] Bearer Token
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
@@ -522,7 +522,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
522
522
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* undefined **Required Permissions** \"
|
|
525
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
526
526
|
* @param {string} providerDashboardId
|
|
527
527
|
* @param {string} [authorization] Bearer Token
|
|
528
528
|
* @param {*} [options] Override http request option.
|
|
@@ -533,7 +533,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
533
533
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
534
534
|
},
|
|
535
535
|
/**
|
|
536
|
-
* undefined **Required Permissions** \"
|
|
536
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
537
537
|
* @param {string} code
|
|
538
538
|
* @param {string} [authorization] Bearer Token
|
|
539
539
|
* @param {*} [options] Override http request option.
|
|
@@ -544,7 +544,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
544
544
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
545
545
|
},
|
|
546
546
|
/**
|
|
547
|
-
* undefined **Required Permissions** \"
|
|
547
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
548
548
|
* @param {string} providerDashboardId
|
|
549
549
|
* @param {string} [authorization] Bearer Token
|
|
550
550
|
* @param {*} [options] Override http request option.
|
|
@@ -555,24 +555,24 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
555
555
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
556
556
|
},
|
|
557
557
|
/**
|
|
558
|
-
* undefined **Required Permissions** \"
|
|
558
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
559
559
|
* @param {string} [authorization] Bearer Token
|
|
560
|
-
* @param {
|
|
561
|
-
* @param {
|
|
562
|
-
* @param {
|
|
563
|
-
* @param {
|
|
564
|
-
* @param {
|
|
565
|
-
* @param {
|
|
566
|
-
* @param {
|
|
560
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
561
|
+
* @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.
|
|
562
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
563
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
564
|
+
* @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.
|
|
565
|
+
* @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.
|
|
566
|
+
* @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.
|
|
567
567
|
* @param {*} [options] Override http request option.
|
|
568
568
|
* @throws {RequiredError}
|
|
569
569
|
*/
|
|
570
|
-
async listDashboards(authorization?: string, pageSize?:
|
|
570
|
+
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>> {
|
|
571
571
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
572
572
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
573
573
|
},
|
|
574
574
|
/**
|
|
575
|
-
* undefined **Required Permissions** \"
|
|
575
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
576
576
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
577
577
|
* @param {string} [authorization] Bearer Token
|
|
578
578
|
* @param {*} [options] Override http request option.
|
|
@@ -583,7 +583,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
583
583
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
584
584
|
},
|
|
585
585
|
/**
|
|
586
|
-
* undefined **Required Permissions** \"
|
|
586
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
587
587
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
588
588
|
* @param {string} [authorization] Bearer Token
|
|
589
589
|
* @param {*} [options] Override http request option.
|
|
@@ -594,7 +594,7 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
594
594
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
595
595
|
},
|
|
596
596
|
/**
|
|
597
|
-
* undefined **Required Permissions** \"
|
|
597
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
598
598
|
* @param {string} code
|
|
599
599
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
600
600
|
* @param {string} [authorization] Bearer Token
|
|
@@ -616,7 +616,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
616
616
|
const localVarFp = DashboardApiFp(configuration)
|
|
617
617
|
return {
|
|
618
618
|
/**
|
|
619
|
-
* undefined **Required Permissions** \"
|
|
619
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
620
620
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
621
621
|
* @param {string} [authorization] Bearer Token
|
|
622
622
|
* @param {*} [options] Override http request option.
|
|
@@ -626,7 +626,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
626
626
|
return localVarFp.createDashboard(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
627
627
|
},
|
|
628
628
|
/**
|
|
629
|
-
* undefined **Required Permissions** \"
|
|
629
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
630
630
|
* @param {string} code
|
|
631
631
|
* @param {string} [authorization] Bearer Token
|
|
632
632
|
* @param {*} [options] Override http request option.
|
|
@@ -636,7 +636,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
636
636
|
return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
637
637
|
},
|
|
638
638
|
/**
|
|
639
|
-
* undefined **Required Permissions** \"
|
|
639
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
640
640
|
* @param {string} providerDashboardId
|
|
641
641
|
* @param {string} [authorization] Bearer Token
|
|
642
642
|
* @param {*} [options] Override http request option.
|
|
@@ -646,7 +646,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
646
646
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
647
647
|
},
|
|
648
648
|
/**
|
|
649
|
-
* undefined **Required Permissions** \"
|
|
649
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
650
650
|
* @param {string} code
|
|
651
651
|
* @param {string} [authorization] Bearer Token
|
|
652
652
|
* @param {*} [options] Override http request option.
|
|
@@ -656,7 +656,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
656
656
|
return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
657
657
|
},
|
|
658
658
|
/**
|
|
659
|
-
* undefined **Required Permissions** \"
|
|
659
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
660
660
|
* @param {string} providerDashboardId
|
|
661
661
|
* @param {string} [authorization] Bearer Token
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
@@ -666,23 +666,23 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
666
666
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
667
667
|
},
|
|
668
668
|
/**
|
|
669
|
-
* undefined **Required Permissions** \"
|
|
669
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
670
670
|
* @param {string} [authorization] Bearer Token
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {
|
|
673
|
-
* @param {
|
|
674
|
-
* @param {
|
|
675
|
-
* @param {
|
|
676
|
-
* @param {
|
|
677
|
-
* @param {
|
|
671
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
672
|
+
* @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.
|
|
673
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
674
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
675
|
+
* @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.
|
|
676
|
+
* @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.
|
|
677
|
+
* @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.
|
|
678
678
|
* @param {*} [options] Override http request option.
|
|
679
679
|
* @throws {RequiredError}
|
|
680
680
|
*/
|
|
681
|
-
listDashboards(authorization?: string, pageSize?:
|
|
681
|
+
listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDashboardsResponseClass> {
|
|
682
682
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
683
683
|
},
|
|
684
684
|
/**
|
|
685
|
-
* undefined **Required Permissions** \"
|
|
685
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
686
686
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
687
687
|
* @param {string} [authorization] Bearer Token
|
|
688
688
|
* @param {*} [options] Override http request option.
|
|
@@ -692,7 +692,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
692
692
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
693
693
|
},
|
|
694
694
|
/**
|
|
695
|
-
* undefined **Required Permissions** \"
|
|
695
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
696
696
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
697
697
|
* @param {string} [authorization] Bearer Token
|
|
698
698
|
* @param {*} [options] Override http request option.
|
|
@@ -702,7 +702,7 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
702
702
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
703
703
|
},
|
|
704
704
|
/**
|
|
705
|
-
* undefined **Required Permissions** \"
|
|
705
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
706
706
|
* @param {string} code
|
|
707
707
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
708
708
|
* @param {string} [authorization] Bearer Token
|
|
@@ -835,52 +835,52 @@ export interface DashboardApiListDashboardsRequest {
|
|
|
835
835
|
|
|
836
836
|
/**
|
|
837
837
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
838
|
-
* @type {
|
|
838
|
+
* @type {number}
|
|
839
839
|
* @memberof DashboardApiListDashboards
|
|
840
840
|
*/
|
|
841
|
-
readonly pageSize?:
|
|
841
|
+
readonly pageSize?: number
|
|
842
842
|
|
|
843
843
|
/**
|
|
844
|
-
* 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,
|
|
845
|
-
* @type {
|
|
844
|
+
* 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.
|
|
845
|
+
* @type {string}
|
|
846
846
|
* @memberof DashboardApiListDashboards
|
|
847
847
|
*/
|
|
848
|
-
readonly pageToken?:
|
|
848
|
+
readonly pageToken?: string
|
|
849
849
|
|
|
850
850
|
/**
|
|
851
851
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
852
|
-
* @type {
|
|
852
|
+
* @type {string}
|
|
853
853
|
* @memberof DashboardApiListDashboards
|
|
854
854
|
*/
|
|
855
|
-
readonly filter?:
|
|
855
|
+
readonly filter?: string
|
|
856
856
|
|
|
857
857
|
/**
|
|
858
858
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
859
|
-
* @type {
|
|
859
|
+
* @type {string}
|
|
860
860
|
* @memberof DashboardApiListDashboards
|
|
861
861
|
*/
|
|
862
|
-
readonly search?:
|
|
862
|
+
readonly search?: string
|
|
863
863
|
|
|
864
864
|
/**
|
|
865
865
|
* 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.
|
|
866
|
-
* @type {
|
|
866
|
+
* @type {string}
|
|
867
867
|
* @memberof DashboardApiListDashboards
|
|
868
868
|
*/
|
|
869
|
-
readonly order?:
|
|
869
|
+
readonly order?: string
|
|
870
870
|
|
|
871
871
|
/**
|
|
872
|
-
* 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
|
|
873
|
-
* @type {
|
|
872
|
+
* 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.
|
|
873
|
+
* @type {string}
|
|
874
874
|
* @memberof DashboardApiListDashboards
|
|
875
875
|
*/
|
|
876
|
-
readonly expand?:
|
|
876
|
+
readonly expand?: string
|
|
877
877
|
|
|
878
878
|
/**
|
|
879
879
|
* 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.
|
|
880
|
-
* @type {
|
|
880
|
+
* @type {string}
|
|
881
881
|
* @memberof DashboardApiListDashboards
|
|
882
882
|
*/
|
|
883
|
-
readonly filters?:
|
|
883
|
+
readonly filters?: string
|
|
884
884
|
}
|
|
885
885
|
|
|
886
886
|
/**
|
|
@@ -961,7 +961,7 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
961
961
|
*/
|
|
962
962
|
export class DashboardApi extends BaseAPI {
|
|
963
963
|
/**
|
|
964
|
-
* undefined **Required Permissions** \"
|
|
964
|
+
* undefined **Required Permissions** \"reporting.dashboards.create\"
|
|
965
965
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
966
966
|
* @param {*} [options] Override http request option.
|
|
967
967
|
* @throws {RequiredError}
|
|
@@ -972,7 +972,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
972
972
|
}
|
|
973
973
|
|
|
974
974
|
/**
|
|
975
|
-
* undefined **Required Permissions** \"
|
|
975
|
+
* undefined **Required Permissions** \"reporting.dashboards.delete\"
|
|
976
976
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
977
977
|
* @param {*} [options] Override http request option.
|
|
978
978
|
* @throws {RequiredError}
|
|
@@ -983,7 +983,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
983
983
|
}
|
|
984
984
|
|
|
985
985
|
/**
|
|
986
|
-
* undefined **Required Permissions** \"
|
|
986
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
987
987
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
988
988
|
* @param {*} [options] Override http request option.
|
|
989
989
|
* @throws {RequiredError}
|
|
@@ -994,7 +994,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
994
994
|
}
|
|
995
995
|
|
|
996
996
|
/**
|
|
997
|
-
* undefined **Required Permissions** \"
|
|
997
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
998
998
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
999
999
|
* @param {*} [options] Override http request option.
|
|
1000
1000
|
* @throws {RequiredError}
|
|
@@ -1005,7 +1005,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1005
1005
|
}
|
|
1006
1006
|
|
|
1007
1007
|
/**
|
|
1008
|
-
* undefined **Required Permissions** \"
|
|
1008
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
1009
1009
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
1010
1010
|
* @param {*} [options] Override http request option.
|
|
1011
1011
|
* @throws {RequiredError}
|
|
@@ -1016,7 +1016,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1016
1016
|
}
|
|
1017
1017
|
|
|
1018
1018
|
/**
|
|
1019
|
-
* undefined **Required Permissions** \"
|
|
1019
|
+
* undefined **Required Permissions** \"reporting.dashboards.view\"
|
|
1020
1020
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
1021
1021
|
* @param {*} [options] Override http request option.
|
|
1022
1022
|
* @throws {RequiredError}
|
|
@@ -1027,7 +1027,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1027
1027
|
}
|
|
1028
1028
|
|
|
1029
1029
|
/**
|
|
1030
|
-
* undefined **Required Permissions** \"
|
|
1030
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1031
1031
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
1032
1032
|
* @param {*} [options] Override http request option.
|
|
1033
1033
|
* @throws {RequiredError}
|
|
@@ -1038,7 +1038,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1038
1038
|
}
|
|
1039
1039
|
|
|
1040
1040
|
/**
|
|
1041
|
-
* undefined **Required Permissions** \"
|
|
1041
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1042
1042
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
1043
1043
|
* @param {*} [options] Override http request option.
|
|
1044
1044
|
* @throws {RequiredError}
|
|
@@ -1049,7 +1049,7 @@ export class DashboardApi extends BaseAPI {
|
|
|
1049
1049
|
}
|
|
1050
1050
|
|
|
1051
1051
|
/**
|
|
1052
|
-
* undefined **Required Permissions** \"
|
|
1052
|
+
* undefined **Required Permissions** \"reporting.dashboards.update\"
|
|
1053
1053
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
1054
1054
|
* @param {*} [options] Override http request option.
|
|
1055
1055
|
* @throws {RequiredError}
|