Class: Zernio::AnalyticsDeltaEntry

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/analytics_delta_entry.rb

Overview

One changed analytics snapshot. Metrics are the absolute values recorded at syncedAt, not the amount they moved by since the previous snapshot, so a later entry for the same postId always supersedes an earlier one.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'profile_id')
    self.profile_id = attributes[:'profile_id']
  else
    self.profile_id = nil
  end

  if attributes.key?(:'platform')
    self.platform = attributes[:'platform']
  else
    self.platform = nil
  end

  if attributes.key?(:'platform_post_id')
    self.platform_post_id = attributes[:'platform_post_id']
  else
    self.platform_post_id = nil
  end

  if attributes.key?(:'published_at')
    self.published_at = attributes[:'published_at']
  else
    self.published_at = nil
  end

  if attributes.key?(:'synced_at')
    self.synced_at = attributes[:'synced_at']
  else
    self.synced_at = nil
  end

  if attributes.key?(:'is_deleted')
    self.is_deleted = attributes[:'is_deleted']
  else
    self.is_deleted = nil
  end

  if attributes.key?(:'metrics')
    self.metrics = attributes[:'metrics']
  else
    self.metrics = nil
  end
end

Instance Attribute Details

#account_id ⇒ Object

Account this post was published through



23
24
25
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 23

def 
  @account_id
end

#is_deleted ⇒ Object

True when the post was detected as deleted on the platform at this sync



40
41
42
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 40

def is_deleted
  @is_deleted
end

#metrics ⇒ Object

Returns the value of attribute metrics.



42
43
44
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 42

def metrics
  @metrics
end

#platform ⇒ Object

Returns the value of attribute platform.



28
29
30
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 28

def platform
  @platform
end

#platform_post_id ⇒ Object

Platform-side post ID (for example the YouTube video ID)



31
32
33
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 31

def platform_post_id
  @platform_post_id
end

#post_id ⇒ Object

External post ID. The same identifier as posts[]._id in GET /v1/analytics.



20
21
22
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 20

def post_id
  @post_id
end

#profile_id ⇒ Object

Profile the account belongs to



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

def profile_id
  @profile_id
end

#published_at ⇒ Object

When the post was published, ISO-8601 UTC



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

def published_at
  @published_at
end

#synced_at ⇒ Object

When the sync cycle that produced this snapshot STARTED, ISO-8601 UTC. This is NOT the order entries arrive in and it is not a resume point: a slow cycle writes its rows after a faster cycle that started later, so syncedAt can go backwards between consecutive entries. Use nextCursor to resume.



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

def synced_at
  @synced_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



60
61
62
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 60

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 65

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 45

def self.attribute_map
  {
    :'post_id' => :'postId',
    :'account_id' => :'accountId',
    :'profile_id' => :'profileId',
    :'platform' => :'platform',
    :'platform_post_id' => :'platformPostId',
    :'published_at' => :'publishedAt',
    :'synced_at' => :'syncedAt',
    :'is_deleted' => :'isDeleted',
    :'metrics' => :'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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 342

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



85
86
87
88
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 70

def self.openapi_types
  {
    :'post_id' => :'String',
    :'account_id' => :'String',
    :'profile_id' => :'String',
    :'platform' => :'String',
    :'platform_post_id' => :'String',
    :'published_at' => :'Time',
    :'synced_at' => :'Time',
    :'is_deleted' => :'Boolean',
    :'metrics' => :'AnalyticsDeltaEntryMetrics'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      post_id == o.post_id &&
       == o. &&
      profile_id == o.profile_id &&
      platform == o.platform &&
      platform_post_id == o.platform_post_id &&
      published_at == o.published_at &&
      synced_at == o.synced_at &&
      is_deleted == o.is_deleted &&
      metrics == o.metrics
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 335

def hash
  [post_id, , profile_id, platform, platform_post_id, published_at, synced_at, is_deleted, 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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 163

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @post_id.nil?
    invalid_properties.push('invalid value for "post_id", post_id cannot be nil.')
  end

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @profile_id.nil?
    invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
  end

  if @platform.nil?
    invalid_properties.push('invalid value for "platform", platform cannot be nil.')
  end

  if @platform_post_id.nil?
    invalid_properties.push('invalid value for "platform_post_id", platform_post_id cannot be nil.')
  end

  if @published_at.nil?
    invalid_properties.push('invalid value for "published_at", published_at cannot be nil.')
  end

  if @synced_at.nil?
    invalid_properties.push('invalid value for "synced_at", synced_at cannot be nil.')
  end

  if @is_deleted.nil?
    invalid_properties.push('invalid value for "is_deleted", is_deleted cannot be nil.')
  end

  if @metrics.nil?
    invalid_properties.push('invalid value for "metrics", metrics cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 364

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



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/zernio-sdk/models/analytics_delta_entry.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @post_id.nil?
  return false if @account_id.nil?
  return false if @profile_id.nil?
  return false if @platform.nil?
  return false if @platform_post_id.nil?
  return false if @published_at.nil?
  return false if @synced_at.nil?
  return false if @is_deleted.nil?
  return false if @metrics.nil?
  true
end