@emilgroup/tenant-sdk 1.42.0 → 1.42.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/.openapi-generator/FILES +17 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +103 -0
- package/api/report-schedule-api.ts +693 -0
- package/api/report-schedule-logs-api.ts +246 -0
- package/api.ts +4 -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 +642 -0
- package/dist/api/report-schedule-logs-api.d.ts +150 -0
- package/dist/api/report-schedule-logs-api.js +260 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -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/dashboard-metadata-class.d.ts +43 -0
- package/dist/models/dashboard-metadata-class.js +15 -0
- package/dist/models/dbconfig-dto.d.ts +6 -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/index.d.ts +15 -0
- package/dist/models/index.js +15 -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/quick-sight-analysis-parameter-class.d.ts +36 -0
- package/dist/models/quick-sight-analysis-parameter-class.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/models/create-report-schedule-request-dto.ts +121 -0
- package/models/create-report-schedule-response-class.ts +31 -0
- package/models/dashboard-metadata-class.ts +49 -0
- package/models/dbconfig-dto.ts +6 -0
- package/models/get-dashboard-metadata-response-class.ts +31 -0
- package/models/get-report-schedule-response-class.ts +31 -0
- package/models/index.ts +15 -0
- package/models/list-report-schedule-logs-response-class.ts +49 -0
- package/models/list-report-schedules-response-class.ts +49 -0
- package/models/quick-sight-analysis-parameter-class.ts +42 -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/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -17,6 +17,8 @@ api/list-organization-invitations-api.ts
|
|
|
17
17
|
api/organization-migration-api.ts
|
|
18
18
|
api/organizations-api.ts
|
|
19
19
|
api/re-invite-an-organization-api.ts
|
|
20
|
+
api/report-schedule-api.ts
|
|
21
|
+
api/report-schedule-logs-api.ts
|
|
20
22
|
api/roles-api.ts
|
|
21
23
|
api/settings-api.ts
|
|
22
24
|
api/user-controller-rest-api.ts
|
|
@@ -47,6 +49,8 @@ models/create-data-report-request-dto.ts
|
|
|
47
49
|
models/create-data-report-response-class.ts
|
|
48
50
|
models/create-organization-migration-request-dto.ts
|
|
49
51
|
models/create-organization-migration-response-class.ts
|
|
52
|
+
models/create-report-schedule-request-dto.ts
|
|
53
|
+
models/create-report-schedule-response-class.ts
|
|
50
54
|
models/create-resources-migration-request-dto.ts
|
|
51
55
|
models/create-tenant-request-dto.ts
|
|
52
56
|
models/create-user-group-request-dto.ts
|
|
@@ -55,6 +59,7 @@ models/custom-field-dto.ts
|
|
|
55
59
|
models/custom-schema-class.ts
|
|
56
60
|
models/dashboard-class.ts
|
|
57
61
|
models/dashboard-group-class.ts
|
|
62
|
+
models/dashboard-metadata-class.ts
|
|
58
63
|
models/data-report-class.ts
|
|
59
64
|
models/data-report-filter-class.ts
|
|
60
65
|
models/data-report-filter-dto.ts
|
|
@@ -71,11 +76,13 @@ models/enable-users-response-class.ts
|
|
|
71
76
|
models/format-tenant-settings-class.ts
|
|
72
77
|
models/get-custom-schema-response-class.ts
|
|
73
78
|
models/get-dashboard-group-response-class.ts
|
|
79
|
+
models/get-dashboard-metadata-response-class.ts
|
|
74
80
|
models/get-dashboard-response-class.ts
|
|
75
81
|
models/get-data-report-response-class.ts
|
|
76
82
|
models/get-embedded-url-response-class.ts
|
|
77
83
|
models/get-organization-migration-response-class.ts
|
|
78
84
|
models/get-organization-response-class.ts
|
|
85
|
+
models/get-report-schedule-response-class.ts
|
|
79
86
|
models/get-settings-response-class.ts
|
|
80
87
|
models/get-user-group-response-class.ts
|
|
81
88
|
models/get-user-response-class.ts
|
|
@@ -99,6 +106,8 @@ models/list-invites-response-class.ts
|
|
|
99
106
|
models/list-org-invitations-response-class.ts
|
|
100
107
|
models/list-organization-migrations-response-class.ts
|
|
101
108
|
models/list-organizations-response-class.ts
|
|
109
|
+
models/list-report-schedule-logs-response-class.ts
|
|
110
|
+
models/list-report-schedules-response-class.ts
|
|
102
111
|
models/list-roles-response-class.ts
|
|
103
112
|
models/list-user-group-members-response-class.ts
|
|
104
113
|
models/list-user-groups-response-class.ts
|
|
@@ -109,8 +118,14 @@ models/organization-class.ts
|
|
|
109
118
|
models/organization-migration-class.ts
|
|
110
119
|
models/permission-class.ts
|
|
111
120
|
models/publish-dashboard-request-dto.ts
|
|
121
|
+
models/quick-sight-analysis-parameter-class.ts
|
|
112
122
|
models/re-invite-org-request-dto.ts
|
|
113
123
|
models/remove-users-from-group-request-dto.ts
|
|
124
|
+
models/report-schedule-class.ts
|
|
125
|
+
models/report-schedule-log-class.ts
|
|
126
|
+
models/report-schedule-parameter-class.ts
|
|
127
|
+
models/report-schedule-parameter-dto.ts
|
|
128
|
+
models/report-schedule-parameter-value-class.ts
|
|
114
129
|
models/revert-analysis-request-dto.ts
|
|
115
130
|
models/revert-organization-migration-request-dto.ts
|
|
116
131
|
models/revert-organization-migration-response-class.ts
|
|
@@ -134,6 +149,8 @@ models/update-data-report-request-dto.ts
|
|
|
134
149
|
models/update-data-report-response-class.ts
|
|
135
150
|
models/update-organization-request-dto-rest.ts
|
|
136
151
|
models/update-organization-response-class.ts
|
|
152
|
+
models/update-report-schedule-request-dto.ts
|
|
153
|
+
models/update-report-schedule-response-class.ts
|
|
137
154
|
models/update-user-group-request-dto.ts
|
|
138
155
|
models/update-user-group-response-class.ts
|
|
139
156
|
models/user-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/tenant-sdk@1.42.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.42.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.42.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.42.1-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/dashboard-api.ts
CHANGED
|
@@ -35,6 +35,8 @@ import { DuplicateDashboardRequestDto } from '../models';
|
|
|
35
35
|
// @ts-ignore
|
|
36
36
|
import { DuplicateDashboardResponseClass } from '../models';
|
|
37
37
|
// @ts-ignore
|
|
38
|
+
import { GetDashboardMetadataResponseClass } from '../models';
|
|
39
|
+
// @ts-ignore
|
|
38
40
|
import { GetDashboardResponseClass } from '../models';
|
|
39
41
|
// @ts-ignore
|
|
40
42
|
import { GetEmbeddedUrlResponseClass } from '../models';
|
|
@@ -371,6 +373,51 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
371
373
|
|
|
372
374
|
|
|
373
375
|
|
|
376
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
377
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
378
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
379
|
+
|
|
380
|
+
return {
|
|
381
|
+
url: toPathString(localVarUrlObj),
|
|
382
|
+
options: localVarRequestOptions,
|
|
383
|
+
};
|
|
384
|
+
},
|
|
385
|
+
/**
|
|
386
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
387
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
388
|
+
* @param {string} code
|
|
389
|
+
* @param {string} [authorization] Bearer Token
|
|
390
|
+
* @param {*} [options] Override http request option.
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
*/
|
|
393
|
+
getDashboardMetadata: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
394
|
+
// verify required parameter 'code' is not null or undefined
|
|
395
|
+
assertParamExists('getDashboardMetadata', 'code', code)
|
|
396
|
+
const localVarPath = `/tenantservice/v1/dashboards/{code}/metadata`
|
|
397
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
398
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
399
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
400
|
+
let baseOptions;
|
|
401
|
+
let baseAccessToken;
|
|
402
|
+
if (configuration) {
|
|
403
|
+
baseOptions = configuration.baseOptions;
|
|
404
|
+
baseAccessToken = configuration.accessToken;
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
408
|
+
const localVarHeaderParameter = {} as any;
|
|
409
|
+
const localVarQueryParameter = {} as any;
|
|
410
|
+
|
|
411
|
+
// authentication bearer required
|
|
412
|
+
// http bearer authentication required
|
|
413
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
414
|
+
|
|
415
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
416
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
374
421
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
375
422
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
376
423
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -697,6 +744,18 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
697
744
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboardEmbeddedUrl(providerDashboardId, authorization, options);
|
|
698
745
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
699
746
|
},
|
|
747
|
+
/**
|
|
748
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
749
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
750
|
+
* @param {string} code
|
|
751
|
+
* @param {string} [authorization] Bearer Token
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
async getDashboardMetadata(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardMetadataResponseClass>> {
|
|
756
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDashboardMetadata(code, authorization, options);
|
|
757
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
758
|
+
},
|
|
700
759
|
/**
|
|
701
760
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
702
761
|
* @summary Retrieves a list of dashboards
|
|
@@ -841,6 +900,17 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
841
900
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass> {
|
|
842
901
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
843
902
|
},
|
|
903
|
+
/**
|
|
904
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
905
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
906
|
+
* @param {string} code
|
|
907
|
+
* @param {string} [authorization] Bearer Token
|
|
908
|
+
* @param {*} [options] Override http request option.
|
|
909
|
+
* @throws {RequiredError}
|
|
910
|
+
*/
|
|
911
|
+
getDashboardMetadata(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardMetadataResponseClass> {
|
|
912
|
+
return localVarFp.getDashboardMetadata(code, authorization, options).then((request) => request(axios, basePath));
|
|
913
|
+
},
|
|
844
914
|
/**
|
|
845
915
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
846
916
|
* @summary Retrieves a list of dashboards
|
|
@@ -1049,6 +1119,27 @@ export interface DashboardApiGetDashboardEmbeddedUrlRequest {
|
|
|
1049
1119
|
readonly authorization?: string
|
|
1050
1120
|
}
|
|
1051
1121
|
|
|
1122
|
+
/**
|
|
1123
|
+
* Request parameters for getDashboardMetadata operation in DashboardApi.
|
|
1124
|
+
* @export
|
|
1125
|
+
* @interface DashboardApiGetDashboardMetadataRequest
|
|
1126
|
+
*/
|
|
1127
|
+
export interface DashboardApiGetDashboardMetadataRequest {
|
|
1128
|
+
/**
|
|
1129
|
+
*
|
|
1130
|
+
* @type {string}
|
|
1131
|
+
* @memberof DashboardApiGetDashboardMetadata
|
|
1132
|
+
*/
|
|
1133
|
+
readonly code: string
|
|
1134
|
+
|
|
1135
|
+
/**
|
|
1136
|
+
* Bearer Token
|
|
1137
|
+
* @type {string}
|
|
1138
|
+
* @memberof DashboardApiGetDashboardMetadata
|
|
1139
|
+
*/
|
|
1140
|
+
readonly authorization?: string
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1052
1143
|
/**
|
|
1053
1144
|
* Request parameters for listDashboards operation in DashboardApi.
|
|
1054
1145
|
* @export
|
|
@@ -1274,6 +1365,18 @@ export class DashboardApi extends BaseAPI {
|
|
|
1274
1365
|
return DashboardApiFp(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1275
1366
|
}
|
|
1276
1367
|
|
|
1368
|
+
/**
|
|
1369
|
+
* Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
|
|
1370
|
+
* @summary Retrieves QuickSight analysis metadata for a dashboard
|
|
1371
|
+
* @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
|
|
1372
|
+
* @param {*} [options] Override http request option.
|
|
1373
|
+
* @throws {RequiredError}
|
|
1374
|
+
* @memberof DashboardApi
|
|
1375
|
+
*/
|
|
1376
|
+
public getDashboardMetadata(requestParameters: DashboardApiGetDashboardMetadataRequest, options?: AxiosRequestConfig) {
|
|
1377
|
+
return DashboardApiFp(this.configuration).getDashboardMetadata(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1378
|
+
}
|
|
1379
|
+
|
|
1277
1380
|
/**
|
|
1278
1381
|
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1279
1382
|
* @summary Retrieves a list of dashboards
|