Class: SibApiV3Sdk::SendTestEmail

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/send_test_email.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SendTestEmail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 36

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'emailTo')
    if (value = attributes[:'emailTo']).is_a?(Array)
      self.email_to = value
    end
  end
end

Instance Attribute Details

#email_to ⇒ Object

List of the email addresses of the recipients whom you wish to send the test mail. If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day.



18
19
20
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 18

def email_to
  @email_to
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 21

def self.attribute_map
  {
    :'email_to' => :'emailTo'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 28

def self.swagger_types
  {
    :'email_to' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



64
65
66
67
68
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 64

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_to == o.email_to
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



106
107
108
109
110
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
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 106

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
    temp_model = SibApiV3Sdk.const_get(type).new
    temp_model.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



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 172

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 85

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


72
73
74
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 72

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



78
79
80
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 78

def hash
  [email_to].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



51
52
53
54
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 51

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



152
153
154
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 152

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



158
159
160
161
162
163
164
165
166
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 158

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



146
147
148
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 146

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



58
59
60
 
# File 'lib/sib-api-v3-sdk/models/send_test_email.rb', line 58

def valid?
  true
end