feat: implement ListMessageBatchesAsync method

src/AnthropicClient/AnthropicApiClient.cs

@@ -41,6 +41,13 @@ public interface IAnthropicApiClient
   /// <returns>A task that represents the asynchronous operation. The task result contains the response as an <see cref="AnthropicResult{T}"/> where T is <see cref="MessageBatchResponse"/>.</returns>
   Task<AnthropicResult<MessageBatchResponse>> GetMessageBatchAsync(string batchId);
 
+  /// <summary>
+  /// Lists the message batches asynchronously.
+  /// </summary>
+  /// <param name="request">The paging request to use for listing the message batches.</param>
+  /// <returns>A task that represents the asynchronous operation. The task result contains the response as an <see cref="AnthropicResult{T}"/> where T is <see cref="Page{T}"/> where T is <see cref="MessageBatchResponse"/>.</returns>
+  Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null);
+
   /// <summary>
   /// Gets the results of a message batch asynchronously.
   /// </summary>
@@ -342,6 +349,25 @@ public class AnthropicApiClient : IAnthropicApiClient
     return AnthropicResult<MessageBatchResponse>.Success(msgBatchResponse, anthropicHeaders);
   }
 
+  /// <inheritdoc/>
+  public async Task<AnthropicResult<Page<MessageBatchResponse>>> ListMessageBatchesAsync(PagingRequest? request = null)
+  {
+    var pagingRequest = request ?? new PagingRequest();
+    var endpoint = $"{MessageBatchesEndpoint}?{pagingRequest.ToQueryParameters()}";
+    var response = await SendRequestAsync(endpoint);
+    var anthropicHeaders = new AnthropicHeaders(response.Headers);
+    var responseContent = await response.Content.ReadAsStringAsync();
+
+    if (response.IsSuccessStatusCode is false)
+    {
+      var error = Deserialize<AnthropicError>(responseContent) ?? new AnthropicError();
+      return AnthropicResult<Page<MessageBatchResponse>>.Failure(error, anthropicHeaders);
+    }
+
+    var page = Deserialize<Page<MessageBatchResponse>>(responseContent) ?? new Page<MessageBatchResponse>();
+    return AnthropicResult<Page<MessageBatchResponse>>.Success(page, anthropicHeaders);
+  }
+
   /// <inheritdoc/>
   public async Task<AnthropicResult<IAsyncEnumerable<MessageBatchResultItem>>> GetMessageBatchResultsAsync(string batchId)
   {

tests/AnthropicClient.Tests/EndToEnd/AnthropicApiClientTests.cs

@@ -2,7 +2,7 @@ using AnthropicClient.Tests.Files;
 
 namespace AnthropicClient.Tests.EndToEnd;
 
-public class ClientTests(ConfigurationFixture configFixture) : EndToEndTest(configFixture)
+public class AnthropicApiClientTests(ConfigurationFixture configFixture) : EndToEndTest(configFixture)
 {
   [Fact]
   public async Task CreateMessageAsync_WhenCalled_ItShouldReturnResponse()
@@ -381,4 +381,26 @@ public class ClientTests(ConfigurationFixture configFixture) : EndToEndTest(conf
     getResult.Value.Should().BeOfType<MessageBatchResponse>();
     getResult.Value.Id.Should().Be(createResult.Value.Id);
   }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalled_ItShouldReturnResponse()
+  {
+    var request = new MessageBatchRequest([
+      new(
+        Guid.NewGuid().ToString(),
+        new(
+          model: AnthropicModels.Claude3Haiku,
+          messages: [new(MessageRole.User, [new TextContent("Hello!")])]
+        )
+      ),
+    ]);
+
+    var createResult = await _client.CreateMessageBatchAsync(request);
+    var result = await _client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeTrue();
+    result.Value.Should().BeOfType<Page<MessageBatchResponse>>();
+    result.Value.Data.Should().HaveCountGreaterThan(0);
+    result.Value.Data.Should().ContainSingle(b => b.Id == createResult.Value.Id);
+  }
 }

tests/AnthropicClient.Tests/Integration/AnthropicApiClientTests.cs

@@ -1466,4 +1466,234 @@ public class AnthropicApiClientTests : IntegrationTest
     result.Error.Should().BeOfType<AnthropicError>();
     result.Error.Error.Should().BeOfType<ApiError>();
   }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledAndSuccessful_ItShouldReturnPageOfBatches()
