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



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 148

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?(:'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?(:'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
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

#buttons ⇒ Object

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



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

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.



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

def click_tag
  @click_tag
end

#comment_reply ⇒ Object

Optional public reply to the comment



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

def comment_reply
  @comment_reply
end

#comment_reply_variations ⇒ Object

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



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

def comment_reply_variations
  @comment_reply_variations
end

#dm_message ⇒ Object

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



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

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.



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

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



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

def link_tracking
  @link_tracking
end

#match_mode ⇒ Object

Returns the value of attribute match_mode.



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

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

#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

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



109
110
111
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 109

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



114
115
116
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 114

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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',
    :'dm_message' => :'dmMessage',
    :'buttons' => :'buttons',
    :'comment_reply' => :'commentReply',
    :'dm_message_variations' => :'dmMessageVariations',
    :'comment_reply_variations' => :'commentReplyVariations',
    :'link_tracking' => :'linkTracking',
    :'click_tag' => :'clickTag'
  }
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



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 443

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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',
    :'dm_message' => :'String',
    :'buttons' => :'Array<DmButton>',
    :'comment_reply' => :'String',
    :'dm_message_variations' => :'Array<String>',
    :'comment_reply_variations' => :'Array<String>',
    :'link_tracking' => :'Boolean',
    :'click_tag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 407

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 &&
      dm_message == o.dm_message &&
      buttons == o.buttons &&
      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
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


430
431
432
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 430

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



436
437
438
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 436

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



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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 465

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/zernio-sdk/models/create_comment_automation_request.rb', line 287

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"])
  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
  true
end