feat(bigin-by-zoho-crm): add create contact action

packages/backend/src/apps/bigin-by-zoho-crm/actions/create-contact/index.js

@@ -0,0 +1,217 @@
+import defineAction from '../../../../helpers/define-action.js';
+
+export default defineAction({
+  name: 'Create contact',
+  key: 'createContact',
+  description: 'Creates a new contact.',
+  arguments: [
+    {
+      label: 'Contact Owner',
+      key: 'contactOwnerId',
+      type: 'dropdown',
+      required: false,
+      description: '',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listContactOwners',
+          },
+        ],
+      },
+    },
+    {
+      label: 'First Name',
+      key: 'firstName',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Last Name',
+      key: 'lastName',
+      type: 'string',
+      required: true,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Title',
+      key: 'title',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Email',
+      key: 'email',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Company ID',
+      key: 'companyId',
+      type: 'dropdown',
+      required: false,
+      description: '',
+      variables: true,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listCompanies',
+          },
+        ],
+      },
+    },
+    {
+      label: 'Mobile',
+      key: 'mobile',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Email Opt Out',
+      key: 'emailOptOut',
+      type: 'dropdown',
+      required: false,
+      description: '',
+      variables: true,
+      options: [
+        { label: 'True', value: true },
+        { label: 'False', value: false },
+      ],
+    },
+    {
+      label: 'Tags',
+      key: 'tags',
+      type: 'dynamic',
+      required: false,
+      description: '',
+      fields: [
+        {
+          label: 'Tag',
+          key: 'tag',
+          type: 'string',
+          required: false,
+          variables: true,
+        },
+      ],
+    },
+    {
+      label: 'Description',
+      key: 'description',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Mailing Street',
+      key: 'mailingStreet',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Mailing City',
+      key: 'mailingCity',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Mailing State',
+      key: 'mailingState',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Mailing Country',
+      key: 'mailingCountry',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+    {
+      label: 'Mailing Zip',
+      key: 'mailingZip',
+      type: 'string',
+      required: false,
+      description: '',
+      variables: true,
+    },
+  ],
+
+  async run($) {
+    const {
+      contactOwnerId,
+      firstName,
+      lastName,
+      title,
+      email,
+      companyId,
+      mobile,
+      emailOptOut,
+      tags,
+      description,
+      mailingStreet,
+      mailingCity,
+      mailingState,
+      mailingCountry,
+      mailingZip,
+    } = $.step.parameters;
+
+    const allTags = tags.map((tag) => ({
+      name: tag.tag,
+    }));
+
+    const body = {
+      data: [
+        {
+          Owner: {
+            id: contactOwnerId,
+          },
+          Account_Name: {
+            id: companyId,
+          },
+          First_Name: firstName,
+          Last_Name: lastName,
+          Title: title,
+          Email: email,
+          Mobile: mobile,
+          Email_Opt_Out: emailOptOut,
+          Tag: allTags,
+          Description: description,
+          Mailing_Street: mailingStreet,
+          Mailing_City: mailingCity,
+          Mailing_State: mailingState,
+          Mailing_Country: mailingCountry,
+          Mailing_Zip: mailingZip,
+        },
+      ],
+    };
+
+    const { data } = await $.http.post(`/bigin/v2/Contacts`, body);
+
+    $.setActionItem({
+      raw: data[0],
+    });
+  },
+});

packages/backend/src/apps/bigin-by-zoho-crm/actions/index.js

@@ -0,0 +1,3 @@
+import createContact from './create-contact/index.js';
+
+export default [createContact];

packages/backend/src/apps/bigin-by-zoho-crm/dynamic-data/index.js

@@ -0,0 +1,5 @@
+import listCompanies from './list-companies/index.js';
+import listOrganizations from './list-organizations/index.js';
+import listContactOwners from './list-contact-owners/index.js';
+
+export default [listCompanies, listOrganizations, listContactOwners];

packages/backend/src/apps/bigin-by-zoho-crm/dynamic-data/list-companies/index.js

