Class: TheCompaniesAPI::Generated::Requests::SearchCompaniesPostRequest

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

Overview

SearchCompaniesPostRequest - API request class

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ SearchCompaniesPostRequest

Initialize a new SearchCompaniesPostRequest

Parameters:

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

    Request data



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 50

def initialize(data = {})
                @action_id = data['actionId'] || data[:action_id]
                @domains_to_exclude = data['domainsToExclude'] || data[:domains_to_exclude]
                @linkedin_to_exclude = data['linkedinToExclude'] || data[:linkedin_to_exclude]
                @page = data['page'] || data[:page]
                @query = data['query'] || data[:query]
                @search = data['search'] || data[:search]
                @search_fields = data['searchFields'] || data[:search_fields]
                @simplified = data['simplified'] || data[:simplified]
                @size = data['size'] || data[:size]
                @sort_fields = data['sortFields'] || data[:sort_fields]
                @sort_key = data['sortKey'] || data[:sort_key]
                @sort_order = data['sortOrder'] || data[:sort_order]
end

Instance Attribute Details

#action_id ⇒ Float

Returns actionId.

Returns:

  • (Float) —

    actionId



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

def action_id
  @action_id
end

#domains_to_exclude ⇒ String

Returns domainsToExclude.

Returns:

  • (String) —

    domainsToExclude



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

def domains_to_exclude
  @domains_to_exclude
end

#linkedin_to_exclude ⇒ String

Returns linkedinToExclude.

Returns:

  • (String) —

    linkedinToExclude



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

def linkedin_to_exclude
  @linkedin_to_exclude
end

#page ⇒ Float

Returns page.

Returns:

  • (Float) —

    page



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

def page
  @page
end

#query ⇒ Array

Returns query.

Returns:

  • (Array) —

    query



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

def query
  @query
end

#search ⇒ String

Returns search.

Returns:

  • (String) —

    search



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

def search
  @search
end

#search_fields ⇒ Array

Returns searchFields.

Returns:

  • (Array) —

    searchFields



29
30
31
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 29

def search_fields
  @search_fields
end

#simplified ⇒ Boolean

Returns simplified.

Returns:

  • (Boolean) —

    simplified



32
33
34
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 32

def simplified
  @simplified
end

#size ⇒ Float

Returns size.

Returns:

  • (Float) —

    size



35
36
37
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 35

def size
  @size
end

#sort_fields ⇒ Array

Returns sortFields.

Returns:

  • (Array) —

    sortFields



38
39
40
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 38

def sort_fields
  @sort_fields
end

#sort_key ⇒ String

Returns sortKey.

Returns:

  • (String) —

    sortKey



41
42
43
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 41

def sort_key
  @sort_key
end

#sort_order ⇒ String

Returns sortOrder.

Returns:

  • (String) —

    sortOrder



44
45
46
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 44

def sort_order
  @sort_order
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Convert to hash for API request

Returns:

  • (Hash) —

    Hash representation



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/thecompaniesapi/generated/requests/search_companies_post_request.rb', line 69

def to_hash
  {
          'actionId' => @action_id,
          'domainsToExclude' => @domains_to_exclude,
          'linkedinToExclude' => @linkedin_to_exclude,
          'page' => @page,
          'query' => @query,
          'search' => @search,
          'searchFields' => @search_fields,
          'simplified' => @simplified,
          'size' => @size,
          'sortFields' => @sort_fields,
          'sortKey' => @sort_key,
          'sortOrder' => @sort_order,
  }.compact
end