@a1liu/solidarity-tech-api 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4682 +0,0 @@
1
- declare const DeleteAgentAssignmentsId: {
2
- readonly metadata: {
3
- readonly allOf: readonly [{
4
- readonly type: "object";
5
- readonly properties: {
6
- readonly id: {
7
- readonly type: "integer";
8
- readonly $schema: "http://json-schema.org/draft-04/schema#";
9
- readonly description: "Identifier of the agent assignment to delete";
10
- };
11
- };
12
- readonly required: readonly ["id"];
13
- }];
14
- };
15
- };
16
- declare const DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId: {
17
- readonly metadata: {
18
- readonly allOf: readonly [{
19
- readonly type: "object";
20
- readonly properties: {
21
- readonly custom_user_property_id: {
22
- readonly type: "integer";
23
- readonly $schema: "http://json-schema.org/draft-04/schema#";
24
- readonly description: "Custom user property ID";
25
- };
26
- readonly id: {
27
- readonly type: "string";
28
- readonly $schema: "http://json-schema.org/draft-04/schema#";
29
- readonly description: "Value of the option to remove";
30
- };
31
- };
32
- readonly required: readonly ["custom_user_property_id", "id"];
33
- }];
34
- };
35
- readonly response: {
36
- readonly "200": {
37
- readonly type: "object";
38
- readonly properties: {
39
- readonly data: {
40
- readonly type: "object";
41
- readonly properties: {
42
- readonly id: {
43
- readonly type: "integer";
44
- };
45
- readonly name: {
46
- readonly type: "string";
47
- };
48
- readonly key: {
49
- readonly type: "string";
50
- };
51
- readonly field_type: {
52
- readonly type: "string";
53
- };
54
- readonly options: {
55
- readonly type: "array";
56
- readonly items: {
57
- readonly type: "object";
58
- readonly properties: {
59
- readonly label: {
60
- readonly type: "object";
61
- readonly additionalProperties: {
62
- readonly type: "string";
63
- };
64
- };
65
- readonly value: {
66
- readonly type: "string";
67
- };
68
- };
69
- };
70
- };
71
- readonly scope_id: {
72
- readonly type: "integer";
73
- };
74
- readonly scope_type: {
75
- readonly type: "string";
76
- readonly enum: readonly ["Organization", "Chapter"];
77
- readonly description: "`Organization` `Chapter`";
78
- };
79
- };
80
- };
81
- };
82
- readonly $schema: "http://json-schema.org/draft-04/schema#";
83
- };
84
- readonly "404": {
85
- readonly type: "object";
86
- readonly properties: {
87
- readonly error: {
88
- readonly type: "string";
89
- };
90
- };
91
- readonly $schema: "http://json-schema.org/draft-04/schema#";
92
- };
93
- readonly "422": {
94
- readonly type: "object";
95
- readonly properties: {
96
- readonly error: {
97
- readonly type: "string";
98
- };
99
- };
100
- readonly $schema: "http://json-schema.org/draft-04/schema#";
101
- };
102
- };
103
- };
104
- declare const DeleteEventAttendancesId: {
105
- readonly metadata: {
106
- readonly allOf: readonly [{
107
- readonly type: "object";
108
- readonly properties: {
109
- readonly id: {
110
- readonly type: "integer";
111
- readonly $schema: "http://json-schema.org/draft-04/schema#";
112
- readonly description: "Identifier of the event attendance to delete";
113
- };
114
- };
115
- readonly required: readonly ["id"];
116
- }];
117
- };
118
- };
119
- declare const DeleteEventRsvpsId: {
120
- readonly metadata: {
121
- readonly allOf: readonly [{
122
- readonly type: "object";
123
- readonly properties: {
124
- readonly id: {
125
- readonly type: "integer";
126
- readonly $schema: "http://json-schema.org/draft-04/schema#";
127
- readonly description: "Identifier of the event rsvp to delete";
128
- };
129
- };
130
- readonly required: readonly ["id"];
131
- }];
132
- };
133
- };
134
- declare const DeleteEventSessionsId: {
135
- readonly metadata: {
136
- readonly allOf: readonly [{
137
- readonly type: "object";
138
- readonly properties: {
139
- readonly id: {
140
- readonly type: "integer";
141
- readonly $schema: "http://json-schema.org/draft-04/schema#";
142
- readonly description: "Identifier of the event session to delete";
143
- };
144
- };
145
- readonly required: readonly ["id"];
146
- }];
147
- };
148
- };
149
- declare const DeleteScheduledTasksId: {
150
- readonly metadata: {
151
- readonly allOf: readonly [{
152
- readonly type: "object";
153
- readonly properties: {
154
- readonly id: {
155
- readonly type: "integer";
156
- readonly $schema: "http://json-schema.org/draft-04/schema#";
157
- readonly description: "Identifier of the scheduled task to delete";
158
- };
159
- };
160
- readonly required: readonly ["id"];
161
- }];
162
- };
163
- };
164
- declare const DeleteTaskAgentsId: {
165
- readonly metadata: {
166
- readonly allOf: readonly [{
167
- readonly type: "object";
168
- readonly properties: {
169
- readonly id: {
170
- readonly type: "integer";
171
- readonly $schema: "http://json-schema.org/draft-04/schema#";
172
- readonly description: "Identifier of the task agent to delete";
173
- };
174
- };
175
- readonly required: readonly ["id"];
176
- }];
177
- };
178
- };
179
- declare const DeleteTaskAssignmentsId: {
180
- readonly metadata: {
181
- readonly allOf: readonly [{
182
- readonly type: "object";
183
- readonly properties: {
184
- readonly id: {
185
- readonly type: "integer";
186
- readonly $schema: "http://json-schema.org/draft-04/schema#";
187
- readonly description: "Identifier of the task assignment to delete";
188
- };
189
- };
190
- readonly required: readonly ["id"];
191
- }];
192
- };
193
- };
194
- declare const DeleteTextTemplatesId: {
195
- readonly metadata: {
196
- readonly allOf: readonly [{
197
- readonly type: "object";
198
- readonly properties: {
199
- readonly id: {
200
- readonly type: "integer";
201
- readonly $schema: "http://json-schema.org/draft-04/schema#";
202
- readonly description: "Identifier of the text template to delete";
203
- };
204
- };
205
- readonly required: readonly ["id"];
206
- }];
207
- };
208
- };
209
- declare const DeleteUserListsId: {
210
- readonly metadata: {
211
- readonly allOf: readonly [{
212
- readonly type: "object";
213
- readonly properties: {
214
- readonly id: {
215
- readonly type: "integer";
216
- readonly $schema: "http://json-schema.org/draft-04/schema#";
217
- readonly description: "Identifier of the user list to delete";
218
- };
219
- };
220
- readonly required: readonly ["id"];
221
- }];
222
- };
223
- };
224
- declare const DeleteUserNotesId: {
225
- readonly metadata: {
226
- readonly allOf: readonly [{
227
- readonly type: "object";
228
- readonly properties: {
229
- readonly id: {
230
- readonly type: "integer";
231
- readonly $schema: "http://json-schema.org/draft-04/schema#";
232
- readonly description: "Identifier of the user note to delete";
233
- };
234
- };
235
- readonly required: readonly ["id"];
236
- }, {
237
- readonly type: "object";
238
- readonly properties: {
239
- readonly user_id: {
240
- readonly type: "integer";
241
- readonly $schema: "http://json-schema.org/draft-04/schema#";
242
- };
243
- readonly agent_id: {
244
- readonly type: "integer";
245
- readonly $schema: "http://json-schema.org/draft-04/schema#";
246
- };
247
- };
248
- readonly required: readonly ["user_id"];
249
- }];
250
- };
251
- };
252
- declare const DeleteUserRelationshipsId: {
253
- readonly metadata: {
254
- readonly allOf: readonly [{
255
- readonly type: "object";
256
- readonly properties: {
257
- readonly id: {
258
- readonly type: "integer";
259
- readonly $schema: "http://json-schema.org/draft-04/schema#";
260
- };
261
- };
262
- readonly required: readonly ["id"];
263
- }, {
264
- readonly type: "object";
265
- readonly properties: {
266
- readonly user_id: {
267
- readonly type: "integer";
268
- readonly $schema: "http://json-schema.org/draft-04/schema#";
269
- };
270
- };
271
- readonly required: readonly ["user_id"];
272
- }];
273
- };
274
- };
275
- declare const GetActivities: {
276
- readonly metadata: {
277
- readonly allOf: readonly [{
278
- readonly type: "object";
279
- readonly properties: {
280
- readonly _limit: {
281
- readonly type: "integer";
282
- readonly default: 20;
283
- readonly $schema: "http://json-schema.org/draft-04/schema#";
284
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
285
- };
286
- readonly _offset: {
287
- readonly type: "integer";
288
- readonly default: 0;
289
- readonly $schema: "http://json-schema.org/draft-04/schema#";
290
- readonly description: "Number of items to skip before starting to return the results.";
291
- };
292
- readonly _since: {
293
- readonly type: "integer";
294
- readonly default: 0;
295
- readonly $schema: "http://json-schema.org/draft-04/schema#";
296
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter activities created after this time.";
297
- };
298
- readonly user_id: {
299
- readonly type: "integer";
300
- readonly $schema: "http://json-schema.org/draft-04/schema#";
301
- readonly description: "User ID to filter activities for a specific user.";
302
- };
303
- };
304
- readonly required: readonly [];
305
- }];
306
- };
307
- readonly response: {
308
- readonly "200": {
309
- readonly type: "object";
310
- readonly properties: {
311
- readonly data: {
312
- readonly type: "array";
313
- readonly items: {
314
- readonly type: "object";
315
- readonly properties: {
316
- readonly id: {
317
- readonly type: "integer";
318
- };
319
- readonly user_id: {
320
- readonly type: "integer";
321
- };
322
- readonly name: {
323
- readonly type: "string";
324
- };
325
- readonly actionable_id: {
326
- readonly type: "integer";
327
- };
328
- readonly actionable_type: {
329
- readonly type: "string";
330
- };
331
- readonly action: {
332
- readonly type: "object";
333
- readonly properties: {
334
- readonly id: {
335
- readonly type: "integer";
336
- };
337
- readonly user_id: {
338
- readonly type: "integer";
339
- };
340
- readonly agent_user_id: {
341
- readonly type: "integer";
342
- };
343
- readonly field_type: {
344
- readonly type: "string";
345
- };
346
- readonly old_value: {
347
- readonly type: "string";
348
- };
349
- readonly new_value: {
350
- readonly type: "string";
351
- };
352
- readonly data_import_id: {
353
- readonly type: "integer";
354
- };
355
- readonly created_at: {
356
- readonly type: "string";
357
- readonly format: "date-time";
358
- };
359
- readonly updated_at: {
360
- readonly type: "string";
361
- readonly format: "date-time";
362
- };
363
- };
364
- };
365
- readonly created_at: {
366
- readonly type: "string";
367
- readonly format: "date-time";
368
- };
369
- readonly updated_at: {
370
- readonly type: "string";
371
- readonly format: "date-time";
372
- };
373
- };
374
- };
375
- };
376
- readonly meta: {
377
- readonly type: "object";
378
- readonly properties: {
379
- readonly total_count: {
380
- readonly type: "integer";
381
- };
382
- readonly limit: {
383
- readonly type: "integer";
384
- };
385
- readonly offset: {
386
- readonly type: "integer";
387
- };
388
- };
389
- };
390
- };
391
- readonly $schema: "http://json-schema.org/draft-04/schema#";
392
- };
393
- };
394
- };
395
- declare const GetAgentAssignments: {
396
- readonly metadata: {
397
- readonly allOf: readonly [{
398
- readonly type: "object";
399
- readonly properties: {
400
- readonly _limit: {
401
- readonly type: "integer";
402
- readonly default: 20;
403
- readonly $schema: "http://json-schema.org/draft-04/schema#";
404
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
405
- };
406
- readonly _offset: {
407
- readonly type: "integer";
408
- readonly default: 0;
409
- readonly $schema: "http://json-schema.org/draft-04/schema#";
410
- readonly description: "Number of items to skip before starting to return the results.";
411
- };
412
- readonly _since: {
413
- readonly type: "integer";
414
- readonly default: 0;
415
- readonly $schema: "http://json-schema.org/draft-04/schema#";
416
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
417
- };
418
- readonly user_id: {
419
- readonly type: "integer";
420
- readonly $schema: "http://json-schema.org/draft-04/schema#";
421
- readonly description: "User ID to filter agent assignments related to a specific user.";
422
- };
423
- readonly agent_user_id: {
424
- readonly type: "integer";
425
- readonly $schema: "http://json-schema.org/draft-04/schema#";
426
- readonly description: "Agent User ID to filter agent user assignments related to a specific agent user.";
427
- };
428
- };
429
- readonly required: readonly [];
430
- }];
431
- };
432
- };
433
- declare const GetAgentAssignmentsId: {
434
- readonly metadata: {
435
- readonly allOf: readonly [{
436
- readonly type: "object";
437
- readonly properties: {
438
- readonly id: {
439
- readonly type: "integer";
440
- readonly $schema: "http://json-schema.org/draft-04/schema#";
441
- readonly description: "ID of the agent assignment to retrieve";
442
- };
443
- };
444
- readonly required: readonly ["id"];
445
- }];
446
- };
447
- };
448
- declare const GetCalls: {
449
- readonly metadata: {
450
- readonly allOf: readonly [{
451
- readonly type: "object";
452
- readonly properties: {
453
- readonly user_id: {
454
- readonly type: "integer";
455
- readonly $schema: "http://json-schema.org/draft-04/schema#";
456
- readonly description: "User ID to filter calls related to a specific user.";
457
- };
458
- readonly _limit: {
459
- readonly type: "integer";
460
- readonly default: 20;
461
- readonly $schema: "http://json-schema.org/draft-04/schema#";
462
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
463
- };
464
- readonly _offset: {
465
- readonly type: "integer";
466
- readonly default: 0;
467
- readonly $schema: "http://json-schema.org/draft-04/schema#";
468
- readonly description: "Number of items to skip before starting to return the results.";
469
- };
470
- readonly _since: {
471
- readonly type: "integer";
472
- readonly default: 0;
473
- readonly $schema: "http://json-schema.org/draft-04/schema#";
474
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
475
- };
476
- };
477
- readonly required: readonly [];
478
- }];
479
- };
480
- readonly response: {
481
- readonly "200": {
482
- readonly type: "object";
483
- readonly properties: {
484
- readonly data: {
485
- readonly type: "array";
486
- readonly items: {
487
- readonly type: "object";
488
- readonly properties: {
489
- readonly id: {
490
- readonly type: "integer";
491
- };
492
- readonly user_id: {
493
- readonly type: "integer";
494
- };
495
- readonly chapter_id: {
496
- readonly type: "integer";
497
- };
498
- readonly direction: {
499
- readonly type: "string";
500
- };
501
- readonly from_number: {
502
- readonly type: "string";
503
- };
504
- readonly to_number: {
505
- readonly type: "string";
506
- };
507
- readonly phonebank_id: {
508
- readonly type: "integer";
509
- readonly description: "The ID of the phone bank (MobilizeEventTask) this call was made as part of, or null if the call was not part of a phone bank.";
510
- };
511
- readonly agent_user_id: {
512
- readonly type: "integer";
513
- };
514
- readonly notes: {
515
- readonly type: "string";
516
- };
517
- readonly duration: {
518
- readonly type: "integer";
519
- };
520
- readonly picked_up: {
521
- readonly type: "boolean";
522
- };
523
- readonly left_voicemail: {
524
- readonly type: "boolean";
525
- };
526
- readonly twilio_call_sid: {
527
- readonly type: "string";
528
- };
529
- readonly created_at: {
530
- readonly type: "string";
531
- readonly format: "date-time";
532
- };
533
- readonly ended_at: {
534
- readonly type: "string";
535
- readonly format: "date-time";
536
- };
537
- readonly transcription: {
538
- readonly type: "object";
539
- readonly description: "AI generated transcription analysis, present when the call has been transcribed.";
540
- readonly properties: {
541
- readonly summary: {
542
- readonly type: "string";
543
- };
544
- readonly rating: {
545
- readonly type: "integer";
546
- };
547
- readonly sentiment: {
548
- readonly type: "string";
549
- };
550
- readonly engagement_analysis: {
551
- readonly type: "string";
552
- };
553
- readonly engagement_analysis_justification: {
554
- readonly type: "string";
555
- };
556
- };
557
- };
558
- };
559
- };
560
- };
561
- readonly meta: {
562
- readonly type: "object";
563
- readonly properties: {
564
- readonly total_count: {
565
- readonly type: "integer";
566
- };
567
- readonly limit: {
568
- readonly type: "integer";
569
- };
570
- readonly offset: {
571
- readonly type: "integer";
572
- };
573
- };
574
- };
575
- };
576
- readonly $schema: "http://json-schema.org/draft-04/schema#";
577
- };
578
- };
579
- };
580
- declare const GetChapterPhoneNumbers: {
581
- readonly metadata: {
582
- readonly allOf: readonly [{
583
- readonly type: "object";
584
- readonly properties: {
585
- readonly _limit: {
586
- readonly type: "integer";
587
- readonly default: 20;
588
- readonly $schema: "http://json-schema.org/draft-04/schema#";
589
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
590
- };
591
- readonly _offset: {
592
- readonly type: "integer";
593
- readonly default: 0;
594
- readonly $schema: "http://json-schema.org/draft-04/schema#";
595
- readonly description: "Number of items to skip before starting to return the results.";
596
- };
597
- readonly _since: {
598
- readonly type: "integer";
599
- readonly default: 0;
600
- readonly $schema: "http://json-schema.org/draft-04/schema#";
601
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
602
- };
603
- readonly chapter_id: {
604
- readonly type: "integer";
605
- readonly default: 0;
606
- readonly $schema: "http://json-schema.org/draft-04/schema#";
607
- readonly description: "Filters chapter phone numbers by chapter_id within the accessible scope.";
608
- };
609
- };
610
- readonly required: readonly [];
611
- }];
612
- };
613
- };
614
- declare const GetChapters: {
615
- readonly metadata: {
616
- readonly allOf: readonly [{
617
- readonly type: "object";
618
- readonly properties: {
619
- readonly _limit: {
620
- readonly type: "integer";
621
- readonly default: 20;
622
- readonly $schema: "http://json-schema.org/draft-04/schema#";
623
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
624
- };
625
- readonly _offset: {
626
- readonly type: "integer";
627
- readonly default: 0;
628
- readonly $schema: "http://json-schema.org/draft-04/schema#";
629
- readonly description: "Number of items to skip before starting to return the results.";
630
- };
631
- readonly _since: {
632
- readonly type: "integer";
633
- readonly default: 0;
634
- readonly $schema: "http://json-schema.org/draft-04/schema#";
635
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter chapters created after this time.";
636
- };
637
- };
638
- readonly required: readonly [];
639
- }];
640
- };
641
- readonly response: {
642
- readonly "200": {
643
- readonly type: "object";
644
- readonly properties: {
645
- readonly data: {
646
- readonly type: "array";
647
- readonly items: {
648
- readonly type: "object";
649
- readonly properties: {
650
- readonly id: {
651
- readonly type: "integer";
652
- };
653
- readonly name: {
654
- readonly type: "string";
655
- };
656
- readonly logo_url: {
657
- readonly type: "string";
658
- };
659
- readonly organization_id: {
660
- readonly type: "integer";
661
- };
662
- readonly chapter_phone_number: {
663
- readonly type: "string";
664
- };
665
- readonly calendar_feed_url: {
666
- readonly type: "string";
667
- };
668
- };
669
- };
670
- };
671
- readonly meta: {
672
- readonly type: "object";
673
- readonly properties: {
674
- readonly total_count: {
675
- readonly type: "integer";
676
- };
677
- readonly limit: {
678
- readonly type: "integer";
679
- };
680
- readonly offset: {
681
- readonly type: "integer";
682
- };
683
- };
684
- };
685
- };
686
- readonly $schema: "http://json-schema.org/draft-04/schema#";
687
- };
688
- };
689
- };
690
- declare const GetCustomUserProperties: {
691
- readonly metadata: {
692
- readonly allOf: readonly [{
693
- readonly type: "object";
694
- readonly properties: {
695
- readonly _limit: {
696
- readonly type: "integer";
697
- readonly default: 20;
698
- readonly $schema: "http://json-schema.org/draft-04/schema#";
699
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
700
- };
701
- readonly _offset: {
702
- readonly type: "integer";
703
- readonly default: 0;
704
- readonly $schema: "http://json-schema.org/draft-04/schema#";
705
- readonly description: "Number of items to skip before starting to return the results.";
706
- };
707
- readonly _since: {
708
- readonly type: "integer";
709
- readonly default: 0;
710
- readonly $schema: "http://json-schema.org/draft-04/schema#";
711
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter custom user properties created after this time.";
712
- };
713
- readonly scope_id: {
714
- readonly type: "integer";
715
- readonly $schema: "http://json-schema.org/draft-04/schema#";
716
- readonly description: "ID of the scope to filter custom user properties by.";
717
- };
718
- readonly scope_type: {
719
- readonly type: "string";
720
- readonly enum: readonly ["Organization", "Chapter"];
721
- readonly $schema: "http://json-schema.org/draft-04/schema#";
722
- readonly description: "Type of the scope to filter custom user properties by.";
723
- };
724
- };
725
- readonly required: readonly [];
726
- }];
727
- };
728
- readonly response: {
729
- readonly "200": {
730
- readonly type: "object";
731
- readonly properties: {
732
- readonly data: {
733
- readonly type: "array";
734
- readonly items: {
735
- readonly type: "object";
736
- readonly properties: {
737
- readonly id: {
738
- readonly type: "integer";
739
- };
740
- readonly name: {
741
- readonly type: "string";
742
- };
743
- readonly key: {
744
- readonly type: "string";
745
- };
746
- readonly field_type: {
747
- readonly type: "string";
748
- };
749
- readonly options: {
750
- readonly type: "array";
751
- readonly items: {
752
- readonly type: "object";
753
- readonly properties: {
754
- readonly label: {
755
- readonly type: "object";
756
- readonly additionalProperties: {
757
- readonly type: "string";
758
- };
759
- };
760
- readonly value: {
761
- readonly type: "string";
762
- };
763
- };
764
- };
765
- };
766
- readonly scope_id: {
767
- readonly type: "integer";
768
- };
769
- readonly scope_type: {
770
- readonly type: "string";
771
- readonly description: "Type of the scope\n\n`Organization` `Chapter`";
772
- readonly enum: readonly ["Organization", "Chapter"];
773
- };
774
- };
775
- };
776
- };
777
- readonly meta: {
778
- readonly type: "object";
779
- readonly properties: {
780
- readonly total_count: {
781
- readonly type: "integer";
782
- };
783
- readonly limit: {
784
- readonly type: "integer";
785
- };
786
- readonly offset: {
787
- readonly type: "integer";
788
- };
789
- };
790
- };
791
- };
792
- readonly $schema: "http://json-schema.org/draft-04/schema#";
793
- };
794
- };
795
- };
796
- declare const GetDonationCharges: {
797
- readonly metadata: {
798
- readonly allOf: readonly [{
799
- readonly type: "object";
800
- readonly properties: {
801
- readonly _limit: {
802
- readonly type: "integer";
803
- readonly default: 20;
804
- readonly $schema: "http://json-schema.org/draft-04/schema#";
805
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
806
- };
807
- readonly _offset: {
808
- readonly type: "integer";
809
- readonly default: 0;
810
- readonly $schema: "http://json-schema.org/draft-04/schema#";
811
- readonly description: "Number of items to skip before starting to return the results.";
812
- };
813
- readonly _since: {
814
- readonly type: "integer";
815
- readonly default: 0;
816
- readonly $schema: "http://json-schema.org/draft-04/schema#";
817
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter donation charges created after this time.";
818
- };
819
- };
820
- readonly required: readonly [];
821
- }];
822
- };
823
- readonly response: {
824
- readonly "200": {
825
- readonly type: "object";
826
- readonly properties: {
827
- readonly data: {
828
- readonly type: "array";
829
- readonly items: {
830
- readonly type: "object";
831
- readonly properties: {
832
- readonly id: {
833
- readonly type: "integer";
834
- readonly examples: readonly [1];
835
- };
836
- readonly amount: {
837
- readonly type: "integer";
838
- readonly description: "Amount in cents";
839
- readonly examples: readonly [5000];
840
- };
841
- readonly created_at: {
842
- readonly type: "string";
843
- readonly format: "datetime";
844
- readonly examples: readonly ["2023-01-01T12:00:00Z"];
845
- };
846
- readonly updated_at: {
847
- readonly type: "string";
848
- readonly format: "datetime";
849
- readonly examples: readonly ["2023-01-01T12:00:00Z"];
850
- };
851
- readonly success: {
852
- readonly type: "boolean";
853
- readonly examples: readonly [true];
854
- };
855
- readonly refunded: {
856
- readonly type: "boolean";
857
- readonly examples: readonly [false];
858
- };
859
- readonly receipt_number: {
860
- readonly type: "string";
861
- readonly examples: readonly ["ABC1-DEF2"];
862
- };
863
- readonly hash_id: {
864
- readonly type: "string";
865
- readonly examples: readonly ["abc123def456"];
866
- };
867
- readonly processing_fee_cents: {
868
- readonly type: "integer";
869
- readonly examples: readonly [150];
870
- };
871
- readonly external_donation_id: {
872
- readonly type: "string";
873
- };
874
- readonly external_donation_date: {
875
- readonly type: "string";
876
- readonly format: "datetime";
877
- };
878
- readonly is_external: {
879
- readonly type: "boolean";
880
- readonly examples: readonly [false];
881
- };
882
- readonly amount_in_dollars: {
883
- readonly type: "string";
884
- readonly examples: readonly ["$50.00"];
885
- };
886
- readonly currency: {
887
- readonly type: "string";
888
- readonly examples: readonly ["USD"];
889
- };
890
- readonly currency_symbol: {
891
- readonly type: "string";
892
- readonly examples: readonly ["$"];
893
- };
894
- readonly receipt_url: {
895
- readonly type: "string";
896
- readonly examples: readonly ["https://example.com/receipt/ABC1-DEF2/abc123def456"];
897
- };
898
- readonly brand: {
899
- readonly type: "string";
900
- readonly examples: readonly ["visa"];
901
- };
902
- readonly last4: {
903
- readonly type: "string";
904
- readonly examples: readonly ["4242"];
905
- };
906
- readonly json: {
907
- readonly type: "object";
908
- readonly description: "Full JSON representation of the donation charge";
909
- readonly additionalProperties: true;
910
- };
911
- readonly user: {
912
- readonly type: "object";
913
- readonly properties: {
914
- readonly id: {
915
- readonly type: "integer";
916
- readonly examples: readonly [1];
917
- };
918
- readonly email: {
919
- readonly type: "string";
920
- readonly examples: readonly ["user@example.com"];
921
- };
922
- readonly first_name: {
923
- readonly type: "string";
924
- readonly examples: readonly ["John"];
925
- };
926
- readonly last_name: {
927
- readonly type: "string";
928
- readonly examples: readonly ["Doe"];
929
- };
930
- readonly phone_number: {
931
- readonly type: "string";
932
- readonly examples: readonly ["15551234567"];
933
- };
934
- readonly created_at: {
935
- readonly type: "string";
936
- readonly format: "datetime";
937
- readonly examples: readonly ["2023-01-01T12:00:00Z"];
938
- };
939
- readonly address1: {
940
- readonly type: "string";
941
- readonly examples: readonly ["123 Main St"];
942
- };
943
- readonly address2: {
944
- readonly type: "string";
945
- readonly examples: readonly ["Apt 4B"];
946
- };
947
- readonly city: {
948
- readonly type: "string";
949
- readonly examples: readonly ["New York"];
950
- };
951
- readonly state: {
952
- readonly type: "string";
953
- readonly examples: readonly ["NY"];
954
- };
955
- readonly zip_code: {
956
- readonly type: "string";
957
- readonly examples: readonly ["10001"];
958
- };
959
- readonly country_name: {
960
- readonly type: "string";
961
- readonly examples: readonly ["United States"];
962
- };
963
- };
964
- };
965
- readonly action_page: {
966
- readonly type: "object";
967
- readonly properties: {
968
- readonly id: {
969
- readonly type: "integer";
970
- readonly examples: readonly [1];
971
- };
972
- readonly title: {
973
- readonly type: "string";
974
- readonly examples: readonly ["Donation Page"];
975
- };
976
- readonly url_slug: {
977
- readonly type: "string";
978
- readonly examples: readonly ["donate-now"];
979
- };
980
- };
981
- };
982
- readonly chapter: {
983
- readonly type: "object";
984
- readonly properties: {
985
- readonly id: {
986
- readonly type: "integer";
987
- readonly examples: readonly [1];
988
- };
989
- readonly name: {
990
- readonly type: "string";
991
- readonly examples: readonly ["Local Chapter"];
992
- };
993
- };
994
- };
995
- };
996
- };
997
- };
998
- readonly meta: {
999
- readonly type: "object";
1000
- readonly properties: {
1001
- readonly total_count: {
1002
- readonly type: "integer";
1003
- readonly examples: readonly [100];
1004
- };
1005
- readonly limit: {
1006
- readonly type: "integer";
1007
- readonly examples: readonly [20];
1008
- };
1009
- readonly offset: {
1010
- readonly type: "integer";
1011
- readonly examples: readonly [0];
1012
- };
1013
- };
1014
- };
1015
- };
1016
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1017
- };
1018
- };
1019
- };
1020
- declare const GetDonationChargesId: {
1021
- readonly metadata: {
1022
- readonly allOf: readonly [{
1023
- readonly type: "object";
1024
- readonly properties: {
1025
- readonly id: {
1026
- readonly type: "integer";
1027
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1028
- readonly description: "ID of the donation charge to retrieve";
1029
- };
1030
- };
1031
- readonly required: readonly ["id"];
1032
- }];
1033
- };
1034
- };
1035
- declare const GetEmailBlasts: {
1036
- readonly metadata: {
1037
- readonly allOf: readonly [{
1038
- readonly type: "object";
1039
- readonly properties: {
1040
- readonly _limit: {
1041
- readonly type: "integer";
1042
- readonly default: 20;
1043
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1044
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1045
- };
1046
- readonly _offset: {
1047
- readonly type: "integer";
1048
- readonly default: 0;
1049
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1050
- readonly description: "Number of items to skip before starting to return the results.";
1051
- };
1052
- readonly _since: {
1053
- readonly type: "integer";
1054
- readonly default: 0;
1055
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1056
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1057
- };
1058
- };
1059
- readonly required: readonly [];
1060
- }];
1061
- };
1062
- };
1063
- declare const GetEmailBlastsId: {
1064
- readonly metadata: {
1065
- readonly allOf: readonly [{
1066
- readonly type: "object";
1067
- readonly properties: {
1068
- readonly id: {
1069
- readonly type: "integer";
1070
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1071
- readonly description: "ID of the email blast to retrieve";
1072
- };
1073
- };
1074
- readonly required: readonly ["id"];
1075
- }];
1076
- };
1077
- };
1078
- declare const GetEmailSenders: {
1079
- readonly metadata: {
1080
- readonly allOf: readonly [{
1081
- readonly type: "object";
1082
- readonly properties: {
1083
- readonly _limit: {
1084
- readonly type: "integer";
1085
- readonly default: 20;
1086
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1087
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1088
- };
1089
- readonly _offset: {
1090
- readonly type: "integer";
1091
- readonly default: 0;
1092
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1093
- readonly description: "Number of items to skip before starting to return the results.";
1094
- };
1095
- };
1096
- readonly required: readonly [];
1097
- }];
1098
- };
1099
- readonly response: {
1100
- readonly "200": {
1101
- readonly type: "object";
1102
- readonly properties: {
1103
- readonly data: {
1104
- readonly type: "array";
1105
- readonly items: {
1106
- readonly type: "object";
1107
- readonly properties: {
1108
- readonly id: {
1109
- readonly type: "integer";
1110
- };
1111
- readonly name: {
1112
- readonly type: "string";
1113
- };
1114
- readonly email: {
1115
- readonly type: "string";
1116
- };
1117
- readonly from: {
1118
- readonly type: "string";
1119
- };
1120
- readonly default_for_scope: {
1121
- readonly type: "boolean";
1122
- };
1123
- readonly scope_type: {
1124
- readonly type: "string";
1125
- };
1126
- readonly scope_id: {
1127
- readonly type: "integer";
1128
- };
1129
- readonly created_at: {
1130
- readonly type: "string";
1131
- readonly format: "date-time";
1132
- };
1133
- };
1134
- };
1135
- };
1136
- readonly meta: {
1137
- readonly type: "object";
1138
- readonly properties: {
1139
- readonly total_count: {
1140
- readonly type: "integer";
1141
- };
1142
- readonly limit: {
1143
- readonly type: "integer";
1144
- };
1145
- readonly offset: {
1146
- readonly type: "integer";
1147
- };
1148
- };
1149
- };
1150
- };
1151
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1152
- };
1153
- };
1154
- };
1155
- declare const GetEventAttendances: {
1156
- readonly metadata: {
1157
- readonly allOf: readonly [{
1158
- readonly type: "object";
1159
- readonly properties: {
1160
- readonly _limit: {
1161
- readonly type: "integer";
1162
- readonly default: 20;
1163
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1164
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1165
- };
1166
- readonly _offset: {
1167
- readonly type: "integer";
1168
- readonly default: 0;
1169
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1170
- readonly description: "Number of items to skip before starting to return the results.";
1171
- };
1172
- readonly _since: {
1173
- readonly type: "integer";
1174
- readonly default: 0;
1175
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1176
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1177
- };
1178
- readonly event_id: {
1179
- readonly type: "integer";
1180
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1181
- readonly description: "Filters attendances by event_id within the accessible scope.";
1182
- };
1183
- readonly session_id: {
1184
- readonly type: "integer";
1185
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1186
- readonly description: "Filters attendances by session_id (calendar item id) within the accessible scope.";
1187
- };
1188
- };
1189
- readonly required: readonly [];
1190
- }];
1191
- };
1192
- };
1193
- declare const GetEventRsvps: {
1194
- readonly metadata: {
1195
- readonly allOf: readonly [{
1196
- readonly type: "object";
1197
- readonly properties: {
1198
- readonly _limit: {
1199
- readonly type: "integer";
1200
- readonly default: 20;
1201
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1202
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1203
- };
1204
- readonly _offset: {
1205
- readonly type: "integer";
1206
- readonly default: 0;
1207
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1208
- readonly description: "Number of items to skip before starting to return the results.";
1209
- };
1210
- readonly _since: {
1211
- readonly type: "integer";
1212
- readonly default: 0;
1213
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1214
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1215
- };
1216
- readonly event_id: {
1217
- readonly type: "integer";
1218
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1219
- readonly description: "Filters rsvps by event_id within the accessible scope.";
1220
- };
1221
- readonly session_id: {
1222
- readonly type: "integer";
1223
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1224
- readonly description: "Filters rsvps by session_id (calendar item id) within the accessible scope.";
1225
- };
1226
- readonly full_user_payload: {
1227
- readonly type: "boolean";
1228
- readonly default: false;
1229
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1230
- readonly description: "When true, includes complete user data in the response instead of just basic details.";
1231
- };
1232
- };
1233
- readonly required: readonly [];
1234
- }];
1235
- };
1236
- };
1237
- declare const GetEventRsvpsId: {
1238
- readonly metadata: {
1239
- readonly allOf: readonly [{
1240
- readonly type: "object";
1241
- readonly properties: {
1242
- readonly id: {
1243
- readonly type: "integer";
1244
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1245
- readonly description: "ID of the event rsvp to retrieve";
1246
- };
1247
- };
1248
- readonly required: readonly ["id"];
1249
- }, {
1250
- readonly type: "object";
1251
- readonly properties: {
1252
- readonly full_user_payload: {
1253
- readonly type: "boolean";
1254
- readonly default: false;
1255
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1256
- readonly description: "When true, includes complete user data in the response instead of just basic details.";
1257
- };
1258
- };
1259
- readonly required: readonly [];
1260
- }];
1261
- };
1262
- };
1263
- declare const GetEventSessions: {
1264
- readonly metadata: {
1265
- readonly allOf: readonly [{
1266
- readonly type: "object";
1267
- readonly properties: {
1268
- readonly _limit: {
1269
- readonly type: "integer";
1270
- readonly default: 20;
1271
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1272
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1273
- };
1274
- readonly _offset: {
1275
- readonly type: "integer";
1276
- readonly default: 0;
1277
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1278
- readonly description: "Number of items to skip before starting to return the results.";
1279
- };
1280
- readonly _since: {
1281
- readonly type: "integer";
1282
- readonly default: 0;
1283
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1284
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1285
- };
1286
- readonly event_id: {
1287
- readonly type: "integer";
1288
- readonly default: 0;
1289
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1290
- readonly description: "Filters sessions by event_id within the accessible scope.";
1291
- };
1292
- };
1293
- readonly required: readonly [];
1294
- }];
1295
- };
1296
- };
1297
- declare const GetEventSessionsId: {
1298
- readonly metadata: {
1299
- readonly allOf: readonly [{
1300
- readonly type: "object";
1301
- readonly properties: {
1302
- readonly id: {
1303
- readonly type: "integer";
1304
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1305
- readonly description: "ID of the event session to retrieve";
1306
- };
1307
- };
1308
- readonly required: readonly ["id"];
1309
- }];
1310
- };
1311
- };
1312
- declare const GetEvents: {
1313
- readonly metadata: {
1314
- readonly allOf: readonly [{
1315
- readonly type: "object";
1316
- readonly properties: {
1317
- readonly _limit: {
1318
- readonly type: "integer";
1319
- readonly default: 20;
1320
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1321
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1322
- };
1323
- readonly _offset: {
1324
- readonly type: "integer";
1325
- readonly default: 0;
1326
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1327
- readonly description: "Number of items to skip before starting to return the results.";
1328
- };
1329
- readonly _since: {
1330
- readonly type: "integer";
1331
- readonly default: 0;
1332
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1333
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1334
- };
1335
- readonly scope_id: {
1336
- readonly type: "integer";
1337
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1338
- readonly description: "ID of the scope to filter events by.";
1339
- };
1340
- readonly scope_type: {
1341
- readonly type: "string";
1342
- readonly enum: readonly ["Organization", "Chapter"];
1343
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1344
- readonly description: "Type of the scope to filter events by.";
1345
- };
1346
- };
1347
- readonly required: readonly [];
1348
- }];
1349
- };
1350
- };
1351
- declare const GetEventsId: {
1352
- readonly metadata: {
1353
- readonly allOf: readonly [{
1354
- readonly type: "object";
1355
- readonly properties: {
1356
- readonly id: {
1357
- readonly type: "integer";
1358
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1359
- readonly description: "ID of the event to retrieve";
1360
- };
1361
- };
1362
- readonly required: readonly ["id"];
1363
- }];
1364
- };
1365
- };
1366
- declare const GetOrganizations: {
1367
- readonly metadata: {
1368
- readonly allOf: readonly [{
1369
- readonly type: "object";
1370
- readonly properties: {
1371
- readonly _limit: {
1372
- readonly type: "integer";
1373
- readonly default: 20;
1374
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1375
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1376
- };
1377
- readonly _offset: {
1378
- readonly type: "integer";
1379
- readonly default: 0;
1380
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1381
- readonly description: "Number of items to skip before starting to return the results.";
1382
- };
1383
- readonly _since: {
1384
- readonly type: "integer";
1385
- readonly default: 0;
1386
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1387
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1388
- };
1389
- };
1390
- readonly required: readonly [];
1391
- }];
1392
- };
1393
- };
1394
- declare const GetOrganizationsId: {
1395
- readonly metadata: {
1396
- readonly allOf: readonly [{
1397
- readonly type: "object";
1398
- readonly properties: {
1399
- readonly id: {
1400
- readonly type: "integer";
1401
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1402
- readonly description: "ID of the organization to retrieve";
1403
- };
1404
- };
1405
- readonly required: readonly ["id"];
1406
- }];
1407
- };
1408
- };
1409
- declare const GetPages: {
1410
- readonly metadata: {
1411
- readonly allOf: readonly [{
1412
- readonly type: "object";
1413
- readonly properties: {
1414
- readonly _limit: {
1415
- readonly type: "integer";
1416
- readonly default: 20;
1417
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1418
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1419
- };
1420
- readonly _offset: {
1421
- readonly type: "integer";
1422
- readonly default: 0;
1423
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1424
- readonly description: "Number of items to skip before starting to return the results.";
1425
- };
1426
- readonly _since: {
1427
- readonly type: "integer";
1428
- readonly default: 0;
1429
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1430
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1431
- };
1432
- };
1433
- readonly required: readonly [];
1434
- }];
1435
- };
1436
- };
1437
- declare const GetPagesId: {
1438
- readonly metadata: {
1439
- readonly allOf: readonly [{
1440
- readonly type: "object";
1441
- readonly properties: {
1442
- readonly id: {
1443
- readonly type: "integer";
1444
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1445
- readonly description: "ID of the page to retrieve";
1446
- };
1447
- };
1448
- readonly required: readonly ["id"];
1449
- }];
1450
- };
1451
- };
1452
- declare const GetPhonebanks: {
1453
- readonly metadata: {
1454
- readonly allOf: readonly [{
1455
- readonly type: "object";
1456
- readonly properties: {
1457
- readonly _limit: {
1458
- readonly type: "integer";
1459
- readonly default: 20;
1460
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1461
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1462
- };
1463
- readonly _offset: {
1464
- readonly type: "integer";
1465
- readonly default: 0;
1466
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1467
- readonly description: "Number of items to skip before starting to return the results.";
1468
- };
1469
- readonly _since: {
1470
- readonly type: "integer";
1471
- readonly default: 0;
1472
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1473
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1474
- };
1475
- readonly event_id: {
1476
- readonly type: "integer";
1477
- readonly default: 0;
1478
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1479
- readonly description: "Filters phonebanks by event_id within the accessible scope.";
1480
- };
1481
- };
1482
- readonly required: readonly [];
1483
- }];
1484
- };
1485
- };
1486
- declare const GetPhonebanksId: {
1487
- readonly metadata: {
1488
- readonly allOf: readonly [{
1489
- readonly type: "object";
1490
- readonly properties: {
1491
- readonly id: {
1492
- readonly type: "integer";
1493
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1494
- readonly description: "ID of the phonebank to retrieve";
1495
- };
1496
- };
1497
- readonly required: readonly ["id"];
1498
- }];
1499
- };
1500
- };
1501
- declare const GetScheduledCalls: {
1502
- readonly metadata: {
1503
- readonly allOf: readonly [{
1504
- readonly type: "object";
1505
- readonly properties: {
1506
- readonly _limit: {
1507
- readonly type: "integer";
1508
- readonly default: 20;
1509
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1510
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1511
- };
1512
- readonly _offset: {
1513
- readonly type: "integer";
1514
- readonly default: 0;
1515
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1516
- readonly description: "Number of items to skip before starting to return the results.";
1517
- };
1518
- readonly _since: {
1519
- readonly type: "integer";
1520
- readonly default: 0;
1521
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1522
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1523
- };
1524
- readonly user_id: {
1525
- readonly type: "integer";
1526
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1527
- readonly description: "User ID to filter scheduled calls related to a specific user.";
1528
- };
1529
- readonly agent_user_id: {
1530
- readonly type: "integer";
1531
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1532
- readonly description: "Agent User ID to filter agent user assignments related to a specific agent user.";
1533
- };
1534
- };
1535
- readonly required: readonly [];
1536
- }];
1537
- };
1538
- };
1539
- declare const GetScheduledCallsId: {
1540
- readonly metadata: {
1541
- readonly allOf: readonly [{
1542
- readonly type: "object";
1543
- readonly properties: {
1544
- readonly id: {
1545
- readonly type: "integer";
1546
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1547
- readonly description: "ID of the scheduled call to retrieve";
1548
- };
1549
- };
1550
- readonly required: readonly ["id"];
1551
- }];
1552
- };
1553
- };
1554
- declare const GetScheduledTasks: {
1555
- readonly metadata: {
1556
- readonly allOf: readonly [{
1557
- readonly type: "object";
1558
- readonly properties: {
1559
- readonly _limit: {
1560
- readonly type: "integer";
1561
- readonly default: 20;
1562
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1563
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1564
- };
1565
- readonly _offset: {
1566
- readonly type: "integer";
1567
- readonly default: 0;
1568
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1569
- readonly description: "Number of items to skip before starting to return the results.";
1570
- };
1571
- readonly _since: {
1572
- readonly type: "integer";
1573
- readonly default: 0;
1574
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1575
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1576
- };
1577
- readonly user_id: {
1578
- readonly type: "integer";
1579
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1580
- readonly description: "User ID to filter scheduled tasks related to a specific user.";
1581
- };
1582
- readonly agent_user_id: {
1583
- readonly type: "integer";
1584
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1585
- readonly description: "Agent User ID to filter agent user assignments related to a specific agent user.";
1586
- };
1587
- };
1588
- readonly required: readonly [];
1589
- }];
1590
- };
1591
- };
1592
- declare const GetScheduledTasksId: {
1593
- readonly metadata: {
1594
- readonly allOf: readonly [{
1595
- readonly type: "object";
1596
- readonly properties: {
1597
- readonly id: {
1598
- readonly type: "integer";
1599
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1600
- readonly description: "ID of the scheduled task to retrieve";
1601
- };
1602
- };
1603
- readonly required: readonly ["id"];
1604
- }];
1605
- };
1606
- };
1607
- declare const GetTaskAgents: {
1608
- readonly metadata: {
1609
- readonly allOf: readonly [{
1610
- readonly type: "object";
1611
- readonly properties: {
1612
- readonly _limit: {
1613
- readonly type: "integer";
1614
- readonly default: 20;
1615
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1616
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1617
- };
1618
- readonly _offset: {
1619
- readonly type: "integer";
1620
- readonly default: 0;
1621
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1622
- readonly description: "Number of items to skip before starting to return the results.";
1623
- };
1624
- readonly _since: {
1625
- readonly type: "integer";
1626
- readonly default: 0;
1627
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1628
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1629
- };
1630
- readonly task_id: {
1631
- readonly type: "integer";
1632
- readonly default: 0;
1633
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1634
- readonly description: "Filters task agents by task within the accessible scope.";
1635
- };
1636
- };
1637
- readonly required: readonly [];
1638
- }];
1639
- };
1640
- };
1641
- declare const GetTaskAgentsId: {
1642
- readonly metadata: {
1643
- readonly allOf: readonly [{
1644
- readonly type: "object";
1645
- readonly properties: {
1646
- readonly id: {
1647
- readonly type: "integer";
1648
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1649
- readonly description: "ID of the task agent to retrieve";
1650
- };
1651
- };
1652
- readonly required: readonly ["id"];
1653
- }];
1654
- };
1655
- };
1656
- declare const GetTaskAssignments: {
1657
- readonly metadata: {
1658
- readonly allOf: readonly [{
1659
- readonly type: "object";
1660
- readonly properties: {
1661
- readonly _limit: {
1662
- readonly type: "integer";
1663
- readonly default: 20;
1664
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1665
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1666
- };
1667
- readonly _offset: {
1668
- readonly type: "integer";
1669
- readonly default: 0;
1670
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1671
- readonly description: "Number of items to skip before starting to return the results.";
1672
- };
1673
- readonly _since: {
1674
- readonly type: "integer";
1675
- readonly default: 0;
1676
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1677
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1678
- };
1679
- readonly task_id: {
1680
- readonly type: "integer";
1681
- readonly default: 0;
1682
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1683
- readonly description: "Filters task assignments by phonebank or textbank task within the accessible scope.";
1684
- };
1685
- readonly agent_user_id: {
1686
- readonly type: "integer";
1687
- readonly default: 0;
1688
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1689
- readonly description: "Filters task assignments by agent user within the accessible scope.";
1690
- };
1691
- };
1692
- readonly required: readonly [];
1693
- }];
1694
- };
1695
- };
1696
- declare const GetTaskAssignmentsId: {
1697
- readonly metadata: {
1698
- readonly allOf: readonly [{
1699
- readonly type: "object";
1700
- readonly properties: {
1701
- readonly id: {
1702
- readonly type: "integer";
1703
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1704
- readonly description: "ID of the task assignment to retrieve";
1705
- };
1706
- };
1707
- readonly required: readonly ["id"];
1708
- }];
1709
- };
1710
- };
1711
- declare const GetTeamMembers: {
1712
- readonly metadata: {
1713
- readonly allOf: readonly [{
1714
- readonly type: "object";
1715
- readonly properties: {
1716
- readonly _limit: {
1717
- readonly type: "integer";
1718
- readonly default: 20;
1719
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1720
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1721
- };
1722
- readonly _offset: {
1723
- readonly type: "integer";
1724
- readonly default: 0;
1725
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1726
- readonly description: "Number of items to skip before starting to return the results.";
1727
- };
1728
- readonly _since: {
1729
- readonly type: "integer";
1730
- readonly default: 0;
1731
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1732
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1733
- };
1734
- };
1735
- readonly required: readonly [];
1736
- }];
1737
- };
1738
- };
1739
- declare const GetTextBlasts: {
1740
- readonly metadata: {
1741
- readonly allOf: readonly [{
1742
- readonly type: "object";
1743
- readonly properties: {
1744
- readonly _limit: {
1745
- readonly type: "integer";
1746
- readonly default: 20;
1747
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1748
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1749
- };
1750
- readonly _offset: {
1751
- readonly type: "integer";
1752
- readonly default: 0;
1753
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1754
- readonly description: "Number of items to skip before starting to return the results.";
1755
- };
1756
- readonly _since: {
1757
- readonly type: "integer";
1758
- readonly default: 0;
1759
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1760
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1761
- };
1762
- };
1763
- readonly required: readonly [];
1764
- }];
1765
- };
1766
- };
1767
- declare const GetTextBlastsId: {
1768
- readonly metadata: {
1769
- readonly allOf: readonly [{
1770
- readonly type: "object";
1771
- readonly properties: {
1772
- readonly id: {
1773
- readonly type: "integer";
1774
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1775
- readonly description: "ID of the text blast to retrieve";
1776
- };
1777
- };
1778
- readonly required: readonly ["id"];
1779
- }];
1780
- };
1781
- };
1782
- declare const GetTextTemplates: {
1783
- readonly metadata: {
1784
- readonly allOf: readonly [{
1785
- readonly type: "object";
1786
- readonly properties: {
1787
- readonly _limit: {
1788
- readonly type: "integer";
1789
- readonly default: 20;
1790
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1791
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1792
- };
1793
- readonly _offset: {
1794
- readonly type: "integer";
1795
- readonly default: 0;
1796
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1797
- readonly description: "Number of items to skip before starting to return the results.";
1798
- };
1799
- readonly _since: {
1800
- readonly type: "integer";
1801
- readonly default: 0;
1802
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1803
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1804
- };
1805
- readonly event_id: {
1806
- readonly type: "integer";
1807
- readonly default: 0;
1808
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1809
- readonly description: "Filters rsvps by event_id within the accessible scope.";
1810
- };
1811
- };
1812
- readonly required: readonly [];
1813
- }];
1814
- };
1815
- };
1816
- declare const GetTextTemplatesId: {
1817
- readonly metadata: {
1818
- readonly allOf: readonly [{
1819
- readonly type: "object";
1820
- readonly properties: {
1821
- readonly id: {
1822
- readonly type: "integer";
1823
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1824
- readonly description: "ID of the text template to retrieve";
1825
- };
1826
- };
1827
- readonly required: readonly ["id"];
1828
- }];
1829
- };
1830
- };
1831
- declare const GetTextbanks: {
1832
- readonly metadata: {
1833
- readonly allOf: readonly [{
1834
- readonly type: "object";
1835
- readonly properties: {
1836
- readonly _limit: {
1837
- readonly type: "integer";
1838
- readonly default: 20;
1839
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1840
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
1841
- };
1842
- readonly _offset: {
1843
- readonly type: "integer";
1844
- readonly default: 0;
1845
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1846
- readonly description: "Number of items to skip before starting to return the results.";
1847
- };
1848
- readonly _since: {
1849
- readonly type: "integer";
1850
- readonly default: 0;
1851
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1852
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
1853
- };
1854
- readonly event_id: {
1855
- readonly type: "integer";
1856
- readonly default: 0;
1857
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1858
- readonly description: "Filters textbanks by event_id within the accessible scope.";
1859
- };
1860
- };
1861
- readonly required: readonly [];
1862
- }];
1863
- };
1864
- };
1865
- declare const GetTextbanksId: {
1866
- readonly metadata: {
1867
- readonly allOf: readonly [{
1868
- readonly type: "object";
1869
- readonly properties: {
1870
- readonly id: {
1871
- readonly type: "integer";
1872
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1873
- readonly description: "ID of the textbank to retrieve";
1874
- };
1875
- };
1876
- readonly required: readonly ["id"];
1877
- }];
1878
- };
1879
- };
1880
- declare const GetTexts: {
1881
- readonly metadata: {
1882
- readonly allOf: readonly [{
1883
- readonly type: "object";
1884
- readonly properties: {
1885
- readonly user_id: {
1886
- readonly type: "integer";
1887
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1888
- };
1889
- readonly _limit: {
1890
- readonly type: "integer";
1891
- readonly default: 20;
1892
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1893
- };
1894
- readonly _offset: {
1895
- readonly type: "integer";
1896
- readonly default: 0;
1897
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1898
- };
1899
- readonly _since: {
1900
- readonly type: "string";
1901
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1902
- };
1903
- };
1904
- readonly required: readonly [];
1905
- }];
1906
- };
1907
- readonly response: {
1908
- readonly "200": {
1909
- readonly type: "object";
1910
- readonly properties: {
1911
- readonly data: {
1912
- readonly type: "array";
1913
- readonly items: {
1914
- readonly type: "object";
1915
- readonly properties: {
1916
- readonly id: {
1917
- readonly type: "integer";
1918
- };
1919
- readonly user_id: {
1920
- readonly type: "integer";
1921
- };
1922
- readonly direction: {
1923
- readonly type: "string";
1924
- };
1925
- readonly body: {
1926
- readonly type: "string";
1927
- };
1928
- readonly media_urls: {
1929
- readonly type: "array";
1930
- readonly items: {
1931
- readonly type: "string";
1932
- };
1933
- };
1934
- readonly segment_size: {
1935
- readonly type: "integer";
1936
- };
1937
- readonly chapter_phone_number_id: {
1938
- readonly type: "integer";
1939
- };
1940
- readonly twilio_error_code: {
1941
- readonly type: "integer";
1942
- };
1943
- readonly created_at: {
1944
- readonly type: "string";
1945
- readonly format: "date-time";
1946
- };
1947
- };
1948
- };
1949
- };
1950
- readonly meta: {
1951
- readonly type: "object";
1952
- readonly properties: {
1953
- readonly total_count: {
1954
- readonly type: "integer";
1955
- };
1956
- readonly limit: {
1957
- readonly type: "integer";
1958
- };
1959
- readonly offset: {
1960
- readonly type: "integer";
1961
- };
1962
- };
1963
- };
1964
- };
1965
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1966
- };
1967
- };
1968
- };
1969
- declare const GetUserActions: {
1970
- readonly metadata: {
1971
- readonly allOf: readonly [{
1972
- readonly type: "object";
1973
- readonly properties: {
1974
- readonly user_id: {
1975
- readonly type: "integer";
1976
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1977
- readonly description: "Filter by user ID";
1978
- };
1979
- readonly page_id: {
1980
- readonly type: "integer";
1981
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1982
- readonly description: "Filter by page ID";
1983
- };
1984
- readonly _limit: {
1985
- readonly type: "integer";
1986
- readonly default: 20;
1987
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1988
- readonly description: "Number of results to return (default: 20, max: 100)";
1989
- };
1990
- readonly _offset: {
1991
- readonly type: "integer";
1992
- readonly default: 0;
1993
- readonly $schema: "http://json-schema.org/draft-04/schema#";
1994
- readonly description: "Number of results to skip (default: 0)";
1995
- };
1996
- readonly _since: {
1997
- readonly type: "integer";
1998
- readonly default: 0;
1999
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2000
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter results created after this time (default: 0)";
2001
- };
2002
- };
2003
- readonly required: readonly [];
2004
- }];
2005
- };
2006
- };
2007
- declare const GetUserLists: {
2008
- readonly metadata: {
2009
- readonly allOf: readonly [{
2010
- readonly type: "object";
2011
- readonly properties: {
2012
- readonly _limit: {
2013
- readonly type: "integer";
2014
- readonly default: 20;
2015
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2016
- readonly description: "Limits the number of items returned. Default is 20, maximum is 100.";
2017
- };
2018
- readonly _offset: {
2019
- readonly type: "integer";
2020
- readonly default: 0;
2021
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2022
- readonly description: "Number of items to skip before starting to return the results.";
2023
- };
2024
- readonly _since: {
2025
- readonly type: "integer";
2026
- readonly default: 0;
2027
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2028
- readonly description: "UTC timestamp in seconds since the Unix epoch to filter calls created after this time.";
2029
- };
2030
- };
2031
- readonly required: readonly [];
2032
- }];
2033
- };
2034
- };
2035
- declare const GetUserListsId: {
2036
- readonly metadata: {
2037
- readonly allOf: readonly [{
2038
- readonly type: "object";
2039
- readonly properties: {
2040
- readonly id: {
2041
- readonly type: "integer";
2042
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2043
- readonly description: "ID of the user list to retrieve";
2044
- };
2045
- };
2046
- readonly required: readonly ["id"];
2047
- }];
2048
- };
2049
- };
2050
- declare const GetUserRelationships: {
2051
- readonly metadata: {
2052
- readonly allOf: readonly [{
2053
- readonly type: "object";
2054
- readonly properties: {
2055
- readonly user_id: {
2056
- readonly type: "integer";
2057
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2058
- };
2059
- };
2060
- readonly required: readonly ["user_id"];
2061
- }];
2062
- };
2063
- readonly response: {
2064
- readonly "200": {
2065
- readonly type: "array";
2066
- readonly items: {
2067
- readonly type: "object";
2068
- readonly properties: {
2069
- readonly id: {
2070
- readonly type: "string";
2071
- };
2072
- readonly text: {
2073
- readonly type: "string";
2074
- };
2075
- };
2076
- };
2077
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2078
- };
2079
- };
2080
- };
2081
- declare const GetUsers: {
2082
- readonly metadata: {
2083
- readonly allOf: readonly [{
2084
- readonly type: "object";
2085
- readonly properties: {
2086
- readonly _limit: {
2087
- readonly type: "integer";
2088
- readonly default: 20;
2089
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2090
- readonly description: "Maximum number of users to return";
2091
- };
2092
- readonly _offset: {
2093
- readonly type: "integer";
2094
- readonly default: 0;
2095
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2096
- readonly description: "Number of users to skip before starting to return";
2097
- };
2098
- readonly _since: {
2099
- readonly type: "integer";
2100
- readonly default: 0;
2101
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2102
- readonly description: "UTC timestamp in seconds since the Unix epoch (e.g., 1622559600) to filter users updated after this time";
2103
- };
2104
- readonly user_list_ids: {
2105
- readonly type: "integer";
2106
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2107
- readonly description: "Comma-separated list of user list IDs to apply";
2108
- };
2109
- readonly phone_number: {
2110
- readonly type: "string";
2111
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2112
- readonly description: "Filter by phone number (any format accepted, will be normalized)";
2113
- };
2114
- readonly email: {
2115
- readonly type: "string";
2116
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2117
- readonly description: "Filter by email address (case-insensitive)";
2118
- };
2119
- };
2120
- readonly required: readonly [];
2121
- }];
2122
- };
2123
- readonly response: {
2124
- readonly "200": {
2125
- readonly type: "object";
2126
- readonly properties: {
2127
- readonly data: {
2128
- readonly type: "array";
2129
- readonly items: {
2130
- readonly type: "object";
2131
- readonly properties: {
2132
- readonly id: {
2133
- readonly type: "integer";
2134
- };
2135
- readonly hash_id: {
2136
- readonly type: "string";
2137
- };
2138
- readonly phone_number: {
2139
- readonly type: "string";
2140
- };
2141
- readonly email: {
2142
- readonly type: "string";
2143
- };
2144
- readonly first_name: {
2145
- readonly type: "string";
2146
- };
2147
- readonly last_name: {
2148
- readonly type: "string";
2149
- };
2150
- readonly alternate_name: {
2151
- readonly type: "string";
2152
- readonly description: "Alternate name (nickname, community name, or alternate romanization). Searchable.";
2153
- };
2154
- readonly preferred_language: {
2155
- readonly type: "string";
2156
- };
2157
- readonly second_language: {
2158
- readonly type: "string";
2159
- };
2160
- readonly chapter_id: {
2161
- readonly type: "integer";
2162
- };
2163
- readonly chapter_ids: {
2164
- readonly type: "array";
2165
- readonly items: {
2166
- readonly type: "integer";
2167
- };
2168
- readonly description: "Array of all chapter IDs this user belongs to (primary + secondary)";
2169
- };
2170
- readonly branch_id: {
2171
- readonly type: "integer";
2172
- };
2173
- readonly created_at: {
2174
- readonly type: "string";
2175
- readonly format: "date-time";
2176
- };
2177
- readonly custom_user_properties: {
2178
- readonly type: "object";
2179
- readonly additionalProperties: {
2180
- readonly oneOf: readonly [{
2181
- readonly type: "string";
2182
- }, {
2183
- readonly type: "array";
2184
- readonly items: {
2185
- readonly type: "string";
2186
- };
2187
- }];
2188
- };
2189
- readonly description: "Custom property values. String for single-value fields, array of strings for Multiple Checkboxes fields.";
2190
- };
2191
- readonly address: {
2192
- readonly type: "object";
2193
- readonly properties: {
2194
- readonly address1: {
2195
- readonly type: "string";
2196
- };
2197
- readonly address2: {
2198
- readonly type: "string";
2199
- };
2200
- readonly city: {
2201
- readonly type: "string";
2202
- };
2203
- readonly state: {
2204
- readonly type: "string";
2205
- };
2206
- readonly zip_code: {
2207
- readonly type: "string";
2208
- };
2209
- readonly country: {
2210
- readonly type: "string";
2211
- };
2212
- };
2213
- };
2214
- readonly sms_permission: {
2215
- readonly type: "boolean";
2216
- };
2217
- readonly call_permission: {
2218
- readonly type: "boolean";
2219
- };
2220
- readonly email_permission: {
2221
- readonly type: "boolean";
2222
- };
2223
- readonly other_emails: {
2224
- readonly type: "array";
2225
- readonly items: {
2226
- readonly type: "string";
2227
- };
2228
- readonly description: "Additional email addresses stored on the user profile, excluding the primary email.";
2229
- };
2230
- readonly other_phone_numbers: {
2231
- readonly type: "array";
2232
- readonly items: {
2233
- readonly type: "string";
2234
- };
2235
- readonly description: "Additional phone numbers stored on the user profile, excluding the primary phone number.";
2236
- };
2237
- };
2238
- };
2239
- };
2240
- readonly meta: {
2241
- readonly type: "object";
2242
- readonly properties: {
2243
- readonly total_count: {
2244
- readonly type: "integer";
2245
- };
2246
- readonly limit: {
2247
- readonly type: "integer";
2248
- };
2249
- readonly offset: {
2250
- readonly type: "integer";
2251
- };
2252
- };
2253
- };
2254
- };
2255
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2256
- };
2257
- };
2258
- };
2259
- declare const GetUsersId: {
2260
- readonly metadata: {
2261
- readonly allOf: readonly [{
2262
- readonly type: "object";
2263
- readonly properties: {
2264
- readonly id: {
2265
- readonly type: "integer";
2266
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2267
- readonly description: "ID of the user to retrieve";
2268
- };
2269
- };
2270
- readonly required: readonly ["id"];
2271
- }];
2272
- };
2273
- readonly response: {
2274
- readonly "200": {
2275
- readonly type: "object";
2276
- readonly properties: {
2277
- readonly id: {
2278
- readonly type: "integer";
2279
- };
2280
- readonly hash_id: {
2281
- readonly type: "string";
2282
- };
2283
- readonly phone_number: {
2284
- readonly type: "string";
2285
- };
2286
- readonly email: {
2287
- readonly type: "string";
2288
- };
2289
- readonly first_name: {
2290
- readonly type: "string";
2291
- };
2292
- readonly last_name: {
2293
- readonly type: "string";
2294
- };
2295
- readonly alternate_name: {
2296
- readonly type: "string";
2297
- readonly description: "Alternate name (nickname, community name, or alternate romanization). Searchable.";
2298
- };
2299
- readonly preferred_language: {
2300
- readonly type: "string";
2301
- };
2302
- readonly second_language: {
2303
- readonly type: "string";
2304
- };
2305
- readonly chapter_id: {
2306
- readonly type: "integer";
2307
- };
2308
- readonly chapter_ids: {
2309
- readonly type: "array";
2310
- readonly items: {
2311
- readonly type: "integer";
2312
- };
2313
- readonly description: "Array of all chapter IDs this user belongs to (primary + secondary)";
2314
- };
2315
- readonly branch_id: {
2316
- readonly type: "integer";
2317
- };
2318
- readonly created_at: {
2319
- readonly type: "string";
2320
- readonly format: "date-time";
2321
- };
2322
- readonly custom_user_properties: {
2323
- readonly type: "object";
2324
- readonly additionalProperties: {
2325
- readonly oneOf: readonly [{
2326
- readonly type: "string";
2327
- }, {
2328
- readonly type: "array";
2329
- readonly items: {
2330
- readonly type: "string";
2331
- };
2332
- }];
2333
- };
2334
- readonly description: "Custom property values. String for single-value fields, array of strings for Multiple Checkboxes fields.";
2335
- };
2336
- readonly address: {
2337
- readonly type: "object";
2338
- readonly properties: {
2339
- readonly address1: {
2340
- readonly type: "string";
2341
- };
2342
- readonly address2: {
2343
- readonly type: "string";
2344
- };
2345
- readonly city: {
2346
- readonly type: "string";
2347
- };
2348
- readonly state: {
2349
- readonly type: "string";
2350
- };
2351
- readonly zip_code: {
2352
- readonly type: "string";
2353
- };
2354
- readonly country: {
2355
- readonly type: "string";
2356
- };
2357
- };
2358
- };
2359
- readonly sms_permission: {
2360
- readonly type: "boolean";
2361
- };
2362
- readonly call_permission: {
2363
- readonly type: "boolean";
2364
- };
2365
- readonly email_permission: {
2366
- readonly type: "boolean";
2367
- };
2368
- readonly other_emails: {
2369
- readonly type: "array";
2370
- readonly items: {
2371
- readonly type: "string";
2372
- };
2373
- readonly description: "Additional email addresses stored on the user profile, excluding the primary email.";
2374
- };
2375
- readonly other_phone_numbers: {
2376
- readonly type: "array";
2377
- readonly items: {
2378
- readonly type: "string";
2379
- };
2380
- readonly description: "Additional phone numbers stored on the user profile, excluding the primary phone number.";
2381
- };
2382
- };
2383
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2384
- };
2385
- };
2386
- };
2387
- declare const PostAgentAssignments: {
2388
- readonly body: {
2389
- readonly type: "object";
2390
- readonly properties: {
2391
- readonly user_id: {
2392
- readonly type: "integer";
2393
- readonly format: "int64";
2394
- readonly description: "Identifier for the user";
2395
- readonly minimum: -9223372036854776000;
2396
- readonly maximum: 9223372036854776000;
2397
- };
2398
- readonly agent_user_id: {
2399
- readonly type: "integer";
2400
- readonly format: "int64";
2401
- readonly description: "Identifier for the agent user";
2402
- readonly minimum: -9223372036854776000;
2403
- readonly maximum: 9223372036854776000;
2404
- };
2405
- readonly is_active: {
2406
- readonly type: "boolean";
2407
- readonly description: "Indicates if the assignment is currently active";
2408
- };
2409
- };
2410
- readonly required: readonly ["user_id", "agent_user_id"];
2411
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2412
- };
2413
- };
2414
- declare const PostAutomationEnrollments: {
2415
- readonly body: {
2416
- readonly type: "object";
2417
- readonly properties: {
2418
- readonly automation_id: {
2419
- readonly type: "integer";
2420
- readonly description: "ID of the automation to enroll user in";
2421
- };
2422
- readonly user_id: {
2423
- readonly type: "integer";
2424
- readonly description: "ID of the user to enroll";
2425
- };
2426
- };
2427
- readonly required: readonly ["automation_id", "user_id"];
2428
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2429
- };
2430
- };
2431
- declare const PostCustomUserProperties: {
2432
- readonly body: {
2433
- readonly type: "object";
2434
- readonly properties: {
2435
- readonly label: {
2436
- readonly type: "string";
2437
- readonly description: "Display label for the property";
2438
- };
2439
- readonly description: {
2440
- readonly type: "string";
2441
- readonly description: "Optional description of the property";
2442
- };
2443
- readonly field_type: {
2444
- readonly type: "string";
2445
- readonly enum: readonly ["input", "textarea", "number", "date", "checkbox", "select", "radios", "checkboxes"];
2446
- readonly description: "Type of field for data entry";
2447
- };
2448
- readonly options: {
2449
- readonly type: "array";
2450
- readonly description: "Options for select, radios, checkbox, or checkboxes field types";
2451
- readonly items: {
2452
- readonly type: "object";
2453
- readonly properties: {
2454
- readonly label: {
2455
- readonly type: "object";
2456
- readonly additionalProperties: {
2457
- readonly type: "string";
2458
- };
2459
- readonly description: "Multi-language labels for the option";
2460
- };
2461
- readonly value: {
2462
- readonly type: "string";
2463
- readonly description: "Internal value for the option";
2464
- };
2465
- };
2466
- };
2467
- };
2468
- readonly scope_type: {
2469
- readonly type: "string";
2470
- readonly enum: readonly ["Organization", "Chapter"];
2471
- readonly description: "Type of scope for the property";
2472
- };
2473
- readonly scope_id: {
2474
- readonly type: "integer";
2475
- readonly description: "ID of the scope for the property";
2476
- };
2477
- };
2478
- readonly required: readonly ["label", "field_type"];
2479
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2480
- };
2481
- readonly response: {
2482
- readonly "201": {
2483
- readonly type: "object";
2484
- readonly properties: {
2485
- readonly data: {
2486
- readonly type: "object";
2487
- readonly properties: {
2488
- readonly id: {
2489
- readonly type: "integer";
2490
- };
2491
- readonly name: {
2492
- readonly type: "string";
2493
- };
2494
- readonly key: {
2495
- readonly type: "string";
2496
- };
2497
- readonly field_type: {
2498
- readonly type: "string";
2499
- };
2500
- readonly options: {
2501
- readonly type: "array";
2502
- readonly items: {
2503
- readonly type: "object";
2504
- readonly properties: {
2505
- readonly label: {
2506
- readonly type: "object";
2507
- readonly additionalProperties: {
2508
- readonly type: "string";
2509
- };
2510
- };
2511
- readonly value: {
2512
- readonly type: "string";
2513
- };
2514
- };
2515
- };
2516
- };
2517
- readonly scope_id: {
2518
- readonly type: "integer";
2519
- };
2520
- readonly scope_type: {
2521
- readonly type: "string";
2522
- readonly enum: readonly ["Organization", "Chapter"];
2523
- readonly description: "`Organization` `Chapter`";
2524
- };
2525
- readonly created_at: {
2526
- readonly type: "string";
2527
- };
2528
- };
2529
- };
2530
- };
2531
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2532
- };
2533
- readonly "422": {
2534
- readonly type: "object";
2535
- readonly properties: {
2536
- readonly error: {
2537
- readonly type: "string";
2538
- };
2539
- readonly details: {
2540
- readonly type: "array";
2541
- readonly items: {
2542
- readonly type: "string";
2543
- };
2544
- };
2545
- };
2546
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2547
- };
2548
- };
2549
- };
2550
- declare const PostCustomUserPropertiesIdOptions: {
2551
- readonly body: {
2552
- readonly type: "object";
2553
- readonly properties: {
2554
- readonly label: {
2555
- readonly type: "object";
2556
- readonly additionalProperties: {
2557
- readonly type: "string";
2558
- };
2559
- readonly description: "Multi-language labels for the option";
2560
- };
2561
- readonly value: {
2562
- readonly type: "string";
2563
- readonly description: "Internal value for the option (will be auto-generated if not provided)";
2564
- };
2565
- };
2566
- readonly required: readonly ["label"];
2567
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2568
- };
2569
- readonly metadata: {
2570
- readonly allOf: readonly [{
2571
- readonly type: "object";
2572
- readonly properties: {
2573
- readonly id: {
2574
- readonly type: "integer";
2575
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2576
- readonly description: "Custom user property ID";
2577
- };
2578
- };
2579
- readonly required: readonly ["id"];
2580
- }];
2581
- };
2582
- readonly response: {
2583
- readonly "201": {
2584
- readonly type: "object";
2585
- readonly properties: {
2586
- readonly data: {
2587
- readonly type: "object";
2588
- readonly properties: {
2589
- readonly id: {
2590
- readonly type: "integer";
2591
- };
2592
- readonly name: {
2593
- readonly type: "string";
2594
- };
2595
- readonly key: {
2596
- readonly type: "string";
2597
- };
2598
- readonly field_type: {
2599
- readonly type: "string";
2600
- };
2601
- readonly options: {
2602
- readonly type: "array";
2603
- readonly items: {
2604
- readonly type: "object";
2605
- readonly properties: {
2606
- readonly label: {
2607
- readonly type: "object";
2608
- readonly additionalProperties: {
2609
- readonly type: "string";
2610
- };
2611
- };
2612
- readonly value: {
2613
- readonly type: "string";
2614
- };
2615
- };
2616
- };
2617
- };
2618
- readonly scope_id: {
2619
- readonly type: "integer";
2620
- };
2621
- readonly scope_type: {
2622
- readonly type: "string";
2623
- readonly enum: readonly ["Organization", "Chapter"];
2624
- readonly description: "`Organization` `Chapter`";
2625
- };
2626
- };
2627
- };
2628
- };
2629
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2630
- };
2631
- readonly "404": {
2632
- readonly type: "object";
2633
- readonly properties: {
2634
- readonly error: {
2635
- readonly type: "string";
2636
- };
2637
- };
2638
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2639
- };
2640
- readonly "422": {
2641
- readonly type: "object";
2642
- readonly properties: {
2643
- readonly error: {
2644
- readonly type: "string";
2645
- };
2646
- };
2647
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2648
- };
2649
- };
2650
- };
2651
- declare const PostEmails: {
2652
- readonly metadata: {
2653
- readonly allOf: readonly [{
2654
- readonly type: "object";
2655
- readonly properties: {
2656
- readonly user_id: {
2657
- readonly type: "integer";
2658
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2659
- readonly description: "ID of the user to send email to";
2660
- };
2661
- readonly subject: {
2662
- readonly type: "string";
2663
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2664
- readonly description: "Email subject line (supports Liquid templating)";
2665
- };
2666
- readonly body_html: {
2667
- readonly type: "string";
2668
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2669
- readonly description: "HTML content of the email (supports Liquid templating)";
2670
- };
2671
- readonly body_plain: {
2672
- readonly type: "string";
2673
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2674
- readonly description: "Plain text fallback content";
2675
- };
2676
- readonly email_sender_id: {
2677
- readonly type: "integer";
2678
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2679
- readonly description: "ID of configured email sender (uses org default if omitted)";
2680
- };
2681
- readonly reply_to: {
2682
- readonly type: "string";
2683
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2684
- readonly description: "Reply-to email address";
2685
- };
2686
- readonly attachment_urls: {
2687
- readonly type: "array";
2688
- readonly items: {
2689
- readonly type: "string";
2690
- };
2691
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2692
- readonly description: "Array of URLs to files to attach (max 5)";
2693
- };
2694
- readonly track_opens: {
2695
- readonly type: "boolean";
2696
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2697
- readonly description: "Enable open tracking (default: true)";
2698
- };
2699
- readonly track_clicks: {
2700
- readonly type: "boolean";
2701
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2702
- readonly description: "Enable click tracking (default: true)";
2703
- };
2704
- };
2705
- readonly required: readonly ["user_id", "subject", "body_html"];
2706
- }];
2707
- };
2708
- };
2709
- declare const PostEventAttendances: {
2710
- readonly body: {
2711
- readonly type: "object";
2712
- readonly properties: {
2713
- readonly event_id: {
2714
- readonly type: "integer";
2715
- readonly format: "int64";
2716
- readonly description: "Identifier for the Mobilize event";
2717
- readonly minimum: -9223372036854776000;
2718
- readonly maximum: 9223372036854776000;
2719
- };
2720
- readonly event_session_id: {
2721
- readonly type: "integer";
2722
- readonly format: "int64";
2723
- readonly description: "Identifier for the specific event session";
2724
- readonly minimum: -9223372036854776000;
2725
- readonly maximum: 9223372036854776000;
2726
- };
2727
- readonly user_id: {
2728
- readonly type: "integer";
2729
- readonly format: "int64";
2730
- readonly description: "Identifier for the user attending to the event";
2731
- readonly minimum: -9223372036854776000;
2732
- readonly maximum: 9223372036854776000;
2733
- };
2734
- readonly attended: {
2735
- readonly type: "boolean";
2736
- readonly description: "Indicates if the user attended the event";
2737
- };
2738
- };
2739
- readonly required: readonly ["event_id", "event_session_id", "user_id", "attended"];
2740
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2741
- };
2742
- };
2743
- declare const PostEventRsvps: {
2744
- readonly body: {
2745
- readonly type: "object";
2746
- readonly properties: {
2747
- readonly event_id: {
2748
- readonly type: "integer";
2749
- readonly format: "int64";
2750
- readonly description: "Identifier for the Mobilize event";
2751
- readonly minimum: -9223372036854776000;
2752
- readonly maximum: 9223372036854776000;
2753
- };
2754
- readonly event_session_id: {
2755
- readonly type: "integer";
2756
- readonly format: "int64";
2757
- readonly description: "Identifier for the specific event session";
2758
- readonly minimum: -9223372036854776000;
2759
- readonly maximum: 9223372036854776000;
2760
- };
2761
- readonly user_id: {
2762
- readonly type: "integer";
2763
- readonly format: "int64";
2764
- readonly description: "Identifier for the user RSVPing to the event";
2765
- readonly minimum: -9223372036854776000;
2766
- readonly maximum: 9223372036854776000;
2767
- };
2768
- readonly is_attending: {
2769
- readonly type: "string";
2770
- readonly description: "Indicates if the user is attending the event";
2771
- readonly enum: readonly ["yes", "no", "maybe"];
2772
- };
2773
- readonly is_confirmed: {
2774
- readonly type: "boolean";
2775
- readonly description: "Indicates if the RSVP is confirmed";
2776
- };
2777
- readonly agent_user_id: {
2778
- readonly type: "integer";
2779
- readonly format: "int64";
2780
- readonly description: "Identifier for the agent user, if applicable";
2781
- readonly minimum: -9223372036854776000;
2782
- readonly maximum: 9223372036854776000;
2783
- };
2784
- readonly source: {
2785
- readonly type: "string";
2786
- readonly description: "Source of the RSVP";
2787
- };
2788
- readonly source_system: {
2789
- readonly type: "string";
2790
- readonly description: "System from which the RSVP originated";
2791
- };
2792
- readonly skip_email_confirmation: {
2793
- readonly type: "boolean";
2794
- readonly description: "When true, skips sending the initial email confirmation to the user";
2795
- readonly default: false;
2796
- };
2797
- };
2798
- readonly required: readonly ["event_id", "event_session_id", "is_attending", "agent_user_id"];
2799
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2800
- };
2801
- };
2802
- declare const PostEventSessions: {
2803
- readonly body: {
2804
- readonly type: "object";
2805
- readonly properties: {
2806
- readonly event_id: {
2807
- readonly type: "integer";
2808
- readonly format: "int64";
2809
- readonly description: "Identifier for the Mobilize event";
2810
- readonly minimum: -9223372036854776000;
2811
- readonly maximum: 9223372036854776000;
2812
- };
2813
- readonly start_time: {
2814
- readonly type: "integer";
2815
- readonly format: "int64";
2816
- readonly description: "UTC timestamp in seconds since the Unix epoch";
2817
- readonly minimum: -9223372036854776000;
2818
- readonly maximum: 9223372036854776000;
2819
- };
2820
- readonly end_time: {
2821
- readonly type: "integer";
2822
- readonly format: "int64";
2823
- readonly description: "UTC timestamp in seconds since the Unix epoch";
2824
- readonly minimum: -9223372036854776000;
2825
- readonly maximum: 9223372036854776000;
2826
- };
2827
- readonly event_type: {
2828
- readonly type: "string";
2829
- readonly description: "Type of session";
2830
- readonly enum: readonly ["virtual", "in_person"];
2831
- };
2832
- readonly title: {
2833
- readonly type: "string";
2834
- readonly description: "Title of the event session";
2835
- };
2836
- readonly location_name: {
2837
- readonly type: "string";
2838
- readonly description: "Name of the location";
2839
- };
2840
- readonly location_data: {
2841
- readonly type: "object";
2842
- readonly description: "Structured location details. `components` and `coordinates` may be sent either as native JSON (array/object) or as JSON-encoded strings; both are stored and returned as JSON strings. Neighborhood is the `components` entry whose `types` include \"neighborhood\"; NYC borough is the entry whose `types` include \"sublocality_level_1\".";
2843
- readonly properties: {
2844
- readonly components: {
2845
- readonly type: "string";
2846
- readonly description: "JSON-encoded array of Google-style address component objects ({ long_name, short_name, types: [] }). May also be sent as a native JSON array.";
2847
- };
2848
- readonly coordinates: {
2849
- readonly type: "string";
2850
- readonly description: "JSON-encoded object of the form {\"lat\":<num>,\"lng\":<num>}. May also be sent as a native JSON object.";
2851
- };
2852
- readonly address_city: {
2853
- readonly type: "string";
2854
- };
2855
- readonly full_address: {
2856
- readonly type: "string";
2857
- };
2858
- readonly address_state: {
2859
- readonly type: "string";
2860
- };
2861
- readonly address_line_1: {
2862
- readonly type: "string";
2863
- };
2864
- readonly address_country: {
2865
- readonly type: "string";
2866
- };
2867
- readonly address_postal_code: {
2868
- readonly type: "string";
2869
- };
2870
- };
2871
- };
2872
- readonly location_address: {
2873
- readonly type: "string";
2874
- readonly description: "Physical address of the event location";
2875
- };
2876
- readonly show_rsvp_bar: {
2877
- readonly type: "boolean";
2878
- readonly description: "Flag to show RSVP buttons bar";
2879
- };
2880
- readonly show_title_in_form: {
2881
- readonly type: "boolean";
2882
- readonly description: "Flag to show title in the form";
2883
- };
2884
- readonly note: {
2885
- readonly type: "string";
2886
- readonly description: "Additional notes for the event session";
2887
- };
2888
- readonly max_capacity: {
2889
- readonly type: "integer";
2890
- readonly description: "Maximum capacity for the event session";
2891
- };
2892
- readonly tags: {
2893
- readonly type: "array";
2894
- readonly items: {
2895
- readonly type: "string";
2896
- };
2897
- readonly description: "Array of tags for the event session";
2898
- };
2899
- };
2900
- readonly required: readonly ["event_id", "start_time", "end_time", "title"];
2901
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2902
- };
2903
- };
2904
- declare const PostEvents: {
2905
- readonly body: {
2906
- readonly type: "object";
2907
- readonly properties: {
2908
- readonly title: {
2909
- readonly type: "string";
2910
- readonly description: "Event title (max 65 characters)";
2911
- };
2912
- readonly event_type: {
2913
- readonly type: "string";
2914
- readonly description: "Type of event";
2915
- readonly enum: readonly ["virtual", "in_person", "hybrid"];
2916
- };
2917
- readonly start_time: {
2918
- readonly type: "integer";
2919
- readonly format: "int64";
2920
- readonly description: "Start time as UNIX timestamp";
2921
- readonly minimum: -9223372036854776000;
2922
- readonly maximum: 9223372036854776000;
2923
- };
2924
- readonly end_time: {
2925
- readonly type: "integer";
2926
- readonly format: "int64";
2927
- readonly description: "End time as UNIX timestamp";
2928
- readonly minimum: -9223372036854776000;
2929
- readonly maximum: 9223372036854776000;
2930
- };
2931
- readonly location_address: {
2932
- readonly type: "string";
2933
- readonly description: "For virtual: meeting URL. For in_person and hybrid: street address for the in-person session";
2934
- };
2935
- readonly virtual_url: {
2936
- readonly type: "string";
2937
- readonly description: "Meeting URL for the virtual session when event_type is hybrid";
2938
- };
2939
- readonly location_name: {
2940
- readonly type: "string";
2941
- readonly description: "Display name for location (e.g., \"City Hall\")";
2942
- };
2943
- readonly scope_id: {
2944
- readonly type: "integer";
2945
- readonly format: "int64";
2946
- readonly description: "ID of the scope (Organization or Chapter)";
2947
- readonly minimum: -9223372036854776000;
2948
- readonly maximum: 9223372036854776000;
2949
- };
2950
- readonly scope_type: {
2951
- readonly type: "string";
2952
- readonly description: "Type of scope";
2953
- readonly enum: readonly ["Organization", "Chapter"];
2954
- };
2955
- readonly session_title: {
2956
- readonly type: "string";
2957
- readonly description: "Title for the first event session (defaults to event title)";
2958
- };
2959
- readonly tags: {
2960
- readonly type: "array";
2961
- readonly items: {
2962
- readonly type: "string";
2963
- };
2964
- readonly description: "Event tags";
2965
- };
2966
- readonly max_capacity: {
2967
- readonly type: "integer";
2968
- readonly description: "Maximum capacity for the event session (0 = unlimited)";
2969
- };
2970
- readonly latitude: {
2971
- readonly type: "number";
2972
- readonly format: "float";
2973
- readonly description: "Latitude for in_person events (optional, will geocode if not provided)";
2974
- readonly minimum: -3.402823669209385e+38;
2975
- readonly maximum: 3.402823669209385e+38;
2976
- };
2977
- readonly longitude: {
2978
- readonly type: "number";
2979
- readonly format: "float";
2980
- readonly description: "Longitude for in_person events (optional, will geocode if not provided)";
2981
- readonly minimum: -3.402823669209385e+38;
2982
- readonly maximum: 3.402823669209385e+38;
2983
- };
2984
- readonly skip_duplicate_check: {
2985
- readonly type: "boolean";
2986
- readonly description: "When true, bypasses duplicate event detection (default: false)";
2987
- readonly default: false;
2988
- };
2989
- };
2990
- readonly required: readonly ["title", "event_type", "start_time", "end_time", "scope_id", "scope_type"];
2991
- readonly $schema: "http://json-schema.org/draft-04/schema#";
2992
- };
2993
- };
2994
- declare const PostFieldSurveyUrls: {
2995
- readonly body: {
2996
- readonly type: "object";
2997
- readonly properties: {
2998
- readonly user_id: {
2999
- readonly type: "integer";
3000
- readonly description: "The ID of the user to generate URL for";
3001
- readonly examples: readonly [123];
3002
- };
3003
- readonly agent_user_id: {
3004
- readonly type: "integer";
3005
- readonly description: "The ID of the agent user";
3006
- readonly examples: readonly [456];
3007
- };
3008
- readonly page_id: {
3009
- readonly type: "integer";
3010
- readonly description: "The ID of the action page (field survey)";
3011
- readonly examples: readonly [789];
3012
- };
3013
- };
3014
- readonly required: readonly ["user_id", "agent_user_id", "page_id"];
3015
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3016
- };
3017
- readonly response: {
3018
- readonly "200": {
3019
- readonly type: "object";
3020
- readonly properties: {
3021
- readonly url: {
3022
- readonly type: "string";
3023
- readonly description: "Complete URL with access token. Token expires in 24 hours.";
3024
- readonly examples: readonly ["https://example.com/field-survey/volunteer-survey?access_token=abc123&user_id=456"];
3025
- };
3026
- readonly expires_at: {
3027
- readonly type: "string";
3028
- readonly format: "date-time";
3029
- readonly description: "ISO 8601 timestamp when the access token expires";
3030
- readonly examples: readonly ["2025-11-14T10:30:00Z"];
3031
- };
3032
- };
3033
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3034
- };
3035
- };
3036
- };
3037
- declare const PostScheduledTasks: {
3038
- readonly body: {
3039
- readonly type: "object";
3040
- readonly properties: {
3041
- readonly due_at: {
3042
- readonly type: "string";
3043
- readonly format: "date-time";
3044
- readonly description: "The date and time when the task is due. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer.";
3045
- };
3046
- readonly remind_at: {
3047
- readonly type: "string";
3048
- readonly format: "date-time";
3049
- readonly description: "The date and time when a reminder for the task should be sent. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer.";
3050
- };
3051
- readonly agent_user_id: {
3052
- readonly type: "integer";
3053
- readonly format: "int64";
3054
- readonly description: "Identifier for the agent user assigned to the task";
3055
- readonly minimum: -9223372036854776000;
3056
- readonly maximum: 9223372036854776000;
3057
- };
3058
- readonly user_id: {
3059
- readonly type: "integer";
3060
- readonly format: "int64";
3061
- readonly description: "Identifier for the user who created the task";
3062
- readonly minimum: -9223372036854776000;
3063
- readonly maximum: 9223372036854776000;
3064
- };
3065
- readonly notes: {
3066
- readonly type: "string";
3067
- readonly description: "Additional notes or details about the task";
3068
- };
3069
- readonly marked_as_completed: {
3070
- readonly type: "boolean";
3071
- readonly description: "Indicates if the task has been marked as completed";
3072
- };
3073
- };
3074
- readonly required: readonly ["due_at", "user_id"];
3075
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3076
- };
3077
- };
3078
- declare const PostTaskAgents: {
3079
- readonly body: {
3080
- readonly type: "object";
3081
- readonly properties: {
3082
- readonly user_id: {
3083
- readonly type: "integer";
3084
- readonly format: "int64";
3085
- readonly description: "Identifier for the task agent";
3086
- readonly minimum: -9223372036854776000;
3087
- readonly maximum: 9223372036854776000;
3088
- };
3089
- readonly task_id: {
3090
- readonly type: "integer";
3091
- readonly format: "int64";
3092
- readonly description: "Identifier for the task";
3093
- readonly minimum: -9223372036854776000;
3094
- readonly maximum: 9223372036854776000;
3095
- };
3096
- };
3097
- readonly required: readonly ["user_id", "task_id"];
3098
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3099
- };
3100
- };
3101
- declare const PostTaskAssignments: {
3102
- readonly body: {
3103
- readonly type: "object";
3104
- readonly properties: {
3105
- readonly user_id: {
3106
- readonly type: "integer";
3107
- readonly format: "int64";
3108
- readonly description: "Identifier for the task assignment user";
3109
- readonly minimum: -9223372036854776000;
3110
- readonly maximum: 9223372036854776000;
3111
- };
3112
- readonly task_id: {
3113
- readonly type: "integer";
3114
- readonly format: "int64";
3115
- readonly description: "Identifier for the phonebank or textbank task";
3116
- readonly minimum: -9223372036854776000;
3117
- readonly maximum: 9223372036854776000;
3118
- };
3119
- readonly agent_user_id: {
3120
- readonly type: "integer";
3121
- readonly format: "int64";
3122
- readonly description: "Identifier for the agent user who will conduct outreach (volunteer or staff member)";
3123
- readonly minimum: -9223372036854776000;
3124
- readonly maximum: 9223372036854776000;
3125
- };
3126
- };
3127
- readonly required: readonly ["user_id", "task_id"];
3128
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3129
- };
3130
- };
3131
- declare const PostTeamMembers: {
3132
- readonly body: {
3133
- readonly type: "object";
3134
- readonly properties: {
3135
- readonly member_id: {
3136
- readonly type: "string";
3137
- readonly description: "Hash ID of existing user (optional if phone_number or email provided)";
3138
- };
3139
- readonly phone_number: {
3140
- readonly type: "string";
3141
- readonly description: "Phone number of the person (primary key for user lookup/creation)";
3142
- };
3143
- readonly email: {
3144
- readonly type: "string";
3145
- readonly description: "Email of the person (secondary key for user lookup/creation)";
3146
- };
3147
- readonly full_name: {
3148
- readonly type: "string";
3149
- readonly description: "Full name for new user creation";
3150
- };
3151
- readonly first_name: {
3152
- readonly type: "string";
3153
- readonly description: "First name for new user creation";
3154
- };
3155
- readonly last_name: {
3156
- readonly type: "string";
3157
- readonly description: "Last name for new user creation";
3158
- };
3159
- readonly role_id: {
3160
- readonly type: "integer";
3161
- readonly description: "ID of the role to assign";
3162
- };
3163
- readonly scope_type: {
3164
- readonly type: "string";
3165
- readonly enum: readonly ["Chapter", "Organization"];
3166
- readonly description: "Type of scope";
3167
- };
3168
- readonly scope_id: {
3169
- readonly type: "integer";
3170
- readonly description: "ID of the scope (Chapter or Organization)";
3171
- };
3172
- readonly invite_via: {
3173
- readonly type: "string";
3174
- readonly enum: readonly ["sms", "email"];
3175
- readonly description: "How to send the invitation";
3176
- };
3177
- readonly task_id: {
3178
- readonly type: "integer";
3179
- readonly description: "Optional task ID to assign the member to";
3180
- };
3181
- };
3182
- readonly required: readonly ["role_id", "scope_type", "scope_id", "invite_via"];
3183
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3184
- };
3185
- };
3186
- declare const PostTextTemplates: {
3187
- readonly body: {
3188
- readonly type: "object";
3189
- readonly properties: {
3190
- readonly name: {
3191
- readonly type: "string";
3192
- readonly description: "Name of the entity";
3193
- };
3194
- readonly scope_id: {
3195
- readonly type: "integer";
3196
- readonly format: "int64";
3197
- readonly description: "Identifier for the scope";
3198
- readonly minimum: -9223372036854776000;
3199
- readonly maximum: 9223372036854776000;
3200
- };
3201
- readonly scope_type: {
3202
- readonly type: "string";
3203
- readonly description: "Type of the scope";
3204
- readonly enum: readonly ["Organization", "Chapter"];
3205
- };
3206
- readonly template: {
3207
- readonly type: "object";
3208
- readonly description: "Template content in various languages, where keys are 2-character language codes (e.g., \"en\" for English, \"fr\" for French).";
3209
- readonly additionalProperties: {
3210
- readonly type: "string";
3211
- readonly description: "The message in the specified language.";
3212
- };
3213
- };
3214
- readonly event_id: {
3215
- readonly type: "integer";
3216
- readonly format: "int64";
3217
- readonly description: "Identifier for the associated event, if applicable";
3218
- readonly minimum: -9223372036854776000;
3219
- readonly maximum: 9223372036854776000;
3220
- };
3221
- };
3222
- readonly required: readonly ["iname", "scope_id", "scope_type"];
3223
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3224
- };
3225
- };
3226
- declare const PostTexts: {
3227
- readonly metadata: {
3228
- readonly allOf: readonly [{
3229
- readonly type: "object";
3230
- readonly properties: {
3231
- readonly user_id: {
3232
- readonly type: "integer";
3233
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3234
- };
3235
- readonly body: {
3236
- readonly type: "string";
3237
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3238
- };
3239
- readonly media_urls: {
3240
- readonly type: "array";
3241
- readonly items: {
3242
- readonly type: "string";
3243
- };
3244
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3245
- };
3246
- readonly attach_contact_card: {
3247
- readonly type: "boolean";
3248
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3249
- };
3250
- readonly shorten_urls: {
3251
- readonly type: "boolean";
3252
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3253
- };
3254
- };
3255
- readonly required: readonly ["user_id", "body"];
3256
- }];
3257
- };
3258
- };
3259
- declare const PostUserActions: {
3260
- readonly body: {
3261
- readonly type: "object";
3262
- readonly required: readonly ["page_id"];
3263
- readonly oneOf: readonly [{
3264
- readonly required: readonly ["user_id"];
3265
- readonly properties: {
3266
- readonly page_id: {
3267
- readonly type: "integer";
3268
- readonly format: "int64";
3269
- readonly description: "Identifier for the Page, required for new user actions";
3270
- readonly minimum: -9223372036854776000;
3271
- readonly maximum: 9223372036854776000;
3272
- };
3273
- readonly user_id: {
3274
- readonly type: "integer";
3275
- readonly format: "int64";
3276
- readonly description: "Identifier for the User";
3277
- readonly minimum: -9223372036854776000;
3278
- readonly maximum: 9223372036854776000;
3279
- };
3280
- readonly created_at: {
3281
- readonly type: "integer";
3282
- readonly format: "int64";
3283
- readonly description: "UTC timestamp in seconds since the Unix epoch for the creation time of the user action";
3284
- readonly minimum: -9223372036854776000;
3285
- readonly maximum: 9223372036854776000;
3286
- };
3287
- readonly data: {
3288
- readonly type: "object";
3289
- readonly properties: {
3290
- readonly phone_number: {
3291
- readonly type: "string";
3292
- readonly description: "User's phone number";
3293
- };
3294
- readonly email: {
3295
- readonly type: "string";
3296
- readonly format: "email";
3297
- readonly description: "User's email address";
3298
- };
3299
- readonly first_name: {
3300
- readonly type: "string";
3301
- };
3302
- readonly last_name: {
3303
- readonly type: "string";
3304
- };
3305
- readonly preferred_language: {
3306
- readonly type: "string";
3307
- };
3308
- readonly second_language: {
3309
- readonly type: "string";
3310
- };
3311
- readonly chapter_id: {
3312
- readonly type: "integer";
3313
- };
3314
- readonly address: {
3315
- readonly type: "object";
3316
- readonly properties: {
3317
- readonly address1: {
3318
- readonly type: "string";
3319
- };
3320
- readonly address2: {
3321
- readonly type: "string";
3322
- };
3323
- readonly city: {
3324
- readonly type: "string";
3325
- };
3326
- readonly state: {
3327
- readonly type: "string";
3328
- };
3329
- readonly zip_code: {
3330
- readonly type: "string";
3331
- };
3332
- readonly country: {
3333
- readonly type: "string";
3334
- };
3335
- };
3336
- };
3337
- readonly assessment: {
3338
- readonly type: "string";
3339
- readonly description: "Assessment status key to set on the user (maps to classification)";
3340
- };
3341
- readonly sms_permission: {
3342
- readonly type: "boolean";
3343
- };
3344
- readonly call_permission: {
3345
- readonly type: "boolean";
3346
- };
3347
- readonly email_permission: {
3348
- readonly type: "boolean";
3349
- };
3350
- readonly custom_user_properties: {
3351
- readonly type: "object";
3352
- readonly additionalProperties: {
3353
- readonly type: "string";
3354
- };
3355
- };
3356
- };
3357
- };
3358
- };
3359
- readonly type: "object";
3360
- }, {
3361
- readonly required: readonly ["data"];
3362
- readonly properties: {
3363
- readonly data: {
3364
- readonly type: "object";
3365
- readonly oneOf: readonly [{
3366
- readonly required: readonly ["phone_number"];
3367
- readonly properties: {
3368
- readonly phone_number: {
3369
- readonly type: "string";
3370
- readonly description: "User's phone number";
3371
- };
3372
- readonly email: {
3373
- readonly type: "string";
3374
- readonly format: "email";
3375
- readonly description: "User's email address";
3376
- };
3377
- readonly first_name: {
3378
- readonly type: "string";
3379
- };
3380
- readonly last_name: {
3381
- readonly type: "string";
3382
- };
3383
- readonly preferred_language: {
3384
- readonly type: "string";
3385
- };
3386
- readonly second_language: {
3387
- readonly type: "string";
3388
- };
3389
- readonly chapter_id: {
3390
- readonly type: "integer";
3391
- };
3392
- readonly address: {
3393
- readonly type: "object";
3394
- readonly properties: {
3395
- readonly address1: {
3396
- readonly type: "string";
3397
- };
3398
- readonly address2: {
3399
- readonly type: "string";
3400
- };
3401
- readonly city: {
3402
- readonly type: "string";
3403
- };
3404
- readonly state: {
3405
- readonly type: "string";
3406
- };
3407
- readonly zip_code: {
3408
- readonly type: "string";
3409
- };
3410
- readonly country: {
3411
- readonly type: "string";
3412
- };
3413
- };
3414
- };
3415
- readonly assessment: {
3416
- readonly type: "string";
3417
- readonly description: "Assessment status key to set on the user (maps to classification)";
3418
- };
3419
- readonly sms_permission: {
3420
- readonly type: "boolean";
3421
- };
3422
- readonly call_permission: {
3423
- readonly type: "boolean";
3424
- };
3425
- readonly email_permission: {
3426
- readonly type: "boolean";
3427
- };
3428
- readonly custom_user_properties: {
3429
- readonly type: "object";
3430
- readonly additionalProperties: {
3431
- readonly type: "string";
3432
- };
3433
- };
3434
- };
3435
- readonly type: "object";
3436
- }, {
3437
- readonly required: readonly ["email"];
3438
- readonly properties: {
3439
- readonly phone_number: {
3440
- readonly type: "string";
3441
- readonly description: "User's phone number";
3442
- };
3443
- readonly email: {
3444
- readonly type: "string";
3445
- readonly format: "email";
3446
- readonly description: "User's email address";
3447
- };
3448
- readonly first_name: {
3449
- readonly type: "string";
3450
- };
3451
- readonly last_name: {
3452
- readonly type: "string";
3453
- };
3454
- readonly preferred_language: {
3455
- readonly type: "string";
3456
- };
3457
- readonly second_language: {
3458
- readonly type: "string";
3459
- };
3460
- readonly chapter_id: {
3461
- readonly type: "integer";
3462
- };
3463
- readonly address: {
3464
- readonly type: "object";
3465
- readonly properties: {
3466
- readonly address1: {
3467
- readonly type: "string";
3468
- };
3469
- readonly address2: {
3470
- readonly type: "string";
3471
- };
3472
- readonly city: {
3473
- readonly type: "string";
3474
- };
3475
- readonly state: {
3476
- readonly type: "string";
3477
- };
3478
- readonly zip_code: {
3479
- readonly type: "string";
3480
- };
3481
- readonly country: {
3482
- readonly type: "string";
3483
- };
3484
- };
3485
- };
3486
- readonly assessment: {
3487
- readonly type: "string";
3488
- readonly description: "Assessment status key to set on the user (maps to classification)";
3489
- };
3490
- readonly sms_permission: {
3491
- readonly type: "boolean";
3492
- };
3493
- readonly call_permission: {
3494
- readonly type: "boolean";
3495
- };
3496
- readonly email_permission: {
3497
- readonly type: "boolean";
3498
- };
3499
- readonly custom_user_properties: {
3500
- readonly type: "object";
3501
- readonly additionalProperties: {
3502
- readonly type: "string";
3503
- };
3504
- };
3505
- };
3506
- readonly type: "object";
3507
- }];
3508
- };
3509
- readonly page_id: {
3510
- readonly type: "integer";
3511
- readonly format: "int64";
3512
- readonly description: "Identifier for the Page, required for new user actions";
3513
- readonly minimum: -9223372036854776000;
3514
- readonly maximum: 9223372036854776000;
3515
- };
3516
- readonly user_id: {
3517
- readonly type: "integer";
3518
- readonly format: "int64";
3519
- readonly description: "Identifier for the User";
3520
- readonly minimum: -9223372036854776000;
3521
- readonly maximum: 9223372036854776000;
3522
- };
3523
- readonly created_at: {
3524
- readonly type: "integer";
3525
- readonly format: "int64";
3526
- readonly description: "UTC timestamp in seconds since the Unix epoch for the creation time of the user action";
3527
- readonly minimum: -9223372036854776000;
3528
- readonly maximum: 9223372036854776000;
3529
- };
3530
- };
3531
- readonly type: "object";
3532
- }];
3533
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3534
- };
3535
- };
3536
- declare const PostUserLists: {
3537
- readonly body: {
3538
- readonly type: "object";
3539
- readonly properties: {
3540
- readonly name: {
3541
- readonly type: "string";
3542
- readonly description: "Name of the user list";
3543
- };
3544
- readonly scope_id: {
3545
- readonly type: "integer";
3546
- readonly format: "int64";
3547
- readonly description: "Identifier for the scope";
3548
- readonly minimum: -9223372036854776000;
3549
- readonly maximum: 9223372036854776000;
3550
- };
3551
- readonly scope_type: {
3552
- readonly type: "string";
3553
- readonly description: "Type of the scope";
3554
- readonly enum: readonly ["Organization", "Chapter"];
3555
- };
3556
- readonly event_id: {
3557
- readonly type: "integer";
3558
- readonly format: "int64";
3559
- readonly description: "Identifier for the associated event, if applicable";
3560
- readonly minimum: -9223372036854776000;
3561
- readonly maximum: 9223372036854776000;
3562
- };
3563
- readonly user_id: {
3564
- readonly type: "integer";
3565
- readonly format: "int64";
3566
- readonly description: "Identifier for the associated user";
3567
- readonly minimum: -9223372036854776000;
3568
- readonly maximum: 9223372036854776000;
3569
- };
3570
- readonly parameters: {
3571
- readonly type: "object";
3572
- readonly description: "Parameters for filtering users in QueryBuilder format";
3573
- readonly properties: {
3574
- readonly condition: {
3575
- readonly type: "string";
3576
- readonly enum: readonly ["AND", "OR"];
3577
- readonly description: "Top-level condition for the rules";
3578
- readonly examples: readonly ["AND"];
3579
- };
3580
- readonly valid: {
3581
- readonly type: "boolean";
3582
- readonly description: "Indicates if the rule set is valid";
3583
- readonly examples: readonly [true];
3584
- };
3585
- readonly rules: {
3586
- readonly type: "array";
3587
- readonly items: {
3588
- readonly type: "object";
3589
- readonly properties: {
3590
- readonly id: {
3591
- readonly type: "string";
3592
- readonly description: "Field identifier";
3593
- readonly examples: readonly ["time.account_created"];
3594
- };
3595
- readonly type: {
3596
- readonly type: "string";
3597
- readonly description: "Data type of the field";
3598
- readonly examples: readonly ["date"];
3599
- };
3600
- readonly operator: {
3601
- readonly type: "string";
3602
- readonly description: "Comparison operator";
3603
- readonly examples: readonly ["between"];
3604
- };
3605
- readonly value: {
3606
- readonly oneOf: readonly [{
3607
- readonly type: "string";
3608
- readonly examples: readonly ["2023-10-23"];
3609
- }, {
3610
- readonly type: "number";
3611
- readonly examples: readonly ["2024-07-25"];
3612
- }, {
3613
- readonly type: "boolean";
3614
- }, {
3615
- readonly type: "array";
3616
- readonly items: {
3617
- readonly oneOf: readonly [{
3618
- readonly type: "string";
3619
- }, {
3620
- readonly type: "number";
3621
- }, {
3622
- readonly type: "boolean";
3623
- }];
3624
- };
3625
- }];
3626
- readonly description: "Value or values to compare against";
3627
- readonly examples: readonly [readonly ["2023-10-23", "2024-07-25"]];
3628
- };
3629
- };
3630
- };
3631
- };
3632
- };
3633
- };
3634
- };
3635
- readonly required: readonly ["name", "scope_id", "scope_type", "parameters"];
3636
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3637
- };
3638
- };
3639
- declare const PostUserNotes: {
3640
- readonly metadata: {
3641
- readonly allOf: readonly [{
3642
- readonly type: "object";
3643
- readonly properties: {
3644
- readonly user_id: {
3645
- readonly type: "integer";
3646
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3647
- };
3648
- readonly agent_id: {
3649
- readonly type: "integer";
3650
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3651
- };
3652
- readonly content: {
3653
- readonly type: "string";
3654
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3655
- };
3656
- readonly created_at: {
3657
- readonly type: "integer";
3658
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3659
- };
3660
- readonly restricted: {
3661
- readonly type: "boolean";
3662
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3663
- readonly description: "When true, the note is only visible to team members with the View Restricted Properties permission.";
3664
- };
3665
- readonly interaction_method: {
3666
- readonly type: "string";
3667
- readonly enum: readonly ["in_person", "call", "text", "email"];
3668
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3669
- readonly description: "Optional interaction type that produced the note. One of: in_person, call, text, email.";
3670
- };
3671
- };
3672
- readonly required: readonly ["user_id", "content"];
3673
- }];
3674
- };
3675
- };
3676
- declare const PostUserRelationships: {
3677
- readonly metadata: {
3678
- readonly allOf: readonly [{
3679
- readonly type: "object";
3680
- readonly properties: {
3681
- readonly user_id: {
3682
- readonly type: "integer";
3683
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3684
- };
3685
- readonly related_user_id: {
3686
- readonly type: "integer";
3687
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3688
- };
3689
- readonly relationship_type: {
3690
- readonly type: "string";
3691
- readonly $schema: "http://json-schema.org/draft-04/schema#";
3692
- };
3693
- };
3694
- readonly required: readonly ["user_id", "related_user_id", "relationship_type"];
3695
- }];
3696
- };
3697
- };
3698
- declare const PostUsers: {
3699
- readonly body: {
3700
- readonly type: "object";
3701
- readonly oneOf: readonly [{
3702
- readonly type: "object";
3703
- readonly required: readonly ["phone_number"];
3704
- readonly properties: {
3705
- readonly phone_number: {
3706
- readonly type: "string";
3707
- readonly format: "phone";
3708
- };
3709
- readonly email: {
3710
- readonly type: "string";
3711
- readonly format: "email";
3712
- };
3713
- readonly first_name: {
3714
- readonly type: "string";
3715
- };
3716
- readonly last_name: {
3717
- readonly type: "string";
3718
- };
3719
- readonly preferred_language: {
3720
- readonly type: "string";
3721
- };
3722
- readonly second_language: {
3723
- readonly type: "string";
3724
- };
3725
- readonly chapter_id: {
3726
- readonly type: "integer";
3727
- readonly description: "Primary chapter ID. Required for new users unless chapter_ids is provided.";
3728
- };
3729
- readonly chapter_ids: {
3730
- readonly type: "array";
3731
- readonly description: "Array of chapter IDs for multi-chapter membership. First element becomes primary if chapter_id not provided. Requires multi-chapter feature for more than one chapter.";
3732
- readonly items: {
3733
- readonly type: "integer";
3734
- };
3735
- };
3736
- readonly referred_by_user_id: {
3737
- readonly type: "integer";
3738
- };
3739
- readonly custom_user_properties: {
3740
- readonly type: "object";
3741
- readonly description: "Custom property values keyed by internal_name. Use a string for single-value fields (text, number, radio, dropdown, single checkbox). Use an array of strings for Multiple Checkboxes fields (e.g. [\"Option A\", \"Option B\"]). Comma-separated strings are also accepted for Multiple Checkboxes (e.g. \"Option A, Option B\"). For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.";
3742
- readonly additionalProperties: {
3743
- readonly oneOf: readonly [{
3744
- readonly type: "string";
3745
- }, {
3746
- readonly type: "array";
3747
- readonly items: {
3748
- readonly type: "string";
3749
- };
3750
- }];
3751
- };
3752
- };
3753
- readonly append_custom_user_properties: {
3754
- readonly type: "boolean";
3755
- readonly description: "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types.";
3756
- };
3757
- readonly add_tags: {
3758
- readonly type: "array";
3759
- readonly items: {
3760
- readonly type: "string";
3761
- };
3762
- };
3763
- readonly remove_tags: {
3764
- readonly type: "array";
3765
- readonly items: {
3766
- readonly type: "string";
3767
- };
3768
- };
3769
- readonly donation_charge: {
3770
- readonly type: "object";
3771
- readonly description: "Optional external donation charge to create";
3772
- readonly required: readonly ["amount", "external_donation_id", "external_donation_source"];
3773
- readonly properties: {
3774
- readonly amount: {
3775
- readonly type: "number";
3776
- readonly description: "Donation amount in dollars";
3777
- };
3778
- readonly processing_fee: {
3779
- readonly type: "number";
3780
- readonly description: "Processing fee in dollars";
3781
- };
3782
- readonly external_donation_id: {
3783
- readonly type: "string";
3784
- readonly description: "External platform donation ID";
3785
- };
3786
- readonly external_donation_source: {
3787
- readonly type: "string";
3788
- readonly description: "Source platform (e.g. WePay, ActBlue, etc.)";
3789
- };
3790
- readonly external_donation_date: {
3791
- readonly type: "string";
3792
- readonly format: "date-time";
3793
- readonly description: "Date of the donation";
3794
- };
3795
- };
3796
- };
3797
- readonly address: {
3798
- readonly type: "object";
3799
- readonly description: "Optional address to create. We will attempt to geocode the address if latitude and longitude are not provided.";
3800
- readonly properties: {
3801
- readonly address1: {
3802
- readonly type: "string";
3803
- };
3804
- readonly address2: {
3805
- readonly type: "string";
3806
- };
3807
- readonly city: {
3808
- readonly type: "string";
3809
- };
3810
- readonly state: {
3811
- readonly type: "string";
3812
- };
3813
- readonly zip_code: {
3814
- readonly type: "string";
3815
- };
3816
- readonly country: {
3817
- readonly type: "string";
3818
- };
3819
- readonly latitude: {
3820
- readonly type: "number";
3821
- readonly format: "float";
3822
- readonly minimum: -3.402823669209385e+38;
3823
- readonly maximum: 3.402823669209385e+38;
3824
- };
3825
- readonly longitude: {
3826
- readonly type: "number";
3827
- readonly format: "float";
3828
- readonly minimum: -3.402823669209385e+38;
3829
- readonly maximum: 3.402823669209385e+38;
3830
- };
3831
- };
3832
- };
3833
- readonly assessment: {
3834
- readonly type: "string";
3835
- readonly description: "Assessment status key to set on the user (maps to classification)";
3836
- };
3837
- readonly sms_permission: {
3838
- readonly type: "boolean";
3839
- };
3840
- readonly call_permission: {
3841
- readonly type: "boolean";
3842
- };
3843
- readonly email_permission: {
3844
- readonly type: "boolean";
3845
- };
3846
- readonly timezone: {
3847
- readonly type: "string";
3848
- readonly description: "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")";
3849
- };
3850
- readonly require_contact_info: {
3851
- readonly type: "boolean";
3852
- readonly description: "Whether to require phone_number or email for user creation. Defaults to true.";
3853
- };
3854
- readonly phone_number_textable_validation: {
3855
- readonly type: "boolean";
3856
- readonly description: "Whether to validate that phone number is textable. Defaults to true.";
3857
- };
3858
- readonly lookup_key: {
3859
- readonly type: "string";
3860
- readonly description: "Custom property key (internal_name) to use for user lookup/deduplication. Value is read from custom_user_properties[lookup_key]. Allows matching existing users by external IDs stored in custom properties.";
3861
- };
3862
- };
3863
- }, {
3864
- readonly type: "object";
3865
- readonly required: readonly ["email"];
3866
- readonly properties: {
3867
- readonly phone_number: {
3868
- readonly type: "string";
3869
- readonly format: "phone";
3870
- };
3871
- readonly email: {
3872
- readonly type: "string";
3873
- readonly format: "email";
3874
- };
3875
- readonly first_name: {
3876
- readonly type: "string";
3877
- };
3878
- readonly last_name: {
3879
- readonly type: "string";
3880
- };
3881
- readonly preferred_language: {
3882
- readonly type: "string";
3883
- };
3884
- readonly second_language: {
3885
- readonly type: "string";
3886
- };
3887
- readonly chapter_id: {
3888
- readonly type: "integer";
3889
- readonly description: "Primary chapter ID. Required for new users unless chapter_ids is provided.";
3890
- };
3891
- readonly chapter_ids: {
3892
- readonly type: "array";
3893
- readonly description: "Array of chapter IDs for multi-chapter membership. First element becomes primary if chapter_id not provided. Requires multi-chapter feature for more than one chapter.";
3894
- readonly items: {
3895
- readonly type: "integer";
3896
- };
3897
- };
3898
- readonly referred_by_user_id: {
3899
- readonly type: "integer";
3900
- };
3901
- readonly custom_user_properties: {
3902
- readonly type: "object";
3903
- readonly description: "Custom property values keyed by internal_name. Use a string for single-value fields (text, number, radio, dropdown, single checkbox). Use an array of strings for Multiple Checkboxes fields (e.g. [\"Option A\", \"Option B\"]). Comma-separated strings are also accepted for Multiple Checkboxes (e.g. \"Option A, Option B\"). For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.";
3904
- readonly additionalProperties: {
3905
- readonly oneOf: readonly [{
3906
- readonly type: "string";
3907
- }, {
3908
- readonly type: "array";
3909
- readonly items: {
3910
- readonly type: "string";
3911
- };
3912
- }];
3913
- };
3914
- };
3915
- readonly append_custom_user_properties: {
3916
- readonly type: "boolean";
3917
- readonly description: "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types.";
3918
- };
3919
- readonly add_tags: {
3920
- readonly type: "array";
3921
- readonly items: {
3922
- readonly type: "string";
3923
- };
3924
- };
3925
- readonly remove_tags: {
3926
- readonly type: "array";
3927
- readonly items: {
3928
- readonly type: "string";
3929
- };
3930
- };
3931
- readonly donation_charge: {
3932
- readonly type: "object";
3933
- readonly description: "Optional external donation charge to create";
3934
- readonly required: readonly ["amount", "external_donation_id", "external_donation_source"];
3935
- readonly properties: {
3936
- readonly amount: {
3937
- readonly type: "number";
3938
- readonly description: "Donation amount in dollars";
3939
- };
3940
- readonly processing_fee: {
3941
- readonly type: "number";
3942
- readonly description: "Processing fee in dollars";
3943
- };
3944
- readonly external_donation_id: {
3945
- readonly type: "string";
3946
- readonly description: "External platform donation ID";
3947
- };
3948
- readonly external_donation_source: {
3949
- readonly type: "string";
3950
- readonly description: "Source platform (e.g. WePay, ActBlue, etc.)";
3951
- };
3952
- readonly external_donation_date: {
3953
- readonly type: "string";
3954
- readonly format: "date-time";
3955
- readonly description: "Date of the donation";
3956
- };
3957
- };
3958
- };
3959
- readonly address: {
3960
- readonly type: "object";
3961
- readonly description: "Optional address to create. We will attempt to geocode the address if latitude and longitude are not provided.";
3962
- readonly properties: {
3963
- readonly address1: {
3964
- readonly type: "string";
3965
- };
3966
- readonly address2: {
3967
- readonly type: "string";
3968
- };
3969
- readonly city: {
3970
- readonly type: "string";
3971
- };
3972
- readonly state: {
3973
- readonly type: "string";
3974
- };
3975
- readonly zip_code: {
3976
- readonly type: "string";
3977
- };
3978
- readonly country: {
3979
- readonly type: "string";
3980
- };
3981
- readonly latitude: {
3982
- readonly type: "number";
3983
- readonly format: "float";
3984
- readonly minimum: -3.402823669209385e+38;
3985
- readonly maximum: 3.402823669209385e+38;
3986
- };
3987
- readonly longitude: {
3988
- readonly type: "number";
3989
- readonly format: "float";
3990
- readonly minimum: -3.402823669209385e+38;
3991
- readonly maximum: 3.402823669209385e+38;
3992
- };
3993
- };
3994
- };
3995
- readonly assessment: {
3996
- readonly type: "string";
3997
- readonly description: "Assessment status key to set on the user (maps to classification)";
3998
- };
3999
- readonly sms_permission: {
4000
- readonly type: "boolean";
4001
- };
4002
- readonly call_permission: {
4003
- readonly type: "boolean";
4004
- };
4005
- readonly email_permission: {
4006
- readonly type: "boolean";
4007
- };
4008
- readonly timezone: {
4009
- readonly type: "string";
4010
- readonly description: "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")";
4011
- };
4012
- readonly require_contact_info: {
4013
- readonly type: "boolean";
4014
- readonly description: "Whether to require phone_number or email for user creation. Defaults to true.";
4015
- };
4016
- readonly phone_number_textable_validation: {
4017
- readonly type: "boolean";
4018
- readonly description: "Whether to validate that phone number is textable. Defaults to true.";
4019
- };
4020
- readonly lookup_key: {
4021
- readonly type: "string";
4022
- readonly description: "Custom property key (internal_name) to use for user lookup/deduplication. Value is read from custom_user_properties[lookup_key]. Allows matching existing users by external IDs stored in custom properties.";
4023
- };
4024
- };
4025
- }];
4026
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4027
- };
4028
- };
4029
- declare const PostUsersMerge: {
4030
- readonly body: {
4031
- readonly type: "object";
4032
- readonly properties: {
4033
- readonly primary_user_id: {
4034
- readonly type: "integer";
4035
- readonly description: "ID of the user to keep (the survivor). All data from duplicates will be merged into this user.";
4036
- readonly examples: readonly [100];
4037
- };
4038
- readonly user_ids: {
4039
- readonly type: "array";
4040
- readonly items: {
4041
- readonly type: "integer";
4042
- readonly examples: readonly [101];
4043
- };
4044
- readonly description: "IDs of the duplicate users to merge into the primary user. These users will be deactivated after merge. Also accepts a comma-separated string.";
4045
- };
4046
- };
4047
- readonly required: readonly ["primary_user_id", "user_ids"];
4048
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4049
- };
4050
- readonly response: {
4051
- readonly "200": {
4052
- readonly type: "object";
4053
- readonly properties: {
4054
- readonly message: {
4055
- readonly type: "string";
4056
- };
4057
- readonly primary_user_id: {
4058
- readonly type: "integer";
4059
- readonly description: "ID of the surviving user";
4060
- };
4061
- readonly merged_user_ids: {
4062
- readonly type: "array";
4063
- readonly items: {
4064
- readonly type: "integer";
4065
- };
4066
- readonly description: "IDs that were successfully merged";
4067
- };
4068
- readonly merged_count: {
4069
- readonly type: "integer";
4070
- readonly description: "Number of users merged";
4071
- };
4072
- readonly not_found_user_ids: {
4073
- readonly type: "array";
4074
- readonly items: {
4075
- readonly type: "integer";
4076
- };
4077
- readonly description: "IDs that were not found (only present if some IDs were missing)";
4078
- };
4079
- };
4080
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4081
- };
4082
- };
4083
- };
4084
- declare const PutAgentAssignmentsId: {
4085
- readonly body: {
4086
- readonly type: "object";
4087
- readonly properties: {
4088
- readonly user_id: {
4089
- readonly type: "integer";
4090
- readonly format: "int64";
4091
- readonly description: "Identifier for the user";
4092
- readonly minimum: -9223372036854776000;
4093
- readonly maximum: 9223372036854776000;
4094
- };
4095
- readonly agent_user_id: {
4096
- readonly type: "integer";
4097
- readonly format: "int64";
4098
- readonly description: "Identifier for the agent user";
4099
- readonly minimum: -9223372036854776000;
4100
- readonly maximum: 9223372036854776000;
4101
- };
4102
- readonly is_active: {
4103
- readonly type: "boolean";
4104
- readonly description: "Indicates if the assignment is currently active";
4105
- };
4106
- };
4107
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4108
- };
4109
- readonly metadata: {
4110
- readonly allOf: readonly [{
4111
- readonly type: "object";
4112
- readonly properties: {
4113
- readonly id: {
4114
- readonly type: "integer";
4115
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4116
- readonly description: "Identifier of the agent assignment to update";
4117
- };
4118
- };
4119
- readonly required: readonly ["id"];
4120
- }];
4121
- };
4122
- };
4123
- declare const PutEventRsvpsId: {
4124
- readonly body: {
4125
- readonly type: "object";
4126
- readonly properties: {
4127
- readonly is_attending: {
4128
- readonly type: "string";
4129
- readonly description: "Indicates if the user is attending the event";
4130
- readonly enum: readonly ["yes", "no", "maybe"];
4131
- };
4132
- readonly is_confirmed: {
4133
- readonly type: "boolean";
4134
- readonly description: "Indicates if the RSVP is confirmed";
4135
- };
4136
- readonly agent_user_id: {
4137
- readonly type: "integer";
4138
- readonly format: "int64";
4139
- readonly description: "Identifier for the agent user, if applicable";
4140
- readonly minimum: -9223372036854776000;
4141
- readonly maximum: 9223372036854776000;
4142
- };
4143
- readonly source: {
4144
- readonly type: "string";
4145
- readonly description: "Source of the RSVP";
4146
- };
4147
- readonly source_system: {
4148
- readonly type: "string";
4149
- readonly description: "System from which the RSVP originated";
4150
- };
4151
- };
4152
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4153
- };
4154
- readonly metadata: {
4155
- readonly allOf: readonly [{
4156
- readonly type: "object";
4157
- readonly properties: {
4158
- readonly id: {
4159
- readonly type: "integer";
4160
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4161
- readonly description: "Identifier of the event rsvp to update";
4162
- };
4163
- };
4164
- readonly required: readonly ["id"];
4165
- }];
4166
- };
4167
- };
4168
- declare const PutEventSessionsId: {
4169
- readonly body: {
4170
- readonly type: "object";
4171
- readonly properties: {
4172
- readonly start_time: {
4173
- readonly type: "integer";
4174
- readonly format: "int64";
4175
- readonly description: "UTC timestamp in seconds since the Unix epoch";
4176
- readonly minimum: -9223372036854776000;
4177
- readonly maximum: 9223372036854776000;
4178
- };
4179
- readonly end_time: {
4180
- readonly type: "integer";
4181
- readonly format: "int64";
4182
- readonly description: "UTC timestamp in seconds since the Unix epoch";
4183
- readonly minimum: -9223372036854776000;
4184
- readonly maximum: 9223372036854776000;
4185
- };
4186
- readonly title: {
4187
- readonly type: "string";
4188
- readonly description: "Title of the event session";
4189
- };
4190
- readonly location_name: {
4191
- readonly type: "string";
4192
- readonly description: "Name of the location";
4193
- };
4194
- readonly location_address: {
4195
- readonly type: "string";
4196
- readonly description: "Physical address of the event location";
4197
- };
4198
- readonly location_data: {
4199
- readonly type: "object";
4200
- readonly description: "See create. `components`/`coordinates` accept native JSON or JSON strings and are stored/returned as JSON strings. Omit to leave the existing location_data unchanged.";
4201
- readonly additionalProperties: true;
4202
- };
4203
- readonly show_rsvp_bar: {
4204
- readonly type: "boolean";
4205
- readonly description: "Flag to show RSVP buttons bar";
4206
- };
4207
- readonly show_title_in_form: {
4208
- readonly type: "boolean";
4209
- readonly description: "Flag to show title in the form";
4210
- };
4211
- readonly note: {
4212
- readonly type: "string";
4213
- readonly description: "Additional notes for the event session";
4214
- };
4215
- readonly max_capacity: {
4216
- readonly type: "integer";
4217
- readonly description: "Maximum capacity for the event session";
4218
- };
4219
- readonly tags: {
4220
- readonly type: "array";
4221
- readonly items: {
4222
- readonly type: "string";
4223
- };
4224
- readonly description: "Array of tags for the event session";
4225
- };
4226
- };
4227
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4228
- };
4229
- readonly metadata: {
4230
- readonly allOf: readonly [{
4231
- readonly type: "object";
4232
- readonly properties: {
4233
- readonly id: {
4234
- readonly type: "integer";
4235
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4236
- readonly description: "Identifier of the event session to update";
4237
- };
4238
- };
4239
- readonly required: readonly ["id"];
4240
- }];
4241
- };
4242
- };
4243
- declare const PutScheduledTasksId: {
4244
- readonly body: {
4245
- readonly type: "object";
4246
- readonly properties: {
4247
- readonly due_at: {
4248
- readonly type: "string";
4249
- readonly format: "date-time";
4250
- readonly description: "The date and time when the task is due. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer.";
4251
- };
4252
- readonly remind_at: {
4253
- readonly type: "string";
4254
- readonly format: "date-time";
4255
- readonly description: "The date and time when a reminder for the task should be sent. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer.";
4256
- };
4257
- readonly agent_user_id: {
4258
- readonly type: "integer";
4259
- readonly format: "int64";
4260
- readonly description: "Identifier for the agent user assigned to the task";
4261
- readonly minimum: -9223372036854776000;
4262
- readonly maximum: 9223372036854776000;
4263
- };
4264
- readonly user_id: {
4265
- readonly type: "integer";
4266
- readonly format: "int64";
4267
- readonly description: "Identifier for the user who created the task";
4268
- readonly minimum: -9223372036854776000;
4269
- readonly maximum: 9223372036854776000;
4270
- };
4271
- readonly notes: {
4272
- readonly type: "string";
4273
- readonly description: "Additional notes or details about the task";
4274
- };
4275
- readonly marked_as_completed: {
4276
- readonly type: "boolean";
4277
- readonly description: "Indicates if the task has been marked as completed";
4278
- };
4279
- };
4280
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4281
- };
4282
- readonly metadata: {
4283
- readonly allOf: readonly [{
4284
- readonly type: "object";
4285
- readonly properties: {
4286
- readonly id: {
4287
- readonly type: "integer";
4288
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4289
- readonly description: "Identifier of the scheduled task to update";
4290
- };
4291
- };
4292
- readonly required: readonly ["id"];
4293
- }];
4294
- };
4295
- };
4296
- declare const PutTaskAssignmentsId: {
4297
- readonly body: {
4298
- readonly type: "object";
4299
- readonly properties: {
4300
- readonly agent_user_id: {
4301
- readonly type: "integer";
4302
- readonly format: "int64";
4303
- readonly description: "Identifier for the agent user, if applicable";
4304
- readonly minimum: -9223372036854776000;
4305
- readonly maximum: 9223372036854776000;
4306
- };
4307
- };
4308
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4309
- };
4310
- readonly metadata: {
4311
- readonly allOf: readonly [{
4312
- readonly type: "object";
4313
- readonly properties: {
4314
- readonly id: {
4315
- readonly type: "integer";
4316
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4317
- readonly description: "Identifier of the task assignment to update";
4318
- };
4319
- };
4320
- readonly required: readonly ["id"];
4321
- }];
4322
- };
4323
- };
4324
- declare const PutTeamMembersId: {
4325
- readonly body: {
4326
- readonly type: "object";
4327
- readonly properties: {
4328
- readonly role_id: {
4329
- readonly type: "integer";
4330
- readonly description: "ID of the role to assign";
4331
- };
4332
- readonly scope_type: {
4333
- readonly type: "string";
4334
- readonly enum: readonly ["Chapter", "Organization"];
4335
- readonly description: "Type of scope";
4336
- };
4337
- readonly scope_id: {
4338
- readonly type: "integer";
4339
- readonly description: "ID of the scope (Chapter or Organization)";
4340
- };
4341
- };
4342
- readonly required: readonly ["role_id", "scope_type", "scope_id"];
4343
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4344
- };
4345
- readonly metadata: {
4346
- readonly allOf: readonly [{
4347
- readonly type: "object";
4348
- readonly properties: {
4349
- readonly id: {
4350
- readonly type: "integer";
4351
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4352
- readonly description: "Team member ID (UserRoleScope ID)";
4353
- };
4354
- };
4355
- readonly required: readonly ["id"];
4356
- }];
4357
- };
4358
- };
4359
- declare const PutTextTemplatesId: {
4360
- readonly body: {
4361
- readonly type: "object";
4362
- readonly properties: {
4363
- readonly name: {
4364
- readonly type: "string";
4365
- readonly description: "Name of the entity";
4366
- };
4367
- readonly scope_id: {
4368
- readonly type: "integer";
4369
- readonly format: "int64";
4370
- readonly description: "Identifier for the scope";
4371
- readonly minimum: -9223372036854776000;
4372
- readonly maximum: 9223372036854776000;
4373
- };
4374
- readonly scope_type: {
4375
- readonly type: "string";
4376
- readonly description: "Type of the scope";
4377
- };
4378
- readonly template: {
4379
- readonly type: "object";
4380
- readonly description: "Template content in various languages, where keys are 2-character language codes (e.g., \"en\" for English, \"fr\" for French).";
4381
- readonly additionalProperties: {
4382
- readonly type: "string";
4383
- readonly description: "The message in the specified language.";
4384
- };
4385
- };
4386
- readonly event_id: {
4387
- readonly type: "integer";
4388
- readonly format: "int64";
4389
- readonly description: "Identifier for the associated event, if applicable";
4390
- readonly minimum: -9223372036854776000;
4391
- readonly maximum: 9223372036854776000;
4392
- };
4393
- };
4394
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4395
- };
4396
- readonly metadata: {
4397
- readonly allOf: readonly [{
4398
- readonly type: "object";
4399
- readonly properties: {
4400
- readonly id: {
4401
- readonly type: "integer";
4402
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4403
- readonly description: "Identifier of the text template to update";
4404
- };
4405
- };
4406
- readonly required: readonly ["id"];
4407
- }];
4408
- };
4409
- };
4410
- declare const PutUserListsId: {
4411
- readonly body: {
4412
- readonly type: "object";
4413
- readonly properties: {
4414
- readonly name: {
4415
- readonly type: "string";
4416
- readonly description: "Name of the user list";
4417
- };
4418
- readonly scope_id: {
4419
- readonly type: "integer";
4420
- readonly format: "int64";
4421
- readonly description: "Identifier for the scope";
4422
- readonly minimum: -9223372036854776000;
4423
- readonly maximum: 9223372036854776000;
4424
- };
4425
- readonly scope_type: {
4426
- readonly type: "string";
4427
- readonly description: "Type of the scope";
4428
- readonly enum: readonly ["Organization", "Chapter"];
4429
- };
4430
- readonly parameters: {
4431
- readonly type: "object";
4432
- readonly description: "Parameters for filtering users in QueryBuilder format";
4433
- readonly properties: {
4434
- readonly condition: {
4435
- readonly type: "string";
4436
- readonly enum: readonly ["AND", "OR"];
4437
- readonly description: "Top-level condition for the rules";
4438
- };
4439
- readonly valid: {
4440
- readonly type: "boolean";
4441
- readonly description: "Indicates if the rule set is valid";
4442
- };
4443
- readonly rules: {
4444
- readonly type: "array";
4445
- readonly items: {
4446
- readonly type: "object";
4447
- readonly properties: {
4448
- readonly id: {
4449
- readonly type: "string";
4450
- readonly description: "Field identifier";
4451
- };
4452
- readonly type: {
4453
- readonly type: "string";
4454
- readonly description: "Data type of the field";
4455
- };
4456
- readonly operator: {
4457
- readonly type: "string";
4458
- readonly description: "Comparison operator";
4459
- };
4460
- readonly value: {
4461
- readonly oneOf: readonly [{
4462
- readonly type: "string";
4463
- }, {
4464
- readonly type: "number";
4465
- }, {
4466
- readonly type: "boolean";
4467
- }, {
4468
- readonly type: "array";
4469
- readonly items: {
4470
- readonly oneOf: readonly [{
4471
- readonly type: "string";
4472
- }, {
4473
- readonly type: "number";
4474
- }, {
4475
- readonly type: "boolean";
4476
- }];
4477
- };
4478
- }];
4479
- readonly description: "Value or values to compare against";
4480
- };
4481
- };
4482
- };
4483
- };
4484
- };
4485
- };
4486
- readonly event_id: {
4487
- readonly type: "integer";
4488
- readonly format: "int64";
4489
- readonly description: "Identifier for the associated event, if applicable";
4490
- readonly minimum: -9223372036854776000;
4491
- readonly maximum: 9223372036854776000;
4492
- };
4493
- };
4494
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4495
- };
4496
- readonly metadata: {
4497
- readonly allOf: readonly [{
4498
- readonly type: "object";
4499
- readonly properties: {
4500
- readonly id: {
4501
- readonly type: "integer";
4502
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4503
- readonly description: "Identifier of the user list to update";
4504
- };
4505
- };
4506
- readonly required: readonly ["id"];
4507
- }];
4508
- };
4509
- };
4510
- declare const PutUsersId: {
4511
- readonly body: {
4512
- readonly type: "object";
4513
- readonly properties: {
4514
- readonly phone_number: {
4515
- readonly type: "string";
4516
- readonly format: "phone";
4517
- };
4518
- readonly email: {
4519
- readonly type: "string";
4520
- readonly format: "email";
4521
- };
4522
- readonly first_name: {
4523
- readonly type: "string";
4524
- };
4525
- readonly last_name: {
4526
- readonly type: "string";
4527
- };
4528
- readonly preferred_language: {
4529
- readonly type: "string";
4530
- };
4531
- readonly chapter_id: {
4532
- readonly type: "integer";
4533
- readonly description: "Primary chapter ID (backwards compatible)";
4534
- };
4535
- readonly chapter_ids: {
4536
- readonly type: "array";
4537
- readonly items: {
4538
- readonly type: "integer";
4539
- };
4540
- readonly description: "Full array of chapter IDs (replaces all). Requires multi-chapter feature.";
4541
- };
4542
- readonly add_chapter_ids: {
4543
- readonly type: "array";
4544
- readonly items: {
4545
- readonly type: "integer";
4546
- };
4547
- readonly description: "Array of chapter IDs to add. Requires multi-chapter feature.";
4548
- };
4549
- readonly remove_chapter_ids: {
4550
- readonly type: "array";
4551
- readonly items: {
4552
- readonly type: "integer";
4553
- };
4554
- readonly description: "Array of chapter IDs to remove. Requires multi-chapter feature.";
4555
- };
4556
- readonly set_exclusive_chapter: {
4557
- readonly type: "boolean";
4558
- readonly description: "When true with chapter_id, sets that chapter as the only chapter (removes all other chapter memberships).";
4559
- };
4560
- readonly second_language: {
4561
- readonly type: "string";
4562
- };
4563
- readonly referred_by_user_id: {
4564
- readonly type: "integer";
4565
- };
4566
- readonly custom_user_properties: {
4567
- readonly type: "object";
4568
- readonly additionalProperties: {
4569
- readonly oneOf: readonly [{
4570
- readonly type: "string";
4571
- }, {
4572
- readonly type: "array";
4573
- readonly items: {
4574
- readonly type: "string";
4575
- };
4576
- }];
4577
- };
4578
- readonly description: "Custom property values keyed by internal_name. Use a string for single-value fields. Use an array of strings for Multiple Checkboxes fields. Comma-separated strings are also accepted for Multiple Checkboxes. For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.";
4579
- };
4580
- readonly append_custom_user_properties: {
4581
- readonly type: "boolean";
4582
- readonly description: "Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types.";
4583
- };
4584
- readonly address: {
4585
- readonly type: "object";
4586
- readonly description: "Optional address to update. We will attempt to geocode the address if latitude and longitude are not provided.";
4587
- readonly properties: {
4588
- readonly address1: {
4589
- readonly type: "string";
4590
- };
4591
- readonly address2: {
4592
- readonly type: "string";
4593
- };
4594
- readonly city: {
4595
- readonly type: "string";
4596
- };
4597
- readonly state: {
4598
- readonly type: "string";
4599
- };
4600
- readonly zip_code: {
4601
- readonly type: "string";
4602
- };
4603
- readonly country: {
4604
- readonly type: "string";
4605
- };
4606
- readonly latitude: {
4607
- readonly type: "number";
4608
- readonly format: "float";
4609
- readonly minimum: -3.402823669209385e+38;
4610
- readonly maximum: 3.402823669209385e+38;
4611
- };
4612
- readonly longitude: {
4613
- readonly type: "number";
4614
- readonly format: "float";
4615
- readonly minimum: -3.402823669209385e+38;
4616
- readonly maximum: 3.402823669209385e+38;
4617
- };
4618
- };
4619
- };
4620
- readonly assessment: {
4621
- readonly type: "string";
4622
- readonly description: "Assessment status key to set on the user (maps to classification)";
4623
- };
4624
- readonly sms_permission: {
4625
- readonly type: "boolean";
4626
- };
4627
- readonly call_permission: {
4628
- readonly type: "boolean";
4629
- };
4630
- readonly email_permission: {
4631
- readonly type: "boolean";
4632
- };
4633
- readonly timezone: {
4634
- readonly type: "string";
4635
- readonly description: "IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\")";
4636
- };
4637
- readonly donation_charge: {
4638
- readonly type: "object";
4639
- readonly description: "Optional external donation charge to create";
4640
- readonly properties: {
4641
- readonly amount: {
4642
- readonly type: "number";
4643
- readonly description: "Donation amount in dollars";
4644
- };
4645
- readonly processing_fee: {
4646
- readonly type: "number";
4647
- readonly description: "Processing fee in dollars";
4648
- };
4649
- readonly external_donation_id: {
4650
- readonly type: "string";
4651
- readonly description: "External platform donation ID";
4652
- };
4653
- readonly external_donation_source: {
4654
- readonly type: "string";
4655
- readonly description: "Source platform (e.g. WePay, ActBlue, etc.)";
4656
- };
4657
- readonly external_donation_date: {
4658
- readonly type: "string";
4659
- readonly format: "date-time";
4660
- readonly description: "Date of the donation";
4661
- };
4662
- };
4663
- readonly required: readonly ["amount", "external_donation_id", "external_donation_source"];
4664
- };
4665
- };
4666
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4667
- };
4668
- readonly metadata: {
4669
- readonly allOf: readonly [{
4670
- readonly type: "object";
4671
- readonly properties: {
4672
- readonly id: {
4673
- readonly type: "integer";
4674
- readonly $schema: "http://json-schema.org/draft-04/schema#";
4675
- readonly description: "ID of the user to update";
4676
- };
4677
- };
4678
- readonly required: readonly ["id"];
4679
- }];
4680
- };
4681
- };
4682
- export { DeleteAgentAssignmentsId, DeleteCustomUserPropertiesCustomUserPropertyIdOptionsId, DeleteEventAttendancesId, DeleteEventRsvpsId, DeleteEventSessionsId, DeleteScheduledTasksId, DeleteTaskAgentsId, DeleteTaskAssignmentsId, DeleteTextTemplatesId, DeleteUserListsId, DeleteUserNotesId, DeleteUserRelationshipsId, GetActivities, GetAgentAssignments, GetAgentAssignmentsId, GetCalls, GetChapterPhoneNumbers, GetChapters, GetCustomUserProperties, GetDonationCharges, GetDonationChargesId, GetEmailBlasts, GetEmailBlastsId, GetEmailSenders, GetEventAttendances, GetEventRsvps, GetEventRsvpsId, GetEventSessions, GetEventSessionsId, GetEvents, GetEventsId, GetOrganizations, GetOrganizationsId, GetPages, GetPagesId, GetPhonebanks, GetPhonebanksId, GetScheduledCalls, GetScheduledCallsId, GetScheduledTasks, GetScheduledTasksId, GetTaskAgents, GetTaskAgentsId, GetTaskAssignments, GetTaskAssignmentsId, GetTeamMembers, GetTextBlasts, GetTextBlastsId, GetTextTemplates, GetTextTemplatesId, GetTextbanks, GetTextbanksId, GetTexts, GetUserActions, GetUserLists, GetUserListsId, GetUserRelationships, GetUsers, GetUsersId, PostAgentAssignments, PostAutomationEnrollments, PostCustomUserProperties, PostCustomUserPropertiesIdOptions, PostEmails, PostEventAttendances, PostEventRsvps, PostEventSessions, PostEvents, PostFieldSurveyUrls, PostScheduledTasks, PostTaskAgents, PostTaskAssignments, PostTeamMembers, PostTextTemplates, PostTexts, PostUserActions, PostUserLists, PostUserNotes, PostUserRelationships, PostUsers, PostUsersMerge, PutAgentAssignmentsId, PutEventRsvpsId, PutEventSessionsId, PutScheduledTasksId, PutTaskAssignmentsId, PutTeamMembersId, PutTextTemplatesId, PutUserListsId, PutUsersId };