@pipedream/bloomerang 0.0.1 → 0.1.1

package/actions/add-interaction/add-interaction.mjs

@@ -0,0 +1,77 @@
+import bloomerang from "../../bloomerang.app.mjs";
+import {
+  CHANNEL_OPTIONS, PURPOSE_OPTIONS,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "bloomerang-add-interaction",
+  name: "Add Interaction",
+  description: "Adds an interaction to an existing constituent in Bloomerang. [See the documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Interactions/post_interaction)",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    bloomerang,
+    constituentId: {
+      propDefinition: [
+        bloomerang,
+        "constituentId",
+      ],
+    },
+    date: {
+      type: "string",
+      label: "Date",
+      description: "The date of the interaction",
+    },
+    subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject of the interaction",
+    },
+    channel: {
+      type: "string",
+      label: "Channel",
+      description: "The channel of the interaction",
+      options: CHANNEL_OPTIONS,
+    },
+    purpose: {
+      type: "string",
+      label: "Purpose",
+      description: "The purpose of the interaction",
+      options: PURPOSE_OPTIONS,
+    },
+    note: {
+      type: "string",
+      label: "Note",
+      description: "Note for the interaction",
+      optional: true,
+    },
+    isInbound: {
+      type: "boolean",
+      label: "Is Inbound",
+      description: "Was the interaction initiated by constituent?",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.bloomerang.createInteraction({
+      $,
+      data: {
+        AccountId: this.constituentId,
+        Date: this.date,
+        Subject: this.subject,
+        Channel: this.channel,
+        Purpose: this.purpose,
+        note: this.note,
+        IsInbound: this.isInbound,
+      },
+    });
+
+    $.export("$summary", `Successfully added interaction with ID ${response.Id}`);
+    return response;
+  },
+};

package/actions/create-constituent/create-constituent.mjs

