Merge pull request #654 from recurly/v2_external_subscriptions_new_fields

V2 Client Library External Subscription changes

Author: ELepolt

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     name: Python ${{ matrix.python }} tests
     strategy:
       matrix:
-        python: [2.7, 3.7, 3.8, 3.9]
+        python: [3.7, 3.8, 3.9]
         os: [ubuntu-latest]
         include:
           # Python 3.6 is not included in ubuntu latest (currently 22)

recurly/__init__.py

@@ -2194,11 +2194,15 @@ class ExternalSubscription(Resource):
         'external_product_reference',
         'last_purchased',
         'auto_renew',
+        'in_grace_period',
         'app_identifier',
         'quantity',
         'state',
         'activated_at',
+        'canceled_at',
         'expires_at',
+        'trial_started_at',
+        'trial_ends_at',
         'created_at',
         'updated_at'
     )

tests/fixtures/account/external-subscriptions.xml

@@ -17,11 +17,15 @@ Content-Type: application/xml; charset=utf-8
         <external_product_reference nil="nil"></external_product_reference>
         <last_purchased nil="nil"></last_purchased>
         <auto_renew type="boolean">false</auto_renew>
+        <in_grace_period type="boolean">false</in_grace_period>
         <app_identifier nil="nil"></app_identifier>
         <quantity type="integer">1</quantity>
         <state>active</state>
         <activated_at nil="nil"></activated_at>
+        <canceled_at type="datetime">2022-11-03T21:57:14Z</canceled_at>
         <expires_at nil="nil"></expires_at>
+        <trial_started_at type="datetime">2022-11-03T21:57:14Z</trial_started_at>
+        <trial_ends_at type="datetime">2022-11-03T21:57:14Z</trial_ends_at>
         <created_at type="datetime">2022-11-04T19:45:00Z</created_at>
         <updated_at type="datetime">2022-11-04T19:45:00Z</updated_at>
     </external_subscription>
@@ -32,11 +36,15 @@ Content-Type: application/xml; charset=utf-8
         <external_product_reference nil="nil"></external_product_reference>
         <last_purchased nil="nil"></last_purchased>
         <auto_renew type="boolean">false</auto_renew>
+        <in_grace_period type="boolean">false</in_grace_period>
         <app_identifier>app_identifier</app_identifier>
         <quantity type="integer">1</quantity>
         <state>active</state>
         <activated_at nil="nil"></activated_at>
+        <canceled_at type="datetime">2022-11-03T21:57:14Z</canceled_at>
         <expires_at nil="nil"></expires_at>
+        <trial_started_at type="datetime">2022-11-03T21:57:14Z</trial_started_at>
+        <trial_ends_at type="datetime">2022-11-03T21:57:14Z</trial_ends_at>
         <created_at type="datetime">2022-11-03T21:57:14Z</created_at>
         <updated_at type="datetime">2022-11-04T18:11:51Z</updated_at>
     </external_subscription>

tests/fixtures/external-subscription/get.xml

@@ -16,11 +16,15 @@ Content-Type: application/xml; charset=utf-8
     <external_product_reference nil="nil"></external_product_reference>
     <last_purchased nil="nil"></last_purchased>
     <auto_renew type="boolean">false</auto_renew>
+    <in_grace_period type="boolean">false</in_grace_period>
     <app_identifier>app_identifier</app_identifier>
     <quantity type="integer">1</quantity>
     <state>active</state>
     <activated_at nil="nil"></activated_at>
+    <canceled_at type="datetime">2022-11-03T21:57:14Z</canceled_at>
     <expires_at nil="nil"></expires_at>
+    <trial_started_at type="datetime">2022-11-03T21:57:14Z</trial_started_at>
+    <trial_ends_at type="datetime">2022-11-03T21:57:14Z</trial_ends_at>
     <created_at type="datetime">2022-11-03T21:57:14Z</created_at>
     <updated_at type="datetime">2022-11-04T18:11:51Z</updated_at>
 </external_subscription>

tests/fixtures/external-subscription/list.xml

@@ -16,11 +16,15 @@ Content-Type: application/xml; charset=utf-8
         <external_product_reference nil="nil"></external_product_reference>
         <last_purchased nil="nil"></last_purchased>
         <auto_renew type="boolean">false</auto_renew>
+        <in_grace_period type="boolean">false</in_grace_period>
         <app_identifier nil="nil"></app_identifier>
         <quantity type="integer">1</quantity>
         <state>active</state>
         <activated_at nil="nil"></activated_at>
