figshare_api_v2 0.9.1

data/lib/private_collections.rb

@@ -0,0 +1,324 @@
+module Figshare
+
+  # Figshare Private Collections API
+  #
+  class PrivateCollections < Base
+  
+    # Requests a list of own (or institute's) collections
+    #
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @param order_direction [String] "desc" Default, "asc"
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, title, doi, handle, url, published_date}
+    def list(order: 'published_date', order_direction: 'desc', impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['order'] = order if ! order.nil?
+      args['order_direction'] = order_direction if ! order_direction.nil?
+      get_paginate(api_query: 'account/collections', args: args, &block)
+    end
+
+    # Search within the own (or institute's) collections
+    #
+    # @param institution [Boolean] Just our institution
+    # @param group_id [Integer] Only return this group's collections
+    # @param published_since [Time] Return results if published after this time
+    # @param modified_since [Time] Return results if modified after this time
+    # @param resource_doi [String] Matches this resource doi
+    # @param doi [String] Matches this doi
+    # @param handle [String] Matches this handle
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @param order_direction [String] "desc" Default, "asc"
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, title, doi, handle, url, published_date}
+    def search(institute: false, group_id: nil, impersonate: nil, 
+                              published_since: nil, modified_since: nil, 
+                              resource_doi: nil, doi: nil, handle: nil,  
+                              order: 'published_date', order_direction: 'desc',
+                              search_for:,
+                              &block
+                             )
+      args = { 'search_for' => search_for }
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['institution'] = @institute_id if ! institute.nil?
+      args['group_id'] = group_id if ! group_id.nil?
+      args['resource_doi'] = resource_doi if ! resource_doi.nil?
+      args['doi'] = doi if ! doi.nil?
+      args['handle'] = handle if ! handle.nil?
+      args['published_since'] = published_since if ! published_since.nil?
+      args['modified_since'] = modified_since if ! modified_since.nil?
+      args['order'] = order if ! order.nil?
+      args['order_direction'] = order_direction if ! order_direction.nil?
+      post(api_query: 'account/collections/search', args: args, &block)
+    end
+  
+    # Create a new private Collection by sending collection information
+    #
+    # @param body [Hash] See Figshare API docs
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def create(body:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/collections", args: args, data: body, &block)
+    end
+
+    # Delete a private collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def collection_delete(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete( api_query: "account/collections/#{collection_id}/files/#{file_id}", args: args, &block )
+    end
+
+    # Return details of specific collection (default version)
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See figshare api docs
+    def detail(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/collections/#{collection_id}", args: args, &block)
+    end
+  
+    # Create a new private Collection by sending collection information
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param body [Hash] See Figshare API docs
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def update(collection_id:, body:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/collections", args: args, data: body, &block)
+    end  
+    
+    # Reserve DOI for collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { doi }
+    def reserve_doi(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: 'account/collections/#{collection_id}/reserve_doi', args: args, &block)
+    end
+
+    # Reserve Handle for collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { handle }
+    def reserve_handle(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: 'account/collections/#{collection_id}/reserve_handle', args: args, &block)
+    end
+
+    # When a collection is published, a new public version will be generated. 
+    # Any further updates to the collection will affect the private collection data. 
+    # In order to make these changes publicly visible, an explicit publish operation is needed.
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def publish(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: 'account/collections/#{collection_id}/publish', args: args, &block)
+    end
+
+    # Yield collections authors
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, full_name, is_active, url_name, orcid_id}
+    def authors(article_id, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/collections/#{collection_id}/authors", args: args, &block)
+    end
+
+    # Associate new authors with the collection. This will add new authors to the list of already associated authors
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param authors [Array] Can be a mix of { id } and/or { name }
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def authors_add(article_id, impersonate: nil, authors:)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/authors", args: args, data: {"authors" => authors}, &block)
+    end
+    
+    # Replace existing authors list with a new list
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param authors [Array] Can be a mix of { id } and/or { name }
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def authors_replace(article_id, impersonate: nil, authors:)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/collections/#{collection_id}/authors", args: args, data: {"authors" => authors}, &block)
+    end
+    
+    # Remove author from the collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param author_id [Integer] Figshare id for the author
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def author_delete(collection_id:, impersonate: nil, author_id:)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/collections/#{collection_id}/authors/#{author_id}", args: args, &block)
+    end
+  
+    # Yield collection categories
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {parent_id, id, title}
+    def categories(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: 'account/collections/#{collection_id}/categories', args: args, &block)
+    end
+    
+    # Associate new categories with the collection. 
+    # This will add new categories to the list of already associated categories
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param categories [Array] [ categorie_id, ... ]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def categories_add(collection_id:, categories:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/categories", args: args, data: { 'categories' => categories }, &block)
+    end
+
+    # Associate new categories with the collection. This will remove all already associated categories and add these new ones
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param categories [Array] [ categorie_id, ... ]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def categories_replace(collection_id:, categories:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/collections/#{collection_id}/categories", args: args, data: { 'categories' => categories }, &block)
+    end
+
+    #  Delete category from collection's categories
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param category_id [Integer] Figshare id of the category
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def categories_delete(collection_id:, category_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/collections/#{collection_id}/categories/#{category_id}", args: args, &block)
+    end
+
+    # Yield collection articles
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See Figshare API docs
+    def articles(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/collections/#{collection_id}/articles", args: args, &block)
+    end
+  
+    # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
+    #
+    # @param article_id [Integer] Figshare id of the article
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def article_detail(article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/articles/#{article_id}", args: args, &block)
+    end
+
+    # Associate new articles with the collection. This will add new articles to the list of already associated articles
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param articles [Array] array of Figshare article ids
+ # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def articles_add(collection_id:, articles: , impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, data: { "articles": articles}, &block)
+    end
+    
+    # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param articles [Array] array of Figshare article ids
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def articles_replace(collection_id:, articles:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, data: { "articles": articles}, &block)
+    end
+    
+    # Get a private article's details (Not a figshare API call. Duplicates PrivateArticles:article_detail)
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param article_id [Integer] Figshare id of the article
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def article_delete(collection_id:, article_id: , impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete( api_query: "account/collections/#{collection_id}/articles/#{article_id}", args: args, &block)
+    end
+    
+    # List private links
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, is_active, expires_date}
+    def links(collection_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/collections/#{collection_id}/private_links", args: args, &block)
+    end
+  
+    # Create new private link for this collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param private_link [Hash] { expires_date, read_only }
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def link_create(collection_id:, private_link:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/collections/#{collection_id}/private_links", args: args, data: private_link, &block)
+    end
+
+    # Disable/delete private link for this collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param link_id [Integer] 
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def link_delete(collection_id:, link:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/collections/#{collection_id}/private_links/#{link_id}", args: args, &block)
+    end
+  
+    # Update private link for this collection
+    #
+    # @param collection_id [Integer] Figshare id of the collection
+    # @param private_link [Hash] { expires_date, read_only }
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def link_update(collection_id:, link_id:, private_link:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/collections/#{collection_id}/private_links/#{link_id}", args: args, data: private_link, &block)
+    end
+    
+  end
+end

data/lib/private_projects.rb

@@ -0,0 +1,308 @@
+module Figshare
+
+  # Figshare private project api
+  #
+  class PrivateProjects < Base
+    # Requests a list private projects
+    #
+    # @param storage [String] group, individual (only return collections from this institution)
+    # @param roles [String] Any combination of owner, collaborator, viewer separated by comma. Examples: "owner" or "owner,collaborator".
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @param order_direction [String] "desc" Default, "asc"
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {role, storage, url, published_date, id, title}
+    def list(storage: nil, roles: nil, order: 'published_date', order_direction: 'desc', impersonate: nil, &block)
+      args = {}
+      args['storage'] = storage if ! storage.nil?
+      args['roles'] = roles if ! roles.nil?
+      args['order'] = order if ! order.nil?
+      args['order_direction'] = order_direction if ! order_direction.nil?
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get_paginate(api_query: 'account/projects', args: args, &block)
+    end
+
+    # Search within the own (or institute's) projects
+    #
+    # @param institution [Boolean] Just our institution
+    # @param group_id [Integer] Only return this group's project
+    # @param published_since [Time] Return results if published after this time
+    # @param modified_since [Time] Return results if modified after this time
+    # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
+    # @param order_direction [String] "desc" Default, "asc"
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, title, doi, handle, url, published_date}
+    def search(institute: false, group_id: nil, impersonate: nil, 
+                        published_since: nil, modified_since: nil, 
+                        order: 'published_date', order_direction: 'desc',
+                        search_for:,
+                        &block
+                       )
+      args = { 'search_for' => search_for }
+      args['institution'] = @institute_id if ! institute.nil?
+      args['group'] = group_id if ! group_id.nil?
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      args['published_since'] = published_since if ! published_since.nil?
+      args['modified_since'] = modified_since if ! modified_since.nil?
+      args['order'] = order if ! order.nil?
+      args['order_direction'] = order_direction if ! order_direction.nil?
+      post(api_query: 'account/projects/search', args: args, &block)
+    end
+
+    # Create a new project
+    #
+    # @param title [String]
+    # @param description [String]
+    # @param funding [String]
+    # @param funding_list [Array] [{id, title}, ... ]
+    # #param group_id [Integer] Figshare group the project falls under.
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def create(title:, description:, funding: '', funding_list: [], group_id:, impersonate: nil, &block)
+      args = { "title" => title, 
+               "description" => description, 
+               "group_id" => group_id,
+               "funding" => funding,
+               "funding_list" => funding_list
+             }
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: 'account/projects', args: args, &block)
+    end
+    
+    # Delete an existing project
+    #
+    # @param project_id [Integer] Figshare project ID
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def project_delete(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: 'account/projects/#{project_id}', args: args, &block)
+    end
+    
+    # Return details of specific private project
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See figshare api docs
+    def detail(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/projects/#{project_id}",  args: args, &block)
+    end
+
+    # Update an existing project
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    # @param title [String]
+    # @param description [String]
+    # @param funding [String]
+    # @param funding_list [Array] [{id, title}, ... ]
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def update(project_id:, title: nil, description: nil, funding: nil, funding_list: nil, impersonate: nil, &block)
+      args = {}
+      args["title"] = title if ! title.nil? 
+      args["description"] = description if ! description.nil? 
+      args["funding"] = funding if ! funding.nil? 
+      args["funding_list"] = funding_list if ! funding_list.nil? 
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/projects/#{project_id}", args: args, &block)
+    end
+    
+    # Publish a project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] Message
+    def publish(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/projects/#{project_id}/publish", args: args, &block)
+    end
+    
+    # List projects notes
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] {id, user_id, abstract, user_name, created_date, modified_date}
+    def notes(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get_paginate(api_query: "account/projects/#{project_id}/notes", args: args, &block)
+    end
+    
+    # Create a project note
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param text [String] The note
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def note_create(project_id:, text:, impersonate: nil, &block)
+      args = { 'text' => text }
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/projects/#{project_id}/notes", args: args, &block)
+    end
+    
+    # Delete a project note
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param note_id [Integer] Figshare id of the note
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def note_delete(project_id:, note_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
+    end
+    
+    # Get a note's text
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param note_id [Integer] Figshare id of the note
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { text }
+    def note_detail(impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
+    end
+    
+    # update a project note
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param note_id [Integer] Figshare id of the note
+    # @param text [String] The note
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def note_create(project_id:, note_id:, text:, impersonate: nil, &block)
+      args = { 'text' => text }
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      put(api_query: "account/projects/#{project_id}/notes/#{note_id}", args: args, &block)
+    end
+    
+    # Leave a project (Please note: project's owner cannot leave the project.)
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    def private_project_collaborators_leave(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      post(api_query: "account/projects/#{project_id}/leave", args: args, &block)
+    end
+    
+    # Get the project collaborators
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { status, role_name, user_id, name }
+    def collaborators(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/projects/#{project_id}/collaborators", args: args, &block)
+    end
+    
+    # Invite a new collaborators to the project
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    # @param role_name [String]
+    # @param user_id [Integer] Need user_id or email
+    # @param email [String] Used, if user_id is nil
+    # @param comment [String]
+    # @yield [String] { message }
+    def collaborator_invite(project_id:, role_name:, user_id: nil, email: nil, comment:, impersonate: nil, &block)
+      args = {
+        'role_name' => role_name,
+        'comment' => comment
+      }
+      if ! user_id.nil?
+        args['user_id'] = user_id
+      elsif ! email.nil?
+        args['email'] = email
+      else
+        raise "collaborator_invite(): Need a user_id or an email address" 
+      end
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      collaborator = { "role_name" => role_name, "user_id" => user_id, "email" => email, "comment" => comment }
+      post(api_query: "account/project/#{project_id}/collaborators", args: args, data: collaborator, &block)
+    end
+    
+    # Leave a project (Please note: project's owner cannot leave the project.)
+    #
+    # @param project_id [Integer] Figshare id of the project_id
+    # @param user_id [Integer] Figshare id of a user in the project
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def collaborator_remove(project_id:, user_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/project/#{project_id}/collaborators/#{user_id}", args: args, &block)
+    end
+    
+    # Return details of list of articles for a specific project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See Figshare API Doc
+    def articles(project_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get_paginate(api_query: "account/projects/#{project_id}/articles", args: args, &block)
+    end
+    
+    # Create a new Article and associate it with this project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param article [Hash] See figshare API docs
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] { location }
+    def article_create(project_id:, article:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      # Figshare Docs say this should be post_paginate, but that makes no sense. Will have to test
+      post_paginate(api_query: "account/projects/#{project_id}/articles", args: args, &block)
+    end
+    
+    # delete an article from a project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param article_id [Integer] Figshare id of the article
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def article_delete(project_id:, article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/projects/#{project_id}/articles/#{article_id}", args: args, &block)
+    end
+    
+    # Get the details of an artilcle in a project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param article_id [Integer] Figshare id of the article
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See Fishare API docs for article hash
+    def article_detail(project_id:, article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/projects/#{project_id}/articles/#{article_id}", args: args, &block)
+    end
+    
+    # Get the files associated with an artilcle in a project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param article_id [Integer] Figshare id of the article
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    # @yield [Hash] See Fishare API docs for article hash
+    def artilce_files(project_id:, article_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      get(api_query: "account/projects/#{project_id}/articles/#{article_id}/files", args: args, &block)
+    end
+    
+    # Get the files associated with an artilcle in a project
+    #
+    # @param project_id [Integer] Figshare id of the project
+    # @param article_id [Integer] Figshare id of the article
+    # @param file_id [Integer] Figshare id of the file
+    # @param impersonate [Integer] Figshare account_id of the user we are making this call on behalf of
+    def artilce_file_detail(project_id:, article_id:, file_id:, impersonate: nil, &block)
+      args = {}
+      args["impersonate"] = impersonate  if ! impersonate.nil?
+      delete(api_query: "account/projects/#{project_id}/articles/#{article_id}/files/#{file_id}", args: args, &block)
+    end
+    
+  end # End of class
+end # End of Module