feat: Implements ARI retrieval service

Adds the ability to retrieve Availability, Rates, and Inventory (ARI) data from the GuestLine service.

This includes:
- Creation of a new `IServiceOperations` interface and its implementation, `ServiceOperations`, to handle ARI requests.
- Introduction of `GuestLineAriRequest` to encapsulate the parameters for ARI requests, including validation.
- Definition of an `AriAction` enum to represent the type of ARI data being requested (range or full year).
- Updates to `ApiClient` to handle the new ARI service endpoint.
- Addition of `GuestLineUriResolver` to determine the correct base URL for services based on environment.
- Fixes a date serialization issue using `DateOnlyJsonConverter`.

Author: Antaris

apps/GuestLineSDK.ConsoleSample/Program.cs

@@ -13,10 +13,16 @@
 var http = CreateHttpClient();
 var api = new GuestLineApiClient(http, settings);
 
-string json = GetARIUpdate();
+var ari = await api.Service.GetAriAsync(new GuestLineAriRequest(
+	PropertyId: "12992",
+	RoomId: "1299210STANDARD",
+	RateId: "1299224125",
+	Action: AriAction.FullYear));
 
-var updateRef = AriUpdateRef.FromJsonString(json);
-var update = AriUpdate.FromJsonString(json);
+//string json = GetARIUpdate();
+
+//var updateRef = AriUpdateRef.FromJsonString(json);
+//var update = AriUpdate.FromJsonString(json);
 Console.ReadKey();
 
 GuestLineSettings GetSettings()

libs/GuestLineSDK/Api/Service/ServiceOperations.cs

@@ -0,0 +1,179 @@
+// This work is licensed under the terms of the MIT license.
+// For a copy, see <https://opensource.org/licenses/MIT>.
+
+namespace GuestLineSDK.Api;
+
+using System.Text.Json.Serialization;
+
+using FluentValidation;
+
+using GuestLineSDK.Ari;
+
+partial interface IGuestLineApiClient
+{
+		/// <summary>
+		/// Service Operations
+		/// </summary>
+		IServiceOperations Service { get; }
+}
+
+partial class GuestLineApiClient
+{
+	Lazy<IServiceOperations>? _service;
+	public IServiceOperations Service => (_service ??= Defer<IServiceOperations>(
+		c => new ServiceOperations(c))).Value;
+}
+
+public partial interface IServiceOperations
+{
+	Task<GuestLineResponse<AriUpdate>> GetAriAsync(
+		GuestLineAriRequest request,
+		CancellationToken cancellationToken = default);
+}
+
+public partial class ServiceOperations(ApiClient client) : IServiceOperations
+{
+	readonly ApiClient _client = client;
+
+	public async Task<GuestLineResponse<AriUpdate>> GetAriAsync(
+		GuestLineAriRequest request,
+		CancellationToken cancellationToken = default)
+	{
+		Ensure.IsNotNull(request, nameof(request));
+
+		request.ApiKey ??= _client.Settings.ApiKey;
+		request.Version ??= _client.Settings.Version;
+
+		request.Validate();
+
+		var req = new GuestLineRequest<GuestLineAriRequest>(
+			GuestLineService.ARI,
+			HttpMethod.Post,
+			PathString.Empty,
+			request);
+
+		return await _client.FetchAsync<GuestLineAriRequest, AriUpdate>(req, cancellationToken)
+			.ConfigureAwait(false);
+	}
+}
+
+public enum AriAction
+{
+	/// <summary>
+	/// Request a range of up to 28 days of ARI data.
+	/// </summary>
+	Range,
+
+	/// <summary>
+	/// Request a full year of ARI data.
+	/// </summary>
+	FullYear
+}
+
+/// <summary>
+/// Represents a request for GuestLine ARI data.
+/// </summary>
+/// <param name="action">The ARI action (range or full year)</param>
+/// <param name="start">The start date of the range (if provided)</param>
+/// <param name="end">The end date of the range (if provided)</param>
+public record GuestLineAriRequest(
+	[property: JsonPropertyName("propertyid")] string PropertyId,
+	[property: JsonPropertyName("room_id")] string RoomId,
+	[property: JsonPropertyName("rate_id")] string RateId,
+
+	[property: JsonIgnore] AriAction Action = AriAction.FullYear,
+	[property: JsonPropertyName("from_date")] DateTime? Start = null,
+	[property: JsonPropertyName("to_date")] DateTime? End = null)
+{
+	[JsonPropertyName("action")]
+	public string? ActionValue
+	{
+		get
+		{
+			return Action switch
+			{
+				AriAction.FullYear => "year_info_ARR",
+				AriAction.Range => "ARR_info",
+				_ => null
+			};
+		}
+	}
+
+	[JsonPropertyName("apikey")]
+	public string? ApiKey { get; set; }
+
+	[JsonPropertyName("version")]
+	public string? Version { get; set; }
+
+	/// <summary>
+	/// Validates the current instance.
+	/// </summary>
+	public void Validate()
+		=> GuestLineAriRequestValidator.Instance.Validate(this);
+}
+
+public class GuestLineAriRequestValidator : AbstractValidator<GuestLineAriRequest>
+{
+	public static readonly GuestLineAriRequestValidator Instance = new();
+
+	public GuestLineAriRequestValidator()
+	{
+		RuleFor(s => s.ActionValue)
+			.NotEmpty()
+			.WithMessage("The Action parameter must be a valid action.");
+
+		RuleFor(s => s.ApiKey)
+			.NotEmpty()
+			.WithMessage("The API key must not be empty.");
+
+		RuleFor(s => s.PropertyId)
+			.NotEmpty()
+			.WithMessage("The Property ID parameter must not be empty.");
+
+		RuleFor(s => s.RoomId)
+			.NotEmpty()
+			.WithMessage("The Room ID parameter must not be empty.");
+
+		RuleFor(s => s.RateId)
+			.NotEmpty()
+			.WithMessage("The Rate ID parameter must not be empty.");
+
+		RuleFor(s => s.Version)
+			.NotEmpty()
+			.WithMessage("The Version parameter must not be empty.");
+
+		When(r => r.Action == AriAction.Range, () =>
+		{
+			RuleFor(s => s.Start)
+				.NotEmpty()
+				.GreaterThanOrEqualTo(DateTime.Today.Date)
+				.WithMessage("The start of the ARI range must be today or after");
+
+			RuleFor(s => s.End)
+				.Custom((end, c) =>
+				{
+					var start = c.InstanceToValidate.Start;
+					if (!end.HasValue)
+					{
+						c.AddFailure("The end of the ARI range must be on or after the start of the range");
+					}
+					else if (!start.HasValue)
+					{
+						c.AddFailure("Cannot request a range without a valid start and end date");
+					}
+					else
+					{
+						var diff = (end.Value - start.Value).Days;
+						if (diff < 0)
+						{
+							c.AddFailure("The end of the range cannot be before the start");
+						}
+						else if (diff > 28)
+						{
+							c.AddFailure("The range cannot extend beyond 28 days when requesting ARI data.");
+						}
+					}
+				});
+		});
+	}
+}