@@ -0,0 +1,39 @@
+export default {
+  name: 'List companies',
+  key: 'listCompanies',
+
+  async run($) {
+    const companies = {
+      data: [],
+    };
+
+    const params = new URLSearchParams({
+      page: 1,
+      pageSize: 200,
+      fields: 'Account_Name',
+    });
+
+    let next = false;
+    do {
+      const { data } = await $.http.get('/bigin/v2/Accounts', { params });
+
+      if (data.info.more_records) {
+        params.page = params.page + 1;
+        next = true;
+      } else {
+        next = false;
+      }
+
+      if (data.data) {
+        for (const account of data.data) {
+          companies.data.push({
+            value: account.id,
+            name: account.Account_Name,
+          });
+        }
+      }
+    } while (next);
+
+    return companies;
+  },
+};

packages/backend/src/apps/bigin-by-zoho-crm/dynamic-data/list-contact-owners/index.js

@@ -0,0 +1,39 @@
+export default {
+  name: 'List contact owners',
+  key: 'listContactOwners',
+
+  async run($) {
+    const contactOwners = {
+      data: [],
+    };
+
+    const params = {
+      type: 'AllUsers',
+      page: 1,
+      pageSize: 200,
+    };
+
+    let next = false;
+    do {
+      const { data } = await $.http.get('/bigin/v2/users', params);
+
+      if (data.users.length === params.pageSize) {
+        next = true;
+        params.page = params.page + 1;
+      } else {
+        next = false;
+      }
+
+      if (data.users) {
+        for (const user of data.users) {
+          contactOwners.data.push({
+            value: user.id,
+            name: user.full_name,
+          });
+        }
+      }
+    } while (next);
+
+    return contactOwners;
+  },
+};

packages/backend/src/apps/bigin-by-zoho-crm/dynamic-data/list-organizations/index.js

@@ -0,0 +1,23 @@
+export default {
+  name: 'List organizations',
+  key: 'listOrganizations',
+
+  async run($) {
+    const organizations = {
+      data: [],
+    };
+
+    const { data } = await $.http.get('/bigin/v2/org');
+
+    if (data.org) {
+      for (const org of data.org) {
+        organizations.data.push({
+          value: org.id,
+          name: org.company_name,
+        });
+      }
+    }
+
+    return organizations;
+  },
+};

packages/backend/src/apps/bigin-by-zoho-crm/index.js

@@ -2,6 +2,9 @@ import defineApp from '../../helpers/define-app.js';
 import addAuthHeader from './common/add-auth-header.js';
 import auth from './auth/index.js';
 import setBaseUrl from './common/set-base-url.js';
+import triggers from './triggers/index.js';
+import dynamicData from './dynamic-data/index.js';
+import actions from './actions/index.js';
 
 export default defineApp({
   name: 'Bigin By Zoho CRM',
@@ -14,4 +17,7 @@ export default defineApp({
   supportsConnections: true,
   beforeRequest: [setBaseUrl, addAuthHeader],
   auth,
+  triggers,
+  dynamicData,
+  actions,
 });

packages/backend/src/apps/bigin-by-zoho-crm/triggers/index.js

@@ -0,0 +1,7 @@
+import newCalls from './new-calls/index.js';
+import newCompanies from './new-companies/index.js';
+import newContacts from './new-contacts/index.js';
+import newProducts from './new-products/index.js';
+import newTasks from './new-tasks/index.js';
+
+export default [newCalls, newCompanies, newContacts, newProducts, newTasks];

packages/backend/src/apps/bigin-by-zoho-crm/triggers/new-calls/index.js

@@ -0,0 +1,89 @@
+import Crypto from 'crypto';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New calls',
+  key: 'newCalls',
+  type: 'webhook',
+  description: 'Triggers when a new call is added.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: false,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const sampleEventData = {
+      ids: ['111111111111111111'],
+      token: null,
+      module: 'Calls',
+      operation: 'insert',
+      channel_id: organizationId,
+      server_time: 1708426963120,
+      query_params: {},
+      resource_uri: `${$.auth.data.apiDomain}/bigin/v1/Calls`,
+      affected_fields: [],
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.channel_id,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const payload = {
+      watch: [
+        {
+          channel_id: organizationId,
+          notify_url: $.webhookUrl,
+          events: ['Calls.create'],
+        },
+      ],
+    };
+
+    await $.http.post('/bigin/v2/actions/watch', payload);
+
+    await $.flow.setRemoteWebhookId(organizationId);
+  },
+
+  async unregisterHook($) {
+    await $.http.delete(
+      `/bigin/v2/actions/watch?channel_ids=${$.flow.remoteWebhookId}`
+    );
+  },
+});

