Merge branch 'main' of github.com:panoramicdata/LogicMonitor.Api

LogicMonitor.Api.Test/Reports/ReportTests.cs

@@ -22,6 +22,44 @@ public async Task GetAllReports()
 		reports.Should().NotBeNullOrEmpty();
 	}
 
+
+	[Fact]
+	public async Task RunReportById()
+	{
+		var response =
+			await LogicMonitorClient.RunReportById(156, default)
+			.ConfigureAwait(true);
+
+		response.Should().NotBeNull();
+		response.ResultUrl.Should().NotBeNullOrEmpty();
+	}
+
+	[Fact]
+	public async Task CreateAndDeleteReport()
+	{
+		var sDate = DateTime.UtcNow.AddDays(-1);
+		var eDate = sDate.AddHours(1);
+
+		// Create it
+		var report =
+			await LogicMonitorClient.CreateAsync(new ReportCreationDto
+			{
+				Name = "Temporary Report 5 - can delete",
+				Description = "Temporary Report - can delete",
+				Format = "PDF",
+				Type = "Dashboard",
+				GroupId = 375,
+				DateRange = $"{sDate.ToString("yyyy-MM-dd HH:mm")} TO {eDate.ToString("yyyy-MM-dd HH:mm")}",
+				DashboardId = 205
+			},
+			default)
+			.ConfigureAwait(true);
+
+		report.Should().NotBeNull();
+
+		await LogicMonitorClient.DeleteAsync<ReportBase>(report.Id, default).ConfigureAwait(true);
+	}
+
 	[Fact]
 	public async Task CrudReportGroups()
 	{

LogicMonitor.Api/Alerts/EscalationChainCreationDto.cs

@@ -3,7 +3,9 @@
 /// <summary>
 /// An Escalation chain creation DTO
 /// </summary>
-public class EscalationChainCreationDto : CreationDto<EscalationChain>
+[DataContract]
+public class EscalationChainCreationDto
+	: CreationDto<EscalationChain>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    The LogicMonitor Name

LogicMonitor.Api/Collectors/CollectorCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Collectors;
 ///     A LogicMonitor Collector
 /// </summary>
 [DataContract]
-public class CollectorCreationDto : CreationDto<Collector>
+public class CollectorCreationDto : CreationDto<Collector>, IHasDescription
 {
 	/// <summary>
 	///     The Collector's description

LogicMonitor.Api/Collectors/CollectorGroupCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Collectors;
 ///     A LogicMonitor Collector Group creation DTO
 /// </summary>
 [DataContract]
-public class CollectorGroupCreationDto : CreationDto<CollectorGroup>
+public class CollectorGroupCreationDto : CreationDto<CollectorGroup>, IHasName, IHasDescription
 {
 	/// <summary>
 	///     The name

LogicMonitor.Api/Dashboards/DashboardCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Dashboards;
 ///    A dashboard creation dto
 /// </summary>
 [DataContract]
-public class DashboardCreationDto : CreationDto<Dashboard>
+public class DashboardCreationDto : CreationDto<Dashboard>, IHasName, IHasDescription
 {
 	/// <summary>
 	/// Owner

LogicMonitor.Api/Dashboards/DashboardGroupCreationDto.cs

@@ -4,7 +4,7 @@
 ///    A dashboard group creation dto
 /// </summary>
 [DataContract]
-public class DashboardGroupCreationDto : CreationDto<DashboardGroup>
+public class DashboardGroupCreationDto : CreationDto<DashboardGroup>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    The Parent Group Id

LogicMonitor.Api/Dashboards/WidgetCreationDto.cs

@@ -5,7 +5,7 @@ namespace LogicMonitor.Api.Dashboards;
 /// </summary>
 /// <typeparam name="T"></typeparam>
 [DataContract]
-public abstract class WidgetCreationDto<T> : CreationDto<T> where T : Widget
+public abstract class WidgetCreationDto<T> : CreationDto<T>, IHasName, IHasDescription where T : Widget
 {
 	/// <summary>
 	///     The refresh periodicity in minutes (as a string)

LogicMonitor.Api/Data/RunReportRequest.cs

@@ -0,0 +1,14 @@
+namespace LogicMonitor.Api.Data;
+
+/// <summary>
+/// A run report request
+/// </summary>
+[DataContract]
+public class RunReportRequest
+{
+	/// <summary>
+	/// The With Admin ID
+	/// </summary>
+	[DataMember(Name = "withAdminId")]
+	public int WithAdminId { get; set; } = 0;
+}

LogicMonitor.Api/Data/RunReportResponse.cs

@@ -0,0 +1,26 @@
+namespace LogicMonitor.Api.Data;
+
+/// <summary>
+/// A run report response
+/// </summary>
+[DataContract]
+public class RunReportResponse
+{
+	/// <summary>
+	/// The report ID
+	/// </summary>
+	[DataMember(Name = "reportId")]
+	public int ReportId { get; set; }
+
+	/// <summary>
+	/// The task ID
+	/// </summary>
+	[DataMember(Name = "taskId")]
+	public long TaskId { get; set; }
+
+	/// <summary>
+	/// The result URL
+	/// </summary>
+	[DataMember(Name = "resulturl")]
+	public string ResultUrl { get; set; } = string.Empty;
+}

LogicMonitor.Api/DescribedItem.cs

@@ -3,7 +3,7 @@ namespace LogicMonitor.Api;
 /// <summary>
 ///    A described item
 /// </summary>
-public abstract class DescribedItem : IdentifiedItem
+public abstract class DescribedItem : IdentifiedItem, IHasDescription
 {
 	/// <summary>
 	///    The LogicMonitor Description

LogicMonitor.Api/Devices/DeviceCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Devices;
 ///    A Device (also known as a Host)
 /// </summary>
 [DataContract]
-public class DeviceCreationDto : CreationDto<Device>
+public class DeviceCreationDto : CreationDto<Device>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    A comma-separated list of device group ids

LogicMonitor.Api/Devices/DeviceGroupCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Devices;
 ///    A device group creation dto
 /// </summary>
 [DataContract]
-public class DeviceGroupCreationDto : CreationDto<DeviceGroup>
+public class DeviceGroupCreationDto : CreationDto<DeviceGroup>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    The Parent Group Id as a string

LogicMonitor.Api/IHasDescription.cs

@@ -0,0 +1,11 @@
+namespace LogicMonitor.Api;
+/// <summary>
+/// An object that has a Description
+/// </summary>
+public interface IHasDescription
+{
+	/// <summary>
+	/// The Description
+	/// </summary>
+	public string Description { get; set; }
+}

LogicMonitor.Api/IHasName.cs

@@ -0,0 +1,11 @@
+namespace LogicMonitor.Api;
+/// <summary>
+/// Defines that the object has a Name property
+/// </summary>
+public interface IHasName
+{
+	/// <summary>
+	/// The name
+	/// </summary>
+	public string Name { get; set; }
+}

LogicMonitor.Api/LogicModules/AppliesToFunctionCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.LogicModules;
 /// An AppliesTo Function creation DTO
 /// </summary>
 [DataContract]
-public class AppliesToFunctionCreationDto : CreationDto<AppliesToFunction>
+public class AppliesToFunctionCreationDto : CreationDto<AppliesToFunction>, IHasName, IHasDescription
 {
 	/// <summary>
 	/// The name

LogicMonitor.Api/LogicMonitor.Api.csproj

@@ -27,7 +27,14 @@
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
 
 		<!-- Update the following before releasing to nuget -->
-		<PackageReleaseNotes>Upversioned to 3.198.</PackageReleaseNotes>
+		<PackageReleaseNotes>
+			Added IHasName and IHasDescription to NamedItem and DescribedItem.
+			Updated CreationDtos to use these new Interfaces.
+			Corrected type for with EmailIntegrationCreationDto.
+			Fixed missing DataContract on IntegrationCreationDto.
+			Added Description to EmailIntegrationCreationDto.
+			Added IHasName to RecipientGroup.
+		</PackageReleaseNotes>
 		<UserSecretsId>57aaa0e7-815d-4065-9339-f3f070bed01e</UserSecretsId>
 
 	</PropertyGroup>

LogicMonitor.Api/LogicMonitorClient_Report.cs

@@ -0,0 +1,16 @@
+namespace LogicMonitor.Api;
+
+/// <summary>
+///    Report interaction
+/// </summary>
+public partial class LogicMonitorClient
+{
+	/// <summary>
+	///    Runs a Report by ID and returns 
+	/// </summary>
+	/// <param name="reportId">The report ID to run</param>
+	/// <param name="cancellationToken">An optional cancellation token</param>
+	/// <returns>The website</returns>
+	public Task<RunReportResponse> RunReportById(int reportId, CancellationToken cancellationToken = default)
+	  => PostAsync<RunReportRequest, RunReportResponse>(new RunReportRequest(), $"report/reports/{reportId}/executions", cancellationToken);
+}

LogicMonitor.Api/NamedItem.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api;
 ///    LogicMonitor named item
 /// </summary>
 [DataContract]
-public abstract class NamedItem : DescribedItem
+public abstract class NamedItem : DescribedItem, IHasName
 {
 	/// <summary>
 	///    The LogicMonitor Name

LogicMonitor.Api/Netscans/NetscanCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Netscans;
 ///    A class for crating NetscanPolicies
 /// </summary>
 [DataContract]
-public class NetscanCreationDto : CreationDto<Netscan>
+public class NetscanCreationDto : CreationDto<Netscan>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    Constructor

LogicMonitor.Api/Netscans/NetscanGroupCreationDto.cs

@@ -4,7 +4,7 @@
 ///    A Netscan Policy
 /// </summary>
 [DataContract]
-public class NetscanGroupCreationDto : CreationDto<NetscanGroup>
+public class NetscanGroupCreationDto : CreationDto<NetscanGroup>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    Name

LogicMonitor.Api/Reports/ReportCreationDto.cs

@@ -0,0 +1,80 @@
+namespace LogicMonitor.Api.Reports;
+
+/// <summary>
+///    A ReportGroup creation DTO. This is incomplete i.e. does not yet include properties to set a schedule or recipients
+/// </summary>
+[DataContract]
+public class ReportCreationDto : CreationDto<ReportBase>
+{
+	/// <summary>
+	///    The type, e.g Dashboard
+	/// </summary>
+	[DataMember(Name = "type")]
+	public string Type { get; set; } = string.Empty;
+
+	/// <summary>
+	///    The Group ID
+	/// </summary>
+	[DataMember(Name = "groupId")]
+	public int GroupId { get; set; }
+
+	/// <summary>
+	///    The name
+	/// </summary>
+	[DataMember(Name = "name")]
+	public string Name { get; set; } = string.Empty;
+
+	/// <summary>
+	///    The description
+	/// </summary>
+	[DataMember(Name = "description")]
+	public string Description { get; set; } = string.Empty;
+
+	/// <summary>
+	///    The format - HTML or PDF
+	/// </summary>
+	[DataMember(Name = "format")]
+	public string Format { get; set; } = "HTML";
+
+	/// <summary>
+	///    The expiry type - High Flexibiilty or High Security
+	/// </summary>
+	[DataMember(Name = "reportLinkExpire")]
+	public string ReportLinkExpire { get; set; } = "High Flexibility";
+
+	/// <summary>
+	///    The date range
+	/// </summary>
+	[DataMember(Name = "dateRange")]
+	public string DateRange { get; set; } = "Default";
+
+	/// <summary>
+	///    The Dashboard ID
+	/// </summary>
+	[DataMember(Name = "dashboardId")]
+	public int DashboardId { get; set; }
+
+	/// <summary>
+	///    The display name used in the generated report (when run)
+	/// </summary>
+	[DataMember(Name = "displayName")]
+	public string DisplayName { get; set; } = string.Empty;
+
+	/// <summary>
+	///    Whether to display the generated report's URL on the output
+	/// </summary>
+	[DataMember(Name = "displayLink")]
+	public bool DisplayLink { get; set; }
+
+	/// <summary>
+	///    Whether to display the generated report's URL on the output
+	/// </summary>
+	[DataMember(Name = "delivery")]
+	public string Delivery { get; set; } = "none";
+
+	/// <summary>
+	///    ToString override
+	/// </summary>
+	/// <returns>Name</returns>
+	public override string ToString() => Name;
+}

LogicMonitor.Api/Reports/ReportGroupCreationDto.cs

@@ -4,7 +4,7 @@ namespace LogicMonitor.Api.Reports;
 ///    A ReportGroup creation DTO
 /// </summary>
 [DataContract]
-public class ReportGroupCreationDto : CreationDto<ReportGroup>
+public class ReportGroupCreationDto : CreationDto<ReportGroup>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    The name

LogicMonitor.Api/Settings/AlertRuleCreationDto.cs

@@ -4,7 +4,7 @@
 /// A LogicMonitor alert rule creation DTO
 /// </summary>
 [DataContract]
-public class AlertRuleCreationDto : CreationDto<AlertRule>
+public class AlertRuleCreationDto : CreationDto<AlertRule>, IHasName, IHasDescription
 {
 	/// <summary>
 	///    The LogicMonitor Name

LogicMonitor.Api/Settings/EmailIntegrationCreationDto.cs

@@ -4,12 +4,12 @@
 /// Email Integration Creation Dto
 /// </summary>
 [DataContract]
-public class EmailIntegrationCreationDto : IntegrationCreationDto<EmailIntegration>
+public class EmailIntegrationCreationDto : IntegrationCreationDto<EmailIntegration>, IHasDescription
 {
 	/// <summary>
 	/// Constructor
 	/// </summary>
-	public EmailIntegrationCreationDto() : base("http")
+	public EmailIntegrationCreationDto() : base("email")
 	{
 	}
 	/// <summary>
@@ -35,4 +35,10 @@ public EmailIntegrationCreationDto() : base("http")
 	/// </summary>
 	[DataMember(Name = "body")]
 	public string Body { get; set; } = string.Empty;
+
+	/// <summary>
+	///    The description
+	/// </summary>
+	[DataMember(Name = "description")]
+	public string Description { get; set; } = string.Empty;
 }

LogicMonitor.Api/Settings/IntegrationCreationDto.cs

@@ -8,7 +8,9 @@
 ///   Constructor
 /// </remarks>
 /// <param name="type">The integration type</param>
-public abstract class IntegrationCreationDto<T>(string type) : CreationDto<Integration> where T : Integration
+[DataContract]
+public abstract class IntegrationCreationDto<T>(string type)
+	: CreationDto<Integration>, IHasName where T : Integration
 {
 	/// <summary>
 	///    The LogicMonitor Name