Update API definitions

- Add new properties.
- Remove redundant type.
- Add methods to get new log types.
- Add new query parameter.

Author: martincostello

src/MartinCostello.BrowserStack.Automate/AppJsonSerializerContext.cs

@@ -21,6 +21,7 @@ namespace MartinCostello.BrowserStack.Automate;
 [JsonSerializable(typeof(ProjectDetailItem))]
 [JsonSerializable(typeof(RecycleAccessKeyResult))]
 [JsonSerializable(typeof(Session))]
+[JsonSerializable(typeof(SetBuildTagRequest))]
 [JsonSerializable(typeof(SetNameRequest))]
 [JsonSerializable(typeof(SetSessionStatusRequest))]
 internal sealed partial class AppJsonSerializerContext : JsonSerializerContext

src/MartinCostello.BrowserStack.Automate/AutomationSessionDetail.cs

@@ -12,5 +12,5 @@ internal sealed class AutomationSessionDetail
     /// Gets or sets the session.
     /// </summary>
     [JsonPropertyName("automation_session")]
-    public SessionDetail SessionDetail { get; set; } = default!;
+    public Session SessionDetail { get; set; } = default!;
 }

src/MartinCostello.BrowserStack.Automate/Browser.cs

@@ -38,4 +38,10 @@ public class Browser : IBrowserInfo
     /// </summary>
     [JsonPropertyName("browser")]
     public string BrowserName { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets if a mobile device is used or not.
+    /// </summary>
+    [JsonPropertyName("real_mobile")]
+    public bool? RealMobile { get; set; }
 }

src/MartinCostello.BrowserStack.Automate/BrowserStackAutomateClient.cs

