Skip to content

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

9.4 KB
Raw Blame
import { httpClient, HttpMethod, HttpRequest } from '@activepieces/pieces-common';
import { AppConnectionType } from '@activepieces/pieces-framework';

import { GetResponseAuthValue } from './auth';

export async function validateGetResponseAuth(auth: GetResponseAuthValue): Promise<void> {
  await sendGetRequest<GetResponseCampaign[]>({
    auth,
    path: '/campaigns',
    queryParams: {
      perPage: '1',
      page: '1',
    },
  });
}

export async function listGetResponseCampaigns({
  auth,
  limit = 1000,
  name,
}: {
  auth: GetResponseAuthValue;
  limit?: number;
  name?: string;
}): Promise<GetResponseCampaign[]> {
  return sendGetRequest<GetResponseCampaign[]>({
    auth,
    path: '/campaigns',
    queryParams: {
      perPage: String(Math.min(limit, 1000)),
      page: '1',
      ...(name ? { 'query[name]': name } : {}),
    },
  });
}

export async function listGetResponseFromFields(
  auth: GetResponseAuthValue,
): Promise<GetResponseFromField[]> {
  return sendGetRequest<GetResponseFromField[]>({
    auth,
    path: '/from-fields',
    queryParams: {
      perPage: '1000',
      page: '1',
      'query[isActive]': 'true',
    },
  });
}

export async function listGetResponseContacts({
  auth,
  email,
  campaignId,
}: {
  auth: GetResponseAuthValue;
  email: string;
  campaignId?: string;
}): Promise<GetResponseContact[]> {
  return sendGetRequest<GetResponseContact[]>({
    auth,
    path: '/contacts',
    queryParams: {
      perPage: '1000',
      page: '1',
      'query[email]': email,
      ...(campaignId ? { 'query[campaignId]': campaignId } : {}),
    },
  });
}

export async function createGetResponseContact({
  auth,
  request,
}: {
  auth: GetResponseAuthValue;
  request: GetResponseNewContactRequest;
}): Promise<GetResponseContact> {
  return sendPostRequest<GetResponseNewContactRequest, GetResponseContact>({
    auth,
    path: '/contacts',
    body: request,
  });
}

export async function updateGetResponseContact({
  auth,
  contactId,
  request,
}: {
  auth: GetResponseAuthValue;
  contactId: string;
  request: GetResponseUpdateContactRequest;
}): Promise<GetResponseContact> {
  return sendPostRequest<GetResponseUpdateContactRequest, GetResponseContact>({
    auth,
    path: `/contacts/${contactId}`,
    body: request,
  });
}

export async function createGetResponseNewsletter({
  auth,
  request,
}: {
  auth: GetResponseAuthValue;
  request: GetResponseNewNewsletterRequest;
}): Promise<GetResponseNewsletter> {
  return sendPostRequest<GetResponseNewNewsletterRequest, GetResponseNewsletter>({
    auth,
    path: '/newsletters',
    body: request,
  });
}

export function flattenGetResponseCampaign(
  campaign: GetResponseCampaign,
): GetResponseFlatRecord {
  return {
    campaign_id: campaign.campaignId,
    name: campaign.name ?? null,
    description: campaign.description ?? null,
    language_code: campaign.languageCode ?? null,
    is_default: campaign.isDefault ?? null,
    created_on: campaign.createdOn ?? null,
    href: campaign.href ?? null,
  };
}

export function flattenGetResponseContact(
  contact: GetResponseContact,
): GetResponseFlatRecord {
  return {
    contact_id: contact.contactId,
    name: contact.name ?? null,
    email: contact.email,
    campaign_id: contact.campaign?.campaignId ?? null,
    campaign_name: contact.campaign?.name ?? null,
    day_of_cycle: contact.dayOfCycle ?? null,
    scoring: contact.scoring ?? null,
    engagement_score: contact.engagementScore ?? null,
    origin: contact.origin ?? null,
    time_zone: contact.timeZone ?? null,
    note: contact.note ?? null,
    tags: formatContactTags(contact.tags),
    custom_field_values: formatContactCustomFieldValues(
      contact.customFieldValues,
    ),
    created_on: contact.createdOn ?? null,
    changed_on: contact.changedOn ?? null,
    href: contact.href ?? null,
  };
}

export function flattenGetResponseNewsletter(
  newsletter: GetResponseNewsletter,
): GetResponseFlatRecord {
  return {
    newsletter_id: newsletter.newsletterId,
    name: newsletter.name ?? null,
    subject: newsletter.subject ?? null,
    type: newsletter.type ?? null,
    status: newsletter.status ?? null,
    campaign_id: newsletter.campaign?.campaignId ?? null,
    campaign_name: newsletter.campaign?.name ?? null,
    from_field_id: newsletter.fromField?.fromFieldId ?? null,
    reply_to_field_id: newsletter.replyTo?.fromFieldId ?? null,
    selected_campaigns: newsletter.sendSettings?.selectedCampaigns.join(', ') ?? null,
    content_html: newsletter.content?.html ?? null,
    content_plain: newsletter.content?.plain ?? null,
    send_on: newsletter.sendOn ?? null,
    created_on: newsletter.createdOn ?? null,
    href: newsletter.href ?? null,
  };
}

