Class: MailSlurpClient::InlineObject

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/inline_object.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 67

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

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

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

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

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

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

Instance Attribute Details

#_email_address ⇒ Object

Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.



24
25
26
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 24

def 
  @_email_address
end

#_spam_check ⇒ Object

Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.



30
31
32
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 30

def _spam_check
  @_spam_check
end

#_subject ⇒ Object

Optional subject of the email that will be sent.



21
22
23
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 21

def _subject
  @_subject
end

#_success_message ⇒ Object

Optional success message to display if no _redirectTo present.



27
28
29
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 27

def _success_message
  @_success_message
end

#_to ⇒ Object

The email address that submitted form should be sent to.



18
19
20
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 18

def _to
  @_to
end

#other_parameters ⇒ Object

All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.



33
34
35
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 33

def other_parameters
  @other_parameters
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 36

def self.attribute_map
  {
    :'_to' => :'_to',
    :'_subject' => :'_subject',
    :'_email_address' => :'_emailAddress',
    :'_success_message' => :'_successMessage',
    :'_spam_check' => :'_spamCheck',
    :'other_parameters' => :'otherParameters'
  }
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



146
147
148
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 146

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 48

def self.openapi_types
  {
    :'_to' => :'String',
    :'_subject' => :'String',
    :'_email_address' => :'String',
    :'_success_message' => :'String',
    :'_spam_check' => :'String',
    :'other_parameters' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _to == o._to &&
      _subject == o._subject &&
       == o. &&
      _success_message == o._success_message &&
      _spam_check == o._spam_check &&
      other_parameters == o.other_parameters
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



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
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 174

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
    MailSlurpClient.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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 243

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 153

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


133
134
135
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



139
140
141
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 139

def hash
  [_to, _subject, , _success_message, _spam_check, other_parameters].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



107
108
109
110
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 107

def list_invalid_properties
  invalid_properties = Array.new
  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



219
220
221
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 219

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 225

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



213
214
215
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 213

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



114
115
116
 
# File 'lib/mailslurp_client/models/inline_object.rb', line 114

def valid?
  true
end