Class: TheCompaniesAPI::Generated::Requests::CountCompaniesPostRequest

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

Overview

CountCompaniesPostRequest - API request class

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ CountCompaniesPostRequest

Initialize a new CountCompaniesPostRequest

Parameters:

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

    Request data



26
27
28
29
30
31
 
# File 'lib/thecompaniesapi/generated/requests/count_companies_post_request.rb', line 26

def initialize(data = {})
                @action_id = data['actionId'] || data[:action_id]
                @query = data['query'] || data[:query]
                @search = data['search'] || data[:search]
                @search_fields = data['searchFields'] || data[:search_fields]
end

Instance Attribute Details

#action_id ⇒ Float

Returns actionId.

Returns:

  • (Float) —

    actionId



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

def action_id
  @action_id
end

#query ⇒ Array

Returns query.

Returns:

  • (Array) —

    query



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

def query
  @query
end

#search ⇒ String

Returns search.

Returns:

  • (String) —

    search



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

def search
  @search
end

#search_fields ⇒ Array

Returns searchFields.

Returns:

  • (Array) —

    searchFields



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

def search_fields
  @search_fields
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Convert to hash for API request

Returns:

  • (Hash) —

    Hash representation



37
38
39
40
41
42
43
44
 
# File 'lib/thecompaniesapi/generated/requests/count_companies_post_request.rb', line 37

def to_hash
  {
          'actionId' => @action_id,
          'query' => @query,
          'search' => @search,
          'searchFields' => @search_fields,
  }.compact
end