@emilgroup/tenant-sdk-node 1.34.1-beta.32 → 1.34.1-beta.34

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