ghl-models 0.5.2

Rust data models (DTOs) for the GoHighLevel (HighLevel) API v2 and v3, generated from the official OpenAPI specifications
Documentation
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
//! `contacts` data models for GoHighLevel API V3 (60 types).
//!
//! Generated from HighLevel's official OpenAPI spec for the
//! **Contacts** module. Every endpoint that uses these types, with its
//! parameters, required scopes and enum values, is documented in the
//! [`contacts` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/contacts.md).
//!
//! Enable with `features = ["contacts"]`.
// @generated by xtask/generate_models.py — do not edit by hand.
// Source: https://github.com/GoHighLevel/highlevel-api-docs
// Doc comments are HighLevel's own field descriptions, reflowed verbatim, so
// they aren't held to rustdoc's markdown conventions.
#![allow(
    missing_docs,
    clippy::doc_lazy_continuation,
    clippy::doc_overindented_list_items
)]

use serde::{Deserialize, Serialize};

/// `AddContactToCampaignDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AddContactToCampaignDto {
    /// The spec defines no fields for this schema.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
}

/// `AttributionSource` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AttributionSource {
    /// Attribution source type
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    /// Campaign name
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub campaign: Option<String>,
    /// UTM source parameter
    #[serde(rename = "utmSource", default, skip_serializing_if = "Option::is_none")]
    pub utm_source: Option<String>,
    /// UTM medium parameter
    #[serde(rename = "utmMedium", default, skip_serializing_if = "Option::is_none")]
    pub utm_medium: Option<String>,
    /// UTM content parameter
    #[serde(
        rename = "utmContent",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub utm_content: Option<String>,
    /// Referrer URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub referrer: Option<String>,
    /// Campaign Id
    #[serde(
        rename = "campaignId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub campaign_id: Option<String>,
    /// Facebook click Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fbclid: Option<String>,
    /// Google click Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gclid: Option<String>,
    /// Microsoft click Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub msclikid: Option<String>,
    /// DoubleClick click Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dclid: Option<String>,
    /// Facebook browser Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fbc: Option<String>,
    /// Facebook pixel Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fbp: Option<String>,
    /// Facebook event Id
    #[serde(rename = "fbEventId", default, skip_serializing_if = "Option::is_none")]
    pub fb_event_id: Option<String>,
    /// Browser user agent string
    #[serde(rename = "userAgent", default, skip_serializing_if = "Option::is_none")]
    pub user_agent: Option<String>,
    /// IP address of the visitor
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ip: Option<String>,
    /// Attribution medium (e.g. survey, funnel)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub medium: Option<String>,
    /// Id of the attribution medium
    #[serde(rename = "mediumId", default, skip_serializing_if = "Option::is_none")]
    pub medium_id: Option<String>,
}

/// `CheckboxField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CheckboxField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Array of selected checkbox values for the custom field (preferred).
    #[serde(rename = "fieldValue", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value: Vec<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(rename = "field_value", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value_alt: Vec<String>,
}

/// `ContactsBulkUpateResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsBulkUpateResponse {
    /// Whether the bulk update was successful
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// List of contact Ids that were updated
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub ids: Vec<String>,
}

/// `ContactsBusinessUpdate` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsBusinessUpdate {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// List of contact Ids to update (maximum 50)
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub ids: Vec<String>,
    /// Business Id to assign to contacts. Pass null to remove business association.
    /// Required by the API.
    #[serde(rename = "businessId")]
    pub business_id: String,
}

/// `ContactsByIdSuccessfulResponseDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsByIdSuccessfulResponseDtoV3 {
    /// Contact details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contact: Option<GetContactByIdSchemaV3>,
}

