mirror of
				https://github.com/immich-app/immich.git
				synced 2025-10-31 02:39:03 -04:00 
			
		
		
		
	
		
			
				
	
	
		
			1783 lines
		
	
	
		
			65 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
		
			Generated
		
	
	
			
		
		
	
	
			1783 lines
		
	
	
		
			65 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
		
			Generated
		
	
	
| # openapi.api.AssetApi
 | |
| 
 | |
| ## Load the API package
 | |
| ```dart
 | |
| import 'package:openapi/api.dart';
 | |
| ```
 | |
| 
 | |
| All URIs are relative to */api*
 | |
| 
 | |
| Method | HTTP request | Description
 | |
| ------------- | ------------- | -------------
 | |
| [**bulkUploadCheck**](AssetApi.md#bulkuploadcheck) | **POST** /asset/bulk-upload-check | 
 | |
| [**checkExistingAssets**](AssetApi.md#checkexistingassets) | **POST** /asset/exist | 
 | |
| [**deleteAssets**](AssetApi.md#deleteassets) | **DELETE** /asset | 
 | |
| [**downloadArchive**](AssetApi.md#downloadarchive) | **POST** /asset/download/archive | 
 | |
| [**downloadFile**](AssetApi.md#downloadfile) | **POST** /asset/download/{id} | 
 | |
| [**emptyTrash**](AssetApi.md#emptytrash) | **POST** /asset/trash/empty | 
 | |
| [**getAllAssets**](AssetApi.md#getallassets) | **GET** /asset | 
 | |
| [**getAssetById**](AssetApi.md#getassetbyid) | **GET** /asset/assetById/{id} | 
 | |
| [**getAssetSearchTerms**](AssetApi.md#getassetsearchterms) | **GET** /asset/search-terms | 
 | |
| [**getAssetStats**](AssetApi.md#getassetstats) | **GET** /asset/statistics | 
 | |
| [**getAssetThumbnail**](AssetApi.md#getassetthumbnail) | **GET** /asset/thumbnail/{id} | 
 | |
| [**getByTimeBucket**](AssetApi.md#getbytimebucket) | **GET** /asset/time-bucket | 
 | |
| [**getCuratedLocations**](AssetApi.md#getcuratedlocations) | **GET** /asset/curated-locations | 
 | |
| [**getCuratedObjects**](AssetApi.md#getcuratedobjects) | **GET** /asset/curated-objects | 
 | |
| [**getDownloadInfo**](AssetApi.md#getdownloadinfo) | **POST** /asset/download/info | 
 | |
| [**getMapMarkers**](AssetApi.md#getmapmarkers) | **GET** /asset/map-marker | 
 | |
| [**getMemoryLane**](AssetApi.md#getmemorylane) | **GET** /asset/memory-lane | 
 | |
| [**getRandom**](AssetApi.md#getrandom) | **GET** /asset/random | 
 | |
| [**getTimeBuckets**](AssetApi.md#gettimebuckets) | **GET** /asset/time-buckets | 
 | |
| [**getUserAssetsByDeviceId**](AssetApi.md#getuserassetsbydeviceid) | **GET** /asset/{deviceId} | 
 | |
| [**importFile**](AssetApi.md#importfile) | **POST** /asset/import | 
 | |
| [**restoreAssets**](AssetApi.md#restoreassets) | **POST** /asset/restore | 
 | |
| [**restoreTrash**](AssetApi.md#restoretrash) | **POST** /asset/trash/restore | 
 | |
| [**runAssetJobs**](AssetApi.md#runassetjobs) | **POST** /asset/jobs | 
 | |
| [**searchAsset**](AssetApi.md#searchasset) | **POST** /asset/search | 
 | |
| [**serveFile**](AssetApi.md#servefile) | **GET** /asset/file/{id} | 
 | |
| [**updateAsset**](AssetApi.md#updateasset) | **PUT** /asset/{id} | 
 | |
| [**updateAssets**](AssetApi.md#updateassets) | **PUT** /asset | 
 | |
| [**updateStackParent**](AssetApi.md#updatestackparent) | **PUT** /asset/stack/parent | 
 | |
| [**uploadFile**](AssetApi.md#uploadfile) | **POST** /asset/upload | 
 | |
| 
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| # **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';
 | |
| // 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 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
 | |
| 
 | |
| [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)
 | |
| 
 | |
| # **deleteAssets**
 | |
| > deleteAssets(assetBulkDeleteDto)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 assetBulkDeleteDto = AssetBulkDeleteDto(); // AssetBulkDeleteDto | 
 | |
| 
 | |
| try {
 | |
|     api_instance.deleteAssets(assetBulkDeleteDto);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->deleteAssets: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **assetBulkDeleteDto** | [**AssetBulkDeleteDto**](AssetBulkDeleteDto.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)
 | |
| 
 | |
| # **downloadArchive**
 | |
| > MultipartFile downloadArchive(assetIdsDto, 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 assetIdsDto = AssetIdsDto(); // AssetIdsDto | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.downloadArchive(assetIdsDto, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->downloadArchive: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **assetIdsDto** | [**AssetIdsDto**](AssetIdsDto.md)|  | 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**MultipartFile**](MultipartFile.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/octet-stream
 | |
| 
 | |
| [[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)
 | |
| 
 | |
| # **downloadFile**
 | |
| > MultipartFile downloadFile(id, 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.downloadFile(id, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->downloadFile: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **id** | **String**|  | 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**MultipartFile**](MultipartFile.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/octet-stream
 | |
| 
 | |
| [[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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| # **getAllAssets**
 | |
| > List<AssetResponseDto> getAllAssets(userId, isFavorite, isArchived, skip, updatedAfter, ifNoneMatch)
 | |
| 
 | |
| 
 | |
| 
 | |
| Get all AssetEntity belong to the user
 | |
| 
 | |
| ### 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 userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final isFavorite = true; // bool | 
 | |
| final isArchived = true; // bool | 
 | |
| final skip = 8.14; // num | 
 | |
| final updatedAfter = 2013-10-20T19:20:30+01:00; // DateTime | 
 | |
| final ifNoneMatch = ifNoneMatch_example; // String | ETag of data already cached on the client
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getAllAssets(userId, isFavorite, isArchived, skip, updatedAfter, ifNoneMatch);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getAllAssets: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **userId** | **String**|  | [optional] 
 | |
|  **isFavorite** | **bool**|  | [optional] 
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **skip** | **num**|  | [optional] 
 | |
|  **updatedAfter** | **DateTime**|  | [optional] 
 | |
|  **ifNoneMatch** | **String**| ETag of data already cached on the client | [optional] 
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| # **getAssetById**
 | |
| > AssetResponseDto getAssetById(id, key)
 | |
| 
 | |
| 
 | |
| 
 | |
| Get a single asset's information
 | |
| 
 | |
| ### 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getAssetById(id, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getAssetById: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **id** | **String**|  | 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**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)
 | |
| 
 | |
| # **getAssetSearchTerms**
 | |
| > List<String> getAssetSearchTerms()
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 {
 | |
|     final result = api_instance.getAssetSearchTerms();
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getAssetSearchTerms: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| This endpoint does not need any parameter.
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| # **getAssetStats**
 | |
| > AssetStatsResponseDto getAssetStats(isArchived, isFavorite, isTrashed)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 isArchived = true; // bool | 
 | |
| final isFavorite = true; // bool | 
 | |
| final isTrashed = true; // bool | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getAssetStats(isArchived, isFavorite, isTrashed);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getAssetStats: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **isFavorite** | **bool**|  | [optional] 
 | |
|  **isTrashed** | **bool**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**AssetStatsResponseDto**](AssetStatsResponseDto.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)
 | |
| 
 | |
| # **getAssetThumbnail**
 | |
| > MultipartFile getAssetThumbnail(id, format, 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final format = ; // ThumbnailFormat | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getAssetThumbnail(id, format, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getAssetThumbnail: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **id** | **String**|  | 
 | |
|  **format** | [**ThumbnailFormat**](.md)|  | [optional] 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**MultipartFile**](MultipartFile.md)
 | |
| 
 | |
| ### Authorization
 | |
| 
 | |
| [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
 | |
| 
 | |
| ### HTTP request headers
 | |
| 
 | |
|  - **Content-Type**: Not defined
 | |
|  - **Accept**: image/jpeg, image/webp
 | |
| 
 | |
| [[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)
 | |
| 
 | |
| # **getByTimeBucket**
 | |
| > List<AssetResponseDto> getByTimeBucket(size, timeBucket, userId, albumId, personId, isArchived, isFavorite, isTrashed, withStacked, 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 timeBucket = timeBucket_example; // String | 
 | |
| final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final isArchived = true; // bool | 
 | |
| final isFavorite = true; // bool | 
 | |
| final isTrashed = true; // bool | 
 | |
| final withStacked = true; // bool | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getByTimeBucket(size, timeBucket, userId, albumId, personId, isArchived, isFavorite, isTrashed, withStacked, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getByTimeBucket: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **size** | [**TimeBucketSize**](.md)|  | 
 | |
|  **timeBucket** | **String**|  | 
 | |
|  **userId** | **String**|  | [optional] 
 | |
|  **albumId** | **String**|  | [optional] 
 | |
|  **personId** | **String**|  | [optional] 
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **isFavorite** | **bool**|  | [optional] 
 | |
|  **isTrashed** | **bool**|  | [optional] 
 | |
|  **withStacked** | **bool**|  | [optional] 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| # **getCuratedLocations**
 | |
| > List<CuratedLocationsResponseDto> getCuratedLocations()
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 {
 | |
|     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
 | |
| 
 | |
| [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)
 | |
| 
 | |
| # **getCuratedObjects**
 | |
| > List<CuratedObjectsResponseDto> getCuratedObjects()
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 {
 | |
|     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
 | |
| 
 | |
| [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)
 | |
| 
 | |
| # **getDownloadInfo**
 | |
| > DownloadResponseDto getDownloadInfo(downloadInfoDto, 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 downloadInfoDto = DownloadInfoDto(); // DownloadInfoDto | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getDownloadInfo(downloadInfoDto, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getDownloadInfo: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **downloadInfoDto** | [**DownloadInfoDto**](DownloadInfoDto.md)|  | 
 | |
|  **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**: 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)
 | |
| 
 | |
| # **getMapMarkers**
 | |
| > List<MapMarkerResponseDto> getMapMarkers(isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 isArchived = true; // bool | 
 | |
| final isFavorite = true; // bool | 
 | |
| final fileCreatedAfter = 2013-10-20T19:20:30+01:00; // DateTime | 
 | |
| final fileCreatedBefore = 2013-10-20T19:20:30+01:00; // DateTime | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getMapMarkers(isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getMapMarkers: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **isFavorite** | **bool**|  | [optional] 
 | |
|  **fileCreatedAfter** | **DateTime**|  | [optional] 
 | |
|  **fileCreatedBefore** | **DateTime**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**List<MapMarkerResponseDto>**](MapMarkerResponseDto.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)
 | |
| 
 | |
| # **getMemoryLane**
 | |
| > List<MemoryLaneResponseDto> getMemoryLane(day, month)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 day = 56; // int | 
 | |
| final month = 56; // int | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getMemoryLane(day, month);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->getMemoryLane: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **day** | **int**|  | 
 | |
|  **month** | **int**|  | 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**List<MemoryLaneResponseDto>**](MemoryLaneResponseDto.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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| # **getTimeBuckets**
 | |
| > List<TimeBucketResponseDto> getTimeBuckets(size, userId, albumId, personId, isArchived, isFavorite, isTrashed, withStacked, 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 personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final isArchived = true; // bool | 
 | |
| final isFavorite = true; // bool | 
 | |
| final isTrashed = true; // bool | 
 | |
| final withStacked = true; // bool | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.getTimeBuckets(size, userId, albumId, personId, isArchived, isFavorite, isTrashed, withStacked, 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] 
 | |
|  **personId** | **String**|  | [optional] 
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **isFavorite** | **bool**|  | [optional] 
 | |
|  **isTrashed** | **bool**|  | [optional] 
 | |
|  **withStacked** | **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)
 | |
| 
 | |
| # **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';
 | |
| // 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 = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| 
 | |
| 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
 | |
| 
 | |
| [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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| # **searchAsset**
 | |
| > List<AssetResponseDto> searchAsset(searchAssetDto)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 searchAssetDto = SearchAssetDto(); // SearchAssetDto | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.searchAsset(searchAssetDto);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->searchAsset: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **searchAssetDto** | [**SearchAssetDto**](SearchAssetDto.md)|  | 
 | |
| 
 | |
| ### 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**: 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)
 | |
| 
 | |
| # **serveFile**
 | |
| > MultipartFile serveFile(id, isThumb, isWeb, 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final isThumb = true; // bool | 
 | |
| final isWeb = true; // bool | 
 | |
| final key = key_example; // String | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.serveFile(id, isThumb, isWeb, key);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->serveFile: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **id** | **String**|  | 
 | |
|  **isThumb** | **bool**|  | [optional] 
 | |
|  **isWeb** | **bool**|  | [optional] 
 | |
|  **key** | **String**|  | [optional] 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**MultipartFile**](MultipartFile.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/octet-stream
 | |
| 
 | |
| [[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)
 | |
| 
 | |
| # **updateAsset**
 | |
| > AssetResponseDto updateAsset(id, updateAssetDto)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.updateAsset(id, updateAssetDto);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->updateAsset: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **id** | **String**|  | 
 | |
|  **updateAssetDto** | [**UpdateAssetDto**](UpdateAssetDto.md)|  | 
 | |
| 
 | |
| ### Return type
 | |
| 
 | |
| [**AssetResponseDto**](AssetResponseDto.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)
 | |
| 
 | |
| # **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)
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| ### 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)
 | |
| 
 | |
| # **uploadFile**
 | |
| > AssetFileUploadResponseDto uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isExternal, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData)
 | |
| 
 | |
| 
 | |
| 
 | |
| ### 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 assetData = BINARY_DATA_HERE; // MultipartFile | 
 | |
| final deviceAssetId = deviceAssetId_example; // String | 
 | |
| final deviceId = deviceId_example; // String | 
 | |
| final fileCreatedAt = 2013-10-20T19:20:30+01:00; // DateTime | 
 | |
| final fileModifiedAt = 2013-10-20T19:20:30+01:00; // DateTime | 
 | |
| final isFavorite = true; // bool | 
 | |
| final key = key_example; // String | 
 | |
| final duration = duration_example; // String | 
 | |
| final isArchived = true; // bool | 
 | |
| final isExternal = true; // bool | 
 | |
| final isOffline = true; // bool | 
 | |
| final isReadOnly = true; // bool | 
 | |
| final isVisible = true; // bool | 
 | |
| final libraryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
 | |
| final livePhotoData = BINARY_DATA_HERE; // MultipartFile | 
 | |
| final sidecarData = BINARY_DATA_HERE; // MultipartFile | 
 | |
| 
 | |
| try {
 | |
|     final result = api_instance.uploadFile(assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, key, duration, isArchived, isExternal, isOffline, isReadOnly, isVisible, libraryId, livePhotoData, sidecarData);
 | |
|     print(result);
 | |
| } catch (e) {
 | |
|     print('Exception when calling AssetApi->uploadFile: $e\n');
 | |
| }
 | |
| ```
 | |
| 
 | |
| ### Parameters
 | |
| 
 | |
| Name | Type | Description  | Notes
 | |
| ------------- | ------------- | ------------- | -------------
 | |
|  **assetData** | **MultipartFile**|  | 
 | |
|  **deviceAssetId** | **String**|  | 
 | |
|  **deviceId** | **String**|  | 
 | |
|  **fileCreatedAt** | **DateTime**|  | 
 | |
|  **fileModifiedAt** | **DateTime**|  | 
 | |
|  **isFavorite** | **bool**|  | 
 | |
|  **key** | **String**|  | [optional] 
 | |
|  **duration** | **String**|  | [optional] 
 | |
|  **isArchived** | **bool**|  | [optional] 
 | |
|  **isExternal** | **bool**|  | [optional] 
 | |
|  **isOffline** | **bool**|  | [optional] 
 | |
|  **isReadOnly** | **bool**|  | [optional] 
 | |
|  **isVisible** | **bool**|  | [optional] 
 | |
|  **libraryId** | **String**|  | [optional] 
 | |
|  **livePhotoData** | **MultipartFile**|  | [optional] 
 | |
|  **sidecarData** | **MultipartFile**|  | [optional] 
 | |
| 
 | |
| ### 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**: 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)
 | |
| 
 |