-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcampaigns.ts
More file actions
243 lines (221 loc) · 7.69 KB
/
campaigns.ts
File metadata and controls
243 lines (221 loc) · 7.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
import {
AbortCampaignParams,
ActivateTriggeredCampaignParams,
ArchiveCampaignsParams,
ArchiveCampaignsResponse,
ArchiveCampaignsResponseSchema,
CampaignMetricsResponse,
CancelCampaignParams,
CreateBlastCampaignParams,
CreateCampaignResponse,
CreateCampaignResponseSchema,
CreateTriggeredCampaignParams,
DeactivateTriggeredCampaignParams,
GetCampaignMetricsParams,
GetCampaignParams,
GetCampaignResponse,
GetCampaignResponseSchema,
GetCampaignsParams,
GetCampaignsResponse,
GetCampaignsResponseSchema,
GetChildCampaignsParams,
GetChildCampaignsResponse,
GetChildCampaignsResponseSchema,
ScheduleCampaignParams,
SendCampaignParams,
TriggerCampaignParams,
} from "../types/campaigns.js";
import {
formatSortParam,
IterableSuccessResponse,
IterableSuccessResponseSchema,
} from "../types/common.js";
import type { BaseIterableClient, Constructor } from "./base.js";
import { parseCsv, validateResponse } from "./base.js";
/**
* Campaigns operations mixin
*/
export function Campaigns<T extends Constructor<BaseIterableClient>>(Base: T) {
return class extends Base {
async getCampaigns(
params?: GetCampaignsParams,
opts?: {
signal?: AbortSignal;
}
): Promise<GetCampaignsResponse> {
// Always use pagination with defaults to ensure consistent API behavior
const page = params?.page ?? 1;
const pageSize = params?.pageSize ?? 10;
const sort = params?.sort;
const queryParams = new URLSearchParams();
queryParams.append("page", page.toString());
queryParams.append("pageSize", pageSize.toString());
const sortString = formatSortParam(sort);
if (sortString) {
queryParams.append("sort", sortString);
}
const url = `/api/campaigns?${queryParams.toString()}`;
const response = await this.client.get(
url,
opts?.signal ? { signal: opts.signal } : {}
);
return validateResponse(response, GetCampaignsResponseSchema);
}
async getCampaign(
params: GetCampaignParams,
opts?: { signal?: AbortSignal }
): Promise<GetCampaignResponse> {
const response = await this.client.get(
`/api/campaigns/${params.id}`,
opts?.signal ? { signal: opts.signal } : {}
);
return validateResponse(response, GetCampaignResponseSchema);
}
async createBlastCampaign(
params: CreateBlastCampaignParams
): Promise<CreateCampaignResponse> {
const response = await this.client.post("/api/campaigns/create", {
...params,
scheduleSend: false,
});
return validateResponse(response, CreateCampaignResponseSchema);
}
async createTriggeredCampaign(
params: CreateTriggeredCampaignParams
): Promise<CreateCampaignResponse> {
const response = await this.client.post("/api/campaigns/create", params);
return validateResponse(response, CreateCampaignResponseSchema);
}
async getChildCampaigns(
params: GetChildCampaignsParams,
opts?: {
signal?: AbortSignal;
}
): Promise<GetChildCampaignsResponse> {
// Always use pagination with defaults to ensure consistent API behavior
const page = params?.page ?? 1;
const pageSize = params?.pageSize ?? 10;
const sort = params?.sort;
const queryParams = new URLSearchParams();
queryParams.append("page", page.toString());
queryParams.append("pageSize", pageSize.toString());
const sortString = formatSortParam(sort);
if (sortString) {
queryParams.append("sort", sortString);
}
const url = `/api/campaigns/recurring/${params.id}/childCampaigns?${queryParams.toString()}`;
const response = await this.client.get(
url,
opts?.signal ? { signal: opts.signal } : {}
);
return validateResponse(response, GetChildCampaignsResponseSchema);
}
async getCampaignMetrics(
options: GetCampaignMetricsParams
): Promise<CampaignMetricsResponse> {
const params = new URLSearchParams();
params.append("campaignId", options.campaignId.toString());
if (options.startDateTime)
params.append("startDateTime", options.startDateTime);
if (options.endDateTime)
params.append("endDateTime", options.endDateTime);
const response = await this.client.get(
`/api/campaigns/metrics?${params.toString()}`,
{
responseType: "text",
}
);
// Parse CSV response into array of objects
return parseCsv(response);
}
async scheduleCampaign(
params: ScheduleCampaignParams
): Promise<IterableSuccessResponse> {
const { campaignId, ...scheduleParams } = params;
const response = await this.client.post(
`/api/campaigns/${campaignId}/schedule`,
scheduleParams
);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Abort a campaign
* Stops a campaign that is currently running
*/
async abortCampaign(
params: AbortCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post("/api/campaigns/abort", params);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Cancel a scheduled or recurring campaign
*/
async cancelCampaign(
params: CancelCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post("/api/campaigns/cancel", params);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Activate a triggered campaign
* Note: API triggered campaign activation must be enabled for your project
*/
async activateTriggeredCampaign(
params: ActivateTriggeredCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post(
"/api/campaigns/activateTriggered",
params
);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Deactivate a triggered campaign
* Note: API triggered campaign deactivation must be enabled for your project
*/
async deactivateTriggeredCampaign(
params: DeactivateTriggeredCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post(
"/api/campaigns/deactivateTriggered",
params
);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Archive one or more campaigns
* This behaves the same as the archive feature in the UI:
* - Scheduled or recurring campaigns will be cancelled
* - Running campaigns will be aborted
* - Archived campaigns will be hidden from the Campaigns page but viewable in the Archived tab
* Rate limit: 5 requests/second, per API key
*/
async archiveCampaigns(
params: ArchiveCampaignsParams
): Promise<ArchiveCampaignsResponse> {
const response = await this.client.post("/api/campaigns/archive", params);
return validateResponse(response, ArchiveCampaignsResponseSchema);
}
/**
* Trigger a campaign to send to specified lists
*/
async triggerCampaign(
params: TriggerCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post("/api/campaigns/trigger", params);
return validateResponse(response, IterableSuccessResponseSchema);
}
/**
* Send an existing campaign immediately
*/
async sendCampaign(
params: SendCampaignParams
): Promise<IterableSuccessResponse> {
const response = await this.client.post(
`/api/campaigns/${params.campaignId}/send`
);
return validateResponse(response, IterableSuccessResponseSchema);
}
};
}