nationbuilder-rb 0.6.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/VERSION +1 -1
  3. data/lib/nationbuilder/api_spec.json +2469 -1989
  4. data/nationbuilder-rb.gemspec +3 -3
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b07b22e7029afcf035ece2b3919be2089dacadf6
4
- data.tar.gz: af29ce1b9f299c4e2c64792594a454301176fdf4
3
+ metadata.gz: 3459d846ec0b373d1aaa9cc55d8bc993fd83ea51
4
+ data.tar.gz: ec82cf2253c05dfdab8365b9276ff98502802969
5
5
  SHA512:
6
- metadata.gz: fd517e2e40ff9b4645748037910984de93e61feda632069fecaeb5d757e33e71434d043dedaa434d93224ee6c2b86a1c2ac55e6928399d8b6137d3cd2f7093fc
7
- data.tar.gz: 7e761b9b8c6910cd2f4e5b9f1de3df00aa260c30227ccbb36c1530e16863605edb12fa153e83be4ca91a561ebd5ce190a6e166a103be1d82983fe9d28d6313b6
6
+ metadata.gz: 0718923f04ff9617d23d56fa1fe5d8374c84dc2a2891f7354e016f33d736f6a168f1308ade0fcee672dbea772e4de1a8546793b70c80f5be17f8ca1e1571fb20
7
+ data.tar.gz: 4aeabccddd681bffd463927d4128569ac4c49fe01a7f342136e201493194caad2e3861ebf744aa10a447510a061fe2c60bcca05bf573f0886938e50ec789a5fd
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.6.0
1
+ 0.7.0
data/lib/nationbuilder/api_spec.json CHANGED
@@ -1,1999 +1,2479 @@
1
1
  {
2
- "endpoints": [{
3
- "name": "Basic Pages",
4
- "methods": [{
5
- "MethodName": "Index",
6
- "Synopsis": "Shows a list of the basic pages in the system",
7
- "HTTPMethod": "GET",
8
- "URI": "/sites/:site_slug/pages/basic_pages",
9
- "parameters": [{
10
- "Name": "site_slug",
11
- "Required": "Y",
12
- "Default": null,
13
- "Type": "string",
14
- "Description": "the site holding the basic page"
15
- }, {
16
- "Name": "page",
17
- "Required": "N",
18
- "Default": "1",
19
- "Type": "int",
20
- "Description": "result page number"
21
- }, {
22
- "Name": "per_page",
23
- "Required": "N",
24
- "Default": "10",
25
- "Type": "int",
26
- "Description": "number of results to return"
27
- }]
28
- }, {
29
- "MethodName": "Create",
30
- "Synopsis": "Creates a basic page for a site",
31
- "HTTPMethod": "POST",
32
- "URI": "/sites/:site_slug/pages/basic_pages",
33
- "parameters": [{
34
- "Name": "site_slug",
35
- "Required": "Y",
36
- "Default": null,
37
- "Type": "string",
38
- "Description": "the site holding the basic page"
39
- }, {
40
- "Name": "body",
41
- "Required": "Y",
42
- "Default": null,
43
- "Type": "json",
44
- "Description": "a JSON representation of the new basic page"
45
- }]
46
- }, {
47
- "MethodName": "Update",
48
- "Synopsis": "Updates the attributes of a basic page",
49
- "HTTPMethod": "PUT",
50
- "URI": "/sites/:site_slug/pages/basic_pages/:id",
51
- "parameters": [{
52
- "Name": "site_slug",
53
- "Required": "Y",
54
- "Default": null,
55
- "Type": "string",
56
- "Description": "the site holding the basic page"
57
- }, {
58
- "Name": "id",
59
- "Required": "Y",
60
- "Default": null,
61
- "Type": "int",
62
- "Description": "the ID of the basic page"
63
- }, {
64
- "Name": "body",
65
- "Required": "Y",
66
- "Default": null,
67
- "Type": "json",
68
- "Description": "JSON containing updates"
69
- }]
70
- }, {
71
- "MethodName": "Destroy",
72
- "Synopsis": "Removes a basic page",
73
- "HTTPMethod": "DELETE",
74
- "URI": "/sites/:site_slug/pages/basic_pages/:id",
75
- "parameters": [{
76
- "Name": "site_slug",
77
- "Required": "Y",
78
- "Default": null,
79
- "Type": "string",
80
- "Description": "the site holding the basic page"
81
- }, {
82
- "Name": "id",
83
- "Required": "Y",
84
- "Default": null,
85
- "Type": "int",
86
- "Description": "the ID of the basic page"
87
- }]
88
- }]
89
- }, {
90
- "name": "Blog Posts",
91
- "methods": [{
92
- "MethodName": "Index",
93
- "Synopsis": "Shows a list of blog's posts",
94
- "HTTPMethod": "GET",
95
- "URI": "/sites/:site_slug/pages/blogs/:id/posts",
96
- "parameters": [{
97
- "Name": "site_slug",
98
- "Required": "Y",
99
- "Default": null,
100
- "Type": "string",
101
- "Description": "the site holding the blog"
102
- }, {
103
- "Name": "id",
104
- "Required": "Y",
105
- "Default": null,
106
- "Type": "int",
107
- "Description": "the ID of the blog"
108
- }, {
109
- "Name": "page",
110
- "Required": "N",
111
- "Default": "1",
112
- "Type": "int",
113
- "Description": "result page number"
114
- }, {
115
- "Name": "per_page",
116
- "Required": "N",
117
- "Default": "10",
118
- "Type": "int",
119
- "Description": "number of results to return"
120
- }]
121
- }, {
122
- "MethodName": "Match",
123
- "Synopsis": "Find a blog post by its external id",
124
- "HTTPMethod": "GET",
125
- "URI": "/sites/:site_slug/pages/blogs/:id/match",
126
- "parameters": [{
127
- "Name": "site_slug",
128
- "Required": "Y",
129
- "Default": null,
130
- "Type": "string",
131
- "Description": "the site holding the blog"
132
- }, {
133
- "Name": "id",
134
- "Required": "Y",
135
- "Default": null,
136
- "Type": "int",
137
- "Description": "the ID of the blog"
138
- }, {
139
- "Name": "external_id",
140
- "Required": "N",
141
- "Default": "1",
142
- "Type": "int",
143
- "Description": "the external id of the post"
144
- }]
145
- }, {
146
- "MethodName": "Create",
147
- "Synopsis": "Creates a new blog post",
148
- "HTTPMethod": "POST",
149
- "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts",
150
- "parameters": [{
151
- "Name": "site_slug",
152
- "Required": "Y",
153
- "Default": null,
154
- "Type": "string",
155
- "Description": "the site holding the blog"
156
- }, {
157
- "Name": "blog_id",
158
- "Required": "Y",
159
- "Default": null,
160
- "Type": "int",
161
- "Description": "the ID of the blog"
162
- }, {
163
- "Name": "body",
164
- "Required": "Y",
165
- "Default": "1",
166
- "Type": "json",
167
- "Description": "a JSON representation of the new post"
168
- }]
169
- }, {
170
- "MethodName": "Update",
171
- "Synopsis": "Updates the attributes of a blog post",
172
- "HTTPMethod": "PUT",
173
- "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
174
- "parameters": [{
175
- "Name": "site_slug",
176
- "Required": "Y",
177
- "Default": null,
178
- "Type": "string",
179
- "Description": "the site holding the blog"
180
- }, {
181
- "Name": "blog_id",
182
- "Required": "Y",
183
- "Default": null,
184
- "Type": "int",
185
- "Description": "the ID of the blog"
186
- }, {
187
- "Name": "blog_post_id",
188
- "Required": "Y",
189
- "Default": null,
190
- "Type": "int",
191
- "Description": "the ID of the blog"
192
- }, {
193
- "Name": "body",
194
- "Required": "Y",
195
- "Default": "1",
196
- "Type": "json",
197
- "Description": "JSON containing updates"
198
- }]
199
- }, {
200
- "MethodName": "Destroy",
201
- "Synopsis": "Removes a blog post",
202
- "HTTPMethod": "DELETE",
203
- "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
204
- "parameters": [{
205
- "Name": "site_slug",
206
- "Required": "Y",
207
- "Default": null,
208
- "Type": "string",
209
- "Description": "the site holding the blog"
210
- }, {
211
- "Name": "blog_id",
212
- "Required": "Y",
213
- "Default": null,
214
- "Type": "int",
215
- "Description": "the ID of the blog"
216
- }, {
217
- "Name": "blog_post_id",
218
- "Required": "Y",
219
- "Default": null,
220
- "Type": "int",
221
- "Description": "the ID of the blog"
222
- }]
223
- }]
224
- }, {
225
- "name": "Blogs",
226
- "methods": [{
227
- "MethodName": "Index",
228
- "Synopsis": "Shows a list of all blogs",
229
- "HTTPMethod": "GET",
230
- "URI": "/sites/:site_slug/pages/blogs",
231
- "parameters": [{
232
- "Name": "site_slug",
233
- "Required": "Y",
234
- "Default": null,
235
- "Type": "string",
236
- "Description": "the site holding the blog"
237
- }, {
238
- "Name": "page",
239
- "Required": "N",
240
- "Default": "1",
241
- "Type": "int",
242
- "Description": "result page number"
243
- }, {
244
- "Name": "per_page",
245
- "Required": "N",
246
- "Default": "10",
247
- "Type": "int",
248
- "Description": "number of results to return"
249
- }]
250
- }, {
251
- "MethodName": "Show",
252
- "Synopsis": "Show the details of a blog",
253
- "HTTPMethod": "GET",
254
- "URI": "/sites/:site_slug/pages/blogs/:id",
255
- "parameters": [{
256
- "Name": "site_slug",
257
- "Required": "Y",
258
- "Default": null,
259
- "Type": "string",
260
- "Description": "the site holding the blog"
261
- }, {
262
- "Name": "id",
263
- "Required": "Y",
264
- "Default": null,
265
- "Type": "int",
266
- "Description": "the ID of the blog"
267
- }]
268
- }, {
269
- "MethodName": "Create",
270
- "Synopsis": "Creates a new blog",
271
- "HTTPMethod": "POST",
272
- "URI": "/sites/:site_slug/pages/blogs",
273
- "parameters": [{
274
- "Name": "site_slug",
275
- "Required": "Y",
276
- "Default": null,
277
- "Type": "string",
278
- "Description": "the site holding the blog"
279
- }, {
280
- "Name": "body",
281
- "Required": "Y",
282
- "Default": "1",
283
- "Type": "json",
284
- "Description": "a JSON representation of the new blog"
285
- }]
286
- }, {
287
- "MethodName": "Update",
288
- "Synopsis": "Updates the attributes of a blog",
289
- "HTTPMethod": "PUT",
290
- "URI": "/sites/:site_slug/pages/blogs/:id",
291
- "parameters": [{
292
- "Name": "site_slug",
293
- "Required": "Y",
294
- "Default": null,
295
- "Type": "string",
296
- "Description": "the site holding the blog"
297
- }, {
298
- "Name": "id",
299
- "Required": "Y",
300
- "Default": null,
301
- "Type": "int",
302
- "Description": "the ID of the blog"
303
- }, {
304
- "Name": "body",
305
- "Required": "Y",
306
- "Default": "1",
307
- "Type": "json",
308
- "Description": "JSON containing updates"
309
- }]
310
- }, {
311
- "MethodName": "Destroy",
312
- "Synopsis": "Removes a blog",
313
- "HTTPMethod": "DELETE",
314
- "URI": "/sites/:site_slug/pages/blogs/:id",
315
- "parameters": [{
316
- "Name": "site_slug",
317
- "Required": "Y",
318
- "Default": null,
319
- "Type": "string",
320
- "Description": "the site holding the blog"
321
- }, {
322
- "Name": "id",
323
- "Required": "Y",
324
- "Default": null,
325
- "Type": "int",
326
- "Description": "the ID of the blog"
327
- }]
328
- }]
329
- }, {
330
- "name": "Calendars",
331
- "methods": [{
332
- "MethodName": "Index",
333
- "Synopsis": "Shows a list of calendars",
334
- "HTTPMethod": "GET",
335
- "URI": "/sites/:site_slug/pages/calendars",
336
- "parameters": [{
337
- "Name": "site_slug",
338
- "Required": "Y",
339
- "Default": null,
340
- "Type": "string",
341
- "Description": "the site holding the calendars"
342
- }, {
343
- "Name": "page",
344
- "Required": "N",
345
- "Default": "1",
346
- "Type": "int",
347
- "Description": "result page number"
348
- }, {
349
- "Name": "per_page",
350
- "Required": "N",
351
- "Default": "10",
352
- "Type": "int",
353
- "Description": "number of results to return"
354
- }]
355
- }, {
356
- "MethodName": "Show",
357
- "Synopsis": "Show the details of a calendar",
358
- "HTTPMethod": "GET",
359
- "URI": "/sites/:site_slug/pages/calendars/:id",
360
- "parameters": [{
361
- "Name": "site_slug",
362
- "Required": "Y",
363
- "Default": null,
364
- "Type": "string",
365
- "Description": "the site holding the calendar"
366
- }, {
367
- "Name": "id",
368
- "Required": "Y",
369
- "Default": null,
370
- "Type": "int",
371
- "Description": "the ID of the calendar"
372
- }]
373
- }, {
374
- "MethodName": "Create",
375
- "Synopsis": "Creates a new calendar",
376
- "HTTPMethod": "POST",
377
- "URI": "/sites/:site_slug/pages/calendars",
378
- "parameters": [{
379
- "Name": "site_slug",
380
- "Required": "Y",
381
- "Default": null,
382
- "Type": "string",
383
- "Description": "the site holding the calendar"
384
- }, {
385
- "Name": "body",
386
- "Required": "Y",
387
- "Default": "1",
388
- "Type": "json",
389
- "Description": "a JSON representation of the new calendar"
390
- }]
391
- }, {
392
- "MethodName": "Update",
393
- "Synopsis": "Updates the attributes of a calendar",
394
- "HTTPMethod": "PUT",
395
- "URI": "/sites/:site_slug/pages/calendars/:id",
396
- "parameters": [{
397
- "Name": "site_slug",
398
- "Required": "Y",
399
- "Default": null,
400
- "Type": "string",
401
- "Description": "the site holding the calendar"
402
- }, {
403
- "Name": "id",
404
- "Required": "Y",
405
- "Default": null,
406
- "Type": "int",
407
- "Description": "the ID of the calendar"
408
- }, {
409
- "Name": "body",
410
- "Required": "Y",
411
- "Default": "1",
412
- "Type": "json",
413
- "Description": "JSON containing updates"
414
- }]
415
- }, {
416
- "MethodName": "Destroy",
417
- "Synopsis": "Removes a calendar",
418
- "HTTPMethod": "DELETE",
419
- "URI": "/sites/:site_slug/pages/calendars/:id",
420
- "parameters": [{
421
- "Name": "site_slug",
422
- "Required": "Y",
423
- "Default": null,
424
- "Type": "string",
425
- "Description": "the site holding the calendar"
426
- }, {
427
- "Name": "id",
428
- "Required": "Y",
429
- "Default": null,
430
- "Type": "int",
431
- "Description": "the ID of the calendar"
432
- }]
433
- }]
434
- }, {
435
- "name": "Campaign Data",
436
- "methods": [{
437
- "MethodName": "Show",
438
- "Synopsis": "Shows campaign metadata about the nation",
439
- "HTTPMethod": "GET",
440
- "URI": "/campaign_data",
441
- "parameters": [
442
-
2
+ "endpoints": [
3
+ {
4
+ "name": "Basic Pages",
5
+ "methods": [
6
+ {
7
+ "MethodName": "Index",
8
+ "Synopsis": "Shows a list of the basic pages in the system",
9
+ "HTTPMethod": "GET",
10
+ "URI": "/sites/:site_slug/pages/basic_pages",
11
+ "parameters": [
12
+ {
13
+ "Name": "site_slug",
14
+ "Required": "Y",
15
+ "Default": null,
16
+ "Type": "string",
17
+ "Description": "the site holding the basic page"
18
+ },
19
+ {
20
+ "Name": "page",
21
+ "Required": "N",
22
+ "Default": "1",
23
+ "Type": "int",
24
+ "Description": "result page number"
25
+ },
26
+ {
27
+ "Name": "per_page",
28
+ "Required": "N",
29
+ "Default": "10",
30
+ "Type": "int",
31
+ "Description": "number of results to return"
32
+ }
33
+ ]
34
+ },
35
+ {
36
+ "MethodName": "Create",
37
+ "Synopsis": "Creates a basic page for a site",
38
+ "HTTPMethod": "POST",
39
+ "URI": "/sites/:site_slug/pages/basic_pages",
40
+ "parameters": [
41
+ {
42
+ "Name": "site_slug",
43
+ "Required": "Y",
44
+ "Default": null,
45
+ "Type": "string",
46
+ "Description": "the site holding the basic page"
47
+ },
48
+ {
49
+ "Name": "body",
50
+ "Required": "Y",
51
+ "Default": null,
52
+ "Type": "json",
53
+ "Description": "a JSON representation of the new basic page"
54
+ }
55
+ ]
56
+ },
57
+ {
58
+ "MethodName": "Update",
59
+ "Synopsis": "Updates the attributes of a basic page",
60
+ "HTTPMethod": "PUT",
61
+ "URI": "/sites/:site_slug/pages/basic_pages/:id",
62
+ "parameters": [
63
+ {
64
+ "Name": "site_slug",
65
+ "Required": "Y",
66
+ "Default": null,
67
+ "Type": "string",
68
+ "Description": "the site holding the basic page"
69
+ },
70
+ {
71
+ "Name": "id",
72
+ "Required": "Y",
73
+ "Default": null,
74
+ "Type": "int",
75
+ "Description": "the ID of the basic page"
76
+ },
77
+ {
78
+ "Name": "body",
79
+ "Required": "Y",
80
+ "Default": null,
81
+ "Type": "json",
82
+ "Description": "JSON containing updates"
83
+ }
84
+ ]
85
+ },
86
+ {
87
+ "MethodName": "Destroy",
88
+ "Synopsis": "Removes a basic page",
89
+ "HTTPMethod": "DELETE",
90
+ "URI": "/sites/:site_slug/pages/basic_pages/:id",
91
+ "parameters": [
92
+ {
93
+ "Name": "site_slug",
94
+ "Required": "Y",
95
+ "Default": null,
96
+ "Type": "string",
97
+ "Description": "the site holding the basic page"
98
+ },
99
+ {
100
+ "Name": "id",
101
+ "Required": "Y",
102
+ "Default": null,
103
+ "Type": "int",
104
+ "Description": "the ID of the basic page"
105
+ }
106
+ ]
107
+ }
443
108
  ]
444
- }]
445
- }, {
446
- "name": "Contacts",
447
- "methods": [{
448
- "MethodName": "Index",
449
- "Synopsis": "View a paginated list of a person's contacts",
450
- "HTTPMethod": "GET",
451
- "URI": "/people/:person_id/contacts",
452
- "parameters": [{
453
- "Name": "person_id",
454
- "Required": "Y",
455
- "Default": null,
456
- "Type": "int",
457
- "Description": "the person's ID"
458
- }, {
459
- "Name": "page",
460
- "Required": "N",
461
- "Default": "1",
462
- "Type": "int",
463
- "Description": "result page number"
464
- }, {
465
- "Name": "per_page",
466
- "Required": "N",
467
- "Default": "10",
468
- "Type": "int",
469
- "Description": "number of results to return"
470
- }]
471
- }, {
472
- "MethodName": "Create",
473
- "Synopsis": "Record a contact for a person",
474
- "HTTPMethod": "POST",
475
- "URI": "/people/:person_id/contacts",
476
- "parameters": [{
477
- "Name": "person_id",
478
- "Required": "Y",
479
- "Default": null,
480
- "Type": "int",
481
- "Description": "the person's ID"
482
- }, {
483
- "Name": "body",
484
- "Required": "Y",
485
- "Default": null,
486
- "Type": "json",
487
- "Description": "a JSON representation of the new contact"
488
- }]
489
- }]
490
- }, {
491
- "name": "Contact Types",
492
- "methods": [{
493
- "MethodName": "Index",
494
- "Synopsis": "Returns paginated list of nation-defined contact types",
495
- "HTTPMethod": "GET",
496
- "URI": "/settings/contact_types",
497
- "parameters": [{
498
- "Name": "page",
499
- "Required": "N",
500
- "Default": "1",
501
- "Type": "int",
502
- "Description": "result page number"
503
- }, {
504
- "Name": "per_page",
505
- "Required": "N",
506
- "Default": "10",
507
- "Type": "int",
508
- "Description": "number of results to return"
509
- }]
510
- }, {
511
- "MethodName": "Create",
512
- "Synopsis": "Creates a new contact type",
513
- "HTTPMethod": "POST",
514
- "URI": "/settings/contact_types",
515
- "parameters": [{
516
- "Name": "body",
517
- "Required": "Y",
518
- "Default": null,
519
- "Type": "json",
520
- "Description": "a JSON representation of the new contact type"
521
- }]
522
- }, {
523
- "MethodName": "Update",
524
- "Synopsis": "Updates an existing contact type",
525
- "HTTPMethod": "PUT",
526
- "URI": "/settings/contact_types/:id",
527
- "parameters": [{
528
- "Name": "id",
529
- "Required": "Y",
530
- "Default": null,
531
- "Type": "int",
532
- "Description": "the ID of the existing contact type"
533
- }, {
534
- "Name": "body",
535
- "Required": "Y",
536
- "Default": null,
537
- "Type": "json",
538
- "Description": "a JSON representation of the updates to make"
539
- }]
540
- }, {
541
- "MethodName": "Destroy",
542
- "Synopsis": "Destroys a contact type",
543
- "HTTPMethod": "DELETE",
544
- "URI": "/settings/contact_types/:id",
545
- "parameters": [{
546
- "Name": "id",
547
- "Required": "Y",
548
- "Default": null,
549
- "Type": "int",
550
- "Description": "the ID of the existing contact type"
551
- }]
552
- }, {
553
- "MethodName": "List Methods",
554
- "Synopsis": "Lists all contact methods",
555
- "HTTPMethod": "GET",
556
- "URI": "/settings/contact_methods",
557
- "parameters": [
558
-
109
+ },
110
+ {
111
+ "name": "Blog Posts",
112
+ "methods": [
113
+ {
114
+ "MethodName": "Index",
115
+ "Synopsis": "Shows a list of blog's posts",
116
+ "HTTPMethod": "GET",
117
+ "URI": "/sites/:site_slug/pages/blogs/:id/posts",
118
+ "parameters": [
119
+ {
120
+ "Name": "site_slug",
121
+ "Required": "Y",
122
+ "Default": null,
123
+ "Type": "string",
124
+ "Description": "the site holding the blog"
125
+ },
126
+ {
127
+ "Name": "id",
128
+ "Required": "Y",
129
+ "Default": null,
130
+ "Type": "int",
131
+ "Description": "the ID of the blog"
132
+ },
133
+ {
134
+ "Name": "page",
135
+ "Required": "N",
136
+ "Default": "1",
137
+ "Type": "int",
138
+ "Description": "result page number"
139
+ },
140
+ {
141
+ "Name": "per_page",
142
+ "Required": "N",
143
+ "Default": "10",
144
+ "Type": "int",
145
+ "Description": "number of results to return"
146
+ }
147
+ ]
148
+ },
149
+ {
150
+ "MethodName": "Match",
151
+ "Synopsis": "Find a blog post by its external id",
152
+ "HTTPMethod": "GET",
153
+ "URI": "/sites/:site_slug/pages/blogs/:id/match",
154
+ "parameters": [
155
+ {
156
+ "Name": "site_slug",
157
+ "Required": "Y",
158
+ "Default": null,
159
+ "Type": "string",
160
+ "Description": "the site holding the blog"
161
+ },
162
+ {
163
+ "Name": "id",
164
+ "Required": "Y",
165
+ "Default": null,
166
+ "Type": "int",
167
+ "Description": "the ID of the blog"
168
+ },
169
+ {
170
+ "Name": "external_id",
171
+ "Required": "N",
172
+ "Default": "1",
173
+ "Type": "int",
174
+ "Description": "the external id of the post"
175
+ }
176
+ ]
177
+ },
178
+ {
179
+ "MethodName": "Create",
180
+ "Synopsis": "Creates a new blog post",
181
+ "HTTPMethod": "POST",
182
+ "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts",
183
+ "parameters": [
184
+ {
185
+ "Name": "site_slug",
186
+ "Required": "Y",
187
+ "Default": null,
188
+ "Type": "string",
189
+ "Description": "the site holding the blog"
190
+ },
191
+ {
192
+ "Name": "blog_id",
193
+ "Required": "Y",
194
+ "Default": null,
195
+ "Type": "int",
196
+ "Description": "the ID of the blog"
197
+ },
198
+ {
199
+ "Name": "body",
200
+ "Required": "Y",
201
+ "Default": "1",
202
+ "Type": "json",
203
+ "Description": "a JSON representation of the new post"
204
+ }
205
+ ]
206
+ },
207
+ {
208
+ "MethodName": "Update",
209
+ "Synopsis": "Updates the attributes of a blog post",
210
+ "HTTPMethod": "PUT",
211
+ "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
212
+ "parameters": [
213
+ {
214
+ "Name": "site_slug",
215
+ "Required": "Y",
216
+ "Default": null,
217
+ "Type": "string",
218
+ "Description": "the site holding the blog"
219
+ },
220
+ {
221
+ "Name": "blog_id",
222
+ "Required": "Y",
223
+ "Default": null,
224
+ "Type": "int",
225
+ "Description": "the ID of the blog"
226
+ },
227
+ {
228
+ "Name": "blog_post_id",
229
+ "Required": "Y",
230
+ "Default": null,
231
+ "Type": "int",
232
+ "Description": "the ID of the blog"
233
+ },
234
+ {
235
+ "Name": "body",
236
+ "Required": "Y",
237
+ "Default": "1",
238
+ "Type": "json",
239
+ "Description": "JSON containing updates"
240
+ }
241
+ ]
242
+ },
243
+ {
244
+ "MethodName": "Destroy",
245
+ "Synopsis": "Removes a blog post",
246
+ "HTTPMethod": "DELETE",
247
+ "URI": "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id",
248
+ "parameters": [
249
+ {
250
+ "Name": "site_slug",
251
+ "Required": "Y",
252
+ "Default": null,
253
+ "Type": "string",
254
+ "Description": "the site holding the blog"
255
+ },
256
+ {
257
+ "Name": "blog_id",
258
+ "Required": "Y",
259
+ "Default": null,
260
+ "Type": "int",
261
+ "Description": "the ID of the blog"
262
+ },
263
+ {
264
+ "Name": "blog_post_id",
265
+ "Required": "Y",
266
+ "Default": null,
267
+ "Type": "int",
268
+ "Description": "the ID of the blog"
269
+ }
270
+ ]
271
+ }
272
+ ]
273
+ },
274
+ {
275
+ "name": "Blogs",
276
+ "methods": [
277
+ {
278
+ "MethodName": "Index",
279
+ "Synopsis": "Shows a list of all blogs",
280
+ "HTTPMethod": "GET",
281
+ "URI": "/sites/:site_slug/pages/blogs",
282
+ "parameters": [
283
+ {
284
+ "Name": "site_slug",
285
+ "Required": "Y",
286
+ "Default": null,
287
+ "Type": "string",
288
+ "Description": "the site holding the blog"
289
+ },
290
+ {
291
+ "Name": "page",
292
+ "Required": "N",
293
+ "Default": "1",
294
+ "Type": "int",
295
+ "Description": "result page number"
296
+ },
297
+ {
298
+ "Name": "per_page",
299
+ "Required": "N",
300
+ "Default": "10",
301
+ "Type": "int",
302
+ "Description": "number of results to return"
303
+ }
304
+ ]
305
+ },
306
+ {
307
+ "MethodName": "Show",
308
+ "Synopsis": "Show the details of a blog",
309
+ "HTTPMethod": "GET",
310
+ "URI": "/sites/:site_slug/pages/blogs/:id",
311
+ "parameters": [
312
+ {
313
+ "Name": "site_slug",
314
+ "Required": "Y",
315
+ "Default": null,
316
+ "Type": "string",
317
+ "Description": "the site holding the blog"
318
+ },
319
+ {
320
+ "Name": "id",
321
+ "Required": "Y",
322
+ "Default": null,
323
+ "Type": "int",
324
+ "Description": "the ID of the blog"
325
+ }
326
+ ]
327
+ },
328
+ {
329
+ "MethodName": "Create",
330
+ "Synopsis": "Creates a new blog",
331
+ "HTTPMethod": "POST",
332
+ "URI": "/sites/:site_slug/pages/blogs",
333
+ "parameters": [
334
+ {
335
+ "Name": "site_slug",
336
+ "Required": "Y",
337
+ "Default": null,
338
+ "Type": "string",
339
+ "Description": "the site holding the blog"
340
+ },
341
+ {
342
+ "Name": "body",
343
+ "Required": "Y",
344
+ "Default": "1",
345
+ "Type": "json",
346
+ "Description": "a JSON representation of the new blog"
347
+ }
348
+ ]
349
+ },
350
+ {
351
+ "MethodName": "Update",
352
+ "Synopsis": "Updates the attributes of a blog",
353
+ "HTTPMethod": "PUT",
354
+ "URI": "/sites/:site_slug/pages/blogs/:id",
355
+ "parameters": [
356
+ {
357
+ "Name": "site_slug",
358
+ "Required": "Y",
359
+ "Default": null,
360
+ "Type": "string",
361
+ "Description": "the site holding the blog"
362
+ },
363
+ {
364
+ "Name": "id",
365
+ "Required": "Y",
366
+ "Default": null,
367
+ "Type": "int",
368
+ "Description": "the ID of the blog"
369
+ },
370
+ {
371
+ "Name": "body",
372
+ "Required": "Y",
373
+ "Default": "1",
374
+ "Type": "json",
375
+ "Description": "JSON containing updates"
376
+ }
377
+ ]
378
+ },
379
+ {
380
+ "MethodName": "Destroy",
381
+ "Synopsis": "Removes a blog",
382
+ "HTTPMethod": "DELETE",
383
+ "URI": "/sites/:site_slug/pages/blogs/:id",
384
+ "parameters": [
385
+ {
386
+ "Name": "site_slug",
387
+ "Required": "Y",
388
+ "Default": null,
389
+ "Type": "string",
390
+ "Description": "the site holding the blog"
391
+ },
392
+ {
393
+ "Name": "id",
394
+ "Required": "Y",
395
+ "Default": null,
396
+ "Type": "int",
397
+ "Description": "the ID of the blog"
398
+ }
399
+ ]
400
+ }
559
401
  ]
560
- }, {
561
- "MethodName": "List Statuses",
562
- "Synopsis": "Lists all contact status types",
563
- "HTTPMethod": "GET",
564
- "URI": "/settings/contact_statuses",
565
- "parameters": [
402
+ },
403
+ {
404
+ "name": "Calendars",
405
+ "methods": [
406
+ {
407
+ "MethodName": "Index",
408
+ "Synopsis": "Shows a list of calendars",
409
+ "HTTPMethod": "GET",
410
+ "URI": "/sites/:site_slug/pages/calendars",
411
+ "parameters": [
412
+ {
413
+ "Name": "site_slug",
414
+ "Required": "Y",
415
+ "Default": null,
416
+ "Type": "string",
417
+ "Description": "the site holding the calendars"
418
+ },
419
+ {
420
+ "Name": "page",
421
+ "Required": "N",
422
+ "Default": "1",
423
+ "Type": "int",
424
+ "Description": "result page number"
425
+ },
426
+ {
427
+ "Name": "per_page",
428
+ "Required": "N",
429
+ "Default": "10",
430
+ "Type": "int",
431
+ "Description": "number of results to return"
432
+ }
433
+ ]
434
+ },
435
+ {
436
+ "MethodName": "Show",
437
+ "Synopsis": "Show the details of a calendar",
438
+ "HTTPMethod": "GET",
439
+ "URI": "/sites/:site_slug/pages/calendars/:id",
440
+ "parameters": [
441
+ {
442
+ "Name": "site_slug",
443
+ "Required": "Y",
444
+ "Default": null,
445
+ "Type": "string",
446
+ "Description": "the site holding the calendar"
447
+ },
448
+ {
449
+ "Name": "id",
450
+ "Required": "Y",
451
+ "Default": null,
452
+ "Type": "int",
453
+ "Description": "the ID of the calendar"
454
+ }
455
+ ]
456
+ },
457
+ {
458
+ "MethodName": "Create",
459
+ "Synopsis": "Creates a new calendar",
460
+ "HTTPMethod": "POST",
461
+ "URI": "/sites/:site_slug/pages/calendars",
462
+ "parameters": [
463
+ {
464
+ "Name": "site_slug",
465
+ "Required": "Y",
466
+ "Default": null,
467
+ "Type": "string",
468
+ "Description": "the site holding the calendar"
469
+ },
470
+ {
471
+ "Name": "body",
472
+ "Required": "Y",
473
+ "Default": "1",
474
+ "Type": "json",
475
+ "Description": "a JSON representation of the new calendar"
476
+ }
477
+ ]
478
+ },
479
+ {
480
+ "MethodName": "Update",
481
+ "Synopsis": "Updates the attributes of a calendar",
482
+ "HTTPMethod": "PUT",
483
+ "URI": "/sites/:site_slug/pages/calendars/:id",
484
+ "parameters": [
485
+ {
486
+ "Name": "site_slug",
487
+ "Required": "Y",
488
+ "Default": null,
489
+ "Type": "string",
490
+ "Description": "the site holding the calendar"
491
+ },
492
+ {
493
+ "Name": "id",
494
+ "Required": "Y",
495
+ "Default": null,
496
+ "Type": "int",
497
+ "Description": "the ID of the calendar"
498
+ },
499
+ {
500
+ "Name": "body",
501
+ "Required": "Y",
502
+ "Default": "1",
503
+ "Type": "json",
504
+ "Description": "JSON containing updates"
505
+ }
506
+ ]
507
+ },
508
+ {
509
+ "MethodName": "Destroy",
510
+ "Synopsis": "Removes a calendar",
511
+ "HTTPMethod": "DELETE",
512
+ "URI": "/sites/:site_slug/pages/calendars/:id",
513
+ "parameters": [
514
+ {
515
+ "Name": "site_slug",
516
+ "Required": "Y",
517
+ "Default": null,
518
+ "Type": "string",
519
+ "Description": "the site holding the calendar"
520
+ },
521
+ {
522
+ "Name": "id",
523
+ "Required": "Y",
524
+ "Default": null,
525
+ "Type": "int",
526
+ "Description": "the ID of the calendar"
527
+ }
528
+ ]
529
+ }
530
+ ]
531
+ },
532
+ {
533
+ "name": "Campaign Data",
534
+ "methods": [
535
+ {
536
+ "MethodName": "Show",
537
+ "Synopsis": "Shows campaign metadata about the nation",
538
+ "HTTPMethod": "GET",
539
+ "URI": "/campaign_data",
540
+ "parameters": [
566
541
 
542
+ ]
543
+ }
544
+ ]
545
+ },
546
+ {
547
+ "name": "Contacts",
548
+ "methods": [
549
+ {
550
+ "MethodName": "Index",
551
+ "Synopsis": "View a paginated list of a person's contacts",
552
+ "HTTPMethod": "GET",
553
+ "URI": "/people/:person_id/contacts",
554
+ "parameters": [
555
+ {
556
+ "Name": "person_id",
557
+ "Required": "Y",
558
+ "Default": null,
559
+ "Type": "int",
560
+ "Description": "the person's ID"
561
+ },
562
+ {
563
+ "Name": "page",
564
+ "Required": "N",
565
+ "Default": "1",
566
+ "Type": "int",
567
+ "Description": "result page number"
568
+ },
569
+ {
570
+ "Name": "per_page",
571
+ "Required": "N",
572
+ "Default": "10",
573
+ "Type": "int",
574
+ "Description": "number of results to return"
575
+ }
576
+ ]
577
+ },
578
+ {
579
+ "MethodName": "Create",
580
+ "Synopsis": "Record a contact for a person",
581
+ "HTTPMethod": "POST",
582
+ "URI": "/people/:person_id/contacts",
583
+ "parameters": [
584
+ {
585
+ "Name": "person_id",
586
+ "Required": "Y",
587
+ "Default": null,
588
+ "Type": "int",
589
+ "Description": "the person's ID"
590
+ },
591
+ {
592
+ "Name": "body",
593
+ "Required": "Y",
594
+ "Default": null,
595
+ "Type": "json",
596
+ "Description": "a JSON representation of the new contact"
597
+ }
598
+ ]
599
+ }
567
600
  ]
568
- }]
569
- }, {
570
- "name": "Donations",
571
- "methods": [{
572
- "MethodName": "Index",
573
- "Synopsis": "Returns a list of donations",
574
- "HTTPMethod": "GET",
575
- "URI": "/donations",
576
- "parameters": [{
577
- "Name": "page",
578
- "Required": "N",
579
- "Default": "1",
580
- "Type": "int",
581
- "Description": "result page number"
582
- }, {
583
- "Name": "per_page",
584
- "Required": "N",
585
- "Default": "10",
586
- "Type": "int",
587
- "Description": "number of results to return"
588
- }]
589
- }, {
590
- "MethodName": "Create",
591
- "Synopsis": "Creates a donation with the provided data",
592
- "HTTPMethod": "POST",
593
- "URI": "/donations",
594
- "parameters": [{
595
- "Name": "body",
596
- "Required": "Y",
597
- "Default": "{}",
598
- "Type": "json",
599
- "Description": "JSON representation of a donation"
600
- }]
601
- }, {
602
- "MethodName": "Update",
603
- "Synopsis": "Updates a donation with the provided data",
604
- "HTTPMethod": "PUT",
605
- "URI": "/donations/:id",
606
- "parameters": [{
607
- "Name": "id",
608
- "Required": "Y",
609
- "Default": null,
610
- "Type": "int",
611
- "Description": "The donation's ID"
612
- }, {
613
- "Name": "body",
614
- "Required": "Y",
615
- "Default": "{}",
616
- "Type": "json",
617
- "Description": "JSON attributes for updating the donation"
618
- }]
619
- }, {
620
- "MethodName": "Destroy",
621
- "Synopsis": "Removes the donation with the matching ID",
622
- "HTTPMethod": "DELETE",
623
- "URI": "/donations/:id",
624
- "parameters": [{
625
- "Name": "id",
626
- "Required": "Y",
627
- "Default": null,
628
- "Type": "int",
629
- "Description": "The donation's ID"
630
- }]
631
- }]
632
- }, {
633
- "name": "Events",
634
- "methods": [{
635
- "MethodName": "Index",
636
- "Synopsis": "Returns a list of events",
637
- "HTTPMethod": "GET",
638
- "URI": "/sites/:site_slug/pages/events",
639
- "parameters": [{
640
- "Name": "site_slug",
641
- "Required": "Y",
642
- "Default": null,
643
- "Type": "string",
644
- "Description": "the site holding the event"
645
- }, {
646
- "Name": "page",
647
- "Required": "N",
648
- "Default": "1",
649
- "Type": "int",
650
- "Description": "result page number"
651
- }, {
652
- "Name": "per_page",
653
- "Required": "N",
654
- "Default": "10",
655
- "Type": "int",
656
- "Description": "number of results to return"
657
- }, {
658
- "Name": "tags",
659
- "Required": "N",
660
- "Default": null,
661
- "Type": "string",
662
- "Description": "tags that must be present on the event"
663
- }, {
664
- "Name": "starting",
665
- "Required": "N",
666
- "Default": null,
667
- "Type": "string",
668
- "Description": "earliest starting time"
669
- }, {
670
- "Name": "until",
671
- "Required": "N",
672
- "Default": null,
673
- "Type": "string",
674
- "Description": "latest ending time"
675
- }, {
676
- "Name": "calendar_id",
677
- "Required": "N",
678
- "Default": null,
679
- "Type": "int",
680
- "Description": "the ID of the calendar from which events should be scoped"
681
- }]
682
- }, {
683
- "MethodName": "Show",
684
- "Synopsis": "Returns an event",
685
- "HTTPMethod": "GET",
686
- "URI": "/sites/:site_slug/pages/events/:id",
687
- "parameters": [{
688
- "Name": "site_slug",
689
- "Required": "Y",
690
- "Default": null,
691
- "Type": "string",
692
- "Description": "the site holding the event"
693
- }, {
694
- "Name": "id",
695
- "Required": "Y",
696
- "Default": null,
697
- "Type": "int",
698
- "Description": "the ID of the event"
699
- }]
700
- }, {
701
- "MethodName": "Create",
702
- "Synopsis": "Creates a event with the provided data",
703
- "HTTPMethod": "POST",
704
- "URI": "/sites/:site_slug/pages/events",
705
- "parameters": [{
706
- "Name": "site_slug",
707
- "Required": "Y",
708
- "Default": null,
709
- "Type": "string",
710
- "Description": "the site holding the event"
711
- }, {
712
- "Name": "body",
713
- "Required": "Y",
714
- "Default": "{}",
715
- "Type": "json",
716
- "Description": "JSON representation of a event"
717
- }]
718
- }, {
719
- "MethodName": "Update",
720
- "Synopsis": "Updates a event with the provided data",
721
- "HTTPMethod": "PUT",
722
- "URI": "/sites/:site_slug/pages/events/:id",
723
- "parameters": [{
724
- "Name": "site_slug",
725
- "Required": "Y",
726
- "Default": null,
727
- "Type": "string",
728
- "Description": "the site holding the event"
729
- }, {
730
- "Name": "id",
731
- "Required": "Y",
732
- "Default": null,
733
- "Type": "int",
734
- "Description": "The event's ID"
735
- }, {
736
- "Name": "body",
737
- "Required": "Y",
738
- "Default": "{}",
739
- "Type": "json",
740
- "Description": "JSON attributes for updating the event"
741
- }]
742
- }, {
743
- "MethodName": "Destroy",
744
- "Synopsis": "Removes the event with the matching ID",
745
- "HTTPMethod": "DELETE",
746
- "URI": "/sites/:site_slug/pages/events/:id",
747
- "parameters": [{
748
- "Name": "site_slug",
749
- "Required": "Y",
750
- "Default": null,
751
- "Type": "string",
752
- "Description": "the site holding the event"
753
- }, {
754
- "Name": "id",
755
- "Required": "Y",
756
- "Default": null,
757
- "Type": "int",
758
- "Description": "The event's ID"
759
- }]
760
- }, {
761
- "MethodName": "RSVPs",
762
- "Synopsis": "Lists all RSVPs for an event",
763
- "HTTPMethod": "GET",
764
- "URI": "/sites/:site_slug/pages/events/:id/rsvps",
765
- "parameters": [{
766
- "Name": "site_slug",
767
- "Required": "Y",
768
- "Default": null,
769
- "Type": "string",
770
- "Description": "the site holding the event"
771
- }, {
772
- "Name": "id",
773
- "Required": "Y",
774
- "Default": null,
775
- "Type": "int",
776
- "Description": "The event's ID"
777
- }, {
778
- "Name": "page",
779
- "Required": "N",
780
- "Default": "1",
781
- "Type": "int",
782
- "Description": "result page number"
783
- }, {
784
- "Name": "per_page",
785
- "Required": "N",
786
- "Default": "10",
787
- "Type": "int",
788
- "Description": "number of results to return"
789
- }]
790
- }, {
791
- "MethodName": "RSVP Create",
792
- "Synopsis": "Creates an RSVP for an event",
793
- "HTTPMethod": "POST",
794
- "URI": "/sites/:site_slug/pages/events/:id/rsvps",
795
- "parameters": [{
796
- "Name": "site_slug",
797
- "Required": "Y",
798
- "Default": null,
799
- "Type": "string",
800
- "Description": "the site holding the event"
801
- }, {
802
- "Name": "id",
803
- "Required": "Y",
804
- "Default": null,
805
- "Type": "int",
806
- "Description": "The event's ID"
807
- }, {
808
- "Name": "body",
809
- "Required": "Y",
810
- "Default": null,
811
- "Type": "json",
812
- "Description": "A JSON representation of the new post"
813
- }]
814
- }, {
815
- "MethodName": "RSVP Update",
816
- "Synopsis": "Updates an existing RSVP",
817
- "HTTPMethod": "PUT",
818
- "URI": "/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id",
819
- "parameters": [{
820
- "Name": "site_slug",
821
- "Required": "Y",
822
- "Default": null,
823
- "Type": "string",
824
- "Description": "the site holding the event"
825
- }, {
826
- "Name": "event_id",
827
- "Required": "Y",
828
- "Default": null,
829
- "Type": "int",
830
- "Description": "The event's ID"
831
- }, {
832
- "Name": "rsvp_id",
833
- "Required": "Y",
834
- "Default": null,
835
- "Type": "int",
836
- "Description": "The RSVP's ID"
837
- }, {
838
- "Name": "body",
839
- "Required": "Y",
840
- "Default": null,
841
- "Type": "json",
842
- "Description": "JSON attributes for updating the RSVP"
843
- }]
844
- }]
845
- }, {
846
- "name": "Imports",
847
- "methods": [{
848
- "MethodName": "Show",
849
- "Synopsis": "Shows the status of an import",
850
- "HTTPMethod": "GET",
851
- "URI": "/imports/:id",
852
- "parameters": [{
853
- "Name": "id",
854
- "Required": "Y",
855
- "Default": null,
856
- "Type": "int",
857
- "Description": "the ID of the import"
858
- }]
859
- }, {
860
- "MethodName": "Create",
861
- "Synopsis": "Creates a import with the provided data",
862
- "HTTPMethod": "POST",
863
- "URI": "/imports",
864
- "parameters": [{
865
- "Name": "body",
866
- "Required": "Y",
867
- "Default": null,
868
- "Type": "json",
869
- "Description": "JSON representation of the import"
870
- }]
871
- }, {
872
- "MethodName": "Result",
873
- "Synopsis": "Gets the import results and error csv file.",
874
- "HTTPMethod": "GET",
875
- "URI": "/imports/:id/result",
876
- "parameters": [{
877
- "Name": "id",
878
- "Required": "Y",
879
- "Default": null,
880
- "Type": "int",
881
- "Description": "the ID of the import"
882
- }]
883
- }]
884
- }, {
885
- "name": "Exports",
886
- "methods": [{
887
- "MethodName": "Create List",
888
- "Synopsis": "Creates a list export with the provided data",
889
- "HTTPMethod": "POST",
890
- "URI": "/list/:list_id/exports",
891
- "parameters": [{
892
- "Name": "body",
893
- "Required": "Y",
894
- "Default": null,
895
- "Type": "json",
896
- "Description": "JSON representation of the export"
897
- }]
898
- }, {
899
- "MethodName": "Show",
900
- "Synopsis": "Shows the status of a list export.",
901
- "HTTPMethod": "GET",
902
- "URI": "/exports/:id",
903
- "parameters": [{
904
- "Name": "id",
905
- "Required": "Y",
906
- "Default": null,
907
- "Type": "int",
908
- "Description": "the ID of the export"
909
- }]
910
- }, {
911
- "MethodName": "Delete",
912
- "Synopsis": "Delete the export",
913
- "HTTPMethod": "DELETE",
914
- "URI": "/exports/:id",
915
- "parameters": [{
916
- "Name": "id",
917
- "Required": "Y",
918
- "Default": null,
919
- "Type": "int",
920
- "Description": "the ID of the export"
921
- }]
922
- }]
923
- }, {
924
- "name": "Lists",
925
- "methods": [{
926
- "MethodName": "Index",
927
- "Synopsis": "Returns a list of created custom lists",
928
- "HTTPMethod": "GET",
929
- "URI": "/lists",
930
- "parameters": [{
931
- "Name": "page",
932
- "Required": "N",
933
- "Default": "1",
934
- "Type": "int",
935
- "Description": "result page number"
936
- }, {
937
- "Name": "per_page",
938
- "Required": "N",
939
- "Default": "10",
940
- "Type": "int",
941
- "Description": "number of results to return"
942
- }]
943
- }, {
944
- "MethodName": "People",
945
- "Synopsis": "Returns people stored in a list",
946
- "HTTPMethod": "GET",
947
- "URI": "/lists/:id/people",
948
- "parameters": [{
949
- "Name": "id",
950
- "Required": "Y",
951
- "Default": null,
952
- "Type": "int",
953
- "Description": "The list's ID"
954
- }, {
955
- "Name": "page",
956
- "Required": "N",
957
- "Default": "1",
958
- "Type": "int",
959
- "Description": "result page number"
960
- }, {
961
- "Name": "per_page",
962
- "Required": "N",
963
- "Default": "10",
964
- "Type": "int",
965
- "Description": "number of results to return"
966
- }]
967
- }, {
968
- "MethodName": "Create",
969
- "Synopsis": "Creates a list with the provided data",
970
- "HTTPMethod": "POST",
971
- "URI": "/lists",
972
- "parameters": [{
973
- "Name": "body",
974
- "Required": "Y",
975
- "Default": "{}",
976
- "Type": "json",
977
- "Description": "JSON representation of the list to create"
978
- }]
979
- }, {
980
- "MethodName": "Update",
981
- "Synopsis": "Updates a list with the provided data",
982
- "HTTPMethod": "PUT",
983
- "URI": "/lists/:id",
984
- "parameters": [{
985
- "Name": "id",
986
- "Required": "Y",
987
- "Default": null,
988
- "Type": "int",
989
- "Description": "The list's ID"
990
- }, {
991
- "Name": "body",
992
- "Required": "Y",
993
- "Default": "{}",
994
- "Type": "json",
995
- "Description": "JSON attributes for updating the list"
996
- }]
997
- }, {
998
- "MethodName": "Destroy",
999
- "Synopsis": "Removes the list with the matching ID",
1000
- "HTTPMethod": "DELETE",
1001
- "URI": "/lists/:id",
1002
- "parameters": [{
1003
- "Name": "id",
1004
- "Required": "Y",
1005
- "Default": null,
1006
- "Type": "int",
1007
- "Description": "The list's ID"
1008
- }]
1009
- }, {
1010
- "MethodName": "Add people",
1011
- "Synopsis": "Adds people to a list",
1012
- "HTTPMethod": "POST",
1013
- "URI": "/lists/:list_id/people",
1014
- "parameters": [{
1015
- "Name": "list_id",
1016
- "Required": "Y",
1017
- "Default": null,
1018
- "Type": "int",
1019
- "Description": "The ID of the list"
1020
- }, {
1021
- "Name": "body",
1022
- "Required": "Y",
1023
- "Default": null,
1024
- "Type": "json",
1025
- "Description": "A JSON hash containing the people to add to the list"
1026
- }]
1027
- }, {
1028
- "MethodName": "Destroy people",
1029
- "Synopsis": "Removes people from a list",
1030
- "HTTPMethod": "DELETE",
1031
- "URI": "/lists/:list_id/people",
1032
- "parameters": [{
1033
- "Name": "list_id",
1034
- "Required": "Y",
1035
- "Default": null,
1036
- "Type": "int",
1037
- "Description": "The ID of the list"
1038
- }, {
1039
- "Name": "body",
1040
- "Required": "Y",
1041
- "Default": null,
1042
- "Type": "json",
1043
- "Description": "A JSON hash containing the people to remove from the list"
1044
- }]
1045
- }, {
1046
- "MethodName": "Listing Create (deprecated)",
1047
- "Synopsis": "Adds a person to a list",
1048
- "HTTPMethod": "POST",
1049
- "URI": "/lists/:list_id/listings",
1050
- "parameters": [{
1051
- "Name": "list_id",
1052
- "Required": "Y",
1053
- "Default": null,
1054
- "Type": "int",
1055
- "Description": "The ID of the list"
1056
- }, {
1057
- "Name": "person_id",
1058
- "Required": "Y",
1059
- "Default": null,
1060
- "Type": "int",
1061
- "Description": "The ID of the person to add to the list"
1062
- }]
1063
- }, {
1064
- "MethodName": "Listing Deletion (deprecated)",
1065
- "Synopsis": "Drops a person from a list",
1066
- "HTTPMethod": "DELETE",
1067
- "URI": "/lists/:list_id/listings/:person_id",
1068
- "parameters": [{
1069
- "Name": "list_id",
1070
- "Required": "Y",
1071
- "Default": null,
1072
- "Type": "int",
1073
- "Description": "The ID of the list"
1074
- }, {
1075
- "Name": "person_id",
1076
- "Required": "Y",
1077
- "Default": null,
1078
- "Type": "int",
1079
- "Description": "The ID of the person to drop from the list"
1080
- }]
1081
- }, {
1082
- "MethodName": "Add tag",
1083
- "Synopsis": "Adds a tag to all of the list members",
1084
- "HTTPMethod": "POST",
1085
- "URI": "/lists/:list_id/tag/:tag",
1086
- "parameters": [{
1087
- "Name": "list_id",
1088
- "Required": "Y",
1089
- "Default": null,
1090
- "Type": "int",
1091
- "Description": "The ID of the list"
1092
- }, {
1093
- "Name": "tag",
1094
- "Required": "Y",
1095
- "Default": null,
1096
- "Type": "string",
1097
- "Description": "The name of the tag to use"
1098
- }]
1099
- }, {
1100
- "MethodName": "Delete tag",
1101
- "Synopsis": "Deletes the tag from all of the list members",
1102
- "HTTPMethod": "DELETE",
1103
- "URI": "/lists/:list_id/tag/:tag",
1104
- "parameters": [{
1105
- "Name": "list_id",
1106
- "Required": "Y",
1107
- "Default": null,
1108
- "Type": "int",
1109
- "Description": "The ID of the list"
1110
- }, {
1111
- "Name": "tag",
1112
- "Required": "Y",
1113
- "Default": null,
1114
- "Type": "string",
1115
- "Description": "The name of the tag to use"
1116
- }]
1117
- }]
1118
- }, {
1119
- "name": "Memberships",
1120
- "methods": [{
1121
- "MethodName": "Index",
1122
- "Synopsis": "Lists all memberships for a person",
1123
- "HTTPMethod": "GET",
1124
- "URI": "/people/:person_id/memberships",
1125
- "parameters": [{
1126
- "Name": "person_id",
1127
- "Required": "Y",
1128
- "Default": null,
1129
- "Type": "int",
1130
- "Description": "The person's ID"
1131
- }, {
1132
- "Name": "page",
1133
- "Required": "N",
1134
- "Default": "1",
1135
- "Type": "int",
1136
- "Description": "Which page to return"
1137
- }, {
1138
- "Name": "per_page",
1139
- "Required": "N",
1140
- "Default": "10",
1141
- "Type": "int",
1142
- "Description": "The number of listings to return per page"
1143
- }]
1144
- }, {
1145
- "MethodName": "Create",
1146
- "Synopsis": "Creates a membership",
1147
- "HTTPMethod": "POST",
1148
- "URI": "/people/:person_id/memberships",
1149
- "parameters": [{
1150
- "Name": "person_id",
1151
- "Required": "Y",
1152
- "Default": null,
1153
- "Type": "int",
1154
- "Description": "The person's ID"
1155
- }, {
1156
- "Name": "body",
1157
- "Required": "Y",
1158
- "Default": "{}",
1159
- "Type": "json",
1160
- "Description": "JSON attributes for the new membership"
1161
- }]
1162
- }, {
1163
- "MethodName": "Update",
1164
- "Synopsis": "Updates a membership",
1165
- "HTTPMethod": "PUT",
1166
- "URI": "/people/:person_id/memberships",
1167
- "parameters": [{
1168
- "Name": "person_id",
1169
- "Required": "Y",
1170
- "Default": null,
1171
- "Type": "int",
1172
- "Description": "The person's ID"
1173
- }, {
1174
- "Name": "body",
1175
- "Required": "Y",
1176
- "Default": "{}",
1177
- "Type": "json",
1178
- "Description": "JSON attributes for updating a membership"
1179
- }]
1180
- }, {
1181
- "MethodName": "Destroy",
1182
- "Synopsis": "Removes a membership from the person",
1183
- "HTTPMethod": "DELETE",
1184
- "URI": "/people/:person_id/memberships/:name",
1185
- "parameters": [{
1186
- "Name": "person_id",
1187
- "Required": "Y",
1188
- "Default": null,
1189
- "Type": "int",
1190
- "Description": "The person's ID"
1191
- }, {
1192
- "Name": "name",
1193
- "Required": "Y",
1194
- "Default": null,
1195
- "Type": "string",
1196
- "Description": "The name of the membership"
1197
- }]
1198
- }]
1199
- }, {
1200
- "name": "Page Attachments",
1201
- "methods": [{
1202
- "MethodName": "Index",
1203
- "Synopsis": "Returns a list of a page's file attachments",
1204
- "HTTPMethod": "GET",
1205
- "URI": "/sites/:site_slug/pages/:page_slug/attachments",
1206
- "parameters": [{
1207
- "Name": "site_slug",
1208
- "Required": "Y",
1209
- "Default": null,
1210
- "Type": "string",
1211
- "Description": "The slug of the site the page lives on"
1212
- }, {
1213
- "Name": "page_slug",
1214
- "Required": "Y",
1215
- "Default": "1",
1216
- "Type": "string",
1217
- "Description": "The page's slug"
1218
- }, {
1219
- "Name": "page",
1220
- "Required": "N",
1221
- "Default": "1",
1222
- "Type": "int",
1223
- "Description": "result page number"
1224
- }, {
1225
- "Name": "per_page",
1226
- "Required": "N",
1227
- "Default": "10",
1228
- "Type": "int",
1229
- "Description": "number of results to return"
1230
- }]
1231
- }, {
1232
- "MethodName": "Show",
1233
- "Synopsis": "Creates a new file attachment for a page",
1234
- "HTTPMethod": "GET",
1235
- "URI": "/sites/:site_slug/pages/:page_slug/attachments/:id",
1236
- "parameters": [{
1237
- "Name": "site_slug",
1238
- "Required": "Y",
1239
- "Default": null,
1240
- "Type": "string",
1241
- "Description": "The slug of the site the page lives on"
1242
- }, {
1243
- "Name": "page_slug",
1244
- "Required": "Y",
1245
- "Default": "1",
1246
- "Type": "string",
1247
- "Description": "The page's slug"
1248
- }, {
1249
- "Name": "id",
1250
- "Required": "Y",
1251
- "Default": null,
1252
- "Type": "int",
1253
- "Description": "The ID of the page attachment"
1254
- }]
1255
- }, {
1256
- "MethodName": "Create",
1257
- "Synopsis": "Creates a new file attachment for a page",
1258
- "HTTPMethod": "POST",
1259
- "URI": "/sites/:site_slug/pages/:page_slug/attachments",
1260
- "parameters": [{
1261
- "Name": "site_slug",
1262
- "Required": "Y",
1263
- "Default": null,
1264
- "Type": "string",
1265
- "Description": "The slug of the site the page lives on"
1266
- }, {
1267
- "Name": "page_slug",
1268
- "Required": "Y",
1269
- "Default": "1",
1270
- "Type": "string",
1271
- "Description": "The page's slug"
1272
- }, {
1273
- "Name": "body",
1274
- "Required": "Y",
1275
- "Default": "{}",
1276
- "Type": "json",
1277
- "Description": "A JSON representation of the attachment"
1278
- }]
1279
- }, {
1280
- "MethodName": "Destroy",
1281
- "Synopsis": "Destroys a file attachment for a page",
1282
- "HTTPMethod": "DELETE",
1283
- "URI": "/sites/:site_slug/pages/:page_slug/attachments/:id",
1284
- "parameters": [{
1285
- "Name": "site_slug",
1286
- "Required": "Y",
1287
- "Default": null,
1288
- "Type": "string",
1289
- "Description": "The slug of the site the page lives on"
1290
- }, {
1291
- "Name": "page_slug",
1292
- "Required": "Y",
1293
- "Default": "1",
1294
- "Type": "string",
1295
- "Description": "The page's slug"
1296
- }, {
1297
- "Name": "id",
1298
- "Required": "Y",
1299
- "Default": null,
1300
- "Type": "int",
1301
- "Description": "The ID of the page attachment"
1302
- }]
1303
- }]
1304
- }, {
1305
- "name": "People",
1306
- "methods": [{
1307
- "MethodName": "Index",
1308
- "Synopsis": "Returns a list of people",
1309
- "HTTPMethod": "GET",
1310
- "URI": "/people",
1311
- "parameters": [{
1312
- "Name": "page",
1313
- "Required": "N",
1314
- "Default": "1",
1315
- "Type": "int",
1316
- "Description": "result page number"
1317
- }, {
1318
- "Name": "per_page",
1319
- "Required": "N",
1320
- "Default": "10",
1321
- "Type": "int",
1322
- "Description": "number of results to return"
1323
- }]
1324
- }, {
1325
- "MethodName": "Show",
1326
- "Synopsis": "Returns a full representation of the person",
1327
- "HTTPMethod": "GET",
1328
- "URI": "/people/:id",
1329
- "parameters": [{
1330
- "Name": "id",
1331
- "Required": "Y",
1332
- "Default": "1",
1333
- "Type": "int",
1334
- "Description": "the person's id"
1335
- }]
1336
- }, {
1337
- "MethodName": "Match",
1338
- "Synopsis": "Finds people that match certain attributes exactly",
1339
- "HTTPMethod": "GET",
1340
- "URI": "/people/match",
1341
- "parameters": [{
1342
- "Name": "email",
1343
- "Required": "N",
1344
- "Default": null,
1345
- "Type": "string",
1346
- "Description": null
1347
- }, {
1348
- "Name": "first_name",
1349
- "Required": "N",
1350
- "Default": null,
1351
- "Type": "string",
1352
- "Description": null
1353
- }, {
1354
- "Name": "last_name",
1355
- "Required": "N",
1356
- "Default": null,
1357
- "Type": "string",
1358
- "Description": null
1359
- }, {
1360
- "Name": "phone",
1361
- "Required": "N",
1362
- "Default": null,
1363
- "Type": "string",
1364
- "Description": null
1365
- }, {
1366
- "Name": "mobile",
1367
- "Required": "N",
1368
- "Default": null,
1369
- "Type": "string",
1370
- "Description": null
1371
- }]
1372
- }, {
1373
- "MethodName": "Search",
1374
- "Synopsis": "Search for people using non-unique traits",
1375
- "HTTPMethod": "GET",
1376
- "URI": "/people/search",
1377
- "parameters": [{
1378
- "Name": "first_name",
1379
- "Required": "N",
1380
- "Default": null,
1381
- "Type": "string",
1382
- "Description": null
1383
- }, {
1384
- "Name": "last_name",
1385
- "Required": "N",
1386
- "Default": null,
1387
- "Type": "string",
1388
- "Description": null
1389
- }, {
1390
- "Name": "city",
1391
- "Required": "N",
1392
- "Default": null,
1393
- "Type": "string",
1394
- "Description": null
1395
- }, {
1396
- "Name": "state",
1397
- "Required": "N",
1398
- "Default": null,
1399
- "Type": "string",
1400
- "Description": null
1401
- }, {
1402
- "Name": "sex",
1403
- "Required": "N",
1404
- "Default": null,
1405
- "Type": "string",
1406
- "Description": null
1407
- }, {
1408
- "Name": "birthdate",
1409
- "Required": "N",
1410
- "Default": null,
1411
- "Type": "string",
1412
- "Description": null
1413
- }, {
1414
- "Name": "updated_since",
1415
- "Required": "N",
1416
- "Default": null,
1417
- "Type": "string",
1418
- "Description": null
1419
- }, {
1420
- "Name": "with_mobile",
1421
- "Required": "N",
1422
- "Default": null,
1423
- "Type": "string",
1424
- "Description": null
1425
- }, {
1426
- "Name": "custom_values",
1427
- "Required": "N",
1428
- "Default": null,
1429
- "Type": "string",
1430
- "Description": null
1431
- }, {
1432
- "Name": "civicrm_id",
1433
- "Required": "N",
1434
- "Default": null,
1435
- "Type": "string",
1436
- "Description": null
1437
- }, {
1438
- "Name": "county_file_id",
1439
- "Required": "N",
1440
- "Default": null,
1441
- "Type": "string",
1442
- "Description": null
1443
- }, {
1444
- "Name": "datatrust_id",
1445
- "Required": "N",
1446
- "Default": null,
1447
- "Type": "string",
1448
- "Description": null
1449
- }, {
1450
- "Name": "dw_id",
1451
- "Required": "N",
1452
- "Default": null,
1453
- "Type": "string",
1454
- "Description": null
1455
- }, {
1456
- "Name": "external_id",
1457
- "Required": "N",
1458
- "Default": null,
1459
- "Type": "string",
1460
- "Description": null
1461
- }, {
1462
- "Name": "media_market_id",
1463
- "Required": "N",
1464
- "Default": null,
1465
- "Type": "string",
1466
- "Description": null
1467
- }, {
1468
- "Name": "membership_level_id",
1469
- "Required": "N",
1470
- "Default": null,
1471
- "Type": "string",
1472
- "Description": null
1473
- }, {
1474
- "Name": "ngp_id",
1475
- "Required": "N",
1476
- "Default": null,
1477
- "Type": "string",
1478
- "Description": null
1479
- }, {
1480
- "Name": "pf_strat_id",
1481
- "Required": "N",
1482
- "Default": null,
1483
- "Type": "string",
1484
- "Description": null
1485
- }, {
1486
- "Name": "rnc_id",
1487
- "Required": "N",
1488
- "Default": null,
1489
- "Type": "string",
1490
- "Description": null
1491
- }, {
1492
- "Name": "rnc_regid",
1493
- "Required": "N",
1494
- "Default": null,
1495
- "Type": "string",
1496
- "Description": null
1497
- }, {
1498
- "Name": "salesforce_id",
1499
- "Required": "N",
1500
- "Default": null,
1501
- "Type": "string",
1502
- "Description": null
1503
- }, {
1504
- "Name": "state_file_id",
1505
- "Required": "N",
1506
- "Default": null,
1507
- "Type": "string",
1508
- "Description": null
1509
- }, {
1510
- "Name": "van_id",
1511
- "Required": "N",
1512
- "Default": null,
1513
- "Type": "string",
1514
- "Description": null
1515
- }, {
1516
- "Name": "page",
1517
- "Required": "N",
1518
- "Default": "1",
1519
- "Type": "int",
1520
- "Description": null
1521
- }, {
1522
- "Name": "per_page",
1523
- "Required": "N",
1524
- "Default": "100",
1525
- "Type": "int",
1526
- "Description": null
1527
- }]
1528
- }, {
1529
- "MethodName": "Nearby",
1530
- "Synopsis": "Searches for people near a location defined by latitude and longitude",
1531
- "HTTPMethod": "GET",
1532
- "URI": "/people/nearby",
1533
- "parameters": [{
1534
- "Name": "location",
1535
- "Required": "Y",
1536
- "Default": "34.049031,-118.251399",
1537
- "Type": "string",
1538
- "Description": "origin of search in the format \"latitude,longitude\""
1539
- }, {
1540
- "Name": "distance",
1541
- "Required": "N",
1542
- "Default": "1",
1543
- "Type": "int",
1544
- "Description": "radius in miles for which to include results"
1545
- }, {
1546
- "Name": "page",
1547
- "Required": "N",
1548
- "Default": "1",
1549
- "Type": "int",
1550
- "Description": "page number"
1551
- }, {
1552
- "Name": "per_page",
1553
- "Required": "N",
1554
- "Default": "10",
1555
- "Type": "int",
1556
- "Description": "number of results to show per page"
1557
- }]
1558
- }, {
1559
- "MethodName": "Me",
1560
- "Synopsis": "Returns the access token's resource owner's representation",
1561
- "HTTPMethod": "GET",
1562
- "URI": "/people/me",
1563
- "parameters": [
601
+ },
602
+ {
603
+ "name": "Contact Types",
604
+ "methods": [
605
+ {
606
+ "MethodName": "Index",
607
+ "Synopsis": "Returns paginated list of nation-defined contact types",
608
+ "HTTPMethod": "GET",
609
+ "URI": "/settings/contact_types",
610
+ "parameters": [
611
+ {
612
+ "Name": "page",
613
+ "Required": "N",
614
+ "Default": "1",
615
+ "Type": "int",
616
+ "Description": "result page number"
617
+ },
618
+ {
619
+ "Name": "per_page",
620
+ "Required": "N",
621
+ "Default": "10",
622
+ "Type": "int",
623
+ "Description": "number of results to return"
624
+ }
625
+ ]
626
+ },
627
+ {
628
+ "MethodName": "Create",
629
+ "Synopsis": "Creates a new contact type",
630
+ "HTTPMethod": "POST",
631
+ "URI": "/settings/contact_types",
632
+ "parameters": [
633
+ {
634
+ "Name": "body",
635
+ "Required": "Y",
636
+ "Default": null,
637
+ "Type": "json",
638
+ "Description": "a JSON representation of the new contact type"
639
+ }
640
+ ]
641
+ },
642
+ {
643
+ "MethodName": "Update",
644
+ "Synopsis": "Updates an existing contact type",
645
+ "HTTPMethod": "PUT",
646
+ "URI": "/settings/contact_types/:id",
647
+ "parameters": [
648
+ {
649
+ "Name": "id",
650
+ "Required": "Y",
651
+ "Default": null,
652
+ "Type": "int",
653
+ "Description": "the ID of the existing contact type"
654
+ },
655
+ {
656
+ "Name": "body",
657
+ "Required": "Y",
658
+ "Default": null,
659
+ "Type": "json",
660
+ "Description": "a JSON representation of the updates to make"
661
+ }
662
+ ]
663
+ },
664
+ {
665
+ "MethodName": "Destroy",
666
+ "Synopsis": "Destroys a contact type",
667
+ "HTTPMethod": "DELETE",
668
+ "URI": "/settings/contact_types/:id",
669
+ "parameters": [
670
+ {
671
+ "Name": "id",
672
+ "Required": "Y",
673
+ "Default": null,
674
+ "Type": "int",
675
+ "Description": "the ID of the existing contact type"
676
+ }
677
+ ]
678
+ },
679
+ {
680
+ "MethodName": "List Methods",
681
+ "Synopsis": "Lists all contact methods",
682
+ "HTTPMethod": "GET",
683
+ "URI": "/settings/contact_methods",
684
+ "parameters": [
1564
685
 
686
+ ]
687
+ },
688
+ {
689
+ "MethodName": "List Statuses",
690
+ "Synopsis": "Lists all contact status types",
691
+ "HTTPMethod": "GET",
692
+ "URI": "/settings/contact_statuses",
693
+ "parameters": [
694
+
695
+ ]
696
+ }
697
+ ]
698
+ },
699
+ {
700
+ "name": "Donations",
701
+ "methods": [
702
+ {
703
+ "MethodName": "Index",
704
+ "Synopsis": "Returns a list of donations",
705
+ "HTTPMethod": "GET",
706
+ "URI": "/donations",
707
+ "parameters": [
708
+ {
709
+ "Name": "page",
710
+ "Required": "N",
711
+ "Default": "1",
712
+ "Type": "int",
713
+ "Description": "result page number"
714
+ },
715
+ {
716
+ "Name": "per_page",
717
+ "Required": "N",
718
+ "Default": "10",
719
+ "Type": "int",
720
+ "Description": "number of results to return"
721
+ }
722
+ ]
723
+ },
724
+ {
725
+ "MethodName": "Create",
726
+ "Synopsis": "Creates a donation with the provided data",
727
+ "HTTPMethod": "POST",
728
+ "URI": "/donations",
729
+ "parameters": [
730
+ {
731
+ "Name": "body",
732
+ "Required": "Y",
733
+ "Default": "{}",
734
+ "Type": "json",
735
+ "Description": "JSON representation of a donation"
736
+ }
737
+ ]
738
+ },
739
+ {
740
+ "MethodName": "Update",
741
+ "Synopsis": "Updates a donation with the provided data",
742
+ "HTTPMethod": "PUT",
743
+ "URI": "/donations/:id",
744
+ "parameters": [
745
+ {
746
+ "Name": "id",
747
+ "Required": "Y",
748
+ "Default": null,
749
+ "Type": "int",
750
+ "Description": "The donation's ID"
751
+ },
752
+ {
753
+ "Name": "body",
754
+ "Required": "Y",
755
+ "Default": "{}",
756
+ "Type": "json",
757
+ "Description": "JSON attributes for updating the donation"
758
+ }
759
+ ]
760
+ },
761
+ {
762
+ "MethodName": "Destroy",
763
+ "Synopsis": "Removes the donation with the matching ID",
764
+ "HTTPMethod": "DELETE",
765
+ "URI": "/donations/:id",
766
+ "parameters": [
767
+ {
768
+ "Name": "id",
769
+ "Required": "Y",
770
+ "Default": null,
771
+ "Type": "int",
772
+ "Description": "The donation's ID"
773
+ }
774
+ ]
775
+ }
776
+ ]
777
+ },
778
+ {
779
+ "name": "Events",
780
+ "methods": [
781
+ {
782
+ "MethodName": "Index",
783
+ "Synopsis": "Returns a list of events",
784
+ "HTTPMethod": "GET",
785
+ "URI": "/sites/:site_slug/pages/events",
786
+ "parameters": [
787
+ {
788
+ "Name": "site_slug",
789
+ "Required": "Y",
790
+ "Default": null,
791
+ "Type": "string",
792
+ "Description": "the site holding the event"
793
+ },
794
+ {
795
+ "Name": "page",
796
+ "Required": "N",
797
+ "Default": "1",
798
+ "Type": "int",
799
+ "Description": "result page number"
800
+ },
801
+ {
802
+ "Name": "per_page",
803
+ "Required": "N",
804
+ "Default": "10",
805
+ "Type": "int",
806
+ "Description": "number of results to return"
807
+ },
808
+ {
809
+ "Name": "tags",
810
+ "Required": "N",
811
+ "Default": null,
812
+ "Type": "string",
813
+ "Description": "tags that must be present on the event"
814
+ },
815
+ {
816
+ "Name": "starting",
817
+ "Required": "N",
818
+ "Default": null,
819
+ "Type": "string",
820
+ "Description": "earliest starting time"
821
+ },
822
+ {
823
+ "Name": "until",
824
+ "Required": "N",
825
+ "Default": null,
826
+ "Type": "string",
827
+ "Description": "latest ending time"
828
+ },
829
+ {
830
+ "Name": "calendar_id",
831
+ "Required": "N",
832
+ "Default": null,
833
+ "Type": "int",
834
+ "Description": "the ID of the calendar from which events should be scoped"
835
+ }
836
+ ]
837
+ },
838
+ {
839
+ "MethodName": "Show",
840
+ "Synopsis": "Returns an event",
841
+ "HTTPMethod": "GET",
842
+ "URI": "/sites/:site_slug/pages/events/:id",
843
+ "parameters": [
844
+ {
845
+ "Name": "site_slug",
846
+ "Required": "Y",
847
+ "Default": null,
848
+ "Type": "string",
849
+ "Description": "the site holding the event"
850
+ },
851
+ {
852
+ "Name": "id",
853
+ "Required": "Y",
854
+ "Default": null,
855
+ "Type": "int",
856
+ "Description": "the ID of the event"
857
+ }
858
+ ]
859
+ },
860
+ {
861
+ "MethodName": "Create",
862
+ "Synopsis": "Creates a event with the provided data",
863
+ "HTTPMethod": "POST",
864
+ "URI": "/sites/:site_slug/pages/events",
865
+ "parameters": [
866
+ {
867
+ "Name": "site_slug",
868
+ "Required": "Y",
869
+ "Default": null,
870
+ "Type": "string",
871
+ "Description": "the site holding the event"
872
+ },
873
+ {
874
+ "Name": "body",
875
+ "Required": "Y",
876
+ "Default": "{}",
877
+ "Type": "json",
878
+ "Description": "JSON representation of a event"
879
+ }
880
+ ]
881
+ },
882
+ {
883
+ "MethodName": "Update",
884
+ "Synopsis": "Updates a event with the provided data",
885
+ "HTTPMethod": "PUT",
886
+ "URI": "/sites/:site_slug/pages/events/:id",
887
+ "parameters": [
888
+ {
889
+ "Name": "site_slug",
890
+ "Required": "Y",
891
+ "Default": null,
892
+ "Type": "string",
893
+ "Description": "the site holding the event"
894
+ },
895
+ {
896
+ "Name": "id",
897
+ "Required": "Y",
898
+ "Default": null,
899
+ "Type": "int",
900
+ "Description": "The event's ID"
901
+ },
902
+ {
903
+ "Name": "body",
904
+ "Required": "Y",
905
+ "Default": "{}",
906
+ "Type": "json",
907
+ "Description": "JSON attributes for updating the event"
908
+ }
909
+ ]
910
+ },
911
+ {
912
+ "MethodName": "Destroy",
913
+ "Synopsis": "Removes the event with the matching ID",
914
+ "HTTPMethod": "DELETE",
915
+ "URI": "/sites/:site_slug/pages/events/:id",
916
+ "parameters": [
917
+ {
918
+ "Name": "site_slug",
919
+ "Required": "Y",
920
+ "Default": null,
921
+ "Type": "string",
922
+ "Description": "the site holding the event"
923
+ },
924
+ {
925
+ "Name": "id",
926
+ "Required": "Y",
927
+ "Default": null,
928
+ "Type": "int",
929
+ "Description": "The event's ID"
930
+ }
931
+ ]
932
+ },
933
+ {
934
+ "MethodName": "RSVPs",
935
+ "Synopsis": "Lists all RSVPs for an event",
936
+ "HTTPMethod": "GET",
937
+ "URI": "/sites/:site_slug/pages/events/:id/rsvps",
938
+ "parameters": [
939
+ {
940
+ "Name": "site_slug",
941
+ "Required": "Y",
942
+ "Default": null,
943
+ "Type": "string",
944
+ "Description": "the site holding the event"
945
+ },
946
+ {
947
+ "Name": "id",
948
+ "Required": "Y",
949
+ "Default": null,
950
+ "Type": "int",
951
+ "Description": "The event's ID"
952
+ },
953
+ {
954
+ "Name": "page",
955
+ "Required": "N",
956
+ "Default": "1",
957
+ "Type": "int",
958
+ "Description": "result page number"
959
+ },
960
+ {
961
+ "Name": "per_page",
962
+ "Required": "N",
963
+ "Default": "10",
964
+ "Type": "int",
965
+ "Description": "number of results to return"
966
+ }
967
+ ]
968
+ },
969
+ {
970
+ "MethodName": "RSVP Create",
971
+ "Synopsis": "Creates an RSVP for an event",
972
+ "HTTPMethod": "POST",
973
+ "URI": "/sites/:site_slug/pages/events/:id/rsvps",
974
+ "parameters": [
975
+ {
976
+ "Name": "site_slug",
977
+ "Required": "Y",
978
+ "Default": null,
979
+ "Type": "string",
980
+ "Description": "the site holding the event"
981
+ },
982
+ {
983
+ "Name": "id",
984
+ "Required": "Y",
985
+ "Default": null,
986
+ "Type": "int",
987
+ "Description": "The event's ID"
988
+ },
989
+ {
990
+ "Name": "body",
991
+ "Required": "Y",
992
+ "Default": null,
993
+ "Type": "json",
994
+ "Description": "A JSON representation of the new post"
995
+ }
996
+ ]
997
+ },
998
+ {
999
+ "MethodName": "RSVP Update",
1000
+ "Synopsis": "Updates an existing RSVP",
1001
+ "HTTPMethod": "PUT",
1002
+ "URI": "/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id",
1003
+ "parameters": [
1004
+ {
1005
+ "Name": "site_slug",
1006
+ "Required": "Y",
1007
+ "Default": null,
1008
+ "Type": "string",
1009
+ "Description": "the site holding the event"
1010
+ },
1011
+ {
1012
+ "Name": "event_id",
1013
+ "Required": "Y",
1014
+ "Default": null,
1015
+ "Type": "int",
1016
+ "Description": "The event's ID"
1017
+ },
1018
+ {
1019
+ "Name": "rsvp_id",
1020
+ "Required": "Y",
1021
+ "Default": null,
1022
+ "Type": "int",
1023
+ "Description": "The RSVP's ID"
1024
+ },
1025
+ {
1026
+ "Name": "body",
1027
+ "Required": "Y",
1028
+ "Default": null,
1029
+ "Type": "json",
1030
+ "Description": "JSON attributes for updating the RSVP"
1031
+ }
1032
+ ]
1033
+ }
1034
+ ]
1035
+ },
1036
+ {
1037
+ "name": "Imports",
1038
+ "methods": [
1039
+ {
1040
+ "MethodName": "Show",
1041
+ "Synopsis": "Shows the status of an import",
1042
+ "HTTPMethod": "GET",
1043
+ "URI": "/imports/:id",
1044
+ "parameters": [
1045
+ {
1046
+ "Name": "id",
1047
+ "Required": "Y",
1048
+ "Default": null,
1049
+ "Type": "int",
1050
+ "Description": "the ID of the import"
1051
+ }
1052
+ ]
1053
+ },
1054
+ {
1055
+ "MethodName": "Create",
1056
+ "Synopsis": "Creates a import with the provided data",
1057
+ "HTTPMethod": "POST",
1058
+ "URI": "/imports",
1059
+ "parameters": [
1060
+ {
1061
+ "Name": "body",
1062
+ "Required": "Y",
1063
+ "Default": null,
1064
+ "Type": "json",
1065
+ "Description": "JSON representation of the import"
1066
+ }
1067
+ ]
1068
+ },
1069
+ {
1070
+ "MethodName": "Result",
1071
+ "Synopsis": "Gets the import results and error csv file.",
1072
+ "HTTPMethod": "GET",
1073
+ "URI": "/imports/:id/result",
1074
+ "parameters": [
1075
+ {
1076
+ "Name": "id",
1077
+ "Required": "Y",
1078
+ "Default": null,
1079
+ "Type": "int",
1080
+ "Description": "the ID of the import"
1081
+ }
1082
+ ]
1083
+ }
1565
1084
  ]
1566
- }, {
1567
- "MethodName": "Register",
1568
- "Synopsis": "Starts user registration person for the given person",
1569
- "HTTPMethod": "GET",
1570
- "URI": "/people/:id/register",
1571
- "parameters": [{
1572
- "Name": "id",
1573
- "Required": "Y",
1574
- "Default": null,
1575
- "Type": "int",
1576
- "Description": "The person's ID"
1577
- }]
1578
- }, {
1579
- "MethodName": "Taggings",
1580
- "Synopsis": "Returns all taggings for a given person",
1581
- "HTTPMethod": "GET",
1582
- "URI": "/people/:id/taggings",
1583
- "parameters": [{
1584
- "Name": "id",
1585
- "Required": "Y",
1586
- "Default": null,
1587
- "Type": "int",
1588
- "Description": "the ID of the person"
1589
- }]
1590
- }, {
1591
- "MethodName": "Tag Person",
1592
- "Synopsis": "Tags a person",
1593
- "HTTPMethod": "PUT",
1594
- "URI": "/people/:id/taggings",
1595
- "parameters": [{
1596
- "Name": "id",
1597
- "Required": "Y",
1598
- "Default": null,
1599
- "Type": "int",
1600
- "Description": "the ID of the person"
1601
- }, {
1602
- "Name": "body",
1603
- "Required": "Y",
1604
- "Default": null,
1605
- "Type": "json",
1606
- "Description": "JSON with tagging information"
1607
- }]
1608
- }, {
1609
- "MethodName": "Tag Removal",
1610
- "Synopsis": "Removes a tag from a person",
1611
- "HTTPMethod": "DELETE",
1612
- "URI": "/people/:id/taggings/:tag",
1613
- "parameters": [{
1614
- "Name": "id",
1615
- "Required": "Y",
1616
- "Default": null,
1617
- "Type": "int",
1618
- "Description": "the ID of the person"
1619
- }, {
1620
- "Name": "tag",
1621
- "Required": "Y",
1622
- "Default": null,
1623
- "Type": "string",
1624
- "Description": "the name of the tag"
1625
- }]
1626
- }, {
1627
- "MethodName": "Political Capital",
1628
- "Synopsis": "Returns a paginated list of a person's capitals",
1629
- "HTTPMethod": "GET",
1630
- "URI": "/people/:id/capitals",
1631
- "parameters": [{
1632
- "Name": "id",
1633
- "Required": "Y",
1634
- "Default": null,
1635
- "Type": "int",
1636
- "Description": "the ID of the person"
1637
- }, {
1638
- "Name": "page",
1639
- "Required": "N",
1640
- "Default": "1",
1641
- "Type": "int",
1642
- "Description": "page number"
1643
- }, {
1644
- "Name": "per_page",
1645
- "Required": "N",
1646
- "Default": "10",
1647
- "Type": "int",
1648
- "Description": "number of results to show per page"
1649
- }]
1650
- }, {
1651
- "MethodName": "Political Capital Create",
1652
- "Synopsis": "Creates capital for the given person",
1653
- "HTTPMethod": "POST",
1654
- "URI": "/people/:id/capitals",
1655
- "parameters": [{
1656
- "Name": "id",
1657
- "Required": "Y",
1658
- "Default": null,
1659
- "Type": "int",
1660
- "Description": "the ID of the person"
1661
- }, {
1662
- "Name": "body",
1663
- "Required": "Y",
1664
- "Default": null,
1665
- "Type": "json",
1666
- "Description": "JSON representation of the capital to create"
1667
- }]
1668
- }, {
1669
- "MethodName": "Political Capital Destroy",
1670
- "Synopsis": "Destroys capital for a person",
1671
- "HTTPMethod": "DELETE",
1672
- "URI": "/people/:person_id/capitals/:capital_id",
1673
- "parameters": [{
1674
- "Name": "person_id",
1675
- "Required": "Y",
1676
- "Default": null,
1677
- "Type": "int",
1678
- "Description": "the ID of the person"
1679
- }, {
1680
- "Name": "capital_id",
1681
- "Required": "Y",
1682
- "Default": null,
1683
- "Type": "int",
1684
- "Description": "the ID of the capital to destroy"
1685
- }]
1686
- }, {
1687
- "MethodName": "Create",
1688
- "Synopsis": "Creates a person with the provided data",
1689
- "HTTPMethod": "POST",
1690
- "URI": "/people",
1691
- "parameters": [{
1692
- "Name": "body",
1693
- "Required": "Y",
1694
- "Default": "{}",
1695
- "Type": "json",
1696
- "Description": "JSON representation of the person to create"
1697
- }]
1698
- }, {
1699
- "MethodName": "Update",
1700
- "Synopsis": "Updates a person with the provided data",
1701
- "HTTPMethod": "PUT",
1702
- "URI": "/people/:id",
1703
- "parameters": [{
1704
- "Name": "id",
1705
- "Required": "Y",
1706
- "Default": null,
1707
- "Type": "int",
1708
- "Description": "The person's ID"
1709
- }, {
1710
- "Name": "body",
1711
- "Required": "Y",
1712
- "Default": "{}",
1713
- "Type": "json",
1714
- "Description": "JSON attributes for updating the person"
1715
- }]
1716
- }, {
1717
- "MethodName": "Push",
1718
- "Synopsis": "Updates a matched person or creates a new one if the person doesn't exist",
1719
- "HTTPMethod": "PUT",
1720
- "URI": "/people/push",
1721
- "parameters": [{
1722
- "Name": "body",
1723
- "Required": "Y",
1724
- "Default": "{}",
1725
- "Type": "json",
1726
- "Description": "JSON attributes for updating/matching the person"
1727
- }]
1728
- }, {
1729
- "MethodName": "Destroy",
1730
- "Synopsis": "Removes the person with the matching ID",
1731
- "HTTPMethod": "DELETE",
1732
- "URI": "/people/:id",
1733
- "parameters": [{
1734
- "Name": "id",
1735
- "Required": "Y",
1736
- "Default": null,
1737
- "Type": "int",
1738
- "Description": "The person's ID"
1739
- }]
1740
- }]
1741
- }, {
1742
- "name": "People Tags",
1743
- "methods": [{
1744
- "MethodName": "Index",
1745
- "Synopsis": "Returns a list of previously used tags",
1746
- "HTTPMethod": "GET",
1747
- "URI": "/tags",
1748
- "parameters": [{
1749
- "Name": "page",
1750
- "Required": "N",
1751
- "Default": "1",
1752
- "Type": "int",
1753
- "Description": "result page number"
1754
- }, {
1755
- "Name": "per_page",
1756
- "Required": "N",
1757
- "Default": "10",
1758
- "Type": "int",
1759
- "Description": "number of results to return"
1760
- }]
1761
- }, {
1762
- "MethodName": "People",
1763
- "Synopsis": "Searches for people with the given tag",
1764
- "HTTPMethod": "GET",
1765
- "URI": "/tags/:tag/people",
1766
- "parameters": [{
1767
- "Name": "tag",
1768
- "Required": "Y",
1769
- "Default": null,
1770
- "Type": "string",
1771
- "Description": "the name of the tag"
1772
- }, {
1773
- "Name": "page",
1774
- "Required": "N",
1775
- "Default": "1",
1776
- "Type": "int",
1777
- "Description": "result page number"
1778
- }, {
1779
- "Name": "per_page",
1780
- "Required": "N",
1781
- "Default": "10",
1782
- "Type": "int",
1783
- "Description": "number of results to return"
1784
- }]
1785
- }]
1786
- }, {
1787
- "name": "Sites",
1788
- "methods": [{
1789
- "MethodName": "Index",
1790
- "Synopsis": "Returns a list of all sites",
1791
- "HTTPMethod": "GET",
1792
- "URI": "/sites",
1793
- "parameters": [{
1794
- "Name": "page",
1795
- "Required": "N",
1796
- "Default": "1",
1797
- "Type": "int",
1798
- "Description": "result page number"
1799
- }, {
1800
- "Name": "per_page",
1801
- "Required": "N",
1802
- "Default": "10",
1803
- "Type": "int",
1804
- "Description": "number of results to return"
1805
- }]
1806
- }]
1807
- }, {
1808
- "name": "Survey Responses",
1809
- "methods": [{
1810
- "MethodName": "Index",
1811
- "Synopsis": "Lists all survey responses",
1812
- "HTTPMethod": "GET",
1813
- "URI": "/survey_responses",
1814
- "parameters": [{
1815
- "Name": "start_time",
1816
- "Required": "N",
1817
- "Default": null,
1818
- "Type": "string",
1819
- "Description": "the starting time for results"
1820
- }, {
1821
- "Name": "end_time",
1822
- "Required": "N",
1823
- "Default": null,
1824
- "Type": "string",
1825
- "Description": "the ending time for results"
1826
- }, {
1827
- "Name": "survey_id",
1828
- "Required": "N",
1829
- "Default": null,
1830
- "Type": "int",
1831
- "Description": "the id for a parent survey"
1832
- }, {
1833
- "Name": "page",
1834
- "Required": "N",
1835
- "Default": "1",
1836
- "Type": "int",
1837
- "Description": "result page number"
1838
- }, {
1839
- "Name": "per_page",
1840
- "Required": "N",
1841
- "Default": "10",
1842
- "Type": "int",
1843
- "Description": "number of results to return"
1844
- }]
1845
- }, {
1846
- "MethodName": "Create",
1847
- "Synopsis": "Creates responses for a survey",
1848
- "HTTPMethod": "POST",
1849
- "URI": "/survey_responses",
1850
- "parameters": [{
1851
- "Name": "body",
1852
- "Required": "Y",
1853
- "Default": null,
1854
- "Type": "json",
1855
- "Description": "a JSON representation of the survey responses"
1856
- }]
1857
- }]
1858
- }, {
1859
- "name": "Surveys",
1860
- "methods": [{
1861
- "MethodName": "Index",
1862
- "Synopsis": "Shows a list of all surveys for the a site",
1863
- "HTTPMethod": "GET",
1864
- "URI": "/sites/:site_slug/pages/surveys",
1865
- "parameters": [{
1866
- "Name": "site_slug",
1867
- "Required": "Y",
1868
- "Default": null,
1869
- "Type": "string",
1870
- "Description": "the site holding the survey"
1871
- }, {
1872
- "Name": "page",
1873
- "Required": "N",
1874
- "Default": "1",
1875
- "Type": "int",
1876
- "Description": "result page number"
1877
- }, {
1878
- "Name": "per_page",
1879
- "Required": "N",
1880
- "Default": "10",
1881
- "Type": "int",
1882
- "Description": "number of results to return"
1883
- }]
1884
- }, {
1885
- "MethodName": "Create",
1886
- "Synopsis": "Creates a survey for a site",
1887
- "HTTPMethod": "POST",
1888
- "URI": "/sites/:site_slug/pages/surveys",
1889
- "parameters": [{
1890
- "Name": "site_slug",
1891
- "Required": "Y",
1892
- "Default": null,
1893
- "Type": "string",
1894
- "Description": "the site holding the survey"
1895
- }, {
1896
- "Name": "body",
1897
- "Required": "Y",
1898
- "Default": null,
1899
- "Type": "json",
1900
- "Description": "a JSON representation of the new survey"
1901
- }]
1902
- }, {
1903
- "MethodName": "Update",
1904
- "Synopsis": "Updates the attributes of a survey",
1905
- "HTTPMethod": "PUT",
1906
- "URI": "/sites/:site_slug/pages/surveys/:id",
1907
- "parameters": [{
1908
- "Name": "site_slug",
1909
- "Required": "Y",
1910
- "Default": null,
1911
- "Type": "string",
1912
- "Description": "the site holding the survey"
1913
- }, {
1914
- "Name": "id",
1915
- "Required": "Y",
1916
- "Default": null,
1917
- "Type": "int",
1918
- "Description": "the ID of the survey"
1919
- }, {
1920
- "Name": "body",
1921
- "Required": "Y",
1922
- "Default": null,
1923
- "Type": "json",
1924
- "Description": "JSON containing updates"
1925
- }]
1926
- }, {
1927
- "MethodName": "Destroy",
1928
- "Synopsis": "Removes a survey",
1929
- "HTTPMethod": "DELETE",
1930
- "URI": "/sites/:site_slug/pages/surveys/:id",
1931
- "parameters": [{
1932
- "Name": "site_slug",
1933
- "Required": "Y",
1934
- "Default": null,
1935
- "Type": "string",
1936
- "Description": "the site holding the survey"
1937
- }, {
1938
- "Name": "id",
1939
- "Required": "Y",
1940
- "Default": null,
1941
- "Type": "int",
1942
- "Description": "the ID of the survey"
1943
- }]
1944
- }]
1945
- }, {
1946
- "name": "Webhooks",
1947
- "methods": [{
1948
- "MethodName": "Index",
1949
- "Synopsis": "Lists all webhooks",
1950
- "HTTPMethod": "GET",
1951
- "URI": "/webhooks",
1952
- "parameters": [{
1953
- "Name": "page",
1954
- "Required": "N",
1955
- "Default": "1",
1956
- "Type": "int",
1957
- "Description": "result page number"
1958
- }, {
1959
- "Name": "per_page",
1960
- "Required": "N",
1961
- "Default": "10",
1962
- "Type": "int",
1963
- "Description": "number of results to return"
1964
- }]
1965
- }, {
1966
- "MethodName": "Show",
1967
- "Synopsis": "Shows the details of an individual webhook",
1968
- "HTTPMethod": "GET",
1969
- "URI": "/webhooks/:id",
1970
- "parameters": [{
1971
- "Name": "id",
1972
- "Required": "Y",
1973
- "Default": null,
1974
- "Type": "string",
1975
- "Description": "the ID of the webhook to display"
1976
- }]
1977
- }, {
1978
- "MethodName": "Create",
1979
- "Synopsis": "Creates a new webhook",
1980
- "HTTPMethod": "POST",
1981
- "URI": "/webhooks",
1982
- "parameters": [{
1983
- "Name": "body",
1984
- "Required": "Y",
1985
- "Default": null,
1986
- "Type": "json",
1987
- "Description": "a JSON representation of the new webhook"
1988
- }]
1989
- }, {
1990
- "MethodName": "Destroy",
1991
- "Synopsis": "Destroys a webhook",
1992
- "HTTPMethod": "DELETE",
1993
- "URI": "/webhooks/:id",
1994
- "parameters": [
1085
+ },
1086
+ {
1087
+ "name": "Exports",
1088
+ "methods": [
1089
+ {
1090
+ "MethodName": "Create List",
1091
+ "Synopsis": "Creates a list export with the provided data",
1092
+ "HTTPMethod": "POST",
1093
+ "URI": "/list/:list_id/exports",
1094
+ "parameters": [
1095
+ {
1096
+ "Name": "body",
1097
+ "Required": "Y",
1098
+ "Default": null,
1099
+ "Type": "json",
1100
+ "Description": "JSON representation of the export"
1101
+ }
1102
+ ]
1103
+ },
1104
+ {
1105
+ "MethodName": "Show",
1106
+ "Synopsis": "Shows the status of a list export.",
1107
+ "HTTPMethod": "GET",
1108
+ "URI": "/exports/:id",
1109
+ "parameters": [
1110
+ {
1111
+ "Name": "id",
1112
+ "Required": "Y",
1113
+ "Default": null,
1114
+ "Type": "int",
1115
+ "Description": "the ID of the export"
1116
+ }
1117
+ ]
1118
+ },
1119
+ {
1120
+ "MethodName": "Delete",
1121
+ "Synopsis": "Delete the export",
1122
+ "HTTPMethod": "DELETE",
1123
+ "URI": "/exports/:id",
1124
+ "parameters": [
1125
+ {
1126
+ "Name": "id",
1127
+ "Required": "Y",
1128
+ "Default": null,
1129
+ "Type": "int",
1130
+ "Description": "the ID of the export"
1131
+ }
1132
+ ]
1133
+ }
1134
+ ]
1135
+ },
1136
+ {
1137
+ "name": "Lists",
1138
+ "methods": [
1139
+ {
1140
+ "MethodName": "Index",
1141
+ "Synopsis": "Returns a list of created custom lists",
1142
+ "HTTPMethod": "GET",
1143
+ "URI": "/lists",
1144
+ "parameters": [
1145
+ {
1146
+ "Name": "page",
1147
+ "Required": "N",
1148
+ "Default": "1",
1149
+ "Type": "int",
1150
+ "Description": "result page number"
1151
+ },
1152
+ {
1153
+ "Name": "per_page",
1154
+ "Required": "N",
1155
+ "Default": "10",
1156
+ "Type": "int",
1157
+ "Description": "number of results to return"
1158
+ }
1159
+ ]
1160
+ },
1161
+ {
1162
+ "MethodName": "People",
1163
+ "Synopsis": "Returns people stored in a list",
1164
+ "HTTPMethod": "GET",
1165
+ "URI": "/lists/:id/people",
1166
+ "parameters": [
1167
+ {
1168
+ "Name": "id",
1169
+ "Required": "Y",
1170
+ "Default": null,
1171
+ "Type": "int",
1172
+ "Description": "The list's ID"
1173
+ },
1174
+ {
1175
+ "Name": "page",
1176
+ "Required": "N",
1177
+ "Default": "1",
1178
+ "Type": "int",
1179
+ "Description": "result page number"
1180
+ },
1181
+ {
1182
+ "Name": "per_page",
1183
+ "Required": "N",
1184
+ "Default": "10",
1185
+ "Type": "int",
1186
+ "Description": "number of results to return"
1187
+ }
1188
+ ]
1189
+ },
1190
+ {
1191
+ "MethodName": "Create",
1192
+ "Synopsis": "Creates a list with the provided data",
1193
+ "HTTPMethod": "POST",
1194
+ "URI": "/lists",
1195
+ "parameters": [
1196
+ {
1197
+ "Name": "body",
1198
+ "Required": "Y",
1199
+ "Default": "{}",
1200
+ "Type": "json",
1201
+ "Description": "JSON representation of the list to create"
1202
+ }
1203
+ ]
1204
+ },
1205
+ {
1206
+ "MethodName": "Update",
1207
+ "Synopsis": "Updates a list with the provided data",
1208
+ "HTTPMethod": "PUT",
1209
+ "URI": "/lists/:id",
1210
+ "parameters": [
1211
+ {
1212
+ "Name": "id",
1213
+ "Required": "Y",
1214
+ "Default": null,
1215
+ "Type": "int",
1216
+ "Description": "The list's ID"
1217
+ },
1218
+ {
1219
+ "Name": "body",
1220
+ "Required": "Y",
1221
+ "Default": "{}",
1222
+ "Type": "json",
1223
+ "Description": "JSON attributes for updating the list"
1224
+ }
1225
+ ]
1226
+ },
1227
+ {
1228
+ "MethodName": "Destroy",
1229
+ "Synopsis": "Removes the list with the matching ID",
1230
+ "HTTPMethod": "DELETE",
1231
+ "URI": "/lists/:id",
1232
+ "parameters": [
1233
+ {
1234
+ "Name": "id",
1235
+ "Required": "Y",
1236
+ "Default": null,
1237
+ "Type": "int",
1238
+ "Description": "The list's ID"
1239
+ }
1240
+ ]
1241
+ },
1242
+ {
1243
+ "MethodName": "Add people",
1244
+ "Synopsis": "Adds people to a list",
1245
+ "HTTPMethod": "POST",
1246
+ "URI": "/lists/:list_id/people",
1247
+ "parameters": [
1248
+ {
1249
+ "Name": "list_id",
1250
+ "Required": "Y",
1251
+ "Default": null,
1252
+ "Type": "int",
1253
+ "Description": "The ID of the list"
1254
+ },
1255
+ {
1256
+ "Name": "body",
1257
+ "Required": "Y",
1258
+ "Default": null,
1259
+ "Type": "json",
1260
+ "Description": "A JSON hash containing the people to add to the list"
1261
+ }
1262
+ ]
1263
+ },
1264
+ {
1265
+ "MethodName": "Destroy people",
1266
+ "Synopsis": "Removes people from a list",
1267
+ "HTTPMethod": "DELETE",
1268
+ "URI": "/lists/:list_id/people",
1269
+ "parameters": [
1270
+ {
1271
+ "Name": "list_id",
1272
+ "Required": "Y",
1273
+ "Default": null,
1274
+ "Type": "int",
1275
+ "Description": "The ID of the list"
1276
+ },
1277
+ {
1278
+ "Name": "body",
1279
+ "Required": "Y",
1280
+ "Default": null,
1281
+ "Type": "json",
1282
+ "Description": "A JSON hash containing the people to remove from the list"
1283
+ }
1284
+ ]
1285
+ },
1286
+ {
1287
+ "MethodName": "Listing Create (deprecated)",
1288
+ "Synopsis": "Adds a person to a list",
1289
+ "HTTPMethod": "POST",
1290
+ "URI": "/lists/:list_id/listings",
1291
+ "parameters": [
1292
+ {
1293
+ "Name": "list_id",
1294
+ "Required": "Y",
1295
+ "Default": null,
1296
+ "Type": "int",
1297
+ "Description": "The ID of the list"
1298
+ },
1299
+ {
1300
+ "Name": "person_id",
1301
+ "Required": "Y",
1302
+ "Default": null,
1303
+ "Type": "int",
1304
+ "Description": "The ID of the person to add to the list"
1305
+ }
1306
+ ]
1307
+ },
1308
+ {
1309
+ "MethodName": "Listing Deletion (deprecated)",
1310
+ "Synopsis": "Drops a person from a list",
1311
+ "HTTPMethod": "DELETE",
1312
+ "URI": "/lists/:list_id/listings/:person_id",
1313
+ "parameters": [
1314
+ {
1315
+ "Name": "list_id",
1316
+ "Required": "Y",
1317
+ "Default": null,
1318
+ "Type": "int",
1319
+ "Description": "The ID of the list"
1320
+ },
1321
+ {
1322
+ "Name": "person_id",
1323
+ "Required": "Y",
1324
+ "Default": null,
1325
+ "Type": "int",
1326
+ "Description": "The ID of the person to drop from the list"
1327
+ }
1328
+ ]
1329
+ },
1330
+ {
1331
+ "MethodName": "Add tag",
1332
+ "Synopsis": "Adds a tag to all of the list members",
1333
+ "HTTPMethod": "POST",
1334
+ "URI": "/lists/:list_id/tag/:tag",
1335
+ "parameters": [
1336
+ {
1337
+ "Name": "list_id",
1338
+ "Required": "Y",
1339
+ "Default": null,
1340
+ "Type": "int",
1341
+ "Description": "The ID of the list"
1342
+ },
1343
+ {
1344
+ "Name": "tag",
1345
+ "Required": "Y",
1346
+ "Default": null,
1347
+ "Type": "string",
1348
+ "Description": "The name of the tag to use"
1349
+ }
1350
+ ]
1351
+ },
1352
+ {
1353
+ "MethodName": "Delete tag",
1354
+ "Synopsis": "Deletes the tag from all of the list members",
1355
+ "HTTPMethod": "DELETE",
1356
+ "URI": "/lists/:list_id/tag/:tag",
1357
+ "parameters": [
1358
+ {
1359
+ "Name": "list_id",
1360
+ "Required": "Y",
1361
+ "Default": null,
1362
+ "Type": "int",
1363
+ "Description": "The ID of the list"
1364
+ },
1365
+ {
1366
+ "Name": "tag",
1367
+ "Required": "Y",
1368
+ "Default": null,
1369
+ "Type": "string",
1370
+ "Description": "The name of the tag to use"
1371
+ }
1372
+ ]
1373
+ }
1374
+ ]
1375
+ },
1376
+ {
1377
+ "name": "Memberships",
1378
+ "methods": [
1379
+ {
1380
+ "MethodName": "Index",
1381
+ "Synopsis": "Lists all memberships for a person",
1382
+ "HTTPMethod": "GET",
1383
+ "URI": "/people/:person_id/memberships",
1384
+ "parameters": [
1385
+ {
1386
+ "Name": "person_id",
1387
+ "Required": "Y",
1388
+ "Default": null,
1389
+ "Type": "int",
1390
+ "Description": "The person's ID"
1391
+ },
1392
+ {
1393
+ "Name": "page",
1394
+ "Required": "N",
1395
+ "Default": "1",
1396
+ "Type": "int",
1397
+ "Description": "Which page to return"
1398
+ },
1399
+ {
1400
+ "Name": "per_page",
1401
+ "Required": "N",
1402
+ "Default": "10",
1403
+ "Type": "int",
1404
+ "Description": "The number of listings to return per page"
1405
+ }
1406
+ ]
1407
+ },
1408
+ {
1409
+ "MethodName": "Create",
1410
+ "Synopsis": "Creates a membership",
1411
+ "HTTPMethod": "POST",
1412
+ "URI": "/people/:person_id/memberships",
1413
+ "parameters": [
1414
+ {
1415
+ "Name": "person_id",
1416
+ "Required": "Y",
1417
+ "Default": null,
1418
+ "Type": "int",
1419
+ "Description": "The person's ID"
1420
+ },
1421
+ {
1422
+ "Name": "body",
1423
+ "Required": "Y",
1424
+ "Default": "{}",
1425
+ "Type": "json",
1426
+ "Description": "JSON attributes for the new membership"
1427
+ }
1428
+ ]
1429
+ },
1430
+ {
1431
+ "MethodName": "Update",
1432
+ "Synopsis": "Updates a membership",
1433
+ "HTTPMethod": "PUT",
1434
+ "URI": "/people/:person_id/memberships",
1435
+ "parameters": [
1436
+ {
1437
+ "Name": "person_id",
1438
+ "Required": "Y",
1439
+ "Default": null,
1440
+ "Type": "int",
1441
+ "Description": "The person's ID"
1442
+ },
1443
+ {
1444
+ "Name": "body",
1445
+ "Required": "Y",
1446
+ "Default": "{}",
1447
+ "Type": "json",
1448
+ "Description": "JSON attributes for updating a membership"
1449
+ }
1450
+ ]
1451
+ },
1452
+ {
1453
+ "MethodName": "Destroy",
1454
+ "Synopsis": "Removes a membership from the person",
1455
+ "HTTPMethod": "DELETE",
1456
+ "URI": "/people/:person_id/memberships/:name",
1457
+ "parameters": [
1458
+ {
1459
+ "Name": "person_id",
1460
+ "Required": "Y",
1461
+ "Default": null,
1462
+ "Type": "int",
1463
+ "Description": "The person's ID"
1464
+ },
1465
+ {
1466
+ "Name": "name",
1467
+ "Required": "Y",
1468
+ "Default": null,
1469
+ "Type": "string",
1470
+ "Description": "The name of the membership"
1471
+ }
1472
+ ]
1473
+ }
1474
+ ]
1475
+ },
1476
+ {
1477
+ "name": "Page Attachments",
1478
+ "methods": [
1479
+ {
1480
+ "MethodName": "Index",
1481
+ "Synopsis": "Returns a list of a page's file attachments",
1482
+ "HTTPMethod": "GET",
1483
+ "URI": "/sites/:site_slug/pages/:page_slug/attachments",
1484
+ "parameters": [
1485
+ {
1486
+ "Name": "site_slug",
1487
+ "Required": "Y",
1488
+ "Default": null,
1489
+ "Type": "string",
1490
+ "Description": "The slug of the site the page lives on"
1491
+ },
1492
+ {
1493
+ "Name": "page_slug",
1494
+ "Required": "Y",
1495
+ "Default": "1",
1496
+ "Type": "string",
1497
+ "Description": "The page's slug"
1498
+ },
1499
+ {
1500
+ "Name": "page",
1501
+ "Required": "N",
1502
+ "Default": "1",
1503
+ "Type": "int",
1504
+ "Description": "result page number"
1505
+ },
1506
+ {
1507
+ "Name": "per_page",
1508
+ "Required": "N",
1509
+ "Default": "10",
1510
+ "Type": "int",
1511
+ "Description": "number of results to return"
1512
+ }
1513
+ ]
1514
+ },
1515
+ {
1516
+ "MethodName": "Show",
1517
+ "Synopsis": "Creates a new file attachment for a page",
1518
+ "HTTPMethod": "GET",
1519
+ "URI": "/sites/:site_slug/pages/:page_slug/attachments/:id",
1520
+ "parameters": [
1521
+ {
1522
+ "Name": "site_slug",
1523
+ "Required": "Y",
1524
+ "Default": null,
1525
+ "Type": "string",
1526
+ "Description": "The slug of the site the page lives on"
1527
+ },
1528
+ {
1529
+ "Name": "page_slug",
1530
+ "Required": "Y",
1531
+ "Default": "1",
1532
+ "Type": "string",
1533
+ "Description": "The page's slug"
1534
+ },
1535
+ {
1536
+ "Name": "id",
1537
+ "Required": "Y",
1538
+ "Default": null,
1539
+ "Type": "int",
1540
+ "Description": "The ID of the page attachment"
1541
+ }
1542
+ ]
1543
+ },
1544
+ {
1545
+ "MethodName": "Create",
1546
+ "Synopsis": "Creates a new file attachment for a page",
1547
+ "HTTPMethod": "POST",
1548
+ "URI": "/sites/:site_slug/pages/:page_slug/attachments",
1549
+ "parameters": [
1550
+ {
1551
+ "Name": "site_slug",
1552
+ "Required": "Y",
1553
+ "Default": null,
1554
+ "Type": "string",
1555
+ "Description": "The slug of the site the page lives on"
1556
+ },
1557
+ {
1558
+ "Name": "page_slug",
1559
+ "Required": "Y",
1560
+ "Default": "1",
1561
+ "Type": "string",
1562
+ "Description": "The page's slug"
1563
+ },
1564
+ {
1565
+ "Name": "body",
1566
+ "Required": "Y",
1567
+ "Default": "{}",
1568
+ "Type": "json",
1569
+ "Description": "A JSON representation of the attachment"
1570
+ }
1571
+ ]
1572
+ },
1573
+ {
1574
+ "MethodName": "Destroy",
1575
+ "Synopsis": "Destroys a file attachment for a page",
1576
+ "HTTPMethod": "DELETE",
1577
+ "URI": "/sites/:site_slug/pages/:page_slug/attachments/:id",
1578
+ "parameters": [
1579
+ {
1580
+ "Name": "site_slug",
1581
+ "Required": "Y",
1582
+ "Default": null,
1583
+ "Type": "string",
1584
+ "Description": "The slug of the site the page lives on"
1585
+ },
1586
+ {
1587
+ "Name": "page_slug",
1588
+ "Required": "Y",
1589
+ "Default": "1",
1590
+ "Type": "string",
1591
+ "Description": "The page's slug"
1592
+ },
1593
+ {
1594
+ "Name": "id",
1595
+ "Required": "Y",
1596
+ "Default": null,
1597
+ "Type": "int",
1598
+ "Description": "The ID of the page attachment"
1599
+ }
1600
+ ]
1601
+ }
1602
+ ]
1603
+ },
1604
+ {
1605
+ "name": "People",
1606
+ "methods": [
1607
+ {
1608
+ "MethodName": "Index",
1609
+ "Synopsis": "Returns a list of people",
1610
+ "HTTPMethod": "GET",
1611
+ "URI": "/people",
1612
+ "parameters": [
1613
+ {
1614
+ "Name": "page",
1615
+ "Required": "N",
1616
+ "Default": "1",
1617
+ "Type": "int",
1618
+ "Description": "result page number"
1619
+ },
1620
+ {
1621
+ "Name": "per_page",
1622
+ "Required": "N",
1623
+ "Default": "10",
1624
+ "Type": "int",
1625
+ "Description": "number of results to return"
1626
+ }
1627
+ ]
1628
+ },
1629
+ {
1630
+ "MethodName": "Show",
1631
+ "Synopsis": "Returns a full representation of the person",
1632
+ "HTTPMethod": "GET",
1633
+ "URI": "/people/:id",
1634
+ "parameters": [
1635
+ {
1636
+ "Name": "id",
1637
+ "Required": "Y",
1638
+ "Default": "1",
1639
+ "Type": "int",
1640
+ "Description": "the person's id"
1641
+ }
1642
+ ]
1643
+ },
1644
+ {
1645
+ "MethodName": "Match",
1646
+ "Synopsis": "Finds people that match certain attributes exactly",
1647
+ "HTTPMethod": "GET",
1648
+ "URI": "/people/match",
1649
+ "parameters": [
1650
+ {
1651
+ "Name": "email",
1652
+ "Required": "N",
1653
+ "Default": null,
1654
+ "Type": "string",
1655
+ "Description": null
1656
+ },
1657
+ {
1658
+ "Name": "first_name",
1659
+ "Required": "N",
1660
+ "Default": null,
1661
+ "Type": "string",
1662
+ "Description": null
1663
+ },
1664
+ {
1665
+ "Name": "last_name",
1666
+ "Required": "N",
1667
+ "Default": null,
1668
+ "Type": "string",
1669
+ "Description": null
1670
+ },
1671
+ {
1672
+ "Name": "phone",
1673
+ "Required": "N",
1674
+ "Default": null,
1675
+ "Type": "string",
1676
+ "Description": null
1677
+ },
1678
+ {
1679
+ "Name": "mobile",
1680
+ "Required": "N",
1681
+ "Default": null,
1682
+ "Type": "string",
1683
+ "Description": null
1684
+ }
1685
+ ]
1686
+ },
1687
+ {
1688
+ "MethodName": "Search",
1689
+ "Synopsis": "Search for people using non-unique traits",
1690
+ "HTTPMethod": "GET",
1691
+ "URI": "/people/search",
1692
+ "parameters": [
1693
+ {
1694
+ "Name": "first_name",
1695
+ "Required": "N",
1696
+ "Default": null,
1697
+ "Type": "string",
1698
+ "Description": null
1699
+ },
1700
+ {
1701
+ "Name": "last_name",
1702
+ "Required": "N",
1703
+ "Default": null,
1704
+ "Type": "string",
1705
+ "Description": null
1706
+ },
1707
+ {
1708
+ "Name": "city",
1709
+ "Required": "N",
1710
+ "Default": null,
1711
+ "Type": "string",
1712
+ "Description": null
1713
+ },
1714
+ {
1715
+ "Name": "state",
1716
+ "Required": "N",
1717
+ "Default": null,
1718
+ "Type": "string",
1719
+ "Description": null
1720
+ },
1721
+ {
1722
+ "Name": "sex",
1723
+ "Required": "N",
1724
+ "Default": null,
1725
+ "Type": "string",
1726
+ "Description": null
1727
+ },
1728
+ {
1729
+ "Name": "birthdate",
1730
+ "Required": "N",
1731
+ "Default": null,
1732
+ "Type": "string",
1733
+ "Description": null
1734
+ },
1735
+ {
1736
+ "Name": "updated_since",
1737
+ "Required": "N",
1738
+ "Default": null,
1739
+ "Type": "string",
1740
+ "Description": null
1741
+ },
1742
+ {
1743
+ "Name": "with_mobile",
1744
+ "Required": "N",
1745
+ "Default": null,
1746
+ "Type": "string",
1747
+ "Description": null
1748
+ },
1749
+ {
1750
+ "Name": "custom_values",
1751
+ "Required": "N",
1752
+ "Default": null,
1753
+ "Type": "string",
1754
+ "Description": null
1755
+ },
1756
+ {
1757
+ "Name": "civicrm_id",
1758
+ "Required": "N",
1759
+ "Default": null,
1760
+ "Type": "string",
1761
+ "Description": null
1762
+ },
1763
+ {
1764
+ "Name": "county_file_id",
1765
+ "Required": "N",
1766
+ "Default": null,
1767
+ "Type": "string",
1768
+ "Description": null
1769
+ },
1770
+ {
1771
+ "Name": "datatrust_id",
1772
+ "Required": "N",
1773
+ "Default": null,
1774
+ "Type": "string",
1775
+ "Description": null
1776
+ },
1777
+ {
1778
+ "Name": "dw_id",
1779
+ "Required": "N",
1780
+ "Default": null,
1781
+ "Type": "string",
1782
+ "Description": null
1783
+ },
1784
+ {
1785
+ "Name": "external_id",
1786
+ "Required": "N",
1787
+ "Default": null,
1788
+ "Type": "string",
1789
+ "Description": null
1790
+ },
1791
+ {
1792
+ "Name": "media_market_id",
1793
+ "Required": "N",
1794
+ "Default": null,
1795
+ "Type": "string",
1796
+ "Description": null
1797
+ },
1798
+ {
1799
+ "Name": "membership_level_id",
1800
+ "Required": "N",
1801
+ "Default": null,
1802
+ "Type": "string",
1803
+ "Description": null
1804
+ },
1805
+ {
1806
+ "Name": "ngp_id",
1807
+ "Required": "N",
1808
+ "Default": null,
1809
+ "Type": "string",
1810
+ "Description": null
1811
+ },
1812
+ {
1813
+ "Name": "pf_strat_id",
1814
+ "Required": "N",
1815
+ "Default": null,
1816
+ "Type": "string",
1817
+ "Description": null
1818
+ },
1819
+ {
1820
+ "Name": "rnc_id",
1821
+ "Required": "N",
1822
+ "Default": null,
1823
+ "Type": "string",
1824
+ "Description": null
1825
+ },
1826
+ {
1827
+ "Name": "rnc_regid",
1828
+ "Required": "N",
1829
+ "Default": null,
1830
+ "Type": "string",
1831
+ "Description": null
1832
+ },
1833
+ {
1834
+ "Name": "salesforce_id",
1835
+ "Required": "N",
1836
+ "Default": null,
1837
+ "Type": "string",
1838
+ "Description": null
1839
+ },
1840
+ {
1841
+ "Name": "state_file_id",
1842
+ "Required": "N",
1843
+ "Default": null,
1844
+ "Type": "string",
1845
+ "Description": null
1846
+ },
1847
+ {
1848
+ "Name": "van_id",
1849
+ "Required": "N",
1850
+ "Default": null,
1851
+ "Type": "string",
1852
+ "Description": null
1853
+ },
1854
+ {
1855
+ "Name": "page",
1856
+ "Required": "N",
1857
+ "Default": "1",
1858
+ "Type": "int",
1859
+ "Description": null
1860
+ },
1861
+ {
1862
+ "Name": "per_page",
1863
+ "Required": "N",
1864
+ "Default": "100",
1865
+ "Type": "int",
1866
+ "Description": null
1867
+ }
1868
+ ]
1869
+ },
1870
+ {
1871
+ "MethodName": "Nearby",
1872
+ "Synopsis": "Searches for people near a location defined by latitude and longitude",
1873
+ "HTTPMethod": "GET",
1874
+ "URI": "/people/nearby",
1875
+ "parameters": [
1876
+ {
1877
+ "Name": "location",
1878
+ "Required": "Y",
1879
+ "Default": "34.049031,-118.251399",
1880
+ "Type": "string",
1881
+ "Description": "origin of search in the format \"latitude,longitude\""
1882
+ },
1883
+ {
1884
+ "Name": "distance",
1885
+ "Required": "N",
1886
+ "Default": "1",
1887
+ "Type": "int",
1888
+ "Description": "radius in miles for which to include results"
1889
+ },
1890
+ {
1891
+ "Name": "page",
1892
+ "Required": "N",
1893
+ "Default": "1",
1894
+ "Type": "int",
1895
+ "Description": "page number"
1896
+ },
1897
+ {
1898
+ "Name": "per_page",
1899
+ "Required": "N",
1900
+ "Default": "10",
1901
+ "Type": "int",
1902
+ "Description": "number of results to show per page"
1903
+ }
1904
+ ]
1905
+ },
1906
+ {
1907
+ "MethodName": "Me",
1908
+ "Synopsis": "Returns the access token's resource owner's representation",
1909
+ "HTTPMethod": "GET",
1910
+ "URI": "/people/me",
1911
+ "parameters": [
1995
1912
 
1913
+ ]
1914
+ },
1915
+ {
1916
+ "MethodName": "Register",
1917
+ "Synopsis": "Starts user registration person for the given person",
1918
+ "HTTPMethod": "GET",
1919
+ "URI": "/people/:id/register",
1920
+ "parameters": [
1921
+ {
1922
+ "Name": "id",
1923
+ "Required": "Y",
1924
+ "Default": null,
1925
+ "Type": "int",
1926
+ "Description": "The person's ID"
1927
+ }
1928
+ ]
1929
+ },
1930
+ {
1931
+ "MethodName": "Taggings",
1932
+ "Synopsis": "Returns all taggings for a given person",
1933
+ "HTTPMethod": "GET",
1934
+ "URI": "/people/:id/taggings",
1935
+ "parameters": [
1936
+ {
1937
+ "Name": "id",
1938
+ "Required": "Y",
1939
+ "Default": null,
1940
+ "Type": "int",
1941
+ "Description": "the ID of the person"
1942
+ }
1943
+ ]
1944
+ },
1945
+ {
1946
+ "MethodName": "Tag Person",
1947
+ "Synopsis": "Tags a person",
1948
+ "HTTPMethod": "PUT",
1949
+ "URI": "/people/:id/taggings",
1950
+ "parameters": [
1951
+ {
1952
+ "Name": "id",
1953
+ "Required": "Y",
1954
+ "Default": null,
1955
+ "Type": "int",
1956
+ "Description": "the ID of the person"
1957
+ },
1958
+ {
1959
+ "Name": "body",
1960
+ "Required": "Y",
1961
+ "Default": null,
1962
+ "Type": "json",
1963
+ "Description": "JSON with tagging information"
1964
+ }
1965
+ ]
1966
+ },
1967
+ {
1968
+ "MethodName": "Tag Removal",
1969
+ "Synopsis": "Removes a tag from a person",
1970
+ "HTTPMethod": "DELETE",
1971
+ "URI": "/people/:id/taggings/:tag",
1972
+ "parameters": [
1973
+ {
1974
+ "Name": "id",
1975
+ "Required": "Y",
1976
+ "Default": null,
1977
+ "Type": "int",
1978
+ "Description": "the ID of the person"
1979
+ },
1980
+ {
1981
+ "Name": "tag",
1982
+ "Required": "Y",
1983
+ "Default": null,
1984
+ "Type": "string",
1985
+ "Description": "the name of the tag"
1986
+ }
1987
+ ]
1988
+ },
1989
+ {
1990
+ "MethodName": "Bulk Tag Removal",
1991
+ "Synopsis": "Removes tags from a person",
1992
+ "HTTPMethod": "DELETE",
1993
+ "URI": "/people/:id/taggings",
1994
+ "parameters": [
1995
+ {
1996
+ "Name": "id",
1997
+ "Required": "Y",
1998
+ "Default": null,
1999
+ "Type": "int",
2000
+ "Description": "the ID of the person"
2001
+ },
2002
+ {
2003
+ "Name": "body",
2004
+ "Required": "Y",
2005
+ "Default": null,
2006
+ "Type": "json",
2007
+ "Description": "the tagging resource"
2008
+ }
2009
+ ]
2010
+ },
2011
+ {
2012
+ "MethodName": "Political Capital",
2013
+ "Synopsis": "Returns a paginated list of a person's capitals",
2014
+ "HTTPMethod": "GET",
2015
+ "URI": "/people/:id/capitals",
2016
+ "parameters": [
2017
+ {
2018
+ "Name": "id",
2019
+ "Required": "Y",
2020
+ "Default": null,
2021
+ "Type": "int",
2022
+ "Description": "the ID of the person"
2023
+ },
2024
+ {
2025
+ "Name": "page",
2026
+ "Required": "N",
2027
+ "Default": "1",
2028
+ "Type": "int",
2029
+ "Description": "page number"
2030
+ },
2031
+ {
2032
+ "Name": "per_page",
2033
+ "Required": "N",
2034
+ "Default": "10",
2035
+ "Type": "int",
2036
+ "Description": "number of results to show per page"
2037
+ }
2038
+ ]
2039
+ },
2040
+ {
2041
+ "MethodName": "Political Capital Create",
2042
+ "Synopsis": "Creates capital for the given person",
2043
+ "HTTPMethod": "POST",
2044
+ "URI": "/people/:id/capitals",
2045
+ "parameters": [
2046
+ {
2047
+ "Name": "id",
2048
+ "Required": "Y",
2049
+ "Default": null,
2050
+ "Type": "int",
2051
+ "Description": "the ID of the person"
2052
+ },
2053
+ {
2054
+ "Name": "body",
2055
+ "Required": "Y",
2056
+ "Default": null,
2057
+ "Type": "json",
2058
+ "Description": "JSON representation of the capital to create"
2059
+ }
2060
+ ]
2061
+ },
2062
+ {
2063
+ "MethodName": "Political Capital Destroy",
2064
+ "Synopsis": "Destroys capital for a person",
2065
+ "HTTPMethod": "DELETE",
2066
+ "URI": "/people/:person_id/capitals/:capital_id",
2067
+ "parameters": [
2068
+ {
2069
+ "Name": "person_id",
2070
+ "Required": "Y",
2071
+ "Default": null,
2072
+ "Type": "int",
2073
+ "Description": "the ID of the person"
2074
+ },
2075
+ {
2076
+ "Name": "capital_id",
2077
+ "Required": "Y",
2078
+ "Default": null,
2079
+ "Type": "int",
2080
+ "Description": "the ID of the capital to destroy"
2081
+ }
2082
+ ]
2083
+ },
2084
+ {
2085
+ "MethodName": "Create",
2086
+ "Synopsis": "Creates a person with the provided data",
2087
+ "HTTPMethod": "POST",
2088
+ "URI": "/people",
2089
+ "parameters": [
2090
+ {
2091
+ "Name": "body",
2092
+ "Required": "Y",
2093
+ "Default": "{}",
2094
+ "Type": "json",
2095
+ "Description": "JSON representation of the person to create"
2096
+ }
2097
+ ]
2098
+ },
2099
+ {
2100
+ "MethodName": "Update",
2101
+ "Synopsis": "Updates a person with the provided data",
2102
+ "HTTPMethod": "PUT",
2103
+ "URI": "/people/:id",
2104
+ "parameters": [
2105
+ {
2106
+ "Name": "id",
2107
+ "Required": "Y",
2108
+ "Default": null,
2109
+ "Type": "int",
2110
+ "Description": "The person's ID"
2111
+ },
2112
+ {
2113
+ "Name": "body",
2114
+ "Required": "Y",
2115
+ "Default": "{}",
2116
+ "Type": "json",
2117
+ "Description": "JSON attributes for updating the person"
2118
+ }
2119
+ ]
2120
+ },
2121
+ {
2122
+ "MethodName": "Push",
2123
+ "Synopsis": "Updates a matched person or creates a new one if the person doesn't exist",
2124
+ "HTTPMethod": "PUT",
2125
+ "URI": "/people/push",
2126
+ "parameters": [
2127
+ {
2128
+ "Name": "body",
2129
+ "Required": "Y",
2130
+ "Default": "{}",
2131
+ "Type": "json",
2132
+ "Description": "JSON attributes for updating/matching the person"
2133
+ }
2134
+ ]
2135
+ },
2136
+ {
2137
+ "MethodName": "Destroy",
2138
+ "Synopsis": "Removes the person with the matching ID",
2139
+ "HTTPMethod": "DELETE",
2140
+ "URI": "/people/:id",
2141
+ "parameters": [
2142
+ {
2143
+ "Name": "id",
2144
+ "Required": "Y",
2145
+ "Default": null,
2146
+ "Type": "int",
2147
+ "Description": "The person's ID"
2148
+ }
2149
+ ]
2150
+ }
2151
+ ]
2152
+ },
2153
+ {
2154
+ "name": "People Tags",
2155
+ "methods": [
2156
+ {
2157
+ "MethodName": "Index",
2158
+ "Synopsis": "Returns a list of previously used tags",
2159
+ "HTTPMethod": "GET",
2160
+ "URI": "/tags",
2161
+ "parameters": [
2162
+ {
2163
+ "Name": "page",
2164
+ "Required": "N",
2165
+ "Default": "1",
2166
+ "Type": "int",
2167
+ "Description": "result page number"
2168
+ },
2169
+ {
2170
+ "Name": "per_page",
2171
+ "Required": "N",
2172
+ "Default": "10",
2173
+ "Type": "int",
2174
+ "Description": "number of results to return"
2175
+ }
2176
+ ]
2177
+ },
2178
+ {
2179
+ "MethodName": "People",
2180
+ "Synopsis": "Searches for people with the given tag",
2181
+ "HTTPMethod": "GET",
2182
+ "URI": "/tags/:tag/people",
2183
+ "parameters": [
2184
+ {
2185
+ "Name": "tag",
2186
+ "Required": "Y",
2187
+ "Default": null,
2188
+ "Type": "string",
2189
+ "Description": "the name of the tag"
2190
+ },
2191
+ {
2192
+ "Name": "page",
2193
+ "Required": "N",
2194
+ "Default": "1",
2195
+ "Type": "int",
2196
+ "Description": "result page number"
2197
+ },
2198
+ {
2199
+ "Name": "per_page",
2200
+ "Required": "N",
2201
+ "Default": "10",
2202
+ "Type": "int",
2203
+ "Description": "number of results to return"
2204
+ }
2205
+ ]
2206
+ }
2207
+ ]
2208
+ },
2209
+ {
2210
+ "name": "Sites",
2211
+ "methods": [
2212
+ {
2213
+ "MethodName": "Index",
2214
+ "Synopsis": "Returns a list of all sites",
2215
+ "HTTPMethod": "GET",
2216
+ "URI": "/sites",
2217
+ "parameters": [
2218
+ {
2219
+ "Name": "page",
2220
+ "Required": "N",
2221
+ "Default": "1",
2222
+ "Type": "int",
2223
+ "Description": "result page number"
2224
+ },
2225
+ {
2226
+ "Name": "per_page",
2227
+ "Required": "N",
2228
+ "Default": "10",
2229
+ "Type": "int",
2230
+ "Description": "number of results to return"
2231
+ }
2232
+ ]
2233
+ }
2234
+ ]
2235
+ },
2236
+ {
2237
+ "name": "Survey Responses",
2238
+ "methods": [
2239
+ {
2240
+ "MethodName": "Index",
2241
+ "Synopsis": "Lists all survey responses",
2242
+ "HTTPMethod": "GET",
2243
+ "URI": "/survey_responses",
2244
+ "parameters": [
2245
+ {
2246
+ "Name": "start_time",
2247
+ "Required": "N",
2248
+ "Default": null,
2249
+ "Type": "string",
2250
+ "Description": "the starting time for results"
2251
+ },
2252
+ {
2253
+ "Name": "end_time",
2254
+ "Required": "N",
2255
+ "Default": null,
2256
+ "Type": "string",
2257
+ "Description": "the ending time for results"
2258
+ },
2259
+ {
2260
+ "Name": "survey_id",
2261
+ "Required": "N",
2262
+ "Default": null,
2263
+ "Type": "int",
2264
+ "Description": "the id for a parent survey"
2265
+ },
2266
+ {
2267
+ "Name": "page",
2268
+ "Required": "N",
2269
+ "Default": "1",
2270
+ "Type": "int",
2271
+ "Description": "result page number"
2272
+ },
2273
+ {
2274
+ "Name": "per_page",
2275
+ "Required": "N",
2276
+ "Default": "10",
2277
+ "Type": "int",
2278
+ "Description": "number of results to return"
2279
+ }
2280
+ ]
2281
+ },
2282
+ {
2283
+ "MethodName": "Create",
2284
+ "Synopsis": "Creates responses for a survey",
2285
+ "HTTPMethod": "POST",
2286
+ "URI": "/survey_responses",
2287
+ "parameters": [
2288
+ {
2289
+ "Name": "body",
2290
+ "Required": "Y",
2291
+ "Default": null,
2292
+ "Type": "json",
2293
+ "Description": "a JSON representation of the survey responses"
2294
+ }
2295
+ ]
2296
+ }
2297
+ ]
2298
+ },
2299
+ {
2300
+ "name": "Surveys",
2301
+ "methods": [
2302
+ {
2303
+ "MethodName": "Index",
2304
+ "Synopsis": "Shows a list of all surveys for the a site",
2305
+ "HTTPMethod": "GET",
2306
+ "URI": "/sites/:site_slug/pages/surveys",
2307
+ "parameters": [
2308
+ {
2309
+ "Name": "site_slug",
2310
+ "Required": "Y",
2311
+ "Default": null,
2312
+ "Type": "string",
2313
+ "Description": "the site holding the survey"
2314
+ },
2315
+ {
2316
+ "Name": "page",
2317
+ "Required": "N",
2318
+ "Default": "1",
2319
+ "Type": "int",
2320
+ "Description": "result page number"
2321
+ },
2322
+ {
2323
+ "Name": "per_page",
2324
+ "Required": "N",
2325
+ "Default": "10",
2326
+ "Type": "int",
2327
+ "Description": "number of results to return"
2328
+ }
2329
+ ]
2330
+ },
2331
+ {
2332
+ "MethodName": "Create",
2333
+ "Synopsis": "Creates a survey for a site",
2334
+ "HTTPMethod": "POST",
2335
+ "URI": "/sites/:site_slug/pages/surveys",
2336
+ "parameters": [
2337
+ {
2338
+ "Name": "site_slug",
2339
+ "Required": "Y",
2340
+ "Default": null,
2341
+ "Type": "string",
2342
+ "Description": "the site holding the survey"
2343
+ },
2344
+ {
2345
+ "Name": "body",
2346
+ "Required": "Y",
2347
+ "Default": null,
2348
+ "Type": "json",
2349
+ "Description": "a JSON representation of the new survey"
2350
+ }
2351
+ ]
2352
+ },
2353
+ {
2354
+ "MethodName": "Update",
2355
+ "Synopsis": "Updates the attributes of a survey",
2356
+ "HTTPMethod": "PUT",
2357
+ "URI": "/sites/:site_slug/pages/surveys/:id",
2358
+ "parameters": [
2359
+ {
2360
+ "Name": "site_slug",
2361
+ "Required": "Y",
2362
+ "Default": null,
2363
+ "Type": "string",
2364
+ "Description": "the site holding the survey"
2365
+ },
2366
+ {
2367
+ "Name": "id",
2368
+ "Required": "Y",
2369
+ "Default": null,
2370
+ "Type": "int",
2371
+ "Description": "the ID of the survey"
2372
+ },
2373
+ {
2374
+ "Name": "body",
2375
+ "Required": "Y",
2376
+ "Default": null,
2377
+ "Type": "json",
2378
+ "Description": "JSON containing updates"
2379
+ }
2380
+ ]
2381
+ },
2382
+ {
2383
+ "MethodName": "Destroy",
2384
+ "Synopsis": "Removes a survey",
2385
+ "HTTPMethod": "DELETE",
2386
+ "URI": "/sites/:site_slug/pages/surveys/:id",
2387
+ "parameters": [
2388
+ {
2389
+ "Name": "site_slug",
2390
+ "Required": "Y",
2391
+ "Default": null,
2392
+ "Type": "string",
2393
+ "Description": "the site holding the survey"
2394
+ },
2395
+ {
2396
+ "Name": "id",
2397
+ "Required": "Y",
2398
+ "Default": null,
2399
+ "Type": "int",
2400
+ "Description": "the ID of the survey"
2401
+ }
2402
+ ]
2403
+ }
2404
+ ]
2405
+ },
2406
+ {
2407
+ "name": "Webhooks",
2408
+ "methods": [
2409
+ {
2410
+ "MethodName": "Index",
2411
+ "Synopsis": "Lists all webhooks",
2412
+ "HTTPMethod": "GET",
2413
+ "URI": "/webhooks",
2414
+ "parameters": [
2415
+ {
2416
+ "Name": "page",
2417
+ "Required": "N",
2418
+ "Default": "1",
2419
+ "Type": "int",
2420
+ "Description": "result page number"
2421
+ },
2422
+ {
2423
+ "Name": "per_page",
2424
+ "Required": "N",
2425
+ "Default": "10",
2426
+ "Type": "int",
2427
+ "Description": "number of results to return"
2428
+ }
2429
+ ]
2430
+ },
2431
+ {
2432
+ "MethodName": "Show",
2433
+ "Synopsis": "Shows the details of an individual webhook",
2434
+ "HTTPMethod": "GET",
2435
+ "URI": "/webhooks/:id",
2436
+ "parameters": [
2437
+ {
2438
+ "Name": "id",
2439
+ "Required": "Y",
2440
+ "Default": null,
2441
+ "Type": "string",
2442
+ "Description": "the ID of the webhook to display"
2443
+ }
2444
+ ]
2445
+ },
2446
+ {
2447
+ "MethodName": "Create",
2448
+ "Synopsis": "Creates a new webhook",
2449
+ "HTTPMethod": "POST",
2450
+ "URI": "/webhooks",
2451
+ "parameters": [
2452
+ {
2453
+ "Name": "body",
2454
+ "Required": "Y",
2455
+ "Default": null,
2456
+ "Type": "json",
2457
+ "Description": "a JSON representation of the new webhook"
2458
+ }
2459
+ ]
2460
+ },
2461
+ {
2462
+ "MethodName": "Destroy",
2463
+ "Synopsis": "Destroys a webhook",
2464
+ "HTTPMethod": "DELETE",
2465
+ "URI": "/webhooks/:id",
2466
+ "parameters": [
2467
+ {
2468
+ "Name": "id",
2469
+ "Required": "Y",
2470
+ "Default": null,
2471
+ "Type": "int",
2472
+ "Description": "the ID a webhook"
2473
+ }
2474
+ ]
2475
+ }
1996
2476
  ]
1997
- }]
1998
- }]
2477
+ }
2478
+ ]
1999
2479
  }