Class: PinterestSdkClient::TopVideoPinsAnalyticsResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ TopVideoPinsAnalyticsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::TopVideoPinsAnalyticsResponse` 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::TopVideoPinsAnalyticsResponse`. 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?(:'date_availability')
    self.date_availability = attributes[:'date_availability']
  end

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

  if attributes.key?(:'sort_by')
    self.sort_by = attributes[:'sort_by']
  end
end

Instance Attribute Details

#date_availability ⇒ Object

Returns the value of attribute date_availability.



18
19
20
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 18

def date_availability
  @date_availability
end

#pins ⇒ Object

Returns the value of attribute pins.



20
21
22
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 20

def pins
  @pins
end

#sort_by ⇒ Object

Returns the value of attribute sort_by.



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

def sort_by
  @sort_by
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'date_availability' => :'date_availability',
    :'pins' => :'pins',
    :'sort_by' => :'sort_by'
  }
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 163

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



75
76
77
78
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 66

def self.openapi_types
  {
    :'date_availability' => :'TopPinsAnalyticsResponseDateAvailability',
    :'pins' => :'Array<TopVideoPinsAnalyticsResponsePinsInner>',
    :'sort_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_availability == o.date_availability &&
      pins == o.pins &&
      sort_by == o.sort_by
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 156

def hash
  [date_availability, pins, sort_by].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



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

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



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 185

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



121
122
123
124
125
126
 
# File 'lib/pinterest_sdk/models/top_video_pins_analytics_response.rb', line 121

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  sort_by_validator = EnumAttributeValidator.new('String', ["SAVE", "IMPRESSION", "OUTBOUND_CLICK", "VIDEO_MRC_VIEW", "VIDEO_AVG_WATCH_TIME", "VIDEO_V50_WATCH_TIME", "QUARTILE_95_PERCENT_VIEW", "VIDEO_10S_VIEW", "VIDEO_START"])
  return false unless sort_by_validator.valid?(@sort_by)
  true
end