feat(mobile) duplicated asset upload handling mechanism (#853)

mobile/openapi/.openapi-generator/FILES

@@ -19,6 +19,8 @@ doc/AssetTypeEnum.md
 doc/AuthenticationApi.md
 doc/CheckDuplicateAssetDto.md
 doc/CheckDuplicateAssetResponseDto.md
+doc/CheckExistingAssetsDto.md
+doc/CheckExistingAssetsResponseDto.md
 doc/CreateAlbumDto.md
 doc/CreateDeviceInfoDto.md
 doc/CreateProfileImageResponseDto.md
@@ -93,6 +95,8 @@ lib/model/asset_response_dto.dart
 lib/model/asset_type_enum.dart
 lib/model/check_duplicate_asset_dto.dart
 lib/model/check_duplicate_asset_response_dto.dart
+lib/model/check_existing_assets_dto.dart
+lib/model/check_existing_assets_response_dto.dart
 lib/model/create_album_dto.dart
 lib/model/create_device_info_dto.dart
 lib/model/create_profile_image_response_dto.dart
@@ -133,3 +137,5 @@ lib/model/user_count_response_dto.dart
 lib/model/user_response_dto.dart
 lib/model/validate_access_token_response_dto.dart
 pubspec.yaml
+test/check_existing_assets_dto_test.dart
+test/check_existing_assets_response_dto_test.dart

mobile/openapi/README.md

@@ -76,6 +76,7 @@ Class | Method | HTTP request | Description
 *AlbumApi* | [**removeUserFromAlbum**](doc//AlbumApi.md#removeuserfromalbum) | **DELETE** /album/{albumId}/user/{userId} | 
 *AlbumApi* | [**updateAlbumInfo**](doc//AlbumApi.md#updatealbuminfo) | **PATCH** /album/{albumId} | 
 *AssetApi* | [**checkDuplicateAsset**](doc//AssetApi.md#checkduplicateasset) | **POST** /asset/check | 
+*AssetApi* | [**checkExistingAssets**](doc//AssetApi.md#checkexistingassets) | **POST** /asset/exist | 
 *AssetApi* | [**deleteAsset**](doc//AssetApi.md#deleteasset) | **DELETE** /asset | 
 *AssetApi* | [**downloadFile**](doc//AssetApi.md#downloadfile) | **GET** /asset/download | 
 *AssetApi* | [**getAllAssets**](doc//AssetApi.md#getallassets) | **GET** /asset | 
@@ -130,6 +131,8 @@ Class | Method | HTTP request | Description
  - [AssetTypeEnum](doc//AssetTypeEnum.md)
  - [CheckDuplicateAssetDto](doc//CheckDuplicateAssetDto.md)
  - [CheckDuplicateAssetResponseDto](doc//CheckDuplicateAssetResponseDto.md)
+ - [CheckExistingAssetsDto](doc//CheckExistingAssetsDto.md)
+ - [CheckExistingAssetsResponseDto](doc//CheckExistingAssetsResponseDto.md)
  - [CreateAlbumDto](doc//CreateAlbumDto.md)
  - [CreateDeviceInfoDto](doc//CreateDeviceInfoDto.md)
  - [CreateProfileImageResponseDto](doc//CreateProfileImageResponseDto.md)

mobile/openapi/doc/AssetApi.md

@@ -10,6 +10,7 @@ All URIs are relative to */api*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**checkDuplicateAsset**](AssetApi.md#checkduplicateasset) | **POST** /asset/check | 
+[**checkExistingAssets**](AssetApi.md#checkexistingassets) | **POST** /asset/exist | 
 [**deleteAsset**](AssetApi.md#deleteasset) | **DELETE** /asset | 
 [**downloadFile**](AssetApi.md#downloadfile) | **GET** /asset/download | 
 [**getAllAssets**](AssetApi.md#getallassets) | **GET** /asset | 
@@ -76,6 +77,55 @@ Name | Type | Description  | Notes
 
 [[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 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
+
+[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)
+
 # **deleteAsset**
 > List<DeleteAssetResponseDto> deleteAsset(deleteAssetDto)
 

mobile/openapi/doc/CheckExistingAssetsDto.md

@@ -0,0 +1,16 @@
+# openapi.model.CheckExistingAssetsDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deviceAssetIds** | **List<String>** |  | [default to const []]
+**deviceId** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

mobile/openapi/doc/CheckExistingAssetsResponseDto.md

@@ -0,0 +1,15 @@
+# openapi.model.CheckExistingAssetsResponseDto
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**existingIds** | **List<String>** |  | [default to const []]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

mobile/openapi/lib/api.dart

@@ -49,6 +49,8 @@ part 'model/asset_response_dto.dart';
 part 'model/asset_type_enum.dart';
 part 'model/check_duplicate_asset_dto.dart';
 part 'model/check_duplicate_asset_response_dto.dart';
+part 'model/check_existing_assets_dto.dart';
+part 'model/check_existing_assets_response_dto.dart';
 part 'model/create_album_dto.dart';
 part 'model/create_device_info_dto.dart';
 part 'model/create_profile_image_response_dto.dart';

mobile/openapi/lib/api/asset_api.dart

@@ -72,6 +72,62 @@ class AssetApi {
     return null;
   }
 
+  /// 
+  ///
+  /// Checks if multiple assets exist on the server and returns all existing - used by background backup
+  ///
+  /// Note: This method returns the HTTP [Response].
+  ///
+  /// Parameters:
+  ///
+  /// * [CheckExistingAssetsDto] checkExistingAssetsDto (required):
+  Future<Response> checkExistingAssetsWithHttpInfo(CheckExistingAssetsDto checkExistingAssetsDto,) async {
+    // ignore: prefer_const_declarations
+    final path = r'/asset/exist';
+
+    // ignore: prefer_final_locals
+    Object? postBody = checkExistingAssetsDto;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    const contentTypes = <String>['application/json'];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'POST',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// 
+  ///
+  /// Checks if multiple assets exist on the server and returns all existing - used by background backup
+  ///
+  /// Parameters:
+  ///
+  /// * [CheckExistingAssetsDto] checkExistingAssetsDto (required):
+  Future<CheckExistingAssetsResponseDto?> checkExistingAssets(CheckExistingAssetsDto checkExistingAssetsDto,) async {
+    final response = await checkExistingAssetsWithHttpInfo(checkExistingAssetsDto,);
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'CheckExistingAssetsResponseDto',) as CheckExistingAssetsResponseDto;
+    
+    }
+    return null;
+  }
+
   /// Performs an HTTP 'DELETE /asset' operation and returns the [Response].
   /// Parameters:
   ///

mobile/openapi/lib/api_client.dart

@@ -220,6 +220,10 @@ class ApiClient {
           return CheckDuplicateAssetDto.fromJson(value);
         case 'CheckDuplicateAssetResponseDto':
           return CheckDuplicateAssetResponseDto.fromJson(value);
+        case 'CheckExistingAssetsDto':
+          return CheckExistingAssetsDto.fromJson(value);
+        case 'CheckExistingAssetsResponseDto':
+          return CheckExistingAssetsResponseDto.fromJson(value);
         case 'CreateAlbumDto':
           return CreateAlbumDto.fromJson(value);
         case 'CreateDeviceInfoDto':

mobile/openapi/lib/model/check_existing_assets_dto.dart

@@ -0,0 +1,121 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class CheckExistingAssetsDto {
+  /// Returns a new [CheckExistingAssetsDto] instance.
+  CheckExistingAssetsDto({
+    this.deviceAssetIds = const [],
+    required this.deviceId,
+  });
+
+  List<String> deviceAssetIds;
+
+  String deviceId;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is CheckExistingAssetsDto &&
+     other.deviceAssetIds == deviceAssetIds &&
+     other.deviceId == deviceId;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (deviceAssetIds.hashCode) +
+    (deviceId.hashCode);
+
+  @override
+  String toString() => 'CheckExistingAssetsDto[deviceAssetIds=$deviceAssetIds, deviceId=$deviceId]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'deviceAssetIds'] = deviceAssetIds;
+      _json[r'deviceId'] = deviceId;
+    return _json;
+  }
+
+  /// Returns a new [CheckExistingAssetsDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static CheckExistingAssetsDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "CheckExistingAssetsDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "CheckExistingAssetsDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return CheckExistingAssetsDto(
+        deviceAssetIds: json[r'deviceAssetIds'] is List
+            ? (json[r'deviceAssetIds'] as List).cast<String>()
+            : const [],
+        deviceId: mapValueOfType<String>(json, r'deviceId')!,
+      );
+    }
+    return null;
+  }
+
+  static List<CheckExistingAssetsDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <CheckExistingAssetsDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = CheckExistingAssetsDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, CheckExistingAssetsDto> mapFromJson(dynamic json) {
+    final map = <String, CheckExistingAssetsDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = CheckExistingAssetsDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of CheckExistingAssetsDto-objects as value to a dart map
+  static Map<String, List<CheckExistingAssetsDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<CheckExistingAssetsDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = CheckExistingAssetsDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'deviceAssetIds',
+    'deviceId',
+  };
+}
+

mobile/openapi/lib/model/check_existing_assets_response_dto.dart

@@ -0,0 +1,113 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class CheckExistingAssetsResponseDto {
+  /// Returns a new [CheckExistingAssetsResponseDto] instance.
+  CheckExistingAssetsResponseDto({
+    this.existingIds = const [],
+  });
+
+  List<String> existingIds;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is CheckExistingAssetsResponseDto &&
+     other.existingIds == existingIds;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (existingIds.hashCode);
+
+  @override
+  String toString() => 'CheckExistingAssetsResponseDto[existingIds=$existingIds]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'existingIds'] = existingIds;
+    return _json;
+  }
+
+  /// Returns a new [CheckExistingAssetsResponseDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static CheckExistingAssetsResponseDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "CheckExistingAssetsResponseDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "CheckExistingAssetsResponseDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return CheckExistingAssetsResponseDto(
+        existingIds: json[r'existingIds'] is List
+            ? (json[r'existingIds'] as List).cast<String>()
+            : const [],
+      );
+    }
+    return null;
+  }
+
+  static List<CheckExistingAssetsResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <CheckExistingAssetsResponseDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = CheckExistingAssetsResponseDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, CheckExistingAssetsResponseDto> mapFromJson(dynamic json) {
+    final map = <String, CheckExistingAssetsResponseDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = CheckExistingAssetsResponseDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of CheckExistingAssetsResponseDto-objects as value to a dart map
+  static Map<String, List<CheckExistingAssetsResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<CheckExistingAssetsResponseDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = CheckExistingAssetsResponseDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'existingIds',
+  };
+}
+

mobile/openapi/test/check_existing_assets_dto_test.dart

@@ -0,0 +1,32 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+import 'package:openapi/api.dart';
+import 'package:test/test.dart';
+
+// tests for CheckExistingAssetsDto
+void main() {
+  // final instance = CheckExistingAssetsDto();
+
+  group('test CheckExistingAssetsDto', () {
+    // List<String> deviceAssetIds (default value: const [])
+    test('to test the property `deviceAssetIds`', () async {
+      // TODO
+    });
+
+    // String deviceId
+    test('to test the property `deviceId`', () async {
+      // TODO
+    });
+
+
+  });
+
+}

mobile/openapi/test/check_existing_assets_response_dto_test.dart

@@ -0,0 +1,27 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+import 'package:openapi/api.dart';
+import 'package:test/test.dart';
+
+// tests for CheckExistingAssetsResponseDto
+void main() {
+  // final instance = CheckExistingAssetsResponseDto();
+
+  group('test CheckExistingAssetsResponseDto', () {
+    // List<String> existingIds (default value: const [])
+    test('to test the property `existingIds`', () async {
+      // TODO
+    });
+
+
+  });
+
+}