figshare_api_v2 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba08b7f752c1c00d25110a9a35fd774b3f69bd6b6fa902c3bc34f5adb8cb389f
-  data.tar.gz: f8598846eb851fef23c50a8b5e4538cb568bef5f21be3d2ae927509a7230f8da
+  metadata.gz: 5a59303e131674b6b915f07bf0e0aa317a3d5d594c8e87586fe273d8ed83697d
+  data.tar.gz: b8bdb004509e69e295b110f60f98ac6da83ea2ea3c5d2bf72e9d46ec041d274a
 SHA512:
-  metadata.gz: b005326e07fe1bcbceb20e87b238ae252afaa27dcdf38c6ba0865277510c077446449bc18d0e86652dbe2125bb22795ec39a2bbf659879d2a0b0c3d6cc494c89
-  data.tar.gz: 5814325e0b0ac251024a5487276a0f972fae33e84ab74bf2fe7f91ed74e4b25ef1f19c2e2baa85e158f758be7a4f8a9fb3df4a3db8c90075c7cbb81bf0a2b1dd
+  metadata.gz: ebdcee71baa8b80d0c434c9c041255a8843c897574c00725c60c288670854c0d3bce3e404805f03201951b981148ea8bfc49acf465b686af75cabd2bd47655f9
+  data.tar.gz: 5cdd11942289e5cb75e4e09afd730ebd12209b161fc68221aa5dadc347a90fc04370d9af464c419b69ed7cb794097254d796cd318ffc9957402cd3736728328b

data/History.txt

@@ -1,3 +1,47 @@
+robertburrowes	Tue May 10 10:42:27 2022 +1200
+	Comment
+robertburrowes	Tue May 10 10:40:02 2022 +1200
+	Left out the pagination args
+robertburrowes	Tue May 10 10:27:57 2022 +1200
+	API changes
+robertburrowes	Tue May 10 10:21:39 2022 +1200
+	API changes
+robertburrowes	Tue May 10 10:11:50 2022 +1200
+	API changes Added missed &block
+robertburrowes	Tue May 10 09:27:50 2022 +1200
+	Api changes
+robertburrowes	Tue May 10 09:27:27 2022 +1200
+	Missed adding _paginate
+robertburrowes	Tue May 10 09:26:58 2022 +1200
+	Use offset for paginatioon, if only the offset is passed in.
+robertburrowes	Mon May 9 17:06:07 2022 +1200
+	Add an HTML PATCH wrapper
+robertburrowes	Mon May 9 16:57:06 2022 +1200
+	Readme update
+robertburrowes	Mon May 9 16:54:56 2022 +1200
+	Bump version for new Figshare APIs.
+robertburrowes	Mon May 9 16:53:27 2022 +1200
+	API changes Fixed URL collection article
+robertburrowes	Mon May 9 16:52:47 2022 +1200
+	fixed param type
+robertburrowes	Mon May 9 16:17:56 2022 +1200
+	API changes
+robertburrowes	Mon May 9 14:55:40 2022 +1200
+	Ignore test script
+robertburrowes	Mon May 9 14:54:41 2022 +1200
+	+x
+robertburrowes	Mon May 9 14:54:11 2022 +1200
+	Include tags pushing to github
+robertburrowes	Mon May 9 14:52:11 2022 +1200
+	API updates
+robertburrowes	Mon May 9 14:39:15 2022 +1200
+	API additions/response changes. Added page/page_size Fixed some string quotes Fixed URL mistypings
+robertburrowes	Mon May 9 12:36:08 2022 +1200
+	Added setting pagination params from the args
+robertburrowes	Mon May 9 11:46:21 2022 +1200
+	Search has pagination
+robertburrowes	Thu Dec 23 12:20:05 2021 +1300
+	Fixed Institutions::hr_upload
 robertburrowes	Tue Nov 2 14:49:47 2021 +1300
 	hr upload is post, not put
 robertburrowes	Tue Nov 2 13:12:30 2021 +1300

data/README.md

@@ -7,7 +7,9 @@
 
 ## DESCRIPTION:
 
-Figshare version 2 API. 
+Figshare version 2 API.
+
+Actually the second version of the version 2 APIs. Lots of changes have been made by Figshare, mostly expanding what is returned from the API calls, but they also added some fields. Looks mostly backwards compatible.
 
 ## FEATURES/PROBLEMS:
 
@@ -71,4 +73,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/lib/authors.rb

