Added set_marketing_consent

Author: 0xdeafcafe

README.md

@@ -246,6 +246,19 @@ Returns the selected marketing consent level for a user. An error with the code
 
 - `level`: The consent level selected. Either `general` or `none`.
 
+### `set_marketing_consent`
+
+Returns the selected marketing consent level for a user. An error with the code `awaiting_consent` will be returned if the user hasn't set a consent level yet.
+
+#### Request
+
+```json
+{
+	"user_id": "user_000000C2kdCzNlbL1BqR5FeMatItU",
+	"level": "general"
+}
+```
+
 ## Webhooks
 
 Webhooks URL's comprise of two parts; the webhook indicator, followed by the provider value. Each provider has an example below.
@@ -325,7 +338,19 @@ interface Identifiers {
 }
 ```
 
-### `provider_mappings`
+### `marketing-consent`
+
+```ts
+interface MarketingConsent {
+	id: string;
+	userId: string;
+	level: 'none' | 'general';
+	createdAt: string;
+	updatedAt: string | null;
+}
+```
+
+### `provider-mappings`
 
 ```ts
 interface ExternalMappings {
@@ -338,7 +363,7 @@ interface ExternalMappings {
 }
 ```
 
-### `refresh_tokens`
+### `refresh-tokens`
 
 ```ts
 interface RefreshTokens {

src/app/set-marketing-consent.ts

@@ -0,0 +1,31 @@
+import mailchimpMarketing from '@mailchimp/mailchimp_marketing';
+import crypto from 'crypto';
+
+import { ConsentLevel } from '../db/marketing-consent';
+import { Context, SetMarketingConsentRequest } from '../types';
+
+export default async function setMarketingConsent(ctx: Context, request: SetMarketingConsentRequest): Promise<void> {
+	console.log(request);
+
+	const user = await ctx.app.dbClient.users.findUser(request.userId);
+	const identifiers = await ctx.app.dbClient.identifiers.listUserIdentifiers(user.id);
+	const emails = identifiers.filter(i => i.identifierType === 'email' && !i.removedAt);
+
+	// For each email, set consent
+	await Promise.all(emails.map(async e => {
+		const digest = crypto.createHash('md5')
+			.update(e.identifierValue)
+			.digest('hex');
+
+		await setMailchimpMarketingLevel(e.identifierValue, digest, request.level);
+	}));
+
+	await ctx.app.dbClient.marketingConsent.upsertMarketingConsent(user.id, request.level);
+}
+
+async function setMailchimpMarketingLevel(email: string, hash: string, level: ConsentLevel) {
+	await mailchimpMarketing.lists.updateListMember('e580e6811f', hash, {
+		email_address: email,
+		status: level === 'none' ? 'unsubscribed' : 'subscribed',
+	});
+}

src/db/marketing-consent.ts

@@ -36,7 +36,6 @@ export default class MarketingConsents extends Collection<MarketingConsent> {
 				_id: id,
 				userId,
 				createdAt: now,
-				removedAt: null,
 			},
 		}, { upsert: true });
 	}

src/interface/rpc/index.ts

@@ -1,5 +1,5 @@
 import { APIGatewayProxyEventV2 } from 'aws-lambda';
-import * as camelCaseKeys from 'camelcase-keys';
+import camelCaseKeys from 'camelcase-keys';
 import { validate } from 'jsonschema';
 import { Logger } from 'tslog';
 
@@ -15,19 +15,20 @@ import getUser, { getUserSchema } from './get-user';
 import listNewsItems, { listNewsItemsSchema } from './list-news-items';
 import handleAuth from './middleware/auth';
 import sendMagicLink, { sendMagicLinkSchema } from './send-magic-link';
+import setMarketingConsent, { setMarketingConsentSchema } from './set-marketing-consent';
 
 const urlRegex = /^\/(\d)\/([\d-]+)\/(.+)$/;
 const qualifierRegex = /^\/\d\/[\d-]+\//;
 
 const v20201214: VersionSet = {
-	send_magic_link: {
-		impl: sendMagicLink,
-		schema: sendMagicLinkSchema,
-	},
 	authenticate_user: {
 		impl: authenticateUser,
 		schema: authenticateUserSchema,
 	},
+	enrol_alpha_user: {
+		impl: enrolAlphaUser,
+		schema: enrolAlphaUserSchema,
+	},
 	get_marketing_consent: {
 		impl: getMarketingConsent,
 		schema: getMarketingConsentSchema,
@@ -36,14 +37,18 @@ const v20201214: VersionSet = {
 		impl: getSubscriptionStatus20201214,
 		schema: getSubscriptionStatusSchema20201214,
 	},
-	enrol_alpha_user: {
-		impl: enrolAlphaUser,
-		schema: enrolAlphaUserSchema,
-	},
 	list_news_items: {
 		impl: listNewsItems,
 		schema: listNewsItemsSchema,
 	},
+	send_magic_link: {
+		impl: sendMagicLink,
+		schema: sendMagicLinkSchema,
+	},
+	set_marketing_consent: {
+		impl: setMarketingConsent,
+		schema: setMarketingConsentSchema,
+	},
 };
 
 const v20211006: VersionSet = {

src/interface/rpc/set-marketing-consent.json

@@ -0,0 +1,21 @@
+{
+	"type": "object",
+	"additionalProperties": false,
+
+	"required": [
+		"user_id",
+		"level"
+	],
+
+	"properties": {
+		"user_id": {
+			"type": "string",
+			"minLength": 1
+		},
+
+		"level": {
+			"type": "string",
+			"enum": ["none", "general"]
+		}
+	}
+}

src/interface/rpc/set-marketing-consent.ts

@@ -0,0 +1,16 @@
+import setMarketingConsentImpl from '../../app/set-marketing-consent';
+import { Context, SetMarketingConsentRequest } from '../../types';
+import Squawk from '../../utils/squawk';
+import setMarketingConsentSchema from './set-marketing-consent.json';
+
+export default async function setMarketingConsent(ctx: Context, request: SetMarketingConsentRequest) {
+	if (!ctx.auth)
+		throw new Squawk('access_denied');
+
+	if (ctx.auth.type !== 'internal' && ctx.auth.userId !== request.userId)
+		throw new Squawk('access_denied');
+
+	return await setMarketingConsentImpl(ctx, request);
+}
+
+export { setMarketingConsentSchema };

src/types.ts

@@ -1,10 +1,10 @@
 import { SESClient } from '@aws-sdk/client-ses';
-import { ConsentLevel } from './db/marketing-consent';
-import { CancelType } from './db/subscriptions';
 import { Stripe } from 'stripe';
 import { Logger } from 'tslog';
 
 import DbClient from './db';
+import { ConsentLevel } from './db/marketing-consent';
+import { CancelType } from './db/subscriptions';
 
 export interface Config {
 	env: string;
@@ -13,6 +13,7 @@ export interface Config {
 	stpSecretKey: string;
 	stpWebhookSecret: string;
 	stpSubscriptionPriceId: string;
+	mailchimpApiKey: string;
 	requiredCoupon?: string;
 	mongoUri: string;
 	internalKey: string;