+        <canceled_at type="datetime">2022-11-03T21:57:14Z</canceled_at>
         <expires_at nil="nil"></expires_at>
+        <trial_started_at type="datetime">2022-11-03T21:57:14Z</trial_started_at>
+        <trial_ends_at type="datetime">2022-11-03T21:57:14Z</trial_ends_at>
         <created_at type="datetime">2022-11-04T19:45:00Z</created_at>
         <updated_at type="datetime">2022-11-04T19:45:00Z</updated_at>
     </external_subscription>
@@ -30,11 +34,15 @@ Content-Type: application/xml; charset=utf-8
         <external_product_reference nil="nil"></external_product_reference>
         <last_purchased nil="nil"></last_purchased>
         <auto_renew type="boolean">false</auto_renew>
+        <in_grace_period type="boolean">false</in_grace_period>
         <app_identifier>app_identifier</app_identifier>
         <quantity type="integer">1</quantity>
         <state>active</state>
         <activated_at nil="nil"></activated_at>
+        <canceled_at type="datetime">2022-11-03T21:57:14Z</canceled_at>
         <expires_at nil="nil"></expires_at>
+        <trial_started_at type="datetime">2022-11-03T21:57:14Z</trial_started_at>
+        <trial_ends_at type="datetime">2022-11-03T21:57:14Z</trial_ends_at>
         <created_at type="datetime">2022-11-03T21:57:14Z</created_at>
         <updated_at type="datetime">2022-11-04T18:11:51Z</updated_at>
     </external_subscription>

tests/test_resources.py

@@ -3013,23 +3013,31 @@ def test_external_subscriptions_on_account(self):
         self.assertEqual(external_subscriptions[0].external_product_reference, None)
         self.assertEqual(external_subscriptions[0].last_purchased, None)
         self.assertEqual(external_subscriptions[0].auto_renew, False)
+        self.assertEqual(external_subscriptions[0].in_grace_period, False)
         self.assertEqual(external_subscriptions[0].app_identifier, None)
         self.assertEqual(external_subscriptions[0].quantity, 1)
         self.assertEqual(external_subscriptions[0].state, 'active')
         self.assertEqual(external_subscriptions[0].activated_at, None)
+        self.assertEqual(external_subscriptions[0].canceled_at, datetime(2022, 11, 3, 21, 57, 14,tzinfo=external_subscriptions[0].canceled_at.tzinfo))
         self.assertEqual(external_subscriptions[0].expires_at, None)
+        self.assertEqual(external_subscriptions[0].trial_started_at, datetime(2022, 11, 3, 21, 57, 14,tzinfo=external_subscriptions[0].trial_started_at.tzinfo))
+        self.assertEqual(external_subscriptions[0].trial_ends_at, datetime(2022, 11, 3, 21, 57, 14,tzinfo=external_subscriptions[0].trial_ends_at.tzinfo))
         self.assertEqual(external_subscriptions[0].created_at, datetime(2022, 11, 4, 19, 45, tzinfo=external_subscriptions[0].created_at.tzinfo))
         self.assertEqual(external_subscriptions[0].updated_at, datetime(2022, 11, 4, 19, 45, tzinfo=external_subscriptions[0].updated_at.tzinfo))
 
         self.assertEqual(external_subscriptions[1].external_id, 'efgh5678')
         self.assertEqual(external_subscriptions[1].external_product_reference, None)
         self.assertEqual(external_subscriptions[1].last_purchased, None)
         self.assertEqual(external_subscriptions[1].auto_renew, False)
+        self.assertEqual(external_subscriptions[1].in_grace_period, False)
         self.assertEqual(external_subscriptions[1].app_identifier, 'app_identifier')
         self.assertEqual(external_subscriptions[1].quantity, 1)
         self.assertEqual(external_subscriptions[1].state, 'active')
         self.assertEqual(external_subscriptions[1].activated_at, None)
+        self.assertEqual(external_subscriptions[1].canceled_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].canceled_at.tzinfo))
         self.assertEqual(external_subscriptions[1].expires_at, None)
+        self.assertEqual(external_subscriptions[1].trial_started_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].trial_started_at.tzinfo))
+        self.assertEqual(external_subscriptions[1].trial_ends_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].trial_ends_at.tzinfo))
         self.assertEqual(external_subscriptions[1].created_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].created_at.tzinfo))
         self.assertEqual(external_subscriptions[1].updated_at, datetime(2022, 11, 4, 18, 11, 51, tzinfo=external_subscriptions[1].updated_at.tzinfo))
 
