nationbuilder-rb 1.3.2 → 1.3.3

data/lib/api_spec/lib/api_spec/specs/events.rb

@@ -0,0 +1,238 @@
+class ApiSpec::Spec
+
+  endpoint 'Events' do |event|
+
+    event.method('Index') do |method|
+      method.synopsis = "Returns a list of events"
+      method.http_method = "GET"
+      method.uri = "/sites/:site_slug/pages/events"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      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
+
+      method.parameter('tags') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'tags that must be present on the event'
+      end
+
+      method.parameter('starting') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'earliest starting time'
+      end
+
+      method.parameter('until') do |p|
+        p.required = 'N'
+        p.type = 'string'
+        p.description = 'latest ending time'
+      end
+
+      method.parameter('calendar_id') do |p|
+        p.required = 'N'
+        p.type = 'int'
+        p.description = 'the ID of the calendar from which events should be scoped'
+      end
+
+    end
+
+    event.method('Show') do |method|
+      method.synopsis = "Returns an event"
+      method.http_method = "GET"
+      method.uri = "/sites/:site_slug/pages/events/:id"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the event'
+      end
+
+    end
+
+    event.method('Create') do |method|
+      method.synopsis = "Creates a event with the provided data"
+      method.http_method = "POST"
+      method.uri = "/sites/:site_slug/pages/events"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON representation of a event'
+      end
+    end
+
+    event.method('Update') do |method|
+      method.synopsis = "Updates a event with the provided data"
+      method.http_method = "PUT"
+      method.uri = "/sites/:site_slug/pages/events/:id"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The event's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON attributes for updating the event'
+      end
+    end
+
+    event.method('Destroy') do |method|
+      method.synopsis = "Removes the event with the matching ID"
+      method.http_method = "DELETE"
+      method.uri = "/sites/:site_slug/pages/events/:id"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The event's ID"
+      end
+    end
+
+    event.method('RSVPs') do |method|
+      method.synopsis = "Lists all RSVPs for an event"
+      method.http_method = "GET"
+      method.uri = "/sites/:site_slug/pages/events/:id/rsvps"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The event's ID"
+      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
+
+    event.method('RSVP Create') do |method|
+      method.synopsis = "Creates an RSVP for an event"
+      method.http_method = "POST"
+      method.uri = "/sites/:site_slug/pages/events/:id/rsvps"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The event's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'A JSON representation of the new post'
+      end
+
+    end
+
+    event.method('RSVP Update') do |method|
+      method.synopsis = "Updates an existing RSVP"
+      method.http_method = "PUT"
+      method.uri = "/sites/:site_slug/pages/events/:event_id/rsvps/:rsvp_id"
+
+      method.parameter('site_slug') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'the site holding the event'
+      end
+
+      method.parameter('event_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The event's ID"
+      end
+
+      method.parameter('rsvp_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The RSVP's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'JSON attributes for updating the RSVP'
+      end
+
+    end
+
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/exports.rb

@@ -0,0 +1,42 @@
+class ApiSpec::Spec
+
+  endpoint 'Exports' do |export|
+
+    export.method('Create List') do |method|
+      method.synopsis = "Creates a list export with the provided data"
+      method.http_method = "POST"
+      method.uri = "/list/:list_id/exports"
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'JSON representation of the export'
+      end
+    end
+
+    export.method('Show') do |method|
+      method.synopsis = "Shows the status of a list export."
+      method.http_method = "GET"
+      method.uri = "/exports/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the export'
+      end
+    end
+
+    export.method('Delete') do |method|
+      method.synopsis = "Delete the export"
+      method.http_method = "DELETE"
+      method.uri = "/exports/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the export'
+      end
+    end
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/imports.rb

@@ -0,0 +1,43 @@
+class ApiSpec::Spec
+
+  endpoint 'Imports' do |import|
+
+    import.method('Show') do |method|
+      method.synopsis = "Shows the status of an import"
+      method.http_method = "GET"
+      method.uri = "/imports/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the import'
+      end
+
+    end
+
+    import.method('Create') do |method|
+      method.synopsis = "Creates a import with the provided data"
+      method.http_method = "POST"
+      method.uri = "/imports"
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'JSON representation of the import'
+      end
+    end
+
+    import.method('Result') do |method|
+      method.synopsis = "Gets the import results and error csv file."
+      method.http_method = "GET"
+      method.uri = "/imports/:id/result"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'the ID of the import'
+      end
+    end
+  end
+
+end

data/lib/api_spec/lib/api_spec/specs/lists.rb

@@ -0,0 +1,215 @@
+class ApiSpec::Spec
+
+  endpoint 'Lists' do |lists|
+
+    lists.method('Index') do |method|
+      method.synopsis = "Returns a list of created custom lists"
+      method.http_method = "GET"
+      method.uri = "/lists"
+
+      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
+
+    lists.method('People') do |method|
+      method.synopsis = "Returns people stored in a list"
+      method.http_method = "GET"
+      method.uri = "/lists/:id/people"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The list's ID"
+      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
+
+    lists.method('Create') do |method|
+      method.synopsis = "Creates a list with the provided data"
+      method.http_method = "POST"
+      method.uri = "/lists"
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON representation of the list to create'
+      end
+    end
+
+    lists.method('Update') do |method|
+      method.synopsis = "Updates a list with the provided data"
+      method.http_method = "PUT"
+      method.uri = "/lists/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The list's ID"
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.default = '{}'
+        p.type = 'json'
+        p.description = 'JSON attributes for updating the list'
+      end
+    end
+
+    lists.method('Destroy') do |method|
+      method.synopsis = "Removes the list with the matching ID"
+      method.http_method = "DELETE"
+      method.uri = "/lists/:id"
+
+      method.parameter('id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = "The list's ID"
+      end
+    end
+
+    lists.method('Add people') do |method|
+      method.synopsis = "Adds people to a list"
+      method.http_method = "POST"
+      method.uri = "/lists/:list_id/people"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'A JSON hash containing the people to add to the list'
+      end
+    end
+
+    lists.method('Destroy people') do |method|
+      method.synopsis = "Removes people from a list"
+      method.http_method = "DELETE"
+      method.uri = "/lists/:list_id/people"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('body') do |p|
+        p.required = 'Y'
+        p.type = 'json'
+        p.description = 'A JSON hash containing the people to remove from the list'
+      end
+    end
+
+    lists.method('Listing Create (deprecated)') do |method|
+      method.synopsis = "Adds a person to a list"
+      method.http_method = "POST"
+      method.uri = "/lists/:list_id/listings"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('person_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the person to add to the list'
+      end
+    end
+
+    lists.method('Listing Deletion (deprecated)') do |method|
+      method.synopsis = "Drops a person from a list"
+      method.http_method = "DELETE"
+      method.uri = "/lists/:list_id/listings/:person_id"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('person_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the person to drop from the list'
+      end
+    end
+
+    lists.method('Add tag') do |method|
+      method.synopsis = "Adds a tag to all of the list members"
+      method.http_method = "POST"
+      method.uri = "/lists/:list_id/tag/:tag"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('tag') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'The name of the tag to use'
+      end
+    end
+
+    lists.method('Delete tag') do |method|
+      method.synopsis = "Deletes the tag from all of the list members"
+      method.http_method = "DELETE"
+      method.uri = "/lists/:list_id/tag/:tag"
+
+      method.parameter('list_id') do |p|
+        p.required = 'Y'
+        p.type = 'int'
+        p.description = 'The ID of the list'
+      end
+
+      method.parameter('tag') do |p|
+        p.required = 'Y'
+        p.type = 'string'
+        p.description = 'The name of the tag to use'
+      end
+    end
+
+  end
+
+end