[ACTION] Toggl Client & Project Creation #8973
Closed
Conversation
This file contains 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
Co-authored-by: gitstart <[email protected]>
Co-authored-by: gitstart <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dylburger
added
the
triaged
|
Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified. |
|
Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:
|
GTFalcao
reviewed
Nov 15, 2023
| workspace_id: this.workspace_id, | ||
| }) | ||
|
|
||
| response && $.export("$summary", "Successfully created new client"); |
There was a problem hiding this comment.
I think the response should be the return value of the step
Suggested change
| response && $.export("$summary", "Successfully created new client"); | |
| response && $.export("$summary", "Successfully created new client"); | |
| return response; |
| type: "string", | ||
| label: "Name", | ||
| }, | ||
| workspace_id: { |
There was a problem hiding this comment.
We should use camelCase for prop names
| import toggl from "../../toggl.app.mjs"; | ||
|
|
||
| export default { | ||
| name: "Create a new client", |
There was a problem hiding this comment.
Suggested change
| name: "Create a new client", | |
| name: "Create Client", |
| version: "0.0.1", | ||
| description: "Create a new Client [See docs here.](https://developers.track.toggl.com/docs/api/clients/index.html#post-create-client)", | ||
| type: "action", | ||
| key: "toggle-create-new-client", |
There was a problem hiding this comment.
Suggested change
| key: "toggle-create-new-client", | |
| key: "toggle-create-client", |
Comment on lines
+11
to
+15
| name: { | ||
| type: "string", | ||
| label: "Name", | ||
| }, | ||
| workspace_id: { |
There was a problem hiding this comment.
We should add descriptions, even if very brief, to these props if possible
| type: 'boolean', | ||
| label: 'Auto Estimates', | ||
| optional: true, | ||
| description: "whether the estimated hours are automatically calculated based on task estimations or manually fixed based on the value of 'estimated_hours' (premium functionality) ", |
There was a problem hiding this comment.
Suggested change
| description: "whether the estimated hours are automatically calculated based on task estimations or manually fixed based on the value of 'estimated_hours' (premium functionality) ", | |
| description: "Whether the estimated hours are automatically calculated based on task estimations or manually fixed based on the value of `Estimated Hours` (premium functionality) ", |
| type: 'boolean', | ||
| label: 'Estimated Hours', | ||
| optional: true, | ||
| description: "if auto_estimates is true then the sum of task estimations is returned, otherwise user inserted hours (premium functionality)" |
There was a problem hiding this comment.
Suggested change
| description: "if auto_estimates is true then the sum of task estimations is returned, otherwise user inserted hours (premium functionality)" | |
| description: "If `Auto Estimates` is true then the sum of task estimations is returned, otherwise user inserted hours (premium functionality)" |
Comment on lines
+78
to
+105
| rate: { | ||
| type: 'integer', | ||
| label: 'Rate', | ||
| description: 'Hourly Rate. premium feature', | ||
| optional: true, | ||
| }, | ||
| fixed_fee: { | ||
| type: 'integer', | ||
| label: 'Rate', | ||
| description: 'Project fixed fee. premium feature', | ||
| optional: true, | ||
| }, | ||
| currency: { | ||
| type: 'string', | ||
| label: 'Currency', | ||
| description: 'Project currency. premium feature', | ||
| optional: true, | ||
| }, | ||
| start_date: { | ||
| type: 'string', | ||
| label: 'Start Date', | ||
| description: 'Start date of a project timeframe', | ||
| }, | ||
| end_date: { | ||
| type: 'string', | ||
| label: 'End Date', | ||
| description: 'End date of a project timeframe', | ||
| }, |
There was a problem hiding this comment.
camelCase and capitalization after periods
| import toggl from "../../toggl.app.mjs"; | ||
|
|
||
| export default { | ||
| name: "Update a Project", |
There was a problem hiding this comment.
Suggested change
| name: "Update a Project", | |
| name: "Update Project", |
| description: "Update project for given workspace. [See docs here.](https://developers.track.toggl.com/docs/api/projects#post-workspaceprojects)", | ||
| type: "action", | ||
| key: "toggle-update-project", | ||
| props: { |
There was a problem hiding this comment.
These props also need to be updated with camelCase and proper capitalization
lcaresia
approved these changes
Nov 16, 2023
| color: { | ||
| type: 'string', | ||
| label: 'Color', | ||
| description: 'Project color (hex value in the form of #[0-9a-f]{6}.)', |
There was a problem hiding this comment.
Suggested change
| description: 'Project color (hex value in the form of #[0-9a-f]{6}.)', | |
| description: 'Project color (hex value in the form of #[0-9a-f]{6}.)', | |
| optional: true |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
WHAT
closes: #7928
🤖 Generated by Copilot at 8013b58
This pull request adds four new actions to the
togglcomponent that allow the user to create and update clients and projects in toggl using the API. It also creates a new component for the dictionary API by copying and modifying the.gitignorefiles from several existing components.🤖 Generated by Copilot at 8013b58
WHY
Actions:
Create new client / Update client
https://developers.track.toggl.com/docs/api/clients
Create project / Update project
https://developers.track.toggl.com/docs/api/projects
HOW
🤖 Generated by Copilot at 8013b58
components/toggl/common/constants.mjsfile (link)components/toggl/toggl.app.mjsfile that implements the API request using the_makeRequesthelper method (link).gitignorefile from various existing components and comment out the lines that ignore the.jsand.mjsfiles to allow them to be tracked by git (link, link, link, link, link, link)Demo Video (Create & update client):
https://www.loom.com/share/791aebcf943a46a7a9e06e93835bfc28?sid=c70cb3fa-2fa6-4124-98c7-7efb75b38ff6
Demo Video (Create & update project):
https://www.loom.com/share/e6bfd8cbae81478e8eb17e7383174cf6?sid=233cb8da-1fbb-46d5-b4db-4ec2349c8b2a
This code was written and reviewed by GitStart Community. Growing great engineers, one PR at a time.