Skip to content

feat: add contact properties #705

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

Merged
Cisneiros merged 2 commits into from
Oct 22, 2025
Merged

feat: add contact properties #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e97187d
feat: add contact properties
Cisneiros Oct 21, 2025
805fb4a
update tests
Cisneiros Oct 21, 2025
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
40 changes: 40 additions & 0 deletions src/common/utils/parse-contact-properties-to-api-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import type {
ApiContactProperty,
ContactProperty,
} from '../../contact-properties/interfaces/contact-property';
import type {
CreateContactPropertyApiOptions,
CreateContactPropertyOptions,
} from '../../contact-properties/interfaces/create-contact-property-options.interface';
import type {
UpdateContactPropertyApiOptions,
UpdateContactPropertyOptions,
} from '../../contact-properties/interfaces/update-contact-property-options.interface';

export function parseContactPropertyFromApi(
contactProperty: ApiContactProperty,
): ContactProperty {
return {
id: contactProperty.id,
key: contactProperty.key,
object: contactProperty.object,
createdAt: contactProperty.created_at,
type: contactProperty.type,
fallbackValue: contactProperty.fallback_value,
} as ContactProperty;
}

export function parseContactPropertyToApiOptions(
contactProperty: CreateContactPropertyOptions | UpdateContactPropertyOptions,
): CreateContactPropertyApiOptions | UpdateContactPropertyApiOptions {
if ('key' in contactProperty) {
return {
key: contactProperty.key,
type: contactProperty.type,
fallback_value: contactProperty.fallbackValue,
};
}
return {
fallback_value: contactProperty.fallbackValue,
};
}
331 changes: 331 additions & 0 deletions src/contact-properties/contact-properties.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,331 @@
import createFetchMock from 'vitest-fetch-mock';
import type { ErrorResponse } from '../interfaces';
import { Resend } from '../resend';
import {
mockErrorResponse,
mockSuccessResponse,
} from '../test-utils/mock-fetch';
import type {
CreateContactPropertyOptions,
CreateContactPropertyResponseSuccess,
} from './interfaces/create-contact-property-options.interface';
import type { RemoveContactPropertyResponseSuccess } from './interfaces/delete-contact-property-options.interface';
import type { GetContactPropertyResponseSuccess } from './interfaces/get-contact-property.interface';
import type { ListContactPropertiesResponseSuccess } from './interfaces/list-contact-properties-options.interface';
import type {
UpdateContactPropertyOptions,
UpdateContactPropertyResponseSuccess,
} from './interfaces/update-contact-property-options.interface';

const fetchMocker = createFetchMock(vi);
fetchMocker.enableMocks();

describe('ContactProperties', () => {
afterEach(() => fetchMock.resetMocks());
afterAll(() => fetchMocker.disableMocks());

describe('create', () => {
it('creates a contact property', async () => {
const payload: CreateContactPropertyOptions = {
key: 'country',
type: 'string',
fallbackValue: 'unknown',
};
const response: CreateContactPropertyResponseSuccess = {
object: 'contact_property',
id: '3deaccfb-f47f-440a-8875-ea14b1716b43',
};

mockSuccessResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.create(payload),
).resolves.toMatchInlineSnapshot(`
{
"data": {
"id": "3deaccfb-f47f-440a-8875-ea14b1716b43",
"object": "contact_property",
},
"error": null,
}
`);
});

it('throws error when missing key', async () => {
// @ts-expect-error - Testing invalid input
const payload: CreateContactPropertyOptions = {
type: 'string',
fallbackValue: 'unknown',
};
const response: ErrorResponse = {
statusCode: 422,
name: 'missing_required_field',
message: 'Missing `key` field.',
};

mockErrorResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.create(payload),
).resolves.toMatchInlineSnapshot(`
{
"data": null,
"error": {
"message": "Missing \`key\` field.",
"name": "missing_required_field",
"statusCode": 422,
},
}
`);
});
});

