customer.io identify + track action

lib/actions/customerio/customerio.d.ts

@@ -0,0 +1,52 @@
+import { TrackClient } from "customerio-node";
+import * as Hub from "../../hub";
+interface CustomerIoFields {
+    idFieldNames: string[];
+    idField?: Hub.Field;
+    userIdField?: Hub.Field;
+    emailField?: Hub.Field;
+}
+export declare enum CustomerIoTags {
+    UserId = "user_id",
+    Email = "email"
+}
+export declare enum CustomerIoCalls {
+    Identify = "identify",
+    Track = "track"
+}
+export declare class CustomerIoAction extends Hub.Action {
+    allowedTags: CustomerIoTags[];
+    name: string;
+    label: string;
+    iconName: string;
+    description: string;
+    params: {
+        description: string;
+        label: string;
+        name: string;
+        required: boolean;
+        sensitive: boolean;
+    }[];
+    minimumSupportedLookerVersion: string;
+    supportedActionTypes: Hub.ActionType[];
+    usesStreaming: boolean;
+    extendedAction: boolean;
+    supportedFormattings: Hub.ActionFormatting[];
+    supportedVisualizationFormattings: Hub.ActionVisualizationFormatting[];
+    requiredFields: {
+        any_tag: CustomerIoTags[];
+    }[];
+    executeInOwnProcess: boolean;
+    supportedFormats: (request: Hub.ActionRequest) => Hub.ActionFormat[];
+    form(): Promise<Hub.ActionForm>;
+    execute(request: Hub.ActionRequest): Promise<Hub.ActionResponse>;
+    protected executeCustomerIo(request: Hub.ActionRequest, customerIoCall: CustomerIoCalls): Promise<Hub.ActionResponse>;
+    protected unassignedCustomerIoFieldsCheck(customerIoFields: CustomerIoFields | undefined): void;
+    protected taggedFields(fields: Hub.Field[], tags: string[]): Hub.Field[];
+    protected taggedField(fields: any[], tags: string[]): Hub.Field | undefined;
+    protected customerIoFields(fields: Hub.Field[]): CustomerIoFields;
+    protected filterJsonCustomerIo(jsonRow: any, customerIoFields: CustomerIoFields, fieldName: string): any;
+    protected prepareCustomerIoTraitsFromRow(row: Hub.JsonDetail.Row, fields: Hub.Field[], customerIoFields: CustomerIoFields, hiddenFields: string[], event: any, context: any, lookerAttributePrefix: string): any;
+    protected customerIoClientFromRequest(request: Hub.ActionRequest): TrackClient;
+}
+export {};

lib/actions/customerio/customerio_error.d.ts

@@ -0,0 +1,3 @@
+export declare class CustomerIoActionError extends Error {
+    constructor(message?: string);
+}

lib/actions/customerio/customerio_error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerIoActionError = void 0;
+class CustomerIoActionError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.CustomerIoActionError = CustomerIoActionError;

lib/actions/customerio/customerio_track.d.ts

@@ -0,0 +1,11 @@
+import * as Hub from "../../hub";
+import { CustomerIoAction } from "./customerio";
+export declare class CustomerIoTrackAction extends CustomerIoAction {
+    name: string;
+    label: string;
+    iconName: string;
+    description: string;
+    minimumSupportedLookerVersion: string;
+    execute(request: Hub.ActionRequest): Promise<Hub.ActionResponse>;
+    form(): Promise<Hub.ActionForm>;
+}

lib/actions/customerio/customerio_track.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomerIoTrackAction = void 0;
+const Hub = require("../../hub");
+const customerio_1 = require("./customerio");
+class CustomerIoTrackAction extends customerio_1.CustomerIoAction {
+    constructor() {
+        super(...arguments);
+        this.name = "customerio_track";
+        this.label = "Customer.io Track";
+        this.iconName = "customerio/customerio.png";
+        this.description = "Add traits via track to your customer.io users.";
+        this.minimumSupportedLookerVersion = "5.5.0";
+    }
+    execute(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.executeCustomerIo(request, customerio_1.CustomerIoCalls.Track);
+        });
+    }
+    form() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const form = new Hub.ActionForm();
+            form.fields = [
+                {
+                    name: "event",
+                    label: "Event",
+                    description: "The name of the event you’re tracking.",
+                    type: "string",
+                    required: true,
+                },
+                {
+                    description: "Override default api key",
+                    label: "Override API Key",
+                    name: "override_customer_io_api_key",
+                    required: false,
+                }, {
+                    description: "Override default site id",
+                    label: "Override Site ID",
+                    name: "override_customer_io_site_id",
+                    required: false,
+                },
+            ];
+            return form;
+        });
+    }
+}
+exports.CustomerIoTrackAction = CustomerIoTrackAction;
+Hub.addAction(new CustomerIoTrackAction());

lib/actions/index.d.ts

@@ -4,6 +4,8 @@ import "./amazon/amazon_s3";
 import "./auger/auger_train";
 import "./azure/azure_storage";
 import "./braze/braze";
+import "./customerio/customerio";
+import "./customerio/customerio_track";
 import "./datarobot/datarobot";
 import "./digitalocean/digitalocean_droplet";
 import "./digitalocean/digitalocean_object_storage";

lib/actions/index.js

@@ -6,6 +6,8 @@ require("./amazon/amazon_s3");
 require("./auger/auger_train");
 require("./azure/azure_storage");
 require("./braze/braze");
+require("./customerio/customerio");
+require("./customerio/customerio_track");
 require("./datarobot/datarobot");
 require("./digitalocean/digitalocean_droplet");
 require("./digitalocean/digitalocean_object_storage");

package.json

@@ -60,6 +60,7 @@
     "async-mutex": "^0.1.4",
     "aws-sdk": "^2.732.0",
     "azure-storage": "^2.10.3",
+    "customerio-node": "^3.3.0",
     "base64-url": "^2.3.3",
     "blocked-at": "^1.2.0",
     "body-parser": "^1.19.0",

src/actions/customerio/README.md

@@ -0,0 +1,4 @@
+# customer.io
+## Add identifiers to your customer.io users.
+
+The customer.io action allows you to Identify users (tagged with either `email`, `user_id`) with additional fields via the customer.io API.