@openfilz-sdk/typescript 1.3.28 → 1.3.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +14 -2
  4. package/api/quota-administration-api.ts +456 -0
  5. package/api/quotas-api.ts +121 -0
  6. package/api/tus-controller-api.ts +8 -4
  7. package/api.ts +2 -0
  8. package/dist/api/quota-administration-api.d.ts +214 -0
  9. package/dist/api/quota-administration-api.js +437 -0
  10. package/dist/api/quotas-api.d.ts +63 -0
  11. package/dist/api/quotas-api.js +125 -0
  12. package/dist/api/tus-controller-api.d.ts +6 -6
  13. package/dist/api/tus-controller-api.js +2 -0
  14. package/dist/api.d.ts +2 -0
  15. package/dist/api.js +2 -0
  16. package/dist/esm/api/quota-administration-api.d.ts +214 -0
  17. package/dist/esm/api/quota-administration-api.js +430 -0
  18. package/dist/esm/api/quotas-api.d.ts +63 -0
  19. package/dist/esm/api/quotas-api.js +118 -0
  20. package/dist/esm/api/tus-controller-api.d.ts +6 -6
  21. package/dist/esm/api/tus-controller-api.js +2 -0
  22. package/dist/esm/api.d.ts +2 -0
  23. package/dist/esm/api.js +2 -0
  24. package/dist/esm/models/error-response.d.ts +16 -0
  25. package/dist/esm/models/error-response.js +14 -0
  26. package/dist/esm/models/index.d.ts +6 -0
  27. package/dist/esm/models/index.js +6 -0
  28. package/dist/esm/models/my-storage-quota.d.ts +24 -0
  29. package/dist/esm/models/my-storage-quota.js +18 -0
  30. package/dist/esm/models/quota-overview.d.ts +19 -0
  31. package/dist/esm/models/quota-overview.js +14 -0
  32. package/dist/esm/models/quota-usage.d.ts +27 -0
  33. package/dist/esm/models/quota-usage.js +18 -0
  34. package/dist/esm/models/quota-user-page.d.ts +18 -0
  35. package/dist/esm/models/quota-user-page.js +14 -0
  36. package/dist/esm/models/storage-breakdown.d.ts +2 -0
  37. package/dist/esm/models/user-quota-request.d.ts +17 -0
  38. package/dist/esm/models/user-quota-request.js +14 -0
  39. package/dist/models/error-response.d.ts +16 -0
  40. package/dist/models/error-response.js +15 -0
  41. package/dist/models/index.d.ts +6 -0
  42. package/dist/models/index.js +6 -0
  43. package/dist/models/my-storage-quota.d.ts +24 -0
  44. package/dist/models/my-storage-quota.js +21 -0
  45. package/dist/models/quota-overview.d.ts +19 -0
  46. package/dist/models/quota-overview.js +15 -0
  47. package/dist/models/quota-usage.d.ts +27 -0
  48. package/dist/models/quota-usage.js +21 -0
  49. package/dist/models/quota-user-page.d.ts +18 -0
  50. package/dist/models/quota-user-page.js +15 -0
  51. package/dist/models/storage-breakdown.d.ts +2 -0
  52. package/dist/models/user-quota-request.d.ts +17 -0
  53. package/dist/models/user-quota-request.js +15 -0
  54. package/docs/ErrorResponse.md +24 -0
  55. package/docs/MyStorageQuota.md +28 -0
  56. package/docs/QuotaAdministrationApi.md +275 -0
  57. package/docs/QuotaOverview.md +30 -0
  58. package/docs/QuotaUsage.md +34 -0
  59. package/docs/QuotaUserPage.md +26 -0
  60. package/docs/QuotasApi.md +52 -0
  61. package/docs/StorageBreakdown.md +2 -0
  62. package/docs/TusControllerApi.md +8 -7
  63. package/docs/UserQuotaRequest.md +20 -0
  64. package/models/error-response.ts +22 -0
  65. package/models/index.ts +6 -0
  66. package/models/my-storage-quota.ts +33 -0
  67. package/models/quota-overview.ts +25 -0
  68. package/models/quota-usage.ts +36 -0
  69. package/models/quota-user-page.ts +26 -0
  70. package/models/storage-breakdown.ts +4 -0
  71. package/models/user-quota-request.ts +23 -0
  72. package/package.json +1 -1
@@ -123,7 +123,7 @@ export declare const TusControllerApiFp: (configuration?: Configuration) => {
123
123
  * @param {*} [options] Override http request option.
124
124
  * @throws {RequiredError}
125
125
  */
126
- createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
126
+ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
127
127
  /**
128
128
  * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded.
129
129
  * @summary Finalize upload
@@ -174,7 +174,7 @@ export declare const TusControllerApiFp: (configuration?: Configuration) => {
174
174
  * @param {*} [options] Override http request option.
175
175
  * @throws {RequiredError}
176
176
  */
177
- uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
177
+ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
178
178
  };