describe('list', () => {
it('lists contact properties', async () => {
const response: ListContactPropertiesResponseSuccess = {
data: [
{
id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
key: 'country',
type: 'string',
fallback_value: 'unknown',
object: 'contact_property',
created_at: '2021-01-01T00:00:00.000Z',
},
{
id: 'ac7503ac-e027-4aea-94b3-b0acd46f65f9',
key: 'edition',
type: 'number',
fallback_value: 1,
object: 'contact_property',
created_at: '2021-01-01T00:00:00.000Z',
},
],
object: 'list',
has_more: false,
};
mockSuccessResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.list(),
).resolves.toMatchInlineSnapshot(`
{
"data": {
"data": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"fallbackValue": "unknown",
"id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
"key": "country",
"object": "contact_property",
"type": "string",
},
{
"createdAt": "2021-01-01T00:00:00.000Z",
"fallbackValue": 1,
"id": "ac7503ac-e027-4aea-94b3-b0acd46f65f9",
"key": "edition",
"object": "contact_property",
"type": "number",
},
],
"has_more": false,
"object": "list",
},
"error": null,
}
`);
});
});

describe('get', () => {
it('gets a contact property by id', async () => {
const response: GetContactPropertyResponseSuccess = {
id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
key: 'country',
type: 'string',
fallback_value: 'unknown',
object: 'contact_property',
created_at: '2021-01-01T00:00:00.000Z',
};
mockSuccessResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.get('b6d24b8e-af0b-4c3c-be0c-359bbd97381e'),
).resolves.toMatchInlineSnapshot(`
{
"data": {
"createdAt": "2021-01-01T00:00:00.000Z",
"fallbackValue": "unknown",
"id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
"key": "country",
"object": "contact_property",
"type": "string",
},
"error": null,
}
`);
});

it('returns error when missing id', async () => {
const response: ErrorResponse = {
statusCode: null,
name: 'missing_required_field',
message: 'Missing `id` field.',
};
mockErrorResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.get(''),
).resolves.toMatchInlineSnapshot(`
{
"data": null,
"error": {
"message": "Missing \`id\` field.",
"name": "missing_required_field",
"statusCode": null,
},
}
`);
});

it('returns error when contact property not found', async () => {
const response: ErrorResponse = {
statusCode: 404,
name: 'not_found',
message: 'Contact property not found',
};
mockErrorResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.get('b6d24b8e-af0b-4c3c-be0c-359bbd97381e'),
).resolves.toMatchInlineSnapshot(`
{
"data": null,
"error": {
"message": "Contact property not found",
"name": "not_found",
"statusCode": 404,
},
}
`);
});
});

describe('update', () => {
it('updates a contact property', async () => {
const payload: UpdateContactPropertyOptions = {
id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
fallbackValue: 'new value',
};
const response: UpdateContactPropertyResponseSuccess = {
id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
object: 'contact_property',
};
mockSuccessResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.update(payload),
).resolves.toMatchInlineSnapshot(`
{
"data": {
"id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
"object": "contact_property",
},
"error": null,
}
`);
});
it('returns error when missing id', async () => {
const payload: UpdateContactPropertyOptions = {
id: '',
fallbackValue: 'new value',
};
const response: ErrorResponse = {
statusCode: null,
name: 'missing_required_field',
message: 'Missing `id` field.',
};
mockErrorResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.update(payload),
).resolves.toMatchInlineSnapshot(`
{
"data": null,
"error": {
"message": "Missing \`id\` field.",
"name": "missing_required_field",
"statusCode": null,
},
}
`);
});
});

describe('remove', () => {
it('removes a contact property', async () => {
const response: RemoveContactPropertyResponseSuccess = {
deleted: true,
id: 'b6d24b8e-af0b-4c3c-be0c-359bbd97381e',
object: 'contact_property',
};
mockSuccessResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.remove('b6d24b8e-af0b-4c3c-be0c-359bbd97381e'),
).resolves.toMatchInlineSnapshot(`
{
"data": {
"deleted": true,
"id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
"object": "contact_property",
},
"error": null,
}
`);
});

it('returns error when missing id', async () => {
const response: ErrorResponse = {
statusCode: null,
name: 'missing_required_field',
message: 'Missing `id` field.',
};
mockErrorResponse(response, {
headers: { Authorization: 'Bearer re_924b3rjh2387fbewf823' },
});
const resend = new Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
await expect(
resend.contactProperties.remove(''),
).resolves.toMatchInlineSnapshot(`
{
"data": null,
"error": {
"message": "Missing \`id\` field.",
"name": "missing_required_field",
"statusCode": null,
},
}
`);
});
});
});
Loading
Loading