Class: Zernio::CtwaAdRequestBodyWelcomeMessage

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb

Overview

Custom chat welcome message (Meta's page_welcome_message, "Mensaje de bienvenida" / "Mensaje predefinido" in Ads Manager). Single-creative shape only; for creatives[] set it per entry.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 64

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

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

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

Instance Attribute Details

#prefill_text ⇒ Object

Message put into the user's text input, ready to send. Replaces Meta's default ("Hi! I want more info."). Lets one ad steer the opening message toward what it promotes (e.g. a specific product). Exactly one of prefillText or quickReplies.



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

def prefill_text
  @prefill_text
end

#quick_replies ⇒ Object

Tappable chips under the greeting instead of a prefilled message. Exactly one of prefillText or quickReplies. Put your own campaign or ad key in each payload: the tap arrives on the messages webhook with that payload even where Meta delivers no ad referral (Pages owned by an EU business under the Europe/Japan Messenger restrictions).



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

def quick_replies
  @quick_replies
end

#text ⇒ Object

Greeting shown when the chat opens. Replaces Meta's default ("Hi! Can we help you?").



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

def text
  @text
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 29

def self.attribute_map
  {
    :'text' => :'text',
    :'prefill_text' => :'prefillText',
    :'quick_replies' => :'quickReplies'
  }
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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 206

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 48

def self.openapi_types
  {
    :'text' => :'String',
    :'prefill_text' => :'String',
    :'quick_replies' => :'Array<CtwaAdRequestBodyWelcomeMessageQuickRepliesInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text == o.text &&
      prefill_text == o.prefill_text &&
      quick_replies == o.quick_replies
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


193
194
195
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [text, prefill_text, quick_replies].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



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

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

  if @text.to_s.length < 1
    invalid_properties.push('invalid value for "text", the character length must be greater than or equal to 1.')
  end

  if !@prefill_text.nil? && @prefill_text.to_s.length < 1
    invalid_properties.push('invalid value for "prefill_text", the character length must be greater than or equal to 1.')
  end

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

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 228

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



125
126
127
128
129
130
131
132
133
 
# File 'lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb', line 125

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @text.nil?
  return false if @text.to_s.length < 1
  return false if !@prefill_text.nil? && @prefill_text.to_s.length < 1
  return false if !@quick_replies.nil? && @quick_replies.length > 13
  return false if !@quick_replies.nil? && @quick_replies.length < 1
  true
end