Class: TheCompaniesAPI::Generated::Requests::AskCompanyRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/thecompaniesapi/generated/requests/ask_company_request.rb

Overview

AskCompanyRequest - API request class

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ AskCompanyRequest

Initialize a new AskCompanyRequest

Parameters:

  • data (Hash) (defaults to: {}) —

    Request data



32
33
34
35
36
37
38
39
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 32

def initialize(data = {})
                @explain = data['explain'] || data[:explain]
                @fields = data['fields'] || data[:fields]
                @list_id = data['listId'] || data[:list_id]
                @model = data['model'] || data[:model]
                @query = data['query'] || data[:query]
                @question = data['question'] || data[:question]
end

Instance Attribute Details

#explain ⇒ Boolean

Returns explain.

Returns:

  • (Boolean) —

    explain



11
12
13
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 11

def explain
  @explain
end

#fields ⇒ Array

Returns fields.

Returns:

  • (Array) —

    fields



14
15
16
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 14

def fields
  @fields
end

#list_id ⇒ Float

Returns listId.

Returns:

  • (Float) —

    listId



17
18
19
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 17

def list_id
  @list_id
end

#model ⇒ String

Returns model.

Returns:

  • (String) —

    model



20
21
22
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 20

def model
  @model
end

#query ⇒ Array

Returns query.

Returns:

  • (Array) —

    query



23
24
25
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 23

def query
  @query
end

#question ⇒ String

Returns question.

Returns:

  • (String) —

    question



26
27
28
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 26

def question
  @question
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Convert to hash for API request

Returns:

  • (Hash) —

    Hash representation



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/thecompaniesapi/generated/requests/ask_company_request.rb', line 45

def to_hash
  {
          'explain' => @explain,
          'fields' => @fields,
          'listId' => @list_id,
          'model' => @model,
          'query' => @query,
          'question' => @question,
  }.compact
end