You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Avoid manual truthiness checks for optional parameters, as @pipedream/platform utilities (@pipedream/axios) automatically exclude undefined values.
8
+
- Use the Breeze API documentation at https://www.breeze.pm/api as the primary reference for all implementation details.
9
+
- Make sure to define and set the annotations property of the components.
10
+
11
+
### API Call Guidelines
12
+
- Always wrap API calls with the `_makeRequest` method.
13
+
- Component methods must call **wrappers** of `_makeRequest`.
14
+
- **Never** call `axios` directly in component methods.
15
+
- **Never** call `_makeRequest` directly in component methods.
16
+
17
+
### Prop Type Guidelines
18
+
- Do not use the `"number"` datatype in props. Use `"string"` instead when representing numeric values.
19
+
- Valid datatypes for props are `"string"`, `"integer"`, `"string[]"`, `"object"`, `"boolean"`
20
+
21
+
### Boolean Handling
22
+
- When API documentation uses `"string"` or `"integer"` values to simulate booleans (e.g., `1` for `true`, `"true"` as a string), define the corresponding props using the native `boolean` type.
23
+
24
+
This applies to:
25
+
1. **Prop type definition** → Use `boolean` for clarity and semantic accuracy.
26
+
2. **Default values and options** → Express as `true` or `false`, not simulated values.
27
+
28
+
Within the component logic, convert the `boolean` prop into the format expected by the API (e.g., `1`/`0` or `"true"`/`"false"`).
- In the package.json file essentially you'll only set the dependencies property, set version prop to "0.1.0", you can refer to the following example that was created for Leonardo AI components:
35
+
```
36
+
{
37
+
"name": "@pipedream/leonardo_ai",
38
+
"version": "0.1.0",
39
+
"description": "Pipedream Leonardo AI Components",
--as a reference of an example API call to Breeze, including authorization, you can use the one we feature at Pipedream. Remember, you'll wrap API calls inside _makeRequest and action, source methods need to call _makeRequest.
57
+
```
58
+
import { axios } from "@pipedream/platform"
59
+
export default defineComponent({
60
+
props: {
61
+
breeze: {
62
+
type: "app",
63
+
app: "breeze",
64
+
}
65
+
},
66
+
async run({steps, $}) {
67
+
return await axios($, {
68
+
url: `https://api.breeze.pm/me.json`,
69
+
params: {
70
+
api_token: `${this.breeze.$auth.api_token}`,
71
+
},
72
+
})
73
+
},
74
+
})
75
+
```
76
+
--For each prop that is used more than one create a propDefinition for it and reuse it in component code, changing description, detaults as needed.
77
+
--For props that handle date values, if a specific format is required, ensure prop descriptions has the format string is enclosed in backticks to enhance clarity and readability. For example:
78
+
```ts
79
+
description: "Only retrieve events that start AFTER the specified UTC date (format: `YYYY-MM-DD`)."
80
+
```
81
+
- When writing descriptions for props of type `boolean`, always be explicit about the conditional behavior by including phrases like **“If true,”** or **“If false,”** rather than leaving the logic implicit. For example:
82
+
```ts
83
+
description: "If true, returns associated performers/artists with the event."
84
+
```
85
+
is preferred over:
86
+
```ts
87
+
description: "Returns any associated performers/artists with the event."
88
+
89
+
**Polling Sources**
90
+
new-task
91
+
Prompt: Emit new event when a new task is created.
92
+
- Require a `project_id` prop which the new task needs to be associated with.
93
+
- Dynamic options must be populated via the **Get Projects** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20projects)).
94
+
95
+
task-moved
96
+
Prompt: Emit new event when a task is moved to another list. Required prop 'taskID' to identify the task.
97
+
- Dynamic options for 'taskID' must be populated via the **Get lists** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20cards)).
98
+
99
+
task-status-updated
100
+
Prompt: Emit new event when a task's status is updated. Required prop 'taskID' to identify the task.
101
+
- Dynamic options for 'taskID' must be populated via the **Get lists** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20cards)).
102
+
103
+
**Actions**
104
+
create-task
105
+
Prompt: Generates a new task within an existing project in breeze. Required props: 'project ID', 'task name'. Optional props: 'task description', 'due date'.
106
+
-When you come up for the description for this component follow format: <component description>. [See documentation](https://www.breeze.pm/api#:~:text=Create%20a%20card)
107
+
This action should:
108
+
- Require a `stage_id` parameter to associate the task to.
109
+
- Dynamic options must be populated via the **Get lists** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20lists)).
110
+
- Require a `swimlane_id` parameter to associate the task to.
111
+
- Dynamic options must be populated via the **Get Swimlanes** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20swimlanes)).
112
+
113
+
create-project
114
+
Prompt: Establishes a new project in breeze. Required props: 'project name'. Optional props: 'project description', 'start date', 'end date'.
115
+
-When you come up for the description for this component follow format: <component description>. [See documentation](https://www.breeze.pm/api#:~:text=Create%20a%20project
116
+
)
117
+
This action should:https://www.breeze.pm/api#:~:text=Get%20swimlanes)
118
+
- Require a `workspace_id` parameter to associate the project to.
119
+
- Dynamic options must be populated via the **Get a Workspaces** endpoint ([docs](https://www.breeze.pm/api#:~:text=Get%20a%20workspaces)).
120
+
121
+
find-project
122
+
Prompt: Searches for a specific project in breeze using the name. Required props: 'project name'.
123
+
-When you come up for the description for this component follow format: <component description>. [See documentation](https://www.breeze.pm/api#:~:text=Get%20Projects)
0 commit comments