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-11-04 03:33:15 +02:00
[**checkBulkUpload** ](AssetApi.md#checkbulkupload ) | **POST** /asset/bulk-upload-check |
2022-10-25 16:51:03 +02:00
[**checkExistingAssets** ](AssetApi.md#checkexistingassets ) | **POST** /asset/exist |
2023-10-06 09:01:14 +02:00
[**deleteAssets** ](AssetApi.md#deleteassets ) | **DELETE** /asset |
2023-08-15 17:49:32 +02:00
[**downloadArchive** ](AssetApi.md#downloadarchive ) | **POST** /asset/download/archive |
2023-06-30 18:24:28 +02:00
[**downloadFile** ](AssetApi.md#downloadfile ) | **POST** /asset/download/{id} |
2023-10-06 09:01:14 +02:00
[**emptyTrash** ](AssetApi.md#emptytrash ) | **POST** /asset/trash/empty |
2022-07-13 14:23:48 +02:00
[**getAllAssets** ](AssetApi.md#getallassets ) | **GET** /asset |
2023-11-25 17:46:20 +02:00
[**getAllUserAssetsByDeviceId** ](AssetApi.md#getalluserassetsbydeviceid ) | **GET** /asset/device/{deviceId} |
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-11-04 03:33:15 +02:00
[**getAssetStatistics** ](AssetApi.md#getassetstatistics ) | **GET** /asset/statistics |
2023-06-02 04:19:25 +02:00
[**getAssetThumbnail** ](AssetApi.md#getassetthumbnail ) | **GET** /asset/thumbnail/{id} |
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-08-15 17:49:32 +02:00
[**getDownloadInfo** ](AssetApi.md#getdownloadinfo ) | **POST** /asset/download/info |
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-09-23 17:28:55 +02:00
[**getRandom** ](AssetApi.md#getrandom ) | **GET** /asset/random |
2023-11-04 03:33:15 +02:00
[**getTimeBucket** ](AssetApi.md#gettimebucket ) | **GET** /asset/time-bucket |
2023-08-04 23:07:15 +02:00
[**getTimeBuckets** ](AssetApi.md#gettimebuckets ) | **GET** /asset/time-buckets |
2023-10-06 09:01:14 +02:00
[**restoreAssets** ](AssetApi.md#restoreassets ) | **POST** /asset/restore |
[**restoreTrash** ](AssetApi.md#restoretrash ) | **POST** /asset/trash/restore |
2023-08-18 16:31:48 +02:00
[**runAssetJobs** ](AssetApi.md#runassetjobs ) | **POST** /asset/jobs |
2023-11-15 00:47:15 +02:00
[**searchAssets** ](AssetApi.md#searchassets ) | **GET** /assets |
2023-06-02 04:19:25 +02:00
[**serveFile** ](AssetApi.md#servefile ) | **GET** /asset/file/{id} |
[**updateAsset** ](AssetApi.md#updateasset ) | **PUT** /asset/{id} |
2023-08-16 22:04:55 +02:00
[**updateAssets** ](AssetApi.md#updateassets ) | **PUT** /asset |
2023-10-22 04:38:07 +02:00
[**updateStackParent** ](AssetApi.md#updatestackparent ) | **PUT** /asset/stack/parent |
2022-07-13 14:23:48 +02:00
[**uploadFile** ](AssetApi.md#uploadfile ) | **POST** /asset/upload |
2023-11-04 03:33:15 +02:00
# **checkBulkUpload**
> AssetBulkUploadCheckResponseDto checkBulkUpload(assetBulkUploadCheckDto)
2023-05-24 23:08:21 +02:00
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 {
2023-11-04 03:33:15 +02:00
final result = api_instance.checkBulkUpload(assetBulkUploadCheckDto);
2023-05-24 23:08:21 +02:00
print(result);
} catch (e) {
2023-11-04 03:33:15 +02:00
print('Exception when calling AssetApi->checkBulkUpload: $e\n');
2023-05-24 23:08:21 +02:00
}
```
### 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-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)
2023-10-06 09:01:14 +02:00
# **deleteAssets**
> deleteAssets(assetBulkDeleteDto)
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-10-06 09:01:14 +02:00
final assetBulkDeleteDto = AssetBulkDeleteDto(); // AssetBulkDeleteDto |
2022-07-13 14:23:48 +02:00
try {
2023-10-06 09:01:14 +02:00
api_instance.deleteAssets(assetBulkDeleteDto);
2022-07-13 14:23:48 +02:00
} catch (e) {
2023-10-06 09:01:14 +02:00
print('Exception when calling AssetApi->deleteAssets: $e\n');
2022-07-13 14:23:48 +02:00
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-10-06 09:01:14 +02:00
**assetBulkDeleteDto** | [**AssetBulkDeleteDto** ](AssetBulkDeleteDto.md )| |
2022-07-13 14:23:48 +02:00
### Return type
2023-10-06 09:01:14 +02:00
void (empty response body)
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**: application/json
2023-10-06 09:01:14 +02:00
- **Accept**: Not defined
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-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)
2023-10-06 09:01:14 +02:00
# **emptyTrash**
> emptyTrash()
### 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();
try {
api_instance.emptyTrash();
} catch (e) {
print('Exception when calling AssetApi->emptyTrash: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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**
2024-01-22 18:49:51 +02:00
> List<AssetResponseDto> getAllAssets(ifNoneMatch, isArchived, isFavorite, skip, take, updatedAfter, updatedBefore, userId)
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();
2024-01-22 18:49:51 +02:00
final ifNoneMatch = ifNoneMatch_example; // String | ETag of data already cached on the client
final isArchived = true; // bool |
final isFavorite = true; // bool |
2023-11-06 19:40:43 +02:00
final skip = 56; // int |
final take = 56; // int |
2023-08-24 21:28:50 +02:00
final updatedAfter = 2013-10-20T19:20:30+01:00; // DateTime |
2023-11-06 19:40:43 +02:00
final updatedBefore = 2013-10-20T19:20:30+01:00; // DateTime |
2024-01-22 18:49:51 +02:00
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2022-07-13 14:23:48 +02:00
try {
2024-01-22 18:49:51 +02:00
final result = api_instance.getAllAssets(ifNoneMatch, isArchived, isFavorite, skip, take, updatedAfter, updatedBefore, userId);
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
------------- | ------------- | ------------- | -------------
2024-01-22 18:49:51 +02:00
**ifNoneMatch** | **String** | ETag of data already cached on the client | [optional]
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
2023-11-06 19:40:43 +02:00
**skip** | **int** | | [optional]
**take** | **int** | | [optional]
2023-08-24 21:28:50 +02:00
**updatedAfter** | **DateTime** | | [optional]
2023-11-06 19:40:43 +02:00
**updatedBefore** | **DateTime** | | [optional]
2024-01-22 18:49:51 +02:00
**userId** | **String** | | [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)
2023-11-25 17:46:20 +02:00
# **getAllUserAssetsByDeviceId**
> List<String> getAllUserAssetsByDeviceId(deviceId)
Get all asset of a device that are in the database, ID only.
### 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 deviceId = deviceId_example; // String |
try {
final result = api_instance.getAllUserAssetsByDeviceId(deviceId);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAllUserAssetsByDeviceId: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deviceId** | **String** | |
### Return type
**List< String > **
### 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
# **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-11-04 03:33:15 +02:00
# **getAssetStatistics**
> AssetStatsResponseDto getAssetStatistics(isArchived, isFavorite, isTrashed)
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 |
2023-10-06 09:01:14 +02:00
final isTrashed = true; // bool |
2022-09-04 15:34:39 +02:00
try {
2023-11-04 03:33:15 +02:00
final result = api_instance.getAssetStatistics(isArchived, isFavorite, isTrashed);
2022-09-04 15:34:39 +02:00
print(result);
} catch (e) {
2023-11-04 03:33:15 +02:00
print('Exception when calling AssetApi->getAssetStatistics: $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]
2023-10-06 09:01:14 +02:00
**isTrashed** | **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-12-12 16:58:25 +02:00
- **Accept**: application/octet-stream
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**
2023-08-15 17:49:32 +02:00
> DownloadResponseDto getDownloadInfo(downloadInfoDto, key)
2023-06-30 18:24:28 +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-08-15 17:49:32 +02:00
final downloadInfoDto = DownloadInfoDto(); // DownloadInfoDto |
2023-06-30 18:24:28 +02:00
final key = key_example; // String |
try {
2023-08-15 17:49:32 +02:00
final result = api_instance.getDownloadInfo(downloadInfoDto, key);
2023-06-30 18:24:28 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getDownloadInfo: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2023-08-15 17:49:32 +02:00
**downloadInfoDto** | [**DownloadInfoDto** ](DownloadInfoDto.md )| |
2023-06-30 18:24:28 +02:00
**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
2023-08-15 17:49:32 +02:00
- **Content-Type**: application/json
2023-06-30 18:24:28 +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)
2022-07-13 14:23:48 +02:00
2023-05-06 03:33:30 +02:00
# **getMapMarkers**
2024-01-22 18:49:51 +02:00
> List<MapMarkerResponseDto> getMapMarkers(fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite)
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();
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 |
2024-01-22 18:49:51 +02:00
final isArchived = true; // bool |
final isFavorite = true; // bool |
2023-05-06 03:33:30 +02:00
try {
2024-01-22 18:49:51 +02:00
final result = api_instance.getMapMarkers(fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite);
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
------------- | ------------- | ------------- | -------------
2023-05-25 18:47:52 +02:00
**fileCreatedAfter** | **DateTime** | | [optional]
**fileCreatedBefore** | **DateTime** | | [optional]
2024-01-22 18:49:51 +02:00
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [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-10-05 00:11:11 +02:00
> List<MemoryLaneResponseDto> getMemoryLane(day, month)
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-10-05 00:11:11 +02:00
final day = 56; // int |
final month = 56; // int |
2023-06-15 03:47:18 +02:00
try {
2023-10-05 00:11:11 +02:00
final result = api_instance.getMemoryLane(day, month);
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-10-05 00:11:11 +02:00
**day** | **int** | |
**month** | **int** | |
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-09-23 17:28:55 +02:00
# **getRandom**
> List<AssetResponseDto> getRandom(count)
### 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 count = 8.14; // num |
try {
final result = api_instance.getRandom(count);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getRandom: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**count** | **num** | | [optional]
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2023-11-04 03:33:15 +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)
# **getTimeBucket**
2024-01-22 18:49:51 +02:00
> List<AssetResponseDto> getTimeBucket(size, timeBucket, albumId, isArchived, isFavorite, isTrashed, key, personId, userId, withPartners, withStacked)
2023-11-04 03:33:15 +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();
final size = ; // TimeBucketSize |
final timeBucket = timeBucket_example; // String |
final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final isArchived = true; // bool |
final isFavorite = true; // bool |
final isTrashed = true; // bool |
final key = key_example; // String |
2024-01-22 18:49:51 +02:00
final personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final withPartners = true; // bool |
final withStacked = true; // bool |
2023-11-04 03:33:15 +02:00
try {
2024-01-22 18:49:51 +02:00
final result = api_instance.getTimeBucket(size, timeBucket, albumId, isArchived, isFavorite, isTrashed, key, personId, userId, withPartners, withStacked);
2023-11-04 03:33:15 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getTimeBucket: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**size** | [**TimeBucketSize** ](.md )| |
**timeBucket** | **String** | |
**albumId** | **String** | | [optional]
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
**isTrashed** | **bool** | | [optional]
**key** | **String** | | [optional]
2024-01-22 18:49:51 +02:00
**personId** | **String** | | [optional]
**userId** | **String** | | [optional]
**withPartners** | **bool** | | [optional]
**withStacked** | **bool** | | [optional]
2023-11-04 03:33:15 +02:00
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.md )
2023-09-23 17:28:55 +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)
2023-05-06 03:33:30 +02:00
2023-08-04 23:07:15 +02:00
# **getTimeBuckets**
2024-01-22 18:49:51 +02:00
> List<TimeBucketResponseDto> getTimeBuckets(size, albumId, isArchived, isFavorite, isTrashed, key, personId, userId, withPartners, withStacked)
2023-08-04 23:07:15 +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();
final size = ; // TimeBucketSize |
final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final isArchived = true; // bool |
final isFavorite = true; // bool |
2023-10-06 09:01:14 +02:00
final isTrashed = true; // bool |
2023-08-04 23:07:15 +02:00
final key = key_example; // String |
2024-01-22 18:49:51 +02:00
final personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final withPartners = true; // bool |
final withStacked = true; // bool |
2023-08-04 23:07:15 +02:00
try {
2024-01-22 18:49:51 +02:00
final result = api_instance.getTimeBuckets(size, albumId, isArchived, isFavorite, isTrashed, key, personId, userId, withPartners, withStacked);
2023-08-04 23:07:15 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->getTimeBuckets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**size** | [**TimeBucketSize** ](.md )| |
**albumId** | **String** | | [optional]
**isArchived** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
2023-10-06 09:01:14 +02:00
**isTrashed** | **bool** | | [optional]
2023-08-04 23:07:15 +02:00
**key** | **String** | | [optional]
2024-01-22 18:49:51 +02:00
**personId** | **String** | | [optional]
**userId** | **String** | | [optional]
**withPartners** | **bool** | | [optional]
**withStacked** | **bool** | | [optional]
2023-08-04 23:07:15 +02:00
### 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)
2023-10-06 09:01:14 +02:00
# **restoreAssets**
> restoreAssets(bulkIdsDto)
### 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 bulkIdsDto = BulkIdsDto(); // BulkIdsDto |
try {
api_instance.restoreAssets(bulkIdsDto);
} catch (e) {
print('Exception when calling AssetApi->restoreAssets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bulkIdsDto** | [**BulkIdsDto** ](BulkIdsDto.md )| |
### Return type
void (empty response body)
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[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)
# **restoreTrash**
> restoreTrash()
### 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();
try {
api_instance.restoreTrash();
} catch (e) {
print('Exception when calling AssetApi->restoreTrash: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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-18 16:31:48 +02:00
# **runAssetJobs**
> runAssetJobs(assetJobsDto)
### 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 assetJobsDto = AssetJobsDto(); // AssetJobsDto |
try {
api_instance.runAssetJobs(assetJobsDto);
} catch (e) {
print('Exception when calling AssetApi->runAssetJobs: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetJobsDto** | [**AssetJobsDto** ](AssetJobsDto.md )| |
### Return type
void (empty response body)
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[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-11-15 00:47:15 +02:00
# **searchAssets**
2024-01-22 18:49:51 +02:00
> List<AssetResponseDto> searchAssets(checksum, city, country, createdAfter, createdBefore, deviceAssetId, deviceId, encodedVideoPath, id, isArchived, isEncoded, isExternal, isFavorite, isMotion, isOffline, isReadOnly, isVisible, lensModel, libraryId, make, model, order, originalFileName, originalPath, page, resizePath, size, state, takenAfter, takenBefore, trashedAfter, trashedBefore, type, updatedAfter, updatedBefore, webpPath, withDeleted, withExif, withPeople, withStacked)
2023-11-15 00:47:15 +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();
2024-01-22 18:49:51 +02:00
final checksum = checksum_example; // String |
final city = city_example; // String |
final country = country_example; // String |
final createdAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final createdBefore = 2013-10-20T19:20:30+01:00; // DateTime |
2023-11-15 00:47:15 +02:00
final deviceAssetId = deviceAssetId_example; // String |
final deviceId = deviceId_example; // String |
2024-01-22 18:49:51 +02:00
final encodedVideoPath = encodedVideoPath_example; // String |
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-11-15 00:47:15 +02:00
final isArchived = true; // bool |
final isEncoded = true; // bool |
final isExternal = true; // bool |
final isFavorite = true; // bool |
final isMotion = true; // bool |
final isOffline = true; // bool |
final isReadOnly = true; // bool |
final isVisible = true; // bool |
2024-01-22 18:49:51 +02:00
final lensModel = lensModel_example; // String |
final libraryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
2023-11-15 00:47:15 +02:00
final make = make_example; // String |
final model = model_example; // String |
2024-01-22 18:49:51 +02:00
final order = ; // AssetOrder |
final originalFileName = originalFileName_example; // String |
final originalPath = originalPath_example; // String |
2023-11-15 00:47:15 +02:00
final page = 8.14; // num |
2024-01-22 18:49:51 +02:00
final resizePath = resizePath_example; // String |
2023-11-15 00:47:15 +02:00
final size = 8.14; // num |
2024-01-22 18:49:51 +02:00
final state = state_example; // String |
final takenAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final takenBefore = 2013-10-20T19:20:30+01:00; // DateTime |
final trashedAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final trashedBefore = 2013-10-20T19:20:30+01:00; // DateTime |
final type = ; // AssetTypeEnum |
final updatedAfter = 2013-10-20T19:20:30+01:00; // DateTime |
final updatedBefore = 2013-10-20T19:20:30+01:00; // DateTime |
final webpPath = webpPath_example; // String |
final withDeleted = true; // bool |
final withExif = true; // bool |
final withPeople = true; // bool |
final withStacked = true; // bool |
2023-11-15 00:47:15 +02:00
try {
2024-01-22 18:49:51 +02:00
final result = api_instance.searchAssets(checksum, city, country, createdAfter, createdBefore, deviceAssetId, deviceId, encodedVideoPath, id, isArchived, isEncoded, isExternal, isFavorite, isMotion, isOffline, isReadOnly, isVisible, lensModel, libraryId, make, model, order, originalFileName, originalPath, page, resizePath, size, state, takenAfter, takenBefore, trashedAfter, trashedBefore, type, updatedAfter, updatedBefore, webpPath, withDeleted, withExif, withPeople, withStacked);
2023-11-15 00:47:15 +02:00
print(result);
} catch (e) {
print('Exception when calling AssetApi->searchAssets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
2024-01-22 18:49:51 +02:00
**checksum** | **String** | | [optional]
**city** | **String** | | [optional]
**country** | **String** | | [optional]
**createdAfter** | **DateTime** | | [optional]
**createdBefore** | **DateTime** | | [optional]
2023-11-15 00:47:15 +02:00
**deviceAssetId** | **String** | | [optional]
**deviceId** | **String** | | [optional]
2024-01-22 18:49:51 +02:00
**encodedVideoPath** | **String** | | [optional]
**id** | **String** | | [optional]
2023-11-15 00:47:15 +02:00
**isArchived** | **bool** | | [optional]
**isEncoded** | **bool** | | [optional]
**isExternal** | **bool** | | [optional]
**isFavorite** | **bool** | | [optional]
**isMotion** | **bool** | | [optional]
**isOffline** | **bool** | | [optional]
**isReadOnly** | **bool** | | [optional]
**isVisible** | **bool** | | [optional]
2024-01-22 18:49:51 +02:00
**lensModel** | **String** | | [optional]
**libraryId** | **String** | | [optional]
2023-11-15 00:47:15 +02:00
**make** | **String** | | [optional]
**model** | **String** | | [optional]
2024-01-22 18:49:51 +02:00
**order** | [**AssetOrder** ](.md )| | [optional]
**originalFileName** | **String** | | [optional]
**originalPath** | **String** | | [optional]
2023-11-15 00:47:15 +02:00
**page** | **num** | | [optional]
2024-01-22 18:49:51 +02:00
**resizePath** | **String** | | [optional]
2023-11-15 00:47:15 +02:00
**size** | **num** | | [optional]
2024-01-22 18:49:51 +02:00
**state** | **String** | | [optional]
**takenAfter** | **DateTime** | | [optional]
**takenBefore** | **DateTime** | | [optional]
**trashedAfter** | **DateTime** | | [optional]
**trashedBefore** | **DateTime** | | [optional]
**type** | [**AssetTypeEnum** ](.md )| | [optional]
**updatedAfter** | **DateTime** | | [optional]
**updatedBefore** | **DateTime** | | [optional]
**webpPath** | **String** | | [optional]
**withDeleted** | **bool** | | [optional]
**withExif** | **bool** | | [optional]
**withPeople** | **bool** | | [optional]
**withStacked** | **bool** | | [optional]
2023-11-15 00:47:15 +02:00
### Return type
[**List<AssetResponseDto>** ](AssetResponseDto.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)
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
### 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)
2023-08-16 22:04:55 +02:00
# **updateAssets**
> updateAssets(assetBulkUpdateDto)
### 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 assetBulkUpdateDto = AssetBulkUpdateDto(); // AssetBulkUpdateDto |
try {
api_instance.updateAssets(assetBulkUpdateDto);
} catch (e) {
print('Exception when calling AssetApi->updateAssets: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetBulkUpdateDto** | [**AssetBulkUpdateDto** ](AssetBulkUpdateDto.md )| |
### Return type
void (empty response body)
2023-10-22 04:38:07 +02:00
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[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)
# **updateStackParent**
> updateStackParent(updateStackParentDto)
### 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 updateStackParentDto = UpdateStackParentDto(); // UpdateStackParentDto |
try {
api_instance.updateStackParent(updateStackParentDto);
} catch (e) {
print('Exception when calling AssetApi->updateStackParent: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**updateStackParentDto** | [**UpdateStackParentDto** ](UpdateStackParentDto.md )| |
### Return type
void (empty response body)
2023-08-16 22:04:55 +02:00
### Authorization
[cookie ](../README.md#cookie ), [api_key ](../README.md#api_key ), [bearer ](../README.md#bearer )
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[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-11-06 16:04:39 +02:00
> AssetFileUploadResponseDto uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key, duration, isArchived, isExternal, isFavorite, isOffline, isReadOnly, isVisible, libraryId, 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-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-09-20 13:16:33 +02:00
final isExternal = true; // bool |
2023-11-06 16:04:39 +02:00
final isFavorite = true; // bool |
2023-09-20 13:16:33 +02:00
final isOffline = 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-09-20 13:16:33 +02:00
final libraryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
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-11-06 16:04:39 +02:00
final result = api_instance.uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, key, duration, isArchived, isExternal, isFavorite, isOffline, isReadOnly, isVisible, libraryId, 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-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-09-20 13:16:33 +02:00
**isExternal** | **bool** | | [optional]
2023-11-06 16:04:39 +02:00
**isFavorite** | **bool** | | [optional]
2023-09-20 13:16:33 +02:00
**isOffline** | **bool** | | [optional]
**isReadOnly** | **bool** | | [optional]
2023-02-12 07:54:07 +02:00
**isVisible** | **bool** | | [optional]
2023-09-20 13:16:33 +02:00
**libraryId** | **String** | | [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)