diff --git a/.fernignore b/.fernignore index 04b4c10..a08c0c9 100644 --- a/.fernignore +++ b/.fernignore @@ -7,7 +7,7 @@ LICENSE # References doc (we have additional use cases) -# reference.md +reference.md # Base client files (temporary) src/main/java/com/pipedream/api/AsyncBaseClientBuilder.java diff --git a/reference.md b/reference.md index 42da24f..04bcf5a 100644 --- a/reference.md +++ b/reference.md @@ -1,9 +1,23 @@ # Reference ## AppCategories -
client.appCategories.list() -> List<AppCategory> +
client.appCategories.list() -> List&lt;AppCategory&gt;
+#### 📝 Description + +
+
+ +
+
+ +Retrieve all available categories for integrated apps +
+
+
+
+ #### 🔌 Usage
@@ -29,6 +43,20 @@ client.appCategories().list();
+#### 📝 Description + +
+
+ +
+
+ +Get details of a specific app category by its ID +
+
+
+
+ #### 🔌 Usage
@@ -54,7 +82,7 @@ client.appCategories().retrieve("id");
**id:** `String` — The ID of the app category to retrieve - +
@@ -66,10 +94,24 @@ client.appCategories().retrieve("id");
## Apps -
client.apps.list() -> ListAppsResponse +
client.apps.list() -> SyncPagingIterable&lt;App&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve all available apps with optional filtering and sorting +
+
+
+
+ #### 🔌 Usage
@@ -82,6 +124,15 @@ client.appCategories().retrieve("id"); client.apps().list( AppsListRequest .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .sortKey(AppsListRequestSortKey.NAME) + .sortDirection(AppsListRequestSortDirection.ASC) + .hasComponents(true) + .hasActions(true) + .hasTriggers(true) .build() ); ``` @@ -99,7 +150,7 @@ client.apps().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -107,7 +158,7 @@ client.apps().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -115,7 +166,7 @@ client.apps().list(
**limit:** `Optional` — The maximum number of results to return - +
@@ -123,7 +174,7 @@ client.apps().list(
**q:** `Optional` — A search query to filter the apps - +
@@ -131,7 +182,7 @@ client.apps().list(
**sortKey:** `Optional` — The key to sort the apps by - +
@@ -139,7 +190,7 @@ client.apps().list(
**sortDirection:** `Optional` — The direction to sort the apps - +
@@ -147,7 +198,31 @@ client.apps().list(
**categoryIds:** `Optional` — Only return apps in these categories - + +
+ + +
+
+ +**hasComponents:** `Optional` — Only return apps that have components (actions or triggers) + +
+
+ +
+
+ +**hasActions:** `Optional` — Only return apps that have actions + +
+
+ +
+
+ +**hasTriggers:** `Optional` — Only return apps that have triggers +
@@ -162,6 +237,20 @@ client.apps().list(
+#### 📝 Description + +
+
+ +
+
+ +Get detailed information about a specific app by ID or name slug +
+
+
+
+ #### 🔌 Usage
@@ -187,7 +276,7 @@ client.apps().retrieve("app_id");
**appId:** `String` — The name slug or ID of the app (e.g., 'slack', 'github') - +
@@ -199,10 +288,24 @@ client.apps().retrieve("app_id");
## Accounts -
client.accounts.list(projectId) -> ListAccountsResponse +
client.accounts.list(projectId) -> SyncPagingIterable&lt;Account&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve all connected accounts for the project with optional filtering +
+
+
+
+ #### 🔌 Usage
@@ -213,9 +316,15 @@ client.apps().retrieve("app_id"); ```java client.accounts().list( - "project_id", AccountsListRequest .builder() + .externalUserId("external_user_id") + .oauthAppId("oauth_app_id") + .after("after") + .before("before") + .limit(1) + .app("app") + .includeCredentials(true) .build() ); ``` @@ -232,56 +341,56 @@ client.accounts().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**appId:** `Optional` — The app slug or ID to filter accounts by. - +**externalUserId:** `Optional` +
-**externalUserId:** `Optional` - +**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable +
-**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable - +**after:** `Optional` — The cursor to start from for pagination +
-**after:** `Optional` — The cursor to start from for pagination - +**before:** `Optional` — The cursor to end before for pagination +
-**before:** `Optional` — The cursor to end before for pagination - +**limit:** `Optional` — The maximum number of results to return +
-**limit:** `Optional` — The maximum number of results to return - +**app:** `Optional` — The app slug or ID to filter accounts by. +
@@ -289,7 +398,7 @@ client.accounts().list(
**includeCredentials:** `Optional` — Whether to retrieve the account's credentials or not - +
@@ -304,6 +413,20 @@ client.accounts().list(
+#### 📝 Description + +
+
+ +
+
+ +Connect a new account for an external user in the project +
+
+
+
+ #### 🔌 Usage
@@ -314,12 +437,13 @@ client.accounts().list( ```java client.accounts().create( - "project_id", CreateAccountOpts .builder() .appSlug("app_slug") .cfmapJson("cfmap_json") .connectToken("connect_token") + .externalUserId("external_user_id") + .oauthAppId("oauth_app_id") .build() ); ``` @@ -336,24 +460,16 @@ client.accounts().create(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
+**projectId:** `String` — The project ID, which starts with `proj_`. -**appId:** `Optional` — The app slug or ID to filter accounts by. -
-**externalUserId:** `Optional` - +**externalUserId:** `Optional` +
@@ -361,7 +477,7 @@ client.accounts().create(
**oauthAppId:** `Optional` — The OAuth app ID to filter by, if applicable - +
@@ -369,7 +485,7 @@ client.accounts().create(
**appSlug:** `String` — The app slug for the account - +
@@ -377,7 +493,7 @@ client.accounts().create(
**cfmapJson:** `String` — JSON string containing the custom fields mapping - +
@@ -385,7 +501,7 @@ client.accounts().create(
**connectToken:** `String` — The connect token for authentication - +
@@ -393,7 +509,7 @@ client.accounts().create(
**name:** `Optional` — Optional name for the account - +
@@ -408,6 +524,20 @@ client.accounts().create(
+#### 📝 Description + +
+
+ +
+
+ +Get the details for a specific connected account +
+
+
+
+ #### 🔌 Usage
@@ -418,10 +548,10 @@ client.accounts().create( ```java client.accounts().retrieve( - "project_id", "account_id", AccountsRetrieveRequest .builder() + .includeCredentials(true) .build() ); ``` @@ -438,16 +568,16 @@ client.accounts().retrieve(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**accountId:** `String` - +**accountId:** `String` +
@@ -455,7 +585,7 @@ client.accounts().retrieve(
**includeCredentials:** `Optional` — Whether to retrieve the account's credentials or not - +
@@ -470,6 +600,20 @@ client.accounts().retrieve(
+#### 📝 Description + +
+
+ +
+
+ +Remove a connected account and its associated credentials +
+
+
+
+ #### 🔌 Usage
@@ -479,7 +623,7 @@ client.accounts().retrieve(
```java -client.accounts().delete("project_id", "account_id"); +client.accounts().delete("account_id"); ```
@@ -494,16 +638,16 @@ client.accounts().delete("project_id", "account_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**accountId:** `String` - +**accountId:** `String` +
@@ -518,6 +662,20 @@ client.accounts().delete("project_id", "account_id");
+#### 📝 Description + +
+
+ +
+
+ +Remove all connected accounts for a specific app +
+
+
+
+ #### 🔌 Usage
@@ -527,7 +685,7 @@ client.accounts().delete("project_id", "account_id");
```java -client.accounts().deleteByApp("project_id", "app_id"); +client.accounts().deleteByApp("app_id"); ```
@@ -542,16 +700,16 @@ client.accounts().deleteByApp("project_id", "app_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**appId:** `String` - +**appId:** `String` +
@@ -567,6 +725,20 @@ client.accounts().deleteByApp("project_id", "app_id");
+#### 📝 Description + +
+
+ +
+
+ +Remove an external user and all their associated accounts and resources +
+
+
+
+ #### 🔌 Usage
@@ -576,7 +748,7 @@ client.accounts().deleteByApp("project_id", "app_id");
```java -client.users().deleteExternalUser("project_id", "external_user_id"); +client.users().deleteExternalUser("external_user_id"); ```
@@ -591,16 +763,16 @@ client.users().deleteExternalUser("project_id", "external_user_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**externalUserId:** `String` - +**externalUserId:** `String` +
@@ -611,11 +783,24 @@ client.users().deleteExternalUser("project_id", "external_user_id");
-## Components -
client.components.list(projectId) -> GetComponentsResponse +
client.users.list(projectId) -> SyncPagingIterable&lt;ExternalUser&gt;
+#### 📝 Description + +
+
+ +
+
+ +Retrieve all external users for the project +
+
+
+
+ #### 🔌 Usage
@@ -625,10 +810,13 @@ client.users().deleteExternalUser("project_id", "external_user_id");
```java -client.components().list( - "project_id", - ComponentsListRequest +client.users().list( + UsersListRequest .builder() + .after("after") + .before("before") + .limit(1) + .q("q") .build() ); ``` @@ -645,8 +833,8 @@ client.components().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
@@ -654,7 +842,7 @@ client.components().list(
**after:** `Optional` — The cursor to start from for pagination - +
@@ -662,7 +850,7 @@ client.components().list(
**before:** `Optional` — The cursor to end before for pagination - +
@@ -670,23 +858,15 @@ client.components().list(
**limit:** `Optional` — The maximum number of results to return - -
- -
-
- -**q:** `Optional` — A search query to filter the components -
-**app:** `Optional` — The ID or name slug of the app to filter the components - +**q:** `Optional` — Filter users by external_id (partial match) +
@@ -697,10 +877,25 @@ client.components().list(
-
client.components.retrieve(projectId, componentId) -> GetComponentResponse +## Components +
client.components.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description +
+
+
+ +Retrieve available components with optional search and app filtering +
+
+
+
+ #### 🔌 Usage
@@ -710,7 +905,18 @@ client.components().list(
```java -client.components().retrieve("project_id", "component_id"); +client.components().list( + ComponentsListRequest + .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .app("app") + .registry(ComponentsListRequestRegistry.PUBLIC) + .componentType(ComponentType.TRIGGER) + .build() +); ```
@@ -725,85 +931,64 @@ client.components().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - -
-
+**after:** `Optional` — The cursor to start from for pagination +
+
+
+ +**before:** `Optional` — The cursor to end before for pagination
-
-
client.components.configureProp(projectId, request) -> ConfigurePropResponse
-#### 🔌 Usage +**limit:** `Optional` — The maximum number of results to return -
-
+
+
-```java -client.components().configureProp( - "project_id", - ComponentsConfigurePropRequest - .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) - .build() -); -``` -
-
+**q:** `Optional` — A search query to filter the components +
-#### ⚙️ Parameters -
-
-
+**app:** `Optional` — The ID or name slug of the app to filter the components -**projectId:** `String` — The project ID, which starts with 'proj_'. -
-**asyncHandle:** `Optional` - +**registry:** `Optional` — The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all') +
-**request:** `ConfigurePropOpts` - +**componentType:** `Optional` — The type of the component to filter the components +
@@ -814,10 +999,24 @@ client.components().configureProp(
-
client.components.reloadProps(projectId, request) -> ReloadPropsResponse +
client.components.retrieve(projectId, componentId) -> GetComponentResponse +
+
+ +#### 📝 Description + +
+
+
+Get detailed configuration for a specific component by its key +
+
+
+
+ #### 🔌 Usage
@@ -827,17 +1026,11 @@ client.components().configureProp(
```java -client.components().reloadProps( - "project_id", - ComponentsReloadPropsRequest +client.components().retrieve( + "component_id", + ComponentsRetrieveRequest .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() - ) + .version("1.2.3") .build() ); ``` @@ -854,24 +1047,24 @@ client.components().reloadProps(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**asyncHandle:** `Optional` - +**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +
-**request:** `ReloadPropsOpts` - +**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') +
@@ -882,11 +1075,24 @@ client.components().reloadProps(
-## Actions -
client.actions.list(projectId) -> GetComponentsResponse +
client.components.configureProp(projectId, request) -> ConfigurePropResponse +
+
+ +#### 📝 Description + +
+
+
+Retrieve remote options for a given prop for a component +
+
+
+
+ #### 🔌 Usage
@@ -896,10 +1102,12 @@ client.components().reloadProps(
```java -client.actions().list( - "project_id", - ActionsListRequest +client.components().configureProp( + ConfigurePropOpts .builder() + .id("id") + .externalUserId("external_user_id") + .propName("prop_name") .build() ); ``` @@ -916,61 +1124,43 @@ client.actions().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**after:** `Optional` — The cursor to start from for pagination - +**request:** `ConfigurePropOpts` + +
+
-
-
-**before:** `Optional` — The cursor to end before for pagination -
+
+
client.components.reloadProps(projectId, request) -> ReloadPropsResponse
-**limit:** `Optional` — The maximum number of results to return - -
-
+#### 📝 Description
-**q:** `Optional` — A search query to filter the actions - -
-
-
-**app:** `Optional` — The ID or name slug of the app to filter the actions - -
-
+Reload the prop definition based on the currently configured props - - -
- -
client.actions.retrieve(projectId, componentId) -> GetComponentResponse -
-
#### 🔌 Usage @@ -981,7 +1171,13 @@ client.actions().list(
```java -client.actions().retrieve("project_id", "component_id"); +client.components().reloadProps( + ReloadPropsOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .build() +); ```
@@ -996,16 +1192,16 @@ client.actions().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - +**request:** `ReloadPropsOpts` +
@@ -1016,10 +1212,25 @@ client.actions().retrieve("project_id", "component_id");
-
client.actions.configureProp(projectId, request) -> ConfigurePropResponse +## Actions +
client.actions.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve available actions with optional search and app filtering +
+
+
+
+ #### 🔌 Usage
@@ -1029,18 +1240,15 @@ client.actions().retrieve("project_id", "component_id");
```java -client.actions().configureProp( - "project_id", - ActionsConfigurePropRequest +client.actions().list( + ActionsListRequest .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) + .after("after") + .before("before") + .limit(1) + .q("q") + .app("app") + .registry(ActionsListRequestRegistry.PUBLIC) .build() ); ``` @@ -1057,92 +1265,56 @@ client.actions().configureProp(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**asyncHandle:** `Optional` - +**after:** `Optional` — The cursor to start from for pagination +
-**request:** `ConfigurePropOpts` - -
-
-
-
- +**before:** `Optional` — The cursor to end before for pagination
-
- -
client.actions.reloadProps(projectId, request) -> ReloadPropsResponse -
-
- -#### 🔌 Usage
-
-
+**limit:** `Optional` — The maximum number of results to return -```java -client.actions().reloadProps( - "project_id", - ActionsReloadPropsRequest - .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() - ) - .build() -); -``` -
-
-#### ⚙️ Parameters -
-
-
+**q:** `Optional` — A search query to filter the actions -**projectId:** `String` — The project ID, which starts with 'proj_'. -
-**asyncHandle:** `Optional` - +**app:** `Optional` — The ID or name slug of the app to filter the actions +
-**request:** `ReloadPropsOpts` - +**registry:** `Optional` — The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all') +
@@ -1153,10 +1325,24 @@ client.actions().reloadProps(
-
client.actions.run(projectId, request) -> RunActionResponse +
client.actions.retrieve(projectId, componentId) -> GetComponentResponse +
+
+ +#### 📝 Description + +
+
+
+Get detailed configuration for a specific action by its key +
+
+
+
+ #### 🔌 Usage
@@ -1166,12 +1352,11 @@ client.actions().reloadProps(
```java -client.actions().run( - "project_id", - RunActionOpts +client.actions().retrieve( + "component_id", + ActionsRetrieveRequest .builder() - .id("id") - .externalUserId("external_user_id") + .version("1.2.3") .build() ); ``` @@ -1188,62 +1373,51 @@ client.actions().run(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**asyncHandle:** `Optional` - +**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +
-**id:** `String` — The action component ID - +**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') + +
+
-
-
-**externalUserId:** `String` — The external user ID -
+
+
client.actions.configureProp(projectId, request) -> ConfigurePropResponse
-**configuredProps:** `Optional>` — The configured properties for the action - -
-
+#### 📝 Description
-**dynamicPropsId:** `Optional` — The ID for dynamic props - -
-
+
+
+ +Retrieve remote options for a given prop for a action
- - -
- -## Triggers -
client.triggers.list(projectId) -> GetComponentsResponse -
-
#### 🔌 Usage @@ -1254,10 +1428,12 @@ client.actions().run(
```java -client.triggers().list( - "project_id", - TriggersListRequest +client.actions().configureProp( + ConfigurePropOpts .builder() + .id("id") + .externalUserId("external_user_id") + .propName("prop_name") .build() ); ``` @@ -1274,61 +1450,43 @@ client.triggers().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**after:** `Optional` — The cursor to start from for pagination - +**request:** `ConfigurePropOpts` + +
+
-
-
-**before:** `Optional` — The cursor to end before for pagination -
+
+
client.actions.reloadProps(projectId, request) -> ReloadPropsResponse
-**limit:** `Optional` — The maximum number of results to return - -
-
+#### 📝 Description
-**q:** `Optional` — A search query to filter the triggers - -
-
-
-**app:** `Optional` — The ID or name slug of the app to filter the triggers - -
-
+Reload the prop definition based on the currently configured props - - -
- -
client.triggers.retrieve(projectId, componentId) -> GetComponentResponse -
-
#### 🔌 Usage @@ -1339,7 +1497,13 @@ client.triggers().list(
```java -client.triggers().retrieve("project_id", "component_id"); +client.actions().reloadProps( + ReloadPropsOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .build() +); ```
@@ -1354,16 +1518,16 @@ client.triggers().retrieve("project_id", "component_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') - +**request:** `ReloadPropsOpts` +
@@ -1374,11 +1538,11 @@ client.triggers().retrieve("project_id", "component_id");
-
client.triggers.configureProp(projectId, request) -> ConfigurePropResponse +
client.actions.run(projectId, request) -> RunActionResponse
-#### 🔌 Usage +#### 📝 Description
@@ -1386,28 +1550,13 @@ client.triggers().retrieve("project_id", "component_id");
-```java -client.triggers().configureProp( - "project_id", - TriggersConfigurePropRequest - .builder() - .body( - ConfigurePropOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .propName("prop_name") - .build() - ) - .build() -); -``` +Execute an action with the provided configuration and return results
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -1415,92 +1564,78 @@ client.triggers().configureProp(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.actions().run( + RunActionOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .build() +); +``` +
+
+#### ⚙️ Parameters +
-**asyncHandle:** `Optional` - -
-
-
-**request:** `ConfigurePropOpts` - -
-
+**projectId:** `String` — The project ID, which starts with `proj_`. +
+
+
+ +**id:** `String` — The action component ID
-
-
client.triggers.reloadProps(projectId, request) -> ReloadPropsResponse
-#### 🔌 Usage +**version:** `Optional` — Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest -
-
+
+
-```java -client.triggers().reloadProps( - "project_id", - TriggersReloadPropsRequest - .builder() - .body( - ReloadPropsOpts - .builder() - .id("id") - .externalUserId("external_user_id") - .build() - ) - .build() -); -``` -
-
+**externalUserId:** `String` — The external user ID +
-#### ⚙️ Parameters -
-
-
+**configuredProps:** `Optional>` -**projectId:** `String` — The project ID, which starts with 'proj_'. -
-**asyncHandle:** `Optional` - +**dynamicPropsId:** `Optional` — The ID for dynamic props +
-**request:** `ReloadPropsOpts` - +**stashId:** `Optional` +
@@ -1511,10 +1646,25 @@ client.triggers().reloadProps(
-
client.triggers.deploy(projectId, request) -> DeployTriggerResponse +## Triggers +
client.triggers.list(projectId) -> SyncPagingIterable&lt;Component&gt; +
+
+ +#### 📝 Description + +
+
+
+Retrieve available triggers with optional search and app filtering +
+
+
+
+ #### 🔌 Usage
@@ -1524,12 +1674,15 @@ client.triggers().reloadProps(
```java -client.triggers().deploy( - "project_id", - DeployTriggerOpts +client.triggers().list( + TriggersListRequest .builder() - .id("id") - .externalUserId("external_user_id") + .after("after") + .before("before") + .limit(1) + .q("q") + .app("app") + .registry(TriggersListRequestRegistry.PUBLIC) .build() ); ``` @@ -1546,48 +1699,56 @@ client.triggers().deploy(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**id:** `String` — The trigger component ID - +**after:** `Optional` — The cursor to start from for pagination +
-**externalUserId:** `String` — The external user ID - +**before:** `Optional` — The cursor to end before for pagination + +
+
+ +
+
+ +**limit:** `Optional` — The maximum number of results to return +
-**configuredProps:** `Optional>` — The configured properties for the trigger - +**q:** `Optional` — A search query to filter the triggers +
-**dynamicPropsId:** `Optional` — The ID for dynamic props - +**app:** `Optional` — The ID or name slug of the app to filter the triggers +
-**webhookUrl:** `Optional` — Optional webhook URL to receive trigger events - +**registry:** `Optional` — The registry to retrieve triggers from. Defaults to 'all' ('public', 'private', or 'all') +
@@ -1598,11 +1759,24 @@ client.triggers().deploy(
-## DeployedTriggers -
client.deployedTriggers.list(projectId) -> GetTriggersResponse +
client.triggers.retrieve(projectId, componentId) -> GetComponentResponse
+#### 📝 Description + +
+
+ +
+
+ +Get detailed configuration for a specific trigger by its key +
+
+
+
+ #### 🔌 Usage
@@ -1612,11 +1786,11 @@ client.triggers().deploy(
```java -client.deployedTriggers().list( - "project_id", - DeployedTriggersListRequest +client.triggers().retrieve( + "component_id", + TriggersRetrieveRequest .builder() - .externalUserId("external_user_id") + .version("1.2.3") .build() ); ``` @@ -1633,40 +1807,93 @@ client.deployedTriggers().list(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**after:** `Optional` — The cursor to start from for pagination - +**componentId:** `String` — The key that uniquely identifies the component (e.g., 'slack-send-message') +
-**before:** `Optional` — The cursor to end before for pagination - +**version:** `Optional` — Optional semantic version of the component to retrieve (for example '1.0.0') + +
+
+ +
+
+
+ +
client.triggers.configureProp(projectId, request) -> ConfigurePropResponse
-**limit:** `Optional` — The maximum number of results to return - +#### 📝 Description + +
+
+ +
+
+ +Retrieve remote options for a given prop for a trigger +
+
+#### 🔌 Usage +
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - +
+
+ +```java +client.triggers().configureProp( + ConfigurePropOpts + .builder() + .id("id") + .externalUserId("external_user_id") + .propName("prop_name") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**request:** `ConfigurePropOpts` +
@@ -1677,10 +1904,24 @@ client.deployedTriggers().list(
-
client.deployedTriggers.retrieve(projectId, triggerId) -> GetTriggerResponse +
client.triggers.reloadProps(projectId, request) -> ReloadPropsResponse +
+
+ +#### 📝 Description + +
+
+
+Reload the prop definition based on the currently configured props +
+
+
+
+ #### 🔌 Usage
@@ -1690,11 +1931,10 @@ client.deployedTriggers().list(
```java -client.deployedTriggers().retrieve( - "project_id", - "trigger_id", - DeployedTriggersRetrieveRequest +client.triggers().reloadProps( + ReloadPropsOpts .builder() + .id("id") .externalUserId("external_user_id") .build() ); @@ -1712,24 +1952,16 @@ client.deployedTriggers().retrieve(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
+**projectId:** `String` — The project ID, which starts with `proj_`. -**triggerId:** `String` -
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - +**request:** `ReloadPropsOpts` +
@@ -1740,10 +1972,24 @@ client.deployedTriggers().retrieve(
-
client.deployedTriggers.update(projectId, triggerId, request) -> GetTriggerResponse +
client.triggers.deploy(projectId, request) -> DeployTriggerResponse
+#### 📝 Description + +
+
+ +
+
+ +Deploy a trigger to listen for and emit events +
+
+
+
+ #### 🔌 Usage
@@ -1753,11 +1999,10 @@ client.deployedTriggers().retrieve(
```java -client.deployedTriggers().update( - "project_id", - "trigger_id", - UpdateTriggerOpts +client.triggers().deploy( + DeployTriggerOpts .builder() + .id("id") .externalUserId("external_user_id") .build() ); @@ -1775,48 +2020,1625 @@ client.deployedTriggers().update(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**id:** `String` — The trigger component ID + +
+
+ +
+
+ +**version:** `Optional` — Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID + +
+
+ +
+
+ +**configuredProps:** `Optional>` +
-**triggerId:** `String` - +**dynamicPropsId:** `Optional` — The ID for dynamic props + +
+
+ +
+
+ +**workflowId:** `Optional` — Optional ID of a workflow to receive trigger events + +
+
+ +
+
+ +**webhookUrl:** `Optional` — Optional webhook URL to receive trigger events + +
+
+ +
+
+ +**emitOnDeploy:** `Optional` — Whether the trigger should emit events during the deploy hook execution. Defaults to true if not specified. + +
+
+
+
+ + +
+
+
+ +## DeployedTriggers +
client.deployedTriggers.list(projectId) -> SyncPagingIterable&lt;Emitter&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve all deployed triggers for a specific external user +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().list( + DeployedTriggersListRequest + .builder() + .externalUserId("external_user_id") + .after("after") + .before("before") + .limit(1) + .emitterType(EmitterType.EMAIL) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**after:** `Optional` — The cursor to start from for pagination + +
+
+ +
+
+ +**before:** `Optional` — The cursor to end before for pagination + +
+
+ +
+
+ +**limit:** `Optional` — The maximum number of results to return + +
+
+ +
+
+ +**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger + +
+
+ +
+
+ +**emitterType:** `Optional` — Filter deployed triggers by emitter type (defaults to 'source' if not provided) + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.retrieve(projectId, triggerId) -> GetTriggerResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get details of a specific deployed trigger by its ID +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().retrieve( + "trigger_id", + DeployedTriggersRetrieveRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.update(projectId, triggerId, request) -> GetTriggerResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Modify the configuration of a deployed trigger, including active status +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().update( + "trigger_id", + UpdateTriggerOpts + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+ +
+
+ +**active:** `Optional` — Whether the trigger should be active + +
+
+ +
+
+ +**configuredProps:** `Optional>` + +
+
+ +
+
+ +**name:** `Optional` — The name of the trigger + +
+
+ +
+
+ +**emitOnDeploy:** `Optional` — Whether the trigger should emit events during deployment + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.delete(projectId, triggerId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove a deployed trigger and stop receiving events +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().delete( + "trigger_id", + DeployedTriggersDeleteRequest + .builder() + .externalUserId("external_user_id") + .ignoreHookErrors(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+ +
+
+ +**ignoreHookErrors:** `Optional` — Whether to ignore errors during deactivation hook + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.listEvents(projectId, triggerId) -> GetTriggerEventsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve recent events emitted by a deployed trigger +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().listEvents( + "trigger_id", + DeployedTriggersListEventsRequest + .builder() + .externalUserId("external_user_id") + .n(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger + +
+
+ +
+
+ +**n:** `Optional` — The number of events to retrieve (defaults to 20 if not provided) + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.listWorkflows(projectId, triggerId) -> GetTriggerWorkflowsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get workflows connected to receive events from this trigger +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().listWorkflows( + "trigger_id", + DeployedTriggersListWorkflowsRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.updateWorkflows(projectId, triggerId, request) -> GetTriggerWorkflowsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Connect or disconnect workflows to receive trigger events +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().updateWorkflows( + "trigger_id", + UpdateTriggerWorkflowsOpts + .builder() + .externalUserId("external_user_id") + .workflowIds( + Arrays.asList("workflow_ids") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+ +
+
+ +**workflowIds:** `List` — Array of workflow IDs to set + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.listWebhooks(projectId, triggerId) -> GetTriggerWebhooksResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get webhook URLs configured to receive trigger events +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().listWebhooks( + "trigger_id", + DeployedTriggersListWebhooksRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.updateWebhooks(projectId, triggerId, request) -> GetTriggerWebhooksResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Configure webhook URLs to receive trigger events. `signing_key` is only returned for OAuth-authenticated requests. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().updateWebhooks( + "trigger_id", + UpdateTriggerWebhooksOpts + .builder() + .externalUserId("external_user_id") + .webhookUrls( + Arrays.asList("webhook_urls") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+ +
+
+ +**webhookUrls:** `List` — Array of webhook URLs to set + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.retrieveWebhook(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a specific webhook for a deployed trigger, including its signing key +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().retrieveWebhook( + "trigger_id", + "webhook_id", + DeployedTriggersRetrieveWebhookRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**webhookId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+
+
+ + +
+
+
+ +
client.deployedTriggers.regenerateWebhookSigningKey(projectId, triggerId, webhookId) -> GetWebhookWithSigningKeyResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Regenerate the signing key for a specific webhook on a deployed trigger +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.deployedTriggers().regenerateWebhookSigningKey( + "trigger_id", + "webhook_id", + DeployedTriggersRegenerateWebhookSigningKeyRequest + .builder() + .externalUserId("external_user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**triggerId:** `String` + +
+
+ +
+
+ +**webhookId:** `String` + +
+
+ +
+
+ +**externalUserId:** `String` — The external user ID who owns the trigger + +
+
+
+
+ + +
+
+
+ +## ProjectEnvironment +
client.projectEnvironment.retrieveWebhook(projectId) -> GetWebhookResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the webhook configured for a project environment +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projectEnvironment().retrieveWebhook(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+
+
+ + +
+
+
+ +
client.projectEnvironment.updateWebhook(projectId, request) -> SetWebhookResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create or update the webhook URL for a project environment. Creating a webhook returns `signing_key`; updating an existing webhook does not. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projectEnvironment().updateWebhook( + SetWebhookOpts + .builder() + .url("url") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url:** `String` — The webhook URL to set + +
+
+
+
+ + +
+
+
+ +
client.projectEnvironment.deleteWebhook(projectId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove the webhook configured for a project environment +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projectEnvironment().deleteWebhook(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+
+
+ + +
+
+
+ +
client.projectEnvironment.regenerateWebhookSigningKey(projectId) -> GetWebhookWithSigningKeyResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Regenerate the signing key for the project environment webhook +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projectEnvironment().regenerateWebhookSigningKey(); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+
+
+ + +
+
+
+ +## Projects +
client.projects.list() -> SyncPagingIterable&lt;Project&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List the projects that are available to the authenticated Connect client +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projects().list( + ProjectsListRequest + .builder() + .after("after") + .before("before") + .limit(1) + .q("q") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**after:** `Optional` — The cursor to start from for pagination + +
+
+ +
+
+ +**before:** `Optional` — The cursor to end before for pagination + +
+
+ +
+
+ +**limit:** `Optional` — The maximum number of results to return + +
+
+ +
+
+ +**q:** `Optional` — A search query to filter the projects + +
+
+
+
+ + +
+
+
+ +
client.projects.create(request) -> Project +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a new project for the authenticated workspace +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projects().create( + CreateProjectOpts + .builder() + .name("name") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `String` — Name of the project + +
+
+ +
+
+ +**appName:** `Optional` — Display name for the Connect application + +
+
+ +
+
+ +**supportEmail:** `Optional` — Support email displayed to end users + +
+
+ +
+
+ +**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps + +
+
+
+
+ + +
+
+
+ +
client.projects.retrieve(projectId) -> Project +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get the project details for a specific project +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projects().retrieve("project_id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+
+
+ + +
+
+
+ +
client.projects.delete(projectId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a project owned by the authenticated workspace +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projects().delete("project_id"); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+
+
+ + +
+
+
+ +
client.projects.update(projectId, request) -> Project +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update project details or application information +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.projects().update( + "project_id", + UpdateProjectOpts + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**externalUserId:** `String` — The external user ID who owns the trigger - +**name:** `Optional` — Name of the project +
-**active:** `Optional` — Whether the trigger should be active - +**appName:** `Optional` — Display name for the Connect application +
-**configuredProps:** `Optional>` — The configured properties for the trigger - +**supportEmail:** `Optional` — Support email displayed to end users +
-**name:** `Optional` — The name of the trigger - +**connectRequireKeyAuthTest:** `Optional` — Send a test request to the upstream API when adding Connect accounts for key-based apps +
@@ -1827,10 +3649,24 @@ client.deployedTriggers().update(
-
client.deployedTriggers.delete(projectId, triggerId) +
client.projects.updateLogo(projectId, request) +
+
+ +#### 📝 Description + +
+
+
+Upload or replace the project logo +
+
+
+
+ #### 🔌 Usage
@@ -1840,12 +3676,11 @@ client.deployedTriggers().update(
```java -client.deployedTriggers().delete( +client.projects().updateLogo( "project_id", - "trigger_id", - DeployedTriggersDeleteRequest + UpdateProjectLogoOpts .builder() - .externalUserId("external_user_id") + .logo("data:image/png;base64,AAAAAA...") .build() ); ``` @@ -1862,32 +3697,16 @@ client.deployedTriggers().delete(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
+**projectId:** `String` — The project ID, which starts with `proj_`. -**triggerId:** `String` -
-**externalUserId:** `String` — The external user ID who owns the trigger - -
-
- -
-
+**logo:** `String` — Data URI containing the new Base64 encoded image -**ignoreHookErrors:** `Optional` — Whether to ignore errors during deactivation hook -
@@ -1898,11 +3717,11 @@ client.deployedTriggers().delete(
-
client.deployedTriggers.listEvents(projectId, triggerId) -> GetTriggerEventsResponse +
client.projects.retrieveInfo(projectId) -> ProjectInfoResponse
-#### 🔌 Usage +#### 📝 Description
@@ -1910,22 +3729,13 @@ client.deployedTriggers().delete(
-```java -client.deployedTriggers().listEvents( - "project_id", - "trigger_id", - DeployedTriggersListEventsRequest - .builder() - .externalUserId("external_user_id") - .build() -); -``` +Retrieve project configuration and environment details
-#### ⚙️ Parameters +#### 🔌 Usage
@@ -1933,32 +3743,24 @@ client.deployedTriggers().listEvents(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +```java +client.projects().retrieveInfo(); +```
- -
-
- -**triggerId:** `String` -
+#### ⚙️ Parameters +
-**externalUserId:** `String` — Your end user ID, for whom you deployed the trigger - -
-
-
-**n:** `Optional` — The number of events to retrieve (defaults to 20 if not provided) - +**projectId:** `String` — The project ID, which starts with `proj_`. +
@@ -1969,10 +3771,25 @@ client.deployedTriggers().listEvents(
-
client.deployedTriggers.listWorkflows(projectId, triggerId) -> GetTriggerWorkflowsResponse +## FileStash +
client.fileStash.downloadFile(projectId) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Download a file from File Stash +
+
+
+
+ #### 🔌 Usage
@@ -1982,12 +3799,10 @@ client.deployedTriggers().listEvents(
```java -client.deployedTriggers().listWorkflows( - "project_id", - "trigger_id", - DeployedTriggersListWorkflowsRequest +client.fileStash().downloadFile( + FileStashDownloadFileRequest .builder() - .externalUserId("external_user_id") + .s3Key("s3_key") .build() ); ``` @@ -2004,24 +3819,16 @@ client.deployedTriggers().listWorkflows(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
- -
-
+**projectId:** `String` — The project ID, which starts with `proj_`. -**triggerId:** `String` -
-**externalUserId:** `String` — The external user ID who owns the trigger - +**s3Key:** `String` +
@@ -2032,10 +3839,25 @@ client.deployedTriggers().listWorkflows(
-
client.deployedTriggers.updateWorkflows(projectId, triggerId, request) -> GetTriggerWorkflowsResponse +## Proxy +
client.proxy.get(projectId, url64) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Forward an authenticated GET request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2045,17 +3867,12 @@ client.deployedTriggers().listWorkflows(
```java -client.deployedTriggers().updateWorkflows( - "project_id", - "trigger_id", - UpdateTriggerWorkflowsOpts +client.proxy().get( + "url_64", + ProxyGetRequest .builder() .externalUserId("external_user_id") - .workflowIds( - new ArrayList( - Arrays.asList("workflow_ids") - ) - ) + .accountId("account_id") .build() ); ``` @@ -2072,32 +3889,32 @@ client.deployedTriggers().updateWorkflows(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**triggerId:** `String` - +**url64:** `String` — Base64-encoded target URL +
-**externalUserId:** `String` — The external user ID who owns the trigger - +**externalUserId:** `String` — The external user ID for the proxy request +
-**workflowIds:** `List` — Array of workflow IDs to set - +**accountId:** `String` — The account ID to use for authentication +
@@ -2108,10 +3925,24 @@ client.deployedTriggers().updateWorkflows(
-
client.deployedTriggers.listWebhooks(projectId, triggerId) -> GetTriggerWebhooksResponse +
client.proxy.post(projectId, url64, request) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+Forward an authenticated POST request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2121,12 +3952,19 @@ client.deployedTriggers().updateWorkflows(
```java -client.deployedTriggers().listWebhooks( - "project_id", - "trigger_id", - DeployedTriggersListWebhooksRequest +client.proxy().post( + "url_64", + ProxyPostRequest .builder() .externalUserId("external_user_id") + .accountId("account_id") + .body( + new HashMap() {{ + put("string", new + HashMap() {{put("key", "value"); + }}); + }} + ) .build() ); ``` @@ -2143,24 +3981,40 @@ client.deployedTriggers().listWebhooks(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**triggerId:** `String` - +**url64:** `String` — Base64-encoded target URL +
-**externalUserId:** `String` — The external user ID who owns the trigger - +**externalUserId:** `String` — The external user ID for the proxy request + +
+
+ +
+
+ +**accountId:** `String` — The account ID to use for authentication + +
+
+ +
+
+ +**request:** `Map` — Request body to forward to the target API +
@@ -2171,10 +4025,24 @@ client.deployedTriggers().listWebhooks(
-
client.deployedTriggers.updateWebhooks(projectId, triggerId, request) -> GetTriggerWebhooksResponse +
client.proxy.put(projectId, url64, request) -> InputStream
+#### 📝 Description + +
+
+ +
+
+ +Forward an authenticated PUT request to an external API using an external user's account credentials +
+
+
+
+ #### 🔌 Usage
@@ -2184,16 +4052,18 @@ client.deployedTriggers().listWebhooks(
```java -client.deployedTriggers().updateWebhooks( - "project_id", - "trigger_id", - UpdateTriggerWebhooksOpts +client.proxy().put( + "url_64", + ProxyPutRequest .builder() .externalUserId("external_user_id") - .webhookUrls( - new ArrayList( - Arrays.asList("webhook_urls") - ) + .accountId("account_id") + .body( + new HashMap() {{ + put("string", new + HashMap() {{put("key", "value"); + }}); + }} ) .build() ); @@ -2211,32 +4081,40 @@ client.deployedTriggers().updateWebhooks(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL +
-**triggerId:** `String` - +**externalUserId:** `String` — The external user ID for the proxy request +
-**externalUserId:** `String` — The external user ID who owns the trigger - +**accountId:** `String` — The account ID to use for authentication +
-**webhookUrls:** `List` — Array of webhook URLs to set - +**request:** `Map` — Request body to forward to the target API +
@@ -2247,28 +4125,11 @@ client.deployedTriggers().updateWebhooks(
-## Projects -
client.projects.retrieveInfo(projectId) -> ProjectInfoResponse -
-
- -#### 🔌 Usage - -
-
- +
client.proxy.delete(projectId, url64) -> InputStream
-```java -client.projects().retrieveInfo("project_id"); -``` -
-
-
-
- -#### ⚙️ Parameters +#### 📝 Description
@@ -2276,22 +4137,11 @@ client.projects().retrieveInfo("project_id");
-**projectId:** `String` — The project ID, which starts with 'proj_'. - -
-
+Forward an authenticated DELETE request to an external API using an external user's account credentials
- -
-
- -## Proxy -
client.proxy.get(url, request) -> Object -
-
#### 🔌 Usage @@ -2302,9 +4152,9 @@ client.projects().retrieveInfo("project_id");
```java -client.proxy().get( - "https://api.example.com/endpoint", - ProxyGetRequest +client.proxy().delete( + "url_64", + ProxyDeleteRequest .builder() .externalUserId("external_user_id") .accountId("account_id") @@ -2324,8 +4174,16 @@ client.proxy().get(
-**url:** `String` — The target URL to proxy the request to - +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL +
@@ -2333,7 +4191,7 @@ client.proxy().get(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -2341,27 +4199,34 @@ client.proxy().get(
**accountId:** `String` — The account ID to use for authentication - +
-#### 📄 Response -The proxy methods intelligently handle responses: -- **JSON responses**: Automatically parsed and returned as structured objects -- **Non-JSON responses**: Returned as raw strings (HTML, XML, plain text, etc.) -- **Empty responses**: Return `null` + + +
+ +
client.proxy.patch(projectId, url64, request) -> InputStream +
+
+ +#### 📝 Description + +
+
+
+
+Forward an authenticated PATCH request to an external API using an external user's account credentials +
+
-
- -
client.proxy.post(url, request) -> Object -
-
#### 🔌 Usage @@ -2372,15 +4237,17 @@ The proxy methods intelligently handle responses:
```java -client.proxy().post( - "https://api.example.com/endpoint", - ProxyPostRequest +client.proxy().patch( + "url_64", + ProxyPatchRequest .builder() .externalUserId("external_user_id") .accountId("account_id") .body( new HashMap() {{ - put("key", "value"); + put("string", new + HashMap() {{put("key", "value"); + }}); }} ) .build() @@ -2399,8 +4266,16 @@ client.proxy().post(
-**url:** `String` — The target URL to proxy the request to - +**projectId:** `String` — The project ID, which starts with `proj_`. + +
+
+ +
+
+ +**url64:** `String` — Base64-encoded target URL +
@@ -2408,7 +4283,7 @@ client.proxy().post(
**externalUserId:** `String` — The external user ID for the proxy request - +
@@ -2416,7 +4291,7 @@ client.proxy().post(
**accountId:** `String` — The account ID to use for authentication - +
@@ -2424,7 +4299,7 @@ client.proxy().post(
**request:** `Map` — Request body to forward to the target API - +
@@ -2435,10 +4310,25 @@ client.proxy().post(
-
client.proxy.put(url, request) -> Object +## Tokens +
client.tokens.create(projectId, request) -> CreateTokenResponse +
+
+ +#### 📝 Description + +
+
+
+Generate a Connect token to use for client-side authentication +
+
+
+
+ #### 🔌 Usage
@@ -2448,17 +4338,10 @@ client.proxy().post(
```java -client.proxy().put( - "https://api.example.com/endpoint", - ProxyPutRequest +client.tokens().create( + CreateTokenOpts .builder() .externalUserId("external_user_id") - .accountId("account_id") - .body( - new HashMap() {{ - put("key", "value"); - }} - ) .build() ); ``` @@ -2475,95 +4358,64 @@ client.proxy().put(
-**url:** `String` — The target URL to proxy the request to - +**projectId:** `String` — The project ID, which starts with `proj_`. +
-**externalUserId:** `String` — The external user ID for the proxy request - +**allowedOrigins:** `Optional>` — List of allowed origins for CORS +
-**accountId:** `String` — The account ID to use for authentication - +**errorRedirectUri:** `Optional` — URI to redirect to on error +
-**request:** `Map` — Request body to forward to the target API - -
-
-
-
- +**expiresIn:** `Optional` — Token TTL in seconds (max 14400 = 4 hours). Defaults to 4 hours if not specified.
-
- -
client.proxy.delete(url, request) -> Object -
-
- -#### 🔌 Usage
-
-
+**externalUserId:** `String` — Your end user ID, for whom you're creating the token -```java -client.proxy().delete( - "https://api.example.com/endpoint", - ProxyDeleteRequest - .builder() - .externalUserId("external_user_id") - .accountId("account_id") - .build() -); -``` -
-
-#### ⚙️ Parameters -
-
-
+**scope:** `Optional` — Space-separated scopes to restrict token permissions. Defaults to 'connect:*' if not specified. See https://pipedream.com/docs/connect/api-reference/authentication#connect-token-scopes for more information. -**url:** `String` — The target URL to proxy the request to -
-**externalUserId:** `String` — The external user ID for the proxy request - +**successRedirectUri:** `Optional` — URI to redirect to on success +
-**accountId:** `String` — The account ID to use for authentication - +**webhookUri:** `Optional` — Webhook URI for notifications +
@@ -2574,10 +4426,24 @@ client.proxy().delete(
-
client.proxy.patch(url, request) -> Object +
client.tokens.validate(ctok) -> ValidateTokenResponse +
+
+ +#### 📝 Description + +
+
+
+Confirm the validity of a Connect token +
+
+
+
+ #### 🔌 Usage
@@ -2587,17 +4453,12 @@ client.proxy().delete(
```java -client.proxy().patch( - "https://api.example.com/endpoint", - ProxyPatchRequest +client.tokens().validate( + "ctok", + TokensValidateRequest .builder() - .externalUserId("external_user_id") - .accountId("account_id") - .body( - new HashMap() {{ - put("key", "value"); - }} - ) + .appId("app_id") + .oauthAppId("oauth_app_id") .build() ); ``` @@ -2614,32 +4475,24 @@ client.proxy().patch(
-**url:** `String` — The target URL to proxy the request to - -
-
- -
-
+**ctok:** `String` -**externalUserId:** `String` — The external user ID for the proxy request -
-**accountId:** `String` — The account ID to use for authentication - +**appId:** `String` — The app ID to validate against +
-**request:** `Map` — Request body to forward to the target API - +**oauthAppId:** `Optional` — The OAuth app ID to validate against (if the token is for an OAuth app) +
@@ -2650,11 +4503,25 @@ client.proxy().patch(
-## Tokens -
client.tokens.create(projectId, request) -> CreateTokenResponse +## Usage +
client.usage.list() -> ConnectUsageResponse +
+
+ +#### 📝 Description + +
+
+
+Retrieve Connect usage records for a time window +
+
+
+
+ #### 🔌 Usage
@@ -2664,11 +4531,11 @@ client.proxy().patch(
```java -client.tokens().create( - "project_id", - CreateTokenOpts +client.usage().list( + UsageListRequest .builder() - .externalUserId("external_user_id") + .startTs(1) + .endTs(1) .build() ); ``` @@ -2685,61 +4552,44 @@ client.tokens().create(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**startTs:** `Integer` — Usage window start timestamp (seconds) +
-**allowedOrigins:** `Optional>` — List of allowed origins for CORS - +**endTs:** `Integer` — Usage window end timestamp (seconds) + +
+
-
-
-**errorRedirectUri:** `Optional` — URI to redirect to on error -
+
+## OauthTokens +
client.oauthTokens.create(request) -> CreateOAuthTokenResponse
-**externalUserId:** `String` — Your end user ID, for whom you're creating the token - -
-
+#### 📝 Description
-**successRedirectUri:** `Optional` — URI to redirect to on success - -
-
-
-**webhookUri:** `Optional` — Webhook URI for notifications - -
-
+Exchange OAuth credentials for an access token - - -
- -
client.tokens.validate(projectId, ctok) -> ValidateTokenResponse -
-
#### 🔌 Usage @@ -2750,11 +4600,12 @@ client.tokens().create(
```java -client.tokens().validate( - "project_id", - "ctok", - TokensValidateRequest +client.oauthTokens().create( + CreateOAuthTokenOpts .builder() + .grantType("client_credentials") + .clientId("client_id") + .clientSecret("client_secret") .build() ); ``` @@ -2771,24 +4622,32 @@ client.tokens().validate(
-**projectId:** `String` — The project ID, which starts with 'proj_'. - +**grantType:** `String` + +
+
+ +
+
+ +**clientId:** `String` +
-**ctok:** `String` - +**clientSecret:** `String` +
-**params:** `Optional` - +**scope:** `Optional` — Optional space-separated scopes for the access token. Defaults to `*`. +
@@ -2852,7 +4711,7 @@ client.workflows().invoke(
**urlOrEndpoint:** `String` — Either a workflow endpoint ID (e.g., 'eo3xxxx') or a full workflow URL - +
@@ -2860,7 +4719,7 @@ client.workflows().invoke(
**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) - + @@ -2868,7 +4727,7 @@ client.workflows().invoke(
**headers:** `Optional>` — Additional headers to include in the request - +
@@ -2876,7 +4735,7 @@ client.workflows().invoke(
**method:** `Optional` — HTTP method to use (defaults to 'POST') - +
@@ -2884,7 +4743,7 @@ client.workflows().invoke(
**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE - +
@@ -2947,111 +4806,47 @@ client.workflows().invokeForExternalUser(
**url:** `String` — The full workflow URL to invoke - -
- - -
-
- -**externalUserId:** `String` — The external user ID for Pipedream Connect authentication - -
-
- -
-
-**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) -
-**headers:** `Optional>` — Additional headers to include in the request - -
-
- -
-
+**externalUserId:** `String` — The external user ID for Pipedream Connect authentication -**method:** `Optional` — HTTP method to use (defaults to 'POST') -
-**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE - -
-
- - - +**body:** `Optional` — Request body to send to the workflow (will be JSON serialized) - - -## OauthTokens -
client.oauthTokens.create(request) -> CreateOAuthTokenResponse -
-
- -#### 🔌 Usage
-
-
+**headers:** `Optional>` — Additional headers to include in the request -```java -client.oauthTokens().create( - CreateOAuthTokenOpts - .builder() - .grantType("client_credentials") - .clientId("client_id") - .clientSecret("client_secret") - .build() -); -``` -
-
-#### ⚙️ Parameters -
-
-
+**method:** `Optional` — HTTP method to use (defaults to 'POST') -**grantType:** `String` -
-**clientId:** `String` - -
-
- -
-
+**authType:** `Optional` — Authentication type: OAUTH (default), STATIC_BEARER, or NONE -**clientSecret:** `String` -
@@ -3061,3 +4856,4 @@ client.oauthTokens().create(
+