Helpscout new components #17637
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import helpScout from "../../help_scout.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "help_scout-get-conversation-details", | ||
| name: "Get Conversation Details", | ||
| description: "Retrieves the details of a specific conversation. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/conversations/get/)", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| props: { | ||
| helpScout, | ||
| conversationId: { | ||
| propDefinition: [ | ||
| helpScout, | ||
| "conversationId", | ||
| ], | ||
| }, | ||
| embed: { | ||
| type: "boolean", | ||
| label: "Embed", | ||
| description: "If true, the response will include the threads of the conversation.", | ||
| optional: true, | ||
| }, | ||
| }, | ||
| async run({ $ }) { | ||
| const response = await this.helpScout.getConversation({ | ||
| $, | ||
| conversationId: this.conversationId, | ||
| params: { | ||
| embed: this.embed, | ||
| }, | ||
| }); | ||
|
|
||
| $.export("$summary", `Successfully retrieved conversation details (ID: ${this.conversationId})`); | ||
| return response; | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import helpScout from "../../help_scout.app.mjs"; | ||
|
|
||
| export default { | ||
| key: "help_scout-get-conversation-threads", | ||
| name: "Get Conversation Threads", | ||
| description: "Retrieves the threads of a specific conversation. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/list/)", | ||
| version: "0.0.1", | ||
| type: "action", | ||
| props: { | ||
| helpScout, | ||
| conversationId: { | ||
| propDefinition: [ | ||
| helpScout, | ||
| "conversationId", | ||
| ], | ||
| }, | ||
| }, | ||
| async run({ $ }) { | ||
| const response = (await this.helpScout.getConversationThreads({ | ||
| $, | ||
| conversationId: this.conversationId, | ||
| }))?._embedded?.threads; | ||
|
|
||
| $.export("$summary", `Successfully retrieved ${response?.length || 0} threads for conversation ID: ${this.conversationId}`); | ||
| return response; | ||
| }, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import common from "../common/base.mjs"; | ||
| import sampleEmit from "./test-event.mjs"; | ||
|
|
||
| export default { | ||
| ...common, | ||
| key: "help_scout-conversation-status-updated-instant", | ||
| name: "Conversation Status Updated (Instant)", | ||
|
Check warning on line 7 in components/help_scout/sources/conversation-status-updated-instant/conversation-status-updated-instant.mjs
|
||
| description: "Emit new event when a conversation has its status updated. [See the documentation](https://developer.helpscout.com/webhooks/)", | ||
| version: "0.0.1", | ||
| type: "source", | ||
| dedupe: "unique", | ||
| methods: { | ||
| ...common.methods, | ||
| getEventType() { | ||
| return [ | ||
| "convo.status", | ||
| ]; | ||
| }, | ||
| getSummary(body) { | ||
| return `Conversation status updated: ${body.subject} (${body.status})`; | ||
| }, | ||
| }, | ||
| sampleEmit, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| export default { | ||
| "id": 291938, | ||
| "type": "email", | ||
| "folderId": "1234", | ||
| "isDraft": "false", | ||
| "number": 349, | ||
| "owner": { | ||
| "id": 1234, | ||
| "firstName": "Jack", | ||
| "lastName": "Sprout", | ||
| "email": "jack.sprout@gmail.com", | ||
| "phone": null, | ||
| "type": "user" | ||
| }, | ||
| "mailbox": { | ||
| "id": 1234, | ||
| "name": "My Mailbox" | ||
| }, | ||
| "customer": { | ||
| "id": 29418, | ||
| "firstName": "Vernon", | ||
| "lastName": "Bear", | ||
| "email": "vbear@mywork.com", | ||
| "phone": "800-555-1212", | ||
| "type": "customer" | ||
| }, | ||
| "threadCount": 4, | ||
| "status": "closed", | ||
| "subject": "I need help!", | ||
| "preview": "Hello, I tried to download the file off your site...", | ||
| "createdBy": { | ||
| "id": 29418, | ||
| "firstName": "Vernon", | ||
| "lastName": "Bear", | ||
| "email": "vbear@mywork.com", | ||
| "phone": null, | ||
| "type": "customer" | ||
| }, | ||
| "createdAt": "2012-07-23T12:34:12Z", | ||
| "modifiedAt": "2012-07-24T20:18:33Z", | ||
| "closedAt": "2012-07-24T20:18:33Z", | ||
| "closedBy": { | ||
| "id": 1234, | ||
| "firstName": "Jack", | ||
| "lastName": "Sprout", | ||
| "email": "jack.sprout@gmail.com", | ||
| "phone": null, | ||
| "type": "user" | ||
| }, | ||
| "source": { | ||
| "type": "email", | ||
| "via": "customer" | ||
| }, | ||
| "cc": [ | ||
| "cc1@somewhere.com", | ||
| "cc2@somewhere.com" | ||
| ], | ||
| "bcc": [ | ||
| "bcc1@somewhere.com", | ||
| "bcc2@somewhere.com" | ||
| ], | ||
| "tags": [ | ||
| "tag1", | ||
| "tag2" | ||
| ], | ||
| "customFields": [ | ||
| { | ||
| "fieldId": 1, | ||
| "name": "Team", | ||
| "value": "Development" | ||
| }, | ||
| { | ||
| "fieldId": 2, | ||
| "name": "Customer Disposition", | ||
| "value": "Happy" | ||
| } | ||
| ], | ||
| "threads": [ | ||
| { | ||
| "id": 88171881, | ||
| "assignedTo": { | ||
| "id": 1234, | ||
| "firstName": "Jack", | ||
| "lastName": "Sprout", | ||
| "email": "jack.sprout@gmail.com", | ||
| "phone": null, | ||
| "type": "user" | ||
| }, | ||
| "status": "closed", | ||
| "createdAt": "2012-07-23T12:34:12Z", | ||
| "createdBy": { | ||
| "id": 1234, | ||
| "firstName": "Jack", | ||
| "lastName": "Sprout", | ||
| "email": "jack.sprout@gmail.com", | ||
| "phone": null, | ||
| "type": "user" | ||
| }, | ||
| "source": { | ||
| "type": "web", | ||
| "via": "user" | ||
| }, | ||
| "type": "message", | ||
| "state": "published", | ||
| "customer": { | ||
| "id": 29418, | ||
| "firstName": "Vernon", | ||
| "lastName": "Bear", | ||
| "email": "vbear@mywork.com", | ||
| "phone": "800-555-1212", | ||
| "type": "customer" | ||
| }, | ||
| "fromMailbox": null, | ||
| "body": "This is what I have to say. Thank you.", | ||
| "to": [ | ||
| "customer@somewhere.com" | ||
| ], | ||
| "cc": [ | ||
| "cc1@somewhere.com", | ||
| "cc2@somewhere.com" | ||
| ], | ||
| "bcc": [ | ||
| "bcc1@somewhere.com", | ||
| "bcc2@somewhere.com" | ||
| ], | ||
| "attachments": [ | ||
| { | ||
| "id": 12391, | ||
| "mimeType": "image/jpeg", | ||
| "filename": "logo.jpg", | ||
| "size": 22, | ||
| "width": 160, | ||
| "height": 160, | ||
| "url": "https://secure.helpscout.net/some-url/logo.jpg" | ||
| } | ||
| ], | ||
| "tags": [ | ||
| "tag1", | ||
| "tag2", | ||
| "tag3" | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks from the docs like maybe this can be paginated? If so, we should offer a
maxResultsprop and return a paginated list.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call - it seems the Helpscout API only supports passing a 'page' parameter though, and the page size for this endpoint is fixed at 25 entries. I've added a 'page' prop with this information so users can retrieve older entries if needed