@openfilz-sdk/typescript-ee 1.12.17 → 1.12.18
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 +18 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +21 -2
- package/api/ownership-api.ts +1076 -0
- package/api/sharing-api.ts +210 -0
- package/api.ts +2 -0
- package/dist/api/ownership-api.d.ts +505 -0
- package/dist/api/ownership-api.js +1015 -0
- package/dist/api/sharing-api.d.ts +104 -0
- package/dist/api/sharing-api.js +209 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/ownership-api.d.ts +505 -0
- package/dist/esm/api/ownership-api.js +1008 -0
- package/dist/esm/api/sharing-api.d.ts +104 -0
- package/dist/esm/api/sharing-api.js +202 -0
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/enriched-audit-log.d.ts +9 -0
- package/dist/esm/models/enriched-audit-log.js +9 -0
- package/dist/esm/models/index.d.ts +7 -0
- package/dist/esm/models/index.js +7 -0
- package/dist/esm/models/notification-dto.d.ts +2 -0
- package/dist/esm/models/notification-dto.js +2 -0
- package/dist/esm/models/owned-document.d.ts +25 -0
- package/dist/esm/models/owned-document.js +17 -0
- package/dist/esm/models/owned-documents-filter.d.ts +45 -0
- package/dist/esm/models/owned-documents-filter.js +17 -0
- package/dist/esm/models/ownership-transfer-report.d.ts +29 -0
- package/dist/esm/models/ownership-transfer-report.js +14 -0
- package/dist/esm/models/ownership-transfer-request.d.ts +53 -0
- package/dist/esm/models/ownership-transfer-request.js +18 -0
- package/dist/esm/models/quota-check.d.ts +17 -0
- package/dist/esm/models/quota-check.js +14 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +9 -0
- package/dist/esm/models/search-by-audit-log-request.js +9 -0
- package/dist/esm/models/share-inheritance-request.d.ts +14 -0
- package/dist/esm/models/share-inheritance-request.js +14 -0
- package/dist/esm/models/share-inheritance.d.ts +16 -0
- package/dist/esm/models/share-inheritance.js +14 -0
- package/dist/esm/models/user-registration-request.d.ts +1 -0
- package/dist/models/enriched-audit-log.d.ts +9 -0
- package/dist/models/enriched-audit-log.js +9 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/notification-dto.d.ts +2 -0
- package/dist/models/notification-dto.js +2 -0
- package/dist/models/owned-document.d.ts +25 -0
- package/dist/models/owned-document.js +20 -0
- package/dist/models/owned-documents-filter.d.ts +45 -0
- package/dist/models/owned-documents-filter.js +20 -0
- package/dist/models/ownership-transfer-report.d.ts +29 -0
- package/dist/models/ownership-transfer-report.js +15 -0
- package/dist/models/ownership-transfer-request.d.ts +53 -0
- package/dist/models/ownership-transfer-request.js +21 -0
- package/dist/models/quota-check.d.ts +17 -0
- package/dist/models/quota-check.js +15 -0
- package/dist/models/search-by-audit-log-request.d.ts +9 -0
- package/dist/models/search-by-audit-log-request.js +9 -0
- package/dist/models/share-inheritance-request.d.ts +14 -0
- package/dist/models/share-inheritance-request.js +15 -0
- package/dist/models/share-inheritance.d.ts +16 -0
- package/dist/models/share-inheritance.js +15 -0
- package/dist/models/user-registration-request.d.ts +1 -0
- package/docs/OwnedDocument.md +32 -0
- package/docs/OwnedDocumentsFilter.md +31 -0
- package/docs/OwnershipApi.md +621 -0
- package/docs/OwnershipTransferReport.md +48 -0
- package/docs/OwnershipTransferRequest.md +37 -0
- package/docs/QuotaCheck.md +26 -0
- package/docs/ShareInheritance.md +24 -0
- package/docs/ShareInheritanceRequest.md +20 -0
- package/docs/SharingApi.md +114 -0
- package/docs/UserRegistrationRequest.md +2 -0
- package/models/enriched-audit-log-details.ts +26 -0
- package/models/enriched-audit-log.ts +9 -0
- package/models/index.ts +7 -0
- package/models/notification-dto.ts +2 -0
- package/models/owned-document.ts +34 -0
- package/models/owned-documents-filter.ts +54 -0
- package/models/ownership-transfer-report.ts +37 -0
- package/models/ownership-transfer-request.ts +64 -0
- package/models/quota-check.ts +23 -0
- package/models/search-by-audit-log-request.ts +9 -0
- package/models/share-inheritance-request.ts +20 -0
- package/models/share-inheritance.ts +22 -0
- package/models/user-registration-request.ts +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,505 @@
|
|
|
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 { OwnedDocument } from '../models';
|
|
16
|
+
import type { OwnershipTransferReport } from '../models';
|
|
17
|
+
import type { OwnershipTransferRequest } from '../models';
|
|
18
|
+
/**
|
|
19
|
+
* OwnershipApi - axios parameter creator
|
|
20
|
+
*/
|
|
21
|
+
export declare const OwnershipApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
25
|
+
* @param {string} userId
|
|
26
|
+
* @param {string} [parentId]
|
|
27
|
+
* @param {boolean} [recursive]
|
|
28
|
+
* @param {AdminCountOwnedDocumentsTypeEnum} [type]
|
|
29
|
+
* @param {string} [name]
|
|
30
|
+
* @param {string} [updatedAfter]
|
|
31
|
+
* @param {string} [updatedBefore]
|
|
32
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
adminCountOwnedDocuments: (userId: string, parentId?: string, recursive?: boolean, type?: AdminCountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @summary A transfer\'s progress and outcome
|
|
40
|
+
* @param {string} jobId
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
adminGetOwnershipTransfer: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
47
|
+
* @summary List the documents a user owns
|
|
48
|
+
* @param {string} userId
|
|
49
|
+
* @param {string} [parentId]
|
|
50
|
+
* @param {boolean} [recursive]
|
|
51
|
+
* @param {AdminListOwnedDocumentsTypeEnum} [type]
|
|
52
|
+
* @param {string} [name]
|
|
53
|
+
* @param {string} [updatedAfter]
|
|
54
|
+
* @param {string} [updatedBefore]
|
|
55
|
+
* @param {number} [page]
|
|
56
|
+
* @param {number} [size]
|
|
57
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
58
|
+
* @param {*} [options] Override http request option.
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
adminListOwnedDocuments: (userId: string, parentId?: string, recursive?: boolean, type?: AdminListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @summary The last 50 transfers from or to a user
|
|
65
|
+
* @param {string} userId
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
adminListOwnershipTransfers: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
+
/**
|
|
71
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
72
|
+
* @summary Transfer documents to another user
|
|
73
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
adminTransferOwnership: (ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
81
|
+
* @param {string} userId
|
|
82
|
+
* @param {string} [parentId]
|
|
83
|
+
* @param {boolean} [recursive]
|
|
84
|
+
* @param {CountOwnedDocumentsTypeEnum} [type]
|
|
85
|
+
* @param {string} [name]
|
|
86
|
+
* @param {string} [updatedAfter]
|
|
87
|
+
* @param {string} [updatedBefore]
|
|
88
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
countOwnedDocuments: (userId: string, parentId?: string, recursive?: boolean, type?: CountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @summary A transfer\'s progress and outcome
|
|
96
|
+
* @param {string} jobId
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
getOwnershipTransfer: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
|
+
/**
|
|
102
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
103
|
+
* @summary List the documents a user owns
|
|
104
|
+
* @param {string} userId
|
|
105
|
+
* @param {string} [parentId]
|
|
106
|
+
* @param {boolean} [recursive]
|
|
107
|
+
* @param {ListOwnedDocumentsTypeEnum} [type]
|
|
108
|
+
* @param {string} [name]
|
|
109
|
+
* @param {string} [updatedAfter]
|
|
110
|
+
* @param {string} [updatedBefore]
|
|
111
|
+
* @param {number} [page]
|
|
112
|
+
* @param {number} [size]
|
|
113
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
listOwnedDocuments: (userId: string, parentId?: string, recursive?: boolean, type?: ListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @summary The last 50 transfers from or to a user
|
|
121
|
+
* @param {string} userId
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
listOwnershipTransfers: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
126
|
+
/**
|
|
127
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
128
|
+
* @summary Transfer documents to another user
|
|
129
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
transferOwnership: (ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* OwnershipApi - functional programming interface
|
|
137
|
+
*/
|
|
138
|
+
export declare const OwnershipApiFp: (configuration?: Configuration) => {
|
|
139
|
+
/**
|
|
140
|
+
*
|
|
141
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
142
|
+
* @param {string} userId
|
|
143
|
+
* @param {string} [parentId]
|
|
144
|
+
* @param {boolean} [recursive]
|
|
145
|
+
* @param {AdminCountOwnedDocumentsTypeEnum} [type]
|
|
146
|
+
* @param {string} [name]
|
|
147
|
+
* @param {string} [updatedAfter]
|
|
148
|
+
* @param {string} [updatedBefore]
|
|
149
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
adminCountOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminCountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @summary A transfer\'s progress and outcome
|
|
157
|
+
* @param {string} jobId
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
adminGetOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipTransferReport>>;
|
|
162
|
+
/**
|
|
163
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
164
|
+
* @summary List the documents a user owns
|
|
165
|
+
* @param {string} userId
|
|
166
|
+
* @param {string} [parentId]
|
|
167
|
+
* @param {boolean} [recursive]
|
|
168
|
+
* @param {AdminListOwnedDocumentsTypeEnum} [type]
|
|
169
|
+
* @param {string} [name]
|
|
170
|
+
* @param {string} [updatedAfter]
|
|
171
|
+
* @param {string} [updatedBefore]
|
|
172
|
+
* @param {number} [page]
|
|
173
|
+
* @param {number} [size]
|
|
174
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
*/
|
|
178
|
+
adminListOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnedDocument>>>;
|
|
179
|
+
/**
|
|
180
|
+
*
|
|
181
|
+
* @summary The last 50 transfers from or to a user
|
|
182
|
+
* @param {string} userId
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnershipTransferReport>>>;
|
|
187
|
+
/**
|
|
188
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
189
|
+
* @summary Transfer documents to another user
|
|
190
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
adminTransferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipTransferReport>>;
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
198
|
+
* @param {string} userId
|
|
199
|
+
* @param {string} [parentId]
|
|
200
|
+
* @param {boolean} [recursive]
|
|
201
|
+
* @param {CountOwnedDocumentsTypeEnum} [type]
|
|
202
|
+
* @param {string} [name]
|
|
203
|
+
* @param {string} [updatedAfter]
|
|
204
|
+
* @param {string} [updatedBefore]
|
|
205
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
countOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: CountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @summary A transfer\'s progress and outcome
|
|
213
|
+
* @param {string} jobId
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
*/
|
|
217
|
+
getOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipTransferReport>>;
|
|
218
|
+
/**
|
|
219
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
220
|
+
* @summary List the documents a user owns
|
|
221
|
+
* @param {string} userId
|
|
222
|
+
* @param {string} [parentId]
|
|
223
|
+
* @param {boolean} [recursive]
|
|
224
|
+
* @param {ListOwnedDocumentsTypeEnum} [type]
|
|
225
|
+
* @param {string} [name]
|
|
226
|
+
* @param {string} [updatedAfter]
|
|
227
|
+
* @param {string} [updatedBefore]
|
|
228
|
+
* @param {number} [page]
|
|
229
|
+
* @param {number} [size]
|
|
230
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
231
|
+
* @param {*} [options] Override http request option.
|
|
232
|
+
* @throws {RequiredError}
|
|
233
|
+
*/
|
|
234
|
+
listOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: ListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnedDocument>>>;
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @summary The last 50 transfers from or to a user
|
|
238
|
+
* @param {string} userId
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnershipTransferReport>>>;
|
|
243
|
+
/**
|
|
244
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
245
|
+
* @summary Transfer documents to another user
|
|
246
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
transferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipTransferReport>>;
|
|
251
|
+
};
|
|
252
|
+
/**
|
|
253
|
+
* OwnershipApi - factory interface
|
|
254
|
+
*/
|
|
255
|
+
export declare const OwnershipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
259
|
+
* @param {string} userId
|
|
260
|
+
* @param {string} [parentId]
|
|
261
|
+
* @param {boolean} [recursive]
|
|
262
|
+
* @param {AdminCountOwnedDocumentsTypeEnum} [type]
|
|
263
|
+
* @param {string} [name]
|
|
264
|
+
* @param {string} [updatedAfter]
|
|
265
|
+
* @param {string} [updatedBefore]
|
|
266
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
267
|
+
* @param {*} [options] Override http request option.
|
|
268
|
+
* @throws {RequiredError}
|
|
269
|
+
*/
|
|
270
|
+
adminCountOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminCountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @summary A transfer\'s progress and outcome
|
|
274
|
+
* @param {string} jobId
|
|
275
|
+
* @param {*} [options] Override http request option.
|
|
276
|
+
* @throws {RequiredError}
|
|
277
|
+
*/
|
|
278
|
+
adminGetOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipTransferReport>;
|
|
279
|
+
/**
|
|
280
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
281
|
+
* @summary List the documents a user owns
|
|
282
|
+
* @param {string} userId
|
|
283
|
+
* @param {string} [parentId]
|
|
284
|
+
* @param {boolean} [recursive]
|
|
285
|
+
* @param {AdminListOwnedDocumentsTypeEnum} [type]
|
|
286
|
+
* @param {string} [name]
|
|
287
|
+
* @param {string} [updatedAfter]
|
|
288
|
+
* @param {string} [updatedBefore]
|
|
289
|
+
* @param {number} [page]
|
|
290
|
+
* @param {number} [size]
|
|
291
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
adminListOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnedDocument>>;
|
|
296
|
+
/**
|
|
297
|
+
*
|
|
298
|
+
* @summary The last 50 transfers from or to a user
|
|
299
|
+
* @param {string} userId
|
|
300
|
+
* @param {*} [options] Override http request option.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
*/
|
|
303
|
+
adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>>;
|
|
304
|
+
/**
|
|
305
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
306
|
+
* @summary Transfer documents to another user
|
|
307
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
308
|
+
* @param {*} [options] Override http request option.
|
|
309
|
+
* @throws {RequiredError}
|
|
310
|
+
*/
|
|
311
|
+
adminTransferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipTransferReport>;
|
|
312
|
+
/**
|
|
313
|
+
*
|
|
314
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
315
|
+
* @param {string} userId
|
|
316
|
+
* @param {string} [parentId]
|
|
317
|
+
* @param {boolean} [recursive]
|
|
318
|
+
* @param {CountOwnedDocumentsTypeEnum} [type]
|
|
319
|
+
* @param {string} [name]
|
|
320
|
+
* @param {string} [updatedAfter]
|
|
321
|
+
* @param {string} [updatedBefore]
|
|
322
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
323
|
+
* @param {*} [options] Override http request option.
|
|
324
|
+
* @throws {RequiredError}
|
|
325
|
+
*/
|
|
326
|
+
countOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: CountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): AxiosPromise<number>;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @summary A transfer\'s progress and outcome
|
|
330
|
+
* @param {string} jobId
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
getOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipTransferReport>;
|
|
335
|
+
/**
|
|
336
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
337
|
+
* @summary List the documents a user owns
|
|
338
|
+
* @param {string} userId
|
|
339
|
+
* @param {string} [parentId]
|
|
340
|
+
* @param {boolean} [recursive]
|
|
341
|
+
* @param {ListOwnedDocumentsTypeEnum} [type]
|
|
342
|
+
* @param {string} [name]
|
|
343
|
+
* @param {string} [updatedAfter]
|
|
344
|
+
* @param {string} [updatedBefore]
|
|
345
|
+
* @param {number} [page]
|
|
346
|
+
* @param {number} [size]
|
|
347
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
listOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: ListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnedDocument>>;
|
|
352
|
+
/**
|
|
353
|
+
*
|
|
354
|
+
* @summary The last 50 transfers from or to a user
|
|
355
|
+
* @param {string} userId
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
*/
|
|
359
|
+
listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>>;
|
|
360
|
+
/**
|
|
361
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
362
|
+
* @summary Transfer documents to another user
|
|
363
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
364
|
+
* @param {*} [options] Override http request option.
|
|
365
|
+
* @throws {RequiredError}
|
|
366
|
+
*/
|
|
367
|
+
transferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipTransferReport>;
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* OwnershipApi - object-oriented interface
|
|
371
|
+
*/
|
|
372
|
+
export declare class OwnershipApi extends BaseAPI {
|
|
373
|
+
/**
|
|
374
|
+
*
|
|
375
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
376
|
+
* @param {string} userId
|
|
377
|
+
* @param {string} [parentId]
|
|
378
|
+
* @param {boolean} [recursive]
|
|
379
|
+
* @param {AdminCountOwnedDocumentsTypeEnum} [type]
|
|
380
|
+
* @param {string} [name]
|
|
381
|
+
* @param {string} [updatedAfter]
|
|
382
|
+
* @param {string} [updatedBefore]
|
|
383
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
*/
|
|
387
|
+
adminCountOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminCountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any, {}, any>>;
|
|
388
|
+
/**
|
|
389
|
+
*
|
|
390
|
+
* @summary A transfer\'s progress and outcome
|
|
391
|
+
* @param {string} jobId
|
|
392
|
+
* @param {*} [options] Override http request option.
|
|
393
|
+
* @throws {RequiredError}
|
|
394
|
+
*/
|
|
395
|
+
adminGetOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport, any, {}, any>>;
|
|
396
|
+
/**
|
|
397
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
398
|
+
* @summary List the documents a user owns
|
|
399
|
+
* @param {string} userId
|
|
400
|
+
* @param {string} [parentId]
|
|
401
|
+
* @param {boolean} [recursive]
|
|
402
|
+
* @param {AdminListOwnedDocumentsTypeEnum} [type]
|
|
403
|
+
* @param {string} [name]
|
|
404
|
+
* @param {string} [updatedAfter]
|
|
405
|
+
* @param {string} [updatedBefore]
|
|
406
|
+
* @param {number} [page]
|
|
407
|
+
* @param {number} [size]
|
|
408
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
*/
|
|
412
|
+
adminListOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: AdminListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnedDocument[], any, {}, any>>;
|
|
413
|
+
/**
|
|
414
|
+
*
|
|
415
|
+
* @summary The last 50 transfers from or to a user
|
|
416
|
+
* @param {string} userId
|
|
417
|
+
* @param {*} [options] Override http request option.
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport[], any, {}, any>>;
|
|
421
|
+
/**
|
|
422
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
423
|
+
* @summary Transfer documents to another user
|
|
424
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
425
|
+
* @param {*} [options] Override http request option.
|
|
426
|
+
* @throws {RequiredError}
|
|
427
|
+
*/
|
|
428
|
+
adminTransferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport, any, {}, any>>;
|
|
429
|
+
/**
|
|
430
|
+
*
|
|
431
|
+
* @summary Count the documents a user owns (same filter as the listing)
|
|
432
|
+
* @param {string} userId
|
|
433
|
+
* @param {string} [parentId]
|
|
434
|
+
* @param {boolean} [recursive]
|
|
435
|
+
* @param {CountOwnedDocumentsTypeEnum} [type]
|
|
436
|
+
* @param {string} [name]
|
|
437
|
+
* @param {string} [updatedAfter]
|
|
438
|
+
* @param {string} [updatedBefore]
|
|
439
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
countOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: CountOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<number, any, {}, any>>;
|
|
444
|
+
/**
|
|
445
|
+
*
|
|
446
|
+
* @summary A transfer\'s progress and outcome
|
|
447
|
+
* @param {string} jobId
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
*/
|
|
451
|
+
getOwnershipTransfer(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport, any, {}, any>>;
|
|
452
|
+
/**
|
|
453
|
+
* Without parentId and recursive: the user\'s top level (no parent, or a parent they do not own). Subject to the consent-bypass setting (except type=FOLDER, used to pick a transfer\'s destination): send the reason in the X-OpenFilz-Reason header, percent-encoded (UTF-8) if not ASCII.
|
|
454
|
+
* @summary List the documents a user owns
|
|
455
|
+
* @param {string} userId
|
|
456
|
+
* @param {string} [parentId]
|
|
457
|
+
* @param {boolean} [recursive]
|
|
458
|
+
* @param {ListOwnedDocumentsTypeEnum} [type]
|
|
459
|
+
* @param {string} [name]
|
|
460
|
+
* @param {string} [updatedAfter]
|
|
461
|
+
* @param {string} [updatedBefore]
|
|
462
|
+
* @param {number} [page]
|
|
463
|
+
* @param {number} [size]
|
|
464
|
+
* @param {string} [xOpenFilzReason] Why the administrator looks at this user\'s documents — required when the consent bypass applies; percent-encode (UTF-8) a non-ASCII reason
|
|
465
|
+
* @param {*} [options] Override http request option.
|
|
466
|
+
* @throws {RequiredError}
|
|
467
|
+
*/
|
|
468
|
+
listOwnedDocuments(userId: string, parentId?: string, recursive?: boolean, type?: ListOwnedDocumentsTypeEnum, name?: string, updatedAfter?: string, updatedBefore?: string, page?: number, size?: number, xOpenFilzReason?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnedDocument[], any, {}, any>>;
|
|
469
|
+
/**
|
|
470
|
+
*
|
|
471
|
+
* @summary The last 50 transfers from or to a user
|
|
472
|
+
* @param {string} userId
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport[], any, {}, any>>;
|
|
477
|
+
/**
|
|
478
|
+
* dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
|
|
479
|
+
* @summary Transfer documents to another user
|
|
480
|
+
* @param {OwnershipTransferRequest} ownershipTransferRequest
|
|
481
|
+
* @param {*} [options] Override http request option.
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
transferOwnership(ownershipTransferRequest: OwnershipTransferRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport, any, {}, any>>;
|
|
485
|
+
}
|
|
486
|
+
export declare const AdminCountOwnedDocumentsTypeEnum: {
|
|
487
|
+
readonly File: "FILE";
|
|
488
|
+
readonly Folder: "FOLDER";
|
|
489
|
+
};
|
|
490
|
+
export type AdminCountOwnedDocumentsTypeEnum = typeof AdminCountOwnedDocumentsTypeEnum[keyof typeof AdminCountOwnedDocumentsTypeEnum];
|
|
491
|
+
export declare const AdminListOwnedDocumentsTypeEnum: {
|
|
492
|
+
readonly File: "FILE";
|
|
493
|
+
readonly Folder: "FOLDER";
|
|
494
|
+
};
|
|
495
|
+
export type AdminListOwnedDocumentsTypeEnum = typeof AdminListOwnedDocumentsTypeEnum[keyof typeof AdminListOwnedDocumentsTypeEnum];
|
|
496
|
+
export declare const CountOwnedDocumentsTypeEnum: {
|
|
497
|
+
readonly File: "FILE";
|
|
498
|
+
readonly Folder: "FOLDER";
|
|
499
|
+
};
|
|
500
|
+
export type CountOwnedDocumentsTypeEnum = typeof CountOwnedDocumentsTypeEnum[keyof typeof CountOwnedDocumentsTypeEnum];
|
|
501
|
+
export declare const ListOwnedDocumentsTypeEnum: {
|
|
502
|
+
readonly File: "FILE";
|
|
503
|
+
readonly Folder: "FOLDER";
|
|
504
|
+
};
|
|
505
|
+
export type ListOwnedDocumentsTypeEnum = typeof ListOwnedDocumentsTypeEnum[keyof typeof ListOwnedDocumentsTypeEnum];
|