@emilgroup/tenant-sdk-node 1.34.1-beta.21 → 1.34.1-beta.22
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/.openapi-generator/FILES +30 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +103 -0
- package/api/report-schedule-api.ts +697 -0
- package/api/report-schedule-logs-api.ts +250 -0
- package/api/user-group-api.ts +1090 -0
- package/api.ts +6 -0
- package/base.ts +1 -0
- package/dist/api/dashboard-api.d.ts +56 -0
- package/dist/api/dashboard-api.js +92 -0
- package/dist/api/report-schedule-api.d.ts +394 -0
- package/dist/api/report-schedule-api.js +646 -0
- package/dist/api/report-schedule-logs-api.d.ts +150 -0
- package/dist/api/report-schedule-logs-api.js +264 -0
- package/dist/api/user-group-api.d.ts +603 -0
- package/dist/api/user-group-api.js +940 -0
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/add-users-to-group-request-dto.d.ts +24 -0
- package/dist/models/add-users-to-group-request-dto.js +15 -0
- package/dist/models/add-users-to-group-response-class.d.ts +25 -0
- package/dist/models/add-users-to-group-response-class.js +15 -0
- package/dist/models/create-report-schedule-request-dto.d.ts +115 -0
- package/dist/models/create-report-schedule-request-dto.js +15 -0
- package/dist/models/create-report-schedule-response-class.d.ts +25 -0
- package/dist/models/create-report-schedule-response-class.js +15 -0
- package/dist/models/create-user-group-request-dto.d.ts +36 -0
- package/dist/models/create-user-group-request-dto.js +15 -0
- package/dist/models/create-user-group-response-class.d.ts +25 -0
- package/dist/models/create-user-group-response-class.js +15 -0
- package/dist/models/dashboard-metadata-class.d.ts +43 -0
- package/dist/models/dashboard-metadata-class.js +15 -0
- package/dist/models/get-dashboard-metadata-response-class.d.ts +25 -0
- package/dist/models/get-dashboard-metadata-response-class.js +15 -0
- package/dist/models/get-report-schedule-response-class.d.ts +25 -0
- package/dist/models/get-report-schedule-response-class.js +15 -0
- package/dist/models/get-user-group-response-class.d.ts +25 -0
- package/dist/models/get-user-group-response-class.js +15 -0
- package/dist/models/index.d.ts +27 -0
- package/dist/models/index.js +27 -0
- package/dist/models/list-report-schedule-logs-response-class.d.ts +43 -0
- package/dist/models/list-report-schedule-logs-response-class.js +15 -0
- package/dist/models/list-report-schedules-response-class.d.ts +43 -0
- package/dist/models/list-report-schedules-response-class.js +15 -0
- package/dist/models/list-user-group-members-response-class.d.ts +43 -0
- package/dist/models/list-user-group-members-response-class.js +15 -0
- package/dist/models/list-user-groups-response-class.d.ts +43 -0
- package/dist/models/list-user-groups-response-class.js +15 -0
- package/dist/models/quick-sight-analysis-parameter-class.d.ts +36 -0
- package/dist/models/quick-sight-analysis-parameter-class.js +15 -0
- package/dist/models/remove-users-from-group-request-dto.d.ts +24 -0
- package/dist/models/remove-users-from-group-request-dto.js +15 -0
- package/dist/models/report-schedule-class.d.ts +157 -0
- package/dist/models/report-schedule-class.js +15 -0
- package/dist/models/report-schedule-log-class.d.ts +133 -0
- package/dist/models/report-schedule-log-class.js +15 -0
- package/dist/models/report-schedule-parameter-class.d.ts +42 -0
- package/dist/models/report-schedule-parameter-class.js +15 -0
- package/dist/models/report-schedule-parameter-dto.d.ts +42 -0
- package/dist/models/report-schedule-parameter-dto.js +15 -0
- package/dist/models/report-schedule-parameter-value-class.d.ts +30 -0
- package/dist/models/report-schedule-parameter-value-class.js +15 -0
- package/dist/models/update-report-schedule-request-dto.d.ts +121 -0
- package/dist/models/update-report-schedule-request-dto.js +15 -0
- package/dist/models/update-report-schedule-response-class.d.ts +25 -0
- package/dist/models/update-report-schedule-response-class.js +15 -0
- package/dist/models/update-user-group-request-dto.d.ts +36 -0
- package/dist/models/update-user-group-request-dto.js +15 -0
- package/dist/models/update-user-group-response-class.d.ts +25 -0
- package/dist/models/update-user-group-response-class.js +15 -0
- package/dist/models/user-group-class.d.ts +72 -0
- package/dist/models/user-group-class.js +15 -0
- package/dist/models/user-group-member-class.d.ts +42 -0
- package/dist/models/user-group-member-class.js +15 -0
- package/models/add-users-to-group-request-dto.ts +30 -0
- package/models/add-users-to-group-response-class.ts +31 -0
- package/models/create-report-schedule-request-dto.ts +121 -0
- package/models/create-report-schedule-response-class.ts +31 -0
- package/models/create-user-group-request-dto.ts +42 -0
- package/models/create-user-group-response-class.ts +31 -0
- package/models/dashboard-metadata-class.ts +49 -0
- package/models/get-dashboard-metadata-response-class.ts +31 -0
- package/models/get-report-schedule-response-class.ts +31 -0
- package/models/get-user-group-response-class.ts +31 -0
- package/models/index.ts +27 -0
- package/models/list-report-schedule-logs-response-class.ts +49 -0
- package/models/list-report-schedules-response-class.ts +49 -0
- package/models/list-user-group-members-response-class.ts +49 -0
- package/models/list-user-groups-response-class.ts +49 -0
- package/models/quick-sight-analysis-parameter-class.ts +42 -0
- package/models/remove-users-from-group-request-dto.ts +30 -0
- package/models/report-schedule-class.ts +163 -0
- package/models/report-schedule-log-class.ts +139 -0
- package/models/report-schedule-parameter-class.ts +48 -0
- package/models/report-schedule-parameter-dto.ts +48 -0
- package/models/report-schedule-parameter-value-class.ts +36 -0
- package/models/update-report-schedule-request-dto.ts +127 -0
- package/models/update-report-schedule-response-class.ts +31 -0
- package/models/update-user-group-request-dto.ts +42 -0
- package/models/update-user-group-response-class.ts +31 -0
- package/models/user-group-class.ts +78 -0
- package/models/user-group-member-class.ts +48 -0
- package/package.json +2 -2
package/api.ts
CHANGED
|
@@ -38,9 +38,12 @@ import { ListOrganizationInvitationsApi } from './api';
|
|
|
38
38
|
import { OrganizationMigrationApi } from './api';
|
|
39
39
|
import { OrganizationsApi } from './api';
|
|
40
40
|
import { ReInviteAnOrganizationApi } from './api';
|
|
41
|
+
import { ReportScheduleApi } from './api';
|
|
42
|
+
import { ReportScheduleLogsApi } from './api';
|
|
41
43
|
import { RolesApi } from './api';
|
|
42
44
|
import { SettingsApi } from './api';
|
|
43
45
|
import { UserControllerRestApi } from './api';
|
|
46
|
+
import { UserGroupApi } from './api';
|
|
44
47
|
import { UsersApi } from './api';
|
|
45
48
|
|
|
46
49
|
|
|
@@ -58,8 +61,11 @@ export * from './api/list-organization-invitations-api';
|
|
|
58
61
|
export * from './api/organization-migration-api';
|
|
59
62
|
export * from './api/organizations-api';
|
|
60
63
|
export * from './api/re-invite-an-organization-api';
|
|
64
|
+
export * from './api/report-schedule-api';
|
|
65
|
+
export * from './api/report-schedule-logs-api';
|
|
61
66
|
export * from './api/roles-api';
|
|
62
67
|
export * from './api/settings-api';
|
|
63
68
|
export * from './api/user-controller-rest-api';
|
|
69
|
+
export * from './api/user-group-api';
|
|
64
70
|
export * from './api/users-api';
|
|
65
71
|
|
package/base.ts
CHANGED
|
@@ -60,6 +60,7 @@ export enum Environment {
|
|
|
60
60
|
Staging = 'https://apiv2-staging.emil.de',
|
|
61
61
|
Development = 'https://apiv2-dev.emil.de',
|
|
62
62
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
63
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
63
64
|
}
|
|
64
65
|
|
|
65
66
|
let _retry_count = 0
|
|
@@ -18,6 +18,7 @@ import { CreateDashboardV2RequestDto } from '../models';
|
|
|
18
18
|
import { CreateDashboardV2ResponseClass } from '../models';
|
|
19
19
|
import { DeleteResponseClass } from '../models';
|
|
20
20
|
import { DuplicateDashboardResponseClass } from '../models';
|
|
21
|
+
import { GetDashboardMetadataResponseClass } from '../models';
|
|
21
22
|
import { GetDashboardResponseClass } from '../models';
|
|
22
23
|
import { GetEmbeddedUrlResponseClass } from '../models';
|
|
23
24
|
import { ListDashboardsResponseClass } from '../models';
|
|
@@ -94,6 +95,15 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
94
95
|
* @throws {RequiredError}
|
|
95
96
|
*/
|
|
96
97
|
getDashboardEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
|
+
/**
|
|
99
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
100
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
101
|
+
* @param {string} code
|
|
102
|
+
* @param {string} [authorization] Bearer Token
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getDashboardMetadata: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
107
|
/**
|
|
98
108
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
99
109
|
* @summary Retrieves a list of dashboards
|
|
@@ -207,6 +217,15 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
207
217
|
* @throws {RequiredError}
|
|
208
218
|
*/
|
|
209
219
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
|
|
220
|
+
/**
|
|
221
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
222
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
223
|
+
* @param {string} code
|
|
224
|
+
* @param {string} [authorization] Bearer Token
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
getDashboardMetadata(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardMetadataResponseClass>>;
|
|
210
229
|
/**
|
|
211
230
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
212
231
|
* @summary Retrieves a list of dashboards
|
|
@@ -320,6 +339,15 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
320
339
|
* @throws {RequiredError}
|
|
321
340
|
*/
|
|
322
341
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
|
|
342
|
+
/**
|
|
343
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
344
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
345
|
+
* @param {string} code
|
|
346
|
+
* @param {string} [authorization] Bearer Token
|
|
347
|
+
* @param {*} [options] Override http request option.
|
|
348
|
+
* @throws {RequiredError}
|
|
349
|
+
*/
|
|
350
|
+
getDashboardMetadata(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardMetadataResponseClass>;
|
|
323
351
|
/**
|
|
324
352
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
325
353
|
* @summary Retrieves a list of dashboards
|
|
@@ -497,6 +525,25 @@ export interface DashboardApiGetDashboardEmbeddedUrlRequest {
|
|
|
497
525
|
*/
|
|
498
526
|
readonly authorization?: string;
|
|
499
527
|
}
|
|
528
|
+
/**
|
|
529
|
+
* Request parameters for getDashboardMetadata operation in DashboardApi.
|
|
530
|
+
* @export
|
|
531
|
+
* @interface DashboardApiGetDashboardMetadataRequest
|
|
532
|
+
*/
|
|
533
|
+
export interface DashboardApiGetDashboardMetadataRequest {
|
|
534
|
+
/**
|
|
535
|
+
*
|
|
536
|
+
* @type {string}
|
|
537
|
+
* @memberof DashboardApiGetDashboardMetadata
|
|
538
|
+
*/
|
|
539
|
+
readonly code: string;
|
|
540
|
+
/**
|
|
541
|
+
* Bearer Token
|
|
542
|
+
* @type {string}
|
|
543
|
+
* @memberof DashboardApiGetDashboardMetadata
|
|
544
|
+
*/
|
|
545
|
+
readonly authorization?: string;
|
|
546
|
+
}
|
|
500
547
|
/**
|
|
501
548
|
* Request parameters for listDashboards operation in DashboardApi.
|
|
502
549
|
* @export
|
|
@@ -686,6 +733,15 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
686
733
|
* @memberof DashboardApi
|
|
687
734
|
*/
|
|
688
735
|
getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any, {}>>;
|
|
736
|
+
/**
|
|
737
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
738
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
739
|
+
* @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
* @memberof DashboardApi
|
|
743
|
+
*/
|
|
744
|
+
getDashboardMetadata(requestParameters: DashboardApiGetDashboardMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardMetadataResponseClass, any, {}>>;
|
|
689
745
|
/**
|
|
690
746
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
691
747
|
* @summary Retrieves a list of dashboards
|
|
@@ -435,6 +435,54 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
435
435
|
});
|
|
436
436
|
});
|
|
437
437
|
},
|
|
438
|
+
/**
|
|
439
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
440
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
441
|
+
* @param {string} code
|
|
442
|
+
* @param {string} [authorization] Bearer Token
|
|
443
|
+
* @param {*} [options] Override http request option.
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
*/
|
|
446
|
+
getDashboardMetadata: function (code, authorization, options) {
|
|
447
|
+
if (options === void 0) { options = {}; }
|
|
448
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
449
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
450
|
+
return __generator(this, function (_a) {
|
|
451
|
+
switch (_a.label) {
|
|
452
|
+
case 0:
|
|
453
|
+
// verify required parameter 'code' is not null or undefined
|
|
454
|
+
(0, common_1.assertParamExists)('getDashboardMetadata', 'code', code);
|
|
455
|
+
localVarPath = "/tenantservice/v1/dashboards/{code}/metadata"
|
|
456
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
457
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
458
|
+
if (configuration) {
|
|
459
|
+
baseOptions = configuration.baseOptions;
|
|
460
|
+
baseAccessToken = configuration.accessToken;
|
|
461
|
+
}
|
|
462
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
463
|
+
localVarHeaderParameter = {};
|
|
464
|
+
localVarQueryParameter = {};
|
|
465
|
+
// authentication bearer required
|
|
466
|
+
// http bearer authentication required
|
|
467
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
468
|
+
case 1:
|
|
469
|
+
// authentication bearer required
|
|
470
|
+
// http bearer authentication required
|
|
471
|
+
_a.sent();
|
|
472
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
473
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
474
|
+
}
|
|
475
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
476
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
477
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
478
|
+
return [2 /*return*/, {
|
|
479
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
480
|
+
options: localVarRequestOptions,
|
|
481
|
+
}];
|
|
482
|
+
}
|
|
483
|
+
});
|
|
484
|
+
});
|
|
485
|
+
},
|
|
438
486
|
/**
|
|
439
487
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
440
488
|
* @summary Retrieves a list of dashboards
|
|
@@ -816,6 +864,27 @@ var DashboardApiFp = function (configuration) {
|
|
|
816
864
|
});
|
|
817
865
|
});
|
|
818
866
|
},
|
|
867
|
+
/**
|
|
868
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
869
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
870
|
+
* @param {string} code
|
|
871
|
+
* @param {string} [authorization] Bearer Token
|
|
872
|
+
* @param {*} [options] Override http request option.
|
|
873
|
+
* @throws {RequiredError}
|
|
874
|
+
*/
|
|
875
|
+
getDashboardMetadata: function (code, authorization, options) {
|
|
876
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
877
|
+
var localVarAxiosArgs;
|
|
878
|
+
return __generator(this, function (_a) {
|
|
879
|
+
switch (_a.label) {
|
|
880
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDashboardMetadata(code, authorization, options)];
|
|
881
|
+
case 1:
|
|
882
|
+
localVarAxiosArgs = _a.sent();
|
|
883
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
884
|
+
}
|
|
885
|
+
});
|
|
886
|
+
});
|
|
887
|
+
},
|
|
819
888
|
/**
|
|
820
889
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
821
890
|
* @summary Retrieves a list of dashboards
|
|
@@ -995,6 +1064,17 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
995
1064
|
getDashboardEmbeddedUrl: function (providerDashboardId, authorization, options) {
|
|
996
1065
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
997
1066
|
},
|
|
1067
|
+
/**
|
|
1068
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
1069
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
1070
|
+
* @param {string} code
|
|
1071
|
+
* @param {string} [authorization] Bearer Token
|
|
1072
|
+
* @param {*} [options] Override http request option.
|
|
1073
|
+
* @throws {RequiredError}
|
|
1074
|
+
*/
|
|
1075
|
+
getDashboardMetadata: function (code, authorization, options) {
|
|
1076
|
+
return localVarFp.getDashboardMetadata(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
1077
|
+
},
|
|
998
1078
|
/**
|
|
999
1079
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1000
1080
|
* @summary Retrieves a list of dashboards
|
|
@@ -1145,6 +1225,18 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
1145
1225
|
var _this = this;
|
|
1146
1226
|
return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1147
1227
|
};
|
|
1228
|
+
/**
|
|
1229
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
1230
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
1231
|
+
* @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
|
|
1232
|
+
* @param {*} [options] Override http request option.
|
|
1233
|
+
* @throws {RequiredError}
|
|
1234
|
+
* @memberof DashboardApi
|
|
1235
|
+
*/
|
|
1236
|
+
DashboardApi.prototype.getDashboardMetadata = function (requestParameters, options) {
|
|
1237
|
+
var _this = this;
|
|
1238
|
+
return (0, exports.DashboardApiFp)(this.configuration).getDashboardMetadata(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1239
|
+
};
|
|
1148
1240
|
/**
|
|
1149
1241
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1150
1242
|
* @summary Retrieves a list of dashboards
|
|
@@ -0,0 +1,394 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
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
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateReportScheduleRequestDto } from '../models';
|
|
16
|
+
import { CreateReportScheduleResponseClass } from '../models';
|
|
17
|
+
import { DeleteResponseClass } from '../models';
|
|
18
|
+
import { GetReportScheduleResponseClass } from '../models';
|
|
19
|
+
import { ListReportSchedulesResponseClass } from '../models';
|
|
20
|
+
import { UpdateReportScheduleRequestDto } from '../models';
|
|
21
|
+
import { UpdateReportScheduleResponseClass } from '../models';
|
|
22
|
+
/**
|
|
23
|
+
* ReportScheduleApi - axios parameter creator
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
export declare const ReportScheduleApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
|
|
29
|
+
* @summary Create the report-schedule
|
|
30
|
+
* @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
|
|
31
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
createReportSchedule: (createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
|
|
38
|
+
* @summary Delete the report-schedule
|
|
39
|
+
* @param {string} code Unique identifier for the object.
|
|
40
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
deleteReportSchedule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
|
|
47
|
+
* @summary Retrieve the report-schedule
|
|
48
|
+
* @param {string} code Unique identifier for the object.
|
|
49
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
|
+
* @param {string} [expand] Fields to expand response by
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getReportSchedule: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
|
|
57
|
+
* @summary List report-schedules
|
|
58
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
|
+
* @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.
|
|
61
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
62
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
63
|
+
* @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.
|
|
64
|
+
* @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.
|
|
65
|
+
* @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.
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
listReportSchedules: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
+
/**
|
|
71
|
+
* Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
|
|
72
|
+
* @summary Update the report-schedule
|
|
73
|
+
* @param {string} code
|
|
74
|
+
* @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
|
|
75
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
updateReportSchedule: (code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* ReportScheduleApi - functional programming interface
|
|
83
|
+
* @export
|
|
84
|
+
*/
|
|
85
|
+
export declare const ReportScheduleApiFp: (configuration?: Configuration) => {
|
|
86
|
+
/**
|
|
87
|
+
* Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
|
|
88
|
+
* @summary Create the report-schedule
|
|
89
|
+
* @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
|
|
90
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReportScheduleResponseClass>>;
|
|
95
|
+
/**
|
|
96
|
+
* Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
|
|
97
|
+
* @summary Delete the report-schedule
|
|
98
|
+
* @param {string} code Unique identifier for the object.
|
|
99
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
deleteReportSchedule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
104
|
+
/**
|
|
105
|
+
* Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
|
|
106
|
+
* @summary Retrieve the report-schedule
|
|
107
|
+
* @param {string} code Unique identifier for the object.
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {string} [expand] Fields to expand response by
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
getReportSchedule(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportScheduleResponseClass>>;
|
|
114
|
+
/**
|
|
115
|
+
* Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
|
|
116
|
+
* @summary List report-schedules
|
|
117
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
118
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
119
|
+
* @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.
|
|
120
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
121
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
122
|
+
* @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.
|
|
123
|
+
* @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.
|
|
124
|
+
* @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.
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
*/
|
|
128
|
+
listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListReportSchedulesResponseClass>>;
|
|
129
|
+
/**
|
|
130
|
+
* Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
|
|
131
|
+
* @summary Update the report-schedule
|
|
132
|
+
* @param {string} code
|
|
133
|
+
* @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
|
|
134
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
135
|
+
* @param {*} [options] Override http request option.
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateReportScheduleResponseClass>>;
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* ReportScheduleApi - factory interface
|
|
142
|
+
* @export
|
|
143
|
+
*/
|
|
144
|
+
export declare const ReportScheduleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
145
|
+
/**
|
|
146
|
+
* Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
|
|
147
|
+
* @summary Create the report-schedule
|
|
148
|
+
* @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
|
|
149
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReportScheduleResponseClass>;
|
|
154
|
+
/**
|
|
155
|
+
* Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
|
|
156
|
+
* @summary Delete the report-schedule
|
|
157
|
+
* @param {string} code Unique identifier for the object.
|
|
158
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
deleteReportSchedule(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
163
|
+
/**
|
|
164
|
+
* Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
|
|
165
|
+
* @summary Retrieve the report-schedule
|
|
166
|
+
* @param {string} code Unique identifier for the object.
|
|
167
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
168
|
+
* @param {string} [expand] Fields to expand response by
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
getReportSchedule(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetReportScheduleResponseClass>;
|
|
173
|
+
/**
|
|
174
|
+
* Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
|
|
175
|
+
* @summary List report-schedules
|
|
176
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
|
+
* @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.
|
|
179
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
180
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
181
|
+
* @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.
|
|
182
|
+
* @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.
|
|
183
|
+
* @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.
|
|
184
|
+
* @param {*} [options] Override http request option.
|
|
185
|
+
* @throws {RequiredError}
|
|
186
|
+
*/
|
|
187
|
+
listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListReportSchedulesResponseClass>;
|
|
188
|
+
/**
|
|
189
|
+
* Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
|
|
190
|
+
* @summary Update the report-schedule
|
|
191
|
+
* @param {string} code
|
|
192
|
+
* @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
|
|
193
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
*/
|
|
197
|
+
updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateReportScheduleResponseClass>;
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* Request parameters for createReportSchedule operation in ReportScheduleApi.
|
|
201
|
+
* @export
|
|
202
|
+
* @interface ReportScheduleApiCreateReportScheduleRequest
|
|
203
|
+
*/
|
|
204
|
+
export interface ReportScheduleApiCreateReportScheduleRequest {
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @type {CreateReportScheduleRequestDto}
|
|
208
|
+
* @memberof ReportScheduleApiCreateReportSchedule
|
|
209
|
+
*/
|
|
210
|
+
readonly createReportScheduleRequestDto: CreateReportScheduleRequestDto;
|
|
211
|
+
/**
|
|
212
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
|
+
* @type {string}
|
|
214
|
+
* @memberof ReportScheduleApiCreateReportSchedule
|
|
215
|
+
*/
|
|
216
|
+
readonly authorization?: string;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Request parameters for deleteReportSchedule operation in ReportScheduleApi.
|
|
220
|
+
* @export
|
|
221
|
+
* @interface ReportScheduleApiDeleteReportScheduleRequest
|
|
222
|
+
*/
|
|
223
|
+
export interface ReportScheduleApiDeleteReportScheduleRequest {
|
|
224
|
+
/**
|
|
225
|
+
* Unique identifier for the object.
|
|
226
|
+
* @type {string}
|
|
227
|
+
* @memberof ReportScheduleApiDeleteReportSchedule
|
|
228
|
+
*/
|
|
229
|
+
readonly code: string;
|
|
230
|
+
/**
|
|
231
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof ReportScheduleApiDeleteReportSchedule
|
|
234
|
+
*/
|
|
235
|
+
readonly authorization?: string;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Request parameters for getReportSchedule operation in ReportScheduleApi.
|
|
239
|
+
* @export
|
|
240
|
+
* @interface ReportScheduleApiGetReportScheduleRequest
|
|
241
|
+
*/
|
|
242
|
+
export interface ReportScheduleApiGetReportScheduleRequest {
|
|
243
|
+
/**
|
|
244
|
+
* Unique identifier for the object.
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof ReportScheduleApiGetReportSchedule
|
|
247
|
+
*/
|
|
248
|
+
readonly code: string;
|
|
249
|
+
/**
|
|
250
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
|
+
* @type {string}
|
|
252
|
+
* @memberof ReportScheduleApiGetReportSchedule
|
|
253
|
+
*/
|
|
254
|
+
readonly authorization?: string;
|
|
255
|
+
/**
|
|
256
|
+
* Fields to expand response by
|
|
257
|
+
* @type {string}
|
|
258
|
+
* @memberof ReportScheduleApiGetReportSchedule
|
|
259
|
+
*/
|
|
260
|
+
readonly expand?: string;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Request parameters for listReportSchedules operation in ReportScheduleApi.
|
|
264
|
+
* @export
|
|
265
|
+
* @interface ReportScheduleApiListReportSchedulesRequest
|
|
266
|
+
*/
|
|
267
|
+
export interface ReportScheduleApiListReportSchedulesRequest {
|
|
268
|
+
/**
|
|
269
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
272
|
+
*/
|
|
273
|
+
readonly authorization?: string;
|
|
274
|
+
/**
|
|
275
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
276
|
+
* @type {number}
|
|
277
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
278
|
+
*/
|
|
279
|
+
readonly pageSize?: number;
|
|
280
|
+
/**
|
|
281
|
+
* 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.
|
|
282
|
+
* @type {string}
|
|
283
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
284
|
+
*/
|
|
285
|
+
readonly pageToken?: string;
|
|
286
|
+
/**
|
|
287
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
290
|
+
*/
|
|
291
|
+
readonly filter?: string;
|
|
292
|
+
/**
|
|
293
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
294
|
+
* @type {string}
|
|
295
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
296
|
+
*/
|
|
297
|
+
readonly search?: string;
|
|
298
|
+
/**
|
|
299
|
+
* 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.
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
302
|
+
*/
|
|
303
|
+
readonly order?: string;
|
|
304
|
+
/**
|
|
305
|
+
* 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.
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
308
|
+
*/
|
|
309
|
+
readonly expand?: string;
|
|
310
|
+
/**
|
|
311
|
+
* 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.
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof ReportScheduleApiListReportSchedules
|
|
314
|
+
*/
|
|
315
|
+
readonly filters?: string;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* Request parameters for updateReportSchedule operation in ReportScheduleApi.
|
|
319
|
+
* @export
|
|
320
|
+
* @interface ReportScheduleApiUpdateReportScheduleRequest
|
|
321
|
+
*/
|
|
322
|
+
export interface ReportScheduleApiUpdateReportScheduleRequest {
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof ReportScheduleApiUpdateReportSchedule
|
|
327
|
+
*/
|
|
328
|
+
readonly code: string;
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {UpdateReportScheduleRequestDto}
|
|
332
|
+
* @memberof ReportScheduleApiUpdateReportSchedule
|
|
333
|
+
*/
|
|
334
|
+
readonly updateReportScheduleRequestDto: UpdateReportScheduleRequestDto;
|
|
335
|
+
/**
|
|
336
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof ReportScheduleApiUpdateReportSchedule
|
|
339
|
+
*/
|
|
340
|
+
readonly authorization?: string;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* ReportScheduleApi - object-oriented interface
|
|
344
|
+
* @export
|
|
345
|
+
* @class ReportScheduleApi
|
|
346
|
+
* @extends {BaseAPI}
|
|
347
|
+
*/
|
|
348
|
+
export declare class ReportScheduleApi extends BaseAPI {
|
|
349
|
+
/**
|
|
350
|
+
* Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
|
|
351
|
+
* @summary Create the report-schedule
|
|
352
|
+
* @param {ReportScheduleApiCreateReportScheduleRequest} requestParameters Request parameters.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
* @memberof ReportScheduleApi
|
|
356
|
+
*/
|
|
357
|
+
createReportSchedule(requestParameters: ReportScheduleApiCreateReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReportScheduleResponseClass, any, {}>>;
|
|
358
|
+
/**
|
|
359
|
+
* Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
|
|
360
|
+
* @summary Delete the report-schedule
|
|
361
|
+
* @param {ReportScheduleApiDeleteReportScheduleRequest} requestParameters Request parameters.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
* @memberof ReportScheduleApi
|
|
365
|
+
*/
|
|
366
|
+
deleteReportSchedule(requestParameters: ReportScheduleApiDeleteReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
|
|
367
|
+
/**
|
|
368
|
+
* Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
|
|
369
|
+
* @summary Retrieve the report-schedule
|
|
370
|
+
* @param {ReportScheduleApiGetReportScheduleRequest} requestParameters Request parameters.
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
* @memberof ReportScheduleApi
|
|
374
|
+
*/
|
|
375
|
+
getReportSchedule(requestParameters: ReportScheduleApiGetReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReportScheduleResponseClass, any, {}>>;
|
|
376
|
+
/**
|
|
377
|
+
* Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
|
|
378
|
+
* @summary List report-schedules
|
|
379
|
+
* @param {ReportScheduleApiListReportSchedulesRequest} requestParameters Request parameters.
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
* @memberof ReportScheduleApi
|
|
383
|
+
*/
|
|
384
|
+
listReportSchedules(requestParameters?: ReportScheduleApiListReportSchedulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListReportSchedulesResponseClass, any, {}>>;
|
|
385
|
+
/**
|
|
386
|
+
* Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
|
|
387
|
+
* @summary Update the report-schedule
|
|
388
|
+
* @param {ReportScheduleApiUpdateReportScheduleRequest} requestParameters Request parameters.
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
* @memberof ReportScheduleApi
|
|
392
|
+
*/
|
|
393
|
+
updateReportSchedule(requestParameters: ReportScheduleApiUpdateReportScheduleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateReportScheduleResponseClass, any, {}>>;
|
|
394
|
+
}
|