@openfilz-sdk/typescript-ee 1.14.6 → 1.14.8
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.
- package/.openapi-generator/FILES +14 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +13 -2
- package/api/access-requests-api.ts +203 -0
- package/api/collaboration-controller-api.ts +79 -4
- package/api/comments-api.ts +152 -0
- package/api.ts +1 -0
- package/dist/api/access-requests-api.d.ts +100 -0
- package/dist/api/access-requests-api.js +202 -0
- package/dist/api/collaboration-controller-api.d.ts +37 -4
- package/dist/api/collaboration-controller-api.js +74 -4
- package/dist/api/comments-api.d.ts +67 -0
- package/dist/api/comments-api.js +140 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/access-requests-api.d.ts +100 -0
- package/dist/esm/api/access-requests-api.js +195 -0
- package/dist/esm/api/collaboration-controller-api.d.ts +37 -4
- package/dist/esm/api/collaboration-controller-api.js +74 -4
- package/dist/esm/api/comments-api.d.ts +67 -0
- package/dist/esm/api/comments-api.js +140 -0
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/access-request-input.d.ts +31 -0
- package/dist/esm/models/access-request-input.js +18 -0
- package/dist/esm/models/access-request-status.d.ts +36 -0
- package/dist/esm/models/access-request-status.js +24 -0
- package/dist/esm/models/enriched-audit-log.d.ts +1 -0
- package/dist/esm/models/enriched-audit-log.js +1 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/models/mention-access-item.d.ts +29 -0
- package/dist/esm/models/mention-access-item.js +21 -0
- package/dist/esm/models/mention-access-preview.d.ts +15 -0
- package/dist/esm/models/mention-access-preview.js +14 -0
- package/dist/esm/models/mention-access-request.d.ts +21 -0
- package/dist/esm/models/mention-access-request.js +14 -0
- package/dist/esm/models/notification-dto.d.ts +3 -0
- package/dist/esm/models/notification-dto.js +3 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/esm/models/search-by-audit-log-request.js +1 -0
- package/dist/esm/models/share-expiry-request.d.ts +25 -0
- package/dist/esm/models/share-expiry-request.js +14 -0
- package/dist/esm/models/share-request.d.ts +4 -0
- package/dist/esm/models/share-result-error.d.ts +3 -0
- package/dist/esm/models/share-result-error.js +3 -0
- package/dist/esm/models/violation.d.ts +3 -0
- package/dist/esm/models/violation.js +3 -0
- package/dist/models/access-request-input.d.ts +31 -0
- package/dist/models/access-request-input.js +21 -0
- package/dist/models/access-request-status.d.ts +36 -0
- package/dist/models/access-request-status.js +27 -0
- package/dist/models/enriched-audit-log.d.ts +1 -0
- package/dist/models/enriched-audit-log.js +1 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/mention-access-item.d.ts +29 -0
- package/dist/models/mention-access-item.js +24 -0
- package/dist/models/mention-access-preview.d.ts +15 -0
- package/dist/models/mention-access-preview.js +15 -0
- package/dist/models/mention-access-request.d.ts +21 -0
- package/dist/models/mention-access-request.js +15 -0
- package/dist/models/notification-dto.d.ts +3 -0
- package/dist/models/notification-dto.js +3 -0
- package/dist/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/models/search-by-audit-log-request.js +1 -0
- package/dist/models/share-expiry-request.d.ts +25 -0
- package/dist/models/share-expiry-request.js +15 -0
- package/dist/models/share-request.d.ts +4 -0
- package/dist/models/share-result-error.d.ts +3 -0
- package/dist/models/share-result-error.js +3 -0
- package/dist/models/violation.d.ts +3 -0
- package/dist/models/violation.js +3 -0
- package/docs/AccessRequestInput.md +24 -0
- package/docs/AccessRequestStatus.md +26 -0
- package/docs/AccessRequestsApi.md +112 -0
- package/docs/CollaborationControllerApi.md +57 -1
- package/docs/CommentsApi.md +106 -0
- package/docs/MentionAccessItem.md +32 -0
- package/docs/MentionAccessPreview.md +20 -0
- package/docs/MentionAccessRequest.md +22 -0
- package/docs/ShareExpiryRequest.md +24 -0
- package/docs/ShareRequest.md +2 -0
- package/graphql/share.graphqls +43 -2
- package/models/access-request-input.ts +40 -0
- package/models/access-request-status.ts +46 -0
- package/models/enriched-audit-log.ts +1 -0
- package/models/index.ts +6 -0
- package/models/mention-access-item.ts +38 -0
- package/models/mention-access-preview.ts +23 -0
- package/models/mention-access-request.ts +27 -0
- package/models/notification-dto.ts +3 -0
- package/models/search-by-audit-log-request.ts +1 -0
- package/models/share-expiry-request.ts +31 -0
- package/models/share-request.ts +4 -0
- package/models/share-result-error.ts +3 -0
- package/models/violation.ts +3 -0
- package/package.json +1 -1
package/api/comments-api.ts
CHANGED
|
@@ -26,6 +26,12 @@ import type { CommentDTO } from '../models';
|
|
|
26
26
|
// @ts-ignore
|
|
27
27
|
import type { CreateCommentRequest } from '../models';
|
|
28
28
|
// @ts-ignore
|
|
29
|
+
import type { MentionAccessPreview } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { MentionAccessRequest } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import type { ShareResultResponse } from '../models';
|
|
34
|
+
// @ts-ignore
|
|
29
35
|
import type { UpdateCommentRequest } from '../models';
|
|
30
36
|
/**
|
|
31
37
|
* CommentsApi - axios parameter creator
|
|
@@ -108,6 +114,84 @@ export const CommentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
108
114
|
options: localVarRequestOptions,
|
|
109
115
|
};
|
|
110
116
|
},
|
|
117
|
+
/**
|
|
118
|
+
* Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
|
|
119
|
+
* @summary Give mentioned users comment access
|
|
120
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
grantMentionAccess: async (mentionAccessRequest: MentionAccessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
125
|
+
// verify required parameter 'mentionAccessRequest' is not null or undefined
|
|
126
|
+
assertParamExists('grantMentionAccess', 'mentionAccessRequest', mentionAccessRequest)
|
|
127
|
+
const localVarPath = `/api/v1/documents/comments/mention-access/grant`;
|
|
128
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
129
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130
|
+
let baseOptions;
|
|
131
|
+
if (configuration) {
|
|
132
|
+
baseOptions = configuration.baseOptions;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
136
|
+
const localVarHeaderParameter = {} as any;
|
|
137
|
+
const localVarQueryParameter = {} as any;
|
|
138
|
+
|
|
139
|
+
// authentication keycloak_auth required
|
|
140
|
+
// http bearer authentication required
|
|
141
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
142
|
+
|
|
143
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
144
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
145
|
+
|
|
146
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
147
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
148
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
149
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration)
|
|
150
|
+
|
|
151
|
+
return {
|
|
152
|
+
url: toPathString(localVarUrlObj),
|
|
153
|
+
options: localVarRequestOptions,
|
|
154
|
+
};
|
|
155
|
+
},
|
|
156
|
+
/**
|
|
157
|
+
* Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
|
|
158
|
+
* @summary Preview comment access for mentioned users
|
|
159
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
previewMentionAccess: async (mentionAccessRequest: MentionAccessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
164
|
+
// verify required parameter 'mentionAccessRequest' is not null or undefined
|
|
165
|
+
assertParamExists('previewMentionAccess', 'mentionAccessRequest', mentionAccessRequest)
|
|
166
|
+
const localVarPath = `/api/v1/documents/comments/mention-access`;
|
|
167
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
168
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
169
|
+
let baseOptions;
|
|
170
|
+
if (configuration) {
|
|
171
|
+
baseOptions = configuration.baseOptions;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
175
|
+
const localVarHeaderParameter = {} as any;
|
|
176
|
+
const localVarQueryParameter = {} as any;
|
|
177
|
+
|
|
178
|
+
// authentication keycloak_auth required
|
|
179
|
+
// http bearer authentication required
|
|
180
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
181
|
+
|
|
182
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
183
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
184
|
+
|
|
185
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
186
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
187
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
188
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mentionAccessRequest, localVarRequestOptions, configuration)
|
|
189
|
+
|
|
190
|
+
return {
|
|
191
|
+
url: toPathString(localVarUrlObj),
|
|
192
|
+
options: localVarRequestOptions,
|
|
193
|
+
};
|
|
194
|
+
},
|
|
111
195
|
/**
|
|
112
196
|
* Update an existing comment. Only the comment creator can update their comment.
|
|
113
197
|
* @summary Update a comment
|
|
@@ -186,6 +270,32 @@ export const CommentsApiFp = function(configuration?: Configuration) {
|
|
|
186
270
|
const localVarOperationServerBasePath = operationServerMap['CommentsApi.deleteComment']?.[localVarOperationServerIndex]?.url;
|
|
187
271
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
188
272
|
},
|
|
273
|
+
/**
|
|
274
|
+
* Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
|
|
275
|
+
* @summary Give mentioned users comment access
|
|
276
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
277
|
+
* @param {*} [options] Override http request option.
|
|
278
|
+
* @throws {RequiredError}
|
|
279
|
+
*/
|
|
280
|
+
async grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>> {
|
|
281
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.grantMentionAccess(mentionAccessRequest, options);
|
|
282
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
283
|
+
const localVarOperationServerBasePath = operationServerMap['CommentsApi.grantMentionAccess']?.[localVarOperationServerIndex]?.url;
|
|
284
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
285
|
+
},
|
|
286
|
+
/**
|
|
287
|
+
* Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
|
|
288
|
+
* @summary Preview comment access for mentioned users
|
|
289
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
290
|
+
* @param {*} [options] Override http request option.
|
|
291
|
+
* @throws {RequiredError}
|
|
292
|
+
*/
|
|
293
|
+
async previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MentionAccessPreview>> {
|
|
294
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.previewMentionAccess(mentionAccessRequest, options);
|
|
295
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
296
|
+
const localVarOperationServerBasePath = operationServerMap['CommentsApi.previewMentionAccess']?.[localVarOperationServerIndex]?.url;
|
|
297
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
298
|
+
},
|
|
189
299
|
/**
|
|
190
300
|
* Update an existing comment. Only the comment creator can update their comment.
|
|
191
301
|
* @summary Update a comment
|
|
@@ -229,6 +339,26 @@ export const CommentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
229
339
|
deleteComment(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
230
340
|
return localVarFp.deleteComment(id, options).then((request) => request(axios, basePath));
|
|
231
341
|
},
|
|
342
|
+
/**
|
|
343
|
+
* Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
|
|
344
|
+
* @summary Give mentioned users comment access
|
|
345
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
349
|
+
grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse> {
|
|
350
|
+
return localVarFp.grantMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
|
|
351
|
+
},
|
|
352
|
+
/**
|
|
353
|
+
* Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
|
|
354
|
+
* @summary Preview comment access for mentioned users
|
|
355
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
*/
|
|
359
|
+
previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<MentionAccessPreview> {
|
|
360
|
+
return localVarFp.previewMentionAccess(mentionAccessRequest, options).then((request) => request(axios, basePath));
|
|
361
|
+
},
|
|
232
362
|
/**
|
|
233
363
|
* Update an existing comment. Only the comment creator can update their comment.
|
|
234
364
|
* @summary Update a comment
|
|
@@ -269,6 +399,28 @@ export class CommentsApi extends BaseAPI {
|
|
|
269
399
|
return CommentsApiFp(this.configuration).deleteComment(id, options).then((request) => request(this.axios, this.basePath));
|
|
270
400
|
}
|
|
271
401
|
|
|
402
|
+
/**
|
|
403
|
+
* Does what the preview lists: silent COMMENTER shares on the documents the caller manages, share requests to the owner on the others. Call it before saving the comment so the mentioned users are notified.
|
|
404
|
+
* @summary Give mentioned users comment access
|
|
405
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
406
|
+
* @param {*} [options] Override http request option.
|
|
407
|
+
* @throws {RequiredError}
|
|
408
|
+
*/
|
|
409
|
+
public grantMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) {
|
|
410
|
+
return CommentsApiFp(this.configuration).grantMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Lists the mentioned users who cannot comment on the documents yet and what giving them access takes: a COMMENTER share (or READER → COMMENTER) on a document the caller manages, a share request to the owner on the others. Changes nothing.
|
|
415
|
+
* @summary Preview comment access for mentioned users
|
|
416
|
+
* @param {MentionAccessRequest} mentionAccessRequest
|
|
417
|
+
* @param {*} [options] Override http request option.
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
public previewMentionAccess(mentionAccessRequest: MentionAccessRequest, options?: RawAxiosRequestConfig) {
|
|
421
|
+
return CommentsApiFp(this.configuration).previewMentionAccess(mentionAccessRequest, options).then((request) => request(this.axios, this.basePath));
|
|
422
|
+
}
|
|
423
|
+
|
|
272
424
|
/**
|
|
273
425
|
* Update an existing comment. Only the comment creator can update their comment.
|
|
274
426
|
* @summary Update a comment
|
package/api.ts
CHANGED
|
@@ -23,6 +23,7 @@ export * from './api/aimaintenance-api';
|
|
|
23
23
|
export * from './api/aisettings-api';
|
|
24
24
|
export * from './api/aitaxonomy-api';
|
|
25
25
|
export * from './api/aiteam-inboxes-api';
|
|
26
|
+
export * from './api/access-requests-api';
|
|
26
27
|
export * from './api/ai-analytics-admin-controller-api';
|
|
27
28
|
export * from './api/ai-archiving-admin-controller-api';
|
|
28
29
|
export * from './api/ai-cloud-usage-admin-controller-api';
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AccessRequestInput } from '../models';
|
|
16
|
+
import type { AccessRequestStatus } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* AccessRequestsApi - axios parameter creator
|
|
19
|
+
*/
|
|
20
|
+
export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
23
|
+
* @summary Can I open this document, or ask for it?
|
|
24
|
+
* @param {string} documentId
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
myAccessToDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
/**
|
|
30
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
31
|
+
* @summary Ask the owner for access
|
|
32
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
requestAccess: (accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* AccessRequestsApi - functional programming interface
|
|
40
|
+
*/
|
|
41
|
+
export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
42
|
+
/**
|
|
43
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
44
|
+
* @summary Can I open this document, or ask for it?
|
|
45
|
+
* @param {string} documentId
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
|
|
50
|
+
/**
|
|
51
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
52
|
+
* @summary Ask the owner for access
|
|
53
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* AccessRequestsApi - factory interface
|
|
61
|
+
*/
|
|
62
|
+
export declare const AccessRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63
|
+
/**
|
|
64
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
65
|
+
* @summary Can I open this document, or ask for it?
|
|
66
|
+
* @param {string} documentId
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
|
|
71
|
+
/**
|
|
72
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
73
|
+
* @summary Ask the owner for access
|
|
74
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* AccessRequestsApi - object-oriented interface
|
|
82
|
+
*/
|
|
83
|
+
export declare class AccessRequestsApi extends BaseAPI {
|
|
84
|
+
/**
|
|
85
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
86
|
+
* @summary Can I open this document, or ask for it?
|
|
87
|
+
* @param {string} documentId
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
|
|
92
|
+
/**
|
|
93
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
94
|
+
* @summary Ask the owner for access
|
|
95
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
|
|
100
|
+
}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.AccessRequestsApi = exports.AccessRequestsApiFactory = exports.AccessRequestsApiFp = exports.AccessRequestsApiAxiosParamCreator = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("../common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("../base");
|
|
32
|
+
/**
|
|
33
|
+
* AccessRequestsApi - axios parameter creator
|
|
34
|
+
*/
|
|
35
|
+
const AccessRequestsApiAxiosParamCreator = function (configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
39
|
+
* @summary Can I open this document, or ask for it?
|
|
40
|
+
* @param {string} documentId
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
myAccessToDocument: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
|
|
45
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
46
|
+
(0, common_1.assertParamExists)('myAccessToDocument', 'documentId', documentId);
|
|
47
|
+
const localVarPath = `/api/v1/users/me/access-requests/{documentId}`
|
|
48
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
49
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
51
|
+
let baseOptions;
|
|
52
|
+
if (configuration) {
|
|
53
|
+
baseOptions = configuration.baseOptions;
|
|
54
|
+
}
|
|
55
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
56
|
+
const localVarHeaderParameter = {};
|
|
57
|
+
const localVarQueryParameter = {};
|
|
58
|
+
// authentication keycloak_auth required
|
|
59
|
+
// http bearer authentication required
|
|
60
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
61
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
62
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
63
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
65
|
+
return {
|
|
66
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
67
|
+
options: localVarRequestOptions,
|
|
68
|
+
};
|
|
69
|
+
}),
|
|
70
|
+
/**
|
|
71
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
72
|
+
* @summary Ask the owner for access
|
|
73
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
requestAccess: (accessRequestInput_1, ...args_1) => __awaiter(this, [accessRequestInput_1, ...args_1], void 0, function* (accessRequestInput, options = {}) {
|
|
78
|
+
// verify required parameter 'accessRequestInput' is not null or undefined
|
|
79
|
+
(0, common_1.assertParamExists)('requestAccess', 'accessRequestInput', accessRequestInput);
|
|
80
|
+
const localVarPath = `/api/v1/users/me/access-requests`;
|
|
81
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
83
|
+
let baseOptions;
|
|
84
|
+
if (configuration) {
|
|
85
|
+
baseOptions = configuration.baseOptions;
|
|
86
|
+
}
|
|
87
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
88
|
+
const localVarHeaderParameter = {};
|
|
89
|
+
const localVarQueryParameter = {};
|
|
90
|
+
// authentication keycloak_auth required
|
|
91
|
+
// http bearer authentication required
|
|
92
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
93
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
94
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
95
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
96
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
97
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
98
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(accessRequestInput, localVarRequestOptions, configuration);
|
|
99
|
+
return {
|
|
100
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
101
|
+
options: localVarRequestOptions,
|
|
102
|
+
};
|
|
103
|
+
}),
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
exports.AccessRequestsApiAxiosParamCreator = AccessRequestsApiAxiosParamCreator;
|
|
107
|
+
/**
|
|
108
|
+
* AccessRequestsApi - functional programming interface
|
|
109
|
+
*/
|
|
110
|
+
const AccessRequestsApiFp = function (configuration) {
|
|
111
|
+
const localVarAxiosParamCreator = (0, exports.AccessRequestsApiAxiosParamCreator)(configuration);
|
|
112
|
+
return {
|
|
113
|
+
/**
|
|
114
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
115
|
+
* @summary Can I open this document, or ask for it?
|
|
116
|
+
* @param {string} documentId
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
myAccessToDocument(documentId, options) {
|
|
121
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
122
|
+
var _a, _b, _c;
|
|
123
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.myAccessToDocument(documentId, options);
|
|
124
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
125
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccessRequestsApi.myAccessToDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
126
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
127
|
+
});
|
|
128
|
+
},
|
|
129
|
+
/**
|
|
130
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
131
|
+
* @summary Ask the owner for access
|
|
132
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
requestAccess(accessRequestInput, options) {
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
var _a, _b, _c;
|
|
139
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.requestAccess(accessRequestInput, options);
|
|
140
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
141
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AccessRequestsApi.requestAccess']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
142
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143
|
+
});
|
|
144
|
+
},
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
exports.AccessRequestsApiFp = AccessRequestsApiFp;
|
|
148
|
+
/**
|
|
149
|
+
* AccessRequestsApi - factory interface
|
|
150
|
+
*/
|
|
151
|
+
const AccessRequestsApiFactory = function (configuration, basePath, axios) {
|
|
152
|
+
const localVarFp = (0, exports.AccessRequestsApiFp)(configuration);
|
|
153
|
+
return {
|
|
154
|
+
/**
|
|
155
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
156
|
+
* @summary Can I open this document, or ask for it?
|
|
157
|
+
* @param {string} documentId
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
myAccessToDocument(documentId, options) {
|
|
162
|
+
return localVarFp.myAccessToDocument(documentId, options).then((request) => request(axios, basePath));
|
|
163
|
+
},
|
|
164
|
+
/**
|
|
165
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
166
|
+
* @summary Ask the owner for access
|
|
167
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
requestAccess(accessRequestInput, options) {
|
|
172
|
+
return localVarFp.requestAccess(accessRequestInput, options).then((request) => request(axios, basePath));
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
exports.AccessRequestsApiFactory = AccessRequestsApiFactory;
|
|
177
|
+
/**
|
|
178
|
+
* AccessRequestsApi - object-oriented interface
|
|
179
|
+
*/
|
|
180
|
+
class AccessRequestsApi extends base_1.BaseAPI {
|
|
181
|
+
/**
|
|
182
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
183
|
+
* @summary Can I open this document, or ask for it?
|
|
184
|
+
* @param {string} documentId
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
myAccessToDocument(documentId, options) {
|
|
189
|
+
return (0, exports.AccessRequestsApiFp)(this.configuration).myAccessToDocument(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
193
|
+
* @summary Ask the owner for access
|
|
194
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
requestAccess(accessRequestInput, options) {
|
|
199
|
+
return (0, exports.AccessRequestsApiFp)(this.configuration).requestAccess(accessRequestInput, options).then((request) => request(this.axios, this.basePath));
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
exports.AccessRequestsApi = AccessRequestsApi;
|
|
@@ -14,6 +14,7 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import type { CreateTeamRequest } from '../models';
|
|
16
16
|
import type { DeleteShareRequest } from '../models';
|
|
17
|
+
import type { ShareExpiryRequest } from '../models';
|
|
17
18
|
import type { ShareRequest } from '../models';
|
|
18
19
|
import type { ShareResultResponse } from '../models';
|
|
19
20
|
import type { TeamMemberInfo } from '../models';
|
|
@@ -42,7 +43,7 @@ export declare const CollaborationControllerApiAxiosParamCreator: (configuration
|
|
|
42
43
|
*/
|
|
43
44
|
addTeamMembers: (teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
45
|
/**
|
|
45
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
46
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
46
47
|
* @summary Create Share for document(s)
|
|
47
48
|
* @param {ShareRequest} shareRequest
|
|
48
49
|
* @param {*} [options] Override http request option.
|
|
@@ -121,6 +122,14 @@ export declare const CollaborationControllerApiAxiosParamCreator: (configuration
|
|
|
121
122
|
* @throws {RequiredError}
|
|
122
123
|
*/
|
|
123
124
|
removeTeamMembers: (teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
|
+
/**
|
|
126
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
127
|
+
* @summary Set, change or remove the end date of share(s)
|
|
128
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
updateShareExpiry: (shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
133
|
/**
|
|
125
134
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
126
135
|
* @summary Update Share for document(s)
|
|
@@ -170,7 +179,7 @@ export declare const CollaborationControllerApiFp: (configuration?: Configuratio
|
|
|
170
179
|
*/
|
|
171
180
|
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
172
181
|
/**
|
|
173
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
182
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
174
183
|
* @summary Create Share for document(s)
|
|
175
184
|
* @param {ShareRequest} shareRequest
|
|
176
185
|
* @param {*} [options] Override http request option.
|
|
@@ -249,6 +258,14 @@ export declare const CollaborationControllerApiFp: (configuration?: Configuratio
|
|
|
249
258
|
* @throws {RequiredError}
|
|
250
259
|
*/
|
|
251
260
|
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
261
|
+
/**
|
|
262
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
263
|
+
* @summary Set, change or remove the end date of share(s)
|
|
264
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
265
|
+
* @param {*} [options] Override http request option.
|
|
266
|
+
* @throws {RequiredError}
|
|
267
|
+
*/
|
|
268
|
+
updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>>;
|
|
252
269
|
/**
|
|
253
270
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
254
271
|
* @summary Update Share for document(s)
|
|
@@ -298,7 +315,7 @@ export declare const CollaborationControllerApiFactory: (configuration?: Configu
|
|
|
298
315
|
*/
|
|
299
316
|
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
300
317
|
/**
|
|
301
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
318
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
302
319
|
* @summary Create Share for document(s)
|
|
303
320
|
* @param {ShareRequest} shareRequest
|
|
304
321
|
* @param {*} [options] Override http request option.
|
|
@@ -377,6 +394,14 @@ export declare const CollaborationControllerApiFactory: (configuration?: Configu
|
|
|
377
394
|
* @throws {RequiredError}
|
|
378
395
|
*/
|
|
379
396
|
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
397
|
+
/**
|
|
398
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
399
|
+
* @summary Set, change or remove the end date of share(s)
|
|
400
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse>;
|
|
380
405
|
/**
|
|
381
406
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
382
407
|
* @summary Update Share for document(s)
|
|
@@ -426,7 +451,7 @@ export declare class CollaborationControllerApi extends BaseAPI {
|
|
|
426
451
|
*/
|
|
427
452
|
addTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
428
453
|
/**
|
|
429
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
454
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
430
455
|
* @summary Create Share for document(s)
|
|
431
456
|
* @param {ShareRequest} shareRequest
|
|
432
457
|
* @param {*} [options] Override http request option.
|
|
@@ -505,6 +530,14 @@ export declare class CollaborationControllerApi extends BaseAPI {
|
|
|
505
530
|
* @throws {RequiredError}
|
|
506
531
|
*/
|
|
507
532
|
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
533
|
+
/**
|
|
534
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
535
|
+
* @summary Set, change or remove the end date of share(s)
|
|
536
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
537
|
+
* @param {*} [options] Override http request option.
|
|
538
|
+
* @throws {RequiredError}
|
|
539
|
+
*/
|
|
540
|
+
updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShareResultResponse, any, {}, any>>;
|
|
508
541
|
/**
|
|
509
542
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
510
543
|
* @summary Update Share for document(s)
|