Class: PinterestSdkClient::PinAnalyticsMetricsResponse

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/pin_analytics_metrics_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ PinAnalyticsMetricsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 63

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::PinAnalyticsMetricsResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::PinAnalyticsMetricsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'daily_metrics')
    if (value = attributes[:'daily_metrics']).is_a?(Array)
      self.daily_metrics = value
    end
  end

  if attributes.key?(:'lifetime_metrics')
    if (value = attributes[:'lifetime_metrics']).is_a?(Hash)
      self.lifetime_metrics = value
    end
  end

  if attributes.key?(:'summary_metrics')
    if (value = attributes[:'summary_metrics']).is_a?(Hash)
      self.summary_metrics = value
    end
  end
end

Instance Attribute Details

#daily_metrics ⇒ Object

Array with the requested daily metric records



19
20
21
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 19

def daily_metrics
  @daily_metrics
end

#lifetime_metrics ⇒ Object

The lifetime metric name and value.



22
23
24
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 22

def lifetime_metrics
  @lifetime_metrics
end

#summary_metrics ⇒ Object

The metric name and value over the requested period for each requested metric



25
26
27
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 25

def summary_metrics
  @summary_metrics
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



37
38
39
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 37

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 42

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



28
29
30
31
32
33
34
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 28

def self.attribute_map
  {
    :'daily_metrics' => :'daily_metrics',
    :'lifetime_metrics' => :'lifetime_metrics',
    :'summary_metrics' => :'summary_metrics'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 136

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 56

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 47

def self.openapi_types
  {
    :'daily_metrics' => :'Array<PinAnalyticsMetricsResponseDailyMetricsInner>',
    :'lifetime_metrics' => :'Hash<String, Integer>',
    :'summary_metrics' => :'Hash<String, Float>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



113
114
115
116
117
118
119
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 113

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      daily_metrics == o.daily_metrics &&
      lifetime_metrics == o.lifetime_metrics &&
      summary_metrics == o.summary_metrics
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


123
124
125
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



129
130
131
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 129

def hash
  [daily_metrics, lifetime_metrics, summary_metrics].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
101
102
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 98

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 158

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



106
107
108
109
 
# File 'lib/pinterest_sdk/models/pin_analytics_metrics_response.rb', line 106

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end