+  {
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .Respond(
+        HttpStatusCode.OK,
+        "application/json",
+        @"{
+            ""data"": [
+              {
+                ""id"": ""msgbatch_013Zva2CMHLNnXjNJJKqJ2EF"",
+                ""type"": ""message_batch"",
+                ""processing_status"": ""in_progress"",
+                ""request_counts"": {
+                  ""processing"": 100,
+                  ""succeeded"": 50,
+                  ""errored"": 30,
+                  ""canceled"": 10,
+                  ""expired"": 10
+                },
+                ""ended_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""created_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""expires_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""archived_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""cancel_initiated_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""results_url"": ""https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results""
+              }
+            ],
+            ""has_more"": true,
+            ""first_id"": ""1"",
+            ""last_id"": ""1""
+          }"
+      );
+
+    var result = await Client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeTrue();
+    result.Value.Should().BeOfType<Page<MessageBatchResponse>>();
+    result.Value.HasMore.Should().BeTrue();
+    result.Value.FirstId.Should().Be("1");
+    result.Value.LastId.Should().Be("1");
+    result.Value.Data.Should().BeEquivalentTo(new MessageBatchResponse[]
+    {
+      new()
+      {
+        Id = "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
+        Type = "message_batch",
+        ProcessingStatus = "in_progress",
+        RequestCounts = new MessageBatchRequestCounts
+        {
+          Processing = 100,
+          Succeeded = 50,
+          Errored = 30,
+          Canceled = 10,
+          Expired = 10
+        },
+        EndedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        CreatedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ExpiresAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ArchivedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        CancelInitiatedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ResultsUrl = "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results"
+      }
+    });
+  }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledWithPagingRequestAndSuccessful_ItShouldReturnPageOfBatches()
+  {
+    var pagingRequest = new PagingRequest(afterId: "next_id", limit: 10);
+
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .WithQueryString(new Dictionary<string, string>
+      {
+        { "after_id", pagingRequest.AfterId },
+        { "limit", pagingRequest.Limit.ToString() },
+      })
+      .Respond(
+        HttpStatusCode.OK,
+        "application/json",
+        @"{
+            ""data"": [
+              {
+                ""id"": ""msgbatch_013Zva2CMHLNnXjNJJKqJ2EF"",
+                ""type"": ""message_batch"",
+                ""processing_status"": ""in_progress"",
+                ""request_counts"": {
+                  ""processing"": 100,
+                  ""succeeded"": 50,
+                  ""errored"": 30,
+                  ""canceled"": 10,
+                  ""expired"": 10
+                },
+                ""ended_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""created_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""expires_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""archived_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""cancel_initiated_at"": ""2024-08-20T18:37:24.100435Z"",
+                ""results_url"": ""https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results""
+              }
+            ],
+            ""has_more"": true,
+            ""first_id"": ""1"",
+            ""last_id"": ""1""
+          }"
+      );
+
+    var result = await Client.ListMessageBatchesAsync(pagingRequest);
+
+    result.IsSuccess.Should().BeTrue();
+    result.Value.Should().BeOfType<Page<MessageBatchResponse>>();
+    result.Value.HasMore.Should().BeTrue();
+    result.Value.FirstId.Should().Be("1");
+    result.Value.LastId.Should().Be("1");
+    result.Value.Data.Should().BeEquivalentTo(new MessageBatchResponse[]
+    {
+      new()
+      {
+        Id = "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
+        Type = "message_batch",
+        ProcessingStatus = "in_progress",
+        RequestCounts = new MessageBatchRequestCounts
+        {
+          Processing = 100,
+          Succeeded = 50,
+          Errored = 30,
+          Canceled = 10,
+          Expired = 10
+        },
+        EndedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        CreatedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ExpiresAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ArchivedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        CancelInitiatedAt = DateTimeOffset.Parse("2024-08-20T18:37:24.100435Z"),
+        ResultsUrl = "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results"
+      }
+    });
+  }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledAndNoBatchesReturned_ItShouldReturnEmptyList()
+  {
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .Respond(
+        HttpStatusCode.OK,
+        "application/json",
+        @"{
+            ""data"": [],
+            ""has_more"": false,
+            ""first_id"": null,
+            ""last_id"": null
+          }"
+      );
+
+    var result = await Client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeTrue();
+    result.Value.Should().BeOfType<Page<MessageBatchResponse>>();
+    result.Value.HasMore.Should().BeFalse();
+    result.Value.FirstId.Should().BeNull();
+    result.Value.LastId.Should().BeNull();
+    result.Value.Data.Should().BeEmpty();
+  }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledAndErrorReturned_ItShouldHandleError()
+  {
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .Respond(
+        HttpStatusCode.BadRequest,
+        "application/json",
+        @"{
+            ""type"": ""error"",
+            ""error"": {
+              ""type"": ""invalid_request_error"",
+              ""message"": ""messages: roles must alternate between user and assistant, but found multiple user roles in a row""
+            }
+          }"
+      );
+
+    var result = await Client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeFalse();
+    result.Error.Should().BeOfType<AnthropicError>();
+    result.Error.Error.Should().BeOfType<InvalidRequestError>();
+  }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledRequestFailsAndCanNotDeserializeError_ItShouldReturnUnknownError()
+  {
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .Respond(
+        HttpStatusCode.BadRequest,
+        "application/json",
+        @"null"
+      );
+
+    var result = await Client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeFalse();
+    result.Error.Should().BeOfType<AnthropicError>();
+    result.Error.Error.Should().BeOfType<ApiError>();
+  }
+
+  [Fact]
+  public async Task ListMessageBatchesAsync_WhenCalledRequestSucceedsAndCanNotDeserializeResponse_ItShouldReturnEmptyPage()
+  {
+    _mockHttpMessageHandler
+      .WhenListMessageBatchesRequest()
+      .Respond(
+        HttpStatusCode.OK,
+        "application/json",
+        @"null"
+      );
+
+    var result = await Client.ListMessageBatchesAsync();
+
+    result.IsSuccess.Should().BeTrue();
+    result.Value.Should().BeOfType<Page<MessageBatchResponse>>();
+    result.Value.HasMore.Should().BeFalse();
+    result.Value.FirstId.Should().BeEmpty();
+    result.Value.LastId.Should().BeEmpty();
+    result.Value.Data.Should().BeEmpty();
+  }
 }

tests/AnthropicClient.Tests/Integration/IntegrationTest.cs

@@ -85,4 +85,10 @@ public static class MockHttpMessageHandlerExtensions
     return mockHttpMessageHandler
       .SetupBaseRequest(HttpMethod.Get, $"{MessageBatchesEndpoint}/{batchId}/results");
   }
+
+  public static MockedRequest WhenListMessageBatchesRequest(this MockHttpMessageHandler mockHttpMessageHandler)
+  {
+    return mockHttpMessageHandler
+      .SetupBaseRequest(HttpMethod.Get, MessageBatchesEndpoint);
+  }
 }