function sendGetRequest<TResponse>({
  auth,
  path,
  queryParams,
}: {
  auth: GetResponseAuthValue;
  path: string;
  queryParams?: GetResponseQueryParams;
}): Promise<TResponse> {
  return sendRequest<TResponse>({
    auth,
    method: HttpMethod.GET,
    path,
    queryParams,
  });
}

function sendPostRequest<TRequest extends Record<string, unknown>, TResponse>({
  auth,
  path,
  body,
}: {
  auth: GetResponseAuthValue;
  path: string;
  body: TRequest;
}): Promise<TResponse> {
  return sendRequest<TResponse>({
    auth,
    method: HttpMethod.POST,
    path,
    body,
  });
}

async function sendRequest<TResponse>({
  auth,
  method,
  path,
  body,
  queryParams,
}: {
  auth: GetResponseAuthValue;
  method: HttpMethod;
  path: string;
  body?: Record<string, unknown>;
  queryParams?: GetResponseQueryParams;
}): Promise<TResponse> {
  const request: HttpRequest<Record<string, unknown> | string> = {
    method,
    url: `${GETRESPONSE_API_URL}${path}`,
    headers: createHeaders(auth),
    queryParams,
    body,
  };
  const response = await httpClient.sendRequest<TResponse>(request);
  return response.body;
}

function createHeaders(auth: GetResponseAuthValue): Record<string, string> {
  const headers: Record<string, string> = {
    Accept: 'application/json',
    'Content-Type': 'application/json',
  };

  if (auth.type === AppConnectionType.OAUTH2) {
    headers['Authorization'] = `Bearer ${auth.access_token}`;
  } else {
    headers['X-Auth-Token'] = `api-key ${auth.props.apiKey}`;
  }

  return headers;
}

function formatContactTags(
  tags: GetResponseContactTag[] | undefined,
): string | null {
  if (!tags || tags.length === 0) {
    return null;
  }
  return tags.map((tag) => tag.name ?? tag.tagId).join(', ');
}

function formatContactCustomFieldValues(
  customFieldValues: GetResponseContactCustomFieldValue[] | undefined,
): string | null {
  if (!customFieldValues || customFieldValues.length === 0) {
    return null;
  }
  return customFieldValues
    .map((customFieldValue) => {
      const joinedValues = customFieldValue.value.join('|');
      return `${customFieldValue.customFieldId}:${joinedValues}`;
    })
    .join(', ');
}

const GETRESPONSE_API_URL = 'https://api.getresponse.com/v3';

export type GetResponseFlatRecord = Record<
  string,
  string | number | boolean | null
>;

type GetResponseCampaign = {
  campaignId: string;
  name?: string | null;
  description?: string | null;
  languageCode?: string | null;
  isDefault?: string | null;
  createdOn?: string | null;
  href?: string | null;
};

type GetResponseCampaignReference = {
  campaignId: string;
  name?: string | null;
  href?: string | null;
};

type GetResponseContact = {
  contactId: string;
  name?: string | null;
  email: string;
  campaign?: GetResponseCampaignReference | null;
  dayOfCycle?: string | null;
  scoring?: number | null;
  engagementScore?: number | null;
  origin?: string | null;
  timeZone?: string | null;
  note?: string | null;
  tags?: GetResponseContactTag[];
  customFieldValues?: GetResponseContactCustomFieldValue[];
  createdOn?: string | null;
  changedOn?: string | null;
  href?: string | null;
};

type GetResponseContactCustomFieldValue = {
  customFieldId: string;
  value: string[];
};

type GetResponseContactTag = {
  tagId: string;
  name?: string | null;
};

type GetResponseFromField = {
  fromFieldId: string;
  email: string;
  name?: string | null;
  isActive?: string | null;
  isDefault?: string | null;
  createdOn?: string | null;
  href?: string | null;
};

type GetResponseFromFieldReference = {
  fromFieldId: string;
  href?: string | null;
};

type GetResponseMessageContent = {
  html?: string;
  plain?: string;
};

type GetResponseNewContactRequest = {
  email: string;
  campaign: GetResponseCampaignReference;
  name?: string;
};

type GetResponseNewNewsletterRequest = {
  subject: string;
  fromField: GetResponseFromFieldReference;
  campaign: GetResponseCampaignReference;
  content: GetResponseMessageContent;
  sendSettings: GetResponseNewsletterSendSettings;
  name?: string;
  replyTo?: GetResponseFromFieldReference;
};

type GetResponseNewsletter = {
  newsletterId: string;
  name?: string | null;
  subject?: string | null;
  type?: string | null;
  status?: string | null;
  campaign?: GetResponseCampaignReference | null;
  fromField?: GetResponseFromFieldReference | null;
  replyTo?: GetResponseFromFieldReference | null;
  sendSettings?: GetResponseNewsletterSendSettings;
  content?: GetResponseMessageContent | null;
  sendOn?: string | null;
  createdOn?: string | null;
  href?: string | null;
};

type GetResponseNewsletterSendSettings = {
  selectedCampaigns: string[];
};

type GetResponseQueryParams = Record<string, string>;

type GetResponseUpdateContactRequest = {
  campaign?: GetResponseCampaignReference;
  email?: string;
  name?: string;
};