-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsequences.py
More file actions
406 lines (342 loc) · 18.4 KB
/
Copy pathsequences.py
File metadata and controls
406 lines (342 loc) · 18.4 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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
"""
Sequences client for Stack0 Mail API
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from .types import (
AddContactToSequenceRequest,
ArchiveSequenceResponse,
CreateConnectionRequest,
CreateNodeRequest,
CreateSequenceRequest,
DeleteConnectionResponse,
DeleteNodeResponse,
DeleteSequenceResponse,
ListSequenceEntriesRequest,
ListSequenceEntriesResponse,
ListSequencesRequest,
ListSequencesResponse,
PauseSequenceResponse,
PublishSequenceResponse,
RemoveContactFromSequenceRequest,
RemoveContactFromSequenceResponse,
ResumeSequenceResponse,
Sequence,
SequenceAnalyticsResponse,
SequenceConnection,
SequenceEntry,
SequenceNode,
SequenceWithNodes,
SetNodeBranchRequest,
SetNodeEmailRequest,
SetNodeExperimentRequest,
SetNodeFilterRequest,
SetNodeTimerRequest,
UpdateNodePositionRequest,
UpdateNodeRequest,
UpdateSequenceRequest,
)
if TYPE_CHECKING:
from .._client.http import AsyncHTTPClient, HTTPClient
class Sequences:
"""Synchronous sequences client"""
def __init__(self, http: HTTPClient) -> None:
self._http = http
# Sequence CRUD
def list(self, request: ListSequencesRequest | None = None) -> ListSequencesResponse:
"""List all sequences"""
params: list[str] = []
if request:
if request.environment:
params.append(f"environment={request.environment}")
if request.limit:
params.append(f"limit={request.limit}")
if request.offset:
params.append(f"offset={request.offset}")
if request.search:
params.append(f"search={request.search}")
if request.status:
params.append(f"status={request.status}")
if request.trigger_type:
params.append(f"triggerType={request.trigger_type}")
query = "&".join(params)
path = f"/mail/sequences{'?' + query if query else ''}"
data = self._http.get(path)
return ListSequencesResponse.model_validate(data)
def get(self, id: str) -> SequenceWithNodes:
"""Get a sequence by ID with all nodes and connections"""
data = self._http.get(f"/mail/sequences/{id}")
return SequenceWithNodes.model_validate(data)
def create(self, request: CreateSequenceRequest) -> Sequence:
"""Create a new sequence"""
data = self._http.post("/mail/sequences", request.model_dump(by_alias=True, exclude_none=True))
return Sequence.model_validate(data)
def update(self, request: UpdateSequenceRequest) -> Sequence:
"""Update a sequence"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = self._http.put(f"/mail/sequences/{request.id}", body)
return Sequence.model_validate(data)
def delete(self, id: str) -> DeleteSequenceResponse:
"""Delete a sequence"""
data = self._http.delete(f"/mail/sequences/{id}")
return DeleteSequenceResponse.model_validate(data)
# Sequence lifecycle
def publish(self, id: str) -> PublishSequenceResponse:
"""Publish (activate) a sequence"""
data = self._http.post(f"/mail/sequences/{id}/publish", {})
return PublishSequenceResponse.model_validate(data)
def pause(self, id: str) -> PauseSequenceResponse:
"""Pause an active sequence"""
data = self._http.post(f"/mail/sequences/{id}/pause", {})
return PauseSequenceResponse.model_validate(data)
def resume(self, id: str) -> ResumeSequenceResponse:
"""Resume a paused sequence"""
data = self._http.post(f"/mail/sequences/{id}/resume", {})
return ResumeSequenceResponse.model_validate(data)
def archive(self, id: str) -> ArchiveSequenceResponse:
"""Archive a sequence"""
data = self._http.post(f"/mail/sequences/{id}/archive", {})
return ArchiveSequenceResponse.model_validate(data)
def duplicate(self, id: str, name: str | None = None) -> Sequence:
"""Duplicate a sequence"""
data = self._http.post(f"/mail/sequences/{id}/duplicate", {"name": name} if name else {})
return Sequence.model_validate(data)
# Node management
def create_node(self, request: CreateNodeRequest) -> SequenceNode:
"""Create a new node in a sequence"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = self._http.post(f"/mail/sequences/{request.id}/nodes", body)
return SequenceNode.model_validate(data)
def update_node(self, request: UpdateNodeRequest) -> SequenceNode:
"""Update a node"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id", "node_id"})
data = self._http.put(f"/mail/sequences/{request.id}/nodes/{request.node_id}", body)
return SequenceNode.model_validate(data)
def update_node_position(self, request: UpdateNodePositionRequest) -> SequenceNode:
"""Update node position"""
data = self._http.put(
f"/mail/sequences/{request.id}/nodes/{request.node_id}/position",
{"positionX": request.position_x, "positionY": request.position_y},
)
return SequenceNode.model_validate(data)
def delete_node(self, sequence_id: str, node_id: str) -> DeleteNodeResponse:
"""Delete a node"""
data = self._http.delete(f"/mail/sequences/{sequence_id}/nodes/{node_id}")
return DeleteNodeResponse.model_validate(data)
# Node configurations
def set_node_email(self, sequence_id: str, request: SetNodeEmailRequest) -> SequenceNode:
"""Set email node content"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/email", body)
return SequenceNode.model_validate(data)
def set_node_timer(self, sequence_id: str, request: SetNodeTimerRequest) -> SequenceNode:
"""Set timer node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/timer", body)
return SequenceNode.model_validate(data)
def set_node_filter(self, sequence_id: str, request: SetNodeFilterRequest) -> SequenceNode:
"""Set filter node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/filter", body)
return SequenceNode.model_validate(data)
def set_node_branch(self, sequence_id: str, request: SetNodeBranchRequest) -> SequenceNode:
"""Set branch node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/branch", body)
return SequenceNode.model_validate(data)
def set_node_experiment(self, sequence_id: str, request: SetNodeExperimentRequest) -> SequenceNode:
"""Set experiment node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/experiment", body)
return SequenceNode.model_validate(data)
# Connections
def create_connection(self, request: CreateConnectionRequest) -> SequenceConnection:
"""Create a connection between nodes"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = self._http.post(f"/mail/sequences/{request.id}/connections", body)
return SequenceConnection.model_validate(data)
def delete_connection(self, sequence_id: str, connection_id: str) -> DeleteConnectionResponse:
"""Delete a connection"""
data = self._http.delete(f"/mail/sequences/{sequence_id}/connections/{connection_id}")
return DeleteConnectionResponse.model_validate(data)
# Sequence entries
def list_entries(self, request: ListSequenceEntriesRequest) -> ListSequenceEntriesResponse:
"""List contacts in a sequence"""
params: list[str] = []
if request.limit:
params.append(f"limit={request.limit}")
if request.offset:
params.append(f"offset={request.offset}")
if request.status:
params.append(f"status={request.status}")
query = "&".join(params)
path = f"/mail/sequences/{request.id}/entries{'?' + query if query else ''}"
data = self._http.get(path)
return ListSequenceEntriesResponse.model_validate(data)
def add_contact(self, request: AddContactToSequenceRequest) -> SequenceEntry:
"""Add a contact to a sequence"""
data = self._http.post(f"/mail/sequences/{request.id}/add-contact", {"contactId": request.contact_id})
return SequenceEntry.model_validate(data)
def remove_contact(self, request: RemoveContactFromSequenceRequest) -> RemoveContactFromSequenceResponse:
"""Remove a contact from a sequence"""
body = {"entryId": request.entry_id}
if request.reason:
body["reason"] = request.reason
data = self._http.post(f"/mail/sequences/{request.id}/remove-contact", body)
return RemoveContactFromSequenceResponse.model_validate(data)
# Analytics
def get_analytics(self, id: str) -> SequenceAnalyticsResponse:
"""Get sequence analytics"""
data = self._http.get(f"/mail/sequences/{id}/analytics")
return SequenceAnalyticsResponse.model_validate(data)
class AsyncSequences:
"""Asynchronous sequences client"""
def __init__(self, http: AsyncHTTPClient) -> None:
self._http = http
# Sequence CRUD
async def list(self, request: ListSequencesRequest | None = None) -> ListSequencesResponse:
"""List all sequences"""
params: list[str] = []
if request:
if request.environment:
params.append(f"environment={request.environment}")
if request.limit:
params.append(f"limit={request.limit}")
if request.offset:
params.append(f"offset={request.offset}")
if request.search:
params.append(f"search={request.search}")
if request.status:
params.append(f"status={request.status}")
if request.trigger_type:
params.append(f"triggerType={request.trigger_type}")
query = "&".join(params)
path = f"/mail/sequences{'?' + query if query else ''}"
data = await self._http.get(path)
return ListSequencesResponse.model_validate(data)
async def get(self, id: str) -> SequenceWithNodes:
"""Get a sequence by ID with all nodes and connections"""
data = await self._http.get(f"/mail/sequences/{id}")
return SequenceWithNodes.model_validate(data)
async def create(self, request: CreateSequenceRequest) -> Sequence:
"""Create a new sequence"""
data = await self._http.post("/mail/sequences", request.model_dump(by_alias=True, exclude_none=True))
return Sequence.model_validate(data)
async def update(self, request: UpdateSequenceRequest) -> Sequence:
"""Update a sequence"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = await self._http.put(f"/mail/sequences/{request.id}", body)
return Sequence.model_validate(data)
async def delete(self, id: str) -> DeleteSequenceResponse:
"""Delete a sequence"""
data = await self._http.delete(f"/mail/sequences/{id}")
return DeleteSequenceResponse.model_validate(data)
# Sequence lifecycle
async def publish(self, id: str) -> PublishSequenceResponse:
"""Publish (activate) a sequence"""
data = await self._http.post(f"/mail/sequences/{id}/publish", {})
return PublishSequenceResponse.model_validate(data)
async def pause(self, id: str) -> PauseSequenceResponse:
"""Pause an active sequence"""
data = await self._http.post(f"/mail/sequences/{id}/pause", {})
return PauseSequenceResponse.model_validate(data)
async def resume(self, id: str) -> ResumeSequenceResponse:
"""Resume a paused sequence"""
data = await self._http.post(f"/mail/sequences/{id}/resume", {})
return ResumeSequenceResponse.model_validate(data)
async def archive(self, id: str) -> ArchiveSequenceResponse:
"""Archive a sequence"""
data = await self._http.post(f"/mail/sequences/{id}/archive", {})
return ArchiveSequenceResponse.model_validate(data)
async def duplicate(self, id: str, name: str | None = None) -> Sequence:
"""Duplicate a sequence"""
data = await self._http.post(f"/mail/sequences/{id}/duplicate", {"name": name} if name else {})
return Sequence.model_validate(data)
# Node management
async def create_node(self, request: CreateNodeRequest) -> SequenceNode:
"""Create a new node in a sequence"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = await self._http.post(f"/mail/sequences/{request.id}/nodes", body)
return SequenceNode.model_validate(data)
async def update_node(self, request: UpdateNodeRequest) -> SequenceNode:
"""Update a node"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id", "node_id"})
data = await self._http.put(f"/mail/sequences/{request.id}/nodes/{request.node_id}", body)
return SequenceNode.model_validate(data)
async def update_node_position(self, request: UpdateNodePositionRequest) -> SequenceNode:
"""Update node position"""
data = await self._http.put(
f"/mail/sequences/{request.id}/nodes/{request.node_id}/position",
{"positionX": request.position_x, "positionY": request.position_y},
)
return SequenceNode.model_validate(data)
async def delete_node(self, sequence_id: str, node_id: str) -> DeleteNodeResponse:
"""Delete a node"""
data = await self._http.delete(f"/mail/sequences/{sequence_id}/nodes/{node_id}")
return DeleteNodeResponse.model_validate(data)
# Node configurations
async def set_node_email(self, sequence_id: str, request: SetNodeEmailRequest) -> SequenceNode:
"""Set email node content"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = await self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/email", body)
return SequenceNode.model_validate(data)
async def set_node_timer(self, sequence_id: str, request: SetNodeTimerRequest) -> SequenceNode:
"""Set timer node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = await self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/timer", body)
return SequenceNode.model_validate(data)
async def set_node_filter(self, sequence_id: str, request: SetNodeFilterRequest) -> SequenceNode:
"""Set filter node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = await self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/filter", body)
return SequenceNode.model_validate(data)
async def set_node_branch(self, sequence_id: str, request: SetNodeBranchRequest) -> SequenceNode:
"""Set branch node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = await self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/branch", body)
return SequenceNode.model_validate(data)
async def set_node_experiment(self, sequence_id: str, request: SetNodeExperimentRequest) -> SequenceNode:
"""Set experiment node configuration"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"node_id"})
data = await self._http.put(f"/mail/sequences/{sequence_id}/nodes/{request.node_id}/experiment", body)
return SequenceNode.model_validate(data)
# Connections
async def create_connection(self, request: CreateConnectionRequest) -> SequenceConnection:
"""Create a connection between nodes"""
body = request.model_dump(by_alias=True, exclude_none=True, exclude={"id"})
data = await self._http.post(f"/mail/sequences/{request.id}/connections", body)
return SequenceConnection.model_validate(data)
async def delete_connection(self, sequence_id: str, connection_id: str) -> DeleteConnectionResponse:
"""Delete a connection"""
data = await self._http.delete(f"/mail/sequences/{sequence_id}/connections/{connection_id}")
return DeleteConnectionResponse.model_validate(data)
# Sequence entries
async def list_entries(self, request: ListSequenceEntriesRequest) -> ListSequenceEntriesResponse:
"""List contacts in a sequence"""
params: list[str] = []
if request.limit:
params.append(f"limit={request.limit}")
if request.offset:
params.append(f"offset={request.offset}")
if request.status:
params.append(f"status={request.status}")
query = "&".join(params)
path = f"/mail/sequences/{request.id}/entries{'?' + query if query else ''}"
data = await self._http.get(path)
return ListSequenceEntriesResponse.model_validate(data)
async def add_contact(self, request: AddContactToSequenceRequest) -> SequenceEntry:
"""Add a contact to a sequence"""
data = await self._http.post(f"/mail/sequences/{request.id}/add-contact", {"contactId": request.contact_id})
return SequenceEntry.model_validate(data)
async def remove_contact(self, request: RemoveContactFromSequenceRequest) -> RemoveContactFromSequenceResponse:
"""Remove a contact from a sequence"""
body = {"entryId": request.entry_id}
if request.reason:
body["reason"] = request.reason
data = await self._http.post(f"/mail/sequences/{request.id}/remove-contact", body)
return RemoveContactFromSequenceResponse.model_validate(data)
# Analytics
async def get_analytics(self, id: str) -> SequenceAnalyticsResponse:
"""Get sequence analytics"""
data = await self._http.get(f"/mail/sequences/{id}/analytics")
return SequenceAnalyticsResponse.model_validate(data)