diff --git a/src/pipedream/accounts/client.py b/src/pipedream/accounts/client.py index b0f86bf..854b919 100644 --- a/src/pipedream/accounts/client.py +++ b/src/pipedream/accounts/client.py @@ -40,6 +40,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Account]: """ + Retrieve all connected accounts for the project with optional filtering + Parameters ---------- app_id : typing.Optional[str] @@ -111,6 +113,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Account: """ + Connect a new account for an external user in the project + Parameters ---------- app_slug : str @@ -177,6 +181,8 @@ def retrieve( request_options: typing.Optional[RequestOptions] = None, ) -> Account: """ + Get the details for a specific connected account + Parameters ---------- account_id : str @@ -213,6 +219,8 @@ def retrieve( def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + Remove a connected account and its associated credentials + Parameters ---------- account_id : str @@ -243,6 +251,8 @@ def delete(self, account_id: str, *, request_options: typing.Optional[RequestOpt def delete_by_app(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + Remove all connected accounts for a specific app + Parameters ---------- app_id : str @@ -300,6 +310,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Account]: """ + Retrieve all connected accounts for the project with optional filtering + Parameters ---------- app_id : typing.Optional[str] @@ -380,6 +392,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Account: """ + Connect a new account for an external user in the project + Parameters ---------- app_slug : str @@ -454,6 +468,8 @@ async def retrieve( request_options: typing.Optional[RequestOptions] = None, ) -> Account: """ + Get the details for a specific connected account + Parameters ---------- account_id : str @@ -498,6 +514,8 @@ async def main() -> None: async def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + Remove a connected account and its associated credentials + Parameters ---------- account_id : str @@ -536,6 +554,8 @@ async def main() -> None: async def delete_by_app(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ + Remove all connected accounts for a specific app + Parameters ---------- app_id : str diff --git a/src/pipedream/accounts/raw_client.py b/src/pipedream/accounts/raw_client.py index 2767afd..bc012a9 100644 --- a/src/pipedream/accounts/raw_client.py +++ b/src/pipedream/accounts/raw_client.py @@ -34,6 +34,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Account]: """ + Retrieve all connected accounts for the project with optional filtering + Parameters ---------- app_id : typing.Optional[str] @@ -124,6 +126,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Account]: """ + Connect a new account for an external user in the project + Parameters ---------- app_slug : str @@ -197,6 +201,8 @@ def retrieve( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[Account]: """ + Get the details for a specific connected account + Parameters ---------- account_id : str @@ -237,6 +243,8 @@ def retrieve( def delete(self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: """ + Remove a connected account and its associated credentials + Parameters ---------- account_id : str @@ -265,6 +273,8 @@ def delete_by_app( self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[None]: """ + Remove all connected accounts for a specific app + Parameters ---------- app_id : str @@ -307,6 +317,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Account]: """ + Retrieve all connected accounts for the project with optional filtering + Parameters ---------- app_id : typing.Optional[str] @@ -400,6 +412,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Account]: """ + Connect a new account for an external user in the project + Parameters ---------- app_slug : str @@ -473,6 +487,8 @@ async def retrieve( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[Account]: """ + Get the details for a specific connected account + Parameters ---------- account_id : str @@ -515,6 +531,8 @@ async def delete( self, account_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ + Remove a connected account and its associated credentials + Parameters ---------- account_id : str @@ -543,6 +561,8 @@ async def delete_by_app( self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ + Remove all connected accounts for a specific app + Parameters ---------- app_id : str diff --git a/src/pipedream/actions/client.py b/src/pipedream/actions/client.py index 0ae8ede..20db8b9 100644 --- a/src/pipedream/actions/client.py +++ b/src/pipedream/actions/client.py @@ -42,6 +42,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available actions with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -90,6 +92,8 @@ def list( def retrieve(self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Component: """ + Get detailed configuration for a specific action by its key + Parameters ---------- component_id : str @@ -135,6 +139,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a action + Parameters ---------- id : str @@ -213,6 +219,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -274,6 +282,8 @@ def run( request_options: typing.Optional[RequestOptions] = None, ) -> RunActionResponse: """ + Execute an action with the provided configuration and return results + Parameters ---------- id : str @@ -350,6 +360,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available actions with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -409,6 +421,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Component: """ + Get detailed configuration for a specific action by its key + Parameters ---------- component_id : str @@ -462,6 +476,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a action + Parameters ---------- id : str @@ -548,6 +564,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -617,6 +635,8 @@ async def run( request_options: typing.Optional[RequestOptions] = None, ) -> RunActionResponse: """ + Execute an action with the provided configuration and return results + Parameters ---------- id : str diff --git a/src/pipedream/actions/raw_client.py b/src/pipedream/actions/raw_client.py index e1ac042..5efb6a8 100644 --- a/src/pipedream/actions/raw_client.py +++ b/src/pipedream/actions/raw_client.py @@ -38,6 +38,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available actions with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -110,6 +112,8 @@ def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[Component]: """ + Get detailed configuration for a specific action by its key + Parameters ---------- component_id : str @@ -159,6 +163,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a action + Parameters ---------- id : str @@ -242,6 +248,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -309,6 +317,8 @@ def run( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[RunActionResponse]: """ + Execute an action with the provided configuration and return results + Parameters ---------- id : str @@ -382,6 +392,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available actions with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -457,6 +469,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Component]: """ + Get detailed configuration for a specific action by its key + Parameters ---------- component_id : str @@ -506,6 +520,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a action + Parameters ---------- id : str @@ -589,6 +605,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -656,6 +674,8 @@ async def run( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[RunActionResponse]: """ + Execute an action with the provided configuration and return results + Parameters ---------- id : str diff --git a/src/pipedream/app_categories/client.py b/src/pipedream/app_categories/client.py index ba55a1b..93cebd8 100644 --- a/src/pipedream/app_categories/client.py +++ b/src/pipedream/app_categories/client.py @@ -26,6 +26,8 @@ def with_raw_response(self) -> RawAppCategoriesClient: def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListAppCategoriesResponse: """ + Retrieve all available categories for integrated apps + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -53,6 +55,8 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Li def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppCategoryResponse: """ + Get details of a specific app category by its ID + Parameters ---------- id : str @@ -101,6 +105,8 @@ def with_raw_response(self) -> AsyncRawAppCategoriesClient: async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ListAppCategoriesResponse: """ + Retrieve all available categories for integrated apps + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -138,6 +144,8 @@ async def retrieve( self, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> GetAppCategoryResponse: """ + Get details of a specific app category by its ID + Parameters ---------- id : str diff --git a/src/pipedream/app_categories/raw_client.py b/src/pipedream/app_categories/raw_client.py index 28fdbdb..09499bd 100644 --- a/src/pipedream/app_categories/raw_client.py +++ b/src/pipedream/app_categories/raw_client.py @@ -21,6 +21,8 @@ def list( self, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[ListAppCategoriesResponse]: """ + Retrieve all available categories for integrated apps + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -55,6 +57,8 @@ def retrieve( self, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[GetAppCategoryResponse]: """ + Get details of a specific app category by its ID + Parameters ---------- id : str @@ -97,6 +101,8 @@ async def list( self, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[ListAppCategoriesResponse]: """ + Retrieve all available categories for integrated apps + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -131,6 +137,8 @@ async def retrieve( self, id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[GetAppCategoryResponse]: """ + Get details of a specific app category by its ID + Parameters ---------- id : str diff --git a/src/pipedream/apps/client.py b/src/pipedream/apps/client.py index 30d994c..5d44a36 100644 --- a/src/pipedream/apps/client.py +++ b/src/pipedream/apps/client.py @@ -40,6 +40,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[App]: """ + Retrieve all available apps with optional filtering and sorting + Parameters ---------- after : typing.Optional[str] @@ -101,6 +103,8 @@ def list( def retrieve(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppResponse: """ + Get detailed information about a specific app by ID or name slug + Parameters ---------- app_id : str @@ -160,6 +164,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[App]: """ + Retrieve all available apps with optional filtering and sorting + Parameters ---------- after : typing.Optional[str] @@ -230,6 +236,8 @@ async def main() -> None: async def retrieve(self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAppResponse: """ + Get detailed information about a specific app by ID or name slug + Parameters ---------- app_id : str diff --git a/src/pipedream/apps/raw_client.py b/src/pipedream/apps/raw_client.py index d850825..3bf84a7 100644 --- a/src/pipedream/apps/raw_client.py +++ b/src/pipedream/apps/raw_client.py @@ -34,6 +34,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[App]: """ + Retrieve all available apps with optional filtering and sorting + Parameters ---------- after : typing.Optional[str] @@ -116,6 +118,8 @@ def retrieve( self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[GetAppResponse]: """ + Get detailed information about a specific app by ID or name slug + Parameters ---------- app_id : str @@ -167,6 +171,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[App]: """ + Retrieve all available apps with optional filtering and sorting + Parameters ---------- after : typing.Optional[str] @@ -252,6 +258,8 @@ async def retrieve( self, app_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[GetAppResponse]: """ + Get detailed information about a specific app by ID or name slug + Parameters ---------- app_id : str diff --git a/src/pipedream/client.py b/src/pipedream/client.py index 24d3539..05f4186 100644 --- a/src/pipedream/client.py +++ b/src/pipedream/client.py @@ -4,7 +4,7 @@ import typing import httpx -from .types.project_environment import ProjectEnvironment +from ._.types.project_environment import ProjectEnvironment from .accounts.client import AccountsClient, AsyncAccountsClient from .actions.client import ActionsClient, AsyncActionsClient from .app_categories.client import AppCategoriesClient, AsyncAppCategoriesClient diff --git a/src/pipedream/components/client.py b/src/pipedream/components/client.py index d2cb872..24f78d8 100644 --- a/src/pipedream/components/client.py +++ b/src/pipedream/components/client.py @@ -40,6 +40,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available components with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -88,6 +90,8 @@ def list( def retrieve(self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Component: """ + Get detailed configuration for a specific component by its key + Parameters ---------- component_id : str @@ -133,6 +137,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a component + Parameters ---------- id : str @@ -211,6 +217,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -288,6 +296,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available components with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -347,6 +357,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Component: """ + Get detailed configuration for a specific component by its key + Parameters ---------- component_id : str @@ -400,6 +412,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a component + Parameters ---------- id : str @@ -486,6 +500,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str diff --git a/src/pipedream/components/raw_client.py b/src/pipedream/components/raw_client.py index 99d2ff0..e64f04d 100644 --- a/src/pipedream/components/raw_client.py +++ b/src/pipedream/components/raw_client.py @@ -35,6 +35,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available components with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -107,6 +109,8 @@ def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[Component]: """ + Get detailed configuration for a specific component by its key + Parameters ---------- component_id : str @@ -156,6 +160,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a component + Parameters ---------- id : str @@ -239,6 +245,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -311,6 +319,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available components with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -386,6 +396,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Component]: """ + Get detailed configuration for a specific component by its key + Parameters ---------- component_id : str @@ -435,6 +447,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a component + Parameters ---------- id : str @@ -518,6 +532,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str diff --git a/src/pipedream/core/client_wrapper.py b/src/pipedream/core/client_wrapper.py index 6a68ab4..ca0abd5 100644 --- a/src/pipedream/core/client_wrapper.py +++ b/src/pipedream/core/client_wrapper.py @@ -3,7 +3,7 @@ import typing import httpx -from ..types.project_environment import ProjectEnvironment +from .._.types.project_environment import ProjectEnvironment from .http_client import AsyncHttpClient, HttpClient diff --git a/src/pipedream/deployed_triggers/client.py b/src/pipedream/deployed_triggers/client.py index dd6c23f..f2f5a7d 100644 --- a/src/pipedream/deployed_triggers/client.py +++ b/src/pipedream/deployed_triggers/client.py @@ -40,6 +40,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[DeployedComponent]: """ + Retrieve all deployed triggers for a specific external user + Parameters ---------- external_user_id : str @@ -89,6 +91,8 @@ def retrieve( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> DeployedComponent: """ + Get details of a specific deployed trigger by its ID + Parameters ---------- trigger_id : str @@ -135,6 +139,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> DeployedComponent: """ + Modify the configuration of a deployed trigger, including active status + Parameters ---------- trigger_id : str @@ -193,6 +199,8 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + Remove a deployed trigger and stop receiving events + Parameters ---------- trigger_id : str @@ -242,6 +250,8 @@ def list_events( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[EmittedEvent]: """ + Retrieve recent events emitted by a deployed trigger + Parameters ---------- trigger_id : str @@ -284,6 +294,8 @@ def list_workflows( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> GetTriggerWorkflowsResponse: """ + Get workflows connected to receive events from this trigger + Parameters ---------- trigger_id : str @@ -328,6 +340,8 @@ def update_workflows( request_options: typing.Optional[RequestOptions] = None, ) -> GetTriggerWorkflowsResponse: """ + Connect or disconnect workflows to receive trigger events + Parameters ---------- trigger_id : str @@ -371,6 +385,8 @@ def list_webhooks( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> GetTriggerWebhooksResponse: """ + Get webhook URLs configured to receive trigger events + Parameters ---------- trigger_id : str @@ -415,6 +431,8 @@ def update_webhooks( request_options: typing.Optional[RequestOptions] = None, ) -> GetTriggerWebhooksResponse: """ + Configure webhook URLs to receive trigger events + Parameters ---------- trigger_id : str @@ -480,6 +498,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[DeployedComponent]: """ + Retrieve all deployed triggers for a specific external user + Parameters ---------- external_user_id : str @@ -538,6 +558,8 @@ async def retrieve( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> DeployedComponent: """ + Get details of a specific deployed trigger by its ID + Parameters ---------- trigger_id : str @@ -592,6 +614,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> DeployedComponent: """ + Modify the configuration of a deployed trigger, including active status + Parameters ---------- trigger_id : str @@ -658,6 +682,8 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ + Remove a deployed trigger and stop receiving events + Parameters ---------- trigger_id : str @@ -715,6 +741,8 @@ async def list_events( request_options: typing.Optional[RequestOptions] = None, ) -> typing.List[EmittedEvent]: """ + Retrieve recent events emitted by a deployed trigger + Parameters ---------- trigger_id : str @@ -765,6 +793,8 @@ async def list_workflows( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> GetTriggerWorkflowsResponse: """ + Get workflows connected to receive events from this trigger + Parameters ---------- trigger_id : str @@ -817,6 +847,8 @@ async def update_workflows( request_options: typing.Optional[RequestOptions] = None, ) -> GetTriggerWorkflowsResponse: """ + Connect or disconnect workflows to receive trigger events + Parameters ---------- trigger_id : str @@ -868,6 +900,8 @@ async def list_webhooks( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> GetTriggerWebhooksResponse: """ + Get webhook URLs configured to receive trigger events + Parameters ---------- trigger_id : str @@ -920,6 +954,8 @@ async def update_webhooks( request_options: typing.Optional[RequestOptions] = None, ) -> GetTriggerWebhooksResponse: """ + Configure webhook URLs to receive trigger events + Parameters ---------- trigger_id : str diff --git a/src/pipedream/deployed_triggers/raw_client.py b/src/pipedream/deployed_triggers/raw_client.py index 9f4e96d..d1ef703 100644 --- a/src/pipedream/deployed_triggers/raw_client.py +++ b/src/pipedream/deployed_triggers/raw_client.py @@ -36,6 +36,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[DeployedComponent]: """ + Retrieve all deployed triggers for a specific external user + Parameters ---------- external_user_id : str @@ -103,6 +105,8 @@ def retrieve( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[DeployedComponent]: """ + Get details of a specific deployed trigger by its ID + Parameters ---------- trigger_id : str @@ -153,6 +157,8 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[DeployedComponent]: """ + Modify the configuration of a deployed trigger, including active status + Parameters ---------- trigger_id : str @@ -219,6 +225,8 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[None]: """ + Remove a deployed trigger and stop receiving events + Parameters ---------- trigger_id : str @@ -262,6 +270,8 @@ def list_events( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.List[EmittedEvent]]: """ + Retrieve recent events emitted by a deployed trigger + Parameters ---------- trigger_id : str @@ -309,6 +319,8 @@ def list_workflows( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[GetTriggerWorkflowsResponse]: """ + Get workflows connected to receive events from this trigger + Parameters ---------- trigger_id : str @@ -356,6 +368,8 @@ def update_workflows( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[GetTriggerWorkflowsResponse]: """ + Connect or disconnect workflows to receive trigger events + Parameters ---------- trigger_id : str @@ -408,6 +422,8 @@ def list_webhooks( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[GetTriggerWebhooksResponse]: """ + Get webhook URLs configured to receive trigger events + Parameters ---------- trigger_id : str @@ -455,6 +471,8 @@ def update_webhooks( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[GetTriggerWebhooksResponse]: """ + Configure webhook URLs to receive trigger events + Parameters ---------- trigger_id : str @@ -518,6 +536,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[DeployedComponent]: """ + Retrieve all deployed triggers for a specific external user + Parameters ---------- external_user_id : str @@ -588,6 +608,8 @@ async def retrieve( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[DeployedComponent]: """ + Get details of a specific deployed trigger by its ID + Parameters ---------- trigger_id : str @@ -638,6 +660,8 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[DeployedComponent]: """ + Modify the configuration of a deployed trigger, including active status + Parameters ---------- trigger_id : str @@ -704,6 +728,8 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[None]: """ + Remove a deployed trigger and stop receiving events + Parameters ---------- trigger_id : str @@ -747,6 +773,8 @@ async def list_events( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.List[EmittedEvent]]: """ + Retrieve recent events emitted by a deployed trigger + Parameters ---------- trigger_id : str @@ -794,6 +822,8 @@ async def list_workflows( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[GetTriggerWorkflowsResponse]: """ + Get workflows connected to receive events from this trigger + Parameters ---------- trigger_id : str @@ -841,6 +871,8 @@ async def update_workflows( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[GetTriggerWorkflowsResponse]: """ + Connect or disconnect workflows to receive trigger events + Parameters ---------- trigger_id : str @@ -893,6 +925,8 @@ async def list_webhooks( self, trigger_id: str, *, external_user_id: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[GetTriggerWebhooksResponse]: """ + Get webhook URLs configured to receive trigger events + Parameters ---------- trigger_id : str @@ -940,6 +974,8 @@ async def update_webhooks( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[GetTriggerWebhooksResponse]: """ + Configure webhook URLs to receive trigger events + Parameters ---------- trigger_id : str diff --git a/src/pipedream/oauth_tokens/client.py b/src/pipedream/oauth_tokens/client.py index 19a4a39..18a5de5 100644 --- a/src/pipedream/oauth_tokens/client.py +++ b/src/pipedream/oauth_tokens/client.py @@ -30,6 +30,8 @@ def create( self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None ) -> CreateOAuthTokenResponse: """ + Exchange OAuth credentials for an access token + Parameters ---------- client_id : str @@ -84,6 +86,8 @@ async def create( self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None ) -> CreateOAuthTokenResponse: """ + Exchange OAuth credentials for an access token + Parameters ---------- client_id : str diff --git a/src/pipedream/oauth_tokens/raw_client.py b/src/pipedream/oauth_tokens/raw_client.py index 7ce3d55..8fc2cb4 100644 --- a/src/pipedream/oauth_tokens/raw_client.py +++ b/src/pipedream/oauth_tokens/raw_client.py @@ -22,6 +22,8 @@ def create( self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[CreateOAuthTokenResponse]: """ + Exchange OAuth credentials for an access token + Parameters ---------- client_id : str @@ -74,6 +76,8 @@ async def create( self, *, client_id: str, client_secret: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[CreateOAuthTokenResponse]: """ + Exchange OAuth credentials for an access token + Parameters ---------- client_id : str diff --git a/src/pipedream/projects/client.py b/src/pipedream/projects/client.py index 8ea3273..e8ec738 100644 --- a/src/pipedream/projects/client.py +++ b/src/pipedream/projects/client.py @@ -25,6 +25,8 @@ def with_raw_response(self) -> RawProjectsClient: def retrieve_info(self, *, request_options: typing.Optional[RequestOptions] = None) -> ProjectInfoResponse: """ + Retrieve project configuration and environment details + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -68,6 +70,8 @@ def with_raw_response(self) -> AsyncRawProjectsClient: async def retrieve_info(self, *, request_options: typing.Optional[RequestOptions] = None) -> ProjectInfoResponse: """ + Retrieve project configuration and environment details + Parameters ---------- request_options : typing.Optional[RequestOptions] diff --git a/src/pipedream/projects/raw_client.py b/src/pipedream/projects/raw_client.py index 8d251b2..3af4a43 100644 --- a/src/pipedream/projects/raw_client.py +++ b/src/pipedream/projects/raw_client.py @@ -20,6 +20,8 @@ def retrieve_info( self, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[ProjectInfoResponse]: """ + Retrieve project configuration and environment details + Parameters ---------- request_options : typing.Optional[RequestOptions] @@ -59,6 +61,8 @@ async def retrieve_info( self, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[ProjectInfoResponse]: """ + Retrieve project configuration and environment details + Parameters ---------- request_options : typing.Optional[RequestOptions] diff --git a/src/pipedream/proxy/raw_client.py b/src/pipedream/proxy/raw_client.py index d82bdae..00ba213 100644 --- a/src/pipedream/proxy/raw_client.py +++ b/src/pipedream/proxy/raw_client.py @@ -28,6 +28,8 @@ def get( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ProxyResponse]: """ + Forward an authenticated GET request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -83,6 +85,8 @@ def post( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ProxyResponse]: """ + Forward an authenticated POST request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -145,6 +149,8 @@ def put( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ProxyResponse]: """ + Forward an authenticated PUT request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -206,6 +212,8 @@ def delete( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ProxyResponse]: """ + Forward an authenticated DELETE request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -261,6 +269,8 @@ def patch( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ProxyResponse]: """ + Forward an authenticated PATCH request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -327,6 +337,8 @@ async def get( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ProxyResponse]: """ + Forward an authenticated GET request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -382,6 +394,8 @@ async def post( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ProxyResponse]: """ + Forward an authenticated POST request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -444,6 +458,8 @@ async def put( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ProxyResponse]: """ + Forward an authenticated PUT request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -505,6 +521,8 @@ async def delete( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ProxyResponse]: """ + Forward an authenticated DELETE request to an external API using an external user's account credentials + Parameters ---------- url_64 : str @@ -560,6 +578,8 @@ async def patch( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ProxyResponse]: """ + Forward an authenticated PATCH request to an external API using an external user's account credentials + Parameters ---------- url_64 : str diff --git a/src/pipedream/tokens/client.py b/src/pipedream/tokens/client.py index ef22604..cbe1c64 100644 --- a/src/pipedream/tokens/client.py +++ b/src/pipedream/tokens/client.py @@ -39,6 +39,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> CreateTokenResponse: """ + Generate a Connect token to use for client-side authentication + Parameters ---------- external_user_id : str @@ -97,6 +99,8 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> ValidateTokenResponse: """ + Confirm the validity of a Connect token + Parameters ---------- ctok : ConnectToken @@ -162,6 +166,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> CreateTokenResponse: """ + Generate a Connect token to use for client-side authentication + Parameters ---------- external_user_id : str @@ -228,6 +234,8 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> ValidateTokenResponse: """ + Confirm the validity of a Connect token + Parameters ---------- ctok : ConnectToken diff --git a/src/pipedream/tokens/raw_client.py b/src/pipedream/tokens/raw_client.py index b18b66d..1ea55e9 100644 --- a/src/pipedream/tokens/raw_client.py +++ b/src/pipedream/tokens/raw_client.py @@ -32,6 +32,8 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[CreateTokenResponse]: """ + Generate a Connect token to use for client-side authentication + Parameters ---------- external_user_id : str @@ -97,6 +99,8 @@ def validate( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ValidateTokenResponse]: """ + Confirm the validity of a Connect token + Parameters ---------- ctok : ConnectToken @@ -155,6 +159,8 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[CreateTokenResponse]: """ + Generate a Connect token to use for client-side authentication + Parameters ---------- external_user_id : str @@ -220,6 +226,8 @@ async def validate( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ValidateTokenResponse]: """ + Confirm the validity of a Connect token + Parameters ---------- ctok : ConnectToken diff --git a/src/pipedream/triggers/client.py b/src/pipedream/triggers/client.py index 21d61cc..ecefa64 100644 --- a/src/pipedream/triggers/client.py +++ b/src/pipedream/triggers/client.py @@ -41,6 +41,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available triggers with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -89,6 +91,8 @@ def list( def retrieve(self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Component: """ + Get detailed configuration for a specific trigger by its key + Parameters ---------- component_id : str @@ -134,6 +138,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a trigger + Parameters ---------- id : str @@ -212,6 +218,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -273,6 +281,8 @@ def deploy( request_options: typing.Optional[RequestOptions] = None, ) -> DeployedComponent: """ + Deploy a trigger to listen for and emit events + Parameters ---------- id : str @@ -350,6 +360,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available triggers with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -409,6 +421,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Component: """ + Get detailed configuration for a specific trigger by its key + Parameters ---------- component_id : str @@ -462,6 +476,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> ConfigurePropResponse: """ + Retrieve remote options for a given prop for a trigger + Parameters ---------- id : str @@ -548,6 +564,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> ReloadPropsResponse: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -617,6 +635,8 @@ async def deploy( request_options: typing.Optional[RequestOptions] = None, ) -> DeployedComponent: """ + Deploy a trigger to listen for and emit events + Parameters ---------- id : str diff --git a/src/pipedream/triggers/raw_client.py b/src/pipedream/triggers/raw_client.py index a946288..a83eb6f 100644 --- a/src/pipedream/triggers/raw_client.py +++ b/src/pipedream/triggers/raw_client.py @@ -37,6 +37,8 @@ def list( request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Component]: """ + Retrieve available triggers with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -109,6 +111,8 @@ def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[Component]: """ + Get detailed configuration for a specific trigger by its key + Parameters ---------- component_id : str @@ -158,6 +162,8 @@ def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a trigger + Parameters ---------- id : str @@ -241,6 +247,8 @@ def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -308,6 +316,8 @@ def deploy( request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[DeployedComponent]: """ + Deploy a trigger to listen for and emit events + Parameters ---------- id : str @@ -381,6 +391,8 @@ async def list( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Component]: """ + Retrieve available triggers with optional search and app filtering + Parameters ---------- after : typing.Optional[str] @@ -456,6 +468,8 @@ async def retrieve( self, component_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[Component]: """ + Get detailed configuration for a specific trigger by its key + Parameters ---------- component_id : str @@ -505,6 +519,8 @@ async def configure_prop( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ConfigurePropResponse]: """ + Retrieve remote options for a given prop for a trigger + Parameters ---------- id : str @@ -588,6 +604,8 @@ async def reload_props( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[ReloadPropsResponse]: """ + Reload the prop definition based on the currently configured props + Parameters ---------- id : str @@ -655,6 +673,8 @@ async def deploy( request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[DeployedComponent]: """ + Deploy a trigger to listen for and emit events + Parameters ---------- id : str diff --git a/src/pipedream/users/client.py b/src/pipedream/users/client.py index e3862a5..b597a38 100644 --- a/src/pipedream/users/client.py +++ b/src/pipedream/users/client.py @@ -26,6 +26,8 @@ def delete_external_user( self, external_user_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + Remove an external user and all their associated accounts and resources + Parameters ---------- external_user_id : str @@ -74,6 +76,8 @@ async def delete_external_user( self, external_user_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ + Remove an external user and all their associated accounts and resources + Parameters ---------- external_user_id : str diff --git a/src/pipedream/users/raw_client.py b/src/pipedream/users/raw_client.py index fa715eb..9f09157 100644 --- a/src/pipedream/users/raw_client.py +++ b/src/pipedream/users/raw_client.py @@ -18,6 +18,8 @@ def delete_external_user( self, external_user_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[None]: """ + Remove an external user and all their associated accounts and resources + Parameters ---------- external_user_id : str @@ -51,6 +53,8 @@ async def delete_external_user( self, external_user_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ + Remove an external user and all their associated accounts and resources + Parameters ---------- external_user_id : str