feat(client): add helper functions for raw messages

Author: stainless-app[bot]

README.md

@@ -111,10 +111,12 @@ To access this data, prefix any HTTP method call on a client or service with `Wi
 
 ```csharp
 var response = await client.WithRawResponse.Customers.Create(parameters);
-var statusCode = response.Message.StatusCode;
-var headers = response.Message.Headers;
+var statusCode = response.StatusCode;
+var headers = response.Headers;
 ```
 
+The raw `HttpResponseMessage` can also be accessed through the `RawMessage` property.
+
 For non-streaming responses, you can deserialize the response into an instance of a C# class if needed:
 
 ```csharp

src/Orb/Core/HttpResponse.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
+using System.Net;
 using System.Net.Http;
 using System.Text.Json;
 using System.Threading.Tasks;
@@ -12,10 +13,32 @@ namespace Orb.Core;
 
 public class HttpResponse : IDisposable
 {
-    public required HttpResponseMessage Message { get; init; }
+    public required HttpResponseMessage RawMessage { get; init; }
+
+    public IEnumerable<KeyValuePair<string, IEnumerable<string>>> Headers
+    {
+        get { return RawMessage.Headers; }
+    }
+
+    public bool IsSuccessStatusCode
+    {
+        get { return RawMessage.IsSuccessStatusCode; }
+    }
+
+    public HttpStatusCode StatusCode
+    {
+        get { return RawMessage.StatusCode; }
+    }
 
     public Threading::CancellationToken CancellationToken { get; init; } = default;
 
+    public IEnumerable<string> GetHeaderValues(string name) => RawMessage.Headers.GetValues(name);
+
+    public bool TryGetHeaderValues(
+        string name,
+        [NotNullWhen(true)] out IEnumerable<string>? values
+    ) => RawMessage.Headers.TryGetValues(name, out values);
+
     public async Task<T> Deserialize<T>(Threading::CancellationToken cancellationToken = default)
     {
         using var cts = Threading::CancellationTokenSource.CreateLinkedTokenSource(
@@ -45,7 +68,7 @@ public async Task<Stream> ReadAsStream(Threading::CancellationToken cancellation
             this.CancellationToken,
             cancellationToken
         );
-        return await Message.Content.ReadAsStreamAsync(
+        return await RawMessage.Content.ReadAsStreamAsync(
 #if NET
             cts.Token
 #endif
@@ -58,7 +81,7 @@ public async Task<string> ReadAsString(Threading::CancellationToken cancellation
             this.CancellationToken,
             cancellationToken
         );
-        return await Message.Content.ReadAsStringAsync(
+        return await RawMessage.Content.ReadAsStringAsync(
 #if NET
             cts.Token
 #endif
@@ -67,7 +90,7 @@ public async Task<string> ReadAsString(Threading::CancellationToken cancellation
 
     public void Dispose()
     {
-        this.Message.Dispose();
+        this.RawMessage.Dispose();
         GC.SuppressFinalize(this);
     }
 }
@@ -88,7 +111,7 @@ internal HttpResponse(
     )
         : this(deserialize)
     {
-        this.Message = response.Message;
+        this.RawMessage = response.RawMessage;
         this.CancellationToken = response.CancellationToken;
     }
 
@@ -120,7 +143,7 @@ internal StreamingHttpResponse(
     )
         : this(enumerate)
     {
-        this.Message = response.Message;
+        this.RawMessage = response.RawMessage;
         this.CancellationToken = response.CancellationToken;
     }
 

src/Orb/OrbClient.cs

@@ -420,15 +420,15 @@ public async Task<HttpResponse> Execute<T>(
 
             if (response != null && (++retries > maxRetries || !ShouldRetry(response)))
             {
-                if (response.Message.IsSuccessStatusCode)
+                if (response.IsSuccessStatusCode)
                 {
                     return response;
                 }
 
                 try
                 {
                     throw OrbExceptionFactory.CreateApiException(
-                        response.Message.StatusCode,
+                        response.StatusCode,
                         await response.ReadAsString(cancellationToken).ConfigureAwait(false)
                     );
                 }
@@ -494,7 +494,7 @@ async Task<HttpResponse> ExecuteOnce<T>(
         {
             throw new OrbIOException("I/O exception", e);
         }
-        return new() { Message = responseMessage, CancellationToken = cts.Token };
+        return new() { RawMessage = responseMessage, CancellationToken = cts.Token };
     }
 
     static TimeSpan ComputeRetryBackoff(int retries, HttpResponse? response)
@@ -516,7 +516,7 @@ static TimeSpan ComputeRetryBackoff(int retries, HttpResponse? response)
     static TimeSpan? ParseRetryAfterMsHeader(HttpResponse? response)
     {
         IEnumerable<string>? headerValues = null;
-        response?.Message.Headers.TryGetValues("Retry-After-Ms", out headerValues);
+        response?.TryGetHeaderValues("Retry-After-Ms", out headerValues);
         var headerValue = headerValues == null ? null : Enumerable.FirstOrDefault(headerValues);
         if (headerValue == null)
         {
@@ -534,7 +534,7 @@ static TimeSpan ComputeRetryBackoff(int retries, HttpResponse? response)
     static TimeSpan? ParseRetryAfterHeader(HttpResponse? response)
     {
         IEnumerable<string>? headerValues = null;
-        response?.Message.Headers.TryGetValues("Retry-After", out headerValues);
+        response?.TryGetHeaderValues("Retry-After", out headerValues);
         var headerValue = headerValues == null ? null : Enumerable.FirstOrDefault(headerValues);
         if (headerValue == null)
         {
@@ -556,15 +556,15 @@ static TimeSpan ComputeRetryBackoff(int retries, HttpResponse? response)
     static bool ShouldRetry(HttpResponse response)
     {
         if (
-            response.Message.Headers.TryGetValues("X-Should-Retry", out var headerValues)
+            response.TryGetHeaderValues("X-Should-Retry", out var headerValues)
             && bool.TryParse(Enumerable.FirstOrDefault(headerValues), out var shouldRetry)
         )
         {
             // If the server explicitly says whether to retry, then we obey.
             return shouldRetry;
         }
 
-        return (int)response.Message.StatusCode switch
+        return (int)response.StatusCode switch
         {
             // Retry on request timeouts
             408