@openfilz-sdk/typescript-ee 1.13.4 → 1.14.1

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 (122) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +33 -2
  4. package/api/metadata-key-controller-api.ts +121 -0
  5. package/api/sharing-policy-api.ts +1471 -0
  6. package/api/team-administration-api.ts +133 -0
  7. package/api.ts +3 -0
  8. package/dist/api/metadata-key-controller-api.d.ts +63 -0
  9. package/dist/api/metadata-key-controller-api.js +125 -0
  10. package/dist/api/sharing-policy-api.d.ts +662 -0
  11. package/dist/api/sharing-policy-api.js +1399 -0
  12. package/dist/api/team-administration-api.d.ts +70 -0
  13. package/dist/api/team-administration-api.js +139 -0
  14. package/dist/api.d.ts +3 -0
  15. package/dist/api.js +3 -0
  16. package/dist/esm/api/metadata-key-controller-api.d.ts +63 -0
  17. package/dist/esm/api/metadata-key-controller-api.js +118 -0
  18. package/dist/esm/api/sharing-policy-api.d.ts +662 -0
  19. package/dist/esm/api/sharing-policy-api.js +1392 -0
  20. package/dist/esm/api/team-administration-api.d.ts +70 -0
  21. package/dist/esm/api/team-administration-api.js +132 -0
  22. package/dist/esm/api.d.ts +3 -0
  23. package/dist/esm/api.js +3 -0
  24. package/dist/esm/models/effective-policy.d.ts +31 -0
  25. package/dist/esm/models/effective-policy.js +24 -0
  26. package/dist/esm/models/enriched-audit-log.d.ts +2 -0
  27. package/dist/esm/models/enriched-audit-log.js +2 -0
  28. package/dist/esm/models/global-policy.d.ts +26 -0
  29. package/dist/esm/models/global-policy.js +19 -0
  30. package/dist/esm/models/index.d.ts +10 -0
  31. package/dist/esm/models/index.js +10 -0
  32. package/dist/esm/models/item.d.ts +1 -7
  33. package/dist/esm/models/metadata-key-suggestion.d.ts +24 -0
  34. package/dist/esm/models/metadata-key-suggestion.js +14 -0
  35. package/dist/esm/models/my-policy.d.ts +30 -0
  36. package/dist/esm/models/my-policy.js +24 -0
  37. package/dist/esm/models/notification-dto.d.ts +1 -0
  38. package/dist/esm/models/notification-dto.js +1 -0
  39. package/dist/esm/models/override-request.d.ts +21 -0
  40. package/dist/esm/models/override-request.js +19 -0
  41. package/dist/esm/models/override-view.d.ts +27 -0
  42. package/dist/esm/models/override-view.js +19 -0
  43. package/dist/esm/models/revoke-request.d.ts +16 -0
  44. package/dist/esm/models/revoke-request.js +14 -0
  45. package/dist/esm/models/revoke-result.d.ts +18 -0
  46. package/dist/esm/models/revoke-result.js +14 -0
  47. package/dist/esm/models/search-by-audit-log-request.d.ts +2 -0
  48. package/dist/esm/models/search-by-audit-log-request.js +2 -0
  49. package/dist/esm/models/search-by-metadata-request.d.ts +1 -1
  50. package/dist/esm/models/share-result-error.d.ts +6 -0
  51. package/dist/esm/models/share-result-error.js +6 -0
  52. package/dist/esm/models/violation.d.ts +41 -0
  53. package/dist/esm/models/violation.js +28 -0
  54. package/dist/esm/models/violations-response.d.ts +17 -0
  55. package/dist/esm/models/violations-response.js +14 -0
  56. package/dist/models/effective-policy.d.ts +31 -0
  57. package/dist/models/effective-policy.js +27 -0
  58. package/dist/models/enriched-audit-log.d.ts +2 -0
  59. package/dist/models/enriched-audit-log.js +2 -0
  60. package/dist/models/global-policy.d.ts +26 -0
  61. package/dist/models/global-policy.js +22 -0
  62. package/dist/models/index.d.ts +10 -0
  63. package/dist/models/index.js +10 -0
  64. package/dist/models/item.d.ts +1 -7
  65. package/dist/models/metadata-key-suggestion.d.ts +24 -0
  66. package/dist/models/metadata-key-suggestion.js +15 -0
  67. package/dist/models/my-policy.d.ts +30 -0
  68. package/dist/models/my-policy.js +27 -0
  69. package/dist/models/notification-dto.d.ts +1 -0
  70. package/dist/models/notification-dto.js +1 -0
  71. package/dist/models/override-request.d.ts +21 -0
  72. package/dist/models/override-request.js +22 -0
  73. package/dist/models/override-view.d.ts +27 -0
  74. package/dist/models/override-view.js +22 -0
  75. package/dist/models/revoke-request.d.ts +16 -0
  76. package/dist/models/revoke-request.js +15 -0
  77. package/dist/models/revoke-result.d.ts +18 -0
  78. package/dist/models/revoke-result.js +15 -0
  79. package/dist/models/search-by-audit-log-request.d.ts +2 -0
  80. package/dist/models/search-by-audit-log-request.js +2 -0
  81. package/dist/models/search-by-metadata-request.d.ts +1 -1
  82. package/dist/models/share-result-error.d.ts +6 -0
  83. package/dist/models/share-result-error.js +6 -0
  84. package/dist/models/violation.d.ts +41 -0
  85. package/dist/models/violation.js +31 -0
  86. package/dist/models/violations-response.d.ts +17 -0
  87. package/dist/models/violations-response.js +15 -0
  88. package/docs/EffectivePolicy.md +28 -0
  89. package/docs/GlobalPolicy.md +30 -0
  90. package/docs/Item.md +2 -14
  91. package/docs/MetadataKeyControllerApi.md +52 -0
  92. package/docs/MetadataKeySuggestion.md +23 -0
  93. package/docs/MyPolicy.md +26 -0
  94. package/docs/OverrideRequest.md +20 -0
  95. package/docs/OverrideView.md +32 -0
  96. package/docs/RevokeRequest.md +22 -0
  97. package/docs/RevokeResult.md +28 -0
  98. package/docs/SearchByMetadataRequest.md +1 -1
  99. package/docs/SharingPolicyApi.md +988 -0
  100. package/docs/TeamAdministrationApi.md +62 -0
  101. package/docs/Violation.md +42 -0
  102. package/docs/ViolationsResponse.md +24 -0
  103. package/graphql/document.graphqls +2 -2
  104. package/graphql/share.graphqls +2 -0
  105. package/models/effective-policy.ts +41 -0
  106. package/models/enriched-audit-log.ts +2 -0
  107. package/models/global-policy.ts +35 -0
  108. package/models/index.ts +10 -0
  109. package/models/item.ts +1 -7
  110. package/models/metadata-key-suggestion.ts +30 -0
  111. package/models/my-policy.ts +40 -0
  112. package/models/notification-dto.ts +1 -0
  113. package/models/override-request.ts +30 -0
  114. package/models/override-view.ts +36 -0
  115. package/models/revoke-request.ts +24 -0
  116. package/models/revoke-result.ts +24 -0
  117. package/models/search-by-audit-log-request.ts +2 -0
  118. package/models/search-by-metadata-request.ts +1 -1
  119. package/models/share-result-error.ts +6 -0
  120. package/models/violation.ts +50 -0
  121. package/models/violations-response.ts +25 -0
  122. package/package.json +1 -1
