Class: MailSlurpClient::ExtractCodesOptions

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

Overview

Options for extracting verification codes from email or SMS content. Use method to control extraction strategy and allowFallback to control strictness.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtractCodesOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 92

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

  if attributes.key?(:'allow_fallback')
    self.allow_fallback = attributes[:'allow_fallback']
  else
    self.allow_fallback = true
  end

  if attributes.key?(:'min_length')
    self.min_length = attributes[:'min_length']
  else
    self.min_length = 4
  end

  if attributes.key?(:'max_length')
    self.max_length = attributes[:'max_length']
  else
    self.max_length = 10
  end

  if attributes.key?(:'max_candidates')
    self.max_candidates = attributes[:'max_candidates']
  else
    self.max_candidates = 5
  end

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

Instance Attribute Details

#allow_fallback ⇒ Object

Allow fallback to deterministic pattern extraction when the selected method is unavailable.



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

def allow_fallback
  @allow_fallback
end

#custom_patterns ⇒ Object

Optional custom regex patterns for code extraction. Each pattern should have either one capture group for the code or match the full code directly.



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

def custom_patterns
  @custom_patterns
end

#max_candidates ⇒ Object

Maximum number of code candidates to return. Best candidate is also returned separately.



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

def max_candidates
  @max_candidates
end

#max_length ⇒ Object

Maximum code length to consider.



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

def max_length
  @max_length
end

#method ⇒ Object

Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.



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

def method
  @method
end

#min_length ⇒ Object

Minimum code length to consider. Typical OTP values are between 4 and 8 characters.



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

def min_length
  @min_length
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 59

def self.attribute_map
  {
    :'method' => :'method',
    :'allow_fallback' => :'allowFallback',
    :'min_length' => :'minLength',
    :'max_length' => :'maxLength',
    :'max_candidates' => :'maxCandidates',
    :'custom_patterns' => :'customPatterns'
  }
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



193
194
195
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 193

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
87
88
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 83

def self.openapi_nullable
  Set.new([
    :'method',
    :'custom_patterns'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 71

def self.openapi_types
  {
    :'method' => :'String',
    :'allow_fallback' => :'Boolean',
    :'min_length' => :'Integer',
    :'max_length' => :'Integer',
    :'max_candidates' => :'Integer',
    :'custom_patterns' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      method == o.method &&
      allow_fallback == o.allow_fallback &&
      min_length == o.min_length &&
      max_length == o.max_length &&
      max_candidates == o.max_candidates &&
      custom_patterns == o.custom_patterns
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 221

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 290

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 200

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


180
181
182
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 186

def hash
  [method, allow_fallback, min_length, max_length, max_candidates, custom_patterns].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



142
143
144
145
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 142

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



266
267
268
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 272

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



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

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



149
150
151
152
153
 
# File 'lib/mailslurp_client/models/extract_codes_options.rb', line 149

def valid?
  method_validator = EnumAttributeValidator.new('String', ["AUTO", "PATTERN", "LLM", "OCR", "OCR_THEN_LLM"])
  return false unless method_validator.valid?(@method)
  true
end