@pipedream/white_swan 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The White Swan API provides predictive analytics for mitigating risks in financial portfolios using artificial intelligence. By leveraging the White Swan API in Pipedream, you can automate the process of gathering insights, monitoring market conditions, and integrating advanced risk analysis into your existing financial systems. With Pipedream's serverless platform, you can construct workflows to react in real-time to data from White Swan, send alerts, and even automate trades or adjustments based on risk thresholds or predictive signals.
+
+# Example Use Cases
+
+- **Automated Risk Alerts**: Use White Swan's predictive analytics to monitor portfolio risk and set up a Pipedream workflow that sends you real-time notifications via email, SMS, or Slack when certain risk thresholds are crossed. This immediate feedback allows you to take swift action to mitigate potential losses.
+
+- **Dynamic Portfolio Rebalancing**: Create a Pipedream workflow that automatically triggers a rebalancing of your investment portfolio using White Swan's risk predictions. Integrate with a trading platform like Alpaca to execute trades that align your portfolio with the desired risk profile, based on the latest AI-driven insights.
+
+- **Market Sentiment Analysis**: Combine White Swan's market sentiment data with sentiment analysis from Twitter or news sources using Pipedream. Correlate the different sentiment indicators and use the results to adjust your investment strategy, or to feed into machine learning models for more nuanced decision-making.

package/actions/create-pre-fill-info/create-pre-fill-info.mjs

@@ -0,0 +1,73 @@
+import whiteSwan from "../../white_swan.app.mjs";
+import constants from "../../common/constants.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "white_swan-create-pre-fill-info",
+  name: "Create Pre-fill Info",
+  description: "Imports client data for pre-filling applications to enrich the user experience. [See the documentation](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/action-calls/create-pre-fill-information)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    whiteSwan,
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The first name of the intended insured person.",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The last name of the intended insured person.",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email of the applicant.",
+      optional: true,
+    },
+    address: {
+      type: "string",
+      label: "Address",
+      description: "The current address of the intended insured person.",
+      optional: true,
+    },
+    dateOfBirth: {
+      type: "string",
+      label: "Date of Birth",
+      description: "The date of birth of the intended insured person in ISO 8601 format.",
+      optional: true,
+    },
+    policyType: {
+      type: "string",
+      label: "Policy Type",
+      description: "The policy type of this policy.",
+      optional: true,
+      options: constants.POLICY_TYPE,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.whiteSwan.importClientData({
+      $,
+      data: {
+        first_name: this.firstName,
+        last_name: this.lastName,
+        email: this.email,
+        address: this.address,
+        date_of_birth: this.dateOfBirth
+          ? utils.convertISOToCustomFormat(this.dateOfBirth)
+          : undefined,
+        policy_type: this.policyType,
+      },
+    });
+    $.export("$summary", "Successfully imported client data for pre-filling applications");
+    return response;
+  },
+};

package/actions/get-referred-clients-info/get-referred-clients-info.mjs

