@emilgroup/tenant-sdk-node 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +2 -2
  3. package/api/data-report-api.ts +677 -0
  4. package/api/data-report-executor-api.ts +165 -0
  5. package/api/roles-api.ts +46 -28
  6. package/api/settings-api.ts +8 -4
  7. package/api.ts +4 -0
  8. package/dist/api/data-report-api.d.ts +380 -0
  9. package/dist/api/data-report-api.js +636 -0
  10. package/dist/api/data-report-executor-api.d.ts +93 -0
  11. package/dist/api/data-report-executor-api.js +224 -0
  12. package/dist/api/roles-api.d.ts +38 -25
  13. package/dist/api/roles-api.js +29 -19
  14. package/dist/api/settings-api.d.ts +8 -4
  15. package/dist/api/settings-api.js +8 -4
  16. package/dist/api.d.ts +2 -0
  17. package/dist/api.js +2 -0
  18. package/dist/models/create-data-report-request-dto.d.ts +61 -0
  19. package/dist/models/create-data-report-request-dto.js +15 -0
  20. package/dist/models/create-data-report-response-class.d.ts +25 -0
  21. package/dist/models/create-data-report-response-class.js +15 -0
  22. package/dist/models/data-report-class.d.ts +79 -0
  23. package/dist/models/data-report-class.js +15 -0
  24. package/dist/models/data-report-filter-class.d.ts +72 -0
  25. package/dist/models/data-report-filter-class.js +15 -0
  26. package/dist/models/data-report-filter-dto.d.ts +48 -0
  27. package/dist/models/data-report-filter-dto.js +15 -0
  28. package/dist/models/data-report-filter-single-value-dto.d.ts +42 -0
  29. package/dist/models/data-report-filter-single-value-dto.js +15 -0
  30. package/dist/models/data-report-filter-value-dto.d.ts +31 -0
  31. package/dist/models/data-report-filter-value-dto.js +15 -0
  32. package/dist/models/get-data-report-response-class.d.ts +25 -0
  33. package/dist/models/get-data-report-response-class.js +15 -0
  34. package/dist/models/index.d.ts +13 -0
  35. package/dist/models/index.js +13 -0
  36. package/dist/models/list-data-reports-response-class.d.ts +31 -0
  37. package/dist/models/list-data-reports-response-class.js +15 -0
  38. package/dist/models/run-data-report-request-dto.d.ts +31 -0
  39. package/dist/models/run-data-report-request-dto.js +15 -0
  40. package/dist/models/run-data-report-response-class.d.ts +24 -0
  41. package/dist/models/run-data-report-response-class.js +15 -0
  42. package/dist/models/update-data-report-request-dto.d.ts +61 -0
  43. package/dist/models/update-data-report-request-dto.js +15 -0
  44. package/dist/models/update-data-report-response-class.d.ts +25 -0
  45. package/dist/models/update-data-report-response-class.js +15 -0
  46. package/models/create-data-report-request-dto.ts +67 -0
  47. package/models/create-data-report-response-class.ts +31 -0
  48. package/models/data-report-class.ts +85 -0
  49. package/models/data-report-filter-class.ts +78 -0
  50. package/models/data-report-filter-dto.ts +54 -0
  51. package/models/data-report-filter-single-value-dto.ts +48 -0
  52. package/models/data-report-filter-value-dto.ts +37 -0
  53. package/models/get-data-report-response-class.ts +31 -0
  54. package/models/index.ts +13 -0
  55. package/models/list-data-reports-response-class.ts +37 -0
  56. package/models/run-data-report-request-dto.ts +37 -0
  57. package/models/run-data-report-response-class.ts +30 -0
  58. package/models/update-data-report-request-dto.ts +67 -0
  59. package/models/update-data-report-response-class.ts +31 -0
  60. package/package.json +1 -1
