diff --git a/docs-v2/reference/sdks/node.mdx b/docs-v2/reference/sdks/node.mdx index 8ca0c119d9b..ce315590c79 100644 --- a/docs-v2/reference/sdks/node.mdx +++ b/docs-v2/reference/sdks/node.mdx @@ -173,14 +173,6 @@ await nango.getIntegration(); Include sensitive data. Allowed values: `webhook` - - - The integration ID. - - - - Defaults to `false`. - **Example Response** @@ -204,6 +196,9 @@ await nango.getIntegration(); Create a new integration. ```js +await nango.createIntegration({ provider: , unique_key: , [...] }); + +// Deprecated await nango.createIntegration(, ); ``` @@ -214,29 +209,17 @@ await nango.createIntegration(, ); The ID of the API provider in Nango (cf. [providers.yaml](https://nango.dev/providers.yaml) for a list of API provider IDs.) - + The integration ID. - - The credentials to include depend on the specific integration that you want to create. + + The display name of this integration - - - The OAuth client ID. - - - - The OAuth client secret. - - - - The list of OAuth scopes - - - + The credentials to include depend on the specific integration that you want to create. + **Example Response** @@ -244,9 +227,12 @@ await nango.createIntegration(, ); ```json { - "config": { + "data": { "unique_key": "slack-nango-community", - "provider": "slack" + "provider": "slack", + "logo": "http://localhost:3003/images/template-logos/slack.svg", + "created_at": "2023-10-16T08:45:26.241Z", + "updated_at": "2023-10-16T08:45:26.241Z", } } ``` @@ -254,42 +240,29 @@ await nango.createIntegration(, ); ### Update an integration -Edits an integration (only for OAuth APIs). +Patch an integration, all fields are optional. ```js +await nango.updateIntegration({ uniqueKey: }, { [...body] }); + +// Deprecated await nango.updateIntegration(, ); ``` **Parameters** - - The ID of the API provider in Nango (cf. [providers.yaml](https://nango.dev/providers.yaml) for a list of API provider IDs.) + + The integration ID. - - The integration ID. + + The display name of this integration The credentials to include depend on the specific integration that you want to create. - - - - - The OAuth client ID. - - - - The OAuth client secret. - - - - The list of OAuth scopes - - - **Example Response** @@ -297,9 +270,12 @@ await nango.updateIntegration(, ); ```json { - "config": { + "data": { "unique_key": "slack-nango-community", - "provider": "slack" + "provider": "slack", + "logo": "http://localhost:3003/images/template-logos/slack.svg", + "created_at": "2023-10-16T08:45:26.241Z", + "updated_at": "2023-10-16T08:45:26.241Z", } } ``` @@ -310,13 +286,13 @@ await nango.updateIntegration(, ); Deletes a specific integration. ```js -await nango.deleteIntegration(); +await nango.deleteIntegration(); ``` **Parameters** - + The integration ID. @@ -326,10 +302,7 @@ await nango.deleteIntegration(); ```json { - "config": { - "unique_key": "slack-nango-community", - "provider": "slack" - } + "success": true } ```