[AWE-774] Add external payment phases

GET /external_subscriptions/{external_subscription_id}/external_payment_phases GET /external_subscriptions/{external_subscription_id}/external_payment_phases/{external_payment_phase_id} GET /external_payment_phases/{external_payment_phase_id}
recurly · Nov 24, 2023 · db6b863 · db6b863
1 parent e02b0f5
commit db6b863
Show file tree

Hide file tree

Showing 9 changed files with 352 additions and 2 deletions.
diff --git a/Library/ExternalPaymentPhase.cs b/Library/ExternalPaymentPhase.cs
@@ -0,0 +1,154 @@
+using System;
+using System.Net;
+using System.Xml;
+
+namespace Recurly
+{
+    public class ExternalPaymentPhase : RecurlyEntity
+    {
+        public DateTime StartedAt { get; private set; }
+        public DateTime EndsAt { get; private set; }
+        public int StartingBillingPeriodIndex { get; private set; }
+        public int EndingBillingPeriodIndex { get; private set; }
+        public string OfferType { get; private set; }
+        public string OfferName { get; private set; }
+        public int PeriodCount { get; private set; }
+        public string PeriodLength { get; private set; }
+        public decimal Amount { get; private set; }
+        public string Currency { get; private set; }
+        public DateTime CreatedAt { get; private set; }
+        public DateTime UpdatedAt { get; private set; }
+
+        internal const string UrlPrefix = "/external_payment_phases/";
+
+        internal ExternalPaymentPhase()
+        {
+        }
+        internal ExternalPaymentPhase(XmlTextReader reader)
+        {
+            ReadXml(reader);
+        }
+        #region Read XML documents
+
+        internal override void ReadXml(XmlTextReader reader)
+        {
+            while (reader.Read())
+            {
+                DateTime dateVal;
+
+                if (reader.Name == "external_payment_phase" && reader.NodeType == XmlNodeType.EndElement)
+                    break;
+
+                if (reader.NodeType != XmlNodeType.Element) continue;
+
+                switch (reader.Name)
+                {
+                    case "started_at":
+                        if (DateTime.TryParse(reader.ReadElementContentAsString(), out dateVal))
+                            StartedAt = dateVal; ;
+                        break;
+
+                    case "ends_at":
+                        if (DateTime.TryParse(reader.ReadElementContentAsString(), out dateVal))
+                            EndsAt = dateVal; ;
+                        break;
+
+                    case "starting_billing_period_index":
+                        StartingBillingPeriodIndex = reader.ReadElementContentAsInt();
+                        break;
+
+                    case "ending_billing_period_index":
+                        EndingBillingPeriodIndex = reader.ReadElementContentAsInt();
+                        break;
+
+                    case "offer_type":
+                        OfferType = reader.ReadElementContentAsString();
+                        break;
+
+                    case "offer_name":
+                        OfferName = reader.ReadElementContentAsString();
+                        break;
+
+                    case "period_count":
+                        PeriodCount = reader.ReadElementContentAsInt();
+                        break;
+
+                    case "period_length":
+                        PeriodLength = reader.ReadElementContentAsString();
+                        break;
+
+                    case "amount":
+                        Amount = reader.ReadElementContentAsDecimal();
+                        break;
+
+                    case "currency":
+                        Currency = reader.ReadElementContentAsString();
+                        break;
+
+                    case "updated_at":
+                        if (DateTime.TryParse(reader.ReadElementContentAsString(), out dateVal))
+                            UpdatedAt = dateVal; ;
+                        break;
+
+                    case "created_at":
+                        if (DateTime.TryParse(reader.ReadElementContentAsString(), out dateVal))
+                            CreatedAt = dateVal; ;
+                        break;
+
+                }
+            }
+        }
+
+        internal override void WriteXml(XmlTextWriter writer)
+        {
+            throw new NotImplementedException();
+        }
+
+        #endregion
+
+        #region Object Overrides
+
+        public override string ToString()
+        {
+            return "Recurly External Payment Phase: " + StartedAt + " " + EndsAt + " " + StartingBillingPeriodIndex + " " + EndingBillingPeriodIndex + " " + OfferType + " " + OfferName + " " + PeriodCount + " " + PeriodLength + " " + Amount + " " + Currency + " " + CreatedAt + " " + UpdatedAt;
+        }
+
+        #endregion
+    }
+
+    public sealed class ExternalPaymentPhases
+    {
+        /// <summary>
+        /// Returns a list of recurly external_payment_phases
+        /// </summary>
+        /// <returns></returns>
+        public static RecurlyList<ExternalPaymentPhase> List()
+        {
+            return List(null);
+        }
+        /// <summary>
+        /// Returns a list of recurly external_payment_phases
+        /// </summary>
+        /// <param name="filter">FilterCriteria used to apply server side sorting and filtering</param>
+        /// <returns></returns>
+        public static RecurlyList<ExternalPaymentPhase> List(FilterCriteria filter)
+        {
+            filter = filter ?? FilterCriteria.Instance;
+            var parameters = filter.ToNamedValueCollection();
+            return new ExternalPaymentPhaseList(ExternalPaymentPhase.UrlPrefix + "?" + parameters.ToString());
+        }
+        public static ExternalPaymentPhase Get(string uuid)
+        {
+            if (string.IsNullOrWhiteSpace(uuid))
+            {
+                return null;
+            }
+            var externalPaymentPhase = new ExternalPaymentPhase();
+            var statusCode = Client.Instance.PerformRequest(Client.HttpRequestMethod.Get,
+                ExternalPaymentPhase.UrlPrefix + Uri.EscapeDataString(uuid),
+                externalPaymentPhase.ReadXml);
+
+            return statusCode == HttpStatusCode.NotFound ? null : externalPaymentPhase;
+        }
+    }
+}
diff --git a/Library/ExternalSubscription.cs b/Library/ExternalSubscription.cs
@@ -204,5 +204,33 @@ public static RecurlyList<ExternalInvoice> GetExternalInvoices(string uuid)
         {
             return new ExternalInvoiceList(ExternalSubscription.UrlPrefix + Uri.EscapeDataString(uuid) + "/external_invoices/");
         }