@@ -302,14 +302,15 @@ public virtual async Task<ICollection<Browser>> GetBrowsersAsync(CancellationTok
     /// A <see cref="Task{TResult}"/> representing the asynchronous operation to get the builds.
     /// </returns>
     public virtual Task<ICollection<Build>> GetBuildsAsync(CancellationToken cancellationToken)
-        => GetBuildsAsync(null, null, null, cancellationToken);
+        => GetBuildsAsync(null, null, null, null, cancellationToken);
 
     /// <summary>
     /// Gets the builds as an asynchronous operation.
     /// </summary>
     /// <param name="limit">The optional number of builds to return. The default value is 10.</param>
     /// <param name="offset">The optional offset for builds to return. The default value is 0.</param>
     /// <param name="status">The optional status to filter builds to.</param>
+    /// <param name="projectId">The optional project Id to filter builds to, if any.</param>
     /// <param name="cancellationToken">The optional cancellation token to use.</param>
     /// <returns>
     /// A <see cref="Task{TResult}"/> representing the asynchronous operation to get the builds.
@@ -318,9 +319,10 @@ public virtual async Task<ICollection<Build>> GetBuildsAsync(
         int? limit = default,
         int? offset = default,
         string? status = default,
+        int? projectId = default,
         CancellationToken cancellationToken = default)
     {
-        string relativeUri = AppendQuery("builds.json", limit, offset, status);
+        string relativeUri = AppendQuery("builds.json", limit, offset, status, projectId);
 
         var builds = await GetJsonAsync(
             relativeUri,
@@ -350,6 +352,30 @@ public virtual async Task<ProjectDetailItem> GetProjectAsync(int projectId, Canc
         return item!;
     }
 
+    /// <summary>
+    /// Gets the badge for the project with the specified Id as an asynchronous operation.
+    /// </summary>
+    /// <param name="projectId">The Id of the project to get the status badge for.</param>
+    /// <param name="cancellationToken">The optional cancellation token to use.</param>
+    /// <returns>
+    /// A <see cref="Task{TResult}"/> representing the asynchronous operation to get the
+    /// key for the status badge for the project with the specified Id.
+    /// </returns>
+    public virtual async Task<string> GetProjectStatusBadgeAsync(int projectId, CancellationToken cancellationToken = default)
+    {
+        using var response = await _client.GetAsync(
+            FormattableString.Invariant($"projects/{projectId}/badge_key"),
+            cancellationToken).ConfigureAwait(false);
+
+        await EnsureSuccessAsync(response, cancellationToken).ConfigureAwait(false);
+
+#if NET8_0_OR_GREATER
+        return await response.Content.ReadAsStringAsync(cancellationToken).ConfigureAwait(false);
+#else
+        return await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+#endif
+    }
+
     /// <summary>
     /// Gets the projects as an asynchronous operation.
     /// </summary>
@@ -371,7 +397,7 @@ public virtual async Task<ICollection<Project>> GetProjectsAsync(CancellationTok
     /// <exception cref="ArgumentException">
     /// <paramref name="sessionId"/> is <see langword="null"/> or white space.
     /// </exception>
-    public virtual async Task<SessionDetail?> GetSessionAsync(string sessionId, CancellationToken cancellationToken = default)
+    public virtual async Task<Session?> GetSessionAsync(string sessionId, CancellationToken cancellationToken = default)
     {
         if (string.IsNullOrWhiteSpace(sessionId))
         {
@@ -450,6 +476,38 @@ public virtual Task<string> GetSessionConsoleLogsAsync(string buildId, string se
     public virtual Task<string> GetSessionNetworkLogsAsync(string buildId, string sessionId, CancellationToken cancellationToken = default)
         => GetLogsAsync(buildId, sessionId, "networklogs", cancellationToken);
 
+    /// <summary>
+    /// Gets the session Selenium logs associated with the specified build and session Id as an asynchronous operation.
+    /// </summary>
+    /// <param name="buildId">The build Id to return the logs for.</param>
+    /// <param name="sessionId">The session Id to return the logs for.</param>
+    /// <param name="cancellationToken">The optional cancellation token to use.</param>
+    /// <returns>
+    /// A <see cref="Task{TResult}"/> representing the asynchronous operation to get the logs for the build and session
+    /// with the specified Ids as a string.
+    /// </returns>
+    /// <exception cref="ArgumentException">
+    /// <paramref name="buildId"/> or <paramref name="sessionId"/> is <see langword="null"/> or white space.
+    /// </exception>
+    public virtual Task<string> GetSessionSeleniumLogsAsync(string buildId, string sessionId, CancellationToken cancellationToken = default)
+        => GetLogsAsync(buildId, sessionId, "seleniumlogs", cancellationToken);
+
+    /// <summary>
+    /// Gets the session Selenium 4 telemetry logs associated with the specified build and session Id as an asynchronous operation.
+    /// </summary>
+    /// <param name="buildId">The build Id to return the logs for.</param>
+    /// <param name="sessionId">The session Id to return the logs for.</param>
+    /// <param name="cancellationToken">The optional cancellation token to use.</param>
+    /// <returns>
+    /// A <see cref="Task{TResult}"/> representing the asynchronous operation to get the logs for the build and session
+    /// with the specified Ids as a string.
+    /// </returns>
+    /// <exception cref="ArgumentException">
+    /// <paramref name="buildId"/> or <paramref name="sessionId"/> is <see langword="null"/> or white space.
+    /// </exception>
+    public virtual Task<string> GetSessionTelemetryLogsAsync(string buildId, string sessionId, CancellationToken cancellationToken = default)
+        => GetLogsAsync(buildId, sessionId, "telemetrylogs", cancellationToken);
+
     /// <summary>
     /// Gets the sessions associated with the specified build Id as an asynchronous operation.
     /// </summary>
@@ -540,30 +598,33 @@ public virtual async Task<ICollection<Session>> GetSessionsAsync(
     }
 
     /// <summary>
-    /// Sets the name of the build with the specified Id as an asynchronous operation.
+    /// Sets a tag of the build with the specified Id as an asynchronous operation.
     /// </summary>
-    /// <param name="buildId">The build Id to set the name of.</param>
-    /// <param name="name">The new name.</param>
+    /// <param name="buildId">The build Id to set the tag for.</param>
+    /// <param name="tag">The new build tag to set.</param>
     /// <param name="cancellationToken">The optional cancellation token to use.</param>
     /// <returns>
     /// A <see cref="Task{TResult}"/> representing the asynchronous operation to set the name for the specified build Id.
     /// </returns>
     /// <exception cref="ArgumentException">
-    /// <paramref name="name"/> is <see langword="null"/> or white space.
+    /// <paramref name="tag"/> is <see langword="null"/> or white space.
     /// </exception>
-    public virtual Task<Build?> SetBuildNameAsync(
+    public virtual Task<Build?> SetBuildTagAsync(
         int buildId,
-        string name,
+        string tag,
         CancellationToken cancellationToken = default)
     {
-        if (string.IsNullOrWhiteSpace(name))
+        if (string.IsNullOrWhiteSpace(tag))
         {
-            throw new ArgumentException("No name specified.", nameof(name));
+            throw new ArgumentException("No tag specified.", nameof(tag));
         }
 
-        return SetNameAsync(
+        var request = new SetBuildTagRequest() { BuildTag = tag };
+
+        return PutJsonAsync(
             FormattableString.Invariant($"builds/{buildId}.json"),
-            name,
+            request,
+            AppJsonSerializerContext.Default.SetBuildTagRequest,
             AppJsonSerializerContext.Default.Build,
             cancellationToken);
     }
@@ -698,10 +759,16 @@ protected virtual void Dispose(bool disposing)
     /// <param name="limit">The limit to use, if any.</param>
     /// <param name="offset">The offset to use, if any.</param>
     /// <param name="status">The status to filter to, if any.</param>
+    /// <param name="projectId">The project Id to filter to, if any.</param>
     /// <returns>
     /// The query string to use, if any.
     /// </returns>
-    private static string AppendQuery(string relativeUri, int? limit, int? offset, string? status)
+    private static string AppendQuery(
+        string relativeUri,
+        int? limit,
+        int? offset,
+        string? status,
+        int? projectId = null)
     {
         var parameters = new Dictionary<string, string?>(3);
 
@@ -730,6 +797,16 @@ private static string AppendQuery(string relativeUri, int? limit, int? offset, s
             parameters["status"] = status;
         }
 
+        if (projectId.HasValue)
+        {
+            if (projectId < 1)
+            {
+                throw new ArgumentOutOfRangeException(nameof(projectId), projectId.Value, "The projectId value cannot be less than one.");
+            }
+
+            parameters["projectId"] = projectId.Value.ToString(CultureInfo.InvariantCulture);
+        }
+
         if (parameters.Count > 0)
         {
             relativeUri = QueryHelpers.AddQueryString(relativeUri, parameters);

src/MartinCostello.BrowserStack.Automate/Build.cs

@@ -33,4 +33,16 @@ public class Build
     /// </summary>
     [JsonPropertyName("status")]
     public string Status { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets the public URL of the build, if any.
+    /// </summary>
+    [JsonPropertyName("public_url")]
+    public string? PublicUrl { get; set; }
+
+    /// <summary>
+    /// Gets or sets the build tag of the build, if any.
+    /// </summary>
+    [JsonPropertyName("build_tag")]
+    public string? BuildTag { get; set; }
 }

src/MartinCostello.BrowserStack.Automate/Project.cs

@@ -44,4 +44,10 @@ public class Project
     /// </summary>
     [JsonPropertyName("group_id")]
     public int GroupId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the sub-group Id.
+    /// </summary>
+    [JsonPropertyName("sub_group_id")]
+    public int? SubGroupId { get; set; }
 }