packages/backend/src/apps/bigin-by-zoho-crm/triggers/new-companies/index.js

@@ -0,0 +1,89 @@
+import Crypto from 'crypto';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New companies',
+  key: 'newCompanies',
+  type: 'webhook',
+  description: 'Triggers when a new company is created.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: false,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const sampleEventData = {
+      ids: ['111111111111111111'],
+      token: null,
+      module: 'Accounts',
+      operation: 'insert',
+      channel_id: organizationId,
+      server_time: 1708426963120,
+      query_params: {},
+      resource_uri: `${$.auth.data.apiDomain}/bigin/v1/Accounts`,
+      affected_fields: [],
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.channel_id,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const payload = {
+      watch: [
+        {
+          channel_id: organizationId,
+          notify_url: $.webhookUrl,
+          events: ['Accounts.create'],
+        },
+      ],
+    };
+
+    await $.http.post('/bigin/v2/actions/watch', payload);
+
+    await $.flow.setRemoteWebhookId(organizationId);
+  },
+
+  async unregisterHook($) {
+    await $.http.delete(
+      `/bigin/v2/actions/watch?channel_ids=${$.flow.remoteWebhookId}`
+    );
+  },
+});

packages/backend/src/apps/bigin-by-zoho-crm/triggers/new-contacts/index.js

@@ -0,0 +1,89 @@
+import Crypto from 'crypto';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New contacts',
+  key: 'newContacts',
+  type: 'webhook',
+  description: 'Triggers when a new contact is created.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: false,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const sampleEventData = {
+      ids: ['111111111111111111'],
+      token: null,
+      module: 'Contacts',
+      operation: 'insert',
+      channel_id: organizationId,
+      server_time: 1708426963120,
+      query_params: {},
+      resource_uri: `${$.auth.data.apiDomain}/bigin/v1/Contacts`,
+      affected_fields: [],
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.channel_id,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const payload = {
+      watch: [
+        {
+          channel_id: organizationId,
+          notify_url: $.webhookUrl,
+          events: ['Contacts.create'],
+        },
+      ],
+    };
+
+    await $.http.post('/bigin/v2/actions/watch', payload);
+
+    await $.flow.setRemoteWebhookId(organizationId);
+  },
+
+  async unregisterHook($) {
+    await $.http.delete(
+      `/bigin/v2/actions/watch?channel_ids=${$.flow.remoteWebhookId}`
+    );
+  },
+});

packages/backend/src/apps/bigin-by-zoho-crm/triggers/new-products/index.js

@@ -0,0 +1,89 @@
+import Crypto from 'crypto';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New products',
+  key: 'newProducts',
+  type: 'webhook',
+  description: 'Triggers when a new product is created.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: false,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const sampleEventData = {
+      ids: ['111111111111111111'],
+      token: null,
+      module: 'Products',
+      operation: 'insert',
+      channel_id: organizationId,
+      server_time: 1708426963120,
+      query_params: {},
+      resource_uri: `${$.auth.data.apiDomain}/bigin/v1/Products`,
+      affected_fields: [],
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.channel_id,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const payload = {
+      watch: [
+        {
+          channel_id: organizationId,
+          notify_url: $.webhookUrl,
+          events: ['Products.create'],
+        },
+      ],
+    };
+
+    await $.http.post('/bigin/v2/actions/watch', payload);
+
+    await $.flow.setRemoteWebhookId(organizationId);
+  },
+
+  async unregisterHook($) {
+    await $.http.delete(
+      `/bigin/v2/actions/watch?channel_ids=${$.flow.remoteWebhookId}`
+    );
+  },
+});