+
+        /// <summary>
+        /// Returns a list of external_payment_phases for this external subscription
+        /// </summary>
+        /// <returns></returns>
+        public static RecurlyList<ExternalPaymentPhase> GetExternalPaymentPhases(string uuid)
+        {
+            return new ExternalPaymentPhaseList(ExternalSubscription.UrlPrefix + Uri.EscapeDataString(uuid) + ExternalPaymentPhase.UrlPrefix);
+        }
+
+        /// <summary>
+        /// Returns an external payment phase for external subscription
+        /// </summary>
+        /// <returns></returns>
+        public static ExternalPaymentPhase GetExternalPaymentPhase(string uuid, string externalPaymentPhaseUuid)
+        {
+            if (string.IsNullOrWhiteSpace(uuid) || string.IsNullOrWhiteSpace(externalPaymentPhaseUuid))
+            {
+                return null;
+            }
+            var externalPaymentPhase = new ExternalPaymentPhase();
+            var statusCode = Client.Instance.PerformRequest(Client.HttpRequestMethod.Get,
+                ExternalSubscription.UrlPrefix + Uri.EscapeDataString(uuid) + ExternalPaymentPhase.UrlPrefix + Uri.EscapeDataString(externalPaymentPhaseUuid),
+                externalPaymentPhase.ReadXml);
+
+            return statusCode == HttpStatusCode.NotFound ? null : externalPaymentPhase;
+        }
+
     }
 }
