2022-07-13 14:23:48 +02:00
# openapi.api.AssetApi
## Load the API package
```dart
import 'package:openapi/api.dart';
```
All URIs are relative to */api*
Method | HTTP request | Description
------------- | ------------- | -------------
2023-05-24 23:08:21 +02:00
[**bulkUploadCheck** ](AssetApi.md#bulkuploadcheck ) | **POST** /asset/bulk-upload-check |
2022-07-13 14:23:48 +02:00
[**checkDuplicateAsset** ](AssetApi.md#checkduplicateasset ) | **POST** /asset/check |
2022-10-25 16:51:03 +02:00
[**checkExistingAssets** ](AssetApi.md#checkexistingassets ) | **POST** /asset/exist |
2022-07-13 14:23:48 +02:00
[**deleteAsset** ](AssetApi.md#deleteasset ) | **DELETE** /asset |
2023-06-30 18:24:28 +02:00
[**downloadArchive** ](AssetApi.md#downloadarchive ) | **POST** /asset/download |
[**downloadFile** ](AssetApi.md#downloadfile ) | **POST** /asset/download/{id} |
2022-07-13 14:23:48 +02:00
[**getAllAssets** ](AssetApi.md#getallassets ) | **GET** /asset |
2023-06-02 04:19:25 +02:00
[**getAssetById** ](AssetApi.md#getassetbyid ) | **GET** /asset/assetById/{id} |
2022-08-27 07:53:37 +02:00
[**getAssetSearchTerms** ](AssetApi.md#getassetsearchterms ) | **GET** /asset/search-terms |
2023-07-14 15:30:17 +02:00
[**getAssetStats** ](AssetApi.md#getassetstats ) | **GET** /asset/statistics |
2023-06-02 04:19:25 +02:00
[**getAssetThumbnail** ](AssetApi.md#getassetthumbnail ) | **GET** /asset/thumbnail/{id} |
2023-08-04 23:07:15 +02:00
[**getByTimeBucket** ](AssetApi.md#getbytimebucket ) | **GET** /asset/time-bucket |
2022-08-27 07:53:37 +02:00
[**getCuratedLocations** ](AssetApi.md#getcuratedlocations ) | **GET** /asset/curated-locations |
[**getCuratedObjects** ](AssetApi.md#getcuratedobjects ) | **GET** /asset/curated-objects |
2023-06-30 18:24:28 +02:00
[**getDownloadInfo** ](AssetApi.md#getdownloadinfo ) | **GET** /asset/download |
2023-05-06 03:33:30 +02:00
[**getMapMarkers** ](AssetApi.md#getmapmarkers ) | **GET** /asset/map-marker |
2023-06-15 03:47:18 +02:00
[**getMemoryLane** ](AssetApi.md#getmemorylane ) | **GET** /asset/memory-lane |
2023-08-04 23:07:15 +02:00
[**getTimeBuckets** ](AssetApi.md#gettimebuckets ) | **GET** /asset/time-buckets |
2022-07-13 14:23:48 +02:00
[**getUserAssetsByDeviceId** ](AssetApi.md#getuserassetsbydeviceid ) | **GET** /asset/{deviceId} |
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 04:33:20 +02:00
[**importFile** ](AssetApi.md#importfile ) | **POST** /asset/import |
2022-07-13 14:23:48 +02:00
[**searchAsset** ](AssetApi.md#searchasset ) | **POST** /asset/search |
2023-06-02 04:19:25 +02:00
[**serveFile** ](AssetApi.md#servefile ) | **GET** /asset/file/{id} |
[**updateAsset** ](AssetApi.md#updateasset ) | **PUT** /asset/{id} |
2022-07-13 14:23:48 +02:00
[**uploadFile** ](AssetApi.md#uploadfile ) | **POST** /asset/upload |
2023-05-24 23:08:21 +02:00
# **bulkUploadCheck**
> AssetBulkUploadCheckResponseDto bulkUploadCheck(assetBulkUploadCheckDto)
Checks if assets exist by checksums
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final assetBulkUploadCheckDto = AssetBulkUploadCheckDto(); // AssetBulkUploadCheckDto |
try {
final result = api_instance.bulkUploadCheck(assetBulkUploadCheckDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->bulkUploadCheck: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetBulkUploadCheckDto** | [**AssetBulkUploadCheckDto** ](AssetBulkUploadCheckDto.md )| |
### Return type
[**AssetBulkUploadCheckResponseDto** ](AssetBulkUploadCheckResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2022-07-13 14:23:48 +02:00
# **checkDuplicateAsset**
2023-02-24 18:01:10 +02:00
> CheckDuplicateAssetResponseDto checkDuplicateAsset(checkDuplicateAssetDto, key)
2022-07-13 14:23:48 +02:00
Check duplicated asset before uploading - for Web upload used
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final checkDuplicateAssetDto = CheckDuplicateAssetDto(); // CheckDuplicateAssetDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-02-24 18:01:10 +02:00
final result = api_instance.checkDuplicateAsset(checkDuplicateAssetDto, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->checkDuplicateAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**checkDuplicateAssetDto** | [**CheckDuplicateAssetDto** ](CheckDuplicateAssetDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**CheckDuplicateAssetResponseDto** ](CheckDuplicateAssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2022-10-25 16:51:03 +02:00
# **checkExistingAssets**
> CheckExistingAssetsResponseDto checkExistingAssets(checkExistingAssetsDto)
Checks if multiple assets exist on the server and returns all existing - used by background backup
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-10-25 16:51:03 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final checkExistingAssetsDto = CheckExistingAssetsDto(); // CheckExistingAssetsDto |
try {
final result = api_instance.checkExistingAssets(checkExistingAssetsDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->checkExistingAssets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**checkExistingAssetsDto** | [**CheckExistingAssetsDto** ](CheckExistingAssetsDto.md )| |
### Return type
[**CheckExistingAssetsResponseDto** ](CheckExistingAssetsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-10-25 16:51:03 +02:00
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2022-07-13 14:23:48 +02:00
# **deleteAsset**
> List<DeleteAssetResponseDto> deleteAsset(deleteAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final deleteAssetDto = DeleteAssetDto(); // DeleteAssetDto |
try {
final result = api_instance.deleteAsset(deleteAssetDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->deleteAsset: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deleteAssetDto** | [**DeleteAssetDto** ](DeleteAssetDto.md )| |
### Return type
[**List<DeleteAssetResponseDto>** ](DeleteAssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2023-06-30 18:24:28 +02:00
# **downloadArchive**
> MultipartFile downloadArchive(assetIdsDto, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-30 18:24:28 +02:00
final assetIdsDto = AssetIdsDto(); // AssetIdsDto |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-06-30 18:24:28 +02:00
final result = api_instance.downloadArchive(assetIdsDto, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
2023-06-30 18:24:28 +02:00
print('Exception when calling AssetApi->downloadArchive: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-30 18:24:28 +02:00
**assetIdsDto** | [**AssetIdsDto** ](AssetIdsDto.md )| |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2023-01-09 22:16:08 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2023-01-09 22:16:08 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-09 22:16:08 +02:00
### HTTP request headers
- **Content-Type**: application/json
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2023-01-09 22:16:08 +02:00
[[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)
2023-06-30 18:24:28 +02:00
# **downloadFile**
> MultipartFile downloadFile(id, key)
2022-11-15 17:51:56 +02:00
2023-01-15 07:49:47 +02:00
2022-11-15 17:51:56 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-11-15 17:51:56 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-30 18:24:28 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-11-15 17:51:56 +02:00
try {
2023-06-30 18:24:28 +02:00
final result = api_instance.downloadFile(id, key);
2022-11-15 17:51:56 +02:00
print(result);
} catch (e) {
2023-06-30 18:24:28 +02:00
print('Exception when calling AssetApi->downloadFile: $e\n');
2022-11-15 17:51:56 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-30 18:24:28 +02:00
**id** | **String** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-11-15 17:51:56 +02:00
### Return type
2023-02-24 18:01:10 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-11-15 17:51:56 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-15 17:51:56 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-02-24 18:01:10 +02:00
- **Accept**: application/octet-stream
2022-11-15 17:51:56 +02:00
[[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)
2022-07-13 14:23:48 +02:00
# **getAllAssets**
2023-06-04 04:41:27 +02:00
> List<AssetResponseDto> getAllAssets(userId, isFavorite, isArchived, withoutThumbs, skip, ifNoneMatch)
2022-07-13 14:23:48 +02:00
Get all AssetEntity belong to the user
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-05-25 05:52:43 +02:00
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-01-24 06:16:20 +02:00
final isFavorite = true; // bool |
2023-04-12 17:37:52 +02:00
final isArchived = true; // bool |
2023-06-04 04:41:27 +02:00
final withoutThumbs = true; // bool | Include assets without thumbnails
2023-01-24 06:16:20 +02:00
final skip = 8.14; // num |
2022-11-26 18:16:02 +02:00
final ifNoneMatch = ifNoneMatch_example; // String | ETag of data already cached on the client
2022-07-13 14:23:48 +02:00
try {
2023-06-04 04:41:27 +02:00
final result = api_instance.getAllAssets(userId, isFavorite, isArchived, withoutThumbs, skip, ifNoneMatch);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAllAssets: $e\n');
}
```
### Parameters
2022-11-26 18:16:02 +02:00
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-05-25 05:52:43 +02:00
**userId** | **String** | | [optional]
2023-01-24 06:16:20 +02:00
**isFavorite** | **bool** | | [optional]
2023-04-12 17:37:52 +02:00
**isArchived** | **bool** | | [optional]
2023-06-04 04:41:27 +02:00
**withoutThumbs** | **bool** | Include assets without thumbnails | [optional]
2023-01-24 06:16:20 +02:00
**skip** | **num** | | [optional]
2022-11-26 18:16:02 +02:00
**ifNoneMatch** | **String** | ETag of data already cached on the client | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getAssetById**
2023-06-02 04:19:25 +02:00
> AssetResponseDto getAssetById(id, key)
2022-07-13 14:23:48 +02:00
Get a single asset's information
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.getAssetById(id, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAssetById: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**AssetResponseDto** ](AssetResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2023-08-04 23:07:15 +02:00
# **getAssetSearchTerms**
> List<String> getAssetSearchTerms()
2022-08-27 07:53:37 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-08-27 07:53:37 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
2023-08-04 23:07:15 +02:00
final result = api_instance.getAssetSearchTerms();
2022-08-27 07:53:37 +02:00
print(result);
} catch (e) {
2023-08-04 23:07:15 +02:00
print('Exception when calling AssetApi->getAssetSearchTerms: $e\n');
2022-08-27 07:53:37 +02:00
}
```
### Parameters
2023-08-04 23:07:15 +02:00
This endpoint does not need any parameter.
2022-08-27 07:53:37 +02:00
### Return type
2023-08-04 23:07:15 +02:00
**List< String > **
2022-09-04 15:34:39 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-04 15:34:39 +02:00
### HTTP request headers
2023-08-04 23:07:15 +02:00
- **Content-Type**: Not defined
2022-09-04 15:34:39 +02:00
- **Accept**: application/json
[[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)
2023-08-04 23:07:15 +02:00
# **getAssetStats**
> AssetStatsResponseDto getAssetStats(isArchived, isFavorite)
2022-09-04 15:34:39 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-09-04 15:34:39 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-08-04 23:07:15 +02:00
final isArchived = true; // bool |
final isFavorite = true; // bool |
2022-09-04 15:34:39 +02:00
try {
2023-08-04 23:07:15 +02:00
final result = api_instance.getAssetStats(isArchived, isFavorite);
2022-09-04 15:34:39 +02:00
print(result);
} catch (e) {
2023-08-04 23:07:15 +02:00
print('Exception when calling AssetApi->getAssetStats: $e\n');
2022-09-04 15:34:39 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-08-04 23:07:15 +02:00
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
2022-09-07 22:16:18 +02:00
### Return type
2023-08-04 23:07:15 +02:00
[**AssetStatsResponseDto** ](AssetStatsResponseDto.md )
2022-09-07 22:16:18 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-09-07 22:16:18 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2023-08-04 23:07:15 +02:00
# **getAssetThumbnail**
> MultipartFile getAssetThumbnail(id, format, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-08-04 23:07:15 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final format = ; // ThumbnailFormat |
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-08-04 23:07:15 +02:00
final result = api_instance.getAssetThumbnail(id, format, key);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
2023-08-04 23:07:15 +02:00
print('Exception when calling AssetApi->getAssetThumbnail: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
2023-07-14 15:30:17 +02:00
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-08-04 23:07:15 +02:00
**id** | **String** | |
**format** | [**ThumbnailFormat** ](.md )| | [optional]
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
2023-08-04 23:07:15 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-08-04 23:07:15 +02:00
- **Accept**: image/jpeg, image/webp
2022-07-13 14:23:48 +02:00
[[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)
2023-08-04 23:07:15 +02:00
# **getByTimeBucket**
> List<AssetResponseDto> getByTimeBucket(size, timeBucket, userId, albumId, isArchived, isFavorite, key)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-08-04 23:07:15 +02:00
final size = ; // TimeBucketSize |
final timeBucket = timeBucket_example; // String |
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final isArchived = true; // bool |
final isFavorite = true; // bool |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-07-13 14:23:48 +02:00
try {
2023-08-04 23:07:15 +02:00
final result = api_instance.getByTimeBucket(size, timeBucket, userId, albumId, isArchived, isFavorite, key);
2023-07-07 00:25:56 +02:00
print(result);
2022-07-13 14:23:48 +02:00
} catch (e) {
2023-08-04 23:07:15 +02:00
print('Exception when calling AssetApi->getByTimeBucket: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-08-04 23:07:15 +02:00
**size** | [**TimeBucketSize** ](.md )| |
**timeBucket** | **String** | |
**userId** | **String** | | [optional]
**albumId** | **String** | | [optional]
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
2023-08-04 23:07:15 +02:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
2023-08-04 23:07:15 +02:00
- **Accept**: application/json
2022-07-13 14:23:48 +02:00
[[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)
# **getCuratedLocations**
> List<CuratedLocationsResponseDto> getCuratedLocations()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getCuratedLocations();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getCuratedLocations: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<CuratedLocationsResponseDto>** ](CuratedLocationsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getCuratedObjects**
> List<CuratedObjectsResponseDto> getCuratedObjects()
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
try {
final result = api_instance.getCuratedObjects();
print(result);
} catch (e) {
print('Exception when calling AssetApi->getCuratedObjects: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<CuratedObjectsResponseDto>** ](CuratedObjectsResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2023-06-30 18:24:28 +02:00
# **getDownloadInfo**
> DownloadResponseDto getDownloadInfo(assetIds, albumId, userId, archiveSize, key)
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final assetIds = []; // List< String > |
final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final archiveSize = 8.14; // num |
final key = key_example; // String |
try {
final result = api_instance.getDownloadInfo(assetIds, albumId, userId, archiveSize, key);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getDownloadInfo: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetIds** | [**List<String>** ](String.md )| | [optional] [default to const []]
**albumId** | **String** | | [optional]
**userId** | **String** | | [optional]
**archiveSize** | **num** | | [optional]
**key** | **String** | | [optional]
### Return type
[**DownloadResponseDto** ](DownloadResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2022-07-13 14:23:48 +02:00
2023-05-06 03:33:30 +02:00
# **getMapMarkers**
2023-05-25 18:47:52 +02:00
> List<MapMarkerResponseDto> getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore)
2023-05-06 03:33:30 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-08 21:59:33 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-05-06 03:33:30 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final isFavorite = true; // bool |
2023-05-25 18:47:52 +02:00
final fileCreatedAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final fileCreatedBefore = 2013-10-20T19:20:30+01:00; // DateTime |
2023-05-06 03:33:30 +02:00
try {
2023-05-25 18:47:52 +02:00
final result = api_instance.getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore);
2023-05-06 03:33:30 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getMapMarkers: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**isFavorite** | **bool** | | [optional]
2023-05-25 18:47:52 +02:00
**fileCreatedAfter** | **DateTime** | | [optional]
**fileCreatedBefore** | **DateTime** | | [optional]
2023-05-06 03:33:30 +02:00
### Return type
[**List<MapMarkerResponseDto>** ](MapMarkerResponseDto.md )
2023-06-15 03:47:18 +02:00
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
# **getMemoryLane**
2023-06-15 20:05:30 +02:00
> List<MemoryLaneResponseDto> getMemoryLane(timestamp)
2023-06-15 03:47:18 +02:00
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-15 20:05:30 +02:00
final timestamp = 2013-10-20T19:20:30+01:00; // DateTime | Get pictures for +24 hours from this time going back x years
2023-06-15 03:47:18 +02:00
try {
2023-06-15 20:05:30 +02:00
final result = api_instance.getMemoryLane(timestamp);
2023-06-15 03:47:18 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getMemoryLane: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-15 20:05:30 +02:00
**timestamp** | **DateTime** | Get pictures for +24 hours from this time going back x years |
2023-06-15 03:47:18 +02:00
### Return type
[**List<MemoryLaneResponseDto>** ](MemoryLaneResponseDto.md )
2023-05-06 03:33:30 +02:00
### Authorization
2023-05-08 21:59:33 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-05-06 03:33:30 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2023-08-04 23:07:15 +02:00
# **getTimeBuckets**
> List<TimeBucketResponseDto> getTimeBuckets(size, userId, albumId, isArchived, isFavorite, key)
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final size = ; // TimeBucketSize |
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final isArchived = true; // bool |
final isFavorite = true; // bool |
final key = key_example; // String |
try {
final result = api_instance.getTimeBuckets(size, userId, albumId, isArchived, isFavorite, key);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getTimeBuckets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**size** | [**TimeBucketSize** ](.md )| |
**userId** | **String** | | [optional]
**albumId** | **String** | | [optional]
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
**key** | **String** | | [optional]
### Return type
[**List<TimeBucketResponseDto>** ](TimeBucketResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
2022-07-13 14:23:48 +02:00
# **getUserAssetsByDeviceId**
> List<String> getUserAssetsByDeviceId(deviceId)
Get all asset of a device that are in the database, ID only.
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-04-05 00:24:08 +02:00
final deviceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-13 14:23:48 +02:00
try {
final result = api_instance.getUserAssetsByDeviceId(deviceId);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getUserAssetsByDeviceId: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceId** | **String** | |
### Return type
**List< String > **
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[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)
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 04:33:20 +02:00
# **importFile**
> AssetFileUploadResponseDto importFile(importAssetDto)
### Example
```dart
import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final importAssetDto = ImportAssetDto(); // ImportAssetDto |
try {
final result = api_instance.importFile(importAssetDto);
print(result);
} catch (e) {
print('Exception when calling AssetApi->importFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**importAssetDto** | [**ImportAssetDto** ](ImportAssetDto.md )| |
### Return type
[**AssetFileUploadResponseDto** ](AssetFileUploadResponseDto.md )
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2023-02-15 23:21:22 +02:00
# **searchAsset**
> List<AssetResponseDto> searchAsset(searchAssetDto)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-02-15 23:21:22 +02:00
final searchAssetDto = SearchAssetDto(); // SearchAssetDto |
2022-07-13 14:23:48 +02:00
try {
2023-02-15 23:21:22 +02:00
final result = api_instance.searchAsset(searchAssetDto);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->searchAsset: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-02-15 23:21:22 +02:00
**searchAssetDto** | [**SearchAssetDto** ](SearchAssetDto.md )| |
2022-07-13 14:23:48 +02:00
### Return type
2023-02-15 23:21:22 +02:00
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2022-07-13 14:23:48 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
2023-02-15 23:21:22 +02:00
- **Content-Type**: application/json
2022-07-13 14:23:48 +02:00
- **Accept**: application/json
[[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)
2023-02-15 23:21:22 +02:00
# **serveFile**
2023-07-07 00:25:56 +02:00
> MultipartFile serveFile(id, isThumb, isWeb, key)
2023-02-15 23:21:22 +02:00
2022-11-08 18:20:36 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-11-08 18:20:36 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 23:21:22 +02:00
final isThumb = true; // bool |
final isWeb = true; // bool |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2022-11-08 18:20:36 +02:00
try {
2023-07-07 00:25:56 +02:00
final result = api_instance.serveFile(id, isThumb, isWeb, key);
print(result);
2022-11-08 18:20:36 +02:00
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->serveFile: $e\n');
2022-11-08 18:20:36 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-15 23:21:22 +02:00
**isThumb** | **bool** | | [optional]
**isWeb** | **bool** | | [optional]
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2022-11-08 18:20:36 +02:00
### Return type
2023-07-07 00:25:56 +02:00
[**MultipartFile** ](MultipartFile.md )
2022-11-08 18:20:36 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-11-08 18:20:36 +02:00
### HTTP request headers
2023-02-15 23:21:22 +02:00
- **Content-Type**: Not defined
2023-07-07 00:25:56 +02:00
- **Accept**: application/octet-stream
2022-11-08 18:20:36 +02:00
[[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)
2023-02-15 23:21:22 +02:00
# **updateAsset**
2023-06-02 04:19:25 +02:00
> AssetResponseDto updateAsset(id, updateAssetDto)
2023-01-15 07:49:47 +02:00
2023-02-15 23:21:22 +02:00
Update an asset
2023-01-15 07:49:47 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2023-01-15 07:49:47 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
2023-06-02 04:19:25 +02:00
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-02-15 23:21:22 +02:00
final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto |
2023-01-15 07:49:47 +02:00
try {
2023-06-02 04:19:25 +02:00
final result = api_instance.updateAsset(id, updateAssetDto);
2023-01-15 07:49:47 +02:00
print(result);
} catch (e) {
2023-02-15 23:21:22 +02:00
print('Exception when calling AssetApi->updateAsset: $e\n');
2023-01-15 07:49:47 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-06-02 04:19:25 +02:00
**id** | **String** | |
2023-02-15 23:21:22 +02:00
**updateAssetDto** | [**UpdateAssetDto** ](UpdateAssetDto.md )| |
2023-01-15 07:49:47 +02:00
### Return type
2023-02-15 23:21:22 +02:00
[**AssetResponseDto** ](AssetResponseDto.md )
2023-01-15 07:49:47 +02:00
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2023-01-15 07:49:47 +02:00
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[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)
2022-07-13 14:23:48 +02:00
# **uploadFile**
2023-08-01 18:49:18 +02:00
> AssetFileUploadResponseDto uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isReadOnly, isVisible, livePhotoData, sidecarData)
2022-07-13 14:23:48 +02:00
### Example
```dart
import 'package:openapi/api.dart';
2023-04-09 04:26:09 +02:00
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('cookie').apiKeyPrefix = 'Bearer';
2023-05-04 18:41:29 +02:00
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication< ApiKeyAuth > ('api_key').apiKeyPrefix = 'Bearer';
2022-07-13 14:23:48 +02:00
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication< HttpBearerAuth > ('bearer').setAccessToken(yourTokenGeneratorFunction);
final api_instance = AssetApi();
final assetData = BINARY_DATA_HERE; // MultipartFile |
2023-02-12 07:54:07 +02:00
final deviceAssetId = deviceAssetId_example; // String |
final deviceId = deviceId_example; // String |
2023-05-29 16:05:14 +02:00
final fileCreatedAt = 2013-10-20T19:20:30+01:00; // DateTime |
final fileModifiedAt = 2013-10-20T19:20:30+01:00; // DateTime |
2023-02-12 07:54:07 +02:00
final isFavorite = true; // bool |
2023-02-24 18:01:10 +02:00
final key = key_example; // String |
2023-08-01 18:49:18 +02:00
final duration = duration_example; // String |
2023-04-12 17:37:52 +02:00
final isArchived = true; // bool |
2023-08-01 18:49:18 +02:00
final isReadOnly = true; // bool |
2023-02-12 07:54:07 +02:00
final isVisible = true; // bool |
2023-08-01 18:49:18 +02:00
final livePhotoData = BINARY_DATA_HERE; // MultipartFile |
final sidecarData = BINARY_DATA_HERE; // MultipartFile |
2022-07-13 14:23:48 +02:00
try {
2023-08-01 18:49:18 +02:00
final result = api_instance.uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isReadOnly, isVisible, livePhotoData, sidecarData);
2022-07-13 14:23:48 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->uploadFile: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetData** | **MultipartFile** | |
2023-02-12 07:54:07 +02:00
**deviceAssetId** | **String** | |
**deviceId** | **String** | |
2023-05-29 16:05:14 +02:00
**fileCreatedAt** | **DateTime** | |
**fileModifiedAt** | **DateTime** | |
2023-02-12 07:54:07 +02:00
**isFavorite** | **bool** | |
2023-02-24 18:01:10 +02:00
**key** | **String** | | [optional]
2023-08-01 18:49:18 +02:00
**duration** | **String** | | [optional]
2023-04-12 17:37:52 +02:00
**isArchived** | **bool** | | [optional]
2023-08-01 18:49:18 +02:00
**isReadOnly** | **bool** | | [optional] [default to false]
2023-02-12 07:54:07 +02:00
**isVisible** | **bool** | | [optional]
2023-08-01 18:49:18 +02:00
**livePhotoData** | **MultipartFile** | | [optional]
**sidecarData** | **MultipartFile** | | [optional]
2022-07-13 14:23:48 +02:00
### Return type
[**AssetFileUploadResponseDto** ](AssetFileUploadResponseDto.md )
### Authorization
2023-05-04 18:41:29 +02:00
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
2022-07-13 14:23:48 +02:00
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
[[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)