feat(server, web): album orders (#7819)

* feat: album orders * fix: tests * pr feedback * pr feedback * pr feedback * fix: tests * add comment * pr feedback * fix: rendering issue * wording * fix: order value doesn't change --------- Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2024-03-14 17:45:03 +01:00
parent 1c4637cb43
commit 31f7e1aca3
32 changed files with 251 additions and 49 deletions
@@ -852,6 +852,8 @@ class AssetApi {
  ///
  /// * [String] key:
  ///
+  /// * [AssetOrder] order:
+  ///
  /// * [String] personId:
  ///
  /// * [String] userId:
@@ -859,7 +861,7 @@ class AssetApi {
  /// * [bool] withPartners:
  ///
  /// * [bool] withStacked:
-  Future<Response> getTimeBucketWithHttpInfo(TimeBucketSize size, String timeBucket, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
+  Future<Response> getTimeBucketWithHttpInfo(TimeBucketSize size, String timeBucket, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
    // ignore: prefer_const_declarations
    final path = r'/asset/time-bucket';

@@ -885,6 +887,9 @@ class AssetApi {
    if (key != null) {
      queryParams.addAll(_queryParams('', 'key', key));
    }
+    if (order != null) {
+      queryParams.addAll(_queryParams('', 'order', order));
+    }
    if (personId != null) {
      queryParams.addAll(_queryParams('', 'personId', personId));
    }
@@ -930,6 +935,8 @@ class AssetApi {
  ///
  /// * [String] key:
  ///
+  /// * [AssetOrder] order:
+  ///
  /// * [String] personId:
  ///
  /// * [String] userId:
@@ -937,8 +944,8 @@ class AssetApi {
  /// * [bool] withPartners:
  ///
  /// * [bool] withStacked:
-  Future<List<AssetResponseDto>?> getTimeBucket(TimeBucketSize size, String timeBucket, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
-    final response = await getTimeBucketWithHttpInfo(size, timeBucket,  albumId: albumId, isArchived: isArchived, isFavorite: isFavorite, isTrashed: isTrashed, key: key, personId: personId, userId: userId, withPartners: withPartners, withStacked: withStacked, );
+  Future<List<AssetResponseDto>?> getTimeBucket(TimeBucketSize size, String timeBucket, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
+    final response = await getTimeBucketWithHttpInfo(size, timeBucket,  albumId: albumId, isArchived: isArchived, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, userId: userId, withPartners: withPartners, withStacked: withStacked, );
    if (response.statusCode >= HttpStatus.badRequest) {
      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
    }
@@ -970,6 +977,8 @@ class AssetApi {
  ///
  /// * [String] key:
  ///
+  /// * [AssetOrder] order:
+  ///
  /// * [String] personId:
  ///
  /// * [String] userId:
@@ -977,7 +986,7 @@ class AssetApi {
  /// * [bool] withPartners:
  ///
  /// * [bool] withStacked:
-  Future<Response> getTimeBucketsWithHttpInfo(TimeBucketSize size, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
+  Future<Response> getTimeBucketsWithHttpInfo(TimeBucketSize size, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
    // ignore: prefer_const_declarations
    final path = r'/asset/time-buckets';

@@ -1003,6 +1012,9 @@ class AssetApi {
    if (key != null) {
      queryParams.addAll(_queryParams('', 'key', key));
    }
+    if (order != null) {
+      queryParams.addAll(_queryParams('', 'order', order));
+    }
    if (personId != null) {
      queryParams.addAll(_queryParams('', 'personId', personId));
    }
@@ -1045,6 +1057,8 @@ class AssetApi {
  ///
  /// * [String] key:
  ///
+  /// * [AssetOrder] order:
+  ///
  /// * [String] personId:
  ///
  /// * [String] userId:
@@ -1052,8 +1066,8 @@ class AssetApi {
  /// * [bool] withPartners:
  ///
  /// * [bool] withStacked:
-  Future<List<TimeBucketResponseDto>?> getTimeBuckets(TimeBucketSize size, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
-    final response = await getTimeBucketsWithHttpInfo(size,  albumId: albumId, isArchived: isArchived, isFavorite: isFavorite, isTrashed: isTrashed, key: key, personId: personId, userId: userId, withPartners: withPartners, withStacked: withStacked, );
+  Future<List<TimeBucketResponseDto>?> getTimeBuckets(TimeBucketSize size, { String? albumId, bool? isArchived, bool? isFavorite, bool? isTrashed, String? key, AssetOrder? order, String? personId, String? userId, bool? withPartners, bool? withStacked, }) async {
+    final response = await getTimeBucketsWithHttpInfo(size,  albumId: albumId, isArchived: isArchived, isFavorite: isFavorite, isTrashed: isTrashed, key: key, order: order, personId: personId, userId: userId, withPartners: withPartners, withStacked: withStacked, );
    if (response.statusCode >= HttpStatus.badRequest) {
      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
    }
@@ -24,6 +24,7 @@ class AlbumResponseDto {
    required this.id,
    required this.isActivityEnabled,
    this.lastModifiedAssetTimestamp,
+    this.order,
    required this.owner,
    required this.ownerId,
    required this.shared,
@@ -66,6 +67,14 @@ class AlbumResponseDto {
  ///
  DateTime? lastModifiedAssetTimestamp;

+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  AssetOrder? order;
+
  UserResponseDto owner;

  String ownerId;
@@ -97,6 +106,7 @@ class AlbumResponseDto {
    other.id == id &&
    other.isActivityEnabled == isActivityEnabled &&
    other.lastModifiedAssetTimestamp == lastModifiedAssetTimestamp &&
+    other.order == order &&
    other.owner == owner &&
    other.ownerId == ownerId &&
    other.shared == shared &&
@@ -118,6 +128,7 @@ class AlbumResponseDto {
    (id.hashCode) +
    (isActivityEnabled.hashCode) +
    (lastModifiedAssetTimestamp == null ? 0 : lastModifiedAssetTimestamp!.hashCode) +
+    (order == null ? 0 : order!.hashCode) +
    (owner.hashCode) +
    (ownerId.hashCode) +
    (shared.hashCode) +
@@ -126,7 +137,7 @@ class AlbumResponseDto {
    (updatedAt.hashCode);

  @override
-  String toString() => 'AlbumResponseDto[albumName=$albumName, albumThumbnailAssetId=$albumThumbnailAssetId, assetCount=$assetCount, assets=$assets, createdAt=$createdAt, description=$description, endDate=$endDate, hasSharedLink=$hasSharedLink, id=$id, isActivityEnabled=$isActivityEnabled, lastModifiedAssetTimestamp=$lastModifiedAssetTimestamp, owner=$owner, ownerId=$ownerId, shared=$shared, sharedUsers=$sharedUsers, startDate=$startDate, updatedAt=$updatedAt]';
+  String toString() => 'AlbumResponseDto[albumName=$albumName, albumThumbnailAssetId=$albumThumbnailAssetId, assetCount=$assetCount, assets=$assets, createdAt=$createdAt, description=$description, endDate=$endDate, hasSharedLink=$hasSharedLink, id=$id, isActivityEnabled=$isActivityEnabled, lastModifiedAssetTimestamp=$lastModifiedAssetTimestamp, order=$order, owner=$owner, ownerId=$ownerId, shared=$shared, sharedUsers=$sharedUsers, startDate=$startDate, updatedAt=$updatedAt]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
@@ -152,6 +163,11 @@ class AlbumResponseDto {
      json[r'lastModifiedAssetTimestamp'] = this.lastModifiedAssetTimestamp!.toUtc().toIso8601String();
    } else {
    //  json[r'lastModifiedAssetTimestamp'] = null;
+    }
+    if (this.order != null) {
+      json[r'order'] = this.order;
+    } else {
+    //  json[r'order'] = null;
    }
      json[r'owner'] = this.owner;
      json[r'ownerId'] = this.ownerId;
@@ -185,6 +201,7 @@ class AlbumResponseDto {
        id: mapValueOfType<String>(json, r'id')!,
        isActivityEnabled: mapValueOfType<bool>(json, r'isActivityEnabled')!,
        lastModifiedAssetTimestamp: mapDateTime(json, r'lastModifiedAssetTimestamp', r''),
+        order: AssetOrder.fromJson(json[r'order']),
        owner: UserResponseDto.fromJson(json[r'owner'])!,
        ownerId: mapValueOfType<String>(json, r'ownerId')!,
        shared: mapValueOfType<bool>(json, r'shared')!,
@@ -17,6 +17,7 @@ class UpdateAlbumDto {
    this.albumThumbnailAssetId,
    this.description,
    this.isActivityEnabled,
+    this.order,
  });

  ///
@@ -51,12 +52,21 @@ class UpdateAlbumDto {
  ///
  bool? isActivityEnabled;

+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  AssetOrder? order;
+
  @override
  bool operator ==(Object other) => identical(this, other) || other is UpdateAlbumDto &&
    other.albumName == albumName &&
    other.albumThumbnailAssetId == albumThumbnailAssetId &&
    other.description == description &&
-    other.isActivityEnabled == isActivityEnabled;
+    other.isActivityEnabled == isActivityEnabled &&
+    other.order == order;

  @override
  int get hashCode =>
@@ -64,10 +74,11 @@ class UpdateAlbumDto {
    (albumName == null ? 0 : albumName!.hashCode) +
    (albumThumbnailAssetId == null ? 0 : albumThumbnailAssetId!.hashCode) +
    (description == null ? 0 : description!.hashCode) +
-    (isActivityEnabled == null ? 0 : isActivityEnabled!.hashCode);
+    (isActivityEnabled == null ? 0 : isActivityEnabled!.hashCode) +
+    (order == null ? 0 : order!.hashCode);

  @override
-  String toString() => 'UpdateAlbumDto[albumName=$albumName, albumThumbnailAssetId=$albumThumbnailAssetId, description=$description, isActivityEnabled=$isActivityEnabled]';
+  String toString() => 'UpdateAlbumDto[albumName=$albumName, albumThumbnailAssetId=$albumThumbnailAssetId, description=$description, isActivityEnabled=$isActivityEnabled, order=$order]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
@@ -91,6 +102,11 @@ class UpdateAlbumDto {
    } else {
    //  json[r'isActivityEnabled'] = null;
    }
+    if (this.order != null) {
+      json[r'order'] = this.order;
+    } else {
+    //  json[r'order'] = null;
+    }
    return json;
  }

@@ -106,6 +122,7 @@ class UpdateAlbumDto {
        albumThumbnailAssetId: mapValueOfType<String>(json, r'albumThumbnailAssetId'),
        description: mapValueOfType<String>(json, r'description'),
        isActivityEnabled: mapValueOfType<bool>(json, r'isActivityEnabled'),
+        order: AssetOrder.fromJson(json[r'order']),
      );
    }
    return null;