Class: Zernio::GetCommentAutomation200ResponseLogsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.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 = {}) ⇒ GetCommentAutomation200ResponseLogsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 147

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audience_outcome ⇒ Object

How the audience rule resolved. Absent on automations without one.



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

def audience_outcome
  @audience_outcome
end

#comment_id ⇒ Object

Returns the value of attribute comment_id.



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

def comment_id
  @comment_id
end

#comment_reply_error ⇒ Object

Public-reply error message if commentReplyStatus is failed



54
55
56
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 54

def comment_reply_error
  @comment_reply_error
end

#comment_reply_status ⇒ Object

Outcome of the optional public reply on the triggering comment. 'skipped' if no commentReply was configured or if the DM failed (the public reply is not attempted in that case).



51
52
53
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 51

def comment_reply_status
  @comment_reply_status
end

#comment_text ⇒ Object

Returns the value of attribute comment_text.



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

def comment_text
  @comment_text
end

#commenter_follower_count ⇒ Object

Returns the value of attribute commenter_follower_count.



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

def commenter_follower_count
  @commenter_follower_count
end

#commenter_id ⇒ Object

Returns the value of attribute commenter_id.



22
23
24
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 22

def commenter_id
  @commenter_id
end

#commenter_is_follower ⇒ Object

Follow relationship at decision time. Absent when Instagram would not tell us (the commenter never messaged the account).



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

def commenter_is_follower
  @commenter_is_follower
end

#commenter_name ⇒ Object

Returns the value of attribute commenter_name.



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

def commenter_name
  @commenter_name
end

#created_at ⇒ Object

Returns the value of attribute created_at.



59
60
61
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 59

def created_at
  @created_at
end

#error ⇒ Object

DM error message if status is failed



43
44
45
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 43

def error
  @error
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#next_due_at ⇒ Object

When the next queued send fires. Present only while something is still pending.



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

def next_due_at
  @next_due_at
end

#platform_error ⇒ Object

Returns the value of attribute platform_error.



45
46
47
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 45

def platform_error
  @platform_error
end

#private_reply_consumed ⇒ Object

True when the failed send spent the comment's single Instagram private reply (subcode 1545133 or 2534023), the same rule as details.privateReplyConsumed on the private-reply endpoint. Absent on direct DMs, on Facebook, and on rows written before this field existed.



48
49
50
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 48

def private_reply_consumed
  @private_reply_consumed
end

#source ⇒ Object

Which door triggered this send. Absent on rows written before this field existed (all of those are comment-triggered).



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

def source
  @source
end

#status ⇒ Object

DM outcome. 'pending' = the automation has a dmDelaySeconds and the response is queued but not sent yet. 'gated' = the follow-gate confirmation DM went out and we are waiting for the tap; it flips to 'sent' or 'skipped' when they tap.



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

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



107
108
109
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 107

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



112
113
114
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 112

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 84

def self.attribute_map
  {
    :'id' => :'id',
    :'comment_id' => :'commentId',
    :'commenter_id' => :'commenterId',
    :'commenter_name' => :'commenterName',
    :'comment_text' => :'commentText',
    :'source' => :'source',
    :'status' => :'status',
    :'audience_outcome' => :'audienceOutcome',
    :'commenter_is_follower' => :'commenterIsFollower',
    :'commenter_follower_count' => :'commenterFollowerCount',
    :'error' => :'error',
    :'platform_error' => :'platformError',
    :'private_reply_consumed' => :'privateReplyConsumed',
    :'comment_reply_status' => :'commentReplyStatus',
    :'comment_reply_error' => :'commentReplyError',
    :'next_due_at' => :'nextDueAt',
    :'created_at' => :'createdAt'
  }
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 332

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



140
141
142
143
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 140

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

.openapi_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 117

def self.openapi_types
  {
    :'id' => :'String',
    :'comment_id' => :'String',
    :'commenter_id' => :'String',
    :'commenter_name' => :'String',
    :'comment_text' => :'String',
    :'source' => :'String',
    :'status' => :'String',
    :'audience_outcome' => :'String',
    :'commenter_is_follower' => :'Boolean',
    :'commenter_follower_count' => :'Integer',
    :'error' => :'String',
    :'platform_error' => :'GetCommentAutomation200ResponseLogsInnerPlatformError',
    :'private_reply_consumed' => :'Boolean',
    :'comment_reply_status' => :'String',
    :'comment_reply_error' => :'String',
    :'next_due_at' => :'Time',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      comment_id == o.comment_id &&
      commenter_id == o.commenter_id &&
      commenter_name == o.commenter_name &&
      comment_text == o.comment_text &&
      source == o.source &&
      status == o.status &&
      audience_outcome == o.audience_outcome &&
      commenter_is_follower == o.commenter_is_follower &&
      commenter_follower_count == o.commenter_follower_count &&
      error == o.error &&
      platform_error == o.platform_error &&
      private_reply_consumed == o.private_reply_consumed &&
      comment_reply_status == o.comment_reply_status &&
      comment_reply_error == o.comment_reply_error &&
      next_due_at == o.next_due_at &&
      created_at == o.created_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


319
320
321
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 325

def hash
  [id, comment_id, commenter_id, commenter_name, comment_text, source, status, audience_outcome, commenter_is_follower, commenter_follower_count, error, platform_error, private_reply_consumed, comment_reply_status, comment_reply_error, next_due_at, created_at].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



232
233
234
235
236
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 232

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 354

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



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/zernio-sdk/models/get_comment_automation200_response_logs_inner.rb', line 240

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  source_validator = EnumAttributeValidator.new('String', ["comment", "story_reply", "dm"])
  return false unless source_validator.valid?(@source)
  status_validator = EnumAttributeValidator.new('String', ["pending", "sent", "failed", "skipped", "gated"])
  return false unless status_validator.valid?(@status)
  audience_outcome_validator = EnumAttributeValidator.new('String', ["passed", "blocked", "gate_sent", "gate_passed", "gate_failed"])
  return false unless audience_outcome_validator.valid?(@audience_outcome)
  comment_reply_status_validator = EnumAttributeValidator.new('String', ["sent", "failed", "skipped"])
  return false unless comment_reply_status_validator.valid?(@comment_reply_status)
  true
end