@emilgroup/tenant-sdk 1.36.1-beta.21 → 1.36.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.
Files changed (105) hide show
  1. package/.openapi-generator/FILES +0 -30
  2. package/README.md +2 -2
  3. package/api/dashboard-api.ts +0 -103
  4. package/api.ts +0 -6
  5. package/base.ts +0 -1
  6. package/dist/api/dashboard-api.d.ts +0 -56
  7. package/dist/api/dashboard-api.js +0 -92
  8. package/dist/api.d.ts +0 -3
  9. package/dist/api.js +0 -3
  10. package/dist/base.d.ts +1 -2
  11. package/dist/base.js +0 -1
  12. package/dist/models/index.d.ts +0 -27
  13. package/dist/models/index.js +0 -27
  14. package/models/index.ts +0 -27
  15. package/package.json +2 -2
  16. package/api/report-schedule-api.ts +0 -693
  17. package/api/report-schedule-logs-api.ts +0 -246
  18. package/api/user-group-api.ts +0 -1086
  19. package/dist/api/report-schedule-api.d.ts +0 -394
  20. package/dist/api/report-schedule-api.js +0 -642
  21. package/dist/api/report-schedule-logs-api.d.ts +0 -150
  22. package/dist/api/report-schedule-logs-api.js +0 -260
  23. package/dist/api/user-group-api.d.ts +0 -603
  24. package/dist/api/user-group-api.js +0 -936
  25. package/dist/models/add-users-to-group-request-dto.d.ts +0 -24
  26. package/dist/models/add-users-to-group-request-dto.js +0 -15
  27. package/dist/models/add-users-to-group-response-class.d.ts +0 -25
  28. package/dist/models/add-users-to-group-response-class.js +0 -15
  29. package/dist/models/create-report-schedule-request-dto.d.ts +0 -115
  30. package/dist/models/create-report-schedule-request-dto.js +0 -15
  31. package/dist/models/create-report-schedule-response-class.d.ts +0 -25
  32. package/dist/models/create-report-schedule-response-class.js +0 -15
  33. package/dist/models/create-user-group-request-dto.d.ts +0 -36
  34. package/dist/models/create-user-group-request-dto.js +0 -15
  35. package/dist/models/create-user-group-response-class.d.ts +0 -25
  36. package/dist/models/create-user-group-response-class.js +0 -15
  37. package/dist/models/dashboard-metadata-class.d.ts +0 -43
  38. package/dist/models/dashboard-metadata-class.js +0 -15
  39. package/dist/models/get-dashboard-metadata-response-class.d.ts +0 -25
  40. package/dist/models/get-dashboard-metadata-response-class.js +0 -15
  41. package/dist/models/get-report-schedule-response-class.d.ts +0 -25
  42. package/dist/models/get-report-schedule-response-class.js +0 -15
  43. package/dist/models/get-user-group-response-class.d.ts +0 -25
  44. package/dist/models/get-user-group-response-class.js +0 -15
  45. package/dist/models/list-report-schedule-logs-response-class.d.ts +0 -43
  46. package/dist/models/list-report-schedule-logs-response-class.js +0 -15
  47. package/dist/models/list-report-schedules-response-class.d.ts +0 -43
  48. package/dist/models/list-report-schedules-response-class.js +0 -15
  49. package/dist/models/list-user-group-members-response-class.d.ts +0 -43
  50. package/dist/models/list-user-group-members-response-class.js +0 -15
  51. package/dist/models/list-user-groups-response-class.d.ts +0 -43
  52. package/dist/models/list-user-groups-response-class.js +0 -15
  53. package/dist/models/quick-sight-analysis-parameter-class.d.ts +0 -36
  54. package/dist/models/quick-sight-analysis-parameter-class.js +0 -15
  55. package/dist/models/remove-users-from-group-request-dto.d.ts +0 -24
  56. package/dist/models/remove-users-from-group-request-dto.js +0 -15
  57. package/dist/models/report-schedule-class.d.ts +0 -157
  58. package/dist/models/report-schedule-class.js +0 -15
  59. package/dist/models/report-schedule-log-class.d.ts +0 -133
  60. package/dist/models/report-schedule-log-class.js +0 -15
  61. package/dist/models/report-schedule-parameter-class.d.ts +0 -42
  62. package/dist/models/report-schedule-parameter-class.js +0 -15
  63. package/dist/models/report-schedule-parameter-dto.d.ts +0 -42
  64. package/dist/models/report-schedule-parameter-dto.js +0 -15
  65. package/dist/models/report-schedule-parameter-value-class.d.ts +0 -30
  66. package/dist/models/report-schedule-parameter-value-class.js +0 -15
  67. package/dist/models/update-report-schedule-request-dto.d.ts +0 -121
  68. package/dist/models/update-report-schedule-request-dto.js +0 -15
  69. package/dist/models/update-report-schedule-response-class.d.ts +0 -25
  70. package/dist/models/update-report-schedule-response-class.js +0 -15
  71. package/dist/models/update-user-group-request-dto.d.ts +0 -36
  72. package/dist/models/update-user-group-request-dto.js +0 -15
  73. package/dist/models/update-user-group-response-class.d.ts +0 -25
  74. package/dist/models/update-user-group-response-class.js +0 -15
  75. package/dist/models/user-group-class.d.ts +0 -72
  76. package/dist/models/user-group-class.js +0 -15
  77. package/dist/models/user-group-member-class.d.ts +0 -42
  78. package/dist/models/user-group-member-class.js +0 -15
  79. package/models/add-users-to-group-request-dto.ts +0 -30
  80. package/models/add-users-to-group-response-class.ts +0 -31
  81. package/models/create-report-schedule-request-dto.ts +0 -121
  82. package/models/create-report-schedule-response-class.ts +0 -31
  83. package/models/create-user-group-request-dto.ts +0 -42
  84. package/models/create-user-group-response-class.ts +0 -31
  85. package/models/dashboard-metadata-class.ts +0 -49
  86. package/models/get-dashboard-metadata-response-class.ts +0 -31
  87. package/models/get-report-schedule-response-class.ts +0 -31
  88. package/models/get-user-group-response-class.ts +0 -31
  89. package/models/list-report-schedule-logs-response-class.ts +0 -49
  90. package/models/list-report-schedules-response-class.ts +0 -49
  91. package/models/list-user-group-members-response-class.ts +0 -49
  92. package/models/list-user-groups-response-class.ts +0 -49
  93. package/models/quick-sight-analysis-parameter-class.ts +0 -42
  94. package/models/remove-users-from-group-request-dto.ts +0 -30
  95. package/models/report-schedule-class.ts +0 -163
  96. package/models/report-schedule-log-class.ts +0 -139
  97. package/models/report-schedule-parameter-class.ts +0 -48
  98. package/models/report-schedule-parameter-dto.ts +0 -48
  99. package/models/report-schedule-parameter-value-class.ts +0 -36
  100. package/models/update-report-schedule-request-dto.ts +0 -127
  101. package/models/update-report-schedule-response-class.ts +0 -31
  102. package/models/update-user-group-request-dto.ts +0 -42
  103. package/models/update-user-group-response-class.ts +0 -31
  104. package/models/user-group-class.ts +0 -78
  105. package/models/user-group-member-class.ts +0 -48
