@emilgroup/tenant-sdk 1.3.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 (63) hide show
  1. package/.openapi-generator/FILES +18 -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 +236 -0
  6. package/api/settings-api.ts +168 -0
  7. package/api.ts +8 -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 +141 -0
  13. package/dist/api/roles-api.js +258 -0
  14. package/dist/api/settings-api.d.ts +96 -0
  15. package/dist/api/settings-api.js +229 -0
  16. package/dist/api.d.ts +4 -0
  17. package/dist/api.js +4 -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 +14 -0
  35. package/dist/models/index.js +14 -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/list-roles-response-class.d.ts +31 -0
  39. package/dist/models/list-roles-response-class.js +15 -0
  40. package/dist/models/run-data-report-request-dto.d.ts +31 -0
  41. package/dist/models/run-data-report-request-dto.js +15 -0
  42. package/dist/models/run-data-report-response-class.d.ts +24 -0
  43. package/dist/models/run-data-report-response-class.js +15 -0
  44. package/dist/models/update-data-report-request-dto.d.ts +61 -0
  45. package/dist/models/update-data-report-request-dto.js +15 -0
  46. package/dist/models/update-data-report-response-class.d.ts +25 -0
  47. package/dist/models/update-data-report-response-class.js +15 -0
  48. package/models/create-data-report-request-dto.ts +67 -0
  49. package/models/create-data-report-response-class.ts +31 -0
  50. package/models/data-report-class.ts +85 -0
  51. package/models/data-report-filter-class.ts +78 -0
  52. package/models/data-report-filter-dto.ts +54 -0
  53. package/models/data-report-filter-single-value-dto.ts +48 -0
  54. package/models/data-report-filter-value-dto.ts +37 -0
  55. package/models/get-data-report-response-class.ts +31 -0
  56. package/models/index.ts +14 -0
  57. package/models/list-data-reports-response-class.ts +37 -0
  58. package/models/list-roles-response-class.ts +37 -0
  59. package/models/run-data-report-request-dto.ts +37 -0
  60. package/models/run-data-report-response-class.ts +30 -0
  61. package/models/update-data-report-request-dto.ts +67 -0
  62. package/models/update-data-report-response-class.ts +31 -0
  63. 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;
@@ -0,0 +1,141 @@
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 { ListRolesResponseClass } from '../models';
16
+ /**
17
+ * RolesApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
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
25
+ * @param {number} [pageSize] Page size
26
+ * @param {string} [pageToken] Page token
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.
28
+ * @param {string} [search] Search query
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.
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ };
36
+ /**
37
+ * RolesApi - functional programming interface
38
+ * @export
39
+ */
40
+ export declare const RolesApiFp: (configuration?: Configuration) => {
41
+ /**
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
45
+ * @param {number} [pageSize] Page size
46
+ * @param {string} [pageToken] Page token
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.
48
+ * @param {string} [search] Search query
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.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
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>>;
55
+ };
56
+ /**
57
+ * RolesApi - factory interface
58
+ * @export
59
+ */
60
+ export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61
+ /**
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
65
+ * @param {number} [pageSize] Page size
66
+ * @param {string} [pageToken] Page token
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.
68
+ * @param {string} [search] Search query
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.
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'label', search?: string, order?: 'label', expand?: 'permissions', options?: any): AxiosPromise<ListRolesResponseClass>;
75
+ };
76
+ /**
77
+ * Request parameters for listRoles operation in RolesApi.
78
+ * @export
79
+ * @interface RolesApiListRolesRequest
80
+ */
81
+ export interface RolesApiListRolesRequest {
82
+ /**
83
+ * Bearer Token
84
+ * @type {string}
85
+ * @memberof RolesApiListRoles
86
+ */
87
+ readonly authorization?: string;
88
+ /**
89
+ * Page size
90
+ * @type {number}
91
+ * @memberof RolesApiListRoles
92
+ */
93
+ readonly pageSize?: number;
94
+ /**
95
+ * Page token
96
+ * @type {string}
97
+ * @memberof RolesApiListRoles
98
+ */
99
+ readonly pageToken?: string;
100
+ /**
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'}
103
+ * @memberof RolesApiListRoles
104
+ */
105
+ readonly filter?: 'id' | 'code' | 'label';
106
+ /**
107
+ * Search query
108
+ * @type {string}
109
+ * @memberof RolesApiListRoles
110
+ */
111
+ readonly search?: string;
112
+ /**
113
+ * Order allowing you to specify the desired order of entities retrieved from the server.
114
+ * @type {'label'}
115
+ * @memberof RolesApiListRoles
116
+ */
117
+ readonly order?: 'label';
118
+ /**
119
+ * You can expand roles in this endpoint. By default, permissions will be an empty array.
120
+ * @type {'permissions'}
121
+ * @memberof RolesApiListRoles
122
+ */
123
+ readonly expand?: 'permissions';
124
+ }
125
+ /**
126
+ * RolesApi - object-oriented interface
127
+ * @export
128
+ * @class RolesApi
129
+ * @extends {BaseAPI}
130
+ */
131
+ export declare class RolesApi extends BaseAPI {
132
+ /**
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
135
+ * @param {RolesApiListRolesRequest} requestParameters Request parameters.
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ * @memberof RolesApi
139
+ */
140
+ listRoles(requestParameters?: RolesApiListRolesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesResponseClass, any>>;
141
+ }