Class: Zernio::CreateCommentAutomationRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 183

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

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

  if attributes.key?(:'trigger')
    self.trigger = attributes[:'trigger']
  else
    self.trigger = 'comment'
  end

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

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

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

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

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

  if attributes.key?(:'match_mode')
    self.match_mode = attributes[:'match_mode']
  else
    self.match_mode = 'contains'
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'link_tracking')
    self.link_tracking = attributes[:'link_tracking']
  else
    self.link_tracking = true
  end

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Instagram or Facebook account ID



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

def 
  @account_id
end

#audience ⇒ Object

Returns the value of attribute audience.



80
81
82
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 80

def audience
  @audience
end

#buttons ⇒ Object

Optional inline DM buttons (1-3). Phone buttons are Facebook-only. Omit or pass [] for a plain-text DM.



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

def buttons
  @buttons
end

#click_tag ⇒ Object

Optional tag applied to a contact when they click a tracked link (requires linkTracking). Lets you segment clickers for broadcasts/sequences.



72
73
74
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 72

def click_tag
  @click_tag
end

#comment_reply ⇒ Object

Optional public reply to the comment



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

def comment_reply
  @comment_reply
end

#comment_reply_delay_seconds ⇒ Object

Seconds to wait before posting the public comment reply. Omit or send 0 to post it right after the DM (the default). The reply never goes out before the DM, so a value below dmDelaySeconds is raised to it. Ignored when trigger=story_reply, which has no public reply.



78
79
80
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 78

def comment_reply_delay_seconds
  @comment_reply_delay_seconds
end

#comment_reply_variations ⇒ Object

Optional alternate public replies, rotated at random alongside commentReply (picked independently of the DM). Up to 5.



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

def comment_reply_variations
  @comment_reply_variations
end

#dm_delay_seconds ⇒ Object

Seconds to wait after the trigger before sending the DM. Omit or send 0 to reply immediately (the default). Max 86400 (24h). The trigger is still matched and deduplicated the moment the comment arrives, so a delay only moves when the response is sent.



75
76
77
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 75

def dm_delay_seconds
  @dm_delay_seconds
end

#dm_message ⇒ Object

DM text to send to commenter. Max 640 chars when buttons are set, otherwise ~1000.



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

def dm_message
  @dm_message
end

#dm_message_variations ⇒ Object

Optional alternate DM texts for random rotation. When set, each triggered comment sends one picked at random from [dmMessage, ...dmMessageVariations], so repeat commenters get slightly different DMs (helps avoid identical-message patterns). Up to 5. Buttons are attached to whichever text is picked, not varied.



63
64
65
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 63

def dm_message_variations
  @dm_message_variations
end

#exclude_keywords ⇒ Object

Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.



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

def exclude_keywords
  @exclude_keywords
end

#follow_gate ⇒ Object

Returns the value of attribute follow_gate.



82
83
84
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 82

def follow_gate
  @follow_gate
end

#keywords ⇒ Object

Trigger keywords (empty = any comment triggers)



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

def keywords
  @keywords
end

#link_tracking ⇒ Object

Wrap link buttons in the DM in a tracked redirect so clicks are counted (Link Clicks / CTR). Pass false to send links exactly as written. Defaults to on.



69
70
71
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 69

def link_tracking
  @link_tracking
end

#match_mode ⇒ Object

How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.



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

def match_mode
  @match_mode
end

#name ⇒ Object

Automation label



36
37
38
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 36

def name
  @name
end

#platform_post_id ⇒ Object

Platform media/post ID (or story media id when trigger=story_reply). Omit for an account-wide (any-post / any-story) automation.



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

def platform_post_id
  @platform_post_id
end

#post_id ⇒ Object

Zernio post ID. Required only when also targeting a specific post via platformPostId.



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

def post_id
  @post_id
end

#post_title ⇒ Object

Post content snippet for display



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

def post_title
  @post_title
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#template ⇒ Object

Optional product card sent INSTEAD of the plain dmMessage bubble. Mutually exclusive with buttons. dmMessage stays required: it is what gets sent the moment the card is cleared.



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

def template
  @template
end

#trigger ⇒ Object

What fires the automation. 'comment' (keyword comment on a post) or 'story_reply' (keyword reply to an Instagram story). For 'story_reply', platformPostId is the story media id (omit for any story).



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

def trigger
  @trigger
end

#typo_tolerance ⇒ Object

Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.



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

def typo_tolerance
  @typo_tolerance
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



136
137
138
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 136

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 107

def self.attribute_map
  {
    :'profile_id' => :'profileId',
    :'account_id' => :'accountId',
    :'trigger' => :'trigger',
    :'platform_post_id' => :'platformPostId',
    :'post_id' => :'postId',
    :'post_title' => :'postTitle',
    :'name' => :'name',
    :'keywords' => :'keywords',
    :'match_mode' => :'matchMode',
    :'exclude_keywords' => :'excludeKeywords',
    :'typo_tolerance' => :'typoTolerance',
    :'dm_message' => :'dmMessage',
    :'buttons' => :'buttons',
    :'template' => :'template',
    :'comment_reply' => :'commentReply',
    :'dm_message_variations' => :'dmMessageVariations',
    :'comment_reply_variations' => :'commentReplyVariations',
    :'link_tracking' => :'linkTracking',
    :'click_tag' => :'clickTag',
    :'dm_delay_seconds' => :'dmDelaySeconds',
    :'comment_reply_delay_seconds' => :'commentReplyDelaySeconds',
    :'audience' => :'audience',
    :'follow_gate' => :'followGate'
  }
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



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 571

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



