From d762c4c5a677a9694099fc4d70f5cac268ad2df9 Mon Sep 17 00:00:00 2001
From: Erin Page <epage@recurly.com>
Date: Tue, 29 Oct 2024 12:13:12 -0500
Subject: [PATCH] [BILL-111] adds vertex_transaction_type to plan

---
 Library/Plan.cs                               | 11 ++++
 .../vertex-transaction-type-show-200.xml      | 41 +++++++++++++++
 Test/PlanTest.cs                              | 50 +++++++++++++++++++
 Test/Recurly.Test.csproj                      |  3 ++
 4 files changed, 105 insertions(+)
 create mode 100644 Test/Fixtures/plans/vertex-transaction-type-show-200.xml

diff --git a/Library/Plan.cs b/Library/Plan.cs
index fb51e32e..50a48520 100644
--- a/Library/Plan.cs
+++ b/Library/Plan.cs
@@ -23,6 +23,12 @@ public enum IntervalUnit
         public string SuccessUrl { get; set; }
         public string CancelUrl { get; set; }
 
+        /// <summary>
+        /// VertexTransactionType is one of rental,sale,lease
+        /// Requires feature flag and vertex integration to use
+        /// </summary>
+        public string VertexTransactionType { get; set; }
+
         public bool? DisplayDonationAmounts { get; set; }
         public bool? DisplayQuantity { get; set; }
         public bool? DisplayPhoneNumber { get; set; }
@@ -320,6 +326,10 @@ internal override void ReadXml(XmlTextReader reader)
                         CancelUrl = reader.ReadElementContentAsString();
                         break;
 
+                    case "vertex_transaction_type":
+                        VertexTransactionType = reader.ReadElementContentAsString();
+                        break;
+
                     case "display_donation_amounts":
                         DisplayDonationAmounts = reader.ReadElementContentAsBoolean();
                         break;
@@ -474,6 +484,7 @@ internal override void WriteXml(XmlTextWriter xmlWriter)
             xmlWriter.WriteStringIfValid("description", Description);
             xmlWriter.WriteStringIfValid("accounting_code", AccountingCode);
             xmlWriter.WriteStringIfValid("setup_fee_accounting_code", SetupFeeAccountingCode);
+            xmlWriter.WriteStringIfValid("vertex_transaction_type", VertexTransactionType);
 
             // product revrec features (and setup fee revrec features)
             WriteRevRecNodes(xmlWriter);
diff --git a/Test/Fixtures/plans/vertex-transaction-type-show-200.xml b/Test/Fixtures/plans/vertex-transaction-type-show-200.xml
new file mode 100644
index 00000000..02daab4f
--- /dev/null
+++ b/Test/Fixtures/plans/vertex-transaction-type-show-200.xml
@@ -0,0 +1,41 @@
+HTTP/1.1 200 OK
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<plan href="https://api.recurly.com/v2/plans/silver">
+  <add_ons href="https://api.recurly.com/v2/plans/silver/add_ons"/>
+  <plan_code>silver</plan_code>
+  <name>Silver Plan</name>
+  <description>Silver is everything but gold</description>
+  <success_url>http://example.com/api100_success</success_url>
+  <cancel_url>http://example.com/api100_cancel</cancel_url>
+  <display_donation_amounts type="boolean">false</display_donation_amounts>
+  <display_quantity type="boolean">true</display_quantity>
+  <display_phone_number type="boolean">false</display_phone_number>
+  <bypass_hosted_confirmation type="boolean">true</bypass_hosted_confirmation>
+  <unit_name>wid99gets</unit_name>
+  <payment_page_tos_link>http://example.com/terms-of-service</payment_page_tos_link>
+  <plan_interval_length type="integer">100</plan_interval_length>
+  <plan_interval_unit>months</plan_interval_unit>
+  <trial_interval_length type="integer">15</trial_interval_length>
+  <trial_interval_unit>days</trial_interval_unit>
+  <total_billing_cycles type="integer">6</total_billing_cycles>
+  <accounting_code nil="nil"></accounting_code>
+  <dunning_campaign_id>1234abcd</dunning_campaign_id>
+  <liability_gl_account_id>twrbsq39zvo5</liability_gl_account_id>
+  <revenue_gl_account_id>bwrks63lznoi</revenue_gl_account_id>
+  <performance_obligation_id>rkslzn</performance_obligation_id>
+  <setup_fee_liability_gl_account_id>twrisqjjzvo5</setup_fee_liability_gl_account_id>
+  <setup_fee_revenue_gl_account_id>dlrk123lzabc</setup_fee_revenue_gl_account_id>
+  <setup_fee_performance_obligation_id>bks6noi</setup_fee_performance_obligation_id>
+  <created_at type="datetime">2011-04-19T07:00:00Z</created_at>
+  <vertex_transaction_type>rental</vertex_transaction_type>
+  <unit_amount_in_cents>
+    <USD type="integer">1000</USD>
+    <EUR type="integer">800</EUR>
+  </unit_amount_in_cents>
+  <setup_fee_in_cents>
+    <USD type="integer">500</USD>
+    <EUR type="integer">400</EUR>
+  </setup_fee_in_cents>
+</plan>
diff --git a/Test/PlanTest.cs b/Test/PlanTest.cs
index b58cd34c..20447c0c 100644
--- a/Test/PlanTest.cs
+++ b/Test/PlanTest.cs
@@ -303,5 +303,55 @@ public void CheckForRevRecData()
             plan.SetupFeeRevenueGlAccountId.Should().Be("dlrk123lzabc");
             plan.SetupFeePerformanceObligationId.Should().Be("bks6noi");
         }
