nationbuilder-rb 1.3.2 → 1.3.3

data/lib/api_spec/lib/api_spec/specs/people_tags.rb

@@ -0,0 +1,63 @@
+class ApiSpec::Spec
+
+  endpoint 'People Tags' do |tags|
+
+    tags.method('Index') do |method|
+      method.synopsis = "Returns a list of previously used tags"
+      method.http_method = "GET"
+      method.uri = "/tags"
+
+      method.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      method.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      method.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+    end
+
+    tags.method('People') do |method|
+      method.synopsis = "Searches for people with the given tag"
+      method.http_method = "GET"
+      method.uri = "/tags/:tag/people"
+
+      method.parameter('tag') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the name of the tag'
+      end
+
+      method.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      method.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      method.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/precincts.rb

@@ -0,0 +1,89 @@
+class ApiSpec::Spec
+
+  endpoint 'Precincts' do |precinct|
+
+    precinct.method('Index') do |method|
+      method.synopsis = "Returns a list of current precincts"
+      method.http_method = "GET"
+      method.uri = "/precincts"
+
+      method.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      method.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      method.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+    end
+
+    precinct.method('Show') do |method|
+      method.synopsis = "Returns a representation of the precinct"
+      method.http_method = "GET"
+      method.uri = "/precincts/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.default = '1'
+        p.type = 'int'
+        p.description = "the precinct's id"
+      end
+    end
+
+    precinct.method('Create') do |method|
+      method.synopsis = "Creates a precinct with the provided data"
+      method.http_method = "POST"
+      method.uri = "/precincts"
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON representation of the precinct to create'
+      end
+    end
+
+    precinct.method('Update') do |method|
+      method.synopsis = "Updates a precinct with the provided data"
+      method.http_method = "PUT"
+      method.uri = "/precincts/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The precinct's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON attributes for updating the precinct'
+      end
+    end
+
+    precinct.method('Destroy') do |method|
+      method.synopsis = "Removes the precinct with the matching ID"
+      method.http_method = "DELETE"
+      method.uri = "/precincts/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The precinct's ID"
+      end
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/sites.rb

@@ -0,0 +1,32 @@
+class ApiSpec::Spec
+
+  endpoint 'Sites' do |tags|
+
+    tags.method('Index') do |method|
+      method.synopsis = "Returns a list of all sites"
+      method.http_method = "GET"
+      method.uri = "/sites"
+
+      method.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      method.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      method.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/survey_responses.rb

@@ -0,0 +1,64 @@
+class ApiSpec::Spec
+
+  endpoint 'Survey Responses' do |surveys|
+
+    surveys.method('Index') do |m|
+
+      m.synopsis = "Lists all survey responses"
+      m.http_method = "GET"
+      m.uri = "/survey_responses"
+
+      m.parameter('start_time') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'the starting time for results'
+      end
+
+      m.parameter('end_time') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'the ending time for results'
+      end
+
+      m.parameter('survey_id') do |p|
+        p.required = 'N'
+        p.type = 'int'
+        p.description = 'the id for a parent survey'
+      end
+
+      m.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      m.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      m.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+
+    end
+
+    surveys.method('Create') do |m|
+      m.synopsis = "Creates responses for a survey"
+      m.http_method = "POST"
+      m.uri = "/survey_responses"
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the survey responses'
+      end
+    end
+  end
+
+
+end

data/lib/api_spec/lib/api_spec/specs/surveys.rb

@@ -0,0 +1,106 @@
+class ApiSpec::Spec
+
+  endpoint 'Surveys' do |surveys|
+
+    surveys.method('Index') do |m|
+
+      m.synopsis = "Shows a list of all surveys for the a site"
+      m.http_method = "GET"
+      m.uri = "/sites/:site_slug/pages/surveys"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the survey'
+      end
+
+      m.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      m.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      m.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+
+    end
+
+    surveys.method('Create') do |m|
+
+      m.synopsis = "Creates a survey for a site"
+      m.http_method = "POST"
+      m.uri = "/sites/:site_slug/pages/surveys"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the survey'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new survey'
+      end
+
+    end
+
+    surveys.method('Update') do |m|
+
+      m.synopsis = "Updates the attributes of a survey"
+      m.http_method = "PUT"
+      m.uri = "/sites/:site_slug/pages/surveys/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the survey'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the survey'
+      end
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'JSON containing updates'
+      end
+
+    end
+
+    surveys.method('Destroy') do |m|
+
+      m.synopsis = "Removes a survey"
+      m.http_method = "DELETE"
+      m.uri = "/sites/:site_slug/pages/surveys/:id"
+
+      m.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the survey'
+      end
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the survey'
+      end
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/webhooks.rb

