Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore: Add email channel to csat example #28

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+375 −122
Open

chore: Add email channel to csat example #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions 12-csat/code/src/functions/common/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ export const SurveysSubmitAPIMethodPath = '/surveys.submit';
export const SurveysListAPIMethodPath = '/surveys.list';
export const SurveysSendAPIMethodPath = '/surveys.send';

// Snap-kit Action
export const SnapKitActionCreateDeferredAPIMethodPath = '/snap-kit-action.create.deferred';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an internal API?


export const EMAIL = 'email';
export const EmailSubject = 'Support experience feedback for ';
export const PLUG = 'plug';
Expand Down
165 changes: 161 additions & 4 deletions 12-csat/code/src/functions/common/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ import {
WorksGetAPIMethodPath,
} from './constants';

export const SurveysEmailCsatResponsePath = '/survey-response';
const SnapKitActionID = 'rating';

const SnapInActionName = 'survey';
export const dispatchIdAndRatingDeliminator = '::';

export async function doDevRevPostAPICall(apiBase: string, method: string, data: object, auth: string) {
const url = apiBase + method;
Expand Down Expand Up @@ -51,10 +53,10 @@ interface snapKitButtonJson {

export function getSnapKitBody(objId: string, snap_in_id: string, survey_text_header: string, survey_text: string,
surveyRespScale: string, visibility: string, members: string[], expires_at :string,
label: string) {
dispatchId: string, label: string) {

let buttonsText = getButtonsText(surveyRespScale);
const buttons = generateButtonJson(buttonsText);
const buttons = generateButtonJson(buttonsText, dispatchId);

let snapKitBody: { [key: string]: any } = {};

Expand Down Expand Up @@ -137,7 +139,7 @@ function getButtonsText(surveyRespScale: string) {
return buttonsText;
}

function generateButtonJson(buttonsText: string[]): snapKitButtonJson[] {
function generateButtonJson(buttonsText: string[], dispatchId: string): snapKitButtonJson[] {
const result: snapKitButtonJson[] = [];
const maxScale = 5;

Expand All @@ -151,7 +153,7 @@ function generateButtonJson(buttonsText: string[]): snapKitButtonJson[] {
type: 'plain_text',
},
type: 'button',
value: (maxScale - i).toString(),
value: `${dispatchId}${dispatchIdAndRatingDeliminator}` + (maxScale - i).toString(),
});
}

Expand Down Expand Up @@ -205,6 +207,17 @@ export function getTimelineCommentBody(objId: string, bodyText :string, visibili
return timelineBody;
}

export function getEmailBody(subject: string, sender: string, recipients: string[], htmlBodyStr: string) {
return {
'email': {
'subject': subject,
'body': htmlBodyStr,
'recipients': recipients,
'sender': sender,
},
};
}

export function getSnapKitActionCreateBody(baseObj: string, snapIn: string, channel: string, dispatchedTo: string ) {
return {
'base_object': baseObj,
Expand All @@ -223,6 +236,150 @@ export function getExpiryTimestamp(timeInMin : number) {
return new Date(numberOfMlSeconds + addMlSeconds);
}

// TODO: isTicket, ticketTitle, ticketDescription are the fields which are added for the tiket only. Ideally this is not scalable. But as
// currently there is no support for HTML given snap-kit this is stop gap solution.
export function getHtmlSurveyString(apiDomain:string, dispatchId: string, emailId: string, surveyTextHeader: string,
surveyText: string, surveyRespScale: string, isTicket: boolean,
ticketDisplayId: string, ticketTitle: string, ticketDescription: string): string {

let buttonsText = getButtonsText(surveyRespScale);

const apiPrefix = 'https://support.';
const hoverText = 'Select this rating';

const rating1 = `${apiPrefix}${apiDomain}${SurveysEmailCsatResponsePath}?uuid=${dispatchId}&id=${SnapKitActionID}&value=${dispatchId}${dispatchIdAndRatingDeliminator}1`;
const rating2 = `${apiPrefix}${apiDomain}${SurveysEmailCsatResponsePath}?uuid=${dispatchId}&id=${SnapKitActionID}&value=${dispatchId}${dispatchIdAndRatingDeliminator}2`;
const rating3 = `${apiPrefix}${apiDomain}${SurveysEmailCsatResponsePath}?uuid=${dispatchId}&id=${SnapKitActionID}&value=${dispatchId}${dispatchIdAndRatingDeliminator}3`;
const rating4 = `${apiPrefix}${apiDomain}${SurveysEmailCsatResponsePath}?uuid=${dispatchId}&id=${SnapKitActionID}&value=${dispatchId}${dispatchIdAndRatingDeliminator}4`;
const rating5 = `${apiPrefix}${apiDomain}${SurveysEmailCsatResponsePath}?uuid=${dispatchId}&id=${SnapKitActionID}&value=${dispatchId}${dispatchIdAndRatingDeliminator}5`;

return `
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<html lang="en">

<head data-id="__react-email-head"></head>

<body data-id="__react-email-body" style="table-layout:fixed;font-family:helvetica;background-color:#eeeeee;border:1px solid #EEEFF1">
<table align="center" width="100%" data-id="__react-email-container" role="presentation" cellSpacing="0" cellPadding="0" border="0" style="max-width:40rem;margin-left:auto;margin-right:auto">
<tbody>
<tr style="width:100%">
<td>
<table align="center" width="100%" data-id="react-email-section" style="background-color:#343DEA;border-radius:12px 12px 0px 0px;max-width:40rem;padding:1.5rem;height:8rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td></td>
<td data-id="__react-email-column" style="width:75%">
<p data-id="react-email-text" style="font-size:2.25rem;line-height:2.5rem;margin:16px 0;color:rgb(255,255,255);letter-spacing:-0.025em">Your Feedback Matters!</p>
</td>
<td data-id="__react-email-column"><img data-id="react-email-img" alt="image" src="https://s3.us-west-1.amazonaws.com/dev.devrev.ai/Assets/NotificationsEmail/surve_header2.png" style="display:block;outline:none;border:none;text-decoration:none;height:4rem;float:right" /></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="color:#202020;border-top:1px solid #EEEFF1;background-color:#F9FAFA;max-width:40rem;padding:2rem;font-size:0.875rem;line-height:1.25rem;border-width:1px;border-color:rgb(238,239,241)" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td>
<p data-id="react-email-text" style="font-size:14px;line-height:24px;margin:16px 0">Hi,</p>
<p data-id="react-email-text" style="font-size:14px;line-height:24px;margin:16px 0">${surveyTextHeader}</p>
<div style="${!isTicket && 'display:none'};padding:1rem;background-color:rgb(255,255,255);border-width:1px;border-color:rgb(238,239,241);border-style:solid;border-radius:0.75rem;gap:0.25rem">
<div style="display:flex;align-items:center;">
<div style="color:rgb(183,143,31);border-width:1px;border-color:#E3B9451A;background-color:#E3B9451A;padding:0.25rem;border-radius:0.375rem;font-size:0.75rem;line-height:1rem;margin-right:0.5rem">${ticketDisplayId}</div>
<div style="font-size:0.875rem;line-height:1.25rem;color:rgb(84,86,99)">${ticketTitle}</div>
</div>
<div style="font-size:0.875rem;line-height:1.25rem;color:rgb(113,115,132)">${ticketDescription}</div>
</div>
</td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="color:#202020;border-bottom:1px solid #EEEFF1;background-color:#FFF;max-width:40rem;padding:2rem;padding-top:1rem;font-size:0.875rem;line-height:1.25rem;border-width:1px;border-color:rgb(238,239,241)" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td>
<p class="" data-id="react-email-text" style="font-size:14px;line-height:24px;margin:16px 0">${surveyText}</p>
<table align="center" width="100%" data-id="react-email-section" border="0" cellPadding="0" cellSpacing="0" role="presentation" style="display:block">
<tbody>
<tr>
<td>
<table align="center" width="100%" data-id="react-email-section" style="border-radius:8px;border:1px solid #E4E5E7;background-color:#F4F4F6;margin-top:0.5rem;margin-bottom:0.5rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td><a title="${hoverText}" href="${rating5}" data-id="react-email-button" target="_blank" style="line-height:100%;text-decoration:none;display:inline-block;max-width:100%;padding:0px 0px;width:10rem;padding-left:1rem;padding-top:0.375rem;padding-bottom:0.375rem;color:rgb(66,67,77)"><span></span><span style="max-width:100%;display:inline-block;line-height:120%;mso-padding-alt:0px;mso-text-raise:0">${buttonsText[0]}</span><span></span></a></td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="border-radius:8px;border:1px solid #E4E5E7;background-color:#F4F4F6;margin-top:0.5rem;margin-bottom:0.5rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td><a title="${hoverText}" href="${rating4}" data-id="react-email-button" target="_blank" style="line-height:100%;text-decoration:none;display:inline-block;max-width:100%;padding:0px 0px;width:10rem;padding-left:1rem;padding-top:0.375rem;padding-bottom:0.375rem;color:rgb(66,67,77)"><span></span><span style="max-width:100%;display:inline-block;line-height:120%;mso-padding-alt:0px;mso-text-raise:0">${buttonsText[1]}</span><span></span></a></td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="border-radius:8px;border:1px solid #E4E5E7;background-color:#F4F4F6;margin-top:0.5rem;margin-bottom:0.5rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td><a title="${hoverText}" href="${rating3}" data-id="react-email-button" target="_blank" style="line-height:100%;text-decoration:none;display:inline-block;max-width:100%;padding:0px 0px;width:10rem;padding-left:1rem;padding-top:0.375rem;padding-bottom:0.375rem;color:rgb(66,67,77)"><span></span><span style="max-width:100%;display:inline-block;line-height:120%;mso-padding-alt:0px;mso-text-raise:0">${buttonsText[2]}</span><span></span></a></td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="border-radius:8px;border:1px solid #E4E5E7;background-color:#F4F4F6;margin-top:0.5rem;margin-bottom:0.5rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td><a title="${hoverText}" href="${rating2}" data-id="react-email-button" target="_blank" style="line-height:100%;text-decoration:none;display:inline-block;max-width:100%;padding:0px 0px;width:10rem;padding-left:1rem;padding-top:0.375rem;padding-bottom:0.375rem;color:rgb(66,67,77)"><span></span><span style="max-width:100%;display:inline-block;line-height:120%;mso-padding-alt:0px;mso-text-raise:0">${buttonsText[3]}</span><span></span></a></td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="border-radius:8px;border:1px solid #E4E5E7;background-color:#F4F4F6;margin-top:0.5rem;margin-bottom:0.5rem" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td><a title="${hoverText}" href="${rating1}" data-id="react-email-button" target="_blank" style="line-height:100%;text-decoration:none;display:inline-block;max-width:100%;padding:0px 0px;width:10rem;padding-left:1rem;padding-top:0.375rem;padding-bottom:0.375rem;color:rgb(66,67,77)"><span></span><span style="max-width:100%;display:inline-block;line-height:120%;mso-padding-alt:0px;mso-text-raise:0">${buttonsText[4]}</span><span></span></a></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" style="background-color:#F9FAFA;color:rgba(0, 0, 0, 0.50);border-radius:0px 0px 12px 12px;max-width:40rem;padding:2rem;border-width:1px;border-color:rgb(238,239,241)" border="0" cellPadding="0" cellSpacing="0" role="presentation">
<tbody>
<tr>
<td>
<table align="center" width="100%" data-id="react-email-section" border="0" cellPadding="0" cellSpacing="0" role="presentation" style="align-self:stretch;font-size:0.75rem;line-height:1rem">
<tbody>
<tr>
<td>
<p data-id="react-email-text" style="font-size:14px;line-height:24px;margin:16px 0">Your response will be recorded. We&#x27;ll use it only for the purpose of improving our services!</p>
<p data-id="react-email-text" style="font-size:14px;line-height:24px;margin:16px 0">This email was sent to ${emailId}. If you&#x27;re not them, please ignore it.</p>
</td>
</tr>
</tbody>
</table>
<table align="center" width="100%" data-id="react-email-section" border="0" cellPadding="0" cellSpacing="0" role="presentation" style="padding:1.5rem">
<tbody>
<tr>
<td></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</body>

</html>
`;
}

export async function getSurveyId(apiBase: string, auth: string, name: string) {
try {
console.log(`Listing surveys with name: [${name}]`);
Expand Down
Loading