/// `ContactsMetaSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsMetaSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub total: Option<f64>,
    #[serde(
        rename = "nextPageUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub next_page_url: Option<String>,
    #[serde(
        rename = "startAfterId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub start_after_id: Option<String>,
    #[serde(
        rename = "startAfter",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub start_after: Option<f64>,
    #[serde(
        rename = "currentPage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub current_page: Option<f64>,
    #[serde(rename = "nextPage", default, skip_serializing_if = "Option::is_none")]
    pub next_page: Option<f64>,
    #[serde(rename = "prevPage", default, skip_serializing_if = "Option::is_none")]
    pub prev_page: Option<f64>,
}

/// `ContactsSearchSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsSearchSchema {
    /// Unique identifier of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Location Id the contact belongs to
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// Email address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Timezone of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Country of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// Source from which the contact was created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// Date and time the contact was added (ISO 8601)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// List of custom field values for the contact
    #[serde(
        rename = "customFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub custom_fields: Vec<CustomFieldSchema>,
    /// List of tags associated with the contact
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// Business Id the contact is associated with
    #[serde(
        rename = "businessId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_id: Option<String>,
    /// List of attribution sources for the contact
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attributions: Vec<AttributionSource>,
    /// List of user Ids following this contact
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
}

/// `ContactsSearchSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsSearchSuccessfulResponseDto {
    /// List of contacts associated with the business
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub contacts: Vec<ContactsSearchSchema>,
    /// Total number of contacts matching the query
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub count: Option<f64>,
}

/// `ContactsWorkflowSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactsWorkflowSuccessfulResponseDto {
    /// Whether the workflow operation was successful
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
}

/// `CreateAddFollowersSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateAddFollowersSuccessfulResponseDto {
    /// Current followers after the operation
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
    /// Followers that were added
    #[serde(
        rename = "followersAdded",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub followers_added: Vec<String>,
}

/// `CreateAddTagSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateAddTagSuccessfulResponseDto {
    /// Current tags on the contact after the operation
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
}

/// `CreateContactDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateContactDtoV3 {
    /// First name of the contact
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    /// Last name of the contact
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    /// Full name of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Email address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Location Id the contact should be created under
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Gender of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gender: Option<String>,
    /// Phone number of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Street address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address1: Option<String>,
    /// City of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// State of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Postal code of the contact
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// Website URL of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// Timezone of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Whether Do Not Disturb is enabled for the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dnd: Option<bool>,
    /// Inbound DND settings per channel for the contact
    #[serde(
        rename = "inboundDndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub inbound_dnd_settings: Option<InboundDndSettingsSchema>,
    /// List of tags to assign to the contact
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// List of custom field values to assign to the contact
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(
        rename = "customFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub custom_fields: Vec<serde_json::Value>,
    /// Source from which the contact was created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD,
    /// MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
    #[serde(
        rename = "dateOfBirth",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_of_birth: Option<serde_json::Value>,
    /// Country code of the contact (ISO 3166-1 alpha-2)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// Company name of the contact
    #[serde(
        rename = "companyName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub company_name: Option<String>,
    /// User's Id
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Per-channel DND settings for the contact
    #[serde(
        rename = "dndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub dnd_settings: Option<DndSettingsSchemaV3>,
}

/// `CreateContactsSuccessfulResponseDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateContactsSuccessfulResponseDtoV3 {
    /// Contact details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contact: Option<GetContactByIdSchemaV3>,
}

/// `CreateDeleteCantactsCampaignsSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateDeleteCantactsCampaignsSuccessfulResponseDto {
    /// Whether the campaign operation was successful
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
}

/// `CreateDeleteTagSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateDeleteTagSuccessfulResponseDto {
    /// Current tags on the contact after the operation
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
}

/// `CreateTaskParams` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateTaskParams {
    /// Title of the task
    /// Required by the API.
    pub title: String,
    /// Body or description of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// Due date of the task (ISO 8601 format)
    /// Required by the API.
    #[serde(rename = "dueDate")]
    pub due_date: String,
    /// Whether the task is completed
    /// Required by the API.
    pub completed: bool,
    /// User Id to whom the task is assigned
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
}