@@ -4,13 +4,17 @@ module Figshare
   class Authors < Base
     # Search authors
     #
-    # @param institution [Boolean] Just our institution
-    # @param group_id [Integer] Only return this group's collections
+    # @param institution [Boolean] Just our institution. We have already stored the institute_id.
     # @param orcid [String] Matches this orcid
+    # @param group_id [Integer] Only return this group's collections
     # @param is_active [Boolean]
     # @param is_public [Boolean]
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
+    # @param page [Numeric] Pages start at 1. Page and Page size go together
+    # @param page_size [Numeric]
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
     # @yield [Hash] {id, first_name, last_name, full_name, url_name, is_active, is_public, orcid_id, institution_id, group_id, job_title}
     def search( search_for:,
                 institute: false,
@@ -20,6 +24,10 @@ module Figshare
                 is_public: true,
                 order: 'published_date',
                 order_direction: 'desc',
+                page: nil,
+                page_size: nil,
+                offset: nil,
+                limit: nil,
                 &block
               )
       args = { 'search_for' => search_for }
@@ -30,7 +38,11 @@ module Figshare
       args['orcid'] = orcid unless orcid.nil?
       args['order'] = order unless order.nil?
       args['order_direction'] = order_direction unless order_direction.nil?
-      post(api_query: 'account/authors/search', args: args, &block)
+      args['page'] = page unless page.nil?
+      args['page_size'] = page_size unless page_size.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
+      post_paginate(api_query: 'account/authors/search', args: args, &block)
     end
 
     # Get an authors details
@@ -38,7 +50,7 @@ module Figshare
     # @param author_id [Integer] Figshare Author ID
     # @yield [Hash] {id, first_name, last_name, full_name, url_name, is_active, is_public, orcid_id, institution_id, group_id, job_title}
     def detail(author_id:, &block)
-      get(api_query: "account/authors/#{author_id}",  &block)
+      get(api_query: "account/authors/#{author_id}", &block)
     end
   end
 end

data/lib/base.rb

@@ -77,10 +77,19 @@ module Figshare
         raise 'get_paginate(): Expecting args to be a Hash'
       end
 
-      offset = 0
-      page = 1
-      limit = page_size = 100
+      # Loop variables, if we are using pages
+      page = args['page'].nil? ? 1 : args['page']
+      page_size = args['page_size'].nil? ? 100 : args['page_size']
+
+      # Loop variables, if we are using offsets
+      offset = args['offset'].nil? ? 0 : args['offset']
+      limit = args['limit'].nil? ? 100 : args['limit']
+
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+
+      # How many results so far.
       result_count = 0
+
       loop do
         content_type = response = nil
         form_args = by_offset ? { 'limit' => limit, 'offset' => offset } : { 'page_size' => page_size, 'page' => page }
@@ -148,11 +157,19 @@ module Figshare
     # @yield [String] if given a block, iterates through the result from figshare
     # @return [Integer] number of results.
     private def post_paginate(api_query:, args: {}, debug: false, by_offset: false, &block)
-      page = 1
-      offset = 0
-      limit = page_size = 100
+      # Loop variables, if we are using pages
+      page = args['page'].nil? ? 1 : args['page']
+      page_size = args['page_size'].nil? ? 100 : args['page_size']
+
+      # Loop variables, if we are using offsets
+      offset = args['offset'].nil? ? 0 : args['offset']
+      limit = args['limit'].nil? ? 100 : args['limit']
+
+      # How many results so far.
       result_count = 0
 
+      by_offset = true if args['page'].nil? && ! args['offset'].nil?
+
       args = {} if args.nil?
       if ! args.is_a?(Hash)
         raise 'post_paginate(): Expecting args to be a Hash'
@@ -214,6 +231,41 @@ module Figshare
       return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
     end
 
