Merge pull request #1419 from automatisch/AUT-391

feat(xero): add new bank transactions trigger

packages/backend/src/apps/xero/common/auth-scope.ts

@@ -4,6 +4,7 @@ const authScope: string[] = [
   'profile',
   'email',
   'accounting.transactions',
+  'accounting.settings',
 ];
 
 export default authScope;

packages/backend/src/apps/xero/dynamic-data/index.ts

@@ -0,0 +1,3 @@
+import listOrganizations from './list-organizations';
+
+export default [listOrganizations];

packages/backend/src/apps/xero/dynamic-data/list-organizations/index.ts

@@ -0,0 +1,27 @@
+import { IGlobalVariable, IJSONObject } from '@automatisch/types';
+
+export default {
+  name: 'List organizations',
+  key: 'listOrganizations',
+
+  async run($: IGlobalVariable) {
+    const organizations: {
+      data: IJSONObject[];
+    } = {
+      data: [],
+    };
+
+    const { data } = await $.http.get('/api.xro/2.0/Organisation');
+
+    if (data.Organisations?.length) {
+      for (const organization of data.Organisations) {
+        organizations.data.push({
+          value: organization.OrganisationID,
+          name: organization.Name,
+        });
+      }
+    }
+
+    return organizations;
+  },
+};

packages/backend/src/apps/xero/index.ts

@@ -1,6 +1,8 @@
 import defineApp from '../../helpers/define-app';
 import addAuthHeader from './common/add-auth-header';
 import auth from './auth';
+import triggers from './triggers';
+import dynamicData from './dynamic-data';
 
 export default defineApp({
   name: 'Xero',
@@ -13,4 +15,6 @@ export default defineApp({
   supportsConnections: true,
   beforeRequest: [addAuthHeader],
   auth,
+  triggers,
+  dynamicData,
 });

packages/backend/src/apps/xero/triggers/index.ts

@@ -0,0 +1,3 @@
+import newBankTransactions from './new-bank-transactions';
+
+export default [newBankTransactions];

packages/backend/src/apps/xero/triggers/new-bank-transactions/index.ts

@@ -0,0 +1,60 @@
+import defineTrigger from '../../../../helpers/define-trigger';
+
+export default defineTrigger({
+  name: 'New bank transactions',
+  key: 'newBankTransactions',
+  pollInterval: 15,
+  description: 'Triggers when a new bank transaction occurs.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown' as const,
+      required: true,
+      description: '',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const params = {
+      page: 1,
+      order: 'Date DESC',
+    };
+
+    let nextPage = false;
+    do {
+      const { data } = await $.http.get('/api.xro/2.0/BankTransactions', {
+        params,
+      });
+      params.page = params.page + 1;
+
+      if (data.BankTransactions?.length) {
+        for (const bankTransaction of data.BankTransactions) {
+          $.pushTriggerItem({
+            raw: bankTransaction,
+            meta: {
+              internalId: bankTransaction.BankTransactionID,
+            },
+          });
+        }
+      }
+
+      if (data.BankTransactions?.length === 100) {
+        nextPage = true;
+      } else {
+        nextPage = false;
+      }
+    } while (nextPage);
+  },
+});

packages/docs/pages/apps/xero/triggers.md

@@ -0,0 +1,12 @@
+---
+favicon: /favicons/xero.svg
+items:
+  - name: New bank transactions
+    desc: Triggers when a new bank transaction occurs.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />