Module: DocumentCloud::API::UpdateProject

Includes:
Utils
Included in:
Client
Defined in:
lib/document_cloud/api/update_project.rb

Constant Summary collapse

PROJECT_PATH = 
"/projects"

Instance Method Summary collapse

Methods included from Utils

#build_object, #build_objects, #parse_json

Instance Method Details

#update_project(id, options = {}) ⇒ Object

update a project

Parameters:

  • id (String) —

    The project id

  • options (Hash) (defaults to: {}) —

    Customizable set of options

  • options (String) (defaults to: {}) —

    :title The document’s canonical title

  • options (String) (defaults to: {}) —

    :description A paragraph of detailed description

  • options (Array) (defaults to: {}) —

    :document_ids A list of documents that the project contains, by id

See Also:



16
17
18
 
# 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