Skip to content

[Components] Drift. Actions + Sources #16553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions components/drift/actions/create-contact/create-contact.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import drift from "../../drift.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";

export default {
key: "drift-create-contact",
name: "Create Contact",
description: "Creates a contact in Drift. [See the docs](https://devdocs.drift.com/docs/creating-a-contact).",
version: "0.0.1",
type: "action",
props: {
drift,
email: {
type: "string",
label: "Email",
description: "The contact's email address",
},
name: {
type: "string",
label: "Name",
description: "The contact's full name",
optional: true,
},
phone: {
type: "string",
label: "Phone",
description: "The contact's phone number",
optional: true,
},
source: {
type: "string",
label: "Lead Source",
description: "The value of the 'lead_create_source' custom attribute to match (case-sensitive).",
optional: true,
},
customAttributes: {
type: "object",
label: "Custom Attributes",
description: "Additional custom attributes to store on the contact",
optional: true,
},
},

async run({ $ }) {

const {
drift, email, name, phone, source,
} = this;

const customAttributes = drift.parseIfJSONString(this.customAttributes);

const attributes = removeNullEntries({
email,
name,
phone,
source,
...customAttributes,
});

const existingContact = await drift.getContactByEmail({
$,
params: {
email,
},
});

if (existingContact && existingContact.data.length > 0) {
throw new Error (`Contact ${email} already exists`);
};

const response = await drift.createContact({
$,
data: {
attributes,
},
});

console.log(response.data.id);

$.export("$summary", `Contact "${email}" has been created successfully.`);
return response;
},
};

41 changes: 41 additions & 0 deletions components/drift/actions/delete-contact/delete-contact.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import drift from "../../drift.app.mjs";

export default {
key: "drift-delete-contact",
name: "Delete Contact",
description: "Deletes a contact in Drift by ID or email. [See the docs](https://devdocs.drift.com/docs/removing-a-contact).",
version: "0.0.1",
type: "action",
props: {
drift,
emailOrId: {
type: "string",
label: "Email or Id",
description: "The contact's email address or ID",
},
},

async run({ $ }) {

const {
drift, emailOrId,
} = this;

let contact = await drift.getContactByEmailOrId($, emailOrId);
contact = contact.data[0] || contact.data;

const contactId = contact.id;
const contactEmail = contact.attributes.email;

const response = await drift.deleteContactById({
$,
contactId,
});

$.export("$summary", `Contact "${contactEmail}" ID "${contactId}"
has been deleted successfully.`);

return response;
},
};

37 changes: 37 additions & 0 deletions components/drift/actions/get-contact/get-contact.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import drift from "../../drift.app.mjs";

export default {
key: "drift-get-contact",
name: "Get Contact",
description: "Retrieves a contact in Drift by ID or email. [See the docs](https://devdocs.drift.com/docs/retrieving-contact)",
version: "0.0.1",
type: "action",
props: {
drift,
emailOrId: {
type: "string",
label: "Email or Id",
description: "The contact's email address or ID",
},
},

async run({ $ }) {

const {
drift, emailOrId,
} = this;

const response = await drift.getContactByEmailOrId($, emailOrId);

const contact = response.data[0] || response.data;

if (!contact) {
throw new Error("Failed to get contact");
};

$.export("$summary", `Contact ${contact.attributes.email} ID "${contact.id}"`
+ " has been fetched successfully.");

return contact;
},
};
85 changes: 85 additions & 0 deletions components/drift/actions/update-contact/update-contact.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import drift from "../../drift.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";

export default {
key: "drift-update-contact",
name: "Update Contact",
description: "Updates a contact in Drift using ID or email. Only changed attributes will be updated. [See Drift API docs](https://devdocs.drift.com/docs/updating-a-contact)",
version: "0.0.1",
type: "action",
props: {
drift,
emailOrId: {
type: "string",
label: "Email or ID",
description: "The contact’s email address or numeric ID.",
},
email: {
type: "string",
label: "Email",
description: "The contact’s email address",
optional: true,
},
name: {
type: "string",
label: "Name",
description: "The contact’s name.",
optional: true,
},
phone: {
type: "string",
label: "Phone",
description: "The contact’s phone number.",
optional: true,
},
source: {
type: "string",
label: "Lead Source",
description: "The value of the 'lead_create_source' custom attribute to match (case-sensitive).",
optional: true,
},
customAttributes: {
type: "object",
label: "Custom Attributes",
description: "Any custom attributes to update (e.g. company, job title, etc).",
optional: true,
},
},

async run({ $ }) {
const {
drift, name, email, phone, source, emailOrId,
} = this;

const customAttributes = drift.parseIfJSONString(this.customAttributes);

const attributes = removeNullEntries({
name,
phone,
email,
source,
...customAttributes,
});

if (!Object.keys(attributes).length) {
throw new Error("No attributes provided to update.");
};

let contact = await drift.getContactByEmailOrId($, emailOrId);

const contactId = contact.data[0]?.id || contact.data.id;

const response = await drift.updateContact({
$,
contactId,
data: {
attributes,
},
});

$.export("$summary", `Contact ID "${contactId}" has been updated successfully.`);

return response;
},
};

27 changes: 27 additions & 0 deletions components/drift/common/utils.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
const removeNullEntries = (obj) =>
obj && Object.entries(obj).reduce((acc, [
key,
value,
]) => {
const isNumber = typeof value === "number";
const isBoolean = typeof value === "boolean";
const isNotEmpyString = typeof value === "string" && value.trim() !== "";
const isNotEmptyArray = Array.isArray(value) && value.length;
const isNotEmptyObject =
typeof value === "object" &&
value !== null &&
!Array.isArray(value) &&
Object.keys(value).length !== 0;
isNotEmptyObject && (value = removeNullEntries(value));
return ((value || value === false) &&
(isNotEmpyString || isNotEmptyArray || isNotEmptyObject || isBoolean || isNumber))
? {
...acc,
[key]: value,
}
: acc;
}, {});

export {
removeNullEntries,
};
Loading
Loading