@@ -0,0 +1,75 @@
+class ApiSpec::Spec
+
+  endpoint 'Webhooks' do |surveys|
+
+    surveys.method('Index') do |m|
+
+      m.synopsis = "Lists all webhooks"
+      m.http_method = "GET"
+      m.uri = "/webhooks"
+
+      m.parameter('__token') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination token'
+      end
+
+      m.parameter('__nonce') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'pagination nonce'
+      end
+
+      m.parameter('limit') do |p|
+        p.required = 'N'
+        p.default = '10'
+        p.type = 'int'
+        p.description = 'maximum number of results to return'
+      end
+
+    end
+
+    surveys.method('Show') do |m|
+
+      m.synopsis = "Shows the details of an individual webhook"
+      m.http_method = "GET"
+      m.uri = "/webhooks/:id"
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the ID of the webhook to display'
+      end
+
+    end
+
+    surveys.method('Create') do |m|
+      m.synopsis = "Creates a new webhook"
+      m.http_method = "POST"
+      m.uri = "/webhooks"
+
+      m.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'a JSON representation of the new webhook'
+      end
+    end
+
+    surveys.method('Destroy') do |m|
+
+      m.synopsis = "Destroys a webhook"
+      m.http_method = "DELETE"
+      m.uri = "/webhooks/:id"
+
+      m.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID a webhook'
+      end
+
+    end
+
+  end
+
+
+end

data/lib/{nationbuilder/api_spec.json → api_spec/spec.json}

@@ -1757,28 +1757,28 @@
               "Required": "N",
               "Default": null,
               "Type": "string",
-              "Description": null
+              "Description": "deprecated"
             },
             {
               "Name": "last_name",
               "Required": "N",
               "Default": null,
               "Type": "string",
-              "Description": null
+              "Description": "deprecated"
             },
             {
               "Name": "phone",
               "Required": "N",
               "Default": null,
               "Type": "string",
-              "Description": null
+              "Description": "deprecated"
             },
             {
               "Name": "mobile",
               "Required": "N",
               "Default": null,
               "Type": "string",
-              "Description": null
+              "Description": "deprecated"
             }
           ]
         },
@@ -2252,6 +2252,21 @@
             }
           ]
         },
+        {
+          "MethodName": "Add",
+          "Synopsis": "Updates a matched person (without overriding data) or creates a new one if the person doesn't exist",
+          "HTTPMethod": "PUT",
+          "URI": "/people/add",
+          "parameters": [
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": "{}",
+              "Type": "json",
+              "Description": "JSON attributes for updating/matching the person"
+            }
+          ]
+        },
         {
           "MethodName": "Destroy",
           "Synopsis": "Removes the person with the matching ID",
@@ -2266,6 +2281,28 @@
               "Description": "The person's ID"
             }
           ]
+        },
+        {
+          "MethodName": "Private Note Create",
+          "Synopsis": "Creates a private note for the given person",
+          "HTTPMethod": "POST",
+          "URI": "/people/:id/notes",
+          "parameters": [
+            {
+              "Name": "id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "the ID of the person"
+            },
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": null,
+              "Type": "json",
+              "Description": "JSON representation of the note to create"
+            }
+          ]
         }
       ]
     },
@@ -2339,6 +2376,107 @@
         }
       ]
     },
+    {
+      "name": "Precincts",
+      "methods": [
+        {
+          "MethodName": "Index",
+          "Synopsis": "Returns a list of current precincts",
+          "HTTPMethod": "GET",
+          "URI": "/precincts",
+          "parameters": [
+            {
+              "Name": "__token",
+              "Required": "N",
+              "Default": null,
+              "Type": "string",
+              "Description": "pagination token"
+            },
+            {
+              "Name": "__nonce",
+              "Required": "N",
+              "Default": null,
+              "Type": "string",
+              "Description": "pagination nonce"
+            },
+            {
+              "Name": "limit",
+              "Required": "N",
+              "Default": "10",
+              "Type": "int",
+              "Description": "maximum number of results to return"
+            }
+          ]
+        },
+        {
+          "MethodName": "Show",
+          "Synopsis": "Returns a representation of the precinct",
+          "HTTPMethod": "GET",
+          "URI": "/precincts/:id",
+          "parameters": [
+            {
+              "Name": "id",
+              "Required": "Y",
+              "Default": "1",
+              "Type": "int",
+              "Description": "the precinct's id"
+            }
+          ]
+        },
+        {
+          "MethodName": "Create",
+          "Synopsis": "Creates a precinct with the provided data",
+          "HTTPMethod": "POST",
+          "URI": "/precincts",
+          "parameters": [
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": "{}",
+              "Type": "json",
+              "Description": "JSON representation of the precinct to create"
+            }
+          ]
+        },
+        {
+          "MethodName": "Update",
+          "Synopsis": "Updates a precinct with the provided data",
+          "HTTPMethod": "PUT",
+          "URI": "/precincts/:id",
+          "parameters": [
+            {
+              "Name": "id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The precinct's ID"
+            },
+            {
+              "Name": "body",
+              "Required": "Y",
+              "Default": "{}",
+              "Type": "json",
+              "Description": "JSON attributes for updating the precinct"
+            }
+          ]
+        },
+        {
+          "MethodName": "Destroy",
+          "Synopsis": "Removes the precinct with the matching ID",
+          "HTTPMethod": "DELETE",
+          "URI": "/precincts/:id",
+          "parameters": [
+            {
+              "Name": "id",
+              "Required": "Y",
+              "Default": null,
+              "Type": "int",
+              "Description": "The precinct's ID"
+            }
+          ]
+        }
+      ]
+    },
     {
       "name": "Sites",
       "methods": [
@@ -2637,4 +2775,4 @@
       ]
     }
   ]
-}
+}