module BWAPI::Client::Author

Author module for author endpoints

Public Instance Methods

author_interests(opts = {}) click to toggle source

Gets all author interests

@param opts [Hash] options hash of parameters @option opts [Integer] page Page of results to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All author interests

# File lib/bwapi/client/author.rb, line 21
def author_interests(opts = {})
  get 'authors/interests', opts
end
author_professions(opts = {}) click to toggle source

Gets all author professions

@param opts [Hash] options hash of parameters @option opts [Integer] page Page of results to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All author professions

# File lib/bwapi/client/author.rb, line 11
def author_professions(opts = {})
  get 'authors/professions', opts
end
get_author(name, opts = {}) click to toggle source

Get an Author with its associated accounts using an account name/domain tuple

@param name [String] Account username @param opts [Hash] options hash of parameters @option opts [String] domain Account domain @return [Hash] Author

# File lib/bwapi/client/author.rb, line 31
def get_author(name, opts = {})
  get "authors/#{name}", opts
end
update_author(name, opts = {}) click to toggle source

Update an Author using an account name/domain tuple

@param name [String] Account username @param opts [Hash] options hash of parameters @option opts [String] accountType Account type of Author Patch @option opts [Array] addInterests Interests to add of Author Patch @option opts [Array] addProfessions Professions to add of Author Patch @option opts [String] domain Domain of Author Patch @option opts [String] gender Gender of Author Patch @option opts [Integer] projectId Project ID of Author Patch @option opts [Integer] queryId Query ID of Author Patch @option opts [Array] removeInterests Interests to remove of Author Patch @option opts [Array] removeProfessions Professions to remove of Author Patch @option opts [Integer] resourceId Resource ID of Author Patch @option opts [String] username Username of Author to be patched @return [Hash] Updated author

# File lib/bwapi/client/author.rb, line 51
def update_author(name, opts = {})
  patch "authors/#{name}", opts
end