Class: MailSlurpClient::CheckCampaignProbeOptions

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

Overview

One-shot public campaign probe preflight check options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CheckCampaignProbeOptions

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
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 80

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

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

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

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

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

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

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

Instance Attribute Details

#captcha_token ⇒ Object

Optional captcha token when captcha protection is enabled



37
38
39
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 37

def captcha_token
  @captcha_token
end

#from_address ⇒ Object

Optional sender email address



19
20
21
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 19

def from_address
  @from_address
end

#html_body ⇒ Object

HTML body content to analyze



31
32
33
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 31

def html_body
  @html_body
end

#message_id ⇒ Object

Optional caller supplied message id



28
29
30
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 28

def message_id
  @message_id
end

#recipient ⇒ Object

Optional recipient email address for context



25
26
27
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 25

def recipient
  @recipient
end

#subject ⇒ Object

Optional message subject



22
23
24
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 22

def subject
  @subject
end

#text_body ⇒ Object

Text body content to analyze when HTML is absent



34
35
36
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 34

def text_body
  @text_body
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 40

def self.attribute_map
  {
    :'from_address' => :'fromAddress',
    :'subject' => :'subject',
    :'recipient' => :'recipient',
    :'message_id' => :'messageId',
    :'html_body' => :'htmlBody',
    :'text_body' => :'textBody',
    :'captcha_token' => :'captchaToken'
  }
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



260
261
262
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 260

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'from_address',
    :'subject',
    :'recipient',
    :'message_id',
    :'html_body',
    :'text_body',
    :'captcha_token'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 53

def self.openapi_types
  {
    :'from_address' => :'String',
    :'subject' => :'String',
    :'recipient' => :'String',
    :'message_id' => :'String',
    :'html_body' => :'String',
    :'text_body' => :'String',
    :'captcha_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from_address == o.from_address &&
      subject == o.subject &&
      recipient == o.recipient &&
      message_id == o.message_id &&
      html_body == o.html_body &&
      text_body == o.text_body &&
      captcha_token == o.captcha_token
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 288

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 357

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 267

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


247
248
249
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 253

def hash
  [from_address, subject, recipient, message_id, html_body, text_body, captcha_token].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@from_address.nil? && @from_address.to_s.length > 320
    invalid_properties.push('invalid value for "from_address", the character length must be smaller than or equal to 320.')
  end

  if !@from_address.nil? && @from_address.to_s.length < 0
    invalid_properties.push('invalid value for "from_address", the character length must be great than or equal to 0.')
  end

  if !@subject.nil? && @subject.to_s.length > 998
    invalid_properties.push('invalid value for "subject", the character length must be smaller than or equal to 998.')
  end

  if !@subject.nil? && @subject.to_s.length < 0
    invalid_properties.push('invalid value for "subject", the character length must be great than or equal to 0.')
  end

  if !@recipient.nil? && @recipient.to_s.length > 320
    invalid_properties.push('invalid value for "recipient", the character length must be smaller than or equal to 320.')
  end

  if !@recipient.nil? && @recipient.to_s.length < 0
    invalid_properties.push('invalid value for "recipient", the character length must be great than or equal to 0.')
  end

  if !@message_id.nil? && @message_id.to_s.length > 998
    invalid_properties.push('invalid value for "message_id", the character length must be smaller than or equal to 998.')
  end

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



333
334
335
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 339

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



327
328
329
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 327

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



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/mailslurp_client/models/check_campaign_probe_options.rb', line 163

def valid?
  return false if !@from_address.nil? && @from_address.to_s.length > 320
  return false if !@from_address.nil? && @from_address.to_s.length < 0
  return false if !@subject.nil? && @subject.to_s.length > 998
  return false if !@subject.nil? && @subject.to_s.length < 0
  return false if !@recipient.nil? && @recipient.to_s.length > 320
  return false if !@recipient.nil? && @recipient.to_s.length < 0
  return false if !@message_id.nil? && @message_id.to_s.length > 998
  return false if !@message_id.nil? && @message_id.to_s.length < 0
  true
end