nationbuilder-rb 1.3.5 → 1.3.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/VERSION +1 -1
- data/lib/api_spec/lib/api_spec/generator.rb +6 -11
- data/lib/api_spec/lib/api_spec/specs/basic_pages.rb +12 -22
- data/lib/api_spec/lib/api_spec/specs/blog_posts.rb +15 -28
- data/lib/api_spec/lib/api_spec/specs/blogs.rb +15 -27
- data/lib/api_spec/lib/api_spec/specs/calendars.rb +15 -27
- data/lib/api_spec/lib/api_spec/specs/campaign_data.rb +3 -7
- data/lib/api_spec/lib/api_spec/specs/contacts.rb +25 -45
- data/lib/api_spec/lib/api_spec/specs/donations.rb +15 -17
- data/lib/api_spec/lib/api_spec/specs/events.rb +31 -38
- data/lib/api_spec/lib/api_spec/specs/exports.rb +16 -11
- data/lib/api_spec/lib/api_spec/specs/imports.rb +9 -11
- data/lib/api_spec/lib/api_spec/specs/lists.rb +47 -49
- data/lib/api_spec/lib/api_spec/specs/memberships.rb +6 -8
- data/lib/api_spec/lib/api_spec/specs/page_attachments.rb +22 -24
- data/lib/api_spec/lib/api_spec/specs/people.rb +88 -92
- data/lib/api_spec/lib/api_spec/specs/people_tags.rb +6 -8
- data/lib/api_spec/lib/api_spec/specs/precincts.rb +19 -21
- data/lib/api_spec/lib/api_spec/specs/sites.rb +3 -5
- data/lib/api_spec/lib/api_spec/specs/survey_responses.rb +7 -11
- data/lib/api_spec/lib/api_spec/specs/surveys.rb +13 -23
- data/lib/api_spec/lib/api_spec/specs/webhooks.rb +12 -21
- data/lib/api_spec/spec.json +71 -64
- data/nationbuilder-rb.gemspec +3 -3
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e592206000b8bf6b4da12aac7e77e8be24d24ed4
|
4
|
+
data.tar.gz: e90bb803dbd498a5dff7e14cd6ada6e340e30db4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7665a8f59a7a20e74f36568b495b3ff895a9a1a7af794975f9d9ee39d909b9389b291ae944949dc9bd64ee6fafba201164e5fe80430deb9251c7cd77630768e
|
7
|
+
data.tar.gz: 7d63b9c2fa767b5cd92dbcf82953044980fd890054c30a93080f95f62aae77d26e2ba8fd4769f162d998e22a86a8d570ad5257a05797d378dac48324ecff1fd4
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.3.
|
1
|
+
1.3.6
|
@@ -40,7 +40,6 @@ module ApiSpec
|
|
40
40
|
send(nested_name) << obj
|
41
41
|
end if base.nested_adder_name
|
42
42
|
end
|
43
|
-
|
44
43
|
end
|
45
44
|
|
46
45
|
class Parameter < APIObject
|
@@ -54,16 +53,15 @@ module ApiSpec
|
|
54
53
|
}
|
55
54
|
|
56
55
|
init(self)
|
57
|
-
|
58
56
|
end
|
59
57
|
|
60
58
|
class Method < APIObject
|
61
59
|
|
62
60
|
JSON_NAMES = {
|
63
|
-
name:
|
64
|
-
synopsis:
|
65
|
-
http_method:
|
66
|
-
uri:
|
61
|
+
name: 'MethodName',
|
62
|
+
synopsis: 'Synopsis',
|
63
|
+
http_method: 'HTTPMethod',
|
64
|
+
uri: 'URI'
|
67
65
|
}
|
68
66
|
|
69
67
|
self.nested_name = :parameters
|
@@ -71,13 +69,12 @@ module ApiSpec
|
|
71
69
|
self.nested_class = Parameter
|
72
70
|
|
73
71
|
init(self)
|
74
|
-
|
75
72
|
end
|
76
73
|
|
77
74
|
class Endpoint < APIObject
|
78
75
|
|
79
76
|
JSON_NAMES = {
|
80
|
-
name:
|
77
|
+
name: 'name'
|
81
78
|
}
|
82
79
|
|
83
80
|
self.nested_name = :methods
|
@@ -85,11 +82,9 @@ module ApiSpec
|
|
85
82
|
self.nested_class = ApiSpec::Method
|
86
83
|
|
87
84
|
init(self)
|
88
|
-
|
89
85
|
end
|
90
86
|
|
91
87
|
class Spec < APIObject
|
92
|
-
|
93
88
|
class << self
|
94
89
|
attr_accessor :endpoints
|
95
90
|
end
|
@@ -97,7 +92,7 @@ module ApiSpec
|
|
97
92
|
self.endpoints = []
|
98
93
|
|
99
94
|
def self.to_hash
|
100
|
-
{ 'endpoints' => endpoints.map
|
95
|
+
{ 'endpoints' => endpoints.map(&:to_hash) }
|
101
96
|
end
|
102
97
|
|
103
98
|
def self.write_spec(path)
|
@@ -3,10 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Basic Pages' do |bp|
|
4
4
|
|
5
5
|
bp.method('Index') do |m|
|
6
|
-
|
7
|
-
m.
|
8
|
-
m.
|
9
|
-
m.uri = "/sites/:site_slug/pages/basic_pages"
|
6
|
+
m.synopsis = 'Shows a list of the basic pages in the system'
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/sites/:site_slug/pages/basic_pages'
|
10
9
|
|
11
10
|
m.parameter('site_slug') do |p|
|
12
11
|
p.required = 'Y'
|
@@ -32,14 +31,12 @@ class ApiSpec::Spec
|
|
32
31
|
p.type = 'int'
|
33
32
|
p.description = 'maximum number of results to return'
|
34
33
|
end
|
35
|
-
|
36
34
|
end
|
37
35
|
|
38
36
|
bp.method('Create') do |m|
|
39
|
-
|
40
|
-
m.
|
41
|
-
m.
|
42
|
-
m.uri = "/sites/:site_slug/pages/basic_pages"
|
37
|
+
m.synopsis = 'Creates a basic page for a site'
|
38
|
+
m.http_method = 'POST'
|
39
|
+
m.uri = '/sites/:site_slug/pages/basic_pages'
|
43
40
|
|
44
41
|
m.parameter('site_slug') do |p|
|
45
42
|
p.required = 'Y'
|
@@ -52,14 +49,12 @@ class ApiSpec::Spec
|
|
52
49
|
p.type = 'json'
|
53
50
|
p.description = 'a JSON representation of the new basic page'
|
54
51
|
end
|
55
|
-
|
56
52
|
end
|
57
53
|
|
58
54
|
bp.method('Update') do |m|
|
59
|
-
|
60
|
-
m.
|
61
|
-
m.
|
62
|
-
m.uri = "/sites/:site_slug/pages/basic_pages/:id"
|
55
|
+
m.synopsis = 'Updates the attributes of a basic page'
|
56
|
+
m.http_method = 'PUT'
|
57
|
+
m.uri = '/sites/:site_slug/pages/basic_pages/:id'
|
63
58
|
|
64
59
|
m.parameter('site_slug') do |p|
|
65
60
|
p.required = 'Y'
|
@@ -78,14 +73,12 @@ class ApiSpec::Spec
|
|
78
73
|
p.type = 'json'
|
79
74
|
p.description = 'JSON containing updates'
|
80
75
|
end
|
81
|
-
|
82
76
|
end
|
83
77
|
|
84
78
|
bp.method('Destroy') do |m|
|
85
|
-
|
86
|
-
m.
|
87
|
-
m.
|
88
|
-
m.uri = "/sites/:site_slug/pages/basic_pages/:id"
|
79
|
+
m.synopsis = 'Removes a basic page'
|
80
|
+
m.http_method = 'DELETE'
|
81
|
+
m.uri = '/sites/:site_slug/pages/basic_pages/:id'
|
89
82
|
|
90
83
|
m.parameter('site_slug') do |p|
|
91
84
|
p.required = 'Y'
|
@@ -98,9 +91,6 @@ class ApiSpec::Spec
|
|
98
91
|
p.type = 'int'
|
99
92
|
p.description = 'the ID of the basic page'
|
100
93
|
end
|
101
|
-
|
102
94
|
end
|
103
|
-
|
104
95
|
end
|
105
|
-
|
106
96
|
end
|
@@ -3,10 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Blog Posts' do |bp|
|
4
4
|
|
5
5
|
bp.method('Index') do |m|
|
6
|
-
|
7
|
-
m.
|
8
|
-
m.
|
9
|
-
m.uri = "/sites/:site_slug/pages/blogs/:id/posts"
|
6
|
+
m.synopsis = 'Shows a list of posts for a blog'
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/sites/:site_slug/pages/blogs/:id/posts'
|
10
9
|
|
11
10
|
m.parameter('site_slug') do |p|
|
12
11
|
p.required = 'Y'
|
@@ -38,14 +37,12 @@ class ApiSpec::Spec
|
|
38
37
|
p.type = 'int'
|
39
38
|
p.description = 'maximum number of results to return'
|
40
39
|
end
|
41
|
-
|
42
40
|
end
|
43
41
|
|
44
42
|
bp.method('Match') do |m|
|
45
|
-
|
46
|
-
m.
|
47
|
-
m.
|
48
|
-
m.uri = "/sites/:site_slug/pages/blogs/:id/match"
|
43
|
+
m.synopsis = 'Find a blog post by its external id'
|
44
|
+
m.http_method = 'GET'
|
45
|
+
m.uri = '/sites/:site_slug/pages/blogs/:id/match'
|
49
46
|
|
50
47
|
m.parameter('site_slug') do |p|
|
51
48
|
p.required = 'Y'
|
@@ -65,14 +62,12 @@ class ApiSpec::Spec
|
|
65
62
|
p.type = 'int'
|
66
63
|
p.description = 'the external id of the post'
|
67
64
|
end
|
68
|
-
|
69
65
|
end
|
70
66
|
|
71
67
|
bp.method('Create') do |m|
|
72
|
-
|
73
|
-
m.
|
74
|
-
m.
|
75
|
-
m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts"
|
68
|
+
m.synopsis = 'Creates a new blog post'
|
69
|
+
m.http_method = 'POST'
|
70
|
+
m.uri = '/sites/:site_slug/pages/blogs/:blog_id/posts'
|
76
71
|
|
77
72
|
m.parameter('site_slug') do |p|
|
78
73
|
p.required = 'Y'
|
@@ -92,14 +87,12 @@ class ApiSpec::Spec
|
|
92
87
|
p.type = 'json'
|
93
88
|
p.description = 'a JSON representation of the new post'
|
94
89
|
end
|
95
|
-
|
96
90
|
end
|
97
91
|
|
98
92
|
bp.method('Update') do |m|
|
99
|
-
|
100
|
-
m.
|
101
|
-
m.
|
102
|
-
m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id"
|
93
|
+
m.synopsis = 'Updates the attributes of a blog post'
|
94
|
+
m.http_method = 'PUT'
|
95
|
+
m.uri = '/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id'
|
103
96
|
|
104
97
|
m.parameter('site_slug') do |p|
|
105
98
|
p.required = 'Y'
|
@@ -125,14 +118,12 @@ class ApiSpec::Spec
|
|
125
118
|
p.type = 'json'
|
126
119
|
p.description = 'JSON containing updates'
|
127
120
|
end
|
128
|
-
|
129
121
|
end
|
130
122
|
|
131
123
|
bp.method('Destroy') do |m|
|
132
|
-
|
133
|
-
m.
|
134
|
-
m.
|
135
|
-
m.uri = "/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id"
|
124
|
+
m.synopsis = 'Removes a blog post'
|
125
|
+
m.http_method = 'DELETE'
|
126
|
+
m.uri = '/sites/:site_slug/pages/blogs/:blog_id/posts/:blog_post_id'
|
136
127
|
|
137
128
|
m.parameter('site_slug') do |p|
|
138
129
|
p.required = 'Y'
|
@@ -151,10 +142,6 @@ class ApiSpec::Spec
|
|
151
142
|
p.type = 'int'
|
152
143
|
p.description = 'the ID of the blog'
|
153
144
|
end
|
154
|
-
|
155
|
-
|
156
145
|
end
|
157
|
-
|
158
146
|
end
|
159
|
-
|
160
147
|
end
|
@@ -3,10 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Blogs' do |bp|
|
4
4
|
|
5
5
|
bp.method('Index') do |m|
|
6
|
-
|
7
|
-
m.
|
8
|
-
m.
|
9
|
-
m.uri = "/sites/:site_slug/pages/blogs"
|
6
|
+
m.synopsis = 'Shows a list of all blogs'
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/sites/:site_slug/pages/blogs'
|
10
9
|
|
11
10
|
m.parameter('site_slug') do |p|
|
12
11
|
p.required = 'Y'
|
@@ -32,14 +31,12 @@ class ApiSpec::Spec
|
|
32
31
|
p.type = 'int'
|
33
32
|
p.description = 'maximum number of results to return'
|
34
33
|
end
|
35
|
-
|
36
34
|
end
|
37
35
|
|
38
36
|
bp.method('Show') do |m|
|
39
|
-
|
40
|
-
m.
|
41
|
-
m.
|
42
|
-
m.uri = "/sites/:site_slug/pages/blogs/:id"
|
37
|
+
m.synopsis = 'Show the details of a blog'
|
38
|
+
m.http_method = 'GET'
|
39
|
+
m.uri = '/sites/:site_slug/pages/blogs/:id'
|
43
40
|
|
44
41
|
m.parameter('site_slug') do |p|
|
45
42
|
p.required = 'Y'
|
@@ -52,14 +49,12 @@ class ApiSpec::Spec
|
|
52
49
|
p.type = 'int'
|
53
50
|
p.description = 'the ID of the blog'
|
54
51
|
end
|
55
|
-
|
56
52
|
end
|
57
53
|
|
58
54
|
bp.method('Create') do |m|
|
59
|
-
|
60
|
-
m.
|
61
|
-
m.
|
62
|
-
m.uri = "/sites/:site_slug/pages/blogs"
|
55
|
+
m.synopsis = 'Creates a new blog'
|
56
|
+
m.http_method = 'POST'
|
57
|
+
m.uri = '/sites/:site_slug/pages/blogs'
|
63
58
|
|
64
59
|
m.parameter('site_slug') do |p|
|
65
60
|
p.required = 'Y'
|
@@ -73,14 +68,12 @@ class ApiSpec::Spec
|
|
73
68
|
p.type = 'json'
|
74
69
|
p.description = 'a JSON representation of the new blog'
|
75
70
|
end
|
76
|
-
|
77
71
|
end
|
78
72
|
|
79
73
|
bp.method('Update') do |m|
|
80
|
-
|
81
|
-
m.
|
82
|
-
m.
|
83
|
-
m.uri = "/sites/:site_slug/pages/blogs/:id"
|
74
|
+
m.synopsis = 'Updates the attributes of a blog'
|
75
|
+
m.http_method = 'PUT'
|
76
|
+
m.uri = '/sites/:site_slug/pages/blogs/:id'
|
84
77
|
|
85
78
|
m.parameter('site_slug') do |p|
|
86
79
|
p.required = 'Y'
|
@@ -100,14 +93,12 @@ class ApiSpec::Spec
|
|
100
93
|
p.type = 'json'
|
101
94
|
p.description = 'JSON containing updates'
|
102
95
|
end
|
103
|
-
|
104
96
|
end
|
105
97
|
|
106
98
|
bp.method('Destroy') do |m|
|
107
|
-
|
108
|
-
m.
|
109
|
-
m.
|
110
|
-
m.uri = "/sites/:site_slug/pages/blogs/:id"
|
99
|
+
m.synopsis = 'Removes a blog'
|
100
|
+
m.http_method = 'DELETE'
|
101
|
+
m.uri = '/sites/:site_slug/pages/blogs/:id'
|
111
102
|
|
112
103
|
m.parameter('site_slug') do |p|
|
113
104
|
p.required = 'Y'
|
@@ -120,9 +111,6 @@ class ApiSpec::Spec
|
|
120
111
|
p.type = 'int'
|
121
112
|
p.description = 'the ID of the blog'
|
122
113
|
end
|
123
|
-
|
124
114
|
end
|
125
|
-
|
126
115
|
end
|
127
|
-
|
128
116
|
end
|
@@ -3,10 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Calendars' do |bp|
|
4
4
|
|
5
5
|
bp.method('Index') do |m|
|
6
|
-
|
7
|
-
m.
|
8
|
-
m.
|
9
|
-
m.uri = "/sites/:site_slug/pages/calendars"
|
6
|
+
m.synopsis = 'Shows a list of calendars'
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/sites/:site_slug/pages/calendars'
|
10
9
|
|
11
10
|
m.parameter('site_slug') do |p|
|
12
11
|
p.required = 'Y'
|
@@ -32,14 +31,12 @@ class ApiSpec::Spec
|
|
32
31
|
p.type = 'int'
|
33
32
|
p.description = 'maximum number of results to return'
|
34
33
|
end
|
35
|
-
|
36
34
|
end
|
37
35
|
|
38
36
|
bp.method('Show') do |m|
|
39
|
-
|
40
|
-
m.
|
41
|
-
m.
|
42
|
-
m.uri = "/sites/:site_slug/pages/calendars/:id"
|
37
|
+
m.synopsis = 'Show the details of a calendar'
|
38
|
+
m.http_method = 'GET'
|
39
|
+
m.uri = '/sites/:site_slug/pages/calendars/:id'
|
43
40
|
|
44
41
|
m.parameter('site_slug') do |p|
|
45
42
|
p.required = 'Y'
|
@@ -52,14 +49,12 @@ class ApiSpec::Spec
|
|
52
49
|
p.type = 'int'
|
53
50
|
p.description = 'the ID of the calendar'
|
54
51
|
end
|
55
|
-
|
56
52
|
end
|
57
53
|
|
58
54
|
bp.method('Create') do |m|
|
59
|
-
|
60
|
-
m.
|
61
|
-
m.
|
62
|
-
m.uri = "/sites/:site_slug/pages/calendars"
|
55
|
+
m.synopsis = 'Creates a new calendar'
|
56
|
+
m.http_method = 'POST'
|
57
|
+
m.uri = '/sites/:site_slug/pages/calendars'
|
63
58
|
|
64
59
|
m.parameter('site_slug') do |p|
|
65
60
|
p.required = 'Y'
|
@@ -73,14 +68,12 @@ class ApiSpec::Spec
|
|
73
68
|
p.type = 'json'
|
74
69
|
p.description = 'a JSON representation of the new calendar'
|
75
70
|
end
|
76
|
-
|
77
71
|
end
|
78
72
|
|
79
73
|
bp.method('Update') do |m|
|
80
|
-
|
81
|
-
m.
|
82
|
-
m.
|
83
|
-
m.uri = "/sites/:site_slug/pages/calendars/:id"
|
74
|
+
m.synopsis = 'Updates the attributes of a calendar'
|
75
|
+
m.http_method = 'PUT'
|
76
|
+
m.uri = '/sites/:site_slug/pages/calendars/:id'
|
84
77
|
|
85
78
|
m.parameter('site_slug') do |p|
|
86
79
|
p.required = 'Y'
|
@@ -100,14 +93,12 @@ class ApiSpec::Spec
|
|
100
93
|
p.type = 'json'
|
101
94
|
p.description = 'JSON containing updates'
|
102
95
|
end
|
103
|
-
|
104
96
|
end
|
105
97
|
|
106
98
|
bp.method('Destroy') do |m|
|
107
|
-
|
108
|
-
m.
|
109
|
-
m.
|
110
|
-
m.uri = "/sites/:site_slug/pages/calendars/:id"
|
99
|
+
m.synopsis = 'Removes a calendar'
|
100
|
+
m.http_method = 'DELETE'
|
101
|
+
m.uri = '/sites/:site_slug/pages/calendars/:id'
|
111
102
|
|
112
103
|
m.parameter('site_slug') do |p|
|
113
104
|
p.required = 'Y'
|
@@ -120,9 +111,6 @@ class ApiSpec::Spec
|
|
120
111
|
p.type = 'int'
|
121
112
|
p.description = 'the ID of the calendar'
|
122
113
|
end
|
123
|
-
|
124
114
|
end
|
125
|
-
|
126
115
|
end
|
127
|
-
|
128
116
|
end
|
@@ -3,13 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Campaign Data' do |bp|
|
4
4
|
|
5
5
|
bp.method('Show') do |m|
|
6
|
-
|
7
|
-
m.
|
8
|
-
m.
|
9
|
-
m.uri = "/campaign_data"
|
10
|
-
|
6
|
+
m.synopsis = 'Shows campaign metadata about the nation'
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/campaign_data'
|
11
9
|
end
|
12
|
-
|
13
10
|
end
|
14
|
-
|
15
11
|
end
|
@@ -3,15 +3,14 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Contacts' do |c|
|
4
4
|
|
5
5
|
c.method('Index') do |m|
|
6
|
-
|
7
6
|
m.synopsis = "View a paginated list of a person's contacts"
|
8
|
-
m.http_method =
|
9
|
-
m.uri =
|
7
|
+
m.http_method = 'GET'
|
8
|
+
m.uri = '/people/:person_id/contacts'
|
10
9
|
|
11
10
|
m.parameter('person_id') do |p|
|
12
11
|
p.required = 'Y'
|
13
12
|
p.type = 'int'
|
14
|
-
p.description =
|
13
|
+
p.description = "the person's ID"
|
15
14
|
end
|
16
15
|
|
17
16
|
m.parameter('__token') do |p|
|
@@ -32,19 +31,17 @@ class ApiSpec::Spec
|
|
32
31
|
p.type = 'int'
|
33
32
|
p.description = 'maximum number of results to return'
|
34
33
|
end
|
35
|
-
|
36
34
|
end
|
37
35
|
|
38
36
|
c.method('Create') do |m|
|
39
|
-
|
40
|
-
m.
|
41
|
-
m.
|
42
|
-
m.uri = "/people/:person_id/contacts"
|
37
|
+
m.synopsis = 'Record a contact for a person'
|
38
|
+
m.http_method = 'POST'
|
39
|
+
m.uri = '/people/:person_id/contacts'
|
43
40
|
|
44
41
|
m.parameter('person_id') do |p|
|
45
42
|
p.required = 'Y'
|
46
43
|
p.type = 'int'
|
47
|
-
p.description =
|
44
|
+
p.description = "the person's ID"
|
48
45
|
end
|
49
46
|
|
50
47
|
m.parameter('body') do |p|
|
@@ -52,18 +49,14 @@ class ApiSpec::Spec
|
|
52
49
|
p.type = 'json'
|
53
50
|
p.description = 'a JSON representation of the new contact'
|
54
51
|
end
|
55
|
-
|
56
52
|
end
|
57
|
-
|
58
53
|
end
|
59
54
|
|
60
55
|
endpoint 'Contact Types' do |c|
|
61
|
-
|
62
56
|
c.method('Index') do |m|
|
63
|
-
|
64
|
-
m.
|
65
|
-
m.
|
66
|
-
m.uri = "/settings/contact_types"
|
57
|
+
m.synopsis = 'Returns paginated list of nation-defined contact types'
|
58
|
+
m.http_method = 'GET'
|
59
|
+
m.uri = '/settings/contact_types'
|
67
60
|
|
68
61
|
m.parameter('__token') do |p|
|
69
62
|
p.required = 'N'
|
@@ -83,28 +76,24 @@ class ApiSpec::Spec
|
|
83
76
|
p.type = 'int'
|
84
77
|
p.description = 'maximum number of results to return'
|
85
78
|
end
|
86
|
-
|
87
79
|
end
|
88
80
|
|
89
81
|
c.method('Create') do |m|
|
90
|
-
|
91
|
-
m.
|
92
|
-
m.
|
93
|
-
m.uri = "/settings/contact_types"
|
82
|
+
m.synopsis = 'Creates a new contact type'
|
83
|
+
m.http_method = 'POST'
|
84
|
+
m.uri = '/settings/contact_types'
|
94
85
|
|
95
86
|
m.parameter('body') do |p|
|
96
87
|
p.required = 'Y'
|
97
88
|
p.type = 'json'
|
98
89
|
p.description = 'a JSON representation of the new contact type'
|
99
90
|
end
|
100
|
-
|
101
91
|
end
|
102
92
|
|
103
93
|
c.method('Update') do |m|
|
104
|
-
|
105
|
-
m.
|
106
|
-
m.
|
107
|
-
m.uri = "/settings/contact_types/:id"
|
94
|
+
m.synopsis = 'Updates an existing contact type'
|
95
|
+
m.http_method = 'PUT'
|
96
|
+
m.uri = '/settings/contact_types/:id'
|
108
97
|
|
109
98
|
m.parameter('id') do |p|
|
110
99
|
p.required = 'Y'
|
@@ -117,39 +106,30 @@ class ApiSpec::Spec
|
|
117
106
|
p.type = 'json'
|
118
107
|
p.description = 'a JSON representation of the updates to make'
|
119
108
|
end
|
120
|
-
|
121
109
|
end
|
122
110
|
|
123
111
|
c.method('Destroy') do |m|
|
124
|
-
|
125
|
-
m.
|
126
|
-
m.
|
127
|
-
m.uri = "/settings/contact_types/:id"
|
112
|
+
m.synopsis = 'Destroys a contact type'
|
113
|
+
m.http_method = 'DELETE'
|
114
|
+
m.uri = '/settings/contact_types/:id'
|
128
115
|
|
129
116
|
m.parameter('id') do |p|
|
130
117
|
p.required = 'Y'
|
131
118
|
p.type = 'int'
|
132
119
|
p.description = 'the ID of the existing contact type'
|
133
120
|
end
|
134
|
-
|
135
121
|
end
|
136
122
|
|
137
123
|
c.method('List Methods') do |m|
|
138
|
-
|
139
|
-
m.
|
140
|
-
m.
|
141
|
-
m.uri = "/settings/contact_methods"
|
142
|
-
|
124
|
+
m.synopsis = 'Lists all contact methods'
|
125
|
+
m.http_method = 'GET'
|
126
|
+
m.uri = '/settings/contact_methods'
|
143
127
|
end
|
144
128
|
|
145
129
|
c.method('List Statuses') do |m|
|
146
|
-
|
147
|
-
m.
|
148
|
-
m.
|
149
|
-
m.uri = "/settings/contact_statuses"
|
150
|
-
|
130
|
+
m.synopsis = 'Lists all contact status types'
|
131
|
+
m.http_method = 'GET'
|
132
|
+
m.uri = '/settings/contact_statuses'
|
151
133
|
end
|
152
|
-
|
153
134
|
end
|
154
|
-
|
155
135
|
end
|
@@ -3,9 +3,9 @@ class ApiSpec::Spec
|
|
3
3
|
endpoint 'Donations' do |donation|
|
4
4
|
|
5
5
|
donation.method('Index') do |method|
|
6
|
-
method.synopsis =
|
7
|
-
method.http_method =
|
8
|
-
method.uri =
|
6
|
+
method.synopsis = 'Returns a list of donations'
|
7
|
+
method.http_method = 'GET'
|
8
|
+
method.uri = '/donations'
|
9
9
|
|
10
10
|
method.parameter('__token') do |p|
|
11
11
|
p.required = 'N'
|
@@ -28,27 +28,27 @@ class ApiSpec::Spec
|
|
28
28
|
end
|
29
29
|
|
30
30
|
donation.method('Create') do |method|
|
31
|
-
method.synopsis =
|
32
|
-
method.http_method =
|
33
|
-
method.uri =
|
31
|
+
method.synopsis = 'Creates a donation with the provided data'
|
32
|
+
method.http_method = 'POST'
|
33
|
+
method.uri = '/donations'
|
34
34
|
|
35
35
|
method.parameter('body') do |p|
|
36
36
|
p.required = 'Y'
|
37
37
|
p.default = '{}'
|
38
38
|
p.type = 'json'
|
39
|
-
p.description = 'JSON representation of a donation'
|
39
|
+
p.description = 'a JSON representation of a donation'
|
40
40
|
end
|
41
41
|
end
|
42
42
|
|
43
43
|
donation.method('Update') do |method|
|
44
|
-
method.synopsis =
|
45
|
-
method.http_method =
|
46
|
-
method.uri =
|
44
|
+
method.synopsis = 'Updates a donation with the provided data'
|
45
|
+
method.http_method = 'PUT'
|
46
|
+
method.uri = '/donations/:id'
|
47
47
|
|
48
48
|
method.parameter('id') do |p|
|
49
49
|
p.required = 'Y'
|
50
50
|
p.type = 'int'
|
51
|
-
p.description = "
|
51
|
+
p.description = "the donation's ID"
|
52
52
|
end
|
53
53
|
|
54
54
|
method.parameter('body') do |p|
|
@@ -60,17 +60,15 @@ class ApiSpec::Spec
|
|
60
60
|
end
|
61
61
|
|
62
62
|
donation.method('Destroy') do |method|
|
63
|
-
method.synopsis =
|
64
|
-
method.http_method =
|
65
|
-
method.uri =
|
63
|
+
method.synopsis = 'Removes the donation with the matching ID'
|
64
|
+
method.http_method = 'DELETE'
|
65
|
+
method.uri = '/donations/:id'
|
66
66
|
|
67
67
|
method.parameter('id') do |p|
|
68
68
|
p.required = 'Y'
|
69
69
|
p.type = 'int'
|
70
|
-
p.description = "
|
70
|
+
p.description = "the donation's ID"
|
71
71
|
end
|
72
72
|
end
|
73
|
-
|
74
73
|
end
|
75
|
-
|
76
74
|
end
|