/// `CreateWorkflowDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateWorkflowDto {
    /// Start time of the workflow event (ISO 8601 format)
    #[serde(
        rename = "eventStartTime",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub event_start_time: Option<String>,
}

/// `CustomFieldSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomFieldSchema {
    /// Unique identifier of the custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Value of the custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
}

/// `DeleteContactsSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteContactsSuccessfulResponseDto {
    /// Whether the delete operation succeeded
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
}

/// `DeleteFollowersSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteFollowersSuccessfulResponseDto {
    /// Current followers after the operation
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
    /// Followers that were removed
    #[serde(
        rename = "followersRemoved",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub followers_removed: Vec<String>,
}

/// `DeleteNoteSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteNoteSuccessfulResponseDto {
    /// Whether the note was successfully deleted
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
}

/// `DeleteTaskSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteTaskSuccessfulResponseDto {
    /// Whether the task was successfully deleted
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
}

/// `DndSettingSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DndSettingSchema {
    /// Do Not Disturb status for this channel
    /// Allowed values: `active`, `inactive`, `permanent`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Custom message associated with the DND setting
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// DND code or reason
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub code: Option<String>,
}

/// `DndSettingsSchemaV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DndSettingsSchemaV3 {
    /// DND settings for phone calls
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub call: Option<DndSettingSchema>,
    /// DND settings for email
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<DndSettingSchema>,
    /// DND settings for SMS
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sms: Option<DndSettingSchema>,
    /// DND settings for WhatsApp
    #[serde(rename = "whatsApp", default, skip_serializing_if = "Option::is_none")]
    pub whats_app: Option<DndSettingSchema>,
    /// DND settings for Google My Business
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gmb: Option<DndSettingSchema>,
    /// DND settings for Facebook
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fb: Option<DndSettingSchema>,
}

/// `FileField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FileField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// File upload value — a map of UUID to file metadata and download URL (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<serde_json::Value>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<serde_json::Value>,
}

/// `FollowersDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FollowersDTO {
    /// List of user Ids to follow or unfollow the contact
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
}

/// `GetContactByIdSchemaV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetContactByIdSchemaV3 {
    /// Unique identifier of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Full name of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Location Id the contact belongs to
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// First name of the contact
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    /// Last name of the contact
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    /// Email address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Lowercase version of the contact email
    #[serde(
        rename = "emailLowerCase",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_lower_case: Option<String>,
    /// Timezone of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Company name of the contact
    #[serde(
        rename = "companyName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub company_name: Option<String>,
    /// Phone number of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Whether Do Not Disturb is enabled for the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dnd: Option<bool>,
    /// Contact type classification
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
    /// Source from which the contact was created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// User Id the contact is assigned to
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Street address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address1: Option<String>,
    /// City of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// State of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Country of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// Postal code of the contact
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// Website URL of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// List of tags associated with the contact
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// Date of birth of the contact (YYYY-MM-DD)
    #[serde(
        rename = "dateOfBirth",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_of_birth: Option<String>,
    /// Date and time the contact was added (ISO 8601)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Date and time the contact was last updated (ISO 8601)
    #[serde(
        rename = "dateUpdated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_updated: Option<String>,
    /// List of attachment URLs associated with the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub attachments: Option<String>,
    /// Social Security Number (if applicable)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ssn: Option<String>,
    /// Search keyword associated with the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub keyword: Option<String>,
    /// Lowercase version of the contact first name
    #[serde(
        rename = "firstNameLowerCase",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub first_name_lower_case: Option<String>,
    /// Lowercase version of the contact full name
    #[serde(
        rename = "fullNameLowerCase",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub full_name_lower_case: Option<String>,
    /// Lowercase version of the contact last name
    #[serde(
        rename = "lastNameLowerCase",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_name_lower_case: Option<String>,
    /// Date and time of last activity on this contact (ISO 8601)
    #[serde(
        rename = "lastActivity",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_activity: Option<String>,
    /// List of custom field values for the contact
    #[serde(
        rename = "customFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub custom_fields: Vec<CustomFieldSchema>,
    /// Business Id the contact is associated with
    #[serde(
        rename = "businessId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_id: Option<String>,
    /// First-touch attribution source details for the contact
    #[serde(
        rename = "attributionSource",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub attribution_source: Option<AttributionSource>,
    /// Last-touch attribution source details for the contact
    #[serde(
        rename = "lastAttributionSource",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_attribution_source: Option<AttributionSource>,
    /// visitorId is the Unique ID assigned to each Live chat visitor.
    #[serde(rename = "visitorId", default, skip_serializing_if = "Option::is_none")]
    pub visitor_id: Option<String>,
    /// Per-channel DND settings for the contact
    #[serde(
        rename = "dndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub dnd_settings: Option<DndSettingsSchemaV3>,
}

/// `GetCreateUpdateNoteSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetCreateUpdateNoteSuccessfulResponseDto {
    /// Note details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub note: Option<GetNoteSchema>,
}

/// `GetEventSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetEventSchema {
    /// Unique identifier of the appointment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Calendar Id associated with the appointment
    #[serde(
        rename = "calendarId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub calendar_id: Option<String>,
    /// Status of the appointment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Title of the appointment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// User Id assigned to the appointment
    #[serde(
        rename = "assignedUserId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_user_id: Option<String>,
    /// Notes for the appointment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub notes: Option<String>,
    /// Start time of the appointment
    #[serde(rename = "startTime", default, skip_serializing_if = "Option::is_none")]
    pub start_time: Option<String>,
    /// End time of the appointment
    #[serde(rename = "endTime", default, skip_serializing_if = "Option::is_none")]
    pub end_time: Option<String>,
    /// Address for the appointment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    /// Location Id of the appointment
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// Contact Id associated with the appointment
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Group Id of the appointment
    #[serde(rename = "groupId", default, skip_serializing_if = "Option::is_none")]
    pub group_id: Option<String>,
    /// Appointment status
    #[serde(
        rename = "appointmentStatus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub appointment_status: Option<String>,
    /// List of user Ids assigned to the appointment
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub users: Vec<String>,
    /// Date the appointment was created
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Date the appointment was last updated
    #[serde(
        rename = "dateUpdated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_updated: Option<String>,
    /// List of resource Ids assigned to the appointment
    #[serde(
        rename = "assignedResources",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub assigned_resources: Vec<String>,
}

/// `GetEventsSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetEventsSuccessfulResponseDto {
    /// List of appointments
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub events: Vec<GetEventSchema>,
}

/// `GetNoteSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetNoteSchema {
    /// Unique identifier of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Body content of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// User Id of the note author
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// Date the note was added (ISO 8601 format)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Contact Id associated with the note
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Title of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Hex color code for the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub color: Option<String>,
    /// Whether the note is pinned
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pinned: Option<bool>,
}

/// `GetNotesListSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetNotesListSuccessfulResponseDto {
    /// List of notes
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub notes: Vec<GetNoteSchema>,
}

/// `InboundDndSettingSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InboundDndSettingSchema {
    /// Inbound DND status for this channel
    /// Allowed values: `active`, `inactive`.
    /// Required by the API.
    pub status: String,
    /// Custom message associated with the inbound DND setting
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `InboundDndSettingsSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InboundDndSettingsSchema {
    /// Inbound DND settings applied to all channels
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub all: Option<InboundDndSettingSchema>,
}

/// `LargeTextField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct LargeTextField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Large text value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<String>,
}

/// `MonetoryField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MonetoryField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Monetary value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<serde_json::Value>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<serde_json::Value>,
}

/// `MultiSelectField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MultiSelectField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Array of selected values for the custom field (preferred).
    #[serde(rename = "fieldValue", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value: Vec<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(rename = "field_value", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value_alt: Vec<String>,
}