@@ -3044,23 +3052,31 @@ def test_list_external_subscriptions(self):
         self.assertEqual(external_subscriptions[0].external_product_reference, None)
         self.assertEqual(external_subscriptions[0].last_purchased, None)
         self.assertEqual(external_subscriptions[0].auto_renew, False)
+        self.assertEqual(external_subscriptions[0].in_grace_period, False)
         self.assertEqual(external_subscriptions[0].app_identifier, None)
         self.assertEqual(external_subscriptions[0].quantity, 1)
         self.assertEqual(external_subscriptions[0].state, 'active')
         self.assertEqual(external_subscriptions[0].activated_at, None)
+        self.assertEqual(external_subscriptions[0].canceled_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[0].canceled_at.tzinfo))
         self.assertEqual(external_subscriptions[0].expires_at, None)
+        self.assertEqual(external_subscriptions[0].trial_started_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[0].trial_started_at.tzinfo))
+        self.assertEqual(external_subscriptions[0].trial_ends_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[0].trial_ends_at.tzinfo))
         self.assertEqual(external_subscriptions[0].created_at, datetime(2022, 11, 4, 19, 45, tzinfo=external_subscriptions[0].created_at.tzinfo))
-        self.assertEqual(external_subscriptions[0].updated_at, datetime(2022, 11, 4, 19, 45, tzinfo=external_subscriptions[0].created_at.tzinfo))
+        self.assertEqual(external_subscriptions[0].updated_at, datetime(2022, 11, 4, 19, 45, tzinfo=external_subscriptions[0].updated_at.tzinfo))
 
         self.assertEqual(external_subscriptions[1].external_id, 'efgh5678')
         self.assertEqual(external_subscriptions[1].external_product_reference, None)
         self.assertEqual(external_subscriptions[1].last_purchased, None)
         self.assertEqual(external_subscriptions[1].auto_renew, False)
+        self.assertEqual(external_subscriptions[1].in_grace_period, False)
         self.assertEqual(external_subscriptions[1].app_identifier, 'app_identifier')
         self.assertEqual(external_subscriptions[1].quantity, 1)
         self.assertEqual(external_subscriptions[1].state, 'active')
         self.assertEqual(external_subscriptions[1].activated_at, None)
+        self.assertEqual(external_subscriptions[1].canceled_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].canceled_at.tzinfo))
         self.assertEqual(external_subscriptions[1].expires_at, None)
+        self.assertEqual(external_subscriptions[1].trial_started_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].trial_started_at.tzinfo))
+        self.assertEqual(external_subscriptions[1].trial_ends_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].trial_ends_at.tzinfo))
         self.assertEqual(external_subscriptions[1].created_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscriptions[1].created_at.tzinfo))
         self.assertEqual(external_subscriptions[1].updated_at, datetime(2022, 11, 4, 18, 11, 51, tzinfo=external_subscriptions[1].updated_at.tzinfo))
 
@@ -3073,11 +3089,15 @@ def test_get_external_subscription(self):
         self.assertEqual(external_subscription.external_product_reference, None)
         self.assertEqual(external_subscription.last_purchased, None)
         self.assertEqual(external_subscription.auto_renew, False)
+        self.assertEqual(external_subscription.in_grace_period, False)
         self.assertEqual(external_subscription.app_identifier, 'app_identifier')
         self.assertEqual(external_subscription.quantity, 1)
         self.assertEqual(external_subscription.state, 'active')
         self.assertEqual(external_subscription.activated_at, None)
+        self.assertEqual(external_subscription.canceled_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscription.canceled_at.tzinfo))
         self.assertEqual(external_subscription.expires_at, None)
+        self.assertEqual(external_subscription.trial_started_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscription.trial_started_at.tzinfo))
+        self.assertEqual(external_subscription.trial_ends_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscription.trial_ends_at.tzinfo))
         self.assertEqual(external_subscription.created_at, datetime(2022, 11, 3, 21, 57, 14, tzinfo=external_subscription.created_at.tzinfo))
         self.assertEqual(external_subscription.updated_at, datetime(2022, 11, 4, 18, 11, 51, tzinfo=external_subscription.updated_at.tzinfo))