@@ -0,0 +1,1471 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
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 type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { EffectivePolicy } from '../models';
26
+ // @ts-ignore
27
+ import type { GlobalPolicy } from '../models';
28
+ // @ts-ignore
29
+ import type { MyPolicy } from '../models';
30
+ // @ts-ignore
31
+ import type { OverrideRequest } from '../models';
32
+ // @ts-ignore
33
+ import type { OverrideView } from '../models';
34
+ // @ts-ignore
35
+ import type { RevokeRequest } from '../models';
36
+ // @ts-ignore
37
+ import type { RevokeResult } from '../models';
38
+ // @ts-ignore
39
+ import type { ViolationsResponse } from '../models';
40
+ /**
41
+ * SharingPolicyApi - axios parameter creator
42
+ */
43
+ export const SharingPolicyApiAxiosParamCreator = function (configuration?: Configuration) {
44
+ return {
45
+ /**
46
+ *
47
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
48
+ * @param {string} userId
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ adminGetEffectiveSharingPolicy: async (userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
53
+ // verify required parameter 'userId' is not null or undefined
54
+ assertParamExists('adminGetEffectiveSharingPolicy', 'userId', userId)
55
+ const localVarPath = `/api/v1/admin/sharing-policy/effective/{userId}`
56
+ .replace('{userId}', encodeURIComponent(String(userId)));
57
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
58
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
59
+ let baseOptions;
60
+ if (configuration) {
61
+ baseOptions = configuration.baseOptions;
62
+ }
63
+
64
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
65
+ const localVarHeaderParameter = {} as any;
66
+ const localVarQueryParameter = {} as any;
67
+
68
+ // authentication keycloak_auth required
69
+ // http bearer authentication required
70
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
71
+
72
+ localVarHeaderParameter['Accept'] = '*/*';
73
+
74
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
75
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
+
78
+ return {
79
+ url: toPathString(localVarUrlObj),
80
+ options: localVarRequestOptions,
81
+ };
82
+ },
83
+ /**
84
+ *
85
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ adminGetSharingPolicy: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
90
+ const localVarPath = `/api/v1/admin/sharing-policy`;
91
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
92
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
93
+ let baseOptions;
94
+ if (configuration) {
95
+ baseOptions = configuration.baseOptions;
96
+ }
97
+
98
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
99
+ const localVarHeaderParameter = {} as any;
100
+ const localVarQueryParameter = {} as any;
101
+
102
+ // authentication keycloak_auth required
103
+ // http bearer authentication required
104
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
105
+
106
+ localVarHeaderParameter['Accept'] = '*/*';
107
+
108
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
109
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
110
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
111
+
112
+ return {
113
+ url: toPathString(localVarUrlObj),
114
+ options: localVarRequestOptions,
115
+ };
116
+ },
117
+ /**
118
+ *
119
+ * @summary Progress of a background revocation
120
+ * @param {string} jobId
121
+ * @param {*} [options] Override http request option.
122
+ * @throws {RequiredError}
123
+ */
124
+ adminGetSharingPolicyRevokeJob: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
125
+ // verify required parameter 'jobId' is not null or undefined
126
+ assertParamExists('adminGetSharingPolicyRevokeJob', 'jobId', jobId)
127
+ const localVarPath = `/api/v1/admin/sharing-policy/violations/revoke/{jobId}`
128
+ .replace('{jobId}', encodeURIComponent(String(jobId)));
129
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
130
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
131
+ let baseOptions;
132
+ if (configuration) {
133
+ baseOptions = configuration.baseOptions;
134
+ }
135
+
136
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
137
+ const localVarHeaderParameter = {} as any;
138
+ const localVarQueryParameter = {} as any;
139
+
140
+ // authentication keycloak_auth required
141
+ // http bearer authentication required
142
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
143
+
144
+ localVarHeaderParameter['Accept'] = '*/*';
145
+
146
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
147
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
148
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
149
+
150
+ return {
151
+ url: toPathString(localVarUrlObj),
152
+ options: localVarRequestOptions,
153
+ };
154
+ },
155
+ /**
156
+ *
157
+ * @summary Users and teams with their own sharing rule
158
+ * @param {string} [type]
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ adminListSharingPolicyOverrides: async (type?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
163
+ const localVarPath = `/api/v1/admin/sharing-policy/overrides`;
164
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
165
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
166
+ let baseOptions;
167
+ if (configuration) {
168
+ baseOptions = configuration.baseOptions;
169
+ }
170
+
171
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
172
+ const localVarHeaderParameter = {} as any;
173
+ const localVarQueryParameter = {} as any;
174
+
175
+ // authentication keycloak_auth required
176
+ // http bearer authentication required
177
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
178
+
179
+ if (type !== undefined) {
180
+ localVarQueryParameter['type'] = type;
181
+ }
182
+
183
+ localVarHeaderParameter['Accept'] = '*/*';
184
+
185
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
186
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
188
+
189
+ return {
190
+ url: toPathString(localVarUrlObj),
191
+ options: localVarRequestOptions,
192
+ };
193
+ },
194
+ /**
195
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
196
+ * @summary Existing shares the current policies refuse
197
+ * @param {string} [cursor]
198
+ * @param {number} [size]
199
+ * @param {boolean} [count]
200
+ * @param {*} [options] Override http request option.
201
+ * @throws {RequiredError}
202
+ */
203
+ adminListSharingPolicyViolations: async (cursor?: string, size?: number, count?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
204
+ const localVarPath = `/api/v1/admin/sharing-policy/violations`;
205
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
206
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
207
+ let baseOptions;
208
+ if (configuration) {
209
+ baseOptions = configuration.baseOptions;
210
+ }
211
+
212
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
213
+ const localVarHeaderParameter = {} as any;
214
+ const localVarQueryParameter = {} as any;
215
+
216
+ // authentication keycloak_auth required
217
+ // http bearer authentication required
218
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
219
+
220
+ if (cursor !== undefined) {
221
+ localVarQueryParameter['cursor'] = cursor;
222
+ }
223
+
224
+ if (size !== undefined) {
225
+ localVarQueryParameter['size'] = size;
226
+ }
227
+
228
+ if (count !== undefined) {
229
+ localVarQueryParameter['count'] = count;
230
+ }
231
+
232
+ localVarHeaderParameter['Accept'] = '*/*';
233
+
234
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
235
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
236
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
237
+
238
+ return {
239
+ url: toPathString(localVarUrlObj),
240
+ options: localVarRequestOptions,
241
+ };
242
+ },
243
+ /**
244
+ *
245
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
246
+ * @param {string} subjectId
247
+ * @param {*} [options] Override http request option.
248
+ * @throws {RequiredError}
249
+ */
250
+ adminRemoveSharingPolicyOverride: async (subjectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
251
+ // verify required parameter 'subjectId' is not null or undefined
252
+ assertParamExists('adminRemoveSharingPolicyOverride', 'subjectId', subjectId)
253
+ const localVarPath = `/api/v1/admin/sharing-policy/overrides/{subjectId}`
254
+ .replace('{subjectId}', encodeURIComponent(String(subjectId)));
255
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
256
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
257
+ let baseOptions;
258
+ if (configuration) {
259
+ baseOptions = configuration.baseOptions;
260
+ }
261
+
262
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
263
+ const localVarHeaderParameter = {} as any;
264
+ const localVarQueryParameter = {} as any;
265
+
266
+ // authentication keycloak_auth required
267
+ // http bearer authentication required
268
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
269
+
270
+
271
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
272
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
273
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
274
+
275
+ return {
276
+ url: toPathString(localVarUrlObj),
277
+ options: localVarRequestOptions,
278
+ };
279
+ },
280
+ /**
281
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
282
+ * @summary Revoke shares that break the policy
283
+ * @param {RevokeRequest} revokeRequest
284
+ * @param {*} [options] Override http request option.
285
+ * @throws {RequiredError}
286
+ */
287
+ adminRevokeSharingPolicyViolations: async (revokeRequest: RevokeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
288
+ // verify required parameter 'revokeRequest' is not null or undefined
289
+ assertParamExists('adminRevokeSharingPolicyViolations', 'revokeRequest', revokeRequest)
290
+ const localVarPath = `/api/v1/admin/sharing-policy/violations/revoke`;
291
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
292
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
293
+ let baseOptions;
294
+ if (configuration) {
295
+ baseOptions = configuration.baseOptions;
296
+ }
297
+
298
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
299
+ const localVarHeaderParameter = {} as any;
300
+ const localVarQueryParameter = {} as any;
301
+
302
+ // authentication keycloak_auth required
303
+ // http bearer authentication required
304
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
305
+
306
+ localVarHeaderParameter['Content-Type'] = 'application/json';
307
+ localVarHeaderParameter['Accept'] = '*/*';
308
+
309
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
310
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
311
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
312
+ localVarRequestOptions.data = serializeDataIfNeeded(revokeRequest, localVarRequestOptions, configuration)
313
+
314
+ return {
315
+ url: toPathString(localVarUrlObj),
316
+ options: localVarRequestOptions,
317
+ };
318
+ },
319
+ /**
320
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
321
+ * @summary Change the global mode, allowed domains and e-Sign switch
322
+ * @param {GlobalPolicy} globalPolicy
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ adminSetSharingPolicyGlobal: async (globalPolicy: GlobalPolicy, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
327
+ // verify required parameter 'globalPolicy' is not null or undefined
328
+ assertParamExists('adminSetSharingPolicyGlobal', 'globalPolicy', globalPolicy)
329
+ const localVarPath = `/api/v1/admin/sharing-policy/global`;
330
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
331
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
332
+ let baseOptions;
333
+ if (configuration) {
334
+ baseOptions = configuration.baseOptions;
335
+ }
336
+
337
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
338
+ const localVarHeaderParameter = {} as any;
339
+ const localVarQueryParameter = {} as any;
340
+
341
+ // authentication keycloak_auth required
342
+ // http bearer authentication required
343
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
344
+
345
+ localVarHeaderParameter['Content-Type'] = 'application/json';
346
+ localVarHeaderParameter['Accept'] = '*/*';
347
+
348
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
349
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
350
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
351
+ localVarRequestOptions.data = serializeDataIfNeeded(globalPolicy, localVarRequestOptions, configuration)
352
+
353
+ return {
354
+ url: toPathString(localVarUrlObj),
355
+ options: localVarRequestOptions,
356
+ };
357
+ },
358
+ /**
359
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
360
+ * @summary Set a user\'s or a team\'s sharing rule
361
+ * @param {string} subjectId
362
+ * @param {OverrideRequest} overrideRequest
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ adminSetSharingPolicyOverride: async (subjectId: string, overrideRequest: OverrideRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
367
+ // verify required parameter 'subjectId' is not null or undefined
368
+ assertParamExists('adminSetSharingPolicyOverride', 'subjectId', subjectId)
369
+ // verify required parameter 'overrideRequest' is not null or undefined
370
+ assertParamExists('adminSetSharingPolicyOverride', 'overrideRequest', overrideRequest)
371
+ const localVarPath = `/api/v1/admin/sharing-policy/overrides/{subjectId}`
372
+ .replace('{subjectId}', encodeURIComponent(String(subjectId)));
373
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
374
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
375
+ let baseOptions;
376
+ if (configuration) {
377
+ baseOptions = configuration.baseOptions;
378
+ }
379
+
380
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
381
+ const localVarHeaderParameter = {} as any;
382
+ const localVarQueryParameter = {} as any;
383
+
384
+ // authentication keycloak_auth required
385
+ // http bearer authentication required
386
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
387
+
388
+ localVarHeaderParameter['Content-Type'] = 'application/json';
389
+ localVarHeaderParameter['Accept'] = '*/*';
390
+
391
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
392
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
393
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
394
+ localVarRequestOptions.data = serializeDataIfNeeded(overrideRequest, localVarRequestOptions, configuration)
395
+
396
+ return {
397
+ url: toPathString(localVarUrlObj),
398
+ options: localVarRequestOptions,
399
+ };
400
+ },
401
+ /**
402
+ *
403
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
404
+ * @param {string} userId
405
+ * @param {*} [options] Override http request option.
406
+ * @throws {RequiredError}
407
+ */
408
+ getEffectiveSharingPolicy: async (userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
409
+ // verify required parameter 'userId' is not null or undefined
410
+ assertParamExists('getEffectiveSharingPolicy', 'userId', userId)
411
+ const localVarPath = `/api/v1/users/sharing-policy/effective/{userId}`
412
+ .replace('{userId}', encodeURIComponent(String(userId)));
413
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
414
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
415
+ let baseOptions;
416
+ if (configuration) {
417
+ baseOptions = configuration.baseOptions;
418
+ }
419
+
420
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
421
+ const localVarHeaderParameter = {} as any;
422
+ const localVarQueryParameter = {} as any;
423
+
424
+ // authentication keycloak_auth required
425
+ // http bearer authentication required
426
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
427
+
428
+ localVarHeaderParameter['Accept'] = '*/*';
429
+
430
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
431
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
432
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
433
+
434
+ return {
435
+ url: toPathString(localVarUrlObj),
436
+ options: localVarRequestOptions,
437
+ };
438
+ },
439
+ /**
440
+ * The allowed domains are listed only when the rule restricts domains.
441
+ * @summary The caller\'s own sharing rule (for the share dialog)
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ getMySharingPolicy: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
446
+ const localVarPath = `/api/v1/users/me/sharing-policy`;
447
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
448
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
449
+ let baseOptions;
450
+ if (configuration) {
451
+ baseOptions = configuration.baseOptions;
452
+ }
453
+
454
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
455
+ const localVarHeaderParameter = {} as any;
456
+ const localVarQueryParameter = {} as any;
457
+
458
+ // authentication keycloak_auth required
459
+ // http bearer authentication required
460
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
461
+
462
+ localVarHeaderParameter['Accept'] = '*/*';
463
+
464
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
465
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
466
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
467
+
468
+ return {
469
+ url: toPathString(localVarUrlObj),
470
+ options: localVarRequestOptions,
471
+ };
472
+ },
473
+ /**
474
+ *
475
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
476
+ * @param {*} [options] Override http request option.
477
+ * @throws {RequiredError}
478
+ */
479
+ getSharingPolicy: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
480
+ const localVarPath = `/api/v1/users/sharing-policy`;
481
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
482
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
483
+ let baseOptions;
484
+ if (configuration) {
485
+ baseOptions = configuration.baseOptions;
486
+ }
487
+
488
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
489
+ const localVarHeaderParameter = {} as any;
490
+ const localVarQueryParameter = {} as any;
491
+
492
+ // authentication keycloak_auth required
493
+ // http bearer authentication required
494
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
495
+
496
+ localVarHeaderParameter['Accept'] = '*/*';
497
+
498
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
499
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
500
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
501
+
502
+ return {
503
+ url: toPathString(localVarUrlObj),
504
+ options: localVarRequestOptions,
505
+ };
506
+ },
507
+ /**
508
+ *
509
+ * @summary Progress of a background revocation
510
+ * @param {string} jobId
511
+ * @param {*} [options] Override http request option.
512
+ * @throws {RequiredError}
513
+ */
514
+ getSharingPolicyRevokeJob: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
515
+ // verify required parameter 'jobId' is not null or undefined
516
+ assertParamExists('getSharingPolicyRevokeJob', 'jobId', jobId)
517
+ const localVarPath = `/api/v1/users/sharing-policy/violations/revoke/{jobId}`
518
+ .replace('{jobId}', encodeURIComponent(String(jobId)));
519
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
520
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
521
+ let baseOptions;
522
+ if (configuration) {
523
+ baseOptions = configuration.baseOptions;
524
+ }
525
+
526
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
527
+ const localVarHeaderParameter = {} as any;
528
+ const localVarQueryParameter = {} as any;
529
+
530
+ // authentication keycloak_auth required
531
+ // http bearer authentication required
532
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
533
+
534
+ localVarHeaderParameter['Accept'] = '*/*';
535
+
536
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
537
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
538
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
539
+
540
+ return {
541
+ url: toPathString(localVarUrlObj),
542
+ options: localVarRequestOptions,
543
+ };
544
+ },
545
+ /**
546
+ *
547
+ * @summary Users and teams with their own sharing rule
548
+ * @param {string} [type]
549
+ * @param {*} [options] Override http request option.
550
+ * @throws {RequiredError}
551
+ */
552
+ listSharingPolicyOverrides: async (type?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
553
+ const localVarPath = `/api/v1/users/sharing-policy/overrides`;
554
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
555
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
556
+ let baseOptions;
557
+ if (configuration) {
558
+ baseOptions = configuration.baseOptions;
559
+ }
560
+
561
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
562
+ const localVarHeaderParameter = {} as any;
563
+ const localVarQueryParameter = {} as any;
564
+
565
+ // authentication keycloak_auth required
566
+ // http bearer authentication required
567
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
568
+
569
+ if (type !== undefined) {
570
+ localVarQueryParameter['type'] = type;
571
+ }
572
+
573
+ localVarHeaderParameter['Accept'] = '*/*';
574
+
575
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
576
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
577
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
578
+
579
+ return {
580
+ url: toPathString(localVarUrlObj),
581
+ options: localVarRequestOptions,
582
+ };
583
+ },
584
+ /**
585
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
586
+ * @summary Existing shares the current policies refuse
587
+ * @param {string} [cursor]
588
+ * @param {number} [size]
589
+ * @param {boolean} [count]
590
+ * @param {*} [options] Override http request option.
591
+ * @throws {RequiredError}
592
+ */
593
+ listSharingPolicyViolations: async (cursor?: string, size?: number, count?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
594
+ const localVarPath = `/api/v1/users/sharing-policy/violations`;
595
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
596
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
597
+ let baseOptions;
598
+ if (configuration) {
599
+ baseOptions = configuration.baseOptions;
600
+ }
601
+
602
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
603
+ const localVarHeaderParameter = {} as any;
604
+ const localVarQueryParameter = {} as any;
605
+
606
+ // authentication keycloak_auth required
607
+ // http bearer authentication required
608
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
609
+
610
+ if (cursor !== undefined) {
611
+ localVarQueryParameter['cursor'] = cursor;
612
+ }
613
+
614
+ if (size !== undefined) {
615
+ localVarQueryParameter['size'] = size;
616
+ }
617
+
618
+ if (count !== undefined) {
619
+ localVarQueryParameter['count'] = count;
620
+ }
621
+
622
+ localVarHeaderParameter['Accept'] = '*/*';
623
+
624
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
625
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
626
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
627
+
628
+ return {
629
+ url: toPathString(localVarUrlObj),
630
+ options: localVarRequestOptions,
631
+ };
632
+ },
633
+ /**
634
+ *
635
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
636
+ * @param {string} subjectId
637
+ * @param {*} [options] Override http request option.
638
+ * @throws {RequiredError}
639
+ */
640
+ removeSharingPolicyOverride: async (subjectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
641
+ // verify required parameter 'subjectId' is not null or undefined
642
+ assertParamExists('removeSharingPolicyOverride', 'subjectId', subjectId)
643
+ const localVarPath = `/api/v1/users/sharing-policy/overrides/{subjectId}`
644
+ .replace('{subjectId}', encodeURIComponent(String(subjectId)));
645
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
646
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
647
+ let baseOptions;
648
+ if (configuration) {
649
+ baseOptions = configuration.baseOptions;
650
+ }
651
+
652
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
653
+ const localVarHeaderParameter = {} as any;
654
+ const localVarQueryParameter = {} as any;
655
+
656
+ // authentication keycloak_auth required
657
+ // http bearer authentication required
658
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
659
+
660
+
661
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
662
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
663
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
664
+
665
+ return {
666
+ url: toPathString(localVarUrlObj),
667
+ options: localVarRequestOptions,
668
+ };
669
+ },
670
+ /**
671
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
672
+ * @summary Revoke shares that break the policy
673
+ * @param {RevokeRequest} revokeRequest
674
+ * @param {*} [options] Override http request option.
675
+ * @throws {RequiredError}
676
+ */
677
+ revokeSharingPolicyViolations: async (revokeRequest: RevokeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
678
+ // verify required parameter 'revokeRequest' is not null or undefined
679
+ assertParamExists('revokeSharingPolicyViolations', 'revokeRequest', revokeRequest)
680
+ const localVarPath = `/api/v1/users/sharing-policy/violations/revoke`;
681
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
682
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
683
+ let baseOptions;
684
+ if (configuration) {
685
+ baseOptions = configuration.baseOptions;
686
+ }
687
+
688
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
689
+ const localVarHeaderParameter = {} as any;
690
+ const localVarQueryParameter = {} as any;
691
+
692
+ // authentication keycloak_auth required
693
+ // http bearer authentication required
694
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
695
+
696
+ localVarHeaderParameter['Content-Type'] = 'application/json';
697
+ localVarHeaderParameter['Accept'] = '*/*';
698
+
699
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
700
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
701
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
702
+ localVarRequestOptions.data = serializeDataIfNeeded(revokeRequest, localVarRequestOptions, configuration)
703
+
704
+ return {
705
+ url: toPathString(localVarUrlObj),
706
+ options: localVarRequestOptions,
707
+ };
708
+ },
709
+ /**
710
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
711
+ * @summary Change the global mode, allowed domains and e-Sign switch
712
+ * @param {GlobalPolicy} globalPolicy
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ */
716
+ setSharingPolicyGlobal: async (globalPolicy: GlobalPolicy, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
717
+ // verify required parameter 'globalPolicy' is not null or undefined
718
+ assertParamExists('setSharingPolicyGlobal', 'globalPolicy', globalPolicy)
719
+ const localVarPath = `/api/v1/users/sharing-policy/global`;
720
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
721
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
722
+ let baseOptions;
723
+ if (configuration) {
724
+ baseOptions = configuration.baseOptions;
725
+ }
726
+
727
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
728
+ const localVarHeaderParameter = {} as any;
729
+ const localVarQueryParameter = {} as any;
730
+
731
+ // authentication keycloak_auth required
732
+ // http bearer authentication required
733
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
734
+
735
+ localVarHeaderParameter['Content-Type'] = 'application/json';
736
+ localVarHeaderParameter['Accept'] = '*/*';
737
+
738
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
739
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
740
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
741
+ localVarRequestOptions.data = serializeDataIfNeeded(globalPolicy, localVarRequestOptions, configuration)
742
+
743
+ return {
744
+ url: toPathString(localVarUrlObj),
745
+ options: localVarRequestOptions,
746
+ };
747
+ },
748
+ /**
749
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
750
+ * @summary Set a user\'s or a team\'s sharing rule
751
+ * @param {string} subjectId
752
+ * @param {OverrideRequest} overrideRequest
753
+ * @param {*} [options] Override http request option.
754
+ * @throws {RequiredError}
755
+ */
756
+ setSharingPolicyOverride: async (subjectId: string, overrideRequest: OverrideRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
757
+ // verify required parameter 'subjectId' is not null or undefined
758
+ assertParamExists('setSharingPolicyOverride', 'subjectId', subjectId)
759
+ // verify required parameter 'overrideRequest' is not null or undefined
760
+ assertParamExists('setSharingPolicyOverride', 'overrideRequest', overrideRequest)
761
+ const localVarPath = `/api/v1/users/sharing-policy/overrides/{subjectId}`
762
+ .replace('{subjectId}', encodeURIComponent(String(subjectId)));
763
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
764
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
765
+ let baseOptions;
766
+ if (configuration) {
767
+ baseOptions = configuration.baseOptions;
768
+ }
769
+
770
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
771
+ const localVarHeaderParameter = {} as any;
772
+ const localVarQueryParameter = {} as any;
773
+
774
+ // authentication keycloak_auth required
775
+ // http bearer authentication required
776
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
777
+
778
+ localVarHeaderParameter['Content-Type'] = 'application/json';
779
+ localVarHeaderParameter['Accept'] = '*/*';
780
+
781
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
782
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
783
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
784
+ localVarRequestOptions.data = serializeDataIfNeeded(overrideRequest, localVarRequestOptions, configuration)
785
+
786
+ return {
787
+ url: toPathString(localVarUrlObj),
788
+ options: localVarRequestOptions,
789
+ };
790
+ },
791
+ }
792
+ };
793
+
794
+ /**
795
+ * SharingPolicyApi - functional programming interface
796
+ */
797
+ export const SharingPolicyApiFp = function(configuration?: Configuration) {
798
+ const localVarAxiosParamCreator = SharingPolicyApiAxiosParamCreator(configuration)
799
+ return {
800
+ /**
801
+ *
802
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
803
+ * @param {string} userId
804
+ * @param {*} [options] Override http request option.
805
+ * @throws {RequiredError}
806
+ */
807
+ async adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EffectivePolicy>> {
808
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminGetEffectiveSharingPolicy(userId, options);
809
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
810
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminGetEffectiveSharingPolicy']?.[localVarOperationServerIndex]?.url;
811
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
812
+ },
813
+ /**
814
+ *
815
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
816
+ * @param {*} [options] Override http request option.
817
+ * @throws {RequiredError}
818
+ */
819
+ async adminGetSharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>> {
820
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminGetSharingPolicy(options);
821
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
822
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminGetSharingPolicy']?.[localVarOperationServerIndex]?.url;
823
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
824
+ },
825
+ /**
826
+ *
827
+ * @summary Progress of a background revocation
828
+ * @param {string} jobId
829
+ * @param {*} [options] Override http request option.
830
+ * @throws {RequiredError}
831
+ */
832
+ async adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>> {
833
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminGetSharingPolicyRevokeJob(jobId, options);
834
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
835
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminGetSharingPolicyRevokeJob']?.[localVarOperationServerIndex]?.url;
836
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
837
+ },
838
+ /**
839
+ *
840
+ * @summary Users and teams with their own sharing rule
841
+ * @param {string} [type]
842
+ * @param {*} [options] Override http request option.
843
+ * @throws {RequiredError}
844
+ */
845
+ async adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OverrideView>>> {
846
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminListSharingPolicyOverrides(type, options);
847
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
848
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminListSharingPolicyOverrides']?.[localVarOperationServerIndex]?.url;
849
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
850
+ },
851
+ /**
852
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
853
+ * @summary Existing shares the current policies refuse
854
+ * @param {string} [cursor]
855
+ * @param {number} [size]
856
+ * @param {boolean} [count]
857
+ * @param {*} [options] Override http request option.
858
+ * @throws {RequiredError}
859
+ */
860
+ async adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ViolationsResponse>> {
861
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminListSharingPolicyViolations(cursor, size, count, options);
862
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
863
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminListSharingPolicyViolations']?.[localVarOperationServerIndex]?.url;
864
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
865
+ },
866
+ /**
867
+ *
868
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
869
+ * @param {string} subjectId
870
+ * @param {*} [options] Override http request option.
871
+ * @throws {RequiredError}
872
+ */
873
+ async adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
874
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminRemoveSharingPolicyOverride(subjectId, options);
875
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
876
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminRemoveSharingPolicyOverride']?.[localVarOperationServerIndex]?.url;
877
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
878
+ },
879
+ /**
880
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
881
+ * @summary Revoke shares that break the policy
882
+ * @param {RevokeRequest} revokeRequest
883
+ * @param {*} [options] Override http request option.
884
+ * @throws {RequiredError}
885
+ */
886
+ async adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>> {
887
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminRevokeSharingPolicyViolations(revokeRequest, options);
888
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
889
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminRevokeSharingPolicyViolations']?.[localVarOperationServerIndex]?.url;
890
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
891
+ },
892
+ /**
893
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
894
+ * @summary Change the global mode, allowed domains and e-Sign switch
895
+ * @param {GlobalPolicy} globalPolicy
896
+ * @param {*} [options] Override http request option.
897
+ * @throws {RequiredError}
898
+ */
899
+ async adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>> {
900
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminSetSharingPolicyGlobal(globalPolicy, options);
901
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
902
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminSetSharingPolicyGlobal']?.[localVarOperationServerIndex]?.url;
903
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
904
+ },
905
+ /**
906
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
907
+ * @summary Set a user\'s or a team\'s sharing rule
908
+ * @param {string} subjectId
909
+ * @param {OverrideRequest} overrideRequest
910
+ * @param {*} [options] Override http request option.
911
+ * @throws {RequiredError}
912
+ */
913
+ async adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OverrideView>> {
914
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminSetSharingPolicyOverride(subjectId, overrideRequest, options);
915
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
916
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.adminSetSharingPolicyOverride']?.[localVarOperationServerIndex]?.url;
917
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
918
+ },
919
+ /**
920
+ *
921
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
922
+ * @param {string} userId
923
+ * @param {*} [options] Override http request option.
924
+ * @throws {RequiredError}
925
+ */
926
+ async getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EffectivePolicy>> {
927
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEffectiveSharingPolicy(userId, options);
928
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
929
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.getEffectiveSharingPolicy']?.[localVarOperationServerIndex]?.url;
930
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
931
+ },
932
+ /**
933
+ * The allowed domains are listed only when the rule restricts domains.
934
+ * @summary The caller\'s own sharing rule (for the share dialog)
935
+ * @param {*} [options] Override http request option.
936
+ * @throws {RequiredError}
937
+ */
938
+ async getMySharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MyPolicy>> {
939
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMySharingPolicy(options);
940
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
941
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.getMySharingPolicy']?.[localVarOperationServerIndex]?.url;
942
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
943
+ },
944
+ /**
945
+ *
946
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
947
+ * @param {*} [options] Override http request option.
948
+ * @throws {RequiredError}
949
+ */
950
+ async getSharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>> {
951
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSharingPolicy(options);
952
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
953
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.getSharingPolicy']?.[localVarOperationServerIndex]?.url;
954
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
955
+ },
956
+ /**
957
+ *
958
+ * @summary Progress of a background revocation
959
+ * @param {string} jobId
960
+ * @param {*} [options] Override http request option.
961
+ * @throws {RequiredError}
962
+ */
963
+ async getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>> {
964
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSharingPolicyRevokeJob(jobId, options);
965
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
966
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.getSharingPolicyRevokeJob']?.[localVarOperationServerIndex]?.url;
967
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
968
+ },
969
+ /**
970
+ *
971
+ * @summary Users and teams with their own sharing rule
972
+ * @param {string} [type]
973
+ * @param {*} [options] Override http request option.
974
+ * @throws {RequiredError}
975
+ */
976
+ async listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OverrideView>>> {
977
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSharingPolicyOverrides(type, options);
978
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
979
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.listSharingPolicyOverrides']?.[localVarOperationServerIndex]?.url;
980
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
981
+ },
982
+ /**
983
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
984
+ * @summary Existing shares the current policies refuse
985
+ * @param {string} [cursor]
986
+ * @param {number} [size]
987
+ * @param {boolean} [count]
988
+ * @param {*} [options] Override http request option.
989
+ * @throws {RequiredError}
990
+ */
991
+ async listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ViolationsResponse>> {
992
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSharingPolicyViolations(cursor, size, count, options);
993
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
994
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.listSharingPolicyViolations']?.[localVarOperationServerIndex]?.url;
995
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
996
+ },
997
+ /**
998
+ *
999
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
1000
+ * @param {string} subjectId
1001
+ * @param {*} [options] Override http request option.
1002
+ * @throws {RequiredError}
1003
+ */
1004
+ async removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1005
+ const localVarAxiosArgs = await localVarAxiosParamCreator.removeSharingPolicyOverride(subjectId, options);
1006
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1007
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.removeSharingPolicyOverride']?.[localVarOperationServerIndex]?.url;
1008
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1009
+ },
1010
+ /**
1011
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
1012
+ * @summary Revoke shares that break the policy
1013
+ * @param {RevokeRequest} revokeRequest
1014
+ * @param {*} [options] Override http request option.
1015
+ * @throws {RequiredError}
1016
+ */
1017
+ async revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>> {
1018
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeSharingPolicyViolations(revokeRequest, options);
1019
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1020
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.revokeSharingPolicyViolations']?.[localVarOperationServerIndex]?.url;
1021
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1022
+ },
1023
+ /**
1024
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
1025
+ * @summary Change the global mode, allowed domains and e-Sign switch
1026
+ * @param {GlobalPolicy} globalPolicy
1027
+ * @param {*} [options] Override http request option.
1028
+ * @throws {RequiredError}
1029
+ */
1030
+ async setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>> {
1031
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setSharingPolicyGlobal(globalPolicy, options);
1032
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1033
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.setSharingPolicyGlobal']?.[localVarOperationServerIndex]?.url;
1034
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1035
+ },
1036
+ /**
1037
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
1038
+ * @summary Set a user\'s or a team\'s sharing rule
1039
+ * @param {string} subjectId
1040
+ * @param {OverrideRequest} overrideRequest
1041
+ * @param {*} [options] Override http request option.
1042
+ * @throws {RequiredError}
1043
+ */
1044
+ async setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OverrideView>> {
1045
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setSharingPolicyOverride(subjectId, overrideRequest, options);
1046
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1047
+ const localVarOperationServerBasePath = operationServerMap['SharingPolicyApi.setSharingPolicyOverride']?.[localVarOperationServerIndex]?.url;
1048
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1049
+ },
1050
+ }
1051
+ };
1052
+
1053
+ /**
1054
+ * SharingPolicyApi - factory interface
1055
+ */
1056
+ export const SharingPolicyApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1057
+ const localVarFp = SharingPolicyApiFp(configuration)
1058
+ return {
1059
+ /**
1060
+ *
1061
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
1062
+ * @param {string} userId
1063
+ * @param {*} [options] Override http request option.
1064
+ * @throws {RequiredError}
1065
+ */
1066
+ adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EffectivePolicy> {
1067
+ return localVarFp.adminGetEffectiveSharingPolicy(userId, options).then((request) => request(axios, basePath));
1068
+ },
1069
+ /**
1070
+ *
1071
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
1072
+ * @param {*} [options] Override http request option.
1073
+ * @throws {RequiredError}
1074
+ */
1075
+ adminGetSharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy> {
1076
+ return localVarFp.adminGetSharingPolicy(options).then((request) => request(axios, basePath));
1077
+ },
1078
+ /**
1079
+ *
1080
+ * @summary Progress of a background revocation
1081
+ * @param {string} jobId
1082
+ * @param {*} [options] Override http request option.
1083
+ * @throws {RequiredError}
1084
+ */
1085
+ adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult> {
1086
+ return localVarFp.adminGetSharingPolicyRevokeJob(jobId, options).then((request) => request(axios, basePath));
1087
+ },
1088
+ /**
1089
+ *
1090
+ * @summary Users and teams with their own sharing rule
1091
+ * @param {string} [type]
1092
+ * @param {*} [options] Override http request option.
1093
+ * @throws {RequiredError}
1094
+ */
1095
+ adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OverrideView>> {
1096
+ return localVarFp.adminListSharingPolicyOverrides(type, options).then((request) => request(axios, basePath));
1097
+ },
1098
+ /**
1099
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
1100
+ * @summary Existing shares the current policies refuse
1101
+ * @param {string} [cursor]
1102
+ * @param {number} [size]
1103
+ * @param {boolean} [count]
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ */
1107
+ adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ViolationsResponse> {
1108
+ return localVarFp.adminListSharingPolicyViolations(cursor, size, count, options).then((request) => request(axios, basePath));
1109
+ },
1110
+ /**
1111
+ *
1112
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
1113
+ * @param {string} subjectId
1114
+ * @param {*} [options] Override http request option.
1115
+ * @throws {RequiredError}
1116
+ */
1117
+ adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1118
+ return localVarFp.adminRemoveSharingPolicyOverride(subjectId, options).then((request) => request(axios, basePath));
1119
+ },
1120
+ /**
1121
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
1122
+ * @summary Revoke shares that break the policy
1123
+ * @param {RevokeRequest} revokeRequest
1124
+ * @param {*} [options] Override http request option.
1125
+ * @throws {RequiredError}
1126
+ */
1127
+ adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult> {
1128
+ return localVarFp.adminRevokeSharingPolicyViolations(revokeRequest, options).then((request) => request(axios, basePath));
1129
+ },
1130
+ /**
1131
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
1132
+ * @summary Change the global mode, allowed domains and e-Sign switch
1133
+ * @param {GlobalPolicy} globalPolicy
1134
+ * @param {*} [options] Override http request option.
1135
+ * @throws {RequiredError}
1136
+ */
1137
+ adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy> {
1138
+ return localVarFp.adminSetSharingPolicyGlobal(globalPolicy, options).then((request) => request(axios, basePath));
1139
+ },
1140
+ /**
1141
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
1142
+ * @summary Set a user\'s or a team\'s sharing rule
1143
+ * @param {string} subjectId
1144
+ * @param {OverrideRequest} overrideRequest
1145
+ * @param {*} [options] Override http request option.
1146
+ * @throws {RequiredError}
1147
+ */
1148
+ adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<OverrideView> {
1149
+ return localVarFp.adminSetSharingPolicyOverride(subjectId, overrideRequest, options).then((request) => request(axios, basePath));
1150
+ },
1151
+ /**
1152
+ *
1153
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
1154
+ * @param {string} userId
1155
+ * @param {*} [options] Override http request option.
1156
+ * @throws {RequiredError}
1157
+ */
1158
+ getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EffectivePolicy> {
1159
+ return localVarFp.getEffectiveSharingPolicy(userId, options).then((request) => request(axios, basePath));
1160
+ },
1161
+ /**
1162
+ * The allowed domains are listed only when the rule restricts domains.
1163
+ * @summary The caller\'s own sharing rule (for the share dialog)
1164
+ * @param {*} [options] Override http request option.
1165
+ * @throws {RequiredError}
1166
+ */
1167
+ getMySharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<MyPolicy> {
1168
+ return localVarFp.getMySharingPolicy(options).then((request) => request(axios, basePath));
1169
+ },
1170
+ /**
1171
+ *
1172
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
1173
+ * @param {*} [options] Override http request option.
1174
+ * @throws {RequiredError}
1175
+ */
1176
+ getSharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy> {
1177
+ return localVarFp.getSharingPolicy(options).then((request) => request(axios, basePath));
1178
+ },
1179
+ /**
1180
+ *
1181
+ * @summary Progress of a background revocation
1182
+ * @param {string} jobId
1183
+ * @param {*} [options] Override http request option.
1184
+ * @throws {RequiredError}
1185
+ */
1186
+ getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult> {
1187
+ return localVarFp.getSharingPolicyRevokeJob(jobId, options).then((request) => request(axios, basePath));
1188
+ },
1189
+ /**
1190
+ *
1191
+ * @summary Users and teams with their own sharing rule
1192
+ * @param {string} [type]
1193
+ * @param {*} [options] Override http request option.
1194
+ * @throws {RequiredError}
1195
+ */
1196
+ listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OverrideView>> {
1197
+ return localVarFp.listSharingPolicyOverrides(type, options).then((request) => request(axios, basePath));
1198
+ },
1199
+ /**
1200
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
1201
+ * @summary Existing shares the current policies refuse
1202
+ * @param {string} [cursor]
1203
+ * @param {number} [size]
1204
+ * @param {boolean} [count]
1205
+ * @param {*} [options] Override http request option.
1206
+ * @throws {RequiredError}
1207
+ */
1208
+ listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ViolationsResponse> {
1209
+ return localVarFp.listSharingPolicyViolations(cursor, size, count, options).then((request) => request(axios, basePath));
1210
+ },
1211
+ /**
1212
+ *
1213
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
1214
+ * @param {string} subjectId
1215
+ * @param {*} [options] Override http request option.
1216
+ * @throws {RequiredError}
1217
+ */
1218
+ removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1219
+ return localVarFp.removeSharingPolicyOverride(subjectId, options).then((request) => request(axios, basePath));
1220
+ },
1221
+ /**
1222
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
1223
+ * @summary Revoke shares that break the policy
1224
+ * @param {RevokeRequest} revokeRequest
1225
+ * @param {*} [options] Override http request option.
1226
+ * @throws {RequiredError}
1227
+ */
1228
+ revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult> {
1229
+ return localVarFp.revokeSharingPolicyViolations(revokeRequest, options).then((request) => request(axios, basePath));
1230
+ },
1231
+ /**
1232
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
1233
+ * @summary Change the global mode, allowed domains and e-Sign switch
1234
+ * @param {GlobalPolicy} globalPolicy
1235
+ * @param {*} [options] Override http request option.
1236
+ * @throws {RequiredError}
1237
+ */
1238
+ setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy> {
1239
+ return localVarFp.setSharingPolicyGlobal(globalPolicy, options).then((request) => request(axios, basePath));
1240
+ },
1241
+ /**
1242
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
1243
+ * @summary Set a user\'s or a team\'s sharing rule
1244
+ * @param {string} subjectId
1245
+ * @param {OverrideRequest} overrideRequest
1246
+ * @param {*} [options] Override http request option.
1247
+ * @throws {RequiredError}
1248
+ */
1249
+ setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<OverrideView> {
1250
+ return localVarFp.setSharingPolicyOverride(subjectId, overrideRequest, options).then((request) => request(axios, basePath));
1251
+ },
1252
+ };
1253
+ };
1254
+
1255
+ /**
1256
+ * SharingPolicyApi - object-oriented interface
1257
+ */
1258
+ export class SharingPolicyApi extends BaseAPI {
1259
+ /**
1260
+ *
1261
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
1262
+ * @param {string} userId
1263
+ * @param {*} [options] Override http request option.
1264
+ * @throws {RequiredError}
1265
+ */
1266
+ public adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig) {
1267
+ return SharingPolicyApiFp(this.configuration).adminGetEffectiveSharingPolicy(userId, options).then((request) => request(this.axios, this.basePath));
1268
+ }
1269
+
1270
+ /**
1271
+ *
1272
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
1273
+ * @param {*} [options] Override http request option.
1274
+ * @throws {RequiredError}
1275
+ */
1276
+ public adminGetSharingPolicy(options?: RawAxiosRequestConfig) {
1277
+ return SharingPolicyApiFp(this.configuration).adminGetSharingPolicy(options).then((request) => request(this.axios, this.basePath));
1278
+ }
1279
+
1280
+ /**
1281
+ *
1282
+ * @summary Progress of a background revocation
1283
+ * @param {string} jobId
1284
+ * @param {*} [options] Override http request option.
1285
+ * @throws {RequiredError}
1286
+ */
1287
+ public adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig) {
1288
+ return SharingPolicyApiFp(this.configuration).adminGetSharingPolicyRevokeJob(jobId, options).then((request) => request(this.axios, this.basePath));
1289
+ }
1290
+
1291
+ /**
1292
+ *
1293
+ * @summary Users and teams with their own sharing rule
1294
+ * @param {string} [type]
1295
+ * @param {*} [options] Override http request option.
1296
+ * @throws {RequiredError}
1297
+ */
1298
+ public adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig) {
1299
+ return SharingPolicyApiFp(this.configuration).adminListSharingPolicyOverrides(type, options).then((request) => request(this.axios, this.basePath));
1300
+ }
1301
+
1302
+ /**
1303
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
1304
+ * @summary Existing shares the current policies refuse
1305
+ * @param {string} [cursor]
1306
+ * @param {number} [size]
1307
+ * @param {boolean} [count]
1308
+ * @param {*} [options] Override http request option.
1309
+ * @throws {RequiredError}
1310
+ */
1311
+ public adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig) {
1312
+ return SharingPolicyApiFp(this.configuration).adminListSharingPolicyViolations(cursor, size, count, options).then((request) => request(this.axios, this.basePath));
1313
+ }
1314
+
1315
+ /**
1316
+ *
1317
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
1318
+ * @param {string} subjectId
1319
+ * @param {*} [options] Override http request option.
1320
+ * @throws {RequiredError}
1321
+ */
1322
+ public adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig) {
1323
+ return SharingPolicyApiFp(this.configuration).adminRemoveSharingPolicyOverride(subjectId, options).then((request) => request(this.axios, this.basePath));
1324
+ }
1325
+
1326
+ /**
1327
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
1328
+ * @summary Revoke shares that break the policy
1329
+ * @param {RevokeRequest} revokeRequest
1330
+ * @param {*} [options] Override http request option.
1331
+ * @throws {RequiredError}
1332
+ */
1333
+ public adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig) {
1334
+ return SharingPolicyApiFp(this.configuration).adminRevokeSharingPolicyViolations(revokeRequest, options).then((request) => request(this.axios, this.basePath));
1335
+ }
1336
+
1337
+ /**
1338
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
1339
+ * @summary Change the global mode, allowed domains and e-Sign switch
1340
+ * @param {GlobalPolicy} globalPolicy
1341
+ * @param {*} [options] Override http request option.
1342
+ * @throws {RequiredError}
1343
+ */
1344
+ public adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig) {
1345
+ return SharingPolicyApiFp(this.configuration).adminSetSharingPolicyGlobal(globalPolicy, options).then((request) => request(this.axios, this.basePath));
1346
+ }
1347
+
1348
+ /**
1349
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
1350
+ * @summary Set a user\'s or a team\'s sharing rule
1351
+ * @param {string} subjectId
1352
+ * @param {OverrideRequest} overrideRequest
1353
+ * @param {*} [options] Override http request option.
1354
+ * @throws {RequiredError}
1355
+ */
1356
+ public adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig) {
1357
+ return SharingPolicyApiFp(this.configuration).adminSetSharingPolicyOverride(subjectId, overrideRequest, options).then((request) => request(this.axios, this.basePath));
1358
+ }
1359
+
1360
+ /**
1361
+ *
1362
+ * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
1363
+ * @param {string} userId
1364
+ * @param {*} [options] Override http request option.
1365
+ * @throws {RequiredError}
1366
+ */
1367
+ public getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig) {
1368
+ return SharingPolicyApiFp(this.configuration).getEffectiveSharingPolicy(userId, options).then((request) => request(this.axios, this.basePath));
1369
+ }
1370
+
1371
+ /**
1372
+ * The allowed domains are listed only when the rule restricts domains.
1373
+ * @summary The caller\'s own sharing rule (for the share dialog)
1374
+ * @param {*} [options] Override http request option.
1375
+ * @throws {RequiredError}
1376
+ */
1377
+ public getMySharingPolicy(options?: RawAxiosRequestConfig) {
1378
+ return SharingPolicyApiFp(this.configuration).getMySharingPolicy(options).then((request) => request(this.axios, this.basePath));
1379
+ }
1380
+
1381
+ /**
1382
+ *
1383
+ * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ */
1387
+ public getSharingPolicy(options?: RawAxiosRequestConfig) {
1388
+ return SharingPolicyApiFp(this.configuration).getSharingPolicy(options).then((request) => request(this.axios, this.basePath));
1389
+ }
1390
+
1391
+ /**
1392
+ *
1393
+ * @summary Progress of a background revocation
1394
+ * @param {string} jobId
1395
+ * @param {*} [options] Override http request option.
1396
+ * @throws {RequiredError}
1397
+ */
1398
+ public getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig) {
1399
+ return SharingPolicyApiFp(this.configuration).getSharingPolicyRevokeJob(jobId, options).then((request) => request(this.axios, this.basePath));
1400
+ }
1401
+
1402
+ /**
1403
+ *
1404
+ * @summary Users and teams with their own sharing rule
1405
+ * @param {string} [type]
1406
+ * @param {*} [options] Override http request option.
1407
+ * @throws {RequiredError}
1408
+ */
1409
+ public listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig) {
1410
+ return SharingPolicyApiFp(this.configuration).listSharingPolicyOverrides(type, options).then((request) => request(this.axios, this.basePath));
1411
+ }
1412
+
1413
+ /**
1414
+ * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
1415
+ * @summary Existing shares the current policies refuse
1416
+ * @param {string} [cursor]
1417
+ * @param {number} [size]
1418
+ * @param {boolean} [count]
1419
+ * @param {*} [options] Override http request option.
1420
+ * @throws {RequiredError}
1421
+ */
1422
+ public listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig) {
1423
+ return SharingPolicyApiFp(this.configuration).listSharingPolicyViolations(cursor, size, count, options).then((request) => request(this.axios, this.basePath));
1424
+ }
1425
+
1426
+ /**
1427
+ *
1428
+ * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
1429
+ * @param {string} subjectId
1430
+ * @param {*} [options] Override http request option.
1431
+ * @throws {RequiredError}
1432
+ */
1433
+ public removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig) {
1434
+ return SharingPolicyApiFp(this.configuration).removeSharingPolicyOverride(subjectId, options).then((request) => request(this.axios, this.basePath));
1435
+ }
1436
+
1437
+ /**
1438
+ * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
1439
+ * @summary Revoke shares that break the policy
1440
+ * @param {RevokeRequest} revokeRequest
1441
+ * @param {*} [options] Override http request option.
1442
+ * @throws {RequiredError}
1443
+ */
1444
+ public revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig) {
1445
+ return SharingPolicyApiFp(this.configuration).revokeSharingPolicyViolations(revokeRequest, options).then((request) => request(this.axios, this.basePath));
1446
+ }
1447
+
1448
+ /**
1449
+ * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
1450
+ * @summary Change the global mode, allowed domains and e-Sign switch
1451
+ * @param {GlobalPolicy} globalPolicy
1452
+ * @param {*} [options] Override http request option.
1453
+ * @throws {RequiredError}
1454
+ */
1455
+ public setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig) {
1456
+ return SharingPolicyApiFp(this.configuration).setSharingPolicyGlobal(globalPolicy, options).then((request) => request(this.axios, this.basePath));
1457
+ }
1458
+
1459
+ /**
1460
+ * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
1461
+ * @summary Set a user\'s or a team\'s sharing rule
1462
+ * @param {string} subjectId
1463
+ * @param {OverrideRequest} overrideRequest
1464
+ * @param {*} [options] Override http request option.
1465
+ * @throws {RequiredError}
1466
+ */
1467
+ public setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig) {
1468
+ return SharingPolicyApiFp(this.configuration).setSharingPolicyOverride(subjectId, overrideRequest, options).then((request) => request(this.axios, this.basePath));
1469
+ }
1470
+ }
1471
+