@@ -0,0 +1,33 @@
+import whiteSwan from "../../white_swan.app.mjs";
+
+export default {
+  key: "white_swan-get-referred-clients-info",
+  name: "Get Referred Clients Info",
+  description: "Retrieves information about clients referred from the user's White Swan account. [See the documentation](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/information-calls/referred-client-s)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    whiteSwan,
+    clientEmail: {
+      propDefinition: [
+        whiteSwan,
+        "clientEmail",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.whiteSwan.getClients({
+      $,
+      data: {
+        client_email: this.clientEmail,
+      },
+    });
+    $.export("$summary", `Retrieved info for client ${this.clientEmail}`);
+    return response;
+  },
+};

package/actions/list-client-email-options/list-client-email-options.mjs

@@ -0,0 +1,24 @@
+import white_swan from "../../white_swan.app.mjs";
+
+export default {
+  key: "white_swan-list-client-email-options",
+  name: "List Client Email Options",
+  description: "Retrieves available options for the Client Email field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    white_swan,
+  },
+  async run({ $ }) {
+    const options = await white_swan.propDefinitions.clientEmail.options.call(this.white_swan);
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/submit-complete-plan-request/submit-complete-plan-request.mjs

@@ -0,0 +1,125 @@
+import whiteSwan from "../../white_swan.app.mjs";
+import constants from "../../common/constants.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "white_swan-submit-complete-plan-request",
+  name: "Submit Complete Plan Request",
+  description: "Creates a new comprehensive quote request based on the information provided and generates the final quotation without further data requirements. [See the documentation](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/action-calls/submit-complete-plan-request)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    whiteSwan,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The full name of the person who the request is made on behalf of.",
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email of the person who the request is made on behalf of.",
+    },
+    policyType: {
+      type: "string",
+      label: "Policy Type",
+      description: "The policy type that this request is made for.",
+      options: constants.POLICY_TYPE,
+    },
+    mainGoal: {
+      type: "string",
+      label: "Main Goal",
+      description: "The primary goal of this plan request, either Protection or Accumulation.",
+      options: constants.MAIN_GOAL,
+    },
+    residentState: {
+      type: "string",
+      label: "Resident State",
+      description: "The state in which the insured person is a resident. Example: `California`",
+    },
+    deathBenefitNeeded: {
+      type: "integer",
+      label: "Death Benefit Needed",
+      description: "The amount of death benefit that is required for this plan. To opt for the lowest amount possible given a certain premium budget, use 0.",
+      default: 0,
+    },
+    paymentSchedule: {
+      type: "string",
+      label: "Payment Schedule",
+      description: "How often premiums should be paid on this plan.",
+      options: constants.PAYMENT_SCHEDULE,
+    },
+    gender: {
+      type: "string",
+      label: "Gender",
+      description: "Whether the intended insured person is Male or Female.",
+      options: constants.GENDER,
+    },
+    dateOfBirth: {
+      type: "string",
+      label: "Date of Birth",
+      description: "The date of birth of the intended insured person in ISO 8601 format.",
+    },
+    healthRating: {
+      type: "string",
+      label: "Health Rating",
+      description: "How the insured person would rate their own general health.",
+      options: constants.HEALTH_RATING,
+    },
+    usesTobacco: {
+      type: "boolean",
+      label: "Uses Tobacco",
+      description: "Whether the intended insured person uses tobacco/nicotine products or not.",
+    },
+    insuredHeightFeet: {
+      type: "integer",
+      label: "Insured Height in Feet",
+      description: "The height in feet of the intended insured person.",
+    },
+    insuredHeightInches: {
+      type: "integer",
+      label: "Insured Height in Inches",
+      description: "The height in inches of the intended insured person.",
+    },
+    insuredWeight: {
+      type: "integer",
+      label: "Insured Weight",
+      description: "The weight in pounds of the intended insured person.",
+    },
+    prefillInfoId: {
+      type: "string",
+      label: "Pre-fill Info ID",
+      description: "If you have already created a pre-fill information you can pass its ID by using this parameter to associate that info with this request.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.whiteSwan.createQuoteRequest({
+      $,
+      data: {
+        name: this.name,
+        email: this.email,
+        policy_type: this.policyType,
+        main_goal: this.mainGoal,
+        resident_state: this.residentState,
+        death_benefit: this.deathBenefitNeeded,
+        payment_schedule: this.paymentSchedule,
+        gender: this.gender,
+        date_of_birth: utils.convertISOToCustomFormat(this.dateOfBirth),
+        health_rating: this.healthRating,
+        tobacco: this.usesTobacco,
+        height_feet: this.insuredHeightFeet,
+        height_inches: this.insuredHeightInches,
+        weight_pounds: this.insuredWeight,
+        contact_id: this.prefillInfoId,
+      },
+    });
+    $.export("$summary", "Successfully submitted complete plan request");
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,38 @@
+const POLICY_TYPE = [
+  "Variable Universal Life",
+  "Indexed Universal Life",
+  "Whole Life",
+  "Term Life",
+  "Guaranteed Universal Life",
+  "Private Placement Life",
+];
+
+const MAIN_GOAL = [
+  "Accumulation",
+  "Protection",
+];
+
+const PAYMENT_SCHEDULE = [
+  "Monthly",
+  "Quarterly",
+  "Yearly",
+];
+
+const GENDER = [
+  "Male",
+  "Female",
+];
+
+const HEALTH_RATING = [
+  "Average",
+  "Good",
+  "Excellent",
+];
+
+export default {
+  POLICY_TYPE,
+  MAIN_GOAL,
+  PAYMENT_SCHEDULE,
+  GENDER,
+  HEALTH_RATING,
+};

package/common/utils.mjs

