module DocumentCloud::API::UpdateProject

Constants

PROJECT_PATH

Public Instance Methods

update_project(id, options={}) click to toggle source

update a project

@see www.documentcloud.org/help/api @param id [String] The project id @param options [Hash] Customizable set of options @param options [String] :title The document's canonical title @param options [String] :description A paragraph of detailed description @param options [Array] :document_ids A list of documents that the project contains, by id @returns [DocumentCloud::Project] The project created

# File lib/document_cloud/api/update_project.rb, line 16
def update_project(id, options={})
  build_object(DocumentCloud::Project, put(project_path(id), options))
end

Private Instance Methods

project_path(project_id) click to toggle source
# File lib/document_cloud/api/update_project.rb, line 22
def project_path(project_id)
  "#{PROJECT_PATH}/#{project_id.to_i}.json"
end