Class: TheCompaniesAPI::Generated::Requests::ExportCompaniesAnalyticsRequest

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

Overview

ExportCompaniesAnalyticsRequest - API request class

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ ExportCompaniesAnalyticsRequest

Initialize a new ExportCompaniesAnalyticsRequest

Parameters:

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

    Request data



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

def initialize(data = {})
                @action_id = data['actionId'] || data[:action_id]
                @attributes = data['attributes'] || data[:attributes]
                @format = data['format'] || data[:format]
                @full = data['full'] || data[:full]
                @list_id = data['listId'] || data[:list_id]
                @query = data['query'] || data[:query]
                @size = data['size'] || data[:size]
                @sort = data['sort'] || data[:sort]
end

Instance Attribute Details

#action_id ⇒ Float

Returns actionId.

Returns:

  • (Float) —

    actionId



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

def action_id
  @action_id
end

#attributes ⇒ Array

Returns attributes.

Returns:

  • (Array) —

    attributes



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

def attributes
  @attributes
end

#format ⇒ String

Returns format.

Returns:

  • (String) —

    format



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

def format
  @format
end

#full ⇒ Boolean

Returns full.

Returns:

  • (Boolean) —

    full



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

def full
  @full
end

#list_id ⇒ Float

Returns listId.

Returns:

  • (Float) —

    listId



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

def list_id
  @list_id
end

#query ⇒ Array

Returns query.

Returns:

  • (Array) —

    query



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

def query
  @query
end

#size ⇒ Float

Returns size.

Returns:

  • (Float) —

    size



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

def size
  @size
end

#sort ⇒ String

Returns sort.

Returns:

  • (String) —

    sort



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

def sort
  @sort
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/export_companies_analytics_request.rb', line 53

def to_hash
  {
          'actionId' => @action_id,
          'attributes' => @attributes,
          'format' => @format,
          'full' => @full,
          'listId' => @list_id,
          'query' => @query,
          'size' => @size,
          'sort' => @sort,
  }.compact
end