@@ -0,0 +1,172 @@
+import bloomerang from "../../bloomerang.app.mjs";
+import {
+  COMMUNICATION_CHANNEL_OPTIONS,
+  CONSTITUENT_GENDER_OPTIONS,
+  CONSTITUENT_PREFIX_OPTIONS,
+  CONSTITUENT_STATUS_OPTIONS,
+  CONSTITUENT_SUFFIX_OPTIONS,
+  CONSTITUENT_TYPE_OPTIONS,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "bloomerang-create-constituent",
+  name: "Create Constituent",
+  description: "Creates a new constituent in Bloomerang. [See the documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    bloomerang,
+    type: {
+      type: "string",
+      label: "Constituent Type",
+      description: "Filter constituents by type",
+      options: CONSTITUENT_TYPE_OPTIONS,
+      reloadProps: true,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The status of the constituent",
+      options: CONSTITUENT_STATUS_OPTIONS,
+      optional: true,
+    },
+    fullName: {
+      type: "string",
+      label: "Organization Name",
+      description: "The organization's name of the constituent",
+      hidden: true,
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The first name of the constituent",
+      hidden: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The last name of the constituent",
+      hidden: true,
+    },
+    middleName: {
+      type: "string",
+      label: "Middle Name",
+      description: "The middle name of the constituent",
+      optional: true,
+    },
+    prefix: {
+      type: "string",
+      label: "Title",
+      description: "The prefix of the constituent",
+      options: CONSTITUENT_PREFIX_OPTIONS,
+      optional: true,
+    },
+    suffix: {
+      type: "string",
+      label: "Suffix",
+      description: "The suffix of the constituent",
+      options: CONSTITUENT_SUFFIX_OPTIONS,
+      optional: true,
+    },
+    jobTitle: {
+      type: "string",
+      label: "Job Title",
+      description: "The job title of the constituent",
+      optional: true,
+    },
+    gender: {
+      type: "string",
+      label: "Gender",
+      description: "The gender of the constituent",
+      options: CONSTITUENT_GENDER_OPTIONS,
+      optional: true,
+    },
+    birthdate: {
+      type: "string",
+      label: "Birthdate",
+      description: "The birth date of the constituent",
+      optional: true,
+    },
+    employer: {
+      type: "string",
+      label: "Employer",
+      description: "The employer of the constituent",
+      optional: true,
+    },
+    website: {
+      type: "string",
+      label: "Website",
+      description: "An website of the constituent",
+      optional: true,
+    },
+    facebookId: {
+      type: "string",
+      label: "Facebook",
+      description: "The constituent's facebook page",
+      optional: true,
+    },
+    twitterId: {
+      type: "string",
+      label: "Twitter ID",
+      description: "The constituent's twitter ID",
+      optional: true,
+    },
+    linkedInId: {
+      type: "string",
+      label: "LinkedIn",
+      description: "The constituent's linkedIn page",
+      optional: true,
+    },
+    preferredCommunicationChannel: {
+      type: "string",
+      label: "Preferred Communication Channel",
+      description: "The preferred comunication channel of the constituent",
+      options: COMMUNICATION_CHANNEL_OPTIONS,
+      optional: true,
+    },
+  },
+  async additionalProps(props) {
+    const isIndividual = this.type === "Individual";
+    props.firstName.hidden = !isIndividual;
+    props.lastName.hidden = !isIndividual;
+    props.fullName.hidden = isIndividual;
+    return {};
+  },
+  async run({ $ }) {
+    const data = {
+      Type: this.type,
+      Status: this.status,
+      Prefix: this.prefix,
+      Suffix: this.suffix,
+      JobTitle: this.jobTitle,
+      Gender: this.gender,
+      Birthdate: this.birthdate,
+      Employer: this.employer,
+      Website: this.website,
+      FacebookId: this.facebookId,
+      TwitterId: this.twitterId,
+      LinkedInId: this.linkedInId,
+      PreferredCommunicationChannel: this.preferredCommunicationChannel,
+    };
+    if (this.type === "Individual") {
+      data.FirstName = this.firstName;
+      data.LastName = this.lastName;
+      data.MiddleName = this.middleName;
+    } else {
+      data.FullName = this.fullName;
+    }
+
+    const response = await this.bloomerang.createConstituent({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created constituent with ID ${response.Id}`);
+    return response;
+  },
+};

package/actions/create-donation/create-donation.mjs

@@ -0,0 +1,90 @@
+import bloomerang from "../../bloomerang.app.mjs";
+import { PAYMENT_METHOD_OPTIONS } from "../../common/constants.mjs";
+
+export default {
+  key: "bloomerang-create-donation",
+  name: "Create Donation",
+  description: "Creates a new donation record in Bloomerang. [See the documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api/)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    bloomerang,
+    constituentId: {
+      propDefinition: [
+        bloomerang,
+        "constituentId",
+      ],
+    },
+    date: {
+      type: "string",
+      label: "Date",
+      description: "The date of the donation",
+    },
+    amount: {
+      type: "string",
+      label: "Amount",
+      description: "The amount for the donation",
+    },
+    fundId: {
+      propDefinition: [
+        bloomerang,
+        "fundId",
+      ],
+    },
+    paymentMethod: {
+      type: "string",
+      label: "Payment Method",
+      description: "The method of payment",
+      options: PAYMENT_METHOD_OPTIONS,
+    },
+    campaignId: {
+      propDefinition: [
+        bloomerang,
+        "campaignId",
+      ],
+      optional: true,
+    },
+    appealId: {
+      propDefinition: [
+        bloomerang,
+        "appealId",
+      ],
+      optional: true,
+    },
+    note: {
+      type: "string",
+      label: "Note",
+      description: "A note for the donation",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.bloomerang.createDonation({
+      $,
+      data: {
+        AccountId: this.constituentId,
+        Date: this.date,
+        Amount: this.amount,
+        Method: this.paymentMethod,
+        Designations: [
+          {
+            FundId: this.fundId,
+            Amount: this.amount,
+            Type: "Donation",
+            CampaignId: this.campaignId,
+            AppealId: this.appealId,
+            Note: this.note,
+          },
+        ],
+      },
+    });
+
+    $.export("$summary", `Successfully created donation with ID: ${response.Id}`);
+    return response;
+  },
+};

package/bloomerang.app.mjs

@@ -1,11 +1,189 @@
+import { axios } from "@pipedream/platform";
+import { LIMIT } from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "bloomerang",
-  propDefinitions: {},
+  propDefinitions: {
+    constituentId: {
+      type: "string",
+      label: "Constituent ID",
+      description: "The ID of the constituent",
+      async options({ page }) {
+        const { Results: response } = await this.listConstituents({
+          params: {
+            skip: LIMIT * page,
+            take: LIMIT,
+          },
+        });
+        return response.map(({
+          Id: value, FullName: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    fundId: {
+      type: "string",
+      label: "Fund",
+      description: "Filter donations by fund",
+      async options({ page }) {
+        const { Results: response } = await this.listFunds({
+          params: {
+            skip: LIMIT * page,
+            take: LIMIT,
+          },
+        });
+        return response.map(({
+          Id: value, Name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    campaignId: {
+      type: "string",
+      label: "Campaign",
+      description: "Filter interactions by campaign",
+      async options({ page }) {
+        const { Results: response } = await this.listCampaigns({
+          params: {
+            skip: LIMIT * page,
+            take: LIMIT,
+          },
+        });
+        return response.map(({
+          Id: value, Name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    appealId: {
+      type: "string",
+      label: "Appeal",
+      description: "An appeal for the donation",
+      async options({ page }) {
+        const { Results: response } = await this.listAppeals({
+          params: {
+            skip: LIMIT * page,
+            take: LIMIT,
+          },
+        });
+        return response.map(({
+          Id: value, Name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.bloomerang.co/v2";
+    },
+    _headers() {
+      return {
+        "accept": "application/json",
+        "x-api-key": `${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    listConstituents(opts = {}) {
+      return this._makeRequest({
+        path: "/constituents",
+        ...opts,
+      });
+    },
+    listInteractions(opts = {}) {
+      return this._makeRequest({
+        path: "/interactions",
+        ...opts,
+      });
+    },
+    listTransactions(opts = {}) {
+      return this._makeRequest({
+        path: "/transactions",
+        ...opts,
+      });
+    },
+    listFunds(opts = {}) {
+      return this._makeRequest({
+        path: "/funds",
+        ...opts,
+      });
+    },
+    listCampaigns(opts = {}) {
+      return this._makeRequest({
+        path: "/campaigns",
+        ...opts,
+      });
+    },
+    listAppeals(opts = {}) {
+      return this._makeRequest({
+        path: "/appeals",
+        ...opts,
+      });
+    },
+    createDonation(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/transaction",
+        ...opts,
+      });
+    },
+    createConstituent(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/constituent",
+        ...opts,
+      });
+    },
+    createInteraction(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/interaction",
+        ...opts,
+      });
+    },
+    async *paginate({
+      fn, params = {}, maxResults = null, ...opts
+    }) {
+      let hasMore = false;
+      let count = 0;
+      let page = 0;
+
+      do {
+        params.skip = LIMIT * page;
+        params.take = LIMIT;
+        page++;
+        const { Results: data } = await fn({
+          params,
+          ...opts,
+        });
+        for (const d of data) {
+          yield d;
+
+          if (maxResults && ++count === maxResults) {
+            return count;
+          }
+        }
+
+        hasMore = data.length;
+
+      } while (hasMore);
     },
   },