+    # Patch iterates through the API response, yielding each value to the passed block
+    # When Figshare API usually has no paging option.
+    # If there is no block, then the results are printed (useful for debugging)
+    #
+    # @param api_query [String] base figshare api call, to which we add parameters defined in args
+    # @param args [Hash] Key, value pairs which get converted to ?key=arg&key=arg...
+    # @param debug [Boolean] print result to stdout
+    # @param content_type [String] Assuming Json, but might need binary ('application/octet-stream')
+    # @yield [String] if given a block, iterates through the result from figshare
+    # @return [Integer] number of results
+    private def patch(api_query:, args: {}, data: nil, debug: false, content_type: 'application/json; charset=UTF-8', &block)
+      body = nil
+      body = if data.is_a?(Hash)
+               # Convert hash to json, and merge in additional args
+               data.merge(args).to_j
+             elsif data.nil? && ! args.empty?
+               # No data, but args, so just use the args
+               args.to_j
+             else
+               # Data isn't a Hash, so just pass it through (might be nil)
+               data
+             end
+
+      response = nil
+      WIKK::WebBrowser.https_session( host: @hostname, verify_cert: false ) do |ws|
+        response = ws.patch_req( query: "#{@api_url}#{api_query}",
+                                 content_type: content_type,
+                                 authorization: "token #{@auth_token}",
+                                 data: body
+                               )
+        content_type = ws.header_value(key: 'Content-Type')
+      end
+      return iterate_json_response(response: response, content_type: content_type, debug: debug, &block)
+    end
+
     # delete sends an HTML DELETE request.
     # We don't expect to get a response to this call.
     #

data/lib/figshare_api_v2.rb

@@ -1,7 +1,7 @@
 module Figshare # :nodoc:
   # Figshare module initialization
   #
-  VERSION = '0.9.8'
+  VERSION = '0.9.9'
 
   require 'wikk_webbrowser'
   require 'wikk_json'

data/lib/institutions.rb

@@ -4,10 +4,14 @@ module Figshare
   class Institutions < Base
     # Upload hr file
     #
-    # @param hr_xml [String] See https://docs.figshare.com/#hr_feed_hr_feed_private_endpoint
+    # @param hr_xml_filename [String] Filename. See https://docs.figshare.com/#hr_feed_hr_feed_private_endpoint
     # @yield [Hash] { message:, data: null, errcode:}
-    def hr_upload(hr_xml:, &block)
-      post(api_query: 'institution/hrfeed/upload', data: hr_xml, content_type: 'multipart/form-data', &block)
+    def hr_upload(hr_xml_filename:, &block)
+      File.open(@file_name, 'rb') do |fin|
+        hr_xml = fin.read
+        args = { 'name' => 'hrfeed', 'filename' => hr_xml_filename }
+        post(api_query: 'institution/hrfeed/upload', args: args, data: hr_xml, content_type: 'multipart/form-data', &block)
+      end
     end
 
     # Get the institional account details
@@ -17,6 +21,13 @@ module Figshare
       get(api_query: 'account/institution', &block)
     end
 
+    # Get the institional account embargo options (IP Ranges)
+    #
+    # @yield [Array] list of embargo ip ranges [ {id:, type: ip_range, ip_name: Figshare_IP_Range} ]
+    def account_embargo_options(&block)
+      get(api_query: 'account/institution/embargo_options', &block)
+    end
+
     # Requests a list of private institute articles
     #
     # @param status [Integer] Only return items with this status
@@ -26,6 +37,10 @@ module Figshare
     # @param item_type [String] Matches this item_type. See Figshare API docs for list (https://docs.figshare.com/#articles_list)
     # @param order [String] "published_date" Default, "modified_date", "views", "cites", "shares"
     # @param order_direction [String] "desc" Default, "asc"
+    # @param page [Numeric] Pages start at 1. Page and Page size go together
+    # @param page_size [Numeric]
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
     # @yield [Hash] {id, title, doi, handle, group_id, url, url_public_html, url_public_api, url_private_htm,
     #                url_private_api, published_date, timeline {...}, thumb, defined_type, defined_name }
     def private_articles( status: nil,
@@ -35,6 +50,10 @@ module Figshare
                           resource_doi: nil,
                           order: 'published_date',
                           order_direction: 'desc',
+                          page: nil,
+                          page_size: nil,
+                          offset: nil,
+                          limit: nil,
                           &block
                         )
       args = {}
@@ -45,6 +64,10 @@ module Figshare
       args['modified_since'] = modified_since unless modified_since.nil?
       args['order'] = order unless order.nil?
       args['order_direction'] = order_direction unless order_direction.nil?
+      args['page'] = page unless page.nil?
+      args['page_size'] = page_size unless page_size.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
       get_paginate(api_query: 'account/institution/articles', args: args, &block)
     end
 
@@ -58,26 +81,57 @@ module Figshare
       args = {}
       args['resource_id'] = resource_id unless resource_id.nil?
       args['filename'] = filename unless filename.nil?
