Class: Zernio::YouTubeVideoRetentionResponse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 103

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

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

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

  if attributes.key?(:'published_at')
    self.published_at = attributes[:'published_at']
  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?(:'retention_curve')
    if (value = attributes[:'retention_curve']).is_a?(Array)
      self.retention_curve = value
    end
  end

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

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

Instance Attribute Details

#account_id ⇒ Object

The Zernio account ID for the YouTube account



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

def 
  @account_id
end

#date_range ⇒ Object

Returns the value of attribute date_range.



35
36
37
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 35

def date_range
  @date_range
end

#duration_seconds ⇒ Object

Video length in seconds (from YouTube contentDetails.duration)



33
34
35
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 33

def duration_seconds
  @duration_seconds
end

#note ⇒ Object

Present only when the curve is empty, explaining why



44
45
46
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 44

def note
  @note
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.



38
39
40
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 38

def provisional_since
  @provisional_since
end

#published_at ⇒ Object

When the video was published on YouTube



30
31
32
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 30

def published_at
  @published_at
end

#retention_curve ⇒ Object

Up to 100 points covering the video timeline, aggregated over the date range. Empty for videos with very few views.



41
42
43
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 41

def retention_curve
  @retention_curve
end

#scope_status ⇒ Object

Returns the value of attribute scope_status.



46
47
48
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 46

def scope_status
  @scope_status
end

#success ⇒ Object

Returns the value of attribute success.



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

def success
  @success
end

#title ⇒ Object

Video title



27
28
29
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 27

def title
  @title
end

#video_id ⇒ Object

The YouTube video ID



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

def video_id
  @video_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 49

def self.attribute_map
  {
    :'success' => :'success',
    :'account_id' => :'accountId',
    :'video_id' => :'videoId',
    :'title' => :'title',
    :'published_at' => :'publishedAt',
    :'duration_seconds' => :'durationSeconds',
    :'date_range' => :'dateRange',
    :'provisional_since' => :'provisionalSince',
    :'retention_curve' => :'retentionCurve',
    :'note' => :'note',
    :'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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 212

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



93
94
95
96
97
98
99
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 76

def self.openapi_types
  {
    :'success' => :'Boolean',
    :'account_id' => :'String',
    :'video_id' => :'String',
    :'title' => :'String',
    :'published_at' => :'Time',
    :'duration_seconds' => :'Integer',
    :'date_range' => :'YouTubeDailyViewsResponseDateRange',
    :'provisional_since' => :'Date',
    :'retention_curve' => :'Array<YouTubeVideoRetentionResponseRetentionCurveInner>',
    :'note' => :'String',
    :'scope_status' => :'YouTubeDailyViewsResponseScopeStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      success == o.success &&
       == o. &&
      video_id == o.video_id &&
      title == o.title &&
      published_at == o.published_at &&
      duration_seconds == o.duration_seconds &&
      date_range == o.date_range &&
      provisional_since == o.provisional_since &&
      retention_curve == o.retention_curve &&
      note == o.note &&
      scope_status == o.scope_status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 205

def hash
  [success, , video_id, title, published_at, duration_seconds, date_range, provisional_since, retention_curve, note, 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



166
167
168
169
170
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 166

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 234

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



174
175
176
177
 
# File 'lib/zernio-sdk/models/you_tube_video_retention_response.rb', line 174

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