From 97783be5218050b0f3cf707369e0dc905404bad2 Mon Sep 17 00:00:00 2001 From: Harshil Agrawal Date: Tue, 6 Apr 2021 10:59:13 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9A=A1=20Update=20node=20documnetation=20(#4?= =?UTF-8?q?66)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core-nodes/MoveBinaryData/README.md | 8 ++-- .../nodes-library/nodes/AWSSES/README.md | 9 +++++ .../nodes-library/nodes/Affinity/README.md | 12 ++++++ docs/nodes/nodes-library/nodes/Box/README.md | 1 + .../nodes-library/nodes/ClickUp/README.md | 37 ++++++++++++++++--- .../nodes-library/nodes/Dropbox/README.md | 4 ++ .../nodes-library/nodes/GoogleDrive/README.md | 1 + docs/nodes/nodes-library/nodes/Jira/README.md | 21 +++++++++++ .../nodes-library/nodes/Mattermost/README.md | 7 ++++ .../nodes/MicrosoftTeams/README.md | 8 ++++ .../nodes-library/nodes/Mondaycom/README.md | 5 ++- .../nodes-library/nodes/SendGrid/README.md | 4 ++ .../nodes-library/nodes/Spotify/README.md | 7 +++- .../nodes-library/nodes/Telegram/README.md | 9 +++++ .../nodes-library/nodes/TheHive/README.md | 2 + .../nodes-library/nodes/Trello/README.md | 1 + .../nodes-library/nodes/Twitter/README.md | 1 + .../nodes/nodes-library/nodes/uProc/README.md | 5 +++ 18 files changed, 131 insertions(+), 11 deletions(-) diff --git a/docs/nodes/nodes-library/core-nodes/MoveBinaryData/README.md b/docs/nodes/nodes-library/core-nodes/MoveBinaryData/README.md index dcb1563d8..63b702594 100644 --- a/docs/nodes/nodes-library/core-nodes/MoveBinaryData/README.md +++ b/docs/nodes/nodes-library/core-nodes/MoveBinaryData/README.md @@ -12,19 +12,21 @@ The Move Binary Data node is useful to move data between binary and JSON propert - ***Mode:*** This field specifies from where and to the data should be moved. - Binary to JSON - JSON to Binary -- ***Set all Data:*** If set to active, all JSON data is replaced with the data retrieved from binary key. If it is not set to active, the data will be written to a single key. This field is displayed when 'Binary to JSON' is selected from the ***Mode*** dropdown list. +- ***Set all Data:*** If set to active, all JSON data is replaced with the data retrieved from binary key. If it is not set to active, the data will be written to a single key. This field is displayed when 'Binary to JSON' is selected from the ***Mode*** dropdown list. - ***Source Key:*** The name of the binary key to get data from. It is also possible to define deep keys by using dot-notation. For example, "level1.level2.currentKey". This field is displayed when 'Binary to JSON' is selected from the ***Mode*** dropdown list. - ***Destination Key:*** The name the JSON key to copy data to. It is also possible to define deep keys by using dot-notation. For example, "level1.level2.newKey". This field is displayed when 'Binary to JSON' is selected from the ***Mode*** dropdown list. -- ***Convert all Data:*** If set to active all JSON data will be converted to binary. If it is not set to active only the data with one key will be converted. This field is displayed when 'JSON to Binary' is selected from the ***Mode*** dropdown list. +- ***Convert all Data:*** If set to active all JSON data will be converted to binary. If it is not set to active only the data with one key will be converted. This field is displayed when 'JSON to Binary' is selected from the ***Mode*** dropdown list. - ***Destination Key:*** The name of the binary key to copy data to. It is also possible to define deep keys by using dot-notation. For example, "level1.level2.newKey". This field is displayed when 'JSON to Binary' is selected from the ***Mode*** dropdown list. - ***Options*** - ***Keep Source:*** Keep the source key. By default it gets deleted. + - ***Encoding:*** Set the encoding of the data stream. - The following are the options when 'Binary to JSON' is selected from the ***Mode*** dropdown list. - - ***Encoding:*** Set the encoding of the datastream. - ***JSON Parse:*** Run JSON parse on the data to get proper object data. This field is displayed when ***Set all Data*** is set to 'false'. - ***Keep As Base64:*** Keeps the binary data as base64 string. This field is displayed when ***Set all Data*** is set to 'false'. + - ***Strip BOM:*** Strip the byte order mark (BOM) from the string. This field is displayed when ***Encoding*** is selected. - The following are the options when 'JSON to Binary' is selected from the ***Mode*** dropdown list. + - ***Add BOM:*** Add the byte order mark (BOM) to the string. This field is displayed when ***Encoding*** is selected. - ***File Name:*** The file name to set. - ***Mime Type:*** The mime-type to set. By default the JSON mime-type will be set. - ***Use Raw Data:*** Use data as is and do not stringify it. diff --git a/docs/nodes/nodes-library/nodes/AWSSES/README.md b/docs/nodes/nodes-library/nodes/AWSSES/README.md index 666a40601..ad12a8757 100644 --- a/docs/nodes/nodes-library/nodes/AWSSES/README.md +++ b/docs/nodes/nodes-library/nodes/AWSSES/README.md @@ -13,6 +13,15 @@ You can find authentication information for this node [here](../../../credential ## Basic Operations +::: details Custom Verification Email +- Create a new custom verification email template +- Delete an existing custom verification email template +- Get the custom email verification template +- Get all the existing custom verification email templates for your account +- Add an email address to the list of identities +- Update an existing custom verification email template +::: + ::: details Email - Send Email - Send Template diff --git a/docs/nodes/nodes-library/nodes/Affinity/README.md b/docs/nodes/nodes-library/nodes/Affinity/README.md index ae6eb5ba4..fd2ea517a 100644 --- a/docs/nodes/nodes-library/nodes/Affinity/README.md +++ b/docs/nodes/nodes-library/nodes/Affinity/README.md @@ -13,6 +13,18 @@ You can find authentication information for this node [here](../../../credential ## Basic Operations +::: details List +- Get a list +- Get all lists +::: + +::: details List Entry +- Create a list entry +- Delete a list entry +- Get a list entry +- Get all list entries +::: + ::: details Organization - Create an organization - Delete an organization diff --git a/docs/nodes/nodes-library/nodes/Box/README.md b/docs/nodes/nodes-library/nodes/Box/README.md index 447a5e99f..2cf5b657a 100644 --- a/docs/nodes/nodes-library/nodes/Box/README.md +++ b/docs/nodes/nodes-library/nodes/Box/README.md @@ -24,6 +24,7 @@ You can find authentication information for this node [here](../../../credential ::: details Folder - Create a folder +- Get a folder - Delete a folder - Search files ::: diff --git a/docs/nodes/nodes-library/nodes/ClickUp/README.md b/docs/nodes/nodes-library/nodes/ClickUp/README.md index 65842ce69..84a5d8daa 100644 --- a/docs/nodes/nodes-library/nodes/ClickUp/README.md +++ b/docs/nodes/nodes-library/nodes/ClickUp/README.md @@ -60,28 +60,55 @@ You can find authentication information for this node [here](../../../credential - Delete a list - Get a list - Get all lists +- Get list members - Update a list ::: +::: details Space Tag +- Create a space tag +- Delete a space tag +- Get all space tags +- Update a space tag +::: + ::: details Task - Create a task - Delete a task - Get a task - Get all tasks +- Get task members - Set a custom field - Update a task ::: +::: details Task List +- Add a task to a list +- Remove a task from a list +::: + +::: details Task Tag +- Add a tag to a task +- Remove a tag from a task +::: + ::: details Task Dependency - Create a task dependency - Delete a task dependency ::: -::: details Time Tracking -- Log time on task -- Delete a logged time -- Get all logging times on task -- Update a logged time +::: details Time Entry +- Create a time entry +- Delete a time entry +- Get a time entry +- Start a time entry +- Stop the current running timer +- Update a time entry +::: + +::: details Time Entry Tag +- Add a tag to a time entry +- Get all time entry tags +- Remove a tag from time entry ::: ## Example Usage diff --git a/docs/nodes/nodes-library/nodes/Dropbox/README.md b/docs/nodes/nodes-library/nodes/Dropbox/README.md index f5c26323f..bb76eea8d 100644 --- a/docs/nodes/nodes-library/nodes/Dropbox/README.md +++ b/docs/nodes/nodes-library/nodes/Dropbox/README.md @@ -29,6 +29,10 @@ You can find authentication information for this node [here](../../../credential - Move a folder ::: +::: details Search +- Query +::: + ## Example Usage This workflow allows you to create a folder in Dropbox, upload a file into that folder, and list the contents of the folder. You can also find the [workflow](https://n8n.io/workflows/615) on n8n.io. This example usage workflow uses the following nodes. diff --git a/docs/nodes/nodes-library/nodes/GoogleDrive/README.md b/docs/nodes/nodes-library/nodes/GoogleDrive/README.md index 03815eaaf..a34589179 100644 --- a/docs/nodes/nodes-library/nodes/GoogleDrive/README.md +++ b/docs/nodes/nodes-library/nodes/GoogleDrive/README.md @@ -27,6 +27,7 @@ You can find authentication information for this node [here](../../../credential - Download a file - List files and folders - Share a file +- Update a file - Upload a file ::: diff --git a/docs/nodes/nodes-library/nodes/Jira/README.md b/docs/nodes/nodes-library/nodes/Jira/README.md index a3b364ac2..7ae554887 100644 --- a/docs/nodes/nodes-library/nodes/Jira/README.md +++ b/docs/nodes/nodes-library/nodes/Jira/README.md @@ -24,6 +24,27 @@ You can find authentication information for this node [here](../../../credential - Delete an issue ::: +::: details Issue Attachment +- Add attachment to an issue +- Get an attachment +- Get all attachments +- Remove an attachment +::: + +::: details Issue Comment +- Add comment to issue +- Get a comment +- Get all comments +- Remove a comment +- Update a comment +::: + +::: details User +- Create a new user +- Delete a user +- Retrieve a user +::: + ## Example Usage This workflow allows you to create a new issue in Jira. You can also find the [workflow](https://n8n.io/workflows/459) on the website. This example usage workflow would use the following two nodes. diff --git a/docs/nodes/nodes-library/nodes/Mattermost/README.md b/docs/nodes/nodes-library/nodes/Mattermost/README.md index 4e90a6f24..9014ac693 100644 --- a/docs/nodes/nodes-library/nodes/Mattermost/README.md +++ b/docs/nodes/nodes-library/nodes/Mattermost/README.md @@ -25,6 +25,13 @@ You can find authentication information for this node [here](../../../credential ::: details Message - Soft delete a post, by marking the post as deleted in the database - Post a message into a channel +- Post an ephemeral message into a channel +::: + +::: details Reaction +- Add a reaction to a post +- Remove a reaction from a post +- Get all the reactions to one or more posts ::: ::: details User diff --git a/docs/nodes/nodes-library/nodes/MicrosoftTeams/README.md b/docs/nodes/nodes-library/nodes/MicrosoftTeams/README.md index 7b903ebd0..618742397 100644 --- a/docs/nodes/nodes-library/nodes/MicrosoftTeams/README.md +++ b/docs/nodes/nodes-library/nodes/MicrosoftTeams/README.md @@ -26,6 +26,14 @@ You can find authentication information for this node [here](../../../credential - Get all messages ::: +::: details Task +- Create a task +- Delete a task +- Get a task +- Get all tasks +- Update a task +::: + ## Example Usage This workflow allows you to create, update and send a message to a channel in Microsoft Teams. You can also find the [workflow](https://n8n.io/workflows/680) on n8n.io. This example usage workflow would use the following nodes. diff --git a/docs/nodes/nodes-library/nodes/Mondaycom/README.md b/docs/nodes/nodes-library/nodes/Mondaycom/README.md index b90378f41..9b40a0b5b 100644 --- a/docs/nodes/nodes-library/nodes/Mondaycom/README.md +++ b/docs/nodes/nodes-library/nodes/Mondaycom/README.md @@ -28,18 +28,19 @@ You can find authentication information for this node [here](../../../credential ::: details Board Group - Delete a group in a board - Create a group in a board -- Get boards' groups +- Get a list of groups in a board ::: ::: details Board Item - Add an update to an item -- Change a column value for a board item +- Change a column value for a board item - Change multiple column values for a board item - Create an item in a board's group - Delete an item - Get an item - Get all items - Get items by column value +- Move item to group ::: ## Example Usage diff --git a/docs/nodes/nodes-library/nodes/SendGrid/README.md b/docs/nodes/nodes-library/nodes/SendGrid/README.md index 8242173f0..55d613836 100644 --- a/docs/nodes/nodes-library/nodes/SendGrid/README.md +++ b/docs/nodes/nodes-library/nodes/SendGrid/README.md @@ -28,6 +28,10 @@ You can find authentication information for this node [here](../../../credential - Update a list ::: +::: detials Mail +- Send an email +::: + ## Example Usage This workflow allows you to create, update and get a contact using the SendGrid node. You can also find the [workflow](https://n8n.io/workflows/901) on n8n.io. This example usage workflow uses the following nodes. diff --git a/docs/nodes/nodes-library/nodes/Spotify/README.md b/docs/nodes/nodes-library/nodes/Spotify/README.md index 7c3857867..b1dd4c8bf 100644 --- a/docs/nodes/nodes-library/nodes/Spotify/README.md +++ b/docs/nodes/nodes-library/nodes/Spotify/README.md @@ -15,6 +15,7 @@ You can find authentication information for this node [here](../../../credential ::: details Album - Get an album by URI or ID +- Get a list of new album releases - Get an album's tracks by URI or ID ::: @@ -25,6 +26,10 @@ You can find authentication information for this node [here](../../../credential - Get an artist's top tracks by URI or ID ::: +::: details Library +- Get the user's liked tracks +::: + ::: details Player - Add a song to your queue - Get your currently playing track @@ -37,6 +42,7 @@ You can find authentication information for this node [here](../../../credential ::: details Playlist - Add tracks from a playlist by track and playlist URI or ID +- Create a new playlist - Get a playlist by URI or ID - Get a playlist's tracks by URI or ID - Get a user's playlists @@ -69,4 +75,3 @@ The start node exists by default when you create a new workflow. 3. Click on *Execute Node* to run the workflow. ![Spotify URI](./spotifyURI.gif) - diff --git a/docs/nodes/nodes-library/nodes/Telegram/README.md b/docs/nodes/nodes-library/nodes/Telegram/README.md index e52cb8293..80c1223fb 100644 --- a/docs/nodes/nodes-library/nodes/Telegram/README.md +++ b/docs/nodes/nodes-library/nodes/Telegram/README.md @@ -23,13 +23,22 @@ You can find authentication information for this node [here](../../../credential ::: details Callback - Send an answer to a callback query sent from the inline keyboard +- Send an answer to a callback query from inline bot +::: + +::: details File +- Get a file ::: ::: details Message - Edit a text message +- Pin a chat message +- Unpin a chat message +- Send an animated file - Send an audio file - Send a chat action - Send a document +- Send a location - Send a text message - Send a group of photos or videos to an album - Send a photo diff --git a/docs/nodes/nodes-library/nodes/TheHive/README.md b/docs/nodes/nodes-library/nodes/TheHive/README.md index 1ae78584b..80df39cfe 100644 --- a/docs/nodes/nodes-library/nodes/TheHive/README.md +++ b/docs/nodes/nodes-library/nodes/TheHive/README.md @@ -19,6 +19,8 @@ You can find authentication information for this node [here](../../../credential - Execute a responder on a specified alert - Get an alert - Get all alerts +- Mark an alert as read +- Mark an alert as unread - Merge an alert into an existing case - Promote an alert into a case - Update an alert diff --git a/docs/nodes/nodes-library/nodes/Trello/README.md b/docs/nodes/nodes-library/nodes/Trello/README.md index faa6f7ffc..393e99bf1 100644 --- a/docs/nodes/nodes-library/nodes/Trello/README.md +++ b/docs/nodes/nodes-library/nodes/Trello/README.md @@ -35,6 +35,7 @@ You can find authentication information for this node [here](../../../credential ::: ::: details Checklist +- Create a checklist item - Create a new checklist - Delete a checklist - Delete a checklist item diff --git a/docs/nodes/nodes-library/nodes/Twitter/README.md b/docs/nodes/nodes-library/nodes/Twitter/README.md index 484ba2f35..1a4af5558 100644 --- a/docs/nodes/nodes-library/nodes/Twitter/README.md +++ b/docs/nodes/nodes-library/nodes/Twitter/README.md @@ -19,6 +19,7 @@ You can find authentication information for this node [here](../../../credential ::: details Tweet - Create or reply to a tweet +- Delete a tweet - Search tweets - Like a tweet - Retweet a tweet diff --git a/docs/nodes/nodes-library/nodes/uProc/README.md b/docs/nodes/nodes-library/nodes/uProc/README.md index 9067e7670..53896ff2e 100644 --- a/docs/nodes/nodes-library/nodes/uProc/README.md +++ b/docs/nodes/nodes-library/nodes/uProc/README.md @@ -87,6 +87,9 @@ You can find authentication information for this node [here](../../../credential - Send a custom invitation message if a profile is connected or a custom message otherwise - Visits a profile to show interest and get profile views in return from contact, increasing your LinkedIn network - Send a custom private message to a connected LinkedIn profile +- Get an email by contact's LinkedIn profile URI +- Discover an email by company's name and prospect's full name +- Discover an email by company's website or domain and prospect's full name ::: ::: details Company @@ -359,6 +362,7 @@ You can find authentication information for this node [here](../../../credential - Allows checking if an ISBN13 code has a valid format - Check if a UPC exists - Check if a UPC has a valid format +- Get ASIN by EAN - Get a book by author's surname - Get all publications by category - Get book data by an editor's name @@ -368,6 +372,7 @@ You can find authentication information for this node [here](../../../credential - Get all books by category - Get all books by editor - Get all books by title +- Get EAN code by ASIN code - Get product data on a UPC on Amazon Marketplace :::