-      get(api_query: 'institutions/{@institute_id}/articles/filter-by', args: args, &block)
+      get(api_query: "institutions/#{@institute_id}/articles/filter-by", args: args, &block)
+    end
+
+    # Get an institute group's custom fields
+    #
+    # @param group_id [Integer] Figshare group_id
+    # @yield [Array] [ {id:, name: field_name, field_type: text } ]
+    def group_custom_fields(group_id: nil, &block )
+      args = {}
+      args['group_id'] = group_id unless group_id.nil?
+      get(api_query: 'account/institution/custom_fields', args: args, &block)
+    end
+
+    # Set institute group's custom fields, from a CSV file
+    #
+    # @param custom_field_id [Integer] Figshare group_id
+    # @param filename [Integer] Figshare group_id
+    # @yield [Hash] {code: 200, message: ok } ]
+    def group_set_custom_fields(custom_field_id:, filename: )
+      File.open(filename, 'rb') do |fin|
+        custom_fields_csv = fin.read
+        args = { 'name' => 'external_file', 'filename' => filename }
+        post(api_query: "account/institution/custom_fields/#{custom_field_id}/items/upload", args: args, data: custom_fields_csv, content_type: 'multipart/form-data', &block)
+      end
     end
 
     # Get institution categories (including parent Categories)
     #
-    # @yield [Hash] { parent_id, id, title }
+    # @yield [Array] [ { parent_id: 1, id: 11, title: "Anatomy", path:"/450/1024/6532", source_id: "300204", taxonomy_id: 4 } ]
     def categories(&block)
       get(api_query: 'account/categories', &block)
     end
 
     # Get the groups for which the account has administrative privileges (assigned and inherited).
     #
-    # @yield [Hash] { id, name, resource_id, parent_id, association_criteria }
+    # @yield [Array] [ { id: 1, name: "Materials", resource_id: "string", parent_id: 0, association_criteria: "IT" } ]
     def groups(&block)
       get(api_query: 'account/groups', &block)
     end
 
+    # Get the institional account group's embargo options (IP Ranges)
+    #
+    # @param group_id [Integer]
+    # @yield [Array] list of embargo ip ranges [ {id:, type: ip_range, ip_name: Figshare_IP_Range} ]
+    def group_embargo_options(group_id:, &block)
+      get(api_query: "account/institution/groups/#{group_id}/embargo_options", &block)
+    end
+
     # Get the roles available for groups and the institution group.
     #
-    # @yield [Hash] { id, name, category, description }
+    # @yield [Array] [ { id:, name:, category:, description: } ]
     def roles(&block)
       get(api_query: 'account/roles', &block)
     end
@@ -87,12 +141,34 @@ module Figshare
     # @param is_active [Boolean] user account is active
     # @param institution_user_id [String] As set in the HR upload
     # @param email [String] as set in the HR upload
-    # @yield [Hash] { id, first_name, last_name, institution_id, email, active, institution_user_id }
-    def accounts(is_active: nil, institution_user_id: nil, email: nil, &block)
+    # @param id_lte [Integer] ID is <=
+    # @param id_gte [Integer] ID is >=
+    # @param page [Numeric] Pages start at 1. Page and Page size go together
+    # @param page_size [Numeric]
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
+    # @yield [Array] [{ id:, first_name:, last_name:, institution_id:, email:, active:, institution_user_id:, quota:, used_quota:, user_id:, orcid_id: }]
+    def accounts( is_active: nil,
+                  institution_user_id: nil,
+                  email: nil,
+                  id_lte: nil,
+                  id_gte: nil,
+                  page: nil,
+                  page_size: nil,
+                  offset: nil,
+                  limit: nil,
+                  &block
+                )
       args = {}
       args['is_active'] = is_active unless is_active.nil?
       args['institution_user_id'] = institution_user_id unless institution_user_id.nil?
       args['email'] = email unless email.nil?
+      args['id_lte'] = id_lte unless id_lte.nil?
+      args['id_gte'] = id_gte unless id_gte.nil?
+      args['page'] = page unless page.nil?
+      args['page_size'] = page_size unless page_size.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
       get_paginate(api_query: 'account/institution/accounts', args: args, &block)
     end
 
@@ -106,7 +182,16 @@ module Figshare
     # @param symplectic_user_id [string]
     # @param quota [Integer] Figshare user quota
     # @param is_active [Boolean]
