Skip to content

Commit

Permalink
feat: Add sequence step list and template list (#234)
Browse files Browse the repository at this point in the history
* add Outreach sequence and template lists

* remove passthrough
  • Loading branch information
zkirby authored Jul 14, 2023
1 parent 295f12f commit c345482
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vesselapi/integrations",
"version": "1.0.23",
"version": "1.0.24",
"description": "Vessel integrations",
"main": "dist/index.js",
"module": "dist/index.mjs",
Expand Down
50 changes: 50 additions & 0 deletions src/platforms/outreach/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,31 @@ export const client = {
),
},
sequenceSteps: {
list: request(
({
cursor,
filters,
include,
}: {
cursor?: `${typeof BASE_URL}/${string}`;
filters?: { sequenceIds?: string };
include?: string;
}) => ({
url: cursor ?? `/sequenceSteps`,
query: shake({
'page[size]': `${DEFAULT_PAGE_SIZE}`,
'filter[sequence][id]': filters?.sequenceIds,
include,
}),
method: 'GET',
schema: z.intersection(
z.object({
data: z.array(outreachSequenceStep),
}),
outreachPaginatedResponse,
),
}),
),
create: request(
(sequenceStep: {
attributes: {
Expand Down Expand Up @@ -412,6 +437,31 @@ export const client = {
),
},
sequenceTemplates: {
list: request(
({
cursor,
filters,
include,
}: {
cursor?: `${typeof BASE_URL}/${string}`;
filters?: { ids?: string };
include?: string;
}) => ({
url: cursor ?? `/sequenceTemplates`,
query: shake({
'page[size]': `${DEFAULT_PAGE_SIZE}`,
'filter[id]': filters?.ids,
include,
}),
method: 'GET',
schema: z.intersection(
z.object({
data: z.array(outreachSequenceTemplate),
}),
outreachPaginatedResponse,
),
}),
),
create: request(
(sequenceTemplate: {
attributes: {
Expand Down
76 changes: 76 additions & 0 deletions src/platforms/outreach/schemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,90 @@ export const outreachMailing = z.object({

export const outreachSequenceStep = custom.object({
id: z.number(),
attributes: z.object({
bounceCount: z.number().nullable(),
clickCount: z.number().nullable(),
createdAt: custom.date().nullable(),
date: custom.date().nullable(),
deliverCount: z.number().nullable(),
displayName: z.string().nullable(),
failureCount: z.number().nullable(),
interval: z.number().nullable(),
negativeReplyCount: z.number().nullable(),
neutralReplyCount: z.number().nullable(),
openCount: z.number().nullable(),
optOutCount: z.number().nullable(),
order: z.number().nullable(),
positiveReplyCount: z.number().nullable(),
replyCount: z.number().nullable(),
scheduleCount: z.number().nullable(),
stepType: z.string().nullable(),
taskAutoskipDelay: z.number().nullable(),
taskNote: z.string().nullable(),
updatedAt: custom.date().nullable(),
}),
relationships: z.object({
sequence: outreachRelationship.nullable(),
sequenceTemplates: outreachRelationship.nullable(),
}),
});

export const outreachTemplate = custom.object({
id: z.number(),
attributes: z.object({
archived: z.boolean().nullable(),
archivedAt: custom.date().nullable(),
bccRecipients: z.string().nullable(),
bodyHtml: z.string().nullable(),
bodyText: z.string().nullable(),
bounceCount: z.number().nullable(),
ccRecipients: z.string().nullable(),
clickCount: z.number().nullable(),
createdAt: custom.date().nullable(),
deliverCount: z.number().nullable(),
failureCount: z.number().nullable(),
lastUsedAt: custom.date().nullable(),
name: z.string().nullable(),
negativeReplyCount: z.number().nullable(),
neutralReplyCount: z.number().nullable(),
openCount: z.number().nullable(),
optOutCount: z.number().nullable(),
positiveReplyCount: z.number().nullable(),
replyCount: z.number().nullable(),
scheduleCount: z.number().nullable(),
shareType: z.string().nullable(),
subject: z.string().nullable(),
tags: z.string().nullable(),
toRecipients: z.string().nullable(),
trackLinks: z.boolean().nullable(),
trackOpens: z.boolean().nullable(),
updatedAt: custom.date().nullable(),
}),
});

export const outreachSequenceTemplate = custom.object({
id: z.number(),
attributes: z.object({
bounceCount: z.number().nullable(),
clickCount: z.number().nullable(),
createdAt: custom.date().nullable(),
deliverCount: z.number().nullable(),
enabled: z.boolean().nullable(),
enabledAt: custom.date().nullable(),
failureCount: z.number().nullable(),
isReply: z.boolean().nullable(),
negativeReplyCount: z.number().nullable(),
neutralReplyCount: z.number().nullable(),
openCount: z.number().nullable(),
optOutCount: z.number().nullable(),
positiveReplyCount: z.number().nullable(),
replyCount: z.number().nullable(),
scheduleCount: z.number().nullable(),
updatedAt: custom.date().nullable(),
}),
relationships: z.object({
template: outreachTemplate.nullable(),
}),
});

export type OutreachProspect = z.infer<typeof outreachProspect>;
Expand Down

0 comments on commit c345482

Please sign in to comment.