179
179
  /**
180
180
  * TusControllerApi - factory interface
@@ -203,7 +203,7 @@ export declare const TusControllerApiFactory: (configuration?: Configuration, ba
203
203
  * @param {*} [options] Override http request option.
204
204
  * @throws {RequiredError}
205
205
  */
206
- createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
206
+ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
207
207
  /**
208
208
  * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded.
209
209
  * @summary Finalize upload
@@ -254,7 +254,7 @@ export declare const TusControllerApiFactory: (configuration?: Configuration, ba
254
254
  * @param {*} [options] Override http request option.
255
255
  * @throws {RequiredError}
256
256
  */
257
- uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
257
+ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): AxiosPromise<object>;
258
258
  };
259
259
  /**
260
260
  * TusControllerApi - object-oriented interface
@@ -283,7 +283,7 @@ export declare class TusControllerApi extends BaseAPI {
283
283
  * @param {*} [options] Override http request option.
284
284
  * @throws {RequiredError}
285
285
  */
286
- createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
286
+ createUpload(uploadLength: number, uploadMetadata?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
287
287
  /**
288
288
  * Completes the upload by moving the file to permanent storage and creating the Document record. Call this after all chunks have been successfully uploaded.
289
289
  * @summary Finalize upload
@@ -334,5 +334,5 @@ export declare class TusControllerApi extends BaseAPI {
334
334
  * @param {*} [options] Override http request option.
335
335
  * @throws {RequiredError}
336
336
  */
337
- uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
337
+ uploadChunk(uploadId: string, uploadOffset: number, requestBody: Array<any>, contentLength?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
338
338
  }
@@ -118,6 +118,7 @@ const TusControllerApiAxiosParamCreator = function (configuration) {
118
118
  // authentication keycloak_auth required
119
119
  // http bearer authentication required
120
120
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
121
+ localVarHeaderParameter['Accept'] = '*/*';
121
122
  if (uploadLength != null) {
122
123
  localVarHeaderParameter['Upload-Length'] = typeof uploadLength === 'string'
123
124
  ? uploadLength
@@ -331,6 +332,7 @@ const TusControllerApiAxiosParamCreator = function (configuration) {
331
332
  // http bearer authentication required
332
333
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
333
334
  localVarHeaderParameter['Content-Type'] = 'application/offset+octet-stream';
335
+ localVarHeaderParameter['Accept'] = '*/*';
334
336
  if (uploadOffset != null) {
335
337
  localVarHeaderParameter['Upload-Offset'] = typeof uploadOffset === 'string'
336
338
  ? uploadOffset
package/dist/api.d.ts CHANGED
@@ -26,6 +26,8 @@ export * from './api/file-controller-api';
26
26
  export * from './api/folder-controller-api';
27
27
  export * from './api/mcp-discovery-controller-api';
28
28
  export * from './api/pdftools-api';
29
+ export * from './api/quota-administration-api';
30
+ export * from './api/quotas-api';
29
31
  export * from './api/settings-api';
30
32
  export * from './api/smart-filing-api';
31
33
  export * from './api/tus-controller-api';
package/dist/api.js CHANGED
@@ -44,6 +44,8 @@ __exportStar(require("./api/file-controller-api"), exports);
44
44
  __exportStar(require("./api/folder-controller-api"), exports);
45
45
  __exportStar(require("./api/mcp-discovery-controller-api"), exports);
46
46
  __exportStar(require("./api/pdftools-api"), exports);
47
+ __exportStar(require("./api/quota-administration-api"), exports);
48
+ __exportStar(require("./api/quotas-api"), exports);
47
49
  __exportStar(require("./api/settings-api"), exports);
48
50
  __exportStar(require("./api/smart-filing-api"), exports);
49
51
  __exportStar(require("./api/tus-controller-api"), exports);
@@ -0,0 +1,214 @@
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 { QuotaOverview } from '../models';
16
+ import type { QuotaUsage } from '../models';
17
+ import type { QuotaUserPage } from '../models';
18
+ import type { UserQuotaRequest } from '../models';
19
+ /**
20
+ * QuotaAdministrationApi - axios parameter creator
21
+ */
22
+ export declare const QuotaAdministrationApiAxiosParamCreator: (configuration?: Configuration) => {
23
+ /**
24
+ * The group or default limit applies again.
25
+ * @summary Remove one user\'s own limit
26
+ * @param {string} username
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ clearUserQuota: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
+ /**
32
+ *
33
+ * @summary Get one user\'s storage
34
+ * @param {string} username
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getUser: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
+ /**
40
+ * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
41
+ * @summary List users\' storage
42
+ * @param {string} [search] Case-insensitive filter on the user name
43
+ * @param {string} [sort] usage | percent | limit | name
44
+ * @param {string} [order] asc | desc
45
+ * @param {number} [page]
46
+ * @param {number} [size]
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ listUsers: (search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
53
+ * @summary Quota overview
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ overview: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58
+ /**
59
+ * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
60
+ * @summary Set one user\'s own limit
61
+ * @param {string} username
62
+ * @param {UserQuotaRequest} userQuotaRequest
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ setUserQuota: (username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67
+ };
68
+ /**
69
+ * QuotaAdministrationApi - functional programming interface
70
+ */
71
+ export declare const QuotaAdministrationApiFp: (configuration?: Configuration) => {
72
+ /**
73
+ * The group or default limit applies again.
74
+ * @summary Remove one user\'s own limit
75
+ * @param {string} username
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ clearUserQuota(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
80
+ /**
81
+ *
82
+ * @summary Get one user\'s storage
83
+ * @param {string} username
84
+ * @param {*} [options] Override http request option.
85
+ * @throws {RequiredError}
86
+ */
87
+ getUser(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
88
+ /**
89
+ * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
90
+ * @summary List users\' storage
91
+ * @param {string} [search] Case-insensitive filter on the user name
92
+ * @param {string} [sort] usage | percent | limit | name
93
+ * @param {string} [order] asc | desc
94
+ * @param {number} [page]
95
+ * @param {number} [size]
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUserPage>>;
100
+ /**
101
+ * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
102
+ * @summary Quota overview
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ overview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaOverview>>;
107
+ /**
108
+ * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
109
+ * @summary Set one user\'s own limit
110
+ * @param {string} username
111
+ * @param {UserQuotaRequest} userQuotaRequest
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotaUsage>>;
116
+ };
117
+ /**
118
+ * QuotaAdministrationApi - factory interface
119
+ */
120
+ export declare const QuotaAdministrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
121
+ /**
122
+ * The group or default limit applies again.
123
+ * @summary Remove one user\'s own limit
124
+ * @param {string} username
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ clearUserQuota(username: string, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
129
+ /**
130
+ *
131
+ * @summary Get one user\'s storage
132
+ * @param {string} username
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ getUser(username: string, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
137
+ /**
138
+ * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
139
+ * @summary List users\' storage
140
+ * @param {string} [search] Case-insensitive filter on the user name
141
+ * @param {string} [sort] usage | percent | limit | name
142
+ * @param {string} [order] asc | desc
143
+ * @param {number} [page]
144
+ * @param {number} [size]
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUserPage>;
149
+ /**
150
+ * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
151
+ * @summary Quota overview
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ overview(options?: RawAxiosRequestConfig): AxiosPromise<QuotaOverview>;
156
+ /**
157
+ * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
158
+ * @summary Set one user\'s own limit
159
+ * @param {string} username
160
+ * @param {UserQuotaRequest} userQuotaRequest
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuotaUsage>;
165
+ };
166
+ /**
167
+ * QuotaAdministrationApi - object-oriented interface
168
+ */
169
+ export declare class QuotaAdministrationApi extends BaseAPI {
170
+ /**
171
+ * The group or default limit applies again.
172
+ * @summary Remove one user\'s own limit
173
+ * @param {string} username
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ clearUserQuota(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}>>;
178
+ /**
179
+ *
180
+ * @summary Get one user\'s storage
181
+ * @param {string} username
182
+ * @param {*} [options] Override http request option.
183
+ * @throws {RequiredError}
184
+ */
185
+ getUser(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}>>;
186
+ /**
187
+ * Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
188
+ * @summary List users\' storage
189
+ * @param {string} [search] Case-insensitive filter on the user name
190
+ * @param {string} [sort] usage | percent | limit | name
191
+ * @param {string} [order] asc | desc
192
+ * @param {number} [page]
193
+ * @param {number} [size]
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ listUsers(search?: string, sort?: string, order?: string, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUserPage, any, {}>>;
198
+ /**
199
+ * Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
200
+ * @summary Quota overview
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ overview(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaOverview, any, {}>>;
205
+ /**
206
+ * quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
207
+ * @summary Set one user\'s own limit
208
+ * @param {string} username
209
+ * @param {UserQuotaRequest} userQuotaRequest
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ */
213
+ setUserQuota(username: string, userQuotaRequest: UserQuotaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QuotaUsage, any, {}>>;
214
+ }