-    def account_create(email:, first_name:, last_name:, group_id:, institution_user_id: nil, symplectic_user_id: nil, quota: nil, is_active: true, &block)
+    def account_create( email:,
+                        first_name:,
+                        last_name:,
+                        group_id:,
+                        institution_user_id: nil,
+                        symplectic_user_id: nil,
+                        quota: nil,
+                        is_active: true,
+                        &block
+                      )
       args = {}
       args['email'] = email unless email.nil?
       args['first_name'] = first_name unless first_name.nil?
@@ -116,11 +201,12 @@ module Figshare
       args['symplectic_user_id'] = symplectic_user_id unless symplectic_user_id.nil?
       args['quota'] = quota unless quota.nil?
       args['is_active'] = is_active unless is_active.nil?
-      post(api_query: "account/institution/accounts/#{account_id}", args: args, &block)
+      post(api_query: 'account/institution/accounts', args: args, &block)
     end
 
     # Update Institution Account
     #
+    # @param account_id [Integer] Whose account
     # @param email [String]
     # @param first_name [String]
     # @param last_name [String]
@@ -129,7 +215,17 @@ module Figshare
     # @param symplectic_user_id [string]
     # @param quota [Integer] Figshare user quota
     # @param is_active [Boolean]
-    def account_update(email:, first_name:, last_name:, group_id:, institution_user_id: nil, symplectic_user_id: nil, quota: nil, is_active: true, &block)
+    def account_update( account_id:,
+                        email: nil,
+                        first_name: nil,
+                        last_name: nil,
+                        group_id: nil,
+                        institution_user_id: nil,
+                        symplectic_user_id: nil,
+                        quota: nil,
+                        is_active: true,
+                        &block
+                      )
       args = {}
       args['email'] = email unless email.nil?
       args['first_name'] = first_name unless first_name.nil?
@@ -142,7 +238,7 @@ module Figshare
       put(api_query: "account/institution/accounts/#{account_id}", args: args, &block)
     end
 
-    # Get institution Account Group Roles
+    # Get institution Account Group Roles for an account
     #
     # @param account_id [Integer] Figshare user account id
     # @yield [Hash] { role_id [ { category, id, name }, ... ], ... }
@@ -153,7 +249,7 @@ module Figshare
     # Add Institution Account Group Roles
     #
     # @param account_id [Integer] Figshare user account id
-    # @param body [Hash] see figshare api docs
+    # @param body [Hash] see figshare api cryptic docs  { "2": [ 2, 7], "3": [7,9] }. Array of roles, per group
     def group_roles_add(account_id:, body:, &block)
       post(api_query: "account/institution/roles/#{account_id}", args: body, &block)
     end
@@ -163,12 +259,9 @@ module Figshare
     # @param account_id [Integer] Figshare user account id
     # @param role_id [Integer] Figshare role id
     # @param group_id [Integer] Figshare group id
-    def group_role_delete( role_id, group_id, account_id:, &block)
+    def group_role_delete( account_id:, role_id:, group_id:, &block)
       args = {}
-      args['account_id'] = account_id unless account_id.nil?
-      args['role_id'] = role_id unless role_id.nil?
-      args['group_id'] = group_id unless group_id.nil?
-      delete(api_query: 'account/institution/roles/{account_id}', args: args, &block)
+      delete(api_query: "account/institution/roles/#{account_id}/#{group_id}/#{role_id}", args: args, &block)
     end
 
     # Get the accounts for which the account has administrative privileges (assigned and inherited).
@@ -176,14 +269,31 @@ module Figshare
     # @param is_active [Boolean] user account is active
     # @param institution_user_id [String] As set in the HR upload
     # @param email [String] as set in the HR upload
-    # @yield [Hash] {id, first_name, last_name, institution_id, email, active, institution_user_id}
-    def account_search(search_for: nil, is_active: nil, institution_user_id: nil, email: nil, &block)
+    # @param page [Numeric] Pages start at 1. Page and Page size go together
+    # @param page_size [Numeric]
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
+    # @yield [Hash] {id, first_name, last_name, institution_id, email, active, institution_user_id, quota, used_quota, user_id, orcid_id}
+    def account_search( search_for: nil,
+                        is_active: nil,
+                        institution_user_id: nil,
+                        email: nil,
+                        page: nil,
+                        page_size: nil,
+                        offset: nil,
+                        limit: nil,
+                        &block
+                      )
       args = {}
       args['search_for'] = search_for unless search_for.nil?
       args['is_active'] = is_active unless is_active.nil?
       args['institution_user_id'] = institution_user_id unless institution_user_id.nil?
       args['email'] = email unless email.nil?
