Class: Zernio::YouTubeDailyViewsResponse

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/you_tube_daily_views_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 = {}) ⇒ YouTubeDailyViewsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 91

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#daily_views ⇒ Object

Returns the value of attribute daily_views.



34
35
36
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 34

def daily_views
  @daily_views
end

#date_range ⇒ Object

Returns the value of attribute date_range.



26
27
28
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 26

def date_range
  @date_range
end

#duration_seconds ⇒ Object

Video length in seconds (from YouTube contentDetails.duration)



24
25
26
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 24

def duration_seconds
  @duration_seconds
end

#last_synced_at ⇒ Object

When the data was last synced from YouTube



37
38
39
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 37

def last_synced_at
  @last_synced_at
end

#provisional_since ⇒ Object

Present only when the range reaches into YouTube's ~3-day processing window: the first date whose numbers are provisional and may still be revised by YouTube.



29
30
31
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 29

def provisional_since
  @provisional_since
end

#scope_status ⇒ Object

Returns the value of attribute scope_status.



39
40
41
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 39

def scope_status
  @scope_status
end

#success ⇒ Object

Returns the value of attribute success.



18
19
20
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 18

def success
  @success
end

#total_views ⇒ Object

Sum of views across all days in the range



32
33
34
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 32

def total_views
  @total_views
end

#video_id ⇒ Object

The YouTube video ID



21
22
23
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 21

def video_id
  @video_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



57
58
59
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 57

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 62

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 42

def self.attribute_map
  {
    :'success' => :'success',
    :'video_id' => :'videoId',
    :'duration_seconds' => :'durationSeconds',
    :'date_range' => :'dateRange',
    :'provisional_since' => :'provisionalSince',
    :'total_views' => :'totalViews',
    :'daily_views' => :'dailyViews',
    :'last_synced_at' => :'lastSyncedAt',
    :'scope_status' => :'scopeStatus'
  }
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 190

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



82
83
84
85
86
87
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 82

def self.openapi_nullable
  Set.new([
    :'duration_seconds',
    :'last_synced_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 67

def self.openapi_types
  {
    :'success' => :'Boolean',
    :'video_id' => :'String',
    :'duration_seconds' => :'Integer',
    :'date_range' => :'YouTubeDailyViewsResponseDateRange',
    :'provisional_since' => :'Date',
    :'total_views' => :'Integer',
    :'daily_views' => :'Array<YouTubeDailyViewsResponseDailyViewsInner>',
    :'last_synced_at' => :'Time',
    :'scope_status' => :'YouTubeDailyViewsResponseScopeStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success == o.success &&
      video_id == o.video_id &&
      duration_seconds == o.duration_seconds &&
      date_range == o.date_range &&
      provisional_since == o.provisional_since &&
      total_views == o.total_views &&
      daily_views == o.daily_views &&
      last_synced_at == o.last_synced_at &&
      scope_status == o.scope_status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 183

def hash
  [success, video_id, duration_seconds, date_range, provisional_since, total_views, daily_views, last_synced_at, scope_status].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



146
147
148
149
150
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 146

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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 212

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



154
155
156
157
 
# File 'lib/zernio-sdk/models/you_tube_daily_views_response.rb', line 154

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