packages/backend/src/apps/bigin-by-zoho-crm/triggers/new-tasks/index.js

@@ -0,0 +1,89 @@
+import Crypto from 'crypto';
+import defineTrigger from '../../../../helpers/define-trigger.js';
+
+export default defineTrigger({
+  name: 'New tasks',
+  key: 'newTasks',
+  type: 'webhook',
+  description: 'Triggers when a new task is created.',
+  arguments: [
+    {
+      label: 'Organization',
+      key: 'organizationId',
+      type: 'dropdown',
+      required: true,
+      description: '',
+      variables: false,
+      source: {
+        type: 'query',
+        name: 'getDynamicData',
+        arguments: [
+          {
+            name: 'key',
+            value: 'listOrganizations',
+          },
+        ],
+      },
+    },
+  ],
+
+  async run($) {
+    const dataItem = {
+      raw: $.request.body,
+      meta: {
+        internalId: Crypto.randomUUID(),
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async testRun($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const sampleEventData = {
+      ids: ['111111111111111111'],
+      token: null,
+      module: 'Tasks',
+      operation: 'insert',
+      channel_id: organizationId,
+      server_time: 1708426963120,
+      query_params: {},
+      resource_uri: `${$.auth.data.apiDomain}/bigin/v1/Tasks`,
+      affected_fields: [],
+    };
+
+    const dataItem = {
+      raw: sampleEventData,
+      meta: {
+        internalId: sampleEventData.channel_id,
+      },
+    };
+
+    $.pushTriggerItem(dataItem);
+  },
+
+  async registerHook($) {
+    const organizationId = $.step.parameters.organizationId;
+
+    const payload = {
+      watch: [
+        {
+          channel_id: organizationId,
+          notify_url: $.webhookUrl,
+          events: ['Tasks.create'],
+        },
+      ],
+    };
+
+    await $.http.post('/bigin/v2/actions/watch', payload);
+
+    await $.flow.setRemoteWebhookId(organizationId);
+  },
+
+  async unregisterHook($) {
+    await $.http.delete(
+      `/bigin/v2/actions/watch?channel_ids=${$.flow.remoteWebhookId}`
+    );
+  },
+});

packages/docs/pages/.vitepress/config.js

@@ -37,6 +37,8 @@ export default defineConfig({
           collapsible: true,
           collapsed: true,
           items: [
+            { text: 'Triggers', link: '/apps/bigin-by-zoho-crm/triggers' },
+            { text: 'Actions', link: '/apps/bigin-by-zoho-crm/actions' },
             { text: 'Connection', link: '/apps/bigin-by-zoho-crm/connection' },
           ],
         },

packages/docs/pages/apps/bigin-by-zoho-crm/actions.md

@@ -0,0 +1,12 @@
+---
+favicon: /favicons/bigin-by-zoho-crm.svg
+items:
+  - name: Create contact
+    desc: Creates a new contact.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />

packages/docs/pages/apps/bigin-by-zoho-crm/triggers.md

@@ -0,0 +1,20 @@
+---
+favicon: /favicons/bigin-by-zoho-crm.svg
+items:
+  - name: New calls
+    desc: Triggers when a new call is added.
+  - name: New companies
+    desc: Triggers when a new company is created.
+  - name: New contacts
+    desc: Triggers when a new contact is created.
+  - name: New products
+    desc: Triggers when a new product is created.
+  - name: New tasks
+    desc: Triggers when a new task is created.
+---
+
+<script setup>
+  import CustomListing from '../../components/CustomListing.vue'
+</script>
+
+<CustomListing />

packages/docs/pages/guide/available-apps.md

@@ -2,6 +2,7 @@
 
 The following integrations are currently supported by Automatisch.
 
+- [Bigin By Zoho CRM](/apps/bigin-by-zoho-crm/triggers)
 - [Carbone](/apps/carbone/actions)
 - [DeepL](/apps/deepl/actions)
 - [Delay](/apps/delay/actions)