146
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
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 146

def self.openapi_types
  {
    :'profile_id' => :'String',
    :'account_id' => :'String',
    :'trigger' => :'String',
    :'platform_post_id' => :'String',
    :'post_id' => :'String',
    :'post_title' => :'String',
    :'name' => :'String',
    :'keywords' => :'Array<String>',
    :'match_mode' => :'String',
    :'exclude_keywords' => :'Array<String>',
    :'typo_tolerance' => :'Boolean',
    :'dm_message' => :'String',
    :'buttons' => :'Array<DmButton>',
    :'template' => :'CommentAutomationTemplate',
    :'comment_reply' => :'String',
    :'dm_message_variations' => :'Array<String>',
    :'comment_reply_variations' => :'Array<String>',
    :'link_tracking' => :'Boolean',
    :'click_tag' => :'String',
    :'dm_delay_seconds' => :'Integer',
    :'comment_reply_delay_seconds' => :'Integer',
    :'audience' => :'CommentAutomationAudience',
    :'follow_gate' => :'CommentAutomationFollowGate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 528

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
       == o. &&
      trigger == o.trigger &&
      platform_post_id == o.platform_post_id &&
      post_id == o.post_id &&
      post_title == o.post_title &&
      name == o.name &&
      keywords == o.keywords &&
      match_mode == o.match_mode &&
      exclude_keywords == o.exclude_keywords &&
      typo_tolerance == o.typo_tolerance &&
      dm_message == o.dm_message &&
      buttons == o.buttons &&
      template == o.template &&
      comment_reply == o.comment_reply &&
      dm_message_variations == o.dm_message_variations &&
      comment_reply_variations == o.comment_reply_variations &&
      link_tracking == o.link_tracking &&
      click_tag == o.click_tag &&
      dm_delay_seconds == o.dm_delay_seconds &&
      comment_reply_delay_seconds == o.comment_reply_delay_seconds &&
      audience == o.audience &&
      follow_gate == o.follow_gate
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


558
559
560
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 558

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



564
565
566
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 564

def hash
  [profile_id, , trigger, platform_post_id, post_id, post_title, name, keywords, match_mode, exclude_keywords, typo_tolerance, dm_message, buttons, template, comment_reply, dm_message_variations, comment_reply_variations, link_tracking, click_tag, dm_delay_seconds, comment_reply_delay_seconds, audience, follow_gate].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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 316

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

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

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

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

  if !@buttons.nil? && @buttons.length > 3
    invalid_properties.push('invalid value for "buttons", number of items must be less than or equal to 3.')
  end

  if !@dm_message_variations.nil? && @dm_message_variations.length > 5
    invalid_properties.push('invalid value for "dm_message_variations", number of items must be less than or equal to 5.')
  end

  if !@comment_reply_variations.nil? && @comment_reply_variations.length > 5
    invalid_properties.push('invalid value for "comment_reply_variations", number of items must be less than or equal to 5.')
  end

  if !@dm_delay_seconds.nil? && @dm_delay_seconds > 86400
    invalid_properties.push('invalid value for "dm_delay_seconds", must be smaller than or equal to 86400.')
  end

  if !@dm_delay_seconds.nil? && @dm_delay_seconds < 0
    invalid_properties.push('invalid value for "dm_delay_seconds", must be greater than or equal to 0.')
  end

  if !@comment_reply_delay_seconds.nil? && @comment_reply_delay_seconds > 86400
    invalid_properties.push('invalid value for "comment_reply_delay_seconds", must be smaller than or equal to 86400.')
  end

  if !@comment_reply_delay_seconds.nil? && @comment_reply_delay_seconds < 0
    invalid_properties.push('invalid value for "comment_reply_delay_seconds", must be greater than or equal to 0.')
  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



593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 593

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 368

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @profile_id.nil?
  return false if @account_id.nil?
  trigger_validator = EnumAttributeValidator.new('String', ["comment", "story_reply"])
  return false unless trigger_validator.valid?(@trigger)
  return false if @name.nil?
  match_mode_validator = EnumAttributeValidator.new('String', ["exact", "contains", "word"])
  return false unless match_mode_validator.valid?(@match_mode)
  return false if @dm_message.nil?
  return false if !@buttons.nil? && @buttons.length > 3
  return false if !@dm_message_variations.nil? && @dm_message_variations.length > 5
  return false if !@comment_reply_variations.nil? && @comment_reply_variations.length > 5
  return false if !@dm_delay_seconds.nil? && @dm_delay_seconds > 86400
  return false if !@dm_delay_seconds.nil? && @dm_delay_seconds < 0
  return false if !@comment_reply_delay_seconds.nil? && @comment_reply_delay_seconds > 86400
  return false if !@comment_reply_delay_seconds.nil? && @comment_reply_delay_seconds < 0
  true
end