@dimrev4/fitness-v3-backend 0.0.34 → 0.0.36
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 +2 -0
- package/api.ts +558 -38
- package/dist/api.d.ts +346 -26
- package/dist/api.js +332 -26
- package/dist/esm/api.d.ts +346 -26
- package/dist/esm/api.js +332 -26
- package/docs/FilesV1Api.md +238 -8
- package/docs/GroupGetPresignedPostUrlRequestDto.md +28 -0
- package/docs/UserGetPresignedPostUrlRequestDto.md +26 -0
- package/package.json +1 -1
package/docs/FilesV1Api.md
CHANGED
|
@@ -5,8 +5,12 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**filesV1ControllerGetBuckets**](#filesv1controllergetbuckets) | **GET** /api/files/v1/buckets | Get buckets|
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
8
|
+
|[**filesV1ControllerGetGroupPresignedGetUrl**](#filesv1controllergetgrouppresignedgeturl) | **GET** /api/files/v1/group/{groupId}/presigned-url/{filepath} | Get presigned get group url|
|
|
9
|
+
|[**filesV1ControllerGetGroupPresignedPostUrl**](#filesv1controllergetgrouppresignedposturl) | **POST** /api/files/v1/group/{groupId}/presigned-url | Get presigned post group url|
|
|
10
|
+
|[**filesV1ControllerGetPublicPresignedGetUrl**](#filesv1controllergetpublicpresignedgeturl) | **GET** /api/files/v1/public/presigned-url/{filepath} | Get presigned public get url|
|
|
11
|
+
|[**filesV1ControllerGetPublicPresignedPostUrl**](#filesv1controllergetpublicpresignedposturl) | **POST** /api/files/v1/public/presigned-url | Get presigned public post url|
|
|
12
|
+
|[**filesV1ControllerGetUserPresignedGetUrl**](#filesv1controllergetuserpresignedgeturl) | **GET** /api/files/v1/user/{userId}/presigned-url/{filepath} | Get presigned get url|
|
|
13
|
+
|[**filesV1ControllerGetUserPresignedPostUrl**](#filesv1controllergetuserpresignedposturl) | **POST** /api/files/v1/user/{userId}/presigned-url | Get presigned post url|
|
|
10
14
|
|
|
11
15
|
# **filesV1ControllerGetBuckets**
|
|
12
16
|
> filesV1ControllerGetBuckets()
|
|
@@ -54,8 +58,8 @@ void (empty response body)
|
|
|
54
58
|
|
|
55
59
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
56
60
|
|
|
57
|
-
# **
|
|
58
|
-
> PresignedGetDataDto
|
|
61
|
+
# **filesV1ControllerGetGroupPresignedGetUrl**
|
|
62
|
+
> PresignedGetDataDto filesV1ControllerGetGroupPresignedGetUrl()
|
|
59
63
|
|
|
60
64
|
|
|
61
65
|
### Example
|
|
@@ -69,9 +73,11 @@ import {
|
|
|
69
73
|
const configuration = new Configuration();
|
|
70
74
|
const apiInstance = new FilesV1Api(configuration);
|
|
71
75
|
|
|
76
|
+
let groupId: string; // (default to undefined)
|
|
72
77
|
let filepath: string; // (default to undefined)
|
|
73
78
|
|
|
74
|
-
const { status, data } = await apiInstance.
|
|
79
|
+
const { status, data } = await apiInstance.filesV1ControllerGetGroupPresignedGetUrl(
|
|
80
|
+
groupId,
|
|
75
81
|
filepath
|
|
76
82
|
);
|
|
77
83
|
```
|
|
@@ -80,6 +86,7 @@ const { status, data } = await apiInstance.filesV1ControllerGetPresignedGetUrl(
|
|
|
80
86
|
|
|
81
87
|
|Name | Type | Description | Notes|
|
|
82
88
|
|------------- | ------------- | ------------- | -------------|
|
|
89
|
+
| **groupId** | [**string**] | | defaults to undefined|
|
|
83
90
|
| **filepath** | [**string**] | | defaults to undefined|
|
|
84
91
|
|
|
85
92
|
|
|
@@ -107,8 +114,118 @@ const { status, data } = await apiInstance.filesV1ControllerGetPresignedGetUrl(
|
|
|
107
114
|
|
|
108
115
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
109
116
|
|
|
110
|
-
# **
|
|
111
|
-
> PresignedPostDataDto
|
|
117
|
+
# **filesV1ControllerGetGroupPresignedPostUrl**
|
|
118
|
+
> PresignedPostDataDto filesV1ControllerGetGroupPresignedPostUrl(groupGetPresignedPostUrlRequestDto)
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### Example
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import {
|
|
125
|
+
FilesV1Api,
|
|
126
|
+
Configuration,
|
|
127
|
+
GroupGetPresignedPostUrlRequestDto
|
|
128
|
+
} from '@dimrev4/fitness-v3-backend-sdk';
|
|
129
|
+
|
|
130
|
+
const configuration = new Configuration();
|
|
131
|
+
const apiInstance = new FilesV1Api(configuration);
|
|
132
|
+
|
|
133
|
+
let groupId: string; // (default to undefined)
|
|
134
|
+
let groupGetPresignedPostUrlRequestDto: GroupGetPresignedPostUrlRequestDto; //
|
|
135
|
+
|
|
136
|
+
const { status, data } = await apiInstance.filesV1ControllerGetGroupPresignedPostUrl(
|
|
137
|
+
groupId,
|
|
138
|
+
groupGetPresignedPostUrlRequestDto
|
|
139
|
+
);
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
|Name | Type | Description | Notes|
|
|
145
|
+
|------------- | ------------- | ------------- | -------------|
|
|
146
|
+
| **groupGetPresignedPostUrlRequestDto** | **GroupGetPresignedPostUrlRequestDto**| | |
|
|
147
|
+
| **groupId** | [**string**] | | defaults to undefined|
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
**PresignedPostDataDto**
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: application/json
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### HTTP response details
|
|
165
|
+
| Status code | Description | Response headers |
|
|
166
|
+
|-------------|-------------|------------------|
|
|
167
|
+
|**200** | | - |
|
|
168
|
+
|**400** | Invalid JWT payload structure or validation failed | - |
|
|
169
|
+
|**401** | JWT token is missing, expired, or invalid | - |
|
|
170
|
+
|**500** | Internal server error during JWT validation | - |
|
|
171
|
+
|
|
172
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
173
|
+
|
|
174
|
+
# **filesV1ControllerGetPublicPresignedGetUrl**
|
|
175
|
+
> PresignedGetDataDto filesV1ControllerGetPublicPresignedGetUrl()
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
### Example
|
|
179
|
+
|
|
180
|
+
```typescript
|
|
181
|
+
import {
|
|
182
|
+
FilesV1Api,
|
|
183
|
+
Configuration
|
|
184
|
+
} from '@dimrev4/fitness-v3-backend-sdk';
|
|
185
|
+
|
|
186
|
+
const configuration = new Configuration();
|
|
187
|
+
const apiInstance = new FilesV1Api(configuration);
|
|
188
|
+
|
|
189
|
+
let filepath: string; // (default to undefined)
|
|
190
|
+
|
|
191
|
+
const { status, data } = await apiInstance.filesV1ControllerGetPublicPresignedGetUrl(
|
|
192
|
+
filepath
|
|
193
|
+
);
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
|Name | Type | Description | Notes|
|
|
199
|
+
|------------- | ------------- | ------------- | -------------|
|
|
200
|
+
| **filepath** | [**string**] | | defaults to undefined|
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
### Return type
|
|
204
|
+
|
|
205
|
+
**PresignedGetDataDto**
|
|
206
|
+
|
|
207
|
+
### Authorization
|
|
208
|
+
|
|
209
|
+
[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
|
|
210
|
+
|
|
211
|
+
### HTTP request headers
|
|
212
|
+
|
|
213
|
+
- **Content-Type**: Not defined
|
|
214
|
+
- **Accept**: application/json
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
### HTTP response details
|
|
218
|
+
| Status code | Description | Response headers |
|
|
219
|
+
|-------------|-------------|------------------|
|
|
220
|
+
|**200** | | - |
|
|
221
|
+
|**400** | Invalid JWT payload structure or validation failed | - |
|
|
222
|
+
|**401** | JWT token is missing, expired, or invalid | - |
|
|
223
|
+
|**500** | Internal server error during JWT validation | - |
|
|
224
|
+
|
|
225
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
226
|
+
|
|
227
|
+
# **filesV1ControllerGetPublicPresignedPostUrl**
|
|
228
|
+
> PresignedPostDataDto filesV1ControllerGetPublicPresignedPostUrl(publicGetPresignedPostUrlRequestDto)
|
|
112
229
|
|
|
113
230
|
|
|
114
231
|
### Example
|
|
@@ -125,7 +242,7 @@ const apiInstance = new FilesV1Api(configuration);
|
|
|
125
242
|
|
|
126
243
|
let publicGetPresignedPostUrlRequestDto: PublicGetPresignedPostUrlRequestDto; //
|
|
127
244
|
|
|
128
|
-
const { status, data } = await apiInstance.
|
|
245
|
+
const { status, data } = await apiInstance.filesV1ControllerGetPublicPresignedPostUrl(
|
|
129
246
|
publicGetPresignedPostUrlRequestDto
|
|
130
247
|
);
|
|
131
248
|
```
|
|
@@ -161,3 +278,116 @@ const { status, data } = await apiInstance.filesV1ControllerGetPresignedPostUrl(
|
|
|
161
278
|
|
|
162
279
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
163
280
|
|
|
281
|
+
# **filesV1ControllerGetUserPresignedGetUrl**
|
|
282
|
+
> PresignedGetDataDto filesV1ControllerGetUserPresignedGetUrl()
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
### Example
|
|
286
|
+
|
|
287
|
+
```typescript
|
|
288
|
+
import {
|
|
289
|
+
FilesV1Api,
|
|
290
|
+
Configuration
|
|
291
|
+
} from '@dimrev4/fitness-v3-backend-sdk';
|
|
292
|
+
|
|
293
|
+
const configuration = new Configuration();
|
|
294
|
+
const apiInstance = new FilesV1Api(configuration);
|
|
295
|
+
|
|
296
|
+
let userId: string; // (default to undefined)
|
|
297
|
+
let filepath: string; // (default to undefined)
|
|
298
|
+
|
|
299
|
+
const { status, data } = await apiInstance.filesV1ControllerGetUserPresignedGetUrl(
|
|
300
|
+
userId,
|
|
301
|
+
filepath
|
|
302
|
+
);
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
|Name | Type | Description | Notes|
|
|
308
|
+
|------------- | ------------- | ------------- | -------------|
|
|
309
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
310
|
+
| **filepath** | [**string**] | | defaults to undefined|
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### Return type
|
|
314
|
+
|
|
315
|
+
**PresignedGetDataDto**
|
|
316
|
+
|
|
317
|
+
### Authorization
|
|
318
|
+
|
|
319
|
+
[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
|
|
320
|
+
|
|
321
|
+
### HTTP request headers
|
|
322
|
+
|
|
323
|
+
- **Content-Type**: Not defined
|
|
324
|
+
- **Accept**: application/json
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
### HTTP response details
|
|
328
|
+
| Status code | Description | Response headers |
|
|
329
|
+
|-------------|-------------|------------------|
|
|
330
|
+
|**200** | | - |
|
|
331
|
+
|**400** | Invalid JWT payload structure or validation failed | - |
|
|
332
|
+
|**401** | JWT token is missing, expired, or invalid | - |
|
|
333
|
+
|**500** | Internal server error during JWT validation | - |
|
|
334
|
+
|
|
335
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
336
|
+
|
|
337
|
+
# **filesV1ControllerGetUserPresignedPostUrl**
|
|
338
|
+
> PresignedPostDataDto filesV1ControllerGetUserPresignedPostUrl(userGetPresignedPostUrlRequestDto)
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
import {
|
|
345
|
+
FilesV1Api,
|
|
346
|
+
Configuration,
|
|
347
|
+
UserGetPresignedPostUrlRequestDto
|
|
348
|
+
} from '@dimrev4/fitness-v3-backend-sdk';
|
|
349
|
+
|
|
350
|
+
const configuration = new Configuration();
|
|
351
|
+
const apiInstance = new FilesV1Api(configuration);
|
|
352
|
+
|
|
353
|
+
let userId: string; // (default to undefined)
|
|
354
|
+
let userGetPresignedPostUrlRequestDto: UserGetPresignedPostUrlRequestDto; //
|
|
355
|
+
|
|
356
|
+
const { status, data } = await apiInstance.filesV1ControllerGetUserPresignedPostUrl(
|
|
357
|
+
userId,
|
|
358
|
+
userGetPresignedPostUrlRequestDto
|
|
359
|
+
);
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### Parameters
|
|
363
|
+
|
|
364
|
+
|Name | Type | Description | Notes|
|
|
365
|
+
|------------- | ------------- | ------------- | -------------|
|
|
366
|
+
| **userGetPresignedPostUrlRequestDto** | **UserGetPresignedPostUrlRequestDto**| | |
|
|
367
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
### Return type
|
|
371
|
+
|
|
372
|
+
**PresignedPostDataDto**
|
|
373
|
+
|
|
374
|
+
### Authorization
|
|
375
|
+
|
|
376
|
+
[apiKey](../README.md#apiKey), [bearer](../README.md#bearer)
|
|
377
|
+
|
|
378
|
+
### HTTP request headers
|
|
379
|
+
|
|
380
|
+
- **Content-Type**: application/json
|
|
381
|
+
- **Accept**: application/json
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### HTTP response details
|
|
385
|
+
| Status code | Description | Response headers |
|
|
386
|
+
|-------------|-------------|------------------|
|
|
387
|
+
|**200** | | - |
|
|
388
|
+
|**400** | Invalid JWT payload structure or validation failed | - |
|
|
389
|
+
|**401** | JWT token is missing, expired, or invalid | - |
|
|
390
|
+
|**500** | Internal server error during JWT validation | - |
|
|
391
|
+
|
|
392
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
393
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# GroupGetPresignedPostUrlRequestDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**userId** | **string** | User ID, for files in the user scope of the bucket | [optional] [default to undefined]
|
|
9
|
+
**filename** | **string** | Original filename | [default to undefined]
|
|
10
|
+
**subject** | **string** | Subject folder | [default to undefined]
|
|
11
|
+
**fileShaCheckSum** | **string** | SHA-256 checksum of the file | [default to undefined]
|
|
12
|
+
**mimetype** | **string** | MIME type of the file | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { GroupGetPresignedPostUrlRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: GroupGetPresignedPostUrlRequestDto = {
|
|
20
|
+
userId,
|
|
21
|
+
filename,
|
|
22
|
+
subject,
|
|
23
|
+
fileShaCheckSum,
|
|
24
|
+
mimetype,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UserGetPresignedPostUrlRequestDto
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**filename** | **string** | Original filename | [default to undefined]
|
|
9
|
+
**subject** | **string** | Subject folder | [default to undefined]
|
|
10
|
+
**fileShaCheckSum** | **string** | SHA-256 checksum of the file | [default to undefined]
|
|
11
|
+
**mimetype** | **string** | MIME type of the file | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UserGetPresignedPostUrlRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: UserGetPresignedPostUrlRequestDto = {
|
|
19
|
+
filename,
|
|
20
|
+
subject,
|
|
21
|
+
fileShaCheckSum,
|
|
22
|
+
mimetype,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|