@@ -1,1086 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * EMIL Tenant Service
5
- * The EMIL TenantService API description
6
- *
7
- * The version of the OpenAPI document: 1.0
8
- * Contact: kontakt@emil.de
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
- import { Configuration } from '../configuration';
18
- // Some imports not used depending on template conditions
19
- // @ts-ignore
20
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
- // @ts-ignore
22
- import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
- // @ts-ignore
24
- import { AddUsersToGroupRequestDto } from '../models';
25
- // @ts-ignore
26
- import { AddUsersToGroupResponseClass } from '../models';
27
- // @ts-ignore
28
- import { CreateUserGroupRequestDto } from '../models';
29
- // @ts-ignore
30
- import { CreateUserGroupResponseClass } from '../models';
31
- // @ts-ignore
32
- import { DeleteResponseClass } from '../models';
33
- // @ts-ignore
34
- import { GetUserGroupResponseClass } from '../models';
35
- // @ts-ignore
36
- import { ListUserGroupMembersResponseClass } from '../models';
37
- // @ts-ignore
38
- import { ListUserGroupsResponseClass } from '../models';
39
- // @ts-ignore
40
- import { RemoveUsersFromGroupRequestDto } from '../models';
41
- // @ts-ignore
42
- import { UpdateUserGroupRequestDto } from '../models';
43
- // @ts-ignore
44
- import { UpdateUserGroupResponseClass } from '../models';
45
- /**
46
- * UserGroupApi - axios parameter creator
47
- * @export
48
- */
49
- export const UserGroupApiAxiosParamCreator = function (configuration?: Configuration) {
50
- return {
51
- /**
52
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
53
- * @param {string} code
54
- * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
55
- * @param {string} [authorization] Bearer Token
56
- * @param {*} [options] Override http request option.
57
- * @throws {RequiredError}
58
- */
59
- addUsersToGroup: async (code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
60
- // verify required parameter 'code' is not null or undefined
61
- assertParamExists('addUsersToGroup', 'code', code)
62
- // verify required parameter 'addUsersToGroupRequestDto' is not null or undefined
63
- assertParamExists('addUsersToGroup', 'addUsersToGroupRequestDto', addUsersToGroupRequestDto)
64
- const localVarPath = `/tenantservice/v1/user-groups/{code}/members`
65
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
66
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
67
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
68
- let baseOptions;
69
- let baseAccessToken;
70
- if (configuration) {
71
- baseOptions = configuration.baseOptions;
72
- baseAccessToken = configuration.accessToken;
73
- }
74
-
75
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
76
- const localVarHeaderParameter = {} as any;
77
- const localVarQueryParameter = {} as any;
78
-
79
- // authentication bearer required
80
- // http bearer authentication required
81
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
82
-
83
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
84
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
85
- }
86
-
87
-
88
-
89
- localVarHeaderParameter['Content-Type'] = 'application/json';
90
-
91
- setSearchParams(localVarUrlObj, localVarQueryParameter);
92
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
93
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
94
- localVarRequestOptions.data = serializeDataIfNeeded(addUsersToGroupRequestDto, localVarRequestOptions, configuration)
95
-
96
- return {
97
- url: toPathString(localVarUrlObj),
98
- options: localVarRequestOptions,
99
- };
100
- },
101
- /**
102
- * undefined **Required Permissions** \"identity-management.user-groups.create\"
103
- * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
104
- * @param {string} [authorization] Bearer Token
105
- * @param {*} [options] Override http request option.
106
- * @throws {RequiredError}
107
- */
108
- createUserGroup: async (createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
109
- // verify required parameter 'createUserGroupRequestDto' is not null or undefined
110
- assertParamExists('createUserGroup', 'createUserGroupRequestDto', createUserGroupRequestDto)
111
- const localVarPath = `/tenantservice/v1/user-groups`;
112
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
113
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
114
- let baseOptions;
115
- let baseAccessToken;
116
- if (configuration) {
117
- baseOptions = configuration.baseOptions;
118
- baseAccessToken = configuration.accessToken;
119
- }
120
-
121
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
122
- const localVarHeaderParameter = {} as any;
123
- const localVarQueryParameter = {} as any;
124
-
125
- // authentication bearer required
126
- // http bearer authentication required
127
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
128
-
129
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
130
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
131
- }
132
-
133
-
134
-
135
- localVarHeaderParameter['Content-Type'] = 'application/json';
136
-
137
- setSearchParams(localVarUrlObj, localVarQueryParameter);
138
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
139
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
140
- localVarRequestOptions.data = serializeDataIfNeeded(createUserGroupRequestDto, localVarRequestOptions, configuration)
141
-
142
- return {
143
- url: toPathString(localVarUrlObj),
144
- options: localVarRequestOptions,
145
- };
146
- },
147
- /**
148
- * undefined **Required Permissions** \"identity-management.user-groups.delete\"
149
- * @param {string} code
150
- * @param {string} [authorization] Bearer Token
151
- * @param {*} [options] Override http request option.
152
- * @throws {RequiredError}
153
- */
154
- deleteUserGroup: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
155
- // verify required parameter 'code' is not null or undefined
156
- assertParamExists('deleteUserGroup', 'code', code)
157
- const localVarPath = `/tenantservice/v1/user-groups/{code}`
158
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
159
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
160
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
161
- let baseOptions;
162
- let baseAccessToken;
163
- if (configuration) {
164
- baseOptions = configuration.baseOptions;
165
- baseAccessToken = configuration.accessToken;
166
- }
167
-
168
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
169
- const localVarHeaderParameter = {} as any;
170
- const localVarQueryParameter = {} as any;
171
-
172
- // authentication bearer required
173
- // http bearer authentication required
174
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
175
-
176
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
177
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
178
- }
179
-
180
-
181
-
182
- setSearchParams(localVarUrlObj, localVarQueryParameter);
183
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
184
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
185
-
186
- return {
187
- url: toPathString(localVarUrlObj),
188
- options: localVarRequestOptions,
189
- };
190
- },
191
- /**
192
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
193
- * @param {string} code
194
- * @param {string} [authorization] Bearer Token
195
- * @param {*} [options] Override http request option.
196
- * @throws {RequiredError}
197
- */
198
- getUserGroup: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
- // verify required parameter 'code' is not null or undefined
200
- assertParamExists('getUserGroup', 'code', code)
201
- const localVarPath = `/tenantservice/v1/user-groups/{code}`
202
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
203
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
204
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
205
- let baseOptions;
206
- let baseAccessToken;
207
- if (configuration) {
208
- baseOptions = configuration.baseOptions;
209
- baseAccessToken = configuration.accessToken;
210
- }
211
-
212
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
213
- const localVarHeaderParameter = {} as any;
214
- const localVarQueryParameter = {} as any;
215
-
216
- // authentication bearer required
217
- // http bearer authentication required
218
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
219
-
220
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
221
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
222
- }
223
-
224
-
225
-
226
- setSearchParams(localVarUrlObj, localVarQueryParameter);
227
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
228
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
229
-
230
- return {
231
- url: toPathString(localVarUrlObj),
232
- options: localVarRequestOptions,
233
- };
234
- },
235
- /**
236
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
237
- * @param {string} code
238
- * @param {string} [authorization] Bearer Token
239
- * @param {number} [pageSize] Number of items per page.
240
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
241
- * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
242
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
243
- * @param {string} [order] Sort the response by allowed columns (see paginate config).
244
- * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
245
- * @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.
246
- * @param {*} [options] Override http request option.
247
- * @throws {RequiredError}
248
- */
249
- listUserGroupMembers: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
250
- // verify required parameter 'code' is not null or undefined
251
- assertParamExists('listUserGroupMembers', 'code', code)
252
- const localVarPath = `/tenantservice/v1/user-groups/{code}/members`
253
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
254
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
255
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
256
- let baseOptions;
257
- let baseAccessToken;
258
- if (configuration) {
259
- baseOptions = configuration.baseOptions;
260
- baseAccessToken = configuration.accessToken;
261
- }
262
-
263
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
264
- const localVarHeaderParameter = {} as any;
265
- const localVarQueryParameter = {} as any;
266
-
267
- // authentication bearer required
268
- // http bearer authentication required
269
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
270
-
271
- if (pageSize !== undefined) {
272
- localVarQueryParameter['pageSize'] = pageSize;
273
- }
274
-
275
- if (pageToken !== undefined) {
276
- localVarQueryParameter['pageToken'] = pageToken;
277
- }
278
-
279
- if (filter !== undefined) {
280
- localVarQueryParameter['filter'] = filter;
281
- }
282
-
283
- if (search !== undefined) {
284
- localVarQueryParameter['search'] = search;
285
- }
286
-
287
- if (order !== undefined) {
288
- localVarQueryParameter['order'] = order;
289
- }
290
-
291
- if (expand !== undefined) {
292
- localVarQueryParameter['expand'] = expand;
293
- }
294
-
295
- if (filters !== undefined) {
296
- localVarQueryParameter['filters'] = filters;
297
- }
298
-
299
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
300
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
301
- }
302
-
303
-
304
-
305
- setSearchParams(localVarUrlObj, localVarQueryParameter);
306
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
307
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
308
-
309
- return {
310
- url: toPathString(localVarUrlObj),
311
- options: localVarRequestOptions,
312
- };
313
- },
314
- /**
315
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
316
- * @param {string} [authorization] Bearer Token
317
- * @param {number} [pageSize] Number of items per page.
318
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
319
- * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
320
- * @param {string} [search] Free-text search over searchable columns.
321
- * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
322
- * @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.
323
- * @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.
324
- * @param {*} [options] Override http request option.
325
- * @throws {RequiredError}
326
- */
327
- listUserGroups: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
328
- const localVarPath = `/tenantservice/v1/user-groups`;
329
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
330
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
331
- let baseOptions;
332
- let baseAccessToken;
333
- if (configuration) {
334
- baseOptions = configuration.baseOptions;
335
- baseAccessToken = configuration.accessToken;
336
- }
337
-
338
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
339
- const localVarHeaderParameter = {} as any;
340
- const localVarQueryParameter = {} as any;
341
-
342
- // authentication bearer required
343
- // http bearer authentication required
344
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
345
-
346
- if (pageSize !== undefined) {
347
- localVarQueryParameter['pageSize'] = pageSize;
348
- }
349
-
350
- if (pageToken !== undefined) {
351
- localVarQueryParameter['pageToken'] = pageToken;
352
- }
353
-
354
- if (filter !== undefined) {
355
- localVarQueryParameter['filter'] = filter;
356
- }
357
-
358
- if (search !== undefined) {
359
- localVarQueryParameter['search'] = search;
360
- }
361
-
362
- if (order !== undefined) {
363
- localVarQueryParameter['order'] = order;
364
- }
365
-
366
- if (expand !== undefined) {
367
- localVarQueryParameter['expand'] = expand;
368
- }
369
-
370
- if (filters !== undefined) {
371
- localVarQueryParameter['filters'] = filters;
372
- }
373
-
374
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
375
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
376
- }
377
-
378
-
379
-
380
- setSearchParams(localVarUrlObj, localVarQueryParameter);
381
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
382
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
383
-
384
- return {
385
- url: toPathString(localVarUrlObj),
386
- options: localVarRequestOptions,
387
- };
388
- },
389
- /**
390
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
391
- * @param {string} code
392
- * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
393
- * @param {string} [authorization] Bearer Token
394
- * @param {*} [options] Override http request option.
395
- * @throws {RequiredError}
396
- */
397
- removeUsersFromGroup: async (code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
398
- // verify required parameter 'code' is not null or undefined
399
- assertParamExists('removeUsersFromGroup', 'code', code)
400
- // verify required parameter 'removeUsersFromGroupRequestDto' is not null or undefined
401
- assertParamExists('removeUsersFromGroup', 'removeUsersFromGroupRequestDto', removeUsersFromGroupRequestDto)
402
- const localVarPath = `/tenantservice/v1/user-groups/{code}/members`
403
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
404
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
405
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
406
- let baseOptions;
407
- let baseAccessToken;
408
- if (configuration) {
409
- baseOptions = configuration.baseOptions;
410
- baseAccessToken = configuration.accessToken;
411
- }
412
-
413
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
414
- const localVarHeaderParameter = {} as any;
415
- const localVarQueryParameter = {} as any;
416
-
417
- // authentication bearer required
418
- // http bearer authentication required
419
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
420
-
421
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
422
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
423
- }
424
-
425
-
426
-
427
- localVarHeaderParameter['Content-Type'] = 'application/json';
428
-
429
- setSearchParams(localVarUrlObj, localVarQueryParameter);
430
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
431
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
432
- localVarRequestOptions.data = serializeDataIfNeeded(removeUsersFromGroupRequestDto, localVarRequestOptions, configuration)
433
-
434
- return {
435
- url: toPathString(localVarUrlObj),
436
- options: localVarRequestOptions,
437
- };
438
- },
439
- /**
440
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
441
- * @param {string} code
442
- * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
443
- * @param {string} [authorization] Bearer Token
444
- * @param {*} [options] Override http request option.
445
- * @throws {RequiredError}
446
- */
447
- updateUserGroup: async (code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
448
- // verify required parameter 'code' is not null or undefined
449
- assertParamExists('updateUserGroup', 'code', code)
450
- // verify required parameter 'updateUserGroupRequestDto' is not null or undefined
451
- assertParamExists('updateUserGroup', 'updateUserGroupRequestDto', updateUserGroupRequestDto)
452
- const localVarPath = `/tenantservice/v1/user-groups/{code}`
453
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
454
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
455
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
456
- let baseOptions;
457
- let baseAccessToken;
458
- if (configuration) {
459
- baseOptions = configuration.baseOptions;
460
- baseAccessToken = configuration.accessToken;
461
- }
462
-
463
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
464
- const localVarHeaderParameter = {} as any;
465
- const localVarQueryParameter = {} as any;
466
-
467
- // authentication bearer required
468
- // http bearer authentication required
469
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
470
-
471
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
472
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
473
- }
474
-
475
-
476
-
477
- localVarHeaderParameter['Content-Type'] = 'application/json';
478
-
479
- setSearchParams(localVarUrlObj, localVarQueryParameter);
480
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
481
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
482
- localVarRequestOptions.data = serializeDataIfNeeded(updateUserGroupRequestDto, localVarRequestOptions, configuration)
483
-
484
- return {
485
- url: toPathString(localVarUrlObj),
486
- options: localVarRequestOptions,
487
- };
488
- },
489
- }
490
- };
491
-
492
- /**
493
- * UserGroupApi - functional programming interface
494
- * @export
495
- */
496
- export const UserGroupApiFp = function(configuration?: Configuration) {
497
- const localVarAxiosParamCreator = UserGroupApiAxiosParamCreator(configuration)
498
- return {
499
- /**
500
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
501
- * @param {string} code
502
- * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
503
- * @param {string} [authorization] Bearer Token
504
- * @param {*} [options] Override http request option.
505
- * @throws {RequiredError}
506
- */
507
- async addUsersToGroup(code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUsersToGroupResponseClass>> {
508
- const localVarAxiosArgs = await localVarAxiosParamCreator.addUsersToGroup(code, addUsersToGroupRequestDto, authorization, options);
509
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
510
- },
511
- /**
512
- * undefined **Required Permissions** \"identity-management.user-groups.create\"
513
- * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
514
- * @param {string} [authorization] Bearer Token
515
- * @param {*} [options] Override http request option.
516
- * @throws {RequiredError}
517
- */
518
- async createUserGroup(createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateUserGroupResponseClass>> {
519
- const localVarAxiosArgs = await localVarAxiosParamCreator.createUserGroup(createUserGroupRequestDto, authorization, options);
520
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
521
- },
522
- /**
523
- * undefined **Required Permissions** \"identity-management.user-groups.delete\"
524
- * @param {string} code
525
- * @param {string} [authorization] Bearer Token
526
- * @param {*} [options] Override http request option.
527
- * @throws {RequiredError}
528
- */
529
- async deleteUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
530
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserGroup(code, authorization, options);
531
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
532
- },
533
- /**
534
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
535
- * @param {string} code
536
- * @param {string} [authorization] Bearer Token
537
- * @param {*} [options] Override http request option.
538
- * @throws {RequiredError}
539
- */
540
- async getUserGroup(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserGroupResponseClass>> {
541
- const localVarAxiosArgs = await localVarAxiosParamCreator.getUserGroup(code, authorization, options);
542
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
543
- },
544
- /**
545
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
546
- * @param {string} code
547
- * @param {string} [authorization] Bearer Token
548
- * @param {number} [pageSize] Number of items per page.
549
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
550
- * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
551
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
552
- * @param {string} [order] Sort the response by allowed columns (see paginate config).
553
- * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
554
- * @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.
555
- * @param {*} [options] Override http request option.
556
- * @throws {RequiredError}
557
- */
558
- async listUserGroupMembers(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUserGroupMembersResponseClass>> {
559
- const localVarAxiosArgs = await localVarAxiosParamCreator.listUserGroupMembers(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
560
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
561
- },
562
- /**
563
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
564
- * @param {string} [authorization] Bearer Token
565
- * @param {number} [pageSize] Number of items per page.
566
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
567
- * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
568
- * @param {string} [search] Free-text search over searchable columns.
569
- * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
570
- * @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.
571
- * @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.
572
- * @param {*} [options] Override http request option.
573
- * @throws {RequiredError}
574
- */
575
- async listUserGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUserGroupsResponseClass>> {
576
- const localVarAxiosArgs = await localVarAxiosParamCreator.listUserGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
577
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
578
- },
579
- /**
580
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
581
- * @param {string} code
582
- * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
583
- * @param {string} [authorization] Bearer Token
584
- * @param {*} [options] Override http request option.
585
- * @throws {RequiredError}
586
- */
587
- async removeUsersFromGroup(code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
588
- const localVarAxiosArgs = await localVarAxiosParamCreator.removeUsersFromGroup(code, removeUsersFromGroupRequestDto, authorization, options);
589
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
590
- },
591
- /**
592
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
593
- * @param {string} code
594
- * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
595
- * @param {string} [authorization] Bearer Token
596
- * @param {*} [options] Override http request option.
597
- * @throws {RequiredError}
598
- */
599
- async updateUserGroup(code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateUserGroupResponseClass>> {
600
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserGroup(code, updateUserGroupRequestDto, authorization, options);
601
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
602
- },
603
- }
604
- };
605
-
606
- /**
607
- * UserGroupApi - factory interface
608
- * @export
609
- */
610
- export const UserGroupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
611
- const localVarFp = UserGroupApiFp(configuration)
612
- return {
613
- /**
614
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
615
- * @param {string} code
616
- * @param {AddUsersToGroupRequestDto} addUsersToGroupRequestDto
617
- * @param {string} [authorization] Bearer Token
618
- * @param {*} [options] Override http request option.
619
- * @throws {RequiredError}
620
- */
621
- addUsersToGroup(code: string, addUsersToGroupRequestDto: AddUsersToGroupRequestDto, authorization?: string, options?: any): AxiosPromise<AddUsersToGroupResponseClass> {
622
- return localVarFp.addUsersToGroup(code, addUsersToGroupRequestDto, authorization, options).then((request) => request(axios, basePath));
623
- },
624
- /**
625
- * undefined **Required Permissions** \"identity-management.user-groups.create\"
626
- * @param {CreateUserGroupRequestDto} createUserGroupRequestDto
627
- * @param {string} [authorization] Bearer Token
628
- * @param {*} [options] Override http request option.
629
- * @throws {RequiredError}
630
- */
631
- createUserGroup(createUserGroupRequestDto: CreateUserGroupRequestDto, authorization?: string, options?: any): AxiosPromise<CreateUserGroupResponseClass> {
632
- return localVarFp.createUserGroup(createUserGroupRequestDto, authorization, options).then((request) => request(axios, basePath));
633
- },
634
- /**
635
- * undefined **Required Permissions** \"identity-management.user-groups.delete\"
636
- * @param {string} code
637
- * @param {string} [authorization] Bearer Token
638
- * @param {*} [options] Override http request option.
639
- * @throws {RequiredError}
640
- */
641
- deleteUserGroup(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
642
- return localVarFp.deleteUserGroup(code, authorization, options).then((request) => request(axios, basePath));
643
- },
644
- /**
645
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
646
- * @param {string} code
647
- * @param {string} [authorization] Bearer Token
648
- * @param {*} [options] Override http request option.
649
- * @throws {RequiredError}
650
- */
651
- getUserGroup(code: string, authorization?: string, options?: any): AxiosPromise<GetUserGroupResponseClass> {
652
- return localVarFp.getUserGroup(code, authorization, options).then((request) => request(axios, basePath));
653
- },
654
- /**
655
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
656
- * @param {string} code
657
- * @param {string} [authorization] Bearer Token
658
- * @param {number} [pageSize] Number of items per page.
659
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
660
- * @param {string} [filter] Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
661
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
662
- * @param {string} [order] Sort the response by allowed columns (see paginate config).
663
- * @param {string} [expand] Comma-separated list of related objects to embed in each member (e.g. user details).
664
- * @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.
665
- * @param {*} [options] Override http request option.
666
- * @throws {RequiredError}
667
- */
668
- listUserGroupMembers(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUserGroupMembersResponseClass> {
669
- return localVarFp.listUserGroupMembers(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
670
- },
671
- /**
672
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
673
- * @param {string} [authorization] Bearer Token
674
- * @param {number} [pageSize] Number of items per page.
675
- * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
676
- * @param {string} [filter] Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
677
- * @param {string} [search] Free-text search over searchable columns.
678
- * @param {string} [order] Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
679
- * @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.
680
- * @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.
681
- * @param {*} [options] Override http request option.
682
- * @throws {RequiredError}
683
- */
684
- listUserGroups(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListUserGroupsResponseClass> {
685
- return localVarFp.listUserGroups(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
686
- },
687
- /**
688
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
689
- * @param {string} code
690
- * @param {RemoveUsersFromGroupRequestDto} removeUsersFromGroupRequestDto
691
- * @param {string} [authorization] Bearer Token
692
- * @param {*} [options] Override http request option.
693
- * @throws {RequiredError}
694
- */
695
- removeUsersFromGroup(code: string, removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
696
- return localVarFp.removeUsersFromGroup(code, removeUsersFromGroupRequestDto, authorization, options).then((request) => request(axios, basePath));
697
- },
698
- /**
699
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
700
- * @param {string} code
701
- * @param {UpdateUserGroupRequestDto} updateUserGroupRequestDto
702
- * @param {string} [authorization] Bearer Token
703
- * @param {*} [options] Override http request option.
704
- * @throws {RequiredError}
705
- */
706
- updateUserGroup(code: string, updateUserGroupRequestDto: UpdateUserGroupRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateUserGroupResponseClass> {
707
- return localVarFp.updateUserGroup(code, updateUserGroupRequestDto, authorization, options).then((request) => request(axios, basePath));
708
- },
709
- };
710
- };
711
-
712
- /**
713
- * Request parameters for addUsersToGroup operation in UserGroupApi.
714
- * @export
715
- * @interface UserGroupApiAddUsersToGroupRequest
716
- */
717
- export interface UserGroupApiAddUsersToGroupRequest {
718
- /**
719
- *
720
- * @type {string}
721
- * @memberof UserGroupApiAddUsersToGroup
722
- */
723
- readonly code: string
724
-
725
- /**
726
- *
727
- * @type {AddUsersToGroupRequestDto}
728
- * @memberof UserGroupApiAddUsersToGroup
729
- */
730
- readonly addUsersToGroupRequestDto: AddUsersToGroupRequestDto
731
-
732
- /**
733
- * Bearer Token
734
- * @type {string}
735
- * @memberof UserGroupApiAddUsersToGroup
736
- */
737
- readonly authorization?: string
738
- }
739
-
740
- /**
741
- * Request parameters for createUserGroup operation in UserGroupApi.
742
- * @export
743
- * @interface UserGroupApiCreateUserGroupRequest
744
- */
745
- export interface UserGroupApiCreateUserGroupRequest {
746
- /**
747
- *
748
- * @type {CreateUserGroupRequestDto}
749
- * @memberof UserGroupApiCreateUserGroup
750
- */
751
- readonly createUserGroupRequestDto: CreateUserGroupRequestDto
752
-
753
- /**
754
- * Bearer Token
755
- * @type {string}
756
- * @memberof UserGroupApiCreateUserGroup
757
- */
758
- readonly authorization?: string
759
- }
760
-
761
- /**
762
- * Request parameters for deleteUserGroup operation in UserGroupApi.
763
- * @export
764
- * @interface UserGroupApiDeleteUserGroupRequest
765
- */
766
- export interface UserGroupApiDeleteUserGroupRequest {
767
- /**
768
- *
769
- * @type {string}
770
- * @memberof UserGroupApiDeleteUserGroup
771
- */
772
- readonly code: string
773
-
774
- /**
775
- * Bearer Token
776
- * @type {string}
777
- * @memberof UserGroupApiDeleteUserGroup
778
- */
779
- readonly authorization?: string
780
- }
781
-
782
- /**
783
- * Request parameters for getUserGroup operation in UserGroupApi.
784
- * @export
785
- * @interface UserGroupApiGetUserGroupRequest
786
- */
787
- export interface UserGroupApiGetUserGroupRequest {
788
- /**
789
- *
790
- * @type {string}
791
- * @memberof UserGroupApiGetUserGroup
792
- */
793
- readonly code: string
794
-
795
- /**
796
- * Bearer Token
797
- * @type {string}
798
- * @memberof UserGroupApiGetUserGroup
799
- */
800
- readonly authorization?: string
801
- }
802
-
803
- /**
804
- * Request parameters for listUserGroupMembers operation in UserGroupApi.
805
- * @export
806
- * @interface UserGroupApiListUserGroupMembersRequest
807
- */
808
- export interface UserGroupApiListUserGroupMembersRequest {
809
- /**
810
- *
811
- * @type {string}
812
- * @memberof UserGroupApiListUserGroupMembers
813
- */
814
- readonly code: string
815
-
816
- /**
817
- * Bearer Token
818
- * @type {string}
819
- * @memberof UserGroupApiListUserGroupMembers
820
- */
821
- readonly authorization?: string
822
-
823
- /**
824
- * Number of items per page.
825
- * @type {number}
826
- * @memberof UserGroupApiListUserGroupMembers
827
- */
828
- readonly pageSize?: number
829
-
830
- /**
831
- * Opaque token for the next page (returned in a previous response).
832
- * @type {string}
833
- * @memberof UserGroupApiListUserGroupMembers
834
- */
835
- readonly pageToken?: string
836
-
837
- /**
838
- * Filter members by one or more fields (in addition to the parent group). Allowed fields are declared in user-group-membership.config.
839
- * @type {string}
840
- * @memberof UserGroupApiListUserGroupMembers
841
- */
842
- readonly filter?: string
843
-
844
- /**
845
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
846
- * @type {string}
847
- * @memberof UserGroupApiListUserGroupMembers
848
- */
849
- readonly search?: string
850
-
851
- /**
852
- * Sort the response by allowed columns (see paginate config).
853
- * @type {string}
854
- * @memberof UserGroupApiListUserGroupMembers
855
- */
856
- readonly order?: string
857
-
858
- /**
859
- * Comma-separated list of related objects to embed in each member (e.g. user details).
860
- * @type {string}
861
- * @memberof UserGroupApiListUserGroupMembers
862
- */
863
- readonly expand?: string
864
-
865
- /**
866
- * 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.
867
- * @type {string}
868
- * @memberof UserGroupApiListUserGroupMembers
869
- */
870
- readonly filters?: string
871
- }
872
-
873
- /**
874
- * Request parameters for listUserGroups operation in UserGroupApi.
875
- * @export
876
- * @interface UserGroupApiListUserGroupsRequest
877
- */
878
- export interface UserGroupApiListUserGroupsRequest {
879
- /**
880
- * Bearer Token
881
- * @type {string}
882
- * @memberof UserGroupApiListUserGroups
883
- */
884
- readonly authorization?: string
885
-
886
- /**
887
- * Number of items per page.
888
- * @type {number}
889
- * @memberof UserGroupApiListUserGroups
890
- */
891
- readonly pageSize?: number
892
-
893
- /**
894
- * Opaque token for the next page (returned in a previous response).
895
- * @type {string}
896
- * @memberof UserGroupApiListUserGroups
897
- */
898
- readonly pageToken?: string
899
-
900
- /**
901
- * Filter user groups by one or more fields. Allowed: id, name, slug, createdAt, updatedAt.
902
- * @type {string}
903
- * @memberof UserGroupApiListUserGroups
904
- */
905
- readonly filter?: string
906
-
907
- /**
908
- * Free-text search over searchable columns.
909
- * @type {string}
910
- * @memberof UserGroupApiListUserGroups
911
- */
912
- readonly search?: string
913
-
914
- /**
915
- * Sort the response. Allowed columns: id, name, slug, createdAt, updatedAt.
916
- * @type {string}
917
- * @memberof UserGroupApiListUserGroups
918
- */
919
- readonly order?: string
920
-
921
- /**
922
- * 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.
923
- * @type {string}
924
- * @memberof UserGroupApiListUserGroups
925
- */
926
- readonly expand?: string
927
-
928
- /**
929
- * 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.
930
- * @type {string}
931
- * @memberof UserGroupApiListUserGroups
932
- */
933
- readonly filters?: string
934
- }
935
-
936
- /**
937
- * Request parameters for removeUsersFromGroup operation in UserGroupApi.
938
- * @export
939
- * @interface UserGroupApiRemoveUsersFromGroupRequest
940
- */
941
- export interface UserGroupApiRemoveUsersFromGroupRequest {
942
- /**
943
- *
944
- * @type {string}
945
- * @memberof UserGroupApiRemoveUsersFromGroup
946
- */
947
- readonly code: string
948
-
949
- /**
950
- *
951
- * @type {RemoveUsersFromGroupRequestDto}
952
- * @memberof UserGroupApiRemoveUsersFromGroup
953
- */
954
- readonly removeUsersFromGroupRequestDto: RemoveUsersFromGroupRequestDto
955
-
956
- /**
957
- * Bearer Token
958
- * @type {string}
959
- * @memberof UserGroupApiRemoveUsersFromGroup
960
- */
961
- readonly authorization?: string
962
- }
963
-
964
- /**
965
- * Request parameters for updateUserGroup operation in UserGroupApi.
966
- * @export
967
- * @interface UserGroupApiUpdateUserGroupRequest
968
- */
969
- export interface UserGroupApiUpdateUserGroupRequest {
970
- /**
971
- *
972
- * @type {string}
973
- * @memberof UserGroupApiUpdateUserGroup
974
- */
975
- readonly code: string
976
-
977
- /**
978
- *
979
- * @type {UpdateUserGroupRequestDto}
980
- * @memberof UserGroupApiUpdateUserGroup
981
- */
982
- readonly updateUserGroupRequestDto: UpdateUserGroupRequestDto
983
-
984
- /**
985
- * Bearer Token
986
- * @type {string}
987
- * @memberof UserGroupApiUpdateUserGroup
988
- */
989
- readonly authorization?: string
990
- }
991
-
992
- /**
993
- * UserGroupApi - object-oriented interface
994
- * @export
995
- * @class UserGroupApi
996
- * @extends {BaseAPI}
997
- */
998
- export class UserGroupApi extends BaseAPI {
999
- /**
1000
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
1001
- * @param {UserGroupApiAddUsersToGroupRequest} requestParameters Request parameters.
1002
- * @param {*} [options] Override http request option.
1003
- * @throws {RequiredError}
1004
- * @memberof UserGroupApi
1005
- */
1006
- public addUsersToGroup(requestParameters: UserGroupApiAddUsersToGroupRequest, options?: AxiosRequestConfig) {
1007
- return UserGroupApiFp(this.configuration).addUsersToGroup(requestParameters.code, requestParameters.addUsersToGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1008
- }
1009
-
1010
- /**
1011
- * undefined **Required Permissions** \"identity-management.user-groups.create\"
1012
- * @param {UserGroupApiCreateUserGroupRequest} requestParameters Request parameters.
1013
- * @param {*} [options] Override http request option.
1014
- * @throws {RequiredError}
1015
- * @memberof UserGroupApi
1016
- */
1017
- public createUserGroup(requestParameters: UserGroupApiCreateUserGroupRequest, options?: AxiosRequestConfig) {
1018
- return UserGroupApiFp(this.configuration).createUserGroup(requestParameters.createUserGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1019
- }
1020
-
1021
- /**
1022
- * undefined **Required Permissions** \"identity-management.user-groups.delete\"
1023
- * @param {UserGroupApiDeleteUserGroupRequest} requestParameters Request parameters.
1024
- * @param {*} [options] Override http request option.
1025
- * @throws {RequiredError}
1026
- * @memberof UserGroupApi
1027
- */
1028
- public deleteUserGroup(requestParameters: UserGroupApiDeleteUserGroupRequest, options?: AxiosRequestConfig) {
1029
- return UserGroupApiFp(this.configuration).deleteUserGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1030
- }
1031
-
1032
- /**
1033
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
1034
- * @param {UserGroupApiGetUserGroupRequest} requestParameters Request parameters.
1035
- * @param {*} [options] Override http request option.
1036
- * @throws {RequiredError}
1037
- * @memberof UserGroupApi
1038
- */
1039
- public getUserGroup(requestParameters: UserGroupApiGetUserGroupRequest, options?: AxiosRequestConfig) {
1040
- return UserGroupApiFp(this.configuration).getUserGroup(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1041
- }
1042
-
1043
- /**
1044
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
1045
- * @param {UserGroupApiListUserGroupMembersRequest} requestParameters Request parameters.
1046
- * @param {*} [options] Override http request option.
1047
- * @throws {RequiredError}
1048
- * @memberof UserGroupApi
1049
- */
1050
- public listUserGroupMembers(requestParameters: UserGroupApiListUserGroupMembersRequest, options?: AxiosRequestConfig) {
1051
- return UserGroupApiFp(this.configuration).listUserGroupMembers(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1052
- }
1053
-
1054
- /**
1055
- * undefined **Required Permissions** \"identity-management.user-groups.view\"
1056
- * @param {UserGroupApiListUserGroupsRequest} requestParameters Request parameters.
1057
- * @param {*} [options] Override http request option.
1058
- * @throws {RequiredError}
1059
- * @memberof UserGroupApi
1060
- */
1061
- public listUserGroups(requestParameters: UserGroupApiListUserGroupsRequest = {}, options?: AxiosRequestConfig) {
1062
- return UserGroupApiFp(this.configuration).listUserGroups(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1063
- }
1064
-
1065
- /**
1066
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
1067
- * @param {UserGroupApiRemoveUsersFromGroupRequest} requestParameters Request parameters.
1068
- * @param {*} [options] Override http request option.
1069
- * @throws {RequiredError}
1070
- * @memberof UserGroupApi
1071
- */
1072
- public removeUsersFromGroup(requestParameters: UserGroupApiRemoveUsersFromGroupRequest, options?: AxiosRequestConfig) {
1073
- return UserGroupApiFp(this.configuration).removeUsersFromGroup(requestParameters.code, requestParameters.removeUsersFromGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1074
- }
1075
-
1076
- /**
1077
- * undefined **Required Permissions** \"identity-management.user-groups.update\"
1078
- * @param {UserGroupApiUpdateUserGroupRequest} requestParameters Request parameters.
1079
- * @param {*} [options] Override http request option.
1080
- * @throws {RequiredError}
1081
- * @memberof UserGroupApi
1082
- */
1083
- public updateUserGroup(requestParameters: UserGroupApiUpdateUserGroupRequest, options?: AxiosRequestConfig) {
1084
- return UserGroupApiFp(this.configuration).updateUserGroup(requestParameters.code, requestParameters.updateUserGroupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1085
- }
1086
- }