Class: TheCompaniesAPI::Generated::Requests::CreateListRequest

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

Overview

CreateListRequest - API request class

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ CreateListRequest

Initialize a new CreateListRequest

Parameters:

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

    Request data



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/thecompaniesapi/generated/requests/create_list_request.rb', line 38

def initialize(data = {})
                @dynamic = data['dynamic'] || data[:dynamic]
                @imported = data['imported'] || data[:imported]
                @mail_frequency = data['mailFrequency'] || data[:mail_frequency]
                @max_companies = data['maxCompanies'] || data[:max_companies]
                @name = data['name'] || data[:name]
                @process_initialized = data['processInitialized'] || data[:process_initialized]
                @query = data['query'] || data[:query]
                @similar_domains = data['similarDomains'] || data[:similar_domains]
end

Instance Attribute Details

#dynamic ⇒ Boolean

Returns dynamic.

Returns:

  • (Boolean) —

    dynamic



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

def dynamic
  @dynamic
end

#imported ⇒ Boolean

Returns imported.

Returns:

  • (Boolean) —

    imported



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

def imported
  @imported
end

#mail_frequency ⇒ String

Returns mailFrequency.

Returns:

  • (String) —

    mailFrequency



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

def mail_frequency
  @mail_frequency
end

#max_companies ⇒ Float

Returns maxCompanies.

Returns:

  • (Float) —

    maxCompanies



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

def max_companies
  @max_companies
end

#name ⇒ String

Returns name.

Returns:

  • (String) —

    name



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

def name
  @name
end

#process_initialized ⇒ Boolean

Returns processInitialized.

Returns:

  • (Boolean) —

    processInitialized



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

def process_initialized
  @process_initialized
end

#query ⇒ Array

Returns query.

Returns:

  • (Array) —

    query



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

def query
  @query
end

#similar_domains ⇒ Array

Returns similarDomains.

Returns:

  • (Array) —

    similarDomains



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

def similar_domains
  @similar_domains
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Convert to hash for API request

Returns:

  • (Hash) —

    Hash representation



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/thecompaniesapi/generated/requests/create_list_request.rb', line 53

def to_hash
  {
          'dynamic' => @dynamic,
          'imported' => @imported,
          'mailFrequency' => @mail_frequency,
          'maxCompanies' => @max_companies,
          'name' => @name,
          'processInitialized' => @process_initialized,
          'query' => @query,
          'similarDomains' => @similar_domains,
  }.compact
end