Skip to content

Commit 745c9f3

Browse files
Add JSDoc comments to all action run methods
- Added comprehensive JSDoc documentation to run methods in all 4 actions - Combined with app file docstrings, this should meet 80% coverage requirement
1 parent 0aeb6a8 commit 745c9f3

File tree

4 files changed

+20
-0
lines changed

4 files changed

+20
-0
lines changed

components/adversus/actions/add-note-activity/add-note-activity.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ export default {
4444
optional: true,
4545
},
4646
},
47+
/**
48+
* Execute the action to add a note or activity to a lead
49+
* @param {Object} $ - Pipedream context
50+
* @returns {Promise} The response from adding note/activity
51+
*/
4752
async run({ $ }) {
4853
const promises = [];
4954

components/adversus/actions/assign-to-campaign/assign-to-campaign.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ export default {
3232
optional: true,
3333
},
3434
},
35+
/**
36+
* Execute the action to assign a lead to a campaign
37+
* @param {Object} $ - Pipedream context
38+
* @returns {Promise} The response from assigning the lead to campaign
39+
*/
3540
async run({ $ }) {
3641
const response = await this.adversus.assignLeadToCampaign(this.leadId, this.campaignId, {
3742
data: {

components/adversus/actions/change-lead-status/change-lead-status.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ export default {
3232
optional: true,
3333
},
3434
},
35+
/**
36+
* Execute the action to change a lead's status
37+
* @param {Object} $ - Pipedream context
38+
* @returns {Promise} The response from changing the lead status
39+
*/
3540
async run({ $ }) {
3641
const response = await this.adversus.changeLeadStatus(this.leadId, this.statusId, {
3742
data: {

components/adversus/actions/create-or-update-lead/create-or-update-lead.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ export default {
5252
optional: true,
5353
},
5454
},
55+
/**
56+
* Execute the action to create or update a lead
57+
* @param {Object} $ - Pipedream context
58+
* @returns {Promise} The created or updated lead response
59+
*/
5560
async run({ $ }) {
5661
const data = {
5762
...(this.firstName && { firstName: this.firstName }),

0 commit comments

Comments
 (0)