Add Tasks API support to Python Client [sc-66753] (#109)

* [sc-66753] Added support for Tasks API

* Adjusted Task resource defintion to specify 'allow_none=True' for completed_at field

* Dropped support for Python 3.8 since it has passed the EOL period

* Bumped version to 4.6.0

Author: keith-chartmogul

.github/workflows/test.yml

@@ -31,7 +31,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-       python-versions: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+       python-versions: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-versions }}

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning].
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
 
+## [4.6.0] - 2025-04-25
+- Adds support for Tasks (https://dev.chartmogul.com/reference/tasks)
+
 ## [4.5.1] - 2025-04-07
 - Update urllib3 dependency to use >=2.2.3 to allow for future minor updates
 

README.md

@@ -29,7 +29,7 @@
 
 ## Installation
 
-This library requires Python 3.8 to 3.12. It was last tested against Python 2.7 in version 1.3.0.
+This library requires Python 3.9 to 3.12. It was last tested against Python 2.7 in version 1.3.0.
 
 ```sh
 pip3 install chartmogul
@@ -106,7 +106,7 @@ except Exception as ex:
 
 Available methods in Import API:
 
-#### [Data Sources](https://dev.chartmogul.com/docs/data-sources)
+#### [Data Sources](https://dev.chartmogul.com/reference/sources/)
 
 ```python
 chartmogul.DataSource.create(config, data={'name': 'In-house billing'})
@@ -115,7 +115,7 @@ chartmogul.DataSource.all(config)
 chartmogul.DataSource.destroy(config, uuid='ds_5915ee5a-babd-406b-b8ce-d207133fb4cb')
 ```
 
-#### [Customers](https://dev.chartmogul.com/docs/customers)
+#### [Customers](https://dev.chartmogul.com/reference/customers/)
 
 ```python
 chartmogul.Customer.create(config, data={})
@@ -166,11 +166,13 @@ chartmogul.Customer.contacts(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb
 chartmogul.Customer.createContact(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={})
 chartmogul.Customer.notes(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', cursor='aabbcc', per_page=20)
 chartmogul.Customer.createNote(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={})
-chartmogul.Customer.opporunities(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', cursor='aabbcc', per_page=20)
+chartmogul.Customer.opportunities(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', cursor='aabbcc', per_page=20)
 chartmogul.Customer.createOpportunity(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={})
+chartmogul.Customer.tasks(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', cursor='aabbcc', per_page=20)
+chartmogul.Customer.createTask(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={})
 ```
 
-#### [Contacts](https://dev.chartmogul.com/docs/contacts)
+#### [Contacts](https://dev.chartmogul.com/reference/contacts/)
 
 ```python
 chartmogul.Contact.create(config, data={})
@@ -183,7 +185,7 @@ chartmogul.Contact.modify(config, uuid='con_5915ee5a-babd-406b-b8ce-d207133fb4cb
 chartmogul.Contact.destroy(config, uuid='con_5915ee5a-babd-406b-b8ce-d207133fb4cb')
 ```
 
-#### [Customer Notes](https://dev.chartmogul.com/docs/customer_notes)
+#### [Customer Notes](https://dev.chartmogul.com/reference/notes-and-call-logs/)
 ```python
 chartmogul.CustomerNote.create(config, data={})
 chartmogul.CustomerNote.all(config, cursor='aabbcc', per_page=20, customer_uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb')
@@ -192,7 +194,7 @@ chartmogul.CustomerNote.patch(config, uuid='note_5915ee5a-babd-406b-b8ce-d207133
 chartmogul.CustomerNote.destroy(config, uuid='note_5915ee5a-babd-406b-b8ce-d207133fb4cb')
 ```
 
-#### [Opportunities](https://dev.chartmogul.com/docs/opportunities)
+#### [Opportunities](https://dev.chartmogul.com/reference/opportunities/)
 
 ```python
 chartmogul.Opportunity.create(config, data={})
@@ -202,15 +204,25 @@ chartmogul.Opportunity.patch(config, uuid='5915ee5a-babd-406b-b8ce-d207133fb4cb'
 chartmogul.Opportunity.destroy(config, uuid='5915ee5a-babd-406b-b8ce-d207133fb4cb')
 ```
 
-#### [Customer Attributes](https://dev.chartmogul.com/docs/customer-attributes)
+#### [Tasks](https://dev.chartmogul.com/reference/tasks/)
+
+```python
+chartmogul.Task.create(config, data={})
+chartmogul.Task.all(config, cursor='aabbcc', per_page=20, customer_uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb')
+chartmogul.Task.retrieve(config, uuid='5915ee5a-babd-406b-b8ce-d207133fb4cb')
+chartmogul.Task.patch(config, uuid='5915ee5a-babd-406b-b8ce-d207133fb4cb')
+chartmogul.Task.destroy(config, uuid='5915ee5a-babd-406b-b8ce-d207133fb4cb')
+```
+
+#### [Customer Attributes](https://dev.chartmogul.com/reference/customers/attributes/)
 
 Note that the returned attributes of type date are not parsed and stay in string.
 
 ```python
 chartmogul.Attributes.retrieve(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb')
 ```
 
-#### [Tags](https://dev.chartmogul.com/docs/tags)
+#### [Tags](https://dev.chartmogul.com/reference/customers/tags/)
 
 ```python
 chartmogul.Tags.add(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={
@@ -225,7 +237,7 @@ chartmogul.Tags.remove(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb',
 })
 ```
 
-#### [Custom Attributes](https://dev.chartmogul.com/docs/custom-attributes)
+#### [Custom Attributes](https://dev.chartmogul.com/reference/customers/attributes/)
 
 ```python
 chartmogul.CustomAttributes.add(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={
@@ -250,7 +262,7 @@ chartmogul.CustomAttributes.remove(config, uuid='cus_5915ee5a-babd-406b-b8ce-d20
 })
 ```
 
-#### [Plans](https://dev.chartmogul.com/docs/plans)
+#### [Plans](https://dev.chartmogul.com/reference/plans/)
 
 ```python
 chartmogul.Plan.create(config, data={})
@@ -262,7 +274,7 @@ chartmogul.Plan.all(config, cursor='cursor==', external_id='')
 chartmogul.Plan.destroy(config, uuid='')
 ```
 
-#### [Plan Groups](https://dev.chartmogul.com/docs/plan_groups)
+#### [Plan Groups](https://dev.chartmogul.com/reference/plan-groups/)
 
 ```python
 chartmogul.PlanGroup.create(config, data={})
@@ -273,7 +285,7 @@ chartmogul.PlanGroup.all(config, uuid='plg_5915ee5a-babd-406b-b8ce-d207133fb4cb'
 chartmogul.PlanGroup.destroy(config, uuid='')
 ```
 
-#### [Invoices](https://dev.chartmogul.com/docs/invoices)
+#### [Invoices](https://dev.chartmogul.com/reference/invoices/)
 
 ```python
 import chartmogul
@@ -284,15 +296,15 @@ chartmogul.Invoice.all(config, customer_uuid='cus_f466e33d-ff2b-4a11-8f85-417eb0
 chartmogul.Invoice.retrieve(config, uuid='inv_22910fc6-c931-48e7-ac12-90d2cb5f0059')
 ```
 
-#### [Transactions](https://dev.chartmogul.com/docs/transactions)
+#### [Transactions](https://dev.chartmogul.com/reference/transactions/)
 
 ```python
 import chartmogul
 
 chartmogul.Transaction.create(config, uuid='inv_745df1d4-819f-48ee-873d-b5204801e021', data={})
 ```
 
-#### [SubscriptionEvents](https://dev.chartmogul.com/docs/subscription_events)
+#### [SubscriptionEvents](https://dev.chartmogul.com/reference/subscription-events/)
 
 ```python
 import chartmogul
@@ -323,7 +335,7 @@ chartmogul.SubscriptionEvent.destroy_with_params(config, data={
 }})
 ```
 
-#### [Subscriptions](https://dev.chartmogul.com/docs/subscriptions)
+#### [Subscriptions](https://dev.chartmogul.com/reference/subscriptions/)
 
 ```python
 import chartmogul
@@ -333,7 +345,7 @@ chartmogul.Subscription.cancel(config, uuid='sub_3995ee5a-bbdb-406b-a8ca-d207133
 chartmogul.Subscription.modify(config, uuid='sub_3995ee5a-bbdb-406b-a8ca-d207133fb9bb' data={'cancellation_dates': []})
 ```
 
-### [Metrics API](https://dev.chartmogul.com/docs/introduction-metrics-api)
+### [Metrics API](https://dev.chartmogul.com/reference/metrics/)
 
 Available methods in Metrics API:
 

chartmogul/__init__.py

@@ -17,6 +17,7 @@
 from .api.invoice import Invoice
 from .api.metrics import Metrics
 from .api.opportunity import Opportunity
+from .api.task import Task
 from .api.ping import Ping
 from .api.plan import Plan
 from .api.plan_group import PlanGroup

chartmogul/api/customer.py

@@ -12,6 +12,7 @@
 from .contact import Contact
 from .customer_note import CustomerNote
 from .opportunity import Opportunity
+from .task import Task
 
 
 class Address(DataObject):
@@ -93,3 +94,5 @@ def make(self, data, **kwargs):
 Customer.createNote = CustomerNote._method("create", "post", "/customer_notes", useCallerClass=True, useUUIDFor="customer_uuid")
 Customer.opportunities = Opportunity._method("all", "get", "/opportunities?customer_uuid={uuid}", useCallerClass=True)
 Customer.createOpportunity = Opportunity._method("create", "post", "/opportunities", useCallerClass=True, useUUIDFor="customer_uuid")
+Customer.tasks = Task._method("all", "get", "/tasks?customer_uuid={uuid}", useCallerClass=True)
+Customer.createTask = Task._method("create", "post", "/tasks", useCallerClass=True, useUUIDFor="customer_uuid")

chartmogul/api/task.py

@@ -0,0 +1,30 @@
+from marshmallow import Schema, fields, post_load, EXCLUDE
+from ..resource import Resource
+from collections import namedtuple
+
+
+class Task(Resource):
+    """
+    https://dev.chartmogul.com/reference/tasks
+    """
+
+    _path = "/tasks{/uuid}"
+    _root_key = "entries"
+    _many = namedtuple("Tasks", [_root_key, "has_more", "cursor"])
+
+    class _Schema(Schema):
+
+        uuid = fields.String()
+        customer_uuid = fields.String()
+        assignee = fields.String()
+        task_details = fields.String()
+        due_date = fields.DateTime()
+        completed_at = fields.DateTime(allow_none=True)
+        created_at = fields.DateTime()
+        updated_at = fields.DateTime()
+
+        @post_load
+        def make(self, data, **kwargs):
+            return Task(**data)
+
+    _schema = _Schema(unknown=EXCLUDE)

chartmogul/version.py

@@ -1 +1 @@
-__version__ = "4.5.1"
+__version__ = "4.6.0"

setup.py

@@ -67,7 +67,6 @@
     classifiers=[
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",

test/api/test_customer.py

@@ -1,5 +1,5 @@
 import unittest
-from chartmogul import Customer, Contact, Config, CustomerNote, Opportunity
+from chartmogul import Customer, Contact, Config, CustomerNote, Opportunity, Task
 from chartmogul.api.customer import Attributes, Address
 from datetime import datetime
 from chartmogul import APIError
@@ -362,6 +362,38 @@
 
 allOpportunities = {"entries": [opportunityEntry], "cursor": "cursor==", "has_more": True}
 
+task = {
+    "uuid": "00000000-0000-0000-0000-000000000000",
+    "customer_uuid": "cus_00000000-0000-0000-0000-000000000000",
+    "assignee": "customer@example.com",
+    "task_details": "This is some task details text.",
+    "due_date": "2025-04-30T00:00:00Z",
+    "completed_at": "2025-04-20T00:00:00Z",
+    "created_at": "2025-04-01T12:00:00.000Z",
+    "updated_at": "2025-04-01T12:00:00.000Z"
+}
+
+createTask = {
+    "customer_uuid": "cus_00000000-0000-0000-0000-000000000000",
+    "assignee": "customer@example.com",
+    "task_details": "This is some task details text.",
+    "due_date": "2025-04-30T00:00:00Z",
+    "completed_at": None,
+}
+
+taskEntry = {
+    "uuid": "00000000-0000-0000-0000-000000000000",
+    "customer_uuid": "cus_00000000-0000-0000-0000-000000000000",
+    "assignee": "customer@example.com",
+    "task_details": "This is some task details text.",
+    "due_date": "2025-04-30T00:00:00Z",
+    "completed_at": "2025-04-20T00:00:00Z",
+    "created_at": "2025-04-01T12:00:00.000Z",
+    "updated_at": "2025-04-01T12:00:00.000Z"
+}
+
+allTasks = {"entries": [taskEntry], "cursor": "cursor==", "has_more": False}
+
 
 class CustomerTestCase(unittest.TestCase):
     """
@@ -453,7 +485,7 @@ def test_merge(self, mock_requests):
         self.assertEqual(mock_requests.last_request.qs, {})
         self.assertEqual(mock_requests.last_request.json(), jsonRequest)
         self.assertEqual(result, None)
-    
+
     @requests_mock.mock()
     def test_unmerge(self, mock_requests):
         mock_requests.register_uri(
@@ -701,3 +733,48 @@ def test_createOpportunity(self, mock_requests):
         self.assertEqual(mock_requests.last_request.qs, {})
         self.assertEqual(mock_requests.last_request.json(), createOpportunity)
         self.assertTrue(isinstance(expected, Opportunity))
+
+    @requests_mock.mock()
+    def test_tasks(self, mock_requests):
+        mock_requests.register_uri(
+            "GET",
+            "https://api.chartmogul.com/v1/tasks?customer_uuid=cus_00000000-0000-0000-0000-000000000000&cursor=df431387&per_page=1",
+            status_code=200,
+            json=allTasks,
+        )
+
+        config = Config("token")
+        tasks = Customer.tasks(
+            config,
+            uuid="cus_00000000-0000-0000-0000-000000000000",
+            cursor="df431387",
+            per_page=1,
+            ).get()
+        expected = Customer._many(**allTasks)
+
+        self.assertEqual(mock_requests.call_count, 1, "expected call")
+        self.assertEqual(mock_requests.last_request.qs, {'customer_uuid': ['cus_00000000-0000-0000-0000-000000000000'], 'cursor': ['df431387'], 'per_page': ['1']})
+        self.assertEqual(mock_requests.last_request.text, None)
+        self.assertEqual(sorted(dir(tasks)), sorted(dir(expected)))
+        self.assertTrue(isinstance(tasks.entries[0], Task))
+        self.assertEqual(tasks.cursor, "cursor==")
+        self.assertFalse(tasks.has_more)
+
+    @requests_mock.mock()
+    def test_createTask(self, mock_requests):
+        mock_requests.register_uri(
+            "POST",
+            "https://api.chartmogul.com/v1/tasks",
+            status_code=200,
+            json=task,
+        )
+
+        config = Config("token")
+        expected = Customer.createTask(
+            config, uuid="cus_00000000-0000-0000-0000-000000000000", data=createTask
+        ).get()
+
+        self.assertEqual(mock_requests.call_count, 1, "expected call")
+        self.assertEqual(mock_requests.last_request.qs, {})
+        self.assertEqual(mock_requests.last_request.json(), createTask)
+        self.assertTrue(isinstance(expected, Task))