Class: Hubspot::CommunicationPreferences::PublicUpdateSubscriptionStatusRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicUpdateSubscriptionStatusRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::CommunicationPreferences::PublicUpdateSubscriptionStatusRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::CommunicationPreferences::PublicUpdateSubscriptionStatusRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

Instance Attribute Details

#email_address ⇒ Object

Contact’s email address.



19
20
21
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 19

def email_address
  @email_address
end

#legal_basis ⇒ Object

Legal basis for updating the contact’s status (required for GDPR enabled portals).



25
26
27
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 25

def legal_basis
  @legal_basis
end

#legal_basis_explanation ⇒ Object

A more detailed explanation to go with the legal basis (required for GDPR enabled portals).



28
29
30
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 28

def legal_basis_explanation
  @legal_basis_explanation
end

#subscription_id ⇒ Object

ID of the subscription being updated for the contact.



22
23
24
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 22

def subscription_id
  @subscription_id
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 53

def self.attribute_map
  {
    :'email_address' => :'emailAddress',
    :'subscription_id' => :'subscriptionId',
    :'legal_basis' => :'legalBasis',
    :'legal_basis_explanation' => :'legalBasisExplanation'
  }
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



171
172
173
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 171

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 63

def self.openapi_types
  {
    :'email_address' => :'String',
    :'subscription_id' => :'String',
    :'legal_basis' => :'String',
    :'legal_basis_explanation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_address == o.email_address &&
      subscription_id == o.subscription_id &&
      legal_basis == o.legal_basis &&
      legal_basis_explanation == o.legal_basis_explanation
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 199

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    Hubspot::CommunicationPreferences.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 268

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 178

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



164
165
166
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 164

def hash
  [email_address, subscription_id, legal_basis, legal_basis_explanation].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



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if @email_address.nil?
    invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 244

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 250

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



238
239
240
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 238

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
132
133
 
# File 'lib/hubspot/codegen/communication_preferences/models/public_update_subscription_status_request.rb', line 127

def valid?
  return false if @email_address.nil?
  return false if @subscription_id.nil?
  legal_basis_validator = EnumAttributeValidator.new('String', ["LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR", "PROCESS_AND_STORE", "LEGITIMATE_INTEREST_OTHER"])
  return false unless legal_basis_validator.valid?(@legal_basis)
  true
end