-      post(api_query: 'account/institution/accounts/search', args: args, &block)
+      args['page'] = page unless page.nil?
+      args['page_size'] = page_size unless page_size.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
+      post_paginate(api_query: 'account/institution/accounts/search', args: args, &block)
     end
 
     # Get institution user information using the account_id
@@ -198,13 +308,23 @@ module Figshare
     #
     # @param group_id [Integer] Figshare group ID
     # @param article_id [Integer] Figshare article ID
-    # @param status [String] pending, approved, rejected, closed
+    # @param status [String] One of: pending, approved, rejected, closed
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
     # @yield [Hash] {id, group_id, account_id, assigned_to, article_id, version, comment_count, status, created_date. modified_date }
-    def curation_review(group_id: nil, article_id: nil, status: nil, &block)
+    def curation_review(  group_id: nil,
+                          article_id: nil,
+                          status: nil,
+                          offset: nil,
+                          limit: nil,
+                          &block
+                       )
       args = {}
       args['group_id'] = group_id unless group_id.nil?
       args['article_id'] = article_id unless article_id.nil?
       args['status'] = status unless status.nil?
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
       # Odd one, as has offset,limit not page,page_size
       get_paginate(api_query: 'account/institution/reviews', args: args, by_offset: true, &block)
     end
@@ -220,10 +340,15 @@ module Figshare
     # Get a certain curation review's comments.
     #
     # @param curation_id [Integer] Figshare curation ID
+    # @param offset [Numeric] offset is 0 based.  Offset and Limit go together
+    # @param limit [Numeric]
     # @yield [Hash] { id, account_id, type, text}
-    def curation_review_comments(curation_id:, &block)
+    def curation_review_comments(curation_id:, offset: nil, limit: nil, &block)
       # Odd one, as has offset,limit not page,page_size.
-      get_paginate(api_query: "account/institution/reviews/#{curation_id}/comments", by_offset: true, &block)
+      args = {}
+      args['offset'] = offset unless offset.nil?
+      args['limit'] = limit unless limit.nil?
+      get_paginate(api_query: "account/institution/review/#{curation_id}/comments", args: args, by_offset: true, &block)
     end
 
     # Add a new comment to the review.
@@ -231,8 +356,7 @@ module Figshare
     # @param curation_id [Integer] Figshare curation ID
     # @param comment [String] Comment text
     def curation_review_comments_update(curation_id:, comment:, &block)
-      # Odd one, as has offset,limit not page,page_size.
-      post(api_query: "account/institution/reviews/#{curation_id}/comments", args: { 'text' => comment }, &block)
+      post(api_query: "account/institution/review/#{curation_id}/comments", args: { 'text' => comment }, &block)
     end
   end
 end

data/lib/other.rb

@@ -2,10 +2,18 @@ module Figshare
   # Misc Figshare API calls that they have classified as Other.
   #
   class Other < Base
+    # Fetch item types
+    #
+    # @param group_id [Integer]
+    # @yield [Array] [{id: 0, name:, string_id:, icon:, public_description:, is_selectable: , url_name: } ]
+    def item_types(group_id:, &block)
+      get(api_query: 'item_types', args: { 'group_id' => group_id }, &block)
+    end
+
     # Search from funding records
     #
     # @param search_for [String] string to search for
-    # @yield [Hash] {id, title, grant_code, funder_name, is_user_defined, url}
+    # @yield [Array] [{id, title, grant_code, funder_name, is_user_defined, url}]
     def search_funding(search_for:, &block)
       post(api_query: 'account/funding/search', args: { 'search_for' => search_for }, &block)
     end
@@ -21,21 +29,21 @@ module Figshare
 
     # Get public categories
     #
-    # @yield [Hash] {parent_id, id, title}
+    # @yield [Array] [{parent_id:, id:, title:, path:, source_id:, taxonomy_id:}]
     def public_categories
       get(api_query: 'categories', &block)
     end
 
     # Get public licenses
     #
-    # @yield [Hash] {value, name, url}
+    # @yield [Array] [{value:, name:, url:}]
     def public_licenses
       get(api_query: 'licenses', &block)
     end
 
     # Get private licenses
     #
-    # @yield [Hash] {value, name, url}
+    # @yield [Array] [{value:, name:, url:}]
     def private_account_licenses
       get(api_query: 'account/licenses', &block)
     end