+
+        [RecurlyFact(TestEnvironment.Type.Unit)]
+        public void CreatePlanWithVertexTransactionType()
+        {
+            var plan = new Plan(GetMockPlanCode(), GetMockPlanName()) { Description = "Test Delete" };
+            plan.VertexTransactionType = "rental";
+            plan.Create();
+            PlansToDeactivateOnDispose.Add(plan);
+
+            plan = Plans.Get(plan.PlanCode);
+            plan.CreatedAt.Should().NotBe(default(DateTime));
+            plan.VertexTransactionType.Should().Be("rental");
+
+            // Clean up
+            plan.Deactivate();
+            Action get = () => Plans.Get(plan.PlanCode);
+            get.ShouldThrow<NotFoundException>();
+        }
+
+        [RecurlyFact(TestEnvironment.Type.Unit)]
+        public void UpdatePlanWithVertexTransactionType()
+        {
+            var plan = new Plan(GetMockPlanCode(), GetMockPlanName()) { Description = "Test Update Plan with Ramps" };
+            plan.VertexTransactionType = "rental";
+            plan.Create();
+            PlansToDeactivateOnDispose.Add(plan);
+
+            plan.VertexTransactionType = "lease";
+            plan.Update();
+
+            var updatedPlan = Plans.Get(plan.PlanCode);
+            updatedPlan.VertexTransactionType.Should().Be("lease");
+
+            // Clean up
+            plan.Deactivate();
+            Action get = () => Plans.Get(plan.PlanCode);
+            get.ShouldThrow<NotFoundException>();
+        }
+
+        [RecurlyFact(TestEnvironment.Type.Unit)]
+        public void GetPlanWithVertexTransactionType()
+        {
+            var plan = new Plan();
+
+            var xmlFixture = FixtureImporter.Get(FixtureType.Plans, "vertex-transaction-type-show-200").Xml;
+            XmlTextReader reader = new XmlTextReader(new System.IO.StringReader(xmlFixture));
+            plan.ReadXml(reader);
+
+            plan.VertexTransactionType.Should().Be("rental");
+        }
     }
 }
diff --git a/Test/Recurly.Test.csproj b/Test/Recurly.Test.csproj
index ed5d1146..f3123362 100644
--- a/Test/Recurly.Test.csproj
+++ b/Test/Recurly.Test.csproj
@@ -224,6 +224,9 @@
     <Content Include="Fixtures\plans\show-200.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
+    <Content Include="Fixtures\plans\vertex-transaction-type-show-200.xml">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
     <Content Include="Fixtures\subscriptions\show-200-inactive.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>