feat: fixed for the issue (#19)

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release Note
 
+## v0.3.0
+
+- Supported `preferences API methods`. ([#19](https://github.com/mastodon-dart/mastodon-api/issues/19))
+  - `GET /api/v1/preferences`
+
 ## v0.2.1
 
 - Added links of `Accounts Service` in `README`.

analysis_options.yaml

@@ -17,7 +17,6 @@ analyzer:
   exclude:
     - "**/*.freezed.dart"
     - "**/*.g.dart"
-    - "test/**/*"
   errors:
     invalid_annotation_target: ignore
 

lib/mastodon_api.dart

@@ -16,12 +16,14 @@ export 'package:mastodon_api/src/core/scope.dart';
 export 'package:mastodon_api/src/core/visibility.dart';
 export 'package:mastodon_api/src/mastodon_api.dart';
 export 'package:mastodon_api/src/service/entities/account.dart';
+export 'package:mastodon_api/src/service/entities/account_preferences.dart';
 export 'package:mastodon_api/src/service/entities/announcement.dart';
 export 'package:mastodon_api/src/service/entities/announcement_account.dart';
 export 'package:mastodon_api/src/service/entities/announcement_status.dart';
 export 'package:mastodon_api/src/service/entities/application.dart';
 export 'package:mastodon_api/src/service/entities/block_severity.dart';
 export 'package:mastodon_api/src/service/entities/blocked_domain.dart';
+export 'package:mastodon_api/src/service/entities/display_media_setting.dart';
 export 'package:mastodon_api/src/service/entities/emoji.dart';
 export 'package:mastodon_api/src/service/entities/emoji_reaction.dart';
 export 'package:mastodon_api/src/service/entities/extended_description.dart';

lib/src/service/entities/account_preferences.dart

@@ -0,0 +1,43 @@
+// Copyright 2022 Kato Shinya. All rights reserved.
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided the conditions.
+
+// ignore_for_file: invalid_annotation_target
+
+// 📦 Package imports:
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+import '../../core/language.dart';
+import '../../core/visibility.dart';
+import 'display_media_setting.dart';
+
+part 'account_preferences.freezed.dart';
+part 'account_preferences.g.dart';
+
+@freezed
+class AccountPreferences with _$AccountPreferences {
+  @JsonSerializable(includeIfNull: false)
+  const factory AccountPreferences({
+    /// `posting:default:visibility`
+    @JsonKey(name: 'posting:default:visibility')
+        required Visibility defaultVisibility,
+
+    /// `posting:default:sensitive`
+    @JsonKey(name: 'posting:default:sensitive')
+        required bool isDefaultSensitive,
+
+    /// `posting:default:language`
+    @JsonKey(name: 'posting:default:language')
+        required Language defaultLanguage,
+
+    /// `reading:expand:media`
+    @JsonKey(name: 'reading:expand:media')
+        required DisplayMediaSetting expandMediaSetting,
+
+    /// `reading:expand:spoilers`
+    @JsonKey(name: 'reading:expand:spoilers') required bool hasExpandSpoilers,
+  }) = _AccountPreferences;
+
+  factory AccountPreferences.fromJson(Map<String, Object?> json) =>
+      _$AccountPreferencesFromJson(json);
+}

lib/src/service/entities/account_preferences.freezed.dart

@@ -0,0 +1,312 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint
+// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target
+
+part of 'account_preferences.dart';
+
+// **************************************************************************
+// FreezedGenerator
+// **************************************************************************
+
+T _$identity<T>(T value) => value;
+
+final _privateConstructorUsedError = UnsupportedError(
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#custom-getters-and-methods');
+
+AccountPreferences _$AccountPreferencesFromJson(Map<String, dynamic> json) {
+  return _AccountPreferences.fromJson(json);
+}
+
+/// @nodoc
+mixin _$AccountPreferences {
+  /// `posting:default:visibility`
+  @JsonKey(name: 'posting:default:visibility')
+  Visibility get defaultVisibility => throw _privateConstructorUsedError;
+
+  /// `posting:default:sensitive`
+  @JsonKey(name: 'posting:default:sensitive')
+  bool get isDefaultSensitive => throw _privateConstructorUsedError;
+
+  /// `posting:default:language`
+  @JsonKey(name: 'posting:default:language')
+  Language get defaultLanguage => throw _privateConstructorUsedError;
+
+  /// `reading:expand:media`
+  @JsonKey(name: 'reading:expand:media')
+  DisplayMediaSetting get expandMediaSetting =>
+      throw _privateConstructorUsedError;
+
+  /// `reading:expand:spoilers`
+  @JsonKey(name: 'reading:expand:spoilers')
+  bool get hasExpandSpoilers => throw _privateConstructorUsedError;
+
+  Map<String, dynamic> toJson() => throw _privateConstructorUsedError;
+  @JsonKey(ignore: true)
+  $AccountPreferencesCopyWith<AccountPreferences> get copyWith =>
+      throw _privateConstructorUsedError;
+}
+
+/// @nodoc
+abstract class $AccountPreferencesCopyWith<$Res> {
+  factory $AccountPreferencesCopyWith(
+          AccountPreferences value, $Res Function(AccountPreferences) then) =
+      _$AccountPreferencesCopyWithImpl<$Res, AccountPreferences>;
+  @useResult
+  $Res call(
+      {@JsonKey(name: 'posting:default:visibility')
+          Visibility defaultVisibility,
+      @JsonKey(name: 'posting:default:sensitive')
+          bool isDefaultSensitive,
+      @JsonKey(name: 'posting:default:language')
+          Language defaultLanguage,
+      @JsonKey(name: 'reading:expand:media')
+          DisplayMediaSetting expandMediaSetting,
+      @JsonKey(name: 'reading:expand:spoilers')
+          bool hasExpandSpoilers});
+}
+
+/// @nodoc
+class _$AccountPreferencesCopyWithImpl<$Res, $Val extends AccountPreferences>
+    implements $AccountPreferencesCopyWith<$Res> {
+  _$AccountPreferencesCopyWithImpl(this._value, this._then);
+
+  // ignore: unused_field
+  final $Val _value;
+  // ignore: unused_field
+  final $Res Function($Val) _then;
+
+  @pragma('vm:prefer-inline')
+  @override
+  $Res call({
+    Object? defaultVisibility = null,
+    Object? isDefaultSensitive = null,
+    Object? defaultLanguage = null,
+    Object? expandMediaSetting = null,
+    Object? hasExpandSpoilers = null,
+  }) {
+    return _then(_value.copyWith(
+      defaultVisibility: null == defaultVisibility
+          ? _value.defaultVisibility
+          : defaultVisibility // ignore: cast_nullable_to_non_nullable
+              as Visibility,
+      isDefaultSensitive: null == isDefaultSensitive
+          ? _value.isDefaultSensitive
+          : isDefaultSensitive // ignore: cast_nullable_to_non_nullable
+              as bool,
+      defaultLanguage: null == defaultLanguage
+          ? _value.defaultLanguage
+          : defaultLanguage // ignore: cast_nullable_to_non_nullable
+              as Language,
+      expandMediaSetting: null == expandMediaSetting
+          ? _value.expandMediaSetting
+          : expandMediaSetting // ignore: cast_nullable_to_non_nullable
+              as DisplayMediaSetting,
+      hasExpandSpoilers: null == hasExpandSpoilers
+          ? _value.hasExpandSpoilers
+          : hasExpandSpoilers // ignore: cast_nullable_to_non_nullable
+              as bool,
+    ) as $Val);
+  }
+}
+
+/// @nodoc
+abstract class _$$_AccountPreferencesCopyWith<$Res>
+    implements $AccountPreferencesCopyWith<$Res> {
+  factory _$$_AccountPreferencesCopyWith(_$_AccountPreferences value,
+          $Res Function(_$_AccountPreferences) then) =
+      __$$_AccountPreferencesCopyWithImpl<$Res>;
+  @override
+  @useResult
+  $Res call(
+      {@JsonKey(name: 'posting:default:visibility')
+          Visibility defaultVisibility,
+      @JsonKey(name: 'posting:default:sensitive')
+          bool isDefaultSensitive,
+      @JsonKey(name: 'posting:default:language')
+          Language defaultLanguage,
+      @JsonKey(name: 'reading:expand:media')
+          DisplayMediaSetting expandMediaSetting,
+      @JsonKey(name: 'reading:expand:spoilers')
+          bool hasExpandSpoilers});
+}
+
+/// @nodoc
+class __$$_AccountPreferencesCopyWithImpl<$Res>
+    extends _$AccountPreferencesCopyWithImpl<$Res, _$_AccountPreferences>
+    implements _$$_AccountPreferencesCopyWith<$Res> {
+  __$$_AccountPreferencesCopyWithImpl(
+      _$_AccountPreferences _value, $Res Function(_$_AccountPreferences) _then)
+      : super(_value, _then);
+
+  @pragma('vm:prefer-inline')
+  @override
+  $Res call({
+    Object? defaultVisibility = null,
+    Object? isDefaultSensitive = null,
+    Object? defaultLanguage = null,
+    Object? expandMediaSetting = null,
+    Object? hasExpandSpoilers = null,
+  }) {
+    return _then(_$_AccountPreferences(
+      defaultVisibility: null == defaultVisibility
+          ? _value.defaultVisibility
+          : defaultVisibility // ignore: cast_nullable_to_non_nullable
+              as Visibility,
+      isDefaultSensitive: null == isDefaultSensitive
+          ? _value.isDefaultSensitive
+          : isDefaultSensitive // ignore: cast_nullable_to_non_nullable
+              as bool,
+      defaultLanguage: null == defaultLanguage
+          ? _value.defaultLanguage
+          : defaultLanguage // ignore: cast_nullable_to_non_nullable
+              as Language,
+      expandMediaSetting: null == expandMediaSetting
+          ? _value.expandMediaSetting
+          : expandMediaSetting // ignore: cast_nullable_to_non_nullable
+              as DisplayMediaSetting,
+      hasExpandSpoilers: null == hasExpandSpoilers
+          ? _value.hasExpandSpoilers
+          : hasExpandSpoilers // ignore: cast_nullable_to_non_nullable
+              as bool,
+    ));
+  }
+}
+
+/// @nodoc
+
+@JsonSerializable(includeIfNull: false)
+class _$_AccountPreferences implements _AccountPreferences {
+  const _$_AccountPreferences(
+      {@JsonKey(name: 'posting:default:visibility')
+          required this.defaultVisibility,
+      @JsonKey(name: 'posting:default:sensitive')
+          required this.isDefaultSensitive,
+      @JsonKey(name: 'posting:default:language')
+          required this.defaultLanguage,
+      @JsonKey(name: 'reading:expand:media')
+          required this.expandMediaSetting,
+      @JsonKey(name: 'reading:expand:spoilers')
+          required this.hasExpandSpoilers});
+
+  factory _$_AccountPreferences.fromJson(Map<String, dynamic> json) =>
+      _$$_AccountPreferencesFromJson(json);
+
+  /// `posting:default:visibility`
+  @override
+  @JsonKey(name: 'posting:default:visibility')
+  final Visibility defaultVisibility;
+
+  /// `posting:default:sensitive`
+  @override
+  @JsonKey(name: 'posting:default:sensitive')
+  final bool isDefaultSensitive;
+
+  /// `posting:default:language`
+  @override
+  @JsonKey(name: 'posting:default:language')
+  final Language defaultLanguage;
+
+  /// `reading:expand:media`
+  @override
+  @JsonKey(name: 'reading:expand:media')
+  final DisplayMediaSetting expandMediaSetting;
+
+  /// `reading:expand:spoilers`
+  @override
+  @JsonKey(name: 'reading:expand:spoilers')
+  final bool hasExpandSpoilers;
+
+  @override
+  String toString() {
+    return 'AccountPreferences(defaultVisibility: $defaultVisibility, isDefaultSensitive: $isDefaultSensitive, defaultLanguage: $defaultLanguage, expandMediaSetting: $expandMediaSetting, hasExpandSpoilers: $hasExpandSpoilers)';
+  }
+
+  @override
+  bool operator ==(dynamic other) {
+    return identical(this, other) ||
+        (other.runtimeType == runtimeType &&
+            other is _$_AccountPreferences &&
+            (identical(other.defaultVisibility, defaultVisibility) ||
+                other.defaultVisibility == defaultVisibility) &&
+            (identical(other.isDefaultSensitive, isDefaultSensitive) ||
+                other.isDefaultSensitive == isDefaultSensitive) &&
+            (identical(other.defaultLanguage, defaultLanguage) ||
+                other.defaultLanguage == defaultLanguage) &&
+            (identical(other.expandMediaSetting, expandMediaSetting) ||
+                other.expandMediaSetting == expandMediaSetting) &&
+            (identical(other.hasExpandSpoilers, hasExpandSpoilers) ||
+                other.hasExpandSpoilers == hasExpandSpoilers));
+  }
+
+  @JsonKey(ignore: true)
+  @override
+  int get hashCode => Object.hash(
+      runtimeType,
+      defaultVisibility,
+      isDefaultSensitive,
+      defaultLanguage,
+      expandMediaSetting,
+      hasExpandSpoilers);
+
+  @JsonKey(ignore: true)
+  @override
+  @pragma('vm:prefer-inline')
+  _$$_AccountPreferencesCopyWith<_$_AccountPreferences> get copyWith =>
+      __$$_AccountPreferencesCopyWithImpl<_$_AccountPreferences>(
+          this, _$identity);
+
+  @override
+  Map<String, dynamic> toJson() {
+    return _$$_AccountPreferencesToJson(
+      this,
+    );
+  }
+}
+
+abstract class _AccountPreferences implements AccountPreferences {
+  const factory _AccountPreferences(
+      {@JsonKey(name: 'posting:default:visibility')
+          required final Visibility defaultVisibility,
+      @JsonKey(name: 'posting:default:sensitive')
+          required final bool isDefaultSensitive,
+      @JsonKey(name: 'posting:default:language')
+          required final Language defaultLanguage,
+      @JsonKey(name: 'reading:expand:media')
+          required final DisplayMediaSetting expandMediaSetting,
+      @JsonKey(name: 'reading:expand:spoilers')
+          required final bool hasExpandSpoilers}) = _$_AccountPreferences;
+
+  factory _AccountPreferences.fromJson(Map<String, dynamic> json) =
+      _$_AccountPreferences.fromJson;
+
+  @override
+
+  /// `posting:default:visibility`
+  @JsonKey(name: 'posting:default:visibility')
+  Visibility get defaultVisibility;
+  @override
+
+  /// `posting:default:sensitive`
+  @JsonKey(name: 'posting:default:sensitive')
+  bool get isDefaultSensitive;
+  @override
+
+  /// `posting:default:language`
+  @JsonKey(name: 'posting:default:language')
+  Language get defaultLanguage;
+  @override
+
+  /// `reading:expand:media`
+  @JsonKey(name: 'reading:expand:media')
+  DisplayMediaSetting get expandMediaSetting;
+  @override
+
+  /// `reading:expand:spoilers`
+  @JsonKey(name: 'reading:expand:spoilers')
+  bool get hasExpandSpoilers;
+  @override
+  @JsonKey(ignore: true)
+  _$$_AccountPreferencesCopyWith<_$_AccountPreferences> get copyWith =>
+      throw _privateConstructorUsedError;
+}