diff --git a/Library/List/ExternalPaymentPhaseList.cs b/Library/List/ExternalPaymentPhaseList.cs
@@ -0,0 +1,43 @@
+using System.Xml;
+
+namespace Recurly
+{
+    public class ExternalPaymentPhaseList : RecurlyList<ExternalPaymentPhase>
+    {
+        internal ExternalPaymentPhaseList(string baseUrl) : base(Client.HttpRequestMethod.Get, baseUrl)
+        {
+        }
+
+        internal ExternalPaymentPhaseList()
+        {
+        }
+        public override RecurlyList<ExternalPaymentPhase> Start
+        {
+            get { return HasStartPage() ? new ExternalPaymentPhaseList(StartUrl) : RecurlyList.Empty<ExternalPaymentPhase>(); }
+        }
+
+        public override RecurlyList<ExternalPaymentPhase> Next
+        {
+            get { return HasNextPage() ? new ExternalPaymentPhaseList(NextUrl) : RecurlyList.Empty<ExternalPaymentPhase>(); }
+        }
+
+        public override RecurlyList<ExternalPaymentPhase> Prev
+        {
+            get { return HasPrevPage() ? new ExternalPaymentPhaseList(PrevUrl) : RecurlyList.Empty<ExternalPaymentPhase>(); }
+        }
+
+        internal override void ReadXml(XmlTextReader reader)
+        {
+            while (reader.Read())
+            {
+                if (reader.Name == "external_payment_phases" && reader.NodeType == XmlNodeType.EndElement)
+                    break;
+
+                if (reader.NodeType == XmlNodeType.Element && reader.Name == "external_payment_phase")
+                {
+                    Add(new ExternalPaymentPhase(reader));
+                }
+            }
+        }
+    }
+}
diff --git a/Test/ExternalPaymentPhaseTest.cs b/Test/ExternalPaymentPhaseTest.cs
@@ -0,0 +1,31 @@
+using System;
+using System.Xml;
+using FluentAssertions;
+using Recurly.Test.Fixtures;
+
+namespace Recurly.Test
+{
+    public class ExternalPaymentPhaseTest : BaseTest
+    {
+        [RecurlyFact(TestEnvironment.Type.Integration)]
+        public void LookupExternalPaymentPhase()
+        {
+            var externalPaymentPhase = new ExternalPaymentPhase();
+            var xmlFixture = FixtureImporter.Get(FixtureType.ExternalPaymentPhases, "show-200").Xml;
+            XmlTextReader reader = new XmlTextReader(new System.IO.StringReader(xmlFixture));
+            externalPaymentPhase.ReadXml(reader);
+            externalPaymentPhase.StartedAt.Should().Be(new DateTime(2023, 11, 15, 0, 0, 0, DateTimeKind.Utc));
+            externalPaymentPhase.EndsAt.Should().Be(new DateTime(2023, 11, 17, 21, 27, 10, DateTimeKind.Utc));
+            externalPaymentPhase.StartingBillingPeriodIndex.Should().Be(1);
+            externalPaymentPhase.EndingBillingPeriodIndex.Should().Be(2);
+            externalPaymentPhase.OfferType.Should().Be("FREE_TRIAL");
+            externalPaymentPhase.OfferName.Should().Be("introductory");
+            externalPaymentPhase.PeriodCount.Should().Be(2);
+            externalPaymentPhase.PeriodLength.Should().Be("TWO WEEKS");
+            externalPaymentPhase.Amount.Should().Be(new decimal(1.99));
+            externalPaymentPhase.Currency.Should().Be("USD");
+            externalPaymentPhase.CreatedAt.Should().Be(new DateTime(2023, 11, 15, 16, 16, 43, DateTimeKind.Utc));
+            externalPaymentPhase.UpdatedAt.Should().Be(new DateTime(2023, 11, 15, 16, 16, 43, DateTimeKind.Utc));
+        }
+    }
+}
diff --git a/Test/Fixtures/FixtureImporter.cs b/Test/Fixtures/FixtureImporter.cs
@@ -8,6 +8,15 @@ namespace Recurly.Test.Fixtures
 {
     public class FixtureImporter
     {
+        public static string GetFixtureTypeDescription(FixtureType type)
+        {
+            DescriptionAttribute[] attributes = (DescriptionAttribute[])type
+           .GetType()
+           .GetField(type.ToString())
+           .GetCustomAttributes(typeof(DescriptionAttribute), false);
+
+            return attributes.Length > 0 ? attributes[0].Description : string.Empty;
+        }
         public static FixtureResponse Get(FixtureType type, string name)
         {
             if (name.IsNullOrEmpty())
@@ -16,7 +25,7 @@ public static FixtureResponse Get(FixtureType type, string name)
             if (!Enum.IsDefined(typeof(FixtureType), type))
                 throw new InvalidEnumArgumentException("type", (int)type, typeof(FixtureType));
 
-            var fixturePath = string.Format("fixtures/{0}/{1}.xml", type, name);
+            var fixturePath = string.Format("Fixtures/{0}/{1}.xml", GetFixtureTypeDescription(type), name);
 
             if (!File.Exists(fixturePath))
                 throw new FileNotFoundException("Could not locate the fixture response file!", fixturePath);
@@ -66,6 +75,8 @@ private static KeyValuePair<string, string> ParseHeader(string line)
 
     public enum FixtureType
     {
-        Accounts
+        Accounts,
+        [Description("external_payment_phases")]
+        ExternalPaymentPhases,
     }
 }
diff --git a/Test/Fixtures/external_payment_phases/index-200.xml b/Test/Fixtures/external_payment_phases/index-200.xml
@@ -0,0 +1,21 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<external_payment_phases type="array">
+    <external_payment_phase href="https://api.recurly.com/v2/external_payment_phases/twqswp627ri3">
+        <id>twqswp627ri3</id>
+        <started_at type="datetime">2023-11-15T00:00:00Z</started_at>
+        <ends_at type="datetime">2023-11-17T21:27:10Z</ends_at>
+        <starting_billing_period_index>1</starting_billing_period_index>
+        <ending_billing_period_index>2</ending_billing_period_index>
+        <offer_type>FREE_TRIAL</offer_type>
+        <offer_name>introductory</offer_name>
+        <period_count>2</period_count>
+        <period_length>TWO WEEKS</period_length>
+        <amount>1.99</amount>
+        <currency>USD</currency>
+        <created_at type="datetime">2023-11-15T16:16:43Z</created_at>
+        <updated_at type="datetime">2023-11-15T16:16:43Z</updated_at>
+    </external_payment_phase>
+</external_payment_phases>
diff --git a/Test/Fixtures/external_payment_phases/show-200.xml b/Test/Fixtures/external_payment_phases/show-200.xml
@@ -0,0 +1,19 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<external_payment_phase href="https://api.recurly.com/v2/external_payment_phases/twqswp627ri3">
+    <id>twqswp627ri3</id>
+    <started_at type="datetime">2023-11-15T00:00:00Z</started_at>
+    <ends_at type="datetime">2023-11-17T21:27:10Z</ends_at>
+    <starting_billing_period_index>1</starting_billing_period_index>
+    <ending_billing_period_index>2</ending_billing_period_index>
+    <offer_type>FREE_TRIAL</offer_type>
+    <offer_name>introductory</offer_name>
+    <period_count>2</period_count>
+    <period_length>TWO WEEKS</period_length>
+    <amount>1.99</amount>
+    <currency>USD</currency>
+    <created_at type="datetime">2023-11-15T16:16:43Z</created_at>
+    <updated_at type="datetime">2023-11-15T16:16:43Z</updated_at>
+</external_payment_phase>
diff --git a/Test/List/ExternalPaymentPhaseListTest.cs b/Test/List/ExternalPaymentPhaseListTest.cs
@@ -0,0 +1,37 @@
+using System;
+
+using System.Xml;
+
+using FluentAssertions;
+
+using Recurly.Test.Fixtures;
+
+namespace Recurly.Test
+{
+    public class ExternalPaymentPhaseListTest : BaseTest
+    {
+        [RecurlyFact(TestEnvironment.Type.Integration)]
+        public void ListExternalPaymentPhase()
+        {
+            var xmlFixture = FixtureImporter.Get(FixtureType.ExternalPaymentPhases, "index-200").Xml;
+            var externalPaymentPhases = new ExternalPaymentPhaseList();
+            XmlTextReader reader = new XmlTextReader(new System.IO.StringReader(xmlFixture));
+            externalPaymentPhases.ReadXml(reader);
+            externalPaymentPhases.Should().HaveCount(1);
+            var externalPaymentPhase = externalPaymentPhases[0];
+            externalPaymentPhase.StartedAt.Should().Be(new DateTime(2023, 11, 15, 0, 0, 0, DateTimeKind.Utc));
+            externalPaymentPhase.EndsAt.Should().Be(new DateTime(2023, 11, 17, 21, 27, 10, DateTimeKind.Utc));
+            externalPaymentPhase.StartingBillingPeriodIndex.Should().Be(1);
+            externalPaymentPhase.EndingBillingPeriodIndex.Should().Be(2);
+            externalPaymentPhase.OfferType.Should().Be("FREE_TRIAL");
+            externalPaymentPhase.OfferName.Should().Be("introductory");
+            externalPaymentPhase.PeriodCount.Should().Be(2);
+            externalPaymentPhase.PeriodLength.Should().Be("TWO WEEKS");
+            externalPaymentPhase.Amount.Should().Be(new decimal(1.99));
+            externalPaymentPhase.Currency.Should().Be("USD");
+            externalPaymentPhase.CreatedAt.Should().Be(new DateTime(2023, 11, 15, 16, 16, 43, DateTimeKind.Utc));
+            externalPaymentPhase.UpdatedAt.Should().Be(new DateTime(2023, 11, 15, 16, 16, 43, DateTimeKind.Utc));
+
+        }
+    }
+}
diff --git a/Test/Recurly.Test.csproj b/Test/Recurly.Test.csproj
@@ -206,6 +206,12 @@
     <Content Include="Fixtures\transactions\show-200.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
+    <Content Include="Fixtures/external_payment_phases/index-200.xml">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <Content Include="Fixtures/external_payment_phases/show-200.xml">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
   </ItemGroup>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
        Other similar extension points exist, see Microsoft.Common.targets.