@@ -0,0 +1,93 @@
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 { RunDataReportRequestDto } from '../models';
16
+ import { RunDataReportResponseClass } from '../models';
17
+ /**
18
+ * DataReportExecutorApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const DataReportExecutorApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
25
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ runDataReport: (runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
+ };
31
+ /**
32
+ * DataReportExecutorApi - functional programming interface
33
+ * @export
34
+ */
35
+ export declare const DataReportExecutorApiFp: (configuration?: Configuration) => {
36
+ /**
37
+ *
38
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunDataReportResponseClass>>;
44
+ };
45
+ /**
46
+ * DataReportExecutorApi - factory interface
47
+ * @export
48
+ */
49
+ export declare const DataReportExecutorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50
+ /**
51
+ *
52
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
53
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<RunDataReportResponseClass>;
58
+ };
59
+ /**
60
+ * Request parameters for runDataReport operation in DataReportExecutorApi.
61
+ * @export
62
+ * @interface DataReportExecutorApiRunDataReportRequest
63
+ */
64
+ export interface DataReportExecutorApiRunDataReportRequest {
65
+ /**
66
+ *
67
+ * @type {RunDataReportRequestDto}
68
+ * @memberof DataReportExecutorApiRunDataReport
69
+ */
70
+ readonly runDataReportRequestDto: RunDataReportRequestDto;
71
+ /**
72
+ * Bearer Token: provided by the login endpoint under the name accessToken.
73
+ * @type {string}
74
+ * @memberof DataReportExecutorApiRunDataReport
75
+ */
76
+ readonly authorization?: string;
77
+ }
78
+ /**
79
+ * DataReportExecutorApi - object-oriented interface
80
+ * @export
81
+ * @class DataReportExecutorApi
82
+ * @extends {BaseAPI}
83
+ */
84
+ export declare class DataReportExecutorApi extends BaseAPI {
85
+ /**
86
+ *
87
+ * @param {DataReportExecutorApiRunDataReportRequest} requestParameters Request parameters.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ * @memberof DataReportExecutorApi
91
+ */
92
+ runDataReport(requestParameters: DataReportExecutorApiRunDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunDataReportResponseClass, any>>;
93
+ }
@@ -0,0 +1,224 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL Tenant Service
6
+ * The EMIL TenantService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.DataReportExecutorApi = exports.DataReportExecutorApiFactory = exports.DataReportExecutorApiFp = exports.DataReportExecutorApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ // URLSearchParams not necessarily used
89
+ // @ts-ignore
90
+ var url_1 = require("url");
91
+ var FormData = require('form-data');
92
+ /**
93
+ * DataReportExecutorApi - axios parameter creator
94
+ * @export
95
+ */
96
+ var DataReportExecutorApiAxiosParamCreator = function (configuration) {
97
+ var _this = this;
98
+ return {
99
+ /**
100
+ *
101
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
102
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ runDataReport: function (runDataReportRequestDto, authorization, options) {
107
+ if (options === void 0) { options = {}; }
108
+ return __awaiter(_this, void 0, void 0, function () {
109
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
110
+ return __generator(this, function (_a) {
111
+ switch (_a.label) {
112
+ case 0:
113
+ // verify required parameter 'runDataReportRequestDto' is not null or undefined
114
+ (0, common_1.assertParamExists)('runDataReport', 'runDataReportRequestDto', runDataReportRequestDto);
115
+ localVarPath = "/tenantservice/v1/data-report-executor";
116
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
117
+ if (configuration) {
118
+ baseOptions = configuration.baseOptions;
119
+ baseAccessToken = configuration.accessToken;
120
+ }
121
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
122
+ localVarHeaderParameter = {};
123
+ localVarQueryParameter = {};
124
+ // authentication bearer required
125
+ // http bearer authentication required
126
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
127
+ case 1:
128
+ // authentication bearer required
129
+ // http bearer authentication required
130
+ _a.sent();
131
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
132
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
133
+ }
134
+ localVarHeaderParameter['Content-Type'] = 'application/json';
135
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
136
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
138
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(runDataReportRequestDto, localVarRequestOptions, configuration);
139
+ return [2 /*return*/, {
140
+ url: (0, common_1.toPathString)(localVarUrlObj),
141
+ options: localVarRequestOptions,
142
+ }];
143
+ }
144
+ });
145
+ });
146
+ },
147
+ };
148
+ };
149
+ exports.DataReportExecutorApiAxiosParamCreator = DataReportExecutorApiAxiosParamCreator;
150
+ /**
151
+ * DataReportExecutorApi - functional programming interface
152
+ * @export
153
+ */
154
+ var DataReportExecutorApiFp = function (configuration) {
155
+ var localVarAxiosParamCreator = (0, exports.DataReportExecutorApiAxiosParamCreator)(configuration);
156
+ return {
157
+ /**
158
+ *
159
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
160
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ runDataReport: function (runDataReportRequestDto, authorization, options) {
165
+ return __awaiter(this, void 0, void 0, function () {
166
+ var localVarAxiosArgs;
167
+ return __generator(this, function (_a) {
168
+ switch (_a.label) {
169
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.runDataReport(runDataReportRequestDto, authorization, options)];
170
+ case 1:
171
+ localVarAxiosArgs = _a.sent();
172
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
173
+ }
174
+ });
175
+ });
176
+ },
177
+ };
178
+ };
179
+ exports.DataReportExecutorApiFp = DataReportExecutorApiFp;
180
+ /**
181
+ * DataReportExecutorApi - factory interface
182
+ * @export
183
+ */
184
+ var DataReportExecutorApiFactory = function (configuration, basePath, axios) {
185
+ var localVarFp = (0, exports.DataReportExecutorApiFp)(configuration);
186
+ return {
187
+ /**
188
+ *
189
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
190
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ runDataReport: function (runDataReportRequestDto, authorization, options) {
195
+ return localVarFp.runDataReport(runDataReportRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
196
+ },
197
+ };
198
+ };
199
+ exports.DataReportExecutorApiFactory = DataReportExecutorApiFactory;
200
+ /**
201
+ * DataReportExecutorApi - object-oriented interface
202
+ * @export
203
+ * @class DataReportExecutorApi
204
+ * @extends {BaseAPI}
205
+ */
206
+ var DataReportExecutorApi = /** @class */ (function (_super) {
207
+ __extends(DataReportExecutorApi, _super);
208
+ function DataReportExecutorApi() {
209
+ return _super !== null && _super.apply(this, arguments) || this;
210
+ }
211
+ /**
212
+ *
213
+ * @param {DataReportExecutorApiRunDataReportRequest} requestParameters Request parameters.
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ * @memberof DataReportExecutorApi
217
+ */
218
+ DataReportExecutorApi.prototype.runDataReport = function (requestParameters, options) {
219
+ var _this = this;
220
+ return (0, exports.DataReportExecutorApiFp)(this.configuration).runDataReport(requestParameters.runDataReportRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
221
+ };
222
+ return DataReportExecutorApi;
223
+ }(base_1.BaseAPI));
224
+ exports.DataReportExecutorApi = DataReportExecutorApi;
@@ -19,17 +19,19 @@ import { ListRolesResponseClass } from '../models';
19
19
  */
20
20
  export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
22
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
23
+ * @summary List roles
24
+ * @param {string} [authorization] Bearer Token
23
25
  * @param {number} [pageSize] Page size
24
26
  * @param {string} [pageToken] Page token
25
- * @param {string} [filter] List filter
27
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
26
28
  * @param {string} [search] Search query
27
- * @param {string} [order] Ordering criteria
28
- * @param {string} [expand] Extra fields to fetch
29
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
30
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
29
31
  * @param {*} [options] Override http request option.
30
32
  * @throws {RequiredError}
31
33
  */
32
- listRoles: (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
35
  };
34
36
  /**
35
37
  * RolesApi - functional programming interface
@@ -37,17 +39,19 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
37
39
  */
38
40
  export declare const RolesApiFp: (configuration?: Configuration) => {
39
41
  /**
40
- *
42
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
43
+ * @summary List roles
44
+ * @param {string} [authorization] Bearer Token
41
45
  * @param {number} [pageSize] Page size
42
46
  * @param {string} [pageToken] Page token
43
- * @param {string} [filter] List filter
47
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
44
48
  * @param {string} [search] Search query
45
- * @param {string} [order] Ordering criteria
46
- * @param {string} [expand] Extra fields to fetch
49
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
50
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
47
51
  * @param {*} [options] Override http request option.
48
52
  * @throws {RequiredError}
49
53
  */
50
- listRoles(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>>;
54
+ listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>>;
51
55
  };
52
56
  /**
53
57
  * RolesApi - factory interface
@@ -55,17 +59,19 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
55
59
  */
56
60
  export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
57
61
  /**
58
- *
62
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
63
+ * @summary List roles
64
+ * @param {string} [authorization] Bearer Token
59
65
  * @param {number} [pageSize] Page size
60
66
  * @param {string} [pageToken] Page token
61
- * @param {string} [filter] List filter
67
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
62
68
  * @param {string} [search] Search query
63
- * @param {string} [order] Ordering criteria
64
- * @param {string} [expand] Extra fields to fetch
69
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
70
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
65
71
  * @param {*} [options] Override http request option.
66
72
  * @throws {RequiredError}
67
73
  */
68
- listRoles(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRolesResponseClass>;
74
+ listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: any): AxiosPromise<ListRolesResponseClass>;
69
75
  };
70
76
  /**
71
77
  * Request parameters for listRoles operation in RolesApi.
@@ -73,6 +79,12 @@ export declare const RolesApiFactory: (configuration?: Configuration, basePath?:
73
79
  * @interface RolesApiListRolesRequest
74
80
  */
75
81
  export interface RolesApiListRolesRequest {
82
+ /**
83
+ * Bearer Token
84
+ * @type {string}
85
+ * @memberof RolesApiListRoles
86
+ */
87
+ readonly authorization?: string;
76
88
  /**
77
89
  * Page size
78
90
  * @type {number}
@@ -86,11 +98,11 @@ export interface RolesApiListRolesRequest {
86
98
  */
87
99
  readonly pageToken?: string;
88
100
  /**
89
- * List filter
90
- * @type {string}
101
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
102
+ * @type {'id' | 'code' | 'label'}
91
103
  * @memberof RolesApiListRoles
92
104
  */
93
- readonly filter?: string;
105
+ readonly filter?: 'id' | 'code' | 'label';
94
106
  /**
95
107
  * Search query
96
108
  * @type {string}
@@ -98,17 +110,17 @@ export interface RolesApiListRolesRequest {
98
110
  */
99
111
  readonly search?: string;
100
112
  /**
101
- * Ordering criteria
102
- * @type {string}
113
+ * Order allowing you to specify the desired order of entities retrieved from the server.
114
+ * @type {'label'}
103
115
  * @memberof RolesApiListRoles
104
116
  */
105
- readonly order?: string;
117
+ readonly order?: 'label';
106
118
  /**
107
- * Extra fields to fetch
108
- * @type {string}
119
+ * You can expand roles in this endpoint. By default, permissions will be an empty array.
120
+ * @type {'permissions'}
109
121
  * @memberof RolesApiListRoles
110
122
  */
111
- readonly expand?: string;
123
+ readonly expand?: 'permissions';
112
124
  }
113
125
  /**
114
126
  * RolesApi - object-oriented interface
@@ -118,7 +130,8 @@ export interface RolesApiListRolesRequest {
118
130
  */
119
131
  export declare class RolesApi extends BaseAPI {
120
132
  /**
121
- *
133
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
134
+ * @summary List roles
122
135
  * @param {RolesApiListRolesRequest} requestParameters Request parameters.
123
136
  * @param {*} [options] Override http request option.
124
137
  * @throws {RequiredError}
@@ -97,17 +97,19 @@ var RolesApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
101
+ * @summary List roles
102
+ * @param {string} [authorization] Bearer Token
101
103
  * @param {number} [pageSize] Page size
102
104
  * @param {string} [pageToken] Page token
103
- * @param {string} [filter] List filter
105
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
104
106
  * @param {string} [search] Search query
105
- * @param {string} [order] Ordering criteria
106
- * @param {string} [expand] Extra fields to fetch
107
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
108
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
107
109
  * @param {*} [options] Override http request option.
108
110
  * @throws {RequiredError}
109
111
  */
110
- listRoles: function (pageSize, pageToken, filter, search, order, expand, options) {
112
+ listRoles: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
111
113
  if (options === void 0) { options = {}; }
112
114
  return __awaiter(_this, void 0, void 0, function () {
113
115
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -148,6 +150,9 @@ var RolesApiAxiosParamCreator = function (configuration) {
148
150
  if (expand !== undefined) {
149
151
  localVarQueryParameter['expand'] = expand;
150
152
  }
153
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
154
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
155
+ }
151
156
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
152
157
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
153
158
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -170,22 +175,24 @@ var RolesApiFp = function (configuration) {
170
175
  var localVarAxiosParamCreator = (0, exports.RolesApiAxiosParamCreator)(configuration);
171
176
  return {
172
177
  /**
173
- *
178
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
179
+ * @summary List roles
180
+ * @param {string} [authorization] Bearer Token
174
181
  * @param {number} [pageSize] Page size
175
182
  * @param {string} [pageToken] Page token
176
- * @param {string} [filter] List filter
183
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
177
184
  * @param {string} [search] Search query
178
- * @param {string} [order] Ordering criteria
179
- * @param {string} [expand] Extra fields to fetch
185
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
186
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
180
187
  * @param {*} [options] Override http request option.
181
188
  * @throws {RequiredError}
182
189
  */
183
- listRoles: function (pageSize, pageToken, filter, search, order, expand, options) {
190
+ listRoles: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
184
191
  return __awaiter(this, void 0, void 0, function () {
185
192
  var localVarAxiosArgs;
186
193
  return __generator(this, function (_a) {
187
194
  switch (_a.label) {
188
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRoles(pageSize, pageToken, filter, search, order, expand, options)];
195
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options)];
189
196
  case 1:
190
197
  localVarAxiosArgs = _a.sent();
191
198
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -204,18 +211,20 @@ var RolesApiFactory = function (configuration, basePath, axios) {
204
211
  var localVarFp = (0, exports.RolesApiFp)(configuration);
205
212
  return {
206
213
  /**
207
- *
214
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
215
+ * @summary List roles
216
+ * @param {string} [authorization] Bearer Token
208
217
  * @param {number} [pageSize] Page size
209
218
  * @param {string} [pageToken] Page token
210
- * @param {string} [filter] List filter
219
+ * @param {'id' | 'code' | 'label'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
211
220
  * @param {string} [search] Search query
212
- * @param {string} [order] Ordering criteria
213
- * @param {string} [expand] Extra fields to fetch
221
+ * @param {'label'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
222
+ * @param {'permissions'} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
214
223
  * @param {*} [options] Override http request option.
215
224
  * @throws {RequiredError}
216
225
  */
217
- listRoles: function (pageSize, pageToken, filter, search, order, expand, options) {
218
- return localVarFp.listRoles(pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
226
+ listRoles: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
227
+ return localVarFp.listRoles(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
219
228
  },
220
229
  };
221
230
  };
@@ -232,7 +241,8 @@ var RolesApi = /** @class */ (function (_super) {
232
241
  return _super !== null && _super.apply(this, arguments) || this;
233
242
  }
234
243
  /**
235
- *
244
+ * Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
245
+ * @summary List roles
236
246
  * @param {RolesApiListRolesRequest} requestParameters Request parameters.
237
247
  * @param {*} [options] Override http request option.
238
248
  * @throws {RequiredError}
@@ -241,7 +251,7 @@ var RolesApi = /** @class */ (function (_super) {
241
251
  RolesApi.prototype.listRoles = function (requestParameters, options) {
242
252
  var _this = this;
243
253
  if (requestParameters === void 0) { requestParameters = {}; }
244
- return (0, exports.RolesApiFp)(this.configuration).listRoles(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
254
+ return (0, exports.RolesApiFp)(this.configuration).listRoles(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
245
255
  };
246
256
  return RolesApi;
247
257
  }(base_1.BaseAPI));
@@ -19,7 +19,8 @@ import { GetSettingsResponseClass } from '../models';
19
19
  */
20
20
  export declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
22
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
23
+ * @summary Retrieve the settings
23
24
  * @param {string} keys
24
25
  * @param {string} [authorization] Bearer Token
25
26
  * @param {*} [options] Override http request option.
@@ -33,7 +34,8 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
33
34
  */
34
35
  export declare const SettingsApiFp: (configuration?: Configuration) => {
35
36
  /**
36
- *
37
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
38
+ * @summary Retrieve the settings
37
39
  * @param {string} keys
38
40
  * @param {string} [authorization] Bearer Token
39
41
  * @param {*} [options] Override http request option.
@@ -47,7 +49,8 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
47
49
  */
48
50
  export declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
49
51
  /**
50
- *
52
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
53
+ * @summary Retrieve the settings
51
54
  * @param {string} keys
52
55
  * @param {string} [authorization] Bearer Token
53
56
  * @param {*} [options] Override http request option.
@@ -82,7 +85,8 @@ export interface SettingsApiGetTenantSettingsRequest {
82
85
  */
83
86
  export declare class SettingsApi extends BaseAPI {
84
87
  /**
85
- *
88
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
89
+ * @summary Retrieve the settings
86
90
  * @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
87
91
  * @param {*} [options] Override http request option.
88
92
  * @throws {RequiredError}
@@ -97,7 +97,8 @@ var SettingsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
101
+ * @summary Retrieve the settings
101
102
  * @param {string} keys
102
103
  * @param {string} [authorization] Bearer Token
103
104
  * @param {*} [options] Override http request option.
@@ -156,7 +157,8 @@ var SettingsApiFp = function (configuration) {
156
157
  var localVarAxiosParamCreator = (0, exports.SettingsApiAxiosParamCreator)(configuration);
157
158
  return {
158
159
  /**
159
- *
160
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
161
+ * @summary Retrieve the settings
160
162
  * @param {string} keys
161
163
  * @param {string} [authorization] Bearer Token
162
164
  * @param {*} [options] Override http request option.
@@ -186,7 +188,8 @@ var SettingsApiFactory = function (configuration, basePath, axios) {
186
188
  var localVarFp = (0, exports.SettingsApiFp)(configuration);
187
189
  return {
188
190
  /**
189
- *
191
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
192
+ * @summary Retrieve the settings
190
193
  * @param {string} keys
191
194
  * @param {string} [authorization] Bearer Token
192
195
  * @param {*} [options] Override http request option.
@@ -210,7 +213,8 @@ var SettingsApi = /** @class */ (function (_super) {
210
213
  return _super !== null && _super.apply(this, arguments) || this;
211
214
  }
212
215
  /**
213
- *
216
+ * Retrieves the details of the settings that was previously created. Supply the unique settings code that was returned when you created it and Emil Api will return the corresponding settings information.
217
+ * @summary Retrieve the settings
214
218
  * @param {SettingsApiGetTenantSettingsRequest} requestParameters Request parameters.
215
219
  * @param {*} [options] Override http request option.
216
220
  * @throws {RequiredError}
package/dist/api.d.ts CHANGED
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  export * from './api/custom-schema-api';
13
+ export * from './api/data-report-api';
14
+ export * from './api/data-report-executor-api';
13
15
  export * from './api/invite-organizations-api';
14
16
  export * from './api/invite-users-api';
15
17
  export * from './api/list-organization-invitations-api';