Class: PublishingPlatformApi::Search

Inherits:
Base
  • Object
show all
Defined in:
lib/publishing_platform_api/search.rb

Instance Attribute Summary

Attributes inherited from Base

#options

Instance Method Summary collapse

Methods inherited from Base

#client, #create_client, #get_list, #initialize, #url_for_slug

Constructor Details

This class inherits a constructor from PublishingPlatformApi::Base

Instance Method Details

#search(args, additional_headers = {}) ⇒ Object

Perform a search.

Parameters:

  • args (Hash) —

    A valid search query. See search-api documentation for options.



10
11
12
13
 
# File 'lib/publishing_platform_api/search.rb', line 10

def search(args, additional_headers = {})
  request_url = "#{endpoint}/search.json?#{Rack::Utils.build_nested_query(args)}"
  get_json(request_url, additional_headers)
end