@openfilz-sdk/typescript-ee 1.14.7 → 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 +8 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +8 -2
- package/api/access-requests-api.ts +203 -0
- package/api/collaboration-controller-api.ts +79 -4
- 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.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.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 +3 -0
- package/dist/esm/models/index.js +3 -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 +3 -0
- package/dist/models/index.js +3 -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/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 +3 -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
|
@@ -0,0 +1,195 @@
|
|
|
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
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import globalAxios from 'axios';
|
|
24
|
+
// Some imports not used depending on template conditions
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
29
|
+
/**
|
|
30
|
+
* AccessRequestsApi - axios parameter creator
|
|
31
|
+
*/
|
|
32
|
+
export const AccessRequestsApiAxiosParamCreator = function (configuration) {
|
|
33
|
+
return {
|
|
34
|
+
/**
|
|
35
|
+
* 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.
|
|
36
|
+
* @summary Can I open this document, or ask for it?
|
|
37
|
+
* @param {string} documentId
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
myAccessToDocument: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
|
|
42
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
43
|
+
assertParamExists('myAccessToDocument', 'documentId', documentId);
|
|
44
|
+
const localVarPath = `/api/v1/users/me/access-requests/{documentId}`
|
|
45
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
if (configuration) {
|
|
50
|
+
baseOptions = configuration.baseOptions;
|
|
51
|
+
}
|
|
52
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
53
|
+
const localVarHeaderParameter = {};
|
|
54
|
+
const localVarQueryParameter = {};
|
|
55
|
+
// authentication keycloak_auth required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
58
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
59
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
61
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
62
|
+
return {
|
|
63
|
+
url: toPathString(localVarUrlObj),
|
|
64
|
+
options: localVarRequestOptions,
|
|
65
|
+
};
|
|
66
|
+
}),
|
|
67
|
+
/**
|
|
68
|
+
* 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.
|
|
69
|
+
* @summary Ask the owner for access
|
|
70
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
requestAccess: (accessRequestInput_1, ...args_1) => __awaiter(this, [accessRequestInput_1, ...args_1], void 0, function* (accessRequestInput, options = {}) {
|
|
75
|
+
// verify required parameter 'accessRequestInput' is not null or undefined
|
|
76
|
+
assertParamExists('requestAccess', 'accessRequestInput', accessRequestInput);
|
|
77
|
+
const localVarPath = `/api/v1/users/me/access-requests`;
|
|
78
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
79
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
80
|
+
let baseOptions;
|
|
81
|
+
if (configuration) {
|
|
82
|
+
baseOptions = configuration.baseOptions;
|
|
83
|
+
}
|
|
84
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85
|
+
const localVarHeaderParameter = {};
|
|
86
|
+
const localVarQueryParameter = {};
|
|
87
|
+
// authentication keycloak_auth required
|
|
88
|
+
// http bearer authentication required
|
|
89
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
90
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
91
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
92
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
93
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
94
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
95
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessRequestInput, localVarRequestOptions, configuration);
|
|
96
|
+
return {
|
|
97
|
+
url: toPathString(localVarUrlObj),
|
|
98
|
+
options: localVarRequestOptions,
|
|
99
|
+
};
|
|
100
|
+
}),
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* AccessRequestsApi - functional programming interface
|
|
105
|
+
*/
|
|
106
|
+
export const AccessRequestsApiFp = function (configuration) {
|
|
107
|
+
const localVarAxiosParamCreator = AccessRequestsApiAxiosParamCreator(configuration);
|
|
108
|
+
return {
|
|
109
|
+
/**
|
|
110
|
+
* 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.
|
|
111
|
+
* @summary Can I open this document, or ask for it?
|
|
112
|
+
* @param {string} documentId
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
myAccessToDocument(documentId, options) {
|
|
117
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
118
|
+
var _a, _b, _c;
|
|
119
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.myAccessToDocument(documentId, options);
|
|
120
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
121
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessRequestsApi.myAccessToDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
122
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
123
|
+
});
|
|
124
|
+
},
|
|
125
|
+
/**
|
|
126
|
+
* 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.
|
|
127
|
+
* @summary Ask the owner for access
|
|
128
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
requestAccess(accessRequestInput, options) {
|
|
133
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
134
|
+
var _a, _b, _c;
|
|
135
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.requestAccess(accessRequestInput, options);
|
|
136
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
137
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccessRequestsApi.requestAccess']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
138
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
139
|
+
});
|
|
140
|
+
},
|
|
141
|
+
};
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* AccessRequestsApi - factory interface
|
|
145
|
+
*/
|
|
146
|
+
export const AccessRequestsApiFactory = function (configuration, basePath, axios) {
|
|
147
|
+
const localVarFp = AccessRequestsApiFp(configuration);
|
|
148
|
+
return {
|
|
149
|
+
/**
|
|
150
|
+
* 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.
|
|
151
|
+
* @summary Can I open this document, or ask for it?
|
|
152
|
+
* @param {string} documentId
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
myAccessToDocument(documentId, options) {
|
|
157
|
+
return localVarFp.myAccessToDocument(documentId, options).then((request) => request(axios, basePath));
|
|
158
|
+
},
|
|
159
|
+
/**
|
|
160
|
+
* 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.
|
|
161
|
+
* @summary Ask the owner for access
|
|
162
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
requestAccess(accessRequestInput, options) {
|
|
167
|
+
return localVarFp.requestAccess(accessRequestInput, options).then((request) => request(axios, basePath));
|
|
168
|
+
},
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
/**
|
|
172
|
+
* AccessRequestsApi - object-oriented interface
|
|
173
|
+
*/
|
|
174
|
+
export class AccessRequestsApi extends BaseAPI {
|
|
175
|
+
/**
|
|
176
|
+
* 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.
|
|
177
|
+
* @summary Can I open this document, or ask for it?
|
|
178
|
+
* @param {string} documentId
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
myAccessToDocument(documentId, options) {
|
|
183
|
+
return AccessRequestsApiFp(this.configuration).myAccessToDocument(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* 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.
|
|
187
|
+
* @summary Ask the owner for access
|
|
188
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
requestAccess(accessRequestInput, options) {
|
|
193
|
+
return AccessRequestsApiFp(this.configuration).requestAccess(accessRequestInput, options).then((request) => request(this.axios, this.basePath));
|
|
194
|
+
}
|
|
195
|
+
}
|
|
@@ -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)
|
|
@@ -102,7 +102,7 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
|
|
|
102
102
|
};
|
|
103
103
|
}),
|
|
104
104
|
/**
|
|
105
|
-
* 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
|
|
105
|
+
* 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.
|
|
106
106
|
* @summary Create Share for document(s)
|
|
107
107
|
* @param {ShareRequest} shareRequest
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -431,6 +431,40 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
|
|
|
431
431
|
options: localVarRequestOptions,
|
|
432
432
|
};
|
|
433
433
|
}),
|
|
434
|
+
/**
|
|
435
|
+
* 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
|
|
436
|
+
* @summary Set, change or remove the end date of share(s)
|
|
437
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
*/
|
|
441
|
+
updateShareExpiry: (shareExpiryRequest_1, ...args_1) => __awaiter(this, [shareExpiryRequest_1, ...args_1], void 0, function* (shareExpiryRequest, options = {}) {
|
|
442
|
+
// verify required parameter 'shareExpiryRequest' is not null or undefined
|
|
443
|
+
assertParamExists('updateShareExpiry', 'shareExpiryRequest', shareExpiryRequest);
|
|
444
|
+
const localVarPath = `/api/v1/users/share/expiry`;
|
|
445
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
446
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
447
|
+
let baseOptions;
|
|
448
|
+
if (configuration) {
|
|
449
|
+
baseOptions = configuration.baseOptions;
|
|
450
|
+
}
|
|
451
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
452
|
+
const localVarHeaderParameter = {};
|
|
453
|
+
const localVarQueryParameter = {};
|
|
454
|
+
// authentication keycloak_auth required
|
|
455
|
+
// http bearer authentication required
|
|
456
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
457
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
458
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
459
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
460
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
461
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
462
|
+
localVarRequestOptions.data = serializeDataIfNeeded(shareExpiryRequest, localVarRequestOptions, configuration);
|
|
463
|
+
return {
|
|
464
|
+
url: toPathString(localVarUrlObj),
|
|
465
|
+
options: localVarRequestOptions,
|
|
466
|
+
};
|
|
467
|
+
}),
|
|
434
468
|
/**
|
|
435
469
|
* 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
|
|
436
470
|
* @summary Update Share for document(s)
|
|
@@ -581,7 +615,7 @@ export const CollaborationControllerApiFp = function (configuration) {
|
|
|
581
615
|
});
|
|
582
616
|
},
|
|
583
617
|
/**
|
|
584
|
-
* 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
|
|
618
|
+
* 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.
|
|
585
619
|
* @summary Create Share for document(s)
|
|
586
620
|
* @param {ShareRequest} shareRequest
|
|
587
621
|
* @param {*} [options] Override http request option.
|
|
@@ -740,6 +774,22 @@ export const CollaborationControllerApiFp = function (configuration) {
|
|
|
740
774
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
741
775
|
});
|
|
742
776
|
},
|
|
777
|
+
/**
|
|
778
|
+
* 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
|
|
779
|
+
* @summary Set, change or remove the end date of share(s)
|
|
780
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
781
|
+
* @param {*} [options] Override http request option.
|
|
782
|
+
* @throws {RequiredError}
|
|
783
|
+
*/
|
|
784
|
+
updateShareExpiry(shareExpiryRequest, options) {
|
|
785
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
786
|
+
var _a, _b, _c;
|
|
787
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateShareExpiry(shareExpiryRequest, options);
|
|
788
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
789
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CollaborationControllerApi.updateShareExpiry']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
790
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
791
|
+
});
|
|
792
|
+
},
|
|
743
793
|
/**
|
|
744
794
|
* 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
|
|
745
795
|
* @summary Update Share for document(s)
|
|
@@ -820,7 +870,7 @@ export const CollaborationControllerApiFactory = function (configuration, basePa
|
|
|
820
870
|
return localVarFp.addTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
|
|
821
871
|
},
|
|
822
872
|
/**
|
|
823
|
-
* 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
|
|
873
|
+
* 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.
|
|
824
874
|
* @summary Create Share for document(s)
|
|
825
875
|
* @param {ShareRequest} shareRequest
|
|
826
876
|
* @param {*} [options] Override http request option.
|
|
@@ -919,6 +969,16 @@ export const CollaborationControllerApiFactory = function (configuration, basePa
|
|
|
919
969
|
removeTeamMembers(teamId, requestBody, options) {
|
|
920
970
|
return localVarFp.removeTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
|
|
921
971
|
},
|
|
972
|
+
/**
|
|
973
|
+
* 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
|
|
974
|
+
* @summary Set, change or remove the end date of share(s)
|
|
975
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
976
|
+
* @param {*} [options] Override http request option.
|
|
977
|
+
* @throws {RequiredError}
|
|
978
|
+
*/
|
|
979
|
+
updateShareExpiry(shareExpiryRequest, options) {
|
|
980
|
+
return localVarFp.updateShareExpiry(shareExpiryRequest, options).then((request) => request(axios, basePath));
|
|
981
|
+
},
|
|
922
982
|
/**
|
|
923
983
|
* 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
|
|
924
984
|
* @summary Update Share for document(s)
|
|
@@ -979,7 +1039,7 @@ export class CollaborationControllerApi extends BaseAPI {
|
|
|
979
1039
|
return CollaborationControllerApiFp(this.configuration).addTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
980
1040
|
}
|
|
981
1041
|
/**
|
|
982
|
-
* 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
|
|
1042
|
+
* 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.
|
|
983
1043
|
* @summary Create Share for document(s)
|
|
984
1044
|
* @param {ShareRequest} shareRequest
|
|
985
1045
|
* @param {*} [options] Override http request option.
|
|
@@ -1078,6 +1138,16 @@ export class CollaborationControllerApi extends BaseAPI {
|
|
|
1078
1138
|
removeTeamMembers(teamId, requestBody, options) {
|
|
1079
1139
|
return CollaborationControllerApiFp(this.configuration).removeTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
1080
1140
|
}
|
|
1141
|
+
/**
|
|
1142
|
+
* 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
|
|
1143
|
+
* @summary Set, change or remove the end date of share(s)
|
|
1144
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
1145
|
+
* @param {*} [options] Override http request option.
|
|
1146
|
+
* @throws {RequiredError}
|
|
1147
|
+
*/
|
|
1148
|
+
updateShareExpiry(shareExpiryRequest, options) {
|
|
1149
|
+
return CollaborationControllerApiFp(this.configuration).updateShareExpiry(shareExpiryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1150
|
+
}
|
|
1081
1151
|
/**
|
|
1082
1152
|
* 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
|
|
1083
1153
|
* @summary Update Share for document(s)
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export * from './api/aimaintenance-api';
|
|
|
18
18
|
export * from './api/aisettings-api';
|
|
19
19
|
export * from './api/aitaxonomy-api';
|
|
20
20
|
export * from './api/aiteam-inboxes-api';
|
|
21
|
+
export * from './api/access-requests-api';
|
|
21
22
|
export * from './api/ai-analytics-admin-controller-api';
|
|
22
23
|
export * from './api/ai-archiving-admin-controller-api';
|
|
23
24
|
export * from './api/ai-cloud-usage-admin-controller-api';
|
package/dist/esm/api.js
CHANGED
|
@@ -20,6 +20,7 @@ export * from './api/aimaintenance-api';
|
|
|
20
20
|
export * from './api/aisettings-api';
|
|
21
21
|
export * from './api/aitaxonomy-api';
|
|
22
22
|
export * from './api/aiteam-inboxes-api';
|
|
23
|
+
export * from './api/access-requests-api';
|
|
23
24
|
export * from './api/ai-analytics-admin-controller-api';
|
|
24
25
|
export * from './api/ai-archiving-admin-controller-api';
|
|
25
26
|
export * from './api/ai-cloud-usage-admin-controller-api';
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
export interface AccessRequestInput {
|
|
13
|
+
/**
|
|
14
|
+
* The document (file or folder) the caller asks access to
|
|
15
|
+
*/
|
|
16
|
+
'documentId': string;
|
|
17
|
+
/**
|
|
18
|
+
* The access asked for; READER when absent
|
|
19
|
+
*/
|
|
20
|
+
'shareMode'?: AccessRequestInputShareModeEnum;
|
|
21
|
+
/**
|
|
22
|
+
* Optional note to the owner
|
|
23
|
+
*/
|
|
24
|
+
'message'?: string;
|
|
25
|
+
}
|
|
26
|
+
export declare const AccessRequestInputShareModeEnum: {
|
|
27
|
+
readonly Reader: "READER";
|
|
28
|
+
readonly Commenter: "COMMENTER";
|
|
29
|
+
readonly Editor: "EDITOR";
|
|
30
|
+
};
|
|
31
|
+
export type AccessRequestInputShareModeEnum = typeof AccessRequestInputShareModeEnum[keyof typeof AccessRequestInputShareModeEnum];
|
|
@@ -0,0 +1,18 @@
|
|
|
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
|
+
export const AccessRequestInputShareModeEnum = {
|
|
15
|
+
Reader: 'READER',
|
|
16
|
+
Commenter: 'COMMENTER',
|
|
17
|
+
Editor: 'EDITOR',
|
|
18
|
+
};
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
export interface AccessRequestStatus {
|
|
13
|
+
'documentId'?: string;
|
|
14
|
+
'state'?: AccessRequestStatusStateEnum;
|
|
15
|
+
/**
|
|
16
|
+
* PENDING: the access asked for
|
|
17
|
+
*/
|
|
18
|
+
'requestedMode'?: AccessRequestStatusRequestedModeEnum;
|
|
19
|
+
/**
|
|
20
|
+
* PENDING: when the owner was last asked
|
|
21
|
+
*/
|
|
22
|
+
'requestedAt'?: string;
|
|
23
|
+
}
|
|
24
|
+
export declare const AccessRequestStatusStateEnum: {
|
|
25
|
+
readonly HasAccess: "HAS_ACCESS";
|
|
26
|
+
readonly NoAccess: "NO_ACCESS";
|
|
27
|
+
readonly Pending: "PENDING";
|
|
28
|
+
readonly OwnerCannotShare: "OWNER_CANNOT_SHARE";
|
|
29
|
+
};
|
|
30
|
+
export type AccessRequestStatusStateEnum = typeof AccessRequestStatusStateEnum[keyof typeof AccessRequestStatusStateEnum];
|
|
31
|
+
export declare const AccessRequestStatusRequestedModeEnum: {
|
|
32
|
+
readonly Reader: "READER";
|
|
33
|
+
readonly Commenter: "COMMENTER";
|
|
34
|
+
readonly Editor: "EDITOR";
|
|
35
|
+
};
|
|
36
|
+
export type AccessRequestStatusRequestedModeEnum = typeof AccessRequestStatusRequestedModeEnum[keyof typeof AccessRequestStatusRequestedModeEnum];
|
|
@@ -0,0 +1,24 @@
|
|
|
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
|
+
export const AccessRequestStatusStateEnum = {
|
|
15
|
+
HasAccess: 'HAS_ACCESS',
|
|
16
|
+
NoAccess: 'NO_ACCESS',
|
|
17
|
+
Pending: 'PENDING',
|
|
18
|
+
OwnerCannotShare: 'OWNER_CANNOT_SHARE',
|
|
19
|
+
};
|
|
20
|
+
export const AccessRequestStatusRequestedModeEnum = {
|
|
21
|
+
Reader: 'READER',
|
|
22
|
+
Commenter: 'COMMENTER',
|
|
23
|
+
Editor: 'EDITOR',
|
|
24
|
+
};
|
|
@@ -69,6 +69,7 @@ export declare const EnrichedAuditLogActionEnum: {
|
|
|
69
69
|
readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
|
|
70
70
|
readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
|
|
71
71
|
readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
|
|
72
|
+
readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
|
|
72
73
|
readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
|
|
73
74
|
readonly TeamCreated: "TEAM_CREATED";
|
|
74
75
|
readonly TeamUpdated: "TEAM_UPDATED";
|
|
@@ -55,6 +55,7 @@ export const EnrichedAuditLogActionEnum = {
|
|
|
55
55
|
ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
|
|
56
56
|
ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
|
|
57
57
|
ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
|
|
58
|
+
ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
|
|
58
59
|
ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
|
|
59
60
|
TeamCreated: 'TEAM_CREATED',
|
|
60
61
|
TeamUpdated: 'TEAM_UPDATED',
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
export * from './access-request-input';
|
|
2
|
+
export * from './access-request-status';
|
|
1
3
|
export * from './add-team-owner-request';
|
|
2
4
|
export * from './ai-analytics-view';
|
|
3
5
|
export * from './ai-chat-conversation';
|
|
@@ -176,6 +178,7 @@ export * from './search-by-metadata-request';
|
|
|
176
178
|
export * from './search-metadata-request';
|
|
177
179
|
export * from './setting-dto';
|
|
178
180
|
export * from './settings';
|
|
181
|
+
export * from './share-expiry-request';
|
|
179
182
|
export * from './share-inheritance';
|
|
180
183
|
export * from './share-inheritance-request';
|
|
181
184
|
export * from './share-request';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
export * from './access-request-input';
|
|
2
|
+
export * from './access-request-status';
|
|
1
3
|
export * from './add-team-owner-request';
|
|
2
4
|
export * from './ai-analytics-view';
|
|
3
5
|
export * from './ai-chat-conversation';
|
|
@@ -176,6 +178,7 @@ export * from './search-by-metadata-request';
|
|
|
176
178
|
export * from './search-metadata-request';
|
|
177
179
|
export * from './setting-dto';
|
|
178
180
|
export * from './settings';
|
|
181
|
+
export * from './share-expiry-request';
|
|
179
182
|
export * from './share-inheritance';
|
|
180
183
|
export * from './share-inheritance-request';
|
|
181
184
|
export * from './share-request';
|