@@ -0,0 +1,28 @@
+export default {
+  convertISOToCustomFormat(isoDateString) {
+    const date = new Date(isoDateString);
+
+    const year = date.getFullYear();
+    const month = (date.getMonth() + 1).toString().padStart(2, "0");
+    const day = date.getDate().toString()
+      .padStart(2, "0");
+    const hours = date.getHours().toString()
+      .padStart(2, "0");
+    const minutes = date.getMinutes().toString()
+      .padStart(2, "0");
+    const seconds = date.getSeconds().toString()
+      .padStart(2, "0");
+
+    const timezoneOffset = -date.getTimezoneOffset();
+    const timezoneHours = Math.floor(Math.abs(timezoneOffset) / 60).toString()
+      .padStart(2, "0");
+    const timezoneMinutes = (Math.abs(timezoneOffset) % 60).toString().padStart(2, "0");
+    const timezoneSign = timezoneOffset >= 0
+      ? "+"
+      : "-";
+
+    const customFormat = `${year}${month}${day}T${hours}${minutes}${seconds}${timezoneSign}${timezoneHours}${timezoneMinutes}`;
+
+    return customFormat;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/white_swan",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream White Swan Components",
   "main": "white_swan.app.mjs",
   "keywords": [
@@ -11,5 +11,9 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.8",
+    "md5": "^2.3.0"
   }
 }

package/sources/common/base-polling.mjs

@@ -0,0 +1,62 @@
+import whiteSwan from "../../white_swan.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  props: {
+    whiteSwan,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvent(25);
+    },
+  },
+  methods: {
+    _getPreviousItems() {
+      return this.db.get("previousItems") || {};
+    },
+    _setPreviousItems(previousItems) {
+      this.db.set("previousItems", previousItems);
+    },
+    async processEvent(max) {
+      const previousItems = this._getPreviousItems();
+      const resourceFn = this.getResourceFn();
+      const items = await resourceFn();
+      if (!items?.length) {
+        return;
+      }
+      let count = 0;
+      for (const item of items) {
+        const itemKey = this.getItemKey(item);
+        if (!previousItems[itemKey]) {
+          const meta = this.generateMeta(item);
+          this.$emit(item, meta);
+          previousItems[itemKey] = true;
+          count++;
+          if (max && count >= max) {
+            break;
+          }
+        }
+      }
+      this._setPreviousItems(previousItems);
+    },
+    getResourceFn() {
+      throw new Error("getResourceFn is not implemented");
+    },
+    getItemKey() {
+      throw new Error("getItemKey is not implemented");
+    },
+    generateMeta() {
+      throw new Error("generateMeta is not implemented");
+    },
+  },
+  async run() {
+    await this.processEvent();
+  },
+};

package/sources/new-earnings-event/new-earnings-event.mjs

@@ -0,0 +1,29 @@
+import common from "../common/base-polling.mjs";
+import md5 from "md5";
+
+export default {
+  ...common,
+  key: "white_swan-new-earnings-event",
+  name: "New Earnings Event",
+  description: "Emit new event when a new earnings event is created for your account, such as credits from client referrals or partner payouts.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.whiteSwan.listEarningsEvents;
+    },
+    getItemKey(event) {
+      return md5(JSON.stringify(event));
+    },
+    generateMeta(event) {
+      const id = this.getItemKey(event);
+      return {
+        id,
+        summary: `New Earnings Event - ${event.event_name}`,
+        ts: Date.now(),
+      };
+    },
+  },
+};

package/sources/new-personal-plan/new-personal-plan.mjs

@@ -0,0 +1,27 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "white_swan-new-personal-plan",
+  name: "New Personal Plan",
+  description: "Emit new event when a customer creates a personal plan.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.whiteSwan.listPersonalPlans;
+    },
+    getItemKey(plan) {
+      return plan.plan_id;
+    },
+    generateMeta(plan) {
+      return {
+        id: plan.plan_id,
+        summary: `New Plan ${plan.plan_id}`,
+        ts: Date.now(),
+      };
+    },
+  },
+};

package/white_swan.app.mjs

@@ -1,11 +1,78 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "white_swan",
-  propDefinitions: {},
+  propDefinitions: {
+    clientEmail: {
+      type: "string",
+      label: "Client Email",
+      description: "Email of the client to retrieve information",
+      async options() {
+        const clients = await this.getClients();
+        return clients?.map(({
+          email: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://app.whiteswan.io/api/1.1/wf";
+    },
+    _makeRequest(opts = {}) {
+      const {
+        $ = this,
+        path,
+        ...otherOpts
+      } = opts;
+      return axios($, {
+        ...otherOpts,
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "Authorization": `Bearer ${this.$auth.api_key}`,
+          "Accept": "application/json",
+          "Content-Type": "application/json",
+        },
+      });
+    },
+    getClients(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/client",
+        ...opts,
+      });
+    },
+    listPersonalPlans(opts = {}) {
+      return this._makeRequest({
+        path: "/personal_plan",
+        method: "POST",
+        ...opts,
+      });
+    },
+    listEarningsEvents(opts = {}) {
+      return this._makeRequest({
+        path: "/earnings_event",
+        method: "POST",
+        ...opts,
+      });
+    },
+    importClientData(opts = {}) {
+      return this._makeRequest({
+        path: "/new_prefill_info",
+        method: "POST",
+        ...opts,
+      });
+    },
+    createQuoteRequest(opts = {}) {
+      return this._makeRequest({
+        path: "/complete_request",
+        method: "POST",
+        ...opts,
+      });
     },
   },
-};
+};