Bugfix refactor and improvements (#246)

* Refactor the Proxy interface so that it handles
  any response type (including JSON)
* Fix how the Proxy handles redirects and other
  non-successful status codes by avoiding to parse
  non-JSON payloads
* Improve the Proxy interface so that the query params
  don't have to be manually encoded in the `url` argument,
  by using the existing `params` argument (which was
  previously ignored)
* Add the new `emit_on_deploy` flag as an argument
  to the "deploy trigger" endpoint

---------

Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jay Vercellone <jay@pipedream.com>

Author: fern-api[bot]

.fernignore

@@ -18,6 +18,7 @@ src/pipedream/pipedream.py
 
 # Custom Proxy files
 src/pipedream/proxy/client.py
+src/pipedream/proxy/raw_client.py
 
 # Custom Workflow files
 src/pipedream/workflows/__init__.py

README.md

@@ -5,6 +5,21 @@
 
 The Pipedream Python library provides convenient access to the Pipedream APIs from Python.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
 ## Installation
 
 ```sh
@@ -89,14 +104,7 @@ client = Pipedream(
     client_id="YOUR_CLIENT_ID",
     client_secret="YOUR_CLIENT_SECRET",
 )
-response = client.apps.list(
-    after="after",
-    before="before",
-    limit=1,
-    q="q",
-    sort_key="name",
-    sort_direction="asc",
-)
+response = client.apps.list()
 for item in response:
     yield item
 # alternatively, you can paginate page-by-page

poetry.lock

@@ -3,7 +3,7 @@ name = "pipedream"
 
 [tool.poetry]
 name = "pipedream"
-version = "1.0.11"
+version = "1.0.12"
 description = ""
 readme = "README.md"
 authors = []

pyproject.toml

@@ -82,15 +82,7 @@ def list(
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        response = client.accounts.list(
-            external_user_id="external_user_id",
-            oauth_app_id="oauth_app_id",
-            after="after",
-            before="before",
-            limit=1,
-            app="app",
-            include_credentials=True,
-        )
+        response = client.accounts.list()
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -160,8 +152,6 @@ def create(
             client_secret="YOUR_CLIENT_SECRET",
         )
         client.accounts.create(
-            external_user_id="external_user_id",
-            oauth_app_id="oauth_app_id",
             app_slug="app_slug",
             cfmap_json="cfmap_json",
             connect_token="connect_token",
@@ -215,7 +205,6 @@ def retrieve(
         )
         client.accounts.retrieve(
             account_id="account_id",
-            include_credentials=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -363,15 +352,7 @@ async def list(
 
 
         async def main() -> None:
-            response = await client.accounts.list(
-                external_user_id="external_user_id",
-                oauth_app_id="oauth_app_id",
-                after="after",
-                before="before",
-                limit=1,
-                app="app",
-                include_credentials=True,
-            )
+            response = await client.accounts.list()
             async for item in response:
                 yield item
 
@@ -450,8 +431,6 @@ async def create(
 
         async def main() -> None:
             await client.accounts.create(
-                external_user_id="external_user_id",
-                oauth_app_id="oauth_app_id",
                 app_slug="app_slug",
                 cfmap_json="cfmap_json",
                 connect_token="connect_token",
@@ -513,7 +492,6 @@ async def retrieve(
         async def main() -> None:
             await client.accounts.retrieve(
                 account_id="account_id",
-                include_credentials=True,
             )
 
 

src/pipedream/accounts/client.py

@@ -80,13 +80,7 @@ def list(
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        response = client.actions.list(
-            after="after",
-            before="before",
-            limit=1,
-            q="q",
-            app="app",
-        )
+        response = client.actions.list()
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -431,13 +425,7 @@ async def list(
 
 
         async def main() -> None:
-            response = await client.actions.list(
-                after="after",
-                before="before",
-                limit=1,
-                q="q",
-                app="app",
-            )
+            response = await client.actions.list()
             async for item in response:
                 yield item
 

src/pipedream/actions/client.py

@@ -426,7 +426,7 @@ def run(
                 ),
                 "dynamic_props_id": dynamic_props_id,
                 "stash_id": convert_and_respect_annotation_metadata(
-                    object_=stash_id, annotation=RunActionOptsStashId, direction="write"
+                    object_=stash_id, annotation=typing.Optional[RunActionOptsStashId], direction="write"
                 ),
             },
             headers={
@@ -866,7 +866,7 @@ async def run(
                 ),
                 "dynamic_props_id": dynamic_props_id,
                 "stash_id": convert_and_respect_annotation_metadata(
-                    object_=stash_id, annotation=RunActionOptsStashId, direction="write"
+                    object_=stash_id, annotation=typing.Optional[RunActionOptsStashId], direction="write"
                 ),
             },
             headers={

src/pipedream/actions/raw_client.py

@@ -83,14 +83,7 @@ def list(
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        response = client.apps.list(
-            after="after",
-            before="before",
-            limit=1,
-            q="q",
-            sort_key="name",
-            sort_direction="asc",
-        )
+        response = client.apps.list()
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -219,14 +212,7 @@ async def list(
 
 
         async def main() -> None:
-            response = await client.apps.list(
-                after="after",
-                before="before",
-                limit=1,
-                q="q",
-                sort_key="name",
-                sort_direction="asc",
-            )
+            response = await client.apps.list()
             async for item in response:
                 yield item
 

src/pipedream/apps/client.py

@@ -6,11 +6,11 @@
 import typing
 
 import httpx
-from .types.project_environment import ProjectEnvironment
 from .core.api_error import ApiError
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .core.oauth_token_provider import OAuthTokenProvider
 from .environment import PipedreamEnvironment
+from .types.project_environment import ProjectEnvironment
 
 if typing.TYPE_CHECKING:
     from .accounts.client import AccountsClient, AsyncAccountsClient

src/pipedream/client.py

@@ -83,14 +83,7 @@ def list(
             client_id="YOUR_CLIENT_ID",
             client_secret="YOUR_CLIENT_SECRET",
         )
-        response = client.components.list(
-            after="after",
-            before="before",
-            limit=1,
-            q="q",
-            app="app",
-            component_type="trigger",
-        )
+        response = client.components.list()
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -379,14 +372,7 @@ async def list(
 
 
         async def main() -> None:
-            response = await client.components.list(
-                after="after",
-                before="before",
-                limit=1,
-                q="q",
-                app="app",
-                component_type="trigger",
-            )
+            response = await client.components.list()
             async for item in response:
                 yield item