feat!: rename FaceImage class to FaceImagePayload & remove ReadMemberLayoutAsync overload

sandbox/ConsoleAppSample/Program.cs

@@ -39,7 +39,7 @@ internal class Commands(ILogger<Commands> logger, IKaonaviClient client)
     public async Task Layout(CancellationToken cancellationToken)
     {
         cancellationToken.ThrowIfCancellationRequested();
-        var memberLayout = await client.Layout.ReadMemberLayoutAsync(cancellationToken).ConfigureAwait(false);
+        var memberLayout = await client.Layout.ReadMemberLayoutAsync(cancellationToken: cancellationToken).ConfigureAwait(false);
         logger.LogInformation("Received Layout: {memberLayout}", memberLayout);
     }
 

src/Kaonavi.NET.Core/Entities/FaceImage.cs → src/Kaonavi.NET.Core/Entities/FaceImagePayload.cs

@@ -5,4 +5,4 @@ namespace Kaonavi.Net.Entities;
 /// </summary>
 /// <param name="Code">社員番号</param>
 /// <param name="Content">顔写真画像(5MBまで)</param>
-public record FaceImage(string Code, [property: JsonPropertyName("base64_face_image")] byte[] Content);
+public record FaceImagePayload(string Code, [property: JsonPropertyName("base64_face_image")] byte[] Content);

src/Kaonavi.NET.Core/Json/Context.cs

@@ -6,7 +6,7 @@ namespace Kaonavi.Net.Json;
 [JsonSerializable(typeof(IReadOnlyList<Attachment>))]
 [JsonSerializable(typeof(IReadOnlyList<DepartmentTree>))]
 [JsonSerializable(typeof(IReadOnlyList<EnumOption>))]
-[JsonSerializable(typeof(IReadOnlyList<FaceImage>))]
+[JsonSerializable(typeof(IReadOnlyList<FaceImagePayload>))]
 [JsonSerializable(typeof(IReadOnlyList<FaceImageInfo>))]
 [JsonSerializable(typeof(IReadOnlyList<JsonElement>))]
 [JsonSerializable(typeof(IReadOnlyList<MemberData>))]

src/Kaonavi.NET.Core/KaonaviClient.Layout.cs

@@ -11,16 +11,13 @@ public partial class KaonaviClient : KaonaviClient.ILayout
     /// </summary>
     public interface ILayout
     {
-        /// <inheritdoc cref="ReadMemberLayoutAsync(bool, CancellationToken)"/>
-        public ValueTask<MemberLayout> ReadMemberLayoutAsync(CancellationToken cancellationToken = default) => ReadMemberLayoutAsync(false, cancellationToken);
-
         /// <summary>
         /// 使用可能なメンバーのレイアウト設定情報を全て取得します。
         /// <see href="https://developer.kaonavi.jp/api/v2.0/index.html#tag/%E3%83%AC%E3%82%A4%E3%82%A2%E3%82%A6%E3%83%88%E8%A8%AD%E5%AE%9A/paths/~1member_layouts/get"/>
         /// </summary>
         /// <param name="getCalcType">計算式パーツの取得</param>
         /// <param name="cancellationToken"><inheritdoc cref="HttpClient.SendAsync(HttpRequestMessage, CancellationToken)" path="/param[@name='cancellationToken']"/></param>
-        public ValueTask<MemberLayout> ReadMemberLayoutAsync(bool getCalcType, CancellationToken cancellationToken = default);
+        public ValueTask<MemberLayout> ReadMemberLayoutAsync(bool getCalcType = false, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// 使用可能なシートのレイアウト設定情報を全て取得します。

src/Kaonavi.NET.Core/KaonaviClient.Member.cs

@@ -134,7 +134,7 @@ public interface IMember
         /// </param>
         /// <param name="cancellationToken"><inheritdoc cref="HttpClient.SendAsync(HttpRequestMessage, CancellationToken)" path="/param[@name='cancellationToken']"/></param>
         /// <returns><inheritdoc cref="TaskProgress" path="/param[@name='Id']"/></returns>
-        public ValueTask<int> AddFaceImageAsync(IReadOnlyList<FaceImage> payload, bool enableTrimming = true, CancellationToken cancellationToken = default);
+        public ValueTask<int> AddFaceImageAsync(IReadOnlyList<FaceImagePayload> payload, bool enableTrimming = true, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// 指定したメンバーの顔写真を置き換えます。
@@ -161,7 +161,7 @@ public interface IMember
         /// <param name="enableTrimming"><inheritdoc cref="IMember.AddFaceImageAsync" path="/param[@name='enableTrimming']"/></param>
         /// <param name="cancellationToken"><inheritdoc cref="HttpClient.SendAsync(HttpRequestMessage, CancellationToken)" path="/param[@name='cancellationToken']"/></param>
         /// <returns><inheritdoc cref="TaskProgress" path="/param[@name='Id']"/></returns>
-        public ValueTask<int> UpdateFaceImageAsync(IReadOnlyList<FaceImage> payload, bool enableTrimming = true, CancellationToken cancellationToken = default);
+        public ValueTask<int> UpdateFaceImageAsync(IReadOnlyList<FaceImagePayload> payload, bool enableTrimming = true, CancellationToken cancellationToken = default);
     }
 
     /// <inheritdoc/>
@@ -196,11 +196,11 @@ ValueTask<IReadOnlyList<FaceImageInfo>> IMember.GetFaceImageListAsync(DateOnly u
         => CallApiAsync(new(HttpMethod.Get, $"members/face_image?updated_since={updatedSince:yyyy-MM-dd}"), "member_data", Context.Default.IReadOnlyListFaceImageInfo, cancellationToken);
 
     /// <inheritdoc/>
-    ValueTask<int> IMember.AddFaceImageAsync(IReadOnlyList<FaceImage> payload, bool enableTrimming, CancellationToken cancellationToken)
+    ValueTask<int> IMember.AddFaceImageAsync(IReadOnlyList<FaceImagePayload> payload, bool enableTrimming, CancellationToken cancellationToken)
         => CallFaceImageApiAsync(HttpMethod.Post, payload, enableTrimming, cancellationToken);
 
     /// <inheritdoc/>
-    ValueTask<int> IMember.UpdateFaceImageAsync(IReadOnlyList<FaceImage> payload, bool enableTrimming, CancellationToken cancellationToken)
+    ValueTask<int> IMember.UpdateFaceImageAsync(IReadOnlyList<FaceImagePayload> payload, bool enableTrimming, CancellationToken cancellationToken)
         => CallFaceImageApiAsync(HttpMethod.Patch, payload, enableTrimming, cancellationToken);
 
     /// <summary>
@@ -212,7 +212,7 @@ ValueTask<int> IMember.UpdateFaceImageAsync(IReadOnlyList<FaceImage> payload, bo
     /// <param name="cancellationToken"><inheritdoc cref="HttpClient.SendAsync(HttpRequestMessage, CancellationToken)" path="/param[@name='cancellationToken']"/></param>
     /// <returns><inheritdoc cref="TaskProgress" path="/param[@name='Id']"/></returns>
     /// <inheritdoc cref="ObjectDisposedException.ThrowIf(bool, Type)" path="/exception"/>
-    private ValueTask<int> CallFaceImageApiAsync(HttpMethod method, IReadOnlyList<FaceImage> payload, bool enableTrimming, CancellationToken cancellationToken)
+    private ValueTask<int> CallFaceImageApiAsync(HttpMethod method, IReadOnlyList<FaceImagePayload> payload, bool enableTrimming, CancellationToken cancellationToken)
     {
         ObjectDisposedException.ThrowIf(_disposedValue, GetType());
 
@@ -221,7 +221,7 @@ private ValueTask<int> CallFaceImageApiAsync(HttpMethod method, IReadOnlyList<Fa
         writer.WriteStartObject();
         writer.WriteBoolean("enable_trimming"u8, enableTrimming);
         writer.WritePropertyName("member_data"u8);
-        JsonSerializer.Serialize(writer, payload, Context.Default.IReadOnlyListFaceImage);
+        JsonSerializer.Serialize(writer, payload, Context.Default.IReadOnlyListFaceImagePayload);
         writer.WriteEndObject();
         writer.Flush();
 

src/Kaonavi.NET.Core/PublicAPI.Shipped.txt

@@ -88,14 +88,6 @@ Kaonavi.Net.Entities.EnumOption.Name.get -> string!
 Kaonavi.Net.Entities.EnumOption.Name.init -> void
 Kaonavi.Net.Entities.EnumOption.SheetName.get -> string!
 Kaonavi.Net.Entities.EnumOption.SheetName.init -> void
-Kaonavi.Net.Entities.FaceImage
-Kaonavi.Net.Entities.FaceImage.Code.get -> string!
-Kaonavi.Net.Entities.FaceImage.Code.init -> void
-Kaonavi.Net.Entities.FaceImage.Content.get -> byte[]!
-Kaonavi.Net.Entities.FaceImage.Content.init -> void
-Kaonavi.Net.Entities.FaceImage.Deconstruct(out string! Code, out byte[]! Content) -> void
-Kaonavi.Net.Entities.FaceImage.FaceImage(Kaonavi.Net.Entities.FaceImage! original) -> void
-Kaonavi.Net.Entities.FaceImage.FaceImage(string! Code, byte[]! Content) -> void
 Kaonavi.Net.Entities.FaceImageInfo
 Kaonavi.Net.Entities.FaceImageInfo.Code.get -> string!
 Kaonavi.Net.Entities.FaceImageInfo.Code.init -> void
@@ -366,18 +358,14 @@ Kaonavi.Net.KaonaviClient.IEnumOption.UpdateAsync(int id, System.Collections.Gen
 Kaonavi.Net.KaonaviClient.ILayout
 Kaonavi.Net.KaonaviClient.ILayout.ListAsync(bool getCalcType = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.SheetLayout!>!>
 Kaonavi.Net.KaonaviClient.ILayout.ReadAsync(int id, bool getCalcType = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Kaonavi.Net.Entities.SheetLayout!>
-Kaonavi.Net.KaonaviClient.ILayout.ReadMemberLayoutAsync(bool getCalcType, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Kaonavi.Net.Entities.MemberLayout!>
-Kaonavi.Net.KaonaviClient.ILayout.ReadMemberLayoutAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Kaonavi.Net.Entities.MemberLayout!>
 Kaonavi.Net.KaonaviClient.IMember
-Kaonavi.Net.KaonaviClient.IMember.AddFaceImageAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.FaceImage!>! payload, bool enableTrimming = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IMember.CreateAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.MemberData!>! payload, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IMember.DeleteAsync(System.Collections.Generic.IReadOnlyList<string!>! codes, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IMember.GetFaceImageListAsync(System.DateOnly updatedSince, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.FaceImageInfo!>!>
 Kaonavi.Net.KaonaviClient.IMember.ListAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.MemberData!>!>
 Kaonavi.Net.KaonaviClient.IMember.OverWriteAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.MemberData!>! payload, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IMember.ReplaceAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.MemberData!>! payload, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IMember.UpdateAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.MemberData!>! payload, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
-Kaonavi.Net.KaonaviClient.IMember.UpdateFaceImageAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.FaceImage!>! payload, bool enableTrimming = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
 Kaonavi.Net.KaonaviClient.IRole
 Kaonavi.Net.KaonaviClient.IRole.ListAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.Role!>!>
 Kaonavi.Net.KaonaviClient.ISheet
@@ -440,9 +428,6 @@ override Kaonavi.Net.Entities.EnumOption.Data.ToString() -> string!
 override Kaonavi.Net.Entities.EnumOption.Equals(object? obj) -> bool
 override Kaonavi.Net.Entities.EnumOption.GetHashCode() -> int
 override Kaonavi.Net.Entities.EnumOption.ToString() -> string!
-override Kaonavi.Net.Entities.FaceImage.Equals(object? obj) -> bool
-override Kaonavi.Net.Entities.FaceImage.GetHashCode() -> int
-override Kaonavi.Net.Entities.FaceImage.ToString() -> string!
 override Kaonavi.Net.Entities.FaceImageInfo.Equals(object? obj) -> bool
 override Kaonavi.Net.Entities.FaceImageInfo.GetHashCode() -> int
 override Kaonavi.Net.Entities.FaceImageInfo.ToString() -> string!
@@ -511,8 +496,6 @@ static Kaonavi.Net.Entities.EnumOption.Data.operator !=(Kaonavi.Net.Entities.Enu
 static Kaonavi.Net.Entities.EnumOption.Data.operator ==(Kaonavi.Net.Entities.EnumOption.Data? left, Kaonavi.Net.Entities.EnumOption.Data? right) -> bool
 static Kaonavi.Net.Entities.EnumOption.operator !=(Kaonavi.Net.Entities.EnumOption? left, Kaonavi.Net.Entities.EnumOption? right) -> bool
 static Kaonavi.Net.Entities.EnumOption.operator ==(Kaonavi.Net.Entities.EnumOption? left, Kaonavi.Net.Entities.EnumOption? right) -> bool
-static Kaonavi.Net.Entities.FaceImage.operator !=(Kaonavi.Net.Entities.FaceImage? left, Kaonavi.Net.Entities.FaceImage? right) -> bool
-static Kaonavi.Net.Entities.FaceImage.operator ==(Kaonavi.Net.Entities.FaceImage? left, Kaonavi.Net.Entities.FaceImage? right) -> bool
 static Kaonavi.Net.Entities.FaceImageInfo.operator !=(Kaonavi.Net.Entities.FaceImageInfo? left, Kaonavi.Net.Entities.FaceImageInfo? right) -> bool
 static Kaonavi.Net.Entities.FaceImageInfo.operator ==(Kaonavi.Net.Entities.FaceImageInfo? left, Kaonavi.Net.Entities.FaceImageInfo? right) -> bool
 static Kaonavi.Net.Entities.FieldLayout.operator !=(Kaonavi.Net.Entities.FieldLayout? left, Kaonavi.Net.Entities.FieldLayout? right) -> bool
@@ -572,10 +555,6 @@ virtual Kaonavi.Net.Entities.EnumOption.Data.PrintMembers(System.Text.StringBuil
 virtual Kaonavi.Net.Entities.EnumOption.EqualityContract.get -> System.Type!
 virtual Kaonavi.Net.Entities.EnumOption.Equals(Kaonavi.Net.Entities.EnumOption? other) -> bool
 virtual Kaonavi.Net.Entities.EnumOption.PrintMembers(System.Text.StringBuilder! builder) -> bool
-virtual Kaonavi.Net.Entities.FaceImage.<Clone>$() -> Kaonavi.Net.Entities.FaceImage!
-virtual Kaonavi.Net.Entities.FaceImage.EqualityContract.get -> System.Type!
-virtual Kaonavi.Net.Entities.FaceImage.Equals(Kaonavi.Net.Entities.FaceImage? other) -> bool
-virtual Kaonavi.Net.Entities.FaceImage.PrintMembers(System.Text.StringBuilder! builder) -> bool
 virtual Kaonavi.Net.Entities.FaceImageInfo.<Clone>$() -> Kaonavi.Net.Entities.FaceImageInfo!
 virtual Kaonavi.Net.Entities.FaceImageInfo.EqualityContract.get -> System.Type!
 virtual Kaonavi.Net.Entities.FaceImageInfo.Equals(Kaonavi.Net.Entities.FaceImageInfo? other) -> bool

src/Kaonavi.NET.Core/PublicAPI.Unshipped.txt

@@ -1 +1,21 @@
 #nullable enable
+Kaonavi.Net.Entities.FaceImagePayload
+Kaonavi.Net.Entities.FaceImagePayload.Code.get -> string!
+Kaonavi.Net.Entities.FaceImagePayload.Code.init -> void
+Kaonavi.Net.Entities.FaceImagePayload.Content.get -> byte[]!
+Kaonavi.Net.Entities.FaceImagePayload.Content.init -> void
+Kaonavi.Net.Entities.FaceImagePayload.Deconstruct(out string! Code, out byte[]! Content) -> void
+Kaonavi.Net.Entities.FaceImagePayload.FaceImagePayload(Kaonavi.Net.Entities.FaceImagePayload! original) -> void
+Kaonavi.Net.Entities.FaceImagePayload.FaceImagePayload(string! Code, byte[]! Content) -> void
+Kaonavi.Net.KaonaviClient.ILayout.ReadMemberLayoutAsync(bool getCalcType = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<Kaonavi.Net.Entities.MemberLayout!>
+Kaonavi.Net.KaonaviClient.IMember.AddFaceImageAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.FaceImagePayload!>! payload, bool enableTrimming = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
+Kaonavi.Net.KaonaviClient.IMember.UpdateFaceImageAsync(System.Collections.Generic.IReadOnlyList<Kaonavi.Net.Entities.FaceImagePayload!>! payload, bool enableTrimming = true, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask<int>
+override Kaonavi.Net.Entities.FaceImagePayload.Equals(object? obj) -> bool
+override Kaonavi.Net.Entities.FaceImagePayload.GetHashCode() -> int
+override Kaonavi.Net.Entities.FaceImagePayload.ToString() -> string!
+static Kaonavi.Net.Entities.FaceImagePayload.operator !=(Kaonavi.Net.Entities.FaceImagePayload? left, Kaonavi.Net.Entities.FaceImagePayload? right) -> bool
+static Kaonavi.Net.Entities.FaceImagePayload.operator ==(Kaonavi.Net.Entities.FaceImagePayload? left, Kaonavi.Net.Entities.FaceImagePayload? right) -> bool
+virtual Kaonavi.Net.Entities.FaceImagePayload.<Clone>$() -> Kaonavi.Net.Entities.FaceImagePayload!
+virtual Kaonavi.Net.Entities.FaceImagePayload.EqualityContract.get -> System.Type!
+virtual Kaonavi.Net.Entities.FaceImagePayload.Equals(Kaonavi.Net.Entities.FaceImagePayload? other) -> bool
+virtual Kaonavi.Net.Entities.FaceImagePayload.PrintMembers(System.Text.StringBuilder! builder) -> bool

test/Kaonavi.NET.Tests/Entities/FaceImage.Test.cs → test/Kaonavi.NET.Tests/Entities/FaceImagePayload.Test.cs

@@ -3,12 +3,12 @@
 
 namespace Kaonavi.Net.Tests.Entities;
 
-/// <summary><see cref="FaceImage"/>の単体テスト</summary>
+/// <summary><see cref="FaceImagePayload"/>の単体テスト</summary>
 [TestClass, TestCategory("Entities")]
-public sealed class FaceImageTest
+public sealed class FaceImagePayloadTest
 {
     /// <summary>JSONからデシリアライズできる。</summary>
-    [TestMethod(DisplayName = $"{nameof(FaceImage)} > JSONからデシリアライズできる。"), TestCategory("JSON Deserialize")]
+    [TestMethod(DisplayName = $"{nameof(FaceImagePayload)} > JSONからデシリアライズできる。"), TestCategory("JSON Deserialize")]
     public void CanDeserializeJSON()
     {
         // Arrange
@@ -21,7 +21,7 @@ public void CanDeserializeJSON()
         """;
 
         // Act
-        var faceImage = JsonSerializer.Deserialize(json, Context.Default.FaceImage);
+        var faceImage = JsonSerializer.Deserialize(json, Context.Default.FaceImagePayload);
 
         // Assert
         faceImage.ShouldNotBeNull().ShouldSatisfyAllConditions(

test/Kaonavi.NET.Tests/KaonaviClient.Member.Test.cs

@@ -290,7 +290,7 @@ public async ValueTask Member_DeleteAsync_Calls_PostApi()
         ]
         """;
         /// <summary>メンバー情報 顔写真 APIのリクエストPayload</summary>
-        private static readonly IReadOnlyList<FaceImage> _faceImagePayload = JsonSerializer.Deserialize(FaceImagePayloadJson, Context.Default.IReadOnlyListFaceImage)!;
+        private static readonly IReadOnlyList<FaceImagePayload> _faceImagePayload = JsonSerializer.Deserialize(FaceImagePayloadJson, Context.Default.IReadOnlyListFaceImagePayload)!;
 
 
         /// <summary>