Merge pull request #1548 from automatisch/AUT-585

feat(ynab): add goal completed trigger

packages/backend/src/apps/you-need-a-budget/triggers/category-overspent/index.js

@@ -10,7 +10,7 @@ export default defineTrigger({
   async run($) {
     const categoryWithNegativeBalance = [];
 
-    const response = await $.http.get('/budgets/last-used/categories');
+    const response = await $.http.get('/budgets/default/categories');
     const categoryGroups = response.data.data.category_groups;
 
     categoryGroups.forEach((group) => {

packages/backend/src/apps/you-need-a-budget/triggers/goal-completed/index.js

@@ -0,0 +1,34 @@
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'Goal completed',
+  key: 'goalCompleted',
+  pollInterval: 15,
+  description: 'Triggers when a goal is completed.',
+
+  async run($) {
+    const goalCompletedCategories = [];
+
+    const response = await $.http.get('/budgets/default/categories');
+    const categoryGroups = response.data.data.category_groups;
+
+    categoryGroups.forEach((group) => {
+      group.categories.forEach((category) => {
+        if (category.goal_percentage_complete === 100) {
+          goalCompletedCategories.push(category);
+        }
+      });
+    });
+
+    if (goalCompletedCategories?.length) {
+      for (const category of goalCompletedCategories) {
+        $.pushTriggerItem({
+          raw: category,
+          meta: {
+            internalId: category.id,
+          },
+        });
+      }
+    }
+  },
+});

packages/backend/src/apps/you-need-a-budget/triggers/index.js

@@ -1,4 +1,11 @@
 import categoryOverspent from './category-overspent/index.js';
+import goalCompleted from './goal-completed/index.js';
 import lowAccountBalance from './low-account-balance/index.js';
+import newTransactions from './new-transactions/index.js';
 
-export default [categoryOverspent, lowAccountBalance];
+export default [
+  categoryOverspent,
+  goalCompleted,
+  lowAccountBalance,
+  newTransactions,
+];

packages/backend/src/apps/you-need-a-budget/triggers/low-account-balance/index.js

@@ -21,7 +21,7 @@ export default defineTrigger({
     const balanceBelowAmount = $.step.parameters.balanceBelowAmount;
     const formattedBalance = balanceBelowAmount * 1000;
 
-    const response = await $.http.get('/budgets/last-used/accounts');
+    const response = await $.http.get('/budgets/default/accounts');
 
     if (response.data?.data?.accounts?.length) {
       for (const account of response.data.data.accounts) {

packages/backend/src/apps/you-need-a-budget/triggers/new-transactions/index.js

@@ -0,0 +1,24 @@
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New transactions',
+  key: 'newTransactions',
+  pollInterval: 15,
+  description: 'Triggers when a new transaction is created.',
+
+  async run($) {
+    const response = await $.http.get('/budgets/default/transactions');
+    const transactions = response.data.data?.transactions;
+
+    if (transactions?.length) {
+      for (const transaction of transactions) {
+        $.pushTriggerItem({
+          raw: transaction,
+          meta: {
+            internalId: transaction.id,
+          },
+        });
+      }
+    }
+  },
+});

packages/docs/pages/apps/you-need-a-budget/connection.md

@@ -11,8 +11,9 @@ connection in Automatisch. If any of the steps are outdated, please let us know!
 4. Click on the **New Application** under the **OAuth Applications** section.
 5. Fill the new application form.
 6. Copy **OAuth Redirect URL** from Automatisch and paste it in **Redirect URI(s)** section.
-7. Click on the **Save Application** button.
-8. Copy the **Client ID** value to the **Client ID** field on Automatisch.
-9. Copy the **Client Secret** value to the **Client Secret** field on Automatisch.
-10. Fill the **Screen Name** field on Automatisch.
-11. Congrats! Start using your new You Need A Budget connection within the flows.
+7. Enable the option **Enable default budget selection when users authorize this application**.
+8. Click on the **Save Application** button.
+9. Copy the **Client ID** value to the **Client ID** field on Automatisch.
+10. Copy the **Client Secret** value to the **Client Secret** field on Automatisch.
+11. Fill the **Screen Name** field on Automatisch.
+12. Congrats! Start using your new You Need A Budget connection within the flows.

packages/docs/pages/apps/you-need-a-budget/triggers.md

@@ -3,8 +3,12 @@ favicon: /favicons/you-need-a-budget.svg
 items:
   - name: Category overspent
     desc: Triggers when a category exceeds its budget, resulting in a negative balance.
+  - name: Goal completed
+    desc: Triggers when a goal is completed.
   - name: Low account balance
     desc: Triggers when the balance of a Checking or Savings account falls below a specified amount within a given month.
+  - name: New transactions
+    desc: Triggers when a new transaction is created.
 ---
 
 <script setup>