libs/GuestLineSDK/ApiClient.cs

@@ -20,16 +20,33 @@ public abstract class ApiClient
 	readonly GuestLineSettings _settings;
 	readonly JsonSerializerOptions _serializerOptions = JsonUtility.CreateSerializerOptions();
 	readonly JsonSerializerOptions _deserializerOptions = JsonUtility.CreateDeserializerOptions();
-	readonly Uri _baseUrl;
+	readonly Uri _serviceBaseUrl;
+	readonly Uri _bookBaseUrl;
 
 	protected ApiClient(HttpClient http, GuestLineSettings settings)
 	{
 		_http = Ensure.IsNotNull(http, nameof(http));
 		_settings = Ensure.IsNotNull(settings, nameof(settings));
 
-		_baseUrl = new Uri(_settings.BaseUrl);
+		_serviceBaseUrl = new Uri(GuestLineUriResolver.ResolveServiceBaseUrl(settings));
+		_bookBaseUrl = new Uri(GuestLineUriResolver.ResolveBookBaseUrl(settings));
 	}
 
+	/// <summary>
+	/// Gets the book base URL.
+	/// </summary>
+	public Uri BookBaseUrl => _bookBaseUrl;
+
+	/// <summary>
+	/// Gets the service base URL.
+	/// </summary>
+	public Uri ServiceBaseUrl => _serviceBaseUrl;
+
+	/// <summary>
+	/// Gets the settings.
+	/// </summary>
+	public GuestLineSettings Settings => _settings;
+
 	#region Send and Fetch
 	protected internal async Task<GuestLineResponse> SendAsync(
 		GuestLineRequest request,
@@ -238,7 +255,8 @@ protected internal HttpRequestMessage CreateHttpRequest(
 
 		var baseUri = request.Service switch
 		{
-			GuestLineService.Reservation => _baseUrl,
+			GuestLineService.Book => _bookBaseUrl,
+			GuestLineService.ARI => _serviceBaseUrl,
 
 			_ => throw new NotSupportedException(
 				string.Format(Resources.ApiClient_UnsupportedService, request.Service)

libs/GuestLineSDK/Ari/AriUpdate.cs

@@ -86,7 +86,7 @@ public class AriUpdateData : Model<AriUpdateData>
 	/// Amount after tax.
 	/// </summary>
 	[JsonPropertyName("amountAfterTax")]
-	public AriUpdateDataPricing? AmountafterTax { get; set; }
+	public AriUpdateDataPricing? AmountAfterTax { get; set; }
 
 	/// <summary>
 	/// Amount before tax.
@@ -109,7 +109,7 @@ public class AriUpdateData : Model<AriUpdateData>
 	/// <summary>
 	/// Date in YYYY-MM-DD format.
 	/// </summary>
-	[JsonPropertyName("from_date")]
+	[JsonPropertyName("from_date"), JsonConverter(typeof(DateOnlyJsonConverter))]
 	public DateTime? FromDate { get; set; }
 
 	/// <summary>
@@ -151,7 +151,7 @@ public class AriUpdateData : Model<AriUpdateData>
 	/// <summary>
 	/// Date in YYYY-MM-DD format.
 	/// </summary>
-	[JsonPropertyName("to_date")]
+	[JsonPropertyName("to_date"), JsonConverter(typeof(DateOnlyJsonConverter))]
 	public DateTime? ToDate { get; set; }
 }
 

libs/GuestLineSDK/GuestLineRequest.cs

@@ -73,7 +73,12 @@ public class GuestLineRequest<TData>(
 public enum GuestLineService
 {
 	/// <summary>
-	/// The reservation service.
+	/// The booking service.
 	/// </summary>
-	Reservation,
+	Book,
+
+	/// <summary>
+	/// The ARI service.
+	/// </summary>
+	ARI
 }

libs/GuestLineSDK/GuestLineSettings.cs

@@ -1,6 +1,8 @@
 // This work is licensed under the terms of the MIT license.
 // For a copy, see <https://opensource.org/licenses/MIT>.
 
+using System.Security.Cryptography;
+
 using FluentValidation;
 
 using Microsoft.Extensions.Options;
@@ -22,7 +24,12 @@ public class GuestLineSettings
 	/// <summary>
 	/// Gets or sets the base URL.
 	/// </summary>
-	public string BaseUrl { get; set; } = "";
+	public string? BookBaseUrl { get; set; }
+
+	/// <summary>
+	/// Gets or sets the GuestLine environment, defaulting to Production.
+	/// </summary>
+	public GuestLineEnvironment Environment { get; set; } = GuestLineEnvironment.Production;
 
 	/// <summary>
 	/// Gets or sets whether to capture request content.
@@ -34,6 +41,21 @@ public class GuestLineSettings
 	/// </summary>
 	public bool CaptureResponseContent { get; set; }
 
+	/// <summary>
+	/// Gets or sets the partner identifier.
+	/// </summary>
+	public string PartnerId { get; set; } = "";
+
+	/// <summary>
+	/// Gets or sets the service base URL.
+	/// </summary>
+	public string? ServiceBaseUrl { get; set; }
+
+	/// <summary>
+	/// Gets or sets the default request version.
+	/// </summary>
+	public string Version { get; set; } = "2";
+
 	/// <summary>
 	/// Returns the settings as a wrapped options instance.
 	/// </summary>
@@ -48,6 +70,22 @@ public void Validate()
 		=> GuestLineSettingsValidator.Instance.Validate(this);
 }
 
+/// <summary>
+/// Specifies the GuestLine environment.
+/// </summary>
+public enum GuestLineEnvironment
+{
+	/// <summary>
+	/// Production environment.
+	/// </summary>
+	Production,
+
+	/// <summary>
+	/// Test environment.
+	/// </summary>
+	Test
+}
+
 /// <summary>
 /// Validates instances of <see cref="GuestLineSettings"/>.
 /// </summary>
@@ -60,17 +98,34 @@ public GuestLineSettingsValidator()
 		bool ValidateUri(string value)
 			=> Uri.TryCreate(value, UriKind.Absolute, out var _);
 
-		RuleFor(s => s.BaseUrl)
+		RuleFor(s => s.ApiKey)
+			.NotEmpty()
+			.WithMessage("The API key must not be empty.");
+
+		RuleFor(s => s.BookBaseUrl)
 			.Custom((value, context) =>
 			{
-				if (!ValidateUri(value))
+				if (value is { Length: > 0 } && !ValidateUri(value))
 				{
-					context.AddFailure($"'{value}' is not a valid URI.");
+					context.AddFailure($"'{value}' is not a valid book URI.");
 				}
 			});
 
-		RuleFor(s => s.ApiKey)
+		RuleFor(s => s.PartnerId)
 			.NotEmpty()
-			.WithMessage("The API key must not be empty.");
+			.WithMessage("The partner ID must not be empty.");
+
+		RuleFor(s => s.ServiceBaseUrl)
+			.Custom((value, context) =>
+			{
+				if (value is { Length: > 0 } && !ValidateUri(value))
+				{
+					context.AddFailure($"'{value}' is not a valid service URI.");
+				}
+			});
+
+		RuleFor(s => s.Version)
+			.NotEmpty()
+			.WithMessage("The version must not be empty.");
 	}
 }