-};
+};

package/common/constants.mjs

@@ -0,0 +1,173 @@
+export const LIMIT = 50;
+
+export const CHANNEL_OPTIONS = [
+  {
+    label: "Email",
+    value: "Email",
+  },
+  {
+    label: "In Person",
+    value: "InPerson",
+  },
+  {
+    label: "Mail",
+    value: "Mail",
+  },
+  {
+    label: "Mass Email",
+    value: "MassEmail",
+  },
+  {
+    label: "Other",
+    value: "Other",
+  },
+  {
+    label: "Phone",
+    value: "Phone",
+  },
+  {
+    label: "Social Media",
+    value: "SocialMedia",
+  },
+  {
+    label: "Text Message",
+    value: "TextMessage",
+  },
+  {
+    label: "Video Call",
+    value: "VideoCall",
+  },
+  {
+    label: "Webinar",
+    value: "Webinar",
+  },
+  {
+    label: "Website",
+    value: "Website",
+  },
+];
+
+export const PURPOSE_OPTIONS = [
+  {
+    label: "Acknowledgement",
+    value: "Acknowledgement",
+  },
+  {
+    label: "Impact/Cultivation",
+    value: "ImpactCultivation",
+  },
+  {
+    label: "Newsletter",
+    value: "Newsletter",
+  },
+  {
+    label: "Receipt",
+    value: "Receipt",
+  },
+  {
+    label: "Solicitation",
+    value: "Solicitation",
+  },
+  {
+    label: "Special Event",
+    value: "SpecialEvent",
+  },
+  {
+    label: "Volunteer Activity",
+    value: "VolunteerActivity",
+  },
+  {
+    label: "Pledge Reminder",
+    value: "PledgeReminder",
+  },
+  {
+    label: "Welcome",
+    value: "Welcome",
+  },
+  {
+    label: "Other",
+    value: "Other",
+  },
+];
+
+export const CONSTITUENT_TYPE_OPTIONS = [
+  "Individual",
+  "Organization",
+];
+
+export const CONSTITUENT_STATUS_OPTIONS = [
+  "Active",
+  "Inactive",
+  "Deceased",
+];
+
+export const CONSTITUENT_PREFIX_OPTIONS = [
+  "Atty.",
+  "Capt",
+  "Cmdr",
+  "Coach",
+  "Col",
+  "Dr.",
+  "Fr.",
+  "Gen",
+  "Gov.",
+  "Hon.",
+  "Lt",
+  "Maj",
+  "Master",
+  "Miss",
+  "Mr.",
+  "Mrs.",
+  "Ms.",
+  "Mx.",
+  "Pastor",
+  "Pres.",
+  "Prof.",
+  "Pvt",
+  "Rabbi",
+  "Rep.",
+  "Rev.",
+  "Sen.",
+  "Sgt",
+  "Sir",
+  "Sr.",
+];
+
+export const CONSTITUENT_SUFFIX_OPTIONS = [
+  "DDS",
+  "Esq.",
+  "II",
+  "III",
+  "IV",
+  "Jr.",
+  "M.D.",
+  "Ph.D.",
+  "Sr.",
+  "V",
+];
+
+export const CONSTITUENT_GENDER_OPTIONS = [
+  "Male",
+  "Female",
+  "Other",
+];
+
+export const COMMUNICATION_CHANNEL_OPTIONS = [
+  "Email",
+  "Phone",
+  "Text Message",
+  "Mail",
+];
+
+export const PAYMENT_METHOD_OPTIONS = [
+  "None",
+  "Cash",
+  "Check",
+  "CreditCard",
+  "Eft",
+  "InKind",
+  "ApplePay",
+  "GooglePay",
+  "PayPal",
+  "Venmo",
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/bloomerang",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "Pipedream Bloomerang Components",
   "main": "bloomerang.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }