Class: PinterestSdkClient::LeadFormCommon

Inherits:
ApiModelBase show all
Defined in:
lib/pinterest_sdk/models/lead_form_common.rb

Overview

Creation fields

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 114

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

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

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

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

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

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

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

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

Instance Attribute Details

#completion_message ⇒ Object

A message for people who complete the form to let them know what happens next.



20
21
22
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 20

def completion_message
  @completion_message
end

#disclosure_language ⇒ Object

Additional disclosure language to be included in the lead form.



23
24
25
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 23

def disclosure_language
  @disclosure_language
end

#has_accepted_terms ⇒ Object

Whether the advertiser has accepted Pinterest’s terms of service for creating a lead ad. By sending us TRUE for this parameter, you agree that (i) you will use any personal information received in compliance with the privacy policy you share with Pinterest, and (ii) you will comply with Pinterest’s <a href="policy.pinterest.com/en/lead-ad-terms">Lead Ad Terms</a>. As a reminder, all advertising on Pinterest is subject to the <a href="business.pinterest.com/en/pinterest-advertising-services-agreement/">Pinterest Advertising Services Agreement</a> or an equivalent agreement as set forth on an IO



26
27
28
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 26

def has_accepted_terms
  @has_accepted_terms
end

#name ⇒ Object

Internal name of the lead form.



29
30
31
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 29

def name
  @name
end

#policy_links ⇒ Object

List of additional policy links to be displayed on the lead form.



32
33
34
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 32

def policy_links
  @policy_links
end

#privacy_policy_link ⇒ Object

A link to the advertiser’s privacy policy. This will be included in the lead form’s disclosure language.



35
36
37
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 35

def privacy_policy_link
  @privacy_policy_link
end

#questions ⇒ Object

List of questions to be displayed on the lead form.



38
39
40
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 38

def questions
  @questions
end

#status ⇒ Object

Returns the value of attribute status.



40
41
42
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 40

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 65

def self.attribute_map
  {
    :'completion_message' => :'completion_message',
    :'disclosure_language' => :'disclosure_language',
    :'has_accepted_terms' => :'has_accepted_terms',
    :'name' => :'name',
    :'policy_links' => :'policy_links',
    :'privacy_policy_link' => :'privacy_policy_link',
    :'questions' => :'questions',
    :'status' => :'status'
  }
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 266

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



103
104
105
106
107
108
109
110
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 103

def self.openapi_nullable
  Set.new([
    :'completion_message',
    :'disclosure_language',
    :'name',
    :'privacy_policy_link',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 89

def self.openapi_types
  {
    :'completion_message' => :'String',
    :'disclosure_language' => :'String',
    :'has_accepted_terms' => :'Boolean',
    :'name' => :'String',
    :'policy_links' => :'Array<LeadFormCommonPolicyLinksInner>',
    :'privacy_policy_link' => :'String',
    :'questions' => :'Array<LeadFormQuestion>',
    :'status' => :'LeadFormStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completion_message == o.completion_message &&
      disclosure_language == o.disclosure_language &&
      has_accepted_terms == o.has_accepted_terms &&
      name == o.name &&
      policy_links == o.policy_links &&
      privacy_policy_link == o.privacy_policy_link &&
      questions == o.questions &&
      status == o.status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 259

def hash
  [completion_message, disclosure_language, has_accepted_terms, name, policy_links, privacy_policy_link, questions, status].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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@policy_links.nil? && @policy_links.length > 3
    invalid_properties.push('invalid value for "policy_links", number of items must be less than or equal to 3.')
  end

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

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

  if !@questions.nil? && @questions.length < 0
    invalid_properties.push('invalid value for "questions", number of items 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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 288

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



191
192
193
194
195
196
197
198
 
# File 'lib/pinterest_sdk/models/lead_form_common.rb', line 191

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@policy_links.nil? && @policy_links.length > 3
  return false if !@policy_links.nil? && @policy_links.length < 0
  return false if !@questions.nil? && @questions.length > 10
  return false if !@questions.nil? && @questions.length < 0
  true
end