Class: Swiftype::Client
- Inherits:
-
Object
- Object
- Swiftype::Client
- Includes:
- Analytics, Clickthrough, Document, DocumentType, Domain, Engine, Search, User, Request
- Defined in:
- lib/swiftype/client.rb
Overview
API client for the Swiftype API.
Defined Under Namespace
Modules: Analytics, Clickthrough, Document, DocumentType, Domain, Engine, Search, User
Constant Summary collapse
- DEFAULT_TIMEOUT =
15
Class Method Summary collapse
Instance Method Summary collapse
- #api_key ⇒ Object
-
#initialize(options = {}) ⇒ Client
constructor
Create a new Swiftype::Client client.
- #open_timeout ⇒ Object
- #overall_timeout ⇒ Object
- #platform_access_token ⇒ Object
Methods included from Clickthrough
Methods included from Domain
#crawl_url, #create_domain, #destroy_domain, #domain, #domains, #recrawl_domain
Methods included from Analytics
#analytics_autoselects, #analytics_clicks, #analytics_searches, #analytics_top_no_result_queries, #analytics_top_queries
Methods included from Document
#async_create_or_update_documents, #create_document, #create_documents, #create_or_update_document, #create_or_update_documents, #create_or_update_documents_verbose, #destroy_document, #destroy_documents, #document, #document_receipts, #documents, #index_documents, #update_document, #update_documents
Methods included from DocumentType
#create_document_type, #destroy_document_type, #document_type, #document_types
Methods included from Engine
#create_engine, #destroy_engine, #engine, #engines
Methods included from Search
#search, #search_document_type, #suggest, #suggest_document_type
Methods included from User
Methods included from Request
#delete, #get, #poll, #post, #put, #request
Constructor Details
#initialize(options = {}) ⇒ Client
Create a new Swiftype::Client client
26 27 28 |
# File 'lib/swiftype/client.rb', line 26 def initialize(={}) @options = end |
Class Method Details
Instance Method Details
#api_key ⇒ Object
30 31 32 |
# File 'lib/swiftype/client.rb', line 30 def api_key @options[:api_key] || Swiftype.api_key end |
#open_timeout ⇒ Object
38 39 40 |
# File 'lib/swiftype/client.rb', line 38 def open_timeout @options[:open_timeout] || DEFAULT_TIMEOUT end |
#overall_timeout ⇒ Object
42 43 44 |
# File 'lib/swiftype/client.rb', line 42 def overall_timeout (@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f end |
#platform_access_token ⇒ Object
34 35 36 |
# File 'lib/swiftype/client.rb', line 34 def platform_access_token @options[:platform_access_token] end |