Merge pull request #24 from mailerlite/bugfix/no-ref/filtering

Bugfix/no ref/filtering

.gitignore

@@ -91,4 +91,5 @@ ENV/
 
 # Rope project settings
 .ropeproject
-.vscode
+.vscode
+toolset.py

Readme.md

@@ -438,7 +438,7 @@ client = MailerLite.Client({
   'api_key': 'your-api-key'
 })
 
-response = client.automations.list(limit=10, page=1, filter={'status': true, 'name': 'some name', 'group': 123456})
+response = client.automations.list(limit=10, page=1, filter={'enabled': True, 'name': 'some name', 'group': 123456})
 ```
 
 ### Get an automation

mailerlite/sdk/automations.py

@@ -23,7 +23,22 @@ def list(self, **kwargs):
         :rtype: dict
         """
 
-        return self.api_client.request("GET", self.base_api_url).json()
+        available_params = ["filter", "page", "limit"]
+
+        params = locals()
+        query_params = {}
+        for key, val in params["kwargs"].items():
+            if key not in available_params:
+                raise TypeError("Got an unknown argument '%s'" % key)
+
+            if key == "filter":
+                for filter_key, filter_value in val.items():
+                    query_params[f"filter[{filter_key}]"] = filter_value
+            else:
+                query_params[key] = val
+
+        print(query_params)
+        return self.api_client.request("GET", self.base_api_url, query_params).json()
 
     def get(self, automation_id):
         """
@@ -59,7 +74,7 @@ def activity(self, automation_id, **kwargs):
 
             if key == "filter":
                 for filter_key, filter_value in val.items():
-                    query_params[filter_key] = filter_value
+                    query_params[f"filter[{filter_key}]"] = filter_value
             else:
                 query_params[key] = val
 

mailerlite/sdk/campaigns.py

@@ -85,7 +85,7 @@ def list(self, **kwargs):
 
             if key == "filter":
                 for filter_key, filter_value in val.items():
-                    query_params[filter_key] = filter_value
+                    query_params[f"filter[{filter_key}]"] = filter_value
             else:
                 query_params[key] = val
 

mailerlite/sdk/fields.py

@@ -59,7 +59,7 @@ def list(self, **kwargs):
                 raise TypeError("Got an unknown argument '%s'" % key)
             if key == "filter":
                 for filter_key, filter_value in val.items():
-                    query_params[filter_key] = filter_value
+                    query_params[f"filter[{filter_key}]"] = filter_value
             else:
                 query_params[key] = val
 

mailerlite/sdk/forms.py

@@ -29,7 +29,7 @@ def list(self, type, **kwargs):
 
             if key == "filter":
                 for filter_key, filter_value in val.items():
-                    query_params[filter_key] = filter_value
+                    query_params[f"filter[{filter_key}]"] = filter_value
             else:
                 query_params[key] = val
 

pyproject.toml

@@ -2,7 +2,7 @@
 authors = ["MailerLite <tech@mailerlite.com>"]
 description = "The official MailerLite Python SDK"
 name = "mailerlite"
-version = "0.1.5"
+version = "0.1.6"
 
 [tool.poetry.dependencies]
 python = "^3.7"

setup.py

@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-__version__ = "0.1.5"
+__version__ = "0.1.6"
 
 
 def _read_long_description():

tests/automations_test.py

@@ -1,7 +1,6 @@
 import os
 
 import mailerlite as MailerLite
-import pytest
 import vcr
 from dotenv import load_dotenv
 from pytest import fixture
@@ -25,7 +24,7 @@ def automation_keys():
 
 class TestAutomations:
     # Automationd ID used in tests
-    automation_id = 75040845299975641
+    automation_id = 112078014094771336
 
     @classmethod
     def setup_class(self):
@@ -66,7 +65,7 @@ def test_automation_activity_information_should_be_returned_when_valid_automatio
         self,
     ):
         response = self.client.automations.activity(
-            self.automation_id, filter={"filter[status]": "active"}
+            self.automation_id, filter={"status": "active"}
         )
 
         assert isinstance(response, dict)

tests/campaigns_test.py

@@ -79,7 +79,6 @@ def test_given_proper_parameters_when_user_calls_create_then_new_campaign_is_cre
                     "subject": "This is a test campaign",
                     "from_name": "Test Man",
                     "from": "testuser@mailerlite.com",
-                    "content": "Hi there, this is a test campaign!",
                 }
             ],
         }
@@ -108,13 +107,12 @@ def test_given_correct_parameters_when_user_calls_update_then_existing_campaign_
     ):
         params = {
             "name": "New Campaign Name",
-            "language_id": 2,
+            "language_id": 1,
             "emails": [
                 {
-                    "subject": "This is a new test campaign",
+                    "subject": "This is a new test campaign subject",
                     "from_name": "Test Man",
                     "from": "testuser@mailerlite.com",
-                    "content": "Hi there, this is a new test campaign!",
                 }
             ],
         }
@@ -150,7 +148,7 @@ def test_given_correct_campaign_id_when_calling_get_then_campaign_is_returned(
     )
     def test_list_of_all_campaigns_should_be_returned(self, campaign_keys):
         response = self.client.campaigns.list(
-            limit=10, page=1, filter={"filter[status]": "draft"}
+            limit=10, page=1, filter={"status": "draft"}
         )
 
         assert isinstance(response, dict)
@@ -172,7 +170,7 @@ def test_given_correct_campaign_id_and_schedule_parameters_when_calling_schedule
     ):
         params = {
             "delivery": "scheduled",
-            "schedule": {"date": "2022-12-31", "hours": "22", "minutes": "00"},
+            "schedule": {"date": "2024-03-31", "hours": "22", "minutes": "00"},
         }
         response = self.client.campaigns.schedule(int(pytest.entity_id), params)
 
@@ -214,11 +212,11 @@ def test_given_correct_campaign_id_when_calling_delete_then_campaign_is_removed(
     ):
         response = self.client.campaigns.delete(int(pytest.entity_id))
 
-        assert response == True
+        assert response is True
 
         response = self.client.campaigns.delete(121212)
 
-        assert response == False
+        assert response is False
 
     def test_given_incorrect_campaign_id_when_calling_activity_then_type_error_is_returned(
         self,
@@ -232,7 +230,7 @@ def test_given_incorrect_campaign_id_when_calling_activity_then_type_error_is_re
     def test_given_correct_campaign_id_when_calling_activity_then_campaign_activity_information_is_returned(
         self, campaign_activity_keys
     ):
-        response = self.client.campaigns.activity(75037917434611569)
+        response = self.client.campaigns.activity(106527960165516964)
 
         assert isinstance(response, dict)
         assert isinstance(response["data"], list)

tests/vcr_cassettes/automations-activity.yml

@@ -13,22 +13,22 @@ interactions:
       User-Agent:
       - MailerLite-Python-SDK-Client
     method: GET
-    uri: https://connect.mailerlite.com/api/automations/75040845299975641/activity?filter%5Bstatus%5D=active
+    uri: https://connect.mailerlite.com/api/automations/112078014094771336/activity?filter%5Bstatus%5D=active
   response:
     body:
       string: !!binary |
-        H4sIAAAAAAAAA7SRwU7DMAyGX2XyYadoaVHLaBDiDRD3ZUKmuCwiTUriVENV3x11W1UQV3azZP/+
-        P/8e4A0ZQe32AqxxHxHUAI0JkUHBgbmLSksta+8c1bxp0VgK1jBtat9qiZ3REhP7Ftl4F7XcllmR
-        3RXlTVVV2/K2yLXEmk1v+Ouxw3d6yEGAxevu7wL1oFyyVoCjI5/rUUBL07ED1CkEcvwyKUDlAprg
-        21kx0S2dSyq7AVKwy8grWVCwtviZ/P3qOVBvfIog4ERDoBq0kUZxkV0zyzNK/sObQ1qsfxM/0ZFX
-        63DC/kO7F9AhH/4fd/oJhTnUTAD7GYw9owWVjeM3AAAA//8DAMXKwiCMAgAA
+        H4sIAAAAAAAAA7SRwU7DMBBEf6XaQ09WHdNCwAjxB4h7XaElbFoLxw72OiqK8u8obaqAOPe20u5o
+        3s708IGMoLc7Ac76zwS6h9rGxKDhwNwmbaSRVfCeKl41aB1FZ5lWVWiMxNYaiZlDg2yDT0YqdVOU
+        94XaFA+bslTr9Z2RWLHtLH8/t7inJwUCHF7ZoI3UgfbZOQGejnyeBwENje/2UOUYyfPbqACtBNQx
+        NBfFiDdvply2PeTo5pN3cqBh6fArh8fFa6TOhpxAwImGQNfoEg1ikl01zTOL+mXOMc/ef5Ff6MiL
+        ZTxx/8PdCWiRD1fgHVuhOMV6WwjgcCHjwOhAF8PwAwAA//8DAHDbHFqQAgAA
     headers:
       Access-Control-Allow-Origin:
       - '*'
       CF-Cache-Status:
       - DYNAMIC
       CF-RAY:
-      - 77d158d2d9e6789f-VIE
+      - 84f37bdc2bf22788-PRG
       Cache-Control:
       - no-cache, private
       Connection:
@@ -38,7 +38,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 21 Dec 2022 14:35:54 GMT
+      - Fri, 02 Feb 2024 15:31:55 GMT
       Server:
       - cloudflare
       Strict-Transport-Security:

tests/vcr_cassettes/automations-get.yml

@@ -13,30 +13,39 @@ interactions:
       User-Agent:
       - MailerLite-Python-SDK-Client
     method: GET
-    uri: https://connect.mailerlite.com/api/automations/75040845299975641
+    uri: https://connect.mailerlite.com/api/automations/112078014094771336
   response:
     body:
       string: !!binary |
-        H4sIAAAAAAAAA4xU70/bMBD9V6qT9i0bSZo0JNI0bWNjoMGnsRbWyXKdazF17OAfQIv6v09O0hIE
-        Wvlk+d3du+d3Jz9CSS2F4hF4CQVkaZiEh0ka53mepaMkggAkrRAK+IXGDj47qypquZIQAEo6E1hC
-        YbXDAKzmiwVqsiW0mrIlQaaqCjVDKOZUGAxAY43U+tIddEcF73g2ARiLtYHizzNNWTJMwvgwSw8z
-        CMCuaq+Jsk5KTTVKS3y+dEIEwFRVC7S4FTfTaoly15BppBZLQi0UEIdx/D6K38fhIMqLOC+iBAJw
-        dfmflKF3pm1POjFtAWHOWFWROUdRQgDN2QiDdHvd2Z0+2fuV2xUEsMQVFMDaS0ds8cHCJoCGXtWo
-        2wF0L72jwvmsn/SmZnwBAZRomOZ1mwQXjaxBK2vQ9B9YNZhuC6YAm7+76b3wfZSORnGcDcMseVJk
-        3My3mKEmN4pLQxZauRoCaE6yLY+iJMmHWZgk6XCYbsP9ZXuR0blxthocd5ROCyjg2traFNOD6UFJ
-        zfVMUV1+qCgXqAW3+IGpanrwpMp80k6g+TiObHZS5fdXk9Pr8jhfndwoTsfp/HKcpif8nl/Gubs6
-        FiEd587Hroand+Xky7qJTU4lW52MxqtTyao8Yj/O+M/vhp+vL+7Pfn0Lz4+W6/P15/D86GJ9tr7g
-        k99RPvkdvhse+VnhAxOuRLI1xPv6dweXLd6Bz3bTz2LP8t5TLblcdNXGUmu8p9uqkvSMIEw5aaEI
-        A+ijXJJbhw574ZlykiHR1Pd9hLlQtKuzmssFFBC+8y9jgrMlscpvotyfbrDj9+l9OU7yW9fs8xPc
-        bvTbiBsdrxA+x7vfoNG8l9LJnUfPiXfwG95b06pvur/uLbqmuiTtAPqNe/AbGqu5fYWjB+/j2Pz/
-        XzwskhF4UYbMqJRYEqakbcbbLeato4LP+esbGG02/wAAAP//AwD+W1MzbQYAAA==
+        H4sIAAAAAAAAA+xX227jNhD9FYHYYl+UWLIk2xJQbG/oJsEmL02bTeqAoKWxzIQiFV6seAP/e0FJ
+        lmXH2yTtok99MjyXM4fD4czoCWVEE5Q8IZqhBPn+0BtPPD/04nA89oNghFzESQEoQb/RomTgVMBS
+        UYADBaEMuQg4mTHIUKKlARdpSfMcJN7AaknSewypKAqQKaBkTpgCF0kogWjr2omWhNEWZ90BKZT8
+        uU9uMgkCzxtNLDm9Ki05ZWYqlXQGEt8JyhXOpTAlclH9i2lmcZDveV4cjKLIj31/OB5Nhui2NenH
+        eW7VJeGjNCVxfOQiIxlK0ELrUiXTwXSQEbWYCSKzY5sYkIxqOE5FMR1suakP0jBQ31/5enxaxNXN
+        57NF9jFend4JSq6i+fVVFJ3Sil4PY3PzkXnkKjZWdxOcLbPPP32pdZ/PeLo6HV2tznhaxH56ck4/
+        /aro+eWP1fkv918u7n73zy/vH88vT4OLu3x1yvxs/oefofWti+AxZSYD3M/KVpzhLhW3LppJcQ+8
+        vR3rnApbABo2V71j4KKKSE553norTbSyBbDxynAvDzgVhmuUeC7qSynHDwYM9NQzYXgKWBIb9wnN
+        mSCtn5aU5yhB3ndo7aKU0fQea4FFCfxlcwUtvjXv0zGcPhjAO2JuGGssX8njAOCuvEFsOL8IaXiX
+        o13gTvyK85ak6Cfd/n3RaUFkhpsL6AfuiV8RWMz1AYye+GWMuZCVjfmKYCklDFOuQZJUU7F/h88N
+        XgK1VyqB2Pq1ajT0huGRNzzyho4fJtEkCQNkU6LwjHAOGU4F13Vxtc/iwRBG5/Rw/fs2GpSHmlzs
+        Df1xGAe9JrdpuSWRwDW29s2x2uZ0tdealZndQaoPaOZSFChBNBfyh9121SpxC3nYQkLJVliLrxrU
+        cfBe146D8WQUhuON/vnU6ZuQtM5RAzIJIt/b+Nmhgb8+rrY2bdqI0aIgdTVsczkzlGUg/4NcvPly
+        SkYoxxoerfIEGBPulE/5tTDOgizBkZACXULmEIdDpRhoDdKxTJ2nd23a1sfW5URUsATpOithZIPv
+        2JdXEQlOSvh77WRUlYysnJPL80+NhTp2bKiUcGdJoXL0AvpxZiun7luU584CJCQ20NM7I9n6iVF+
+        f0SzpLkX35uEnhdF/iQerq1Ve4r3cnMGi6EXVO3gQ0qMAku5Oa5aiIo79ZMFpR3Kd095IXSntDnh
+        q0JI+OD8bEnWDB0tnF6zTGq62/8HaAfxOPRG/ihY24tKJQBXC6Hx/sxXWkiSw3EuRM6AlFQ1E39b
+        A0dbb3VUSpFNB1vJdNAkfDp4/gKmA384CR/HwWjbcY78KPG8xA+PS57bQpFgb+gZrVbeX0So6MTT
+        Qf2a/i44erHphXYDKrPDJlHiDRPfolCFM1A059sFkRGeG5I3LzisTSrKOciuY3arw5uGtPdtJ7T3
+        /3h+43ju+3+Lie39k3H9xkWw2QQzTObaFmAzTZtPlrq4NkVrFCisjFzCqivTWvZg6JdOUkpYALFT
+        JUGWyn6p7y/Q/+aNhUkUJ5HdPQ7QbfoRJpywlaap2jkZ5TmuiMIZVe2XW0s/A1uupU2z/dwDnjnT
+        3eE0Rd2QsmO022LWt+v1XwAAAP//AwAaeo+tSg4AAA==
     headers:
       Access-Control-Allow-Origin:
       - '*'
       CF-Cache-Status:
       - DYNAMIC
       CF-RAY:
-      - 77d158d0ee0dc27d-VIE
+      - 84f37bd96aad4114-PRG
       Cache-Control:
       - no-cache, private
       Connection:
@@ -46,7 +55,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 21 Dec 2022 14:35:54 GMT
+      - Fri, 02 Feb 2024 15:31:54 GMT
       Server:
       - cloudflare
       Strict-Transport-Security:

tests/vcr_cassettes/automations-list.yml

@@ -17,30 +17,38 @@ interactions:
   response:
     body:
       string: !!binary |
-        H4sIAAAAAAAAA6RWbU/bSBD+K9FI7Se32I6dYJ+qqnfc9UAF3YdSKA1abdaTZMl61+xLIIny30/r
-        l2AOVFDvU+zZmWeefWY8ky0U1FLIf2yBF5DDOA2T8DBJ4yzLxukoiSAASUuEHL6isYNPzqqSWq4k
-        BICSTgUWkFvtMACr+XyOmjSIW7CasiVBpsoSNUPIZ1QYDEBjhdT60L1pRQVvcXYBGIuV+S+ncTJM
-        wvhwnB6OIQC7rjwnyloqFdUoLfH+0gkRAFNlJdBiR26q1RLlPiHTSC0WhFrIIQ7j+F0Uv4vDQZTl
-        cZZHCQTgquInLkOvTJOetGSaAMKcsaokM46igADq35oYpN2rV2dvaeX9g9s1BLDENeTAmpcW2OK9
-        hV0ANbyqUDcFaG+6osJ5ry/0pmJ8DgEUaJjmVeME5zWtQUNrUOcfWDWYdAETgN31vnpPdB+lo1Ec
-        j4fhOHlgZNzUp5iiJjeKS0PmWrkKAqh/SRceRUmSDcdhkqTDYdod72//nEerxul68LmFdFpADgtr
-        K5NPDiYHBTWLqaK6eF9SLlALbvE9U+Xk4IGV+aidQPPhIrLj4zK7u7o8WRSfs/XxjeL0Ip19v0jT
-        Y37Hv8eZu/osQnqROX92NTxZFZe/b+qzyxPJ1seji/WJZGUWsb9P+Ze/DD/bnN+dfv0zPDtabs42
-        n8Kzo/PN6eacX36Lsstv4Zvhka8V3jPhCiSdIF7X6725aOyt8VFv+lq80Lx3VEsu5x2kl8EQppy0
-        kIe+xbSxpDYTwzSiNAtlSa1j0zLGUmt8GbpEBelp14PqW7kktw4d9o6nykmGRFNPdQszoWgbZzWX
-        c8ghfOPFYIKzJbHKN6982d1gi+/d+3Sc5Leu/gQezM2NXgdc83gG8LG9HSA15xchndxr9Bh4b37F
-        fSta9kX3ry8GLaguSFOAfuKe+RWJ1cw+g9Ezv4Sx+/koPcyTEXhShkyplFgQpqSty9v28q2jgs/4
-        8x0Y+Y9BcLmsm7Xu60ejgCkpkdkng4BWfHJA96vKfKzoHD/4iS3o/4aoNK66JpF+MtfPuwBKbPYe
-        c7peRj4C8iiAmVZl/eCzP5jbi/3YQu/TFHSKft69FfTWqd8G/2hcceVMu21W3c7cBdsnk/FX5Giy
-        RT34Zgk/S+oM7+3gra6ZPSF07bewXfwSIy8r6k6aMACraomsslQ8PBEnZ1xY1P5PR7Tb/QsAAP//
-        AwCxgXtPvggAAA==
+        H4sIAAAAAAAAA+xX62/bNhD/VwSia78osWTLLw1F98KaBE1QYNnShwOCls4yE5pU+LDjGP7fh5Nk
+        WU7cJWmLYR8GGLB9PP7u+OPxHiuSMstI/HlFeEpiEobtoD8IwigYRv1+2On0iE8kmwGJyR98lgvw
+        FiASNQMPZowL4hOQbCwgJbHVDnxiNc8y0LTEXRGrWXJNIVGzGegESDxhwoBPNOTALG6tRXMmeIWz
+        roHMHucGg04nCHoDdM4uc3TOuLFJNB+DpleKS0MzrVxOfFJ8U54iDgmDIBh2et1uOAzDdr83aJPL
+        SqVp56FWTcJb7XLmhcQnTgsSk6m1uYlHrVErZWY6Vkynh0gMaMEtHCZqNmptfTNvtBNgXl+Etn88
+        Gy4+fTiZpm+Hy+MrxdlFd/Lxots95gv+sT10n96KgF0MHa596pzM0w+/3BVrH05ksjzuXSxPZDIb
+        hsnRKX/3u+Gn5z8vTn+7vju7+jM8Pb++PT0/7pxdZctjEaaTv8KUrC99AreJcCnQJitbcUprKi59
+        MtbqGmR1O7g5URgAFjZXvaPgkwXTkstsA4ksGJooJy2JQ59MuDaWFmJqEg0gzVRZep9GY5VmGRxm
+        SmUCWM5NSeKW1IPtbnOQa5WOWlvJqFUaHrW20TLs9Ae9KOqPWmF7EN32O7120I4OgjZ+wm4cBHEY
+        HeYyIz4xllmDcbs5bEob17c5TuCTppRLeuPAQWN5rJxMgGqGdK3IRChW7bOay4zEJPiBrH2SCJ5c
+        U6uoykE+rm6gwkf1pjtO8hsHdEcsnRCl5hP92AO4Ky8RS58fhXSy5mgXuBY/4bw5mzVJx7+Pbpoy
+        ndLyApqGG+InGFYTuwejIX4cY6L0Am0+wVjCmaBcWtAssVzdv8OHCo+B4pVqYBi/uEy2Ee+FUdwd
+        xFGHICWGjpmUkNJESVsEV/WabxwTfML3x3+I1iDfl5uHQTvsR8NOIzdvKkXONEhLUb88VpVTL+5V
+        FOPGV5DYPSsTrWYkJjxT+qfdLFst0gpyv4aGXCypVV9UKLPTvWKzSR+bdWT9yyosKTgqQQadbhhs
+        9mGto1+usludijbmrJqxIhq2XI4dFynof4GLZ19OLhiX1MItLh6BEMofyZH8qJw3ZXPwNCTA55B6
+        zJOwMAKsBe2hp97qRUXb+hC3HKkFzEH73lI5XeJ7+PIWTIOXMPnKeik3uWBL7+j89F2pYQ49NJUw
+        6c05LDw7haad8dIr8haXmTcFDTEaWr1wWqxXgsvrA57G5b2EwSAKgm43HAzba9SqTvFKb86AGHbK
+        zQ4+JMwZQJfL45qpWkiveLJgrMfl7inPlK0XkRO5nCkNb7xf0cnCQ88qr5Es48Ld7f89bneG/Sjo
+        hb3OGi/qP1tjcw14Qw/cquTN/omrWjxqFa/pn4yTR5NehI1bnu5X6cZBOw4RhRuaguGZ3Pa1gsnM
+        sax8wVGhsuBSgq4zZt06PKtIB9+3Qgf/l+dnlufm/u9RsYOvKdfPbATLTjClbGIxAMtqWk5aRXBt
+        gtYZMNQ4PYdlHaaF7Mbxu1qSa5gCw6oSE3Tlfqjf7/u/5Y1FcXcYd7H32ONumY8ok0wsLU/Mzsm4
+        zOiCGZpyUw2clfspYLjmSDNOqSBTb7RbnEakLlJYRusuZn2JYw2m0eLdFhPKTkZKlJSQ2AcTHcv5
+        qNWoz29ylsFrnAoF+2YIzHd1h1RUU/y99skMypE6cbpopHBHOVoVrUBYWt+Kq4N9XpWzaoko2Bgw
+        7b4U7MapH733mF2VM0XrYvl8M46v/dWDEfdr6CithQ34cr7f69QZ3FrvpS48e+DQJXaQdvpVHiGt
+        oDfUBD7BxifEL8tE8YtlmYas0o5XhAmUr9frvwEAAP//AwBozF32IxEAAA==
     headers:
       Access-Control-Allow-Origin:
       - '*'
       CF-Cache-Status:
       - DYNAMIC
       CF-RAY:
-      - 77d158ceaa96c27d-VIE
+      - 84f37bd6fe62b38f-PRG
       Cache-Control:
       - no-cache, private
       Connection:
@@ -50,7 +58,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 21 Dec 2022 14:35:54 GMT
+      - Fri, 02 Feb 2024 15:31:54 GMT
       Server:
       - cloudflare
       Strict-Transport-Security: