-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcontacts.py
More file actions
373 lines (293 loc) · 14.9 KB
/
contacts.py
File metadata and controls
373 lines (293 loc) · 14.9 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
from datetime import datetime
from typing import Any, Dict, List, Optional
from pydantic import BaseModel, Field, validator
class Contact(BaseModel):
"""
Contact model representing a contact in the Devo Global Communications API.
"""
id: str = Field(description="Unique identifier for the contact")
account_id: Optional[str] = Field(None, description="Account identifier")
user_id: Optional[str] = Field(None, description="User identifier")
phone_number: Optional[str] = Field(None, description="Contact phone number in E.164 format")
email: Optional[str] = Field(None, description="Contact email address")
first_name: Optional[str] = Field(None, description="Contact first name")
last_name: Optional[str] = Field(None, description="Contact last name")
company: Optional[str] = Field(None, description="Contact company")
address: Optional[str] = Field(None, description="Contact address")
country_code: Optional[str] = Field(None, description="Country code")
# Subscription preferences
is_whatsapp_subscribed: Optional[bool] = Field(None, description="WhatsApp subscription status")
is_email_subscribed: Optional[bool] = Field(None, description="Email subscription status")
is_sms_subscribed: Optional[bool] = Field(None, description="SMS subscription status")
is_mms_subscribed: Optional[bool] = Field(None, description="MMS subscription status")
is_rcs_subscribed: Optional[bool] = Field(None, description="RCS subscription status")
# Communication preferences
preferred_channel: Optional[str] = Field(None, description="Preferred communication channel")
timezone: Optional[str] = Field(None, description="Contact timezone")
language: Optional[str] = Field(None, description="Preferred language")
# Tags and grouping
tags: Optional[List[str]] = Field(None, description="Contact tags")
contacts_group_ids: Optional[List[str]] = Field(None, description="Contact group IDs")
# Custom fields
custom_fields: Optional[Dict[str, Any]] = Field(None, description="Custom field values")
# Metadata
created_at: Optional[datetime] = Field(None, description="Contact creation timestamp")
updated_at: Optional[datetime] = Field(None, description="Contact last updated timestamp")
last_contacted: Optional[datetime] = Field(None, description="Last contact timestamp")
metadata: Optional[Dict[str, Any]] = Field(None, description="Custom metadata")
class Config:
json_encoders = {datetime: lambda v: v.isoformat() if v else None}
class ContactSerializer(Contact):
"""Contact serializer for API responses."""
pass
class CreateContactDto(BaseModel):
"""
Data transfer object for creating a new contact.
"""
phone_number: Optional[str] = Field(None, description="Contact phone number in E.164 format")
email: Optional[str] = Field(None, description="Contact email address")
first_name: Optional[str] = Field(None, description="Contact first name")
last_name: Optional[str] = Field(None, description="Contact last name")
company: Optional[str] = Field(None, description="Contact company")
address: Optional[str] = Field(None, description="Contact address")
country_code: Optional[str] = Field(None, description="Country code")
# Subscription preferences
is_whatsapp_subscribed: Optional[bool] = Field(True, description="WhatsApp subscription status")
is_email_subscribed: Optional[bool] = Field(True, description="Email subscription status")
is_sms_subscribed: Optional[bool] = Field(True, description="SMS subscription status")
is_mms_subscribed: Optional[bool] = Field(True, description="MMS subscription status")
is_rcs_subscribed: Optional[bool] = Field(True, description="RCS subscription status")
# Communication preferences
preferred_channel: Optional[str] = Field(None, description="Preferred communication channel")
timezone: Optional[str] = Field(None, description="Contact timezone")
language: Optional[str] = Field(None, description="Preferred language")
# Tags and grouping
tags: Optional[List[str]] = Field(None, description="Contact tags")
contacts_group_ids: Optional[List[str]] = Field(None, description="Contact group IDs to assign")
# Custom fields
custom_fields: Optional[Dict[str, Any]] = Field(None, description="Custom field values")
# Metadata
metadata: Optional[Dict[str, Any]] = Field(None, description="Custom metadata")
@validator("email")
def validate_email(cls, v):
"""Validate email format if provided."""
if v and "@" not in v:
raise ValueError("Invalid email format")
return v
@validator("phone_number")
def validate_phone_number(cls, v):
"""Validate phone number format if provided."""
if v and not v.startswith("+"):
raise ValueError("Phone number must be in E.164 format (start with +)")
return v
class UpdateContactDto(BaseModel):
"""
Data transfer object for updating an existing contact.
"""
phone_number: Optional[str] = Field(None, description="Contact phone number in E.164 format")
email: Optional[str] = Field(None, description="Contact email address")
first_name: Optional[str] = Field(None, description="Contact first name")
last_name: Optional[str] = Field(None, description="Contact last name")
company: Optional[str] = Field(None, description="Contact company")
address: Optional[str] = Field(None, description="Contact address")
country_code: Optional[str] = Field(None, description="Country code")
# Subscription preferences
is_whatsapp_subscribed: Optional[bool] = Field(None, description="WhatsApp subscription status")
is_email_subscribed: Optional[bool] = Field(None, description="Email subscription status")
is_sms_subscribed: Optional[bool] = Field(None, description="SMS subscription status")
is_mms_subscribed: Optional[bool] = Field(None, description="MMS subscription status")
is_rcs_subscribed: Optional[bool] = Field(None, description="RCS subscription status")
# Communication preferences
preferred_channel: Optional[str] = Field(None, description="Preferred communication channel")
timezone: Optional[str] = Field(None, description="Contact timezone")
language: Optional[str] = Field(None, description="Preferred language")
# Tags and grouping
tags: Optional[List[str]] = Field(None, description="Contact tags")
contacts_group_ids: Optional[List[str]] = Field(None, description="Contact group IDs")
# Custom fields
custom_fields: Optional[Dict[str, Any]] = Field(None, description="Custom field values")
# Metadata
metadata: Optional[Dict[str, Any]] = Field(None, description="Custom metadata")
@validator("email")
def validate_email(cls, v):
"""Validate email format if provided."""
if v and "@" not in v:
raise ValueError("Invalid email format")
return v
@validator("phone_number")
def validate_phone_number(cls, v):
"""Validate phone number format if provided."""
if v and not v.startswith("+"):
raise ValueError("Phone number must be in E.164 format (start with +)")
return v
class DeleteContactsDto(BaseModel):
"""
Data transfer object for deleting contacts.
"""
contact_ids: List[str] = Field(description="List of contact IDs to delete", min_length=1)
@validator("contact_ids")
def validate_contact_ids(cls, v):
"""Validate that contact IDs list is not empty."""
if not v:
raise ValueError("At least one contact ID must be provided")
return v
class AssignToContactsGroupDto(BaseModel):
"""
Data transfer object for assigning/unassigning contacts to/from groups.
"""
contact_ids: List[str] = Field(description="List of contact IDs", min_length=1)
contacts_group_id: str = Field(description="Contact group ID")
@validator("contact_ids")
def validate_contact_ids(cls, v):
"""Validate that contact IDs list is not empty."""
if not v:
raise ValueError("At least one contact ID must be provided")
return v
@validator("contacts_group_id")
def validate_group_id(cls, v):
"""Validate that group ID is not empty."""
if not v or not v.strip():
raise ValueError("Contact group ID cannot be empty")
return v.strip()
class CreateContactsFromCsvDto(BaseModel):
"""
Data transfer object for importing contacts from CSV.
"""
csv_data: str = Field(description="CSV data as string")
contacts_group_id: Optional[str] = Field(None, description="Contact group ID to assign imported contacts")
skip_duplicates: Optional[bool] = Field(True, description="Skip duplicate contacts")
update_existing: Optional[bool] = Field(False, description="Update existing contacts")
@validator("csv_data")
def validate_csv_data(cls, v):
"""Validate that CSV data is not empty."""
if not v or not v.strip():
raise ValueError("CSV data cannot be empty")
return v.strip()
class CreateContactsFromCsvRespDto(BaseModel):
"""
Response data transfer object for CSV import operation.
"""
total_processed: int = Field(description="Total number of contacts processed")
successfully_created: int = Field(description="Number of contacts successfully created")
skipped_duplicates: int = Field(description="Number of duplicate contacts skipped")
failed_imports: int = Field(description="Number of failed imports")
errors: Optional[List[str]] = Field(None, description="List of error messages")
class GetContactsSerializer(BaseModel):
"""
Serializer for paginated contacts list response.
"""
contacts: List[ContactSerializer] = Field(description="List of contacts")
total: int = Field(description="Total number of contacts")
page: int = Field(description="Current page number")
limit: int = Field(description="Number of contacts per page")
total_pages: int = Field(description="Total number of pages")
@validator("page")
def validate_page(cls, v):
"""Validate page number."""
if v < 1:
raise ValueError("Page number must be positive")
return v
@validator("limit")
def validate_limit(cls, v):
"""Validate limit."""
if v < 1:
raise ValueError("Limit must be positive")
return v
# Custom Fields Models
class CustomField(BaseModel):
"""
Custom field model.
"""
id: str = Field(description="Unique identifier for the custom field")
name: str = Field(description="Custom field name")
field_type: str = Field(description="Field type (text, number, date, boolean, etc.)")
description: Optional[str] = Field(None, description="Custom field description")
is_required: Optional[bool] = Field(False, description="Whether the field is required")
default_value: Optional[Any] = Field(None, description="Default value for the field")
options: Optional[List[str]] = Field(None, description="Options for select/radio fields")
created_at: Optional[datetime] = Field(None, description="Field creation timestamp")
updated_at: Optional[datetime] = Field(None, description="Field last updated timestamp")
class Config:
json_encoders = {datetime: lambda v: v.isoformat() if v else None}
class CustomFieldSerializer(CustomField):
"""Custom field serializer for API responses."""
pass
class CreateCustomFieldDto(BaseModel):
"""
Data transfer object for creating a custom field.
"""
name: str = Field(description="Custom field name")
field_type: str = Field(description="Field type (text, number, date, boolean, etc.)")
description: Optional[str] = Field(None, description="Custom field description")
is_required: Optional[bool] = Field(False, description="Whether the field is required")
default_value: Optional[Any] = Field(None, description="Default value for the field")
options: Optional[List[str]] = Field(None, description="Options for select/radio fields")
@validator("name")
def validate_name(cls, v):
"""Validate field name."""
if not v or not v.strip():
raise ValueError("Custom field name cannot be empty")
return v.strip()
@validator("field_type")
def validate_field_type(cls, v):
"""Validate field type."""
allowed_types = ["text", "number", "date", "boolean", "select", "radio", "textarea"]
if v not in allowed_types:
raise ValueError(f'Field type must be one of: {", ".join(allowed_types)}')
return v
class UpdateCustomFieldDto(BaseModel):
"""
Data transfer object for updating a custom field.
"""
name: Optional[str] = Field(None, description="Custom field name")
field_type: Optional[str] = Field(None, description="Field type")
description: Optional[str] = Field(None, description="Custom field description")
is_required: Optional[bool] = Field(None, description="Whether the field is required")
default_value: Optional[Any] = Field(None, description="Default value for the field")
options: Optional[List[str]] = Field(None, description="Options for select/radio fields")
@validator("name")
def validate_name(cls, v):
"""Validate field name."""
if v is not None and (not v or not v.strip()):
raise ValueError("Custom field name cannot be empty")
return v.strip() if v else v
@validator("field_type")
def validate_field_type(cls, v):
"""Validate field type."""
if v is not None:
allowed_types = ["text", "number", "date", "boolean", "select", "radio", "textarea"]
if v not in allowed_types:
raise ValueError(f'Field type must be one of: {", ".join(allowed_types)}')
return v
class GetCustomFieldsSerializer(BaseModel):
"""
Serializer for paginated custom fields list response.
"""
custom_fields: List[CustomFieldSerializer] = Field(description="List of custom fields")
total: int = Field(description="Total number of custom fields")
page: int = Field(description="Current page number")
limit: int = Field(description="Number of custom fields per page")
total_pages: int = Field(description="Total number of pages")
@validator("page")
def validate_page(cls, v):
"""Validate page number."""
if v < 1:
raise ValueError("Page number must be positive")
return v
@validator("limit")
def validate_limit(cls, v):
"""Validate limit."""
if v < 1:
raise ValueError("Limit must be positive")
return v
class CommonDeleteDto(BaseModel):
"""
Common data transfer object for delete operations.
"""
ids: List[str] = Field(description="List of IDs to delete", min_length=1)
@validator("ids")
def validate_ids(cls, v):
"""Validate that IDs list is not empty."""
if not v:
raise ValueError("At least one ID must be provided")
return v