Class: Zernio::MetaLeadFormPlatformData

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'thank_you_enable_messenger')
    self.thank_you_enable_messenger = attributes[:'thank_you_enable_messenger']
  else
    self.thank_you_enable_messenger = false
  end

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

  if attributes.key?(:'is_phone_sms_verify_enabled')
    self.is_phone_sms_verify_enabled = attributes[:'is_phone_sms_verify_enabled']
  else
    self.is_phone_sms_verify_enabled = false
  end

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

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

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

Instance Attribute Details

#block_display_for_non_targeted_viewer ⇒ Object

Returns the value of attribute block_display_for_non_targeted_viewer.



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

def block_display_for_non_targeted_viewer
  @block_display_for_non_targeted_viewer
end

#context_card ⇒ Object

Returns the value of attribute context_card.



49
50
51
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 49

def context_card
  @context_card
end

#follow_up_action_url ⇒ Object

Returns the value of attribute follow_up_action_url.



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

def follow_up_action_url
  @follow_up_action_url
end

#is_optimized_for_quality ⇒ Object

Set true for a higher-intent form (adds a review step before submit).



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

def is_optimized_for_quality
  @is_optimized_for_quality
end

#is_phone_sms_verify_enabled ⇒ Object

Requires the lead to verify their phone number over SMS before the form submits (Meta is_phone_sms_verify_enabled). Only meaningful on a form with a PHONE question. Meta can restrict this parameter to apps holding a capability: when it does, the create fails with a 422 naming platformSpecificData.isPhoneSmsVerifyEnabled, and the toggle then has to be set in Meta's form builder.



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

def is_phone_sms_verify_enabled
  @is_phone_sms_verify_enabled
end

#locale ⇒ Object

Returns the value of attribute locale.



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

def locale
  @locale
end

#privacy_policy_link_text ⇒ Object

Returns the value of attribute privacy_policy_link_text.



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

def privacy_policy_link_text
  @privacy_policy_link_text
end

#question_page_custom_headline ⇒ Object

Returns the value of attribute question_page_custom_headline.



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

def question_page_custom_headline
  @question_page_custom_headline
end

#questions ⇒ Object

Returns the value of attribute questions.



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

def questions
  @questions
end

#thank_you_body ⇒ Object

Returns the value of attribute thank_you_body.



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

def thank_you_body
  @thank_you_body
end

#thank_you_button_text ⇒ Object

Returns the value of attribute thank_you_button_text.



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

def thank_you_button_text
  @thank_you_button_text
end

#thank_you_button_type ⇒ Object

Returns the value of attribute thank_you_button_type.



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

def thank_you_button_type
  @thank_you_button_type
end

#thank_you_enable_messenger ⇒ Object

Adds a 'Continue in Messenger' option to the thank-you page (Meta thank_you_page.enable_messenger), so the lead can carry on chatting with the Page. Set thankYouButtonType to MESSAGE_BUSINESS or P2B_MESSENGER to make the chat the primary button.



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

def thank_you_enable_messenger
  @thank_you_enable_messenger
end

#thank_you_title ⇒ Object

Returns the value of attribute thank_you_title.



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

def thank_you_title
  @thank_you_title
end

#thank_you_website_url ⇒ Object

Returns the value of attribute thank_you_website_url.



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

def thank_you_website_url
  @thank_you_website_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 52

def self.attribute_map
  {
    :'questions' => :'questions',
    :'privacy_policy_link_text' => :'privacyPolicyLinkText',
    :'follow_up_action_url' => :'followUpActionUrl',
    :'locale' => :'locale',
    :'thank_you_title' => :'thankYouTitle',
    :'thank_you_body' => :'thankYouBody',
    :'thank_you_button_text' => :'thankYouButtonText',
    :'thank_you_button_type' => :'thankYouButtonType',
    :'thank_you_website_url' => :'thankYouWebsiteUrl',
    :'thank_you_enable_messenger' => :'thankYouEnableMessenger',
    :'is_optimized_for_quality' => :'isOptimizedForQuality',
    :'is_phone_sms_verify_enabled' => :'isPhoneSmsVerifyEnabled',
    :'block_display_for_non_targeted_viewer' => :'blockDisplayForNonTargetedViewer',
    :'question_page_custom_headline' => :'questionPageCustomHeadline',
    :'context_card' => :'contextCard'
  }
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 289

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



104
105
106
107
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'questions' => :'Array<CreateLeadFormRequestQuestionsInner>',
    :'privacy_policy_link_text' => :'String',
    :'follow_up_action_url' => :'String',
    :'locale' => :'String',
    :'thank_you_title' => :'String',
    :'thank_you_body' => :'String',
    :'thank_you_button_text' => :'String',
    :'thank_you_button_type' => :'String',
    :'thank_you_website_url' => :'String',
    :'thank_you_enable_messenger' => :'Boolean',
    :'is_optimized_for_quality' => :'Boolean',
    :'is_phone_sms_verify_enabled' => :'Boolean',
    :'block_display_for_non_targeted_viewer' => :'Boolean',
    :'question_page_custom_headline' => :'String',
    :'context_card' => :'MetaLeadFormPlatformDataContextCard'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      questions == o.questions &&
      privacy_policy_link_text == o.privacy_policy_link_text &&
      follow_up_action_url == o.follow_up_action_url &&
      locale == o.locale &&
      thank_you_title == o.thank_you_title &&
      thank_you_body == o.thank_you_body &&
      thank_you_button_text == o.thank_you_button_text &&
      thank_you_button_type == o.thank_you_button_type &&
      thank_you_website_url == o.thank_you_website_url &&
      thank_you_enable_messenger == o.thank_you_enable_messenger &&
      is_optimized_for_quality == o.is_optimized_for_quality &&
      is_phone_sms_verify_enabled == o.is_phone_sms_verify_enabled &&
      block_display_for_non_targeted_viewer == o.block_display_for_non_targeted_viewer &&
      question_page_custom_headline == o.question_page_custom_headline &&
      context_card == o.context_card
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 282

def hash
  [questions, privacy_policy_link_text, follow_up_action_url, locale, thank_you_title, thank_you_body, thank_you_button_text, thank_you_button_type, thank_you_website_url, thank_you_enable_messenger, is_optimized_for_quality, is_phone_sms_verify_enabled, block_display_for_non_targeted_viewer, question_page_custom_headline, context_card].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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 196

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

  if @questions.length < 1
    invalid_properties.push('invalid value for "questions", number of items must be greater than or equal to 1.')
  end

  if !@privacy_policy_link_text.nil? && @privacy_policy_link_text.to_s.length > 70
    invalid_properties.push('invalid value for "privacy_policy_link_text", the character length must be smaller than or equal to 70.')
  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



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

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



216
217
218
219
220
221
222
 
# File 'lib/zernio-sdk/models/meta_lead_form_platform_data.rb', line 216

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