/// `NotesDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NotesDTO {
    /// User Id of the note author
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// Body content of the note
    /// Required by the API.
    pub body: String,
    /// Title of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Hex color code for the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub color: Option<String>,
    /// Whether the note is pinned
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pinned: Option<bool>,
}

/// `NumericField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NumericField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Numeric value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<serde_json::Value>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<serde_json::Value>,
}

/// `RadioField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RadioField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Selected radio option value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<String>,
}

/// `SearchBodyV2DTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SearchBodyV2DTO {
    /// The spec defines no fields for this schema.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
}

/// `SingleSelectField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SingleSelectField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Selected option value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<String>,
}

/// `TagsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TagsDTO {
    /// List of tags to add or remove
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
}

/// `TaskByIsSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TaskByIsSuccessfulResponseDto {
    /// Task details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub task: Option<TaskSchema>,
}

/// `TaskSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TaskSchema {
    /// Unique identifier of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Title of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Body or description of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// User Id to whom the task is assigned
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Due date of the task (ISO 8601 format)
    #[serde(rename = "dueDate", default, skip_serializing_if = "Option::is_none")]
    pub due_date: Option<String>,
    /// Whether the task is completed
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub completed: Option<bool>,
    /// Contact Id associated with the task
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
}

/// `TasksListSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TasksListSuccessfulResponseDto {
    /// List of tasks
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tasks: Vec<TaskSchema>,
}

/// `TextField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TextField {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    pub id: String,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Text value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<String>,
}

/// `UpdateContactDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateContactDtoV3 {
    /// First name of the contact
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    /// Last name of the contact
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    /// Full name of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Email address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Phone number of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Street address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address1: Option<String>,
    /// City of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// State of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Postal code of the contact
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// Website URL of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// Timezone of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Whether Do Not Disturb is enabled for the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dnd: Option<bool>,
    /// Inbound DND settings per channel for the contact
    #[serde(
        rename = "inboundDndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub inbound_dnd_settings: Option<InboundDndSettingsSchema>,
    /// This field will overwrite all current tags associated with the contact. To update a
    /// tags, it is recommended to use the Add Tag or Remove Tag API instead.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// List of custom field values to assign to the contact
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(
        rename = "customFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub custom_fields: Vec<serde_json::Value>,
    /// Source from which the contact was updated
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD,
    /// MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
    #[serde(
        rename = "dateOfBirth",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_of_birth: Option<serde_json::Value>,
    /// Country code of the contact (ISO 3166-1 alpha-2), Refer country list from documentaion,
    /// documentation has list of all countries
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// User's Id
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Per-channel DND settings for the contact
    #[serde(
        rename = "dndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub dnd_settings: Option<DndSettingsSchemaV3>,
}

/// `UpdateContactsSuccessfulResponseDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateContactsSuccessfulResponseDtoV3 {
    /// Whether the update operation succeeded
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Contact details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contact: Option<GetContactByIdSchemaV3>,
}

/// `UpdateNoteDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateNoteDTO {
    /// User Id of the note author
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// Body content of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// Title of the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Hex color code for the note
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub color: Option<String>,
    /// Whether the note is pinned
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pinned: Option<bool>,
}

/// `UpdateTagsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateTagsDTO {
    /// list of contact ids to be processed
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub contacts: Vec<String>,
    /// list of tags to be added or removed
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// location id from where the bulk request is executed
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Option to implement remove all tags. if true, all tags will be removed from the
    /// contacts. Can only be used with remove type.
    #[serde(
        rename = "removeAllTags",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub remove_all_tags: Option<bool>,
}

/// `UpdateTagsResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateTagsResponseDTO {
    /// Indicates if the operation was successful
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeeded: Option<bool>,
    /// Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub succeded: Option<bool>,
    /// Number of errors encountered during the operation
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "errorCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub error_count: Option<f64>,
    /// Responses for each contact processed
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub responses: Vec<String>,
}

/// `UpdateTaskBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateTaskBody {
    /// Title of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Body or description of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// Due date of the task (ISO 8601 format)
    #[serde(rename = "dueDate", default, skip_serializing_if = "Option::is_none")]
    pub due_date: Option<String>,
    /// Whether the task is completed
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub completed: Option<bool>,
    /// User Id to whom the task is assigned
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
}

/// `UpdateTaskStatusParams` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateTaskStatusParams {
    /// Whether the task is completed
    /// Required by the API.
    pub completed: bool,
}

/// `UpsertContactDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpsertContactDtoV3 {
    /// First name of the contact
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    /// Last name of the contact
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    /// Full name of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Email address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Location Id the contact should be created under
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Gender of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gender: Option<String>,
    /// Phone number of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Street address of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address1: Option<String>,
    /// City of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// State of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// Postal code of the contact
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// Website URL of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// Timezone of the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Whether Do Not Disturb is enabled for the contact
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dnd: Option<bool>,
    /// Inbound DND settings per channel for the contact
    #[serde(
        rename = "inboundDndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub inbound_dnd_settings: Option<InboundDndSettingsSchema>,
    /// This field will overwrite all current tags associated with the contact. To update a
    /// tags, it is recommended to use the Add Tag or Remove Tag API instead.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// List of custom field values to assign to the contact
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(
        rename = "customFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub custom_fields: Vec<serde_json::Value>,
    /// Source from which the contact was created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD,
    /// MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
    #[serde(
        rename = "dateOfBirth",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_of_birth: Option<serde_json::Value>,
    /// Country code of the contact (ISO 3166-1 alpha-2)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// Company name of the contact
    #[serde(
        rename = "companyName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub company_name: Option<String>,
    /// User's Id
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Controls whether to create a new contact or update an existing duplicate. **Scenario
    /// 1:** If this value is `true` and the location allows duplicate contacts, a new contact
    /// will be created immediately without checking for duplicates. **Scenario 2:** If this
    /// value is `true` but the location does not allow duplicate contacts, this field is
    /// ignored and the normal upsert behavior applies: the API will search for an existing
    /// duplicate contact, update it if found, or create a new contact if not found. **Scenario
    /// 3:** If this value is `false` or not provided, the normal upsert behavior applies
    /// regardless of the location's duplicate contact setting.
    #[serde(
        rename = "createNewIfDuplicateAllowed",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub create_new_if_duplicate_allowed: Option<bool>,
    /// Per-channel DND settings for the contact
    #[serde(
        rename = "dndSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub dnd_settings: Option<DndSettingsSchemaV3>,
}

/// `UpsertContactsSuccessfulResponseDtoV3` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpsertContactsSuccessfulResponseDtoV3 {
    /// Whether a new contact was created (true) or an existing one was updated (false)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub new: Option<bool>,
    /// Contact details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contact: Option<GetContactByIdSchemaV3>,
    /// Unique trace identifier for this operation
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
}

/// `customFieldsInputArraySchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomFieldsInputArraySchema {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Array value for the custom field (preferred).
    #[serde(rename = "fieldValue", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value: Vec<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(rename = "field_value", default, skip_serializing_if = "Vec::is_empty")]
    pub field_value_alt: Vec<String>,
}

/// `customFieldsInputObjectSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomFieldsInputObjectSchema {
    /// Pass either `id` or `key` of custom field
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Object value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<serde_json::Value>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<serde_json::Value>,
}

/// `customFieldsInputStringSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomFieldsInputStringSchema {
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Pass either `id` or `key` of custom field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Value for the custom field (preferred).
    #[serde(
        rename = "fieldValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value: Option<String>,
    /// Deprecated. Use `fieldValue` instead.
    #[serde(
        rename = "field_value",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub field_value_alt: Option<String>,
}