Class: AsposeEmailCloud::AiNameMatchParsedRequest

Inherits:
AiNameParsedRequest show all
Defined in:
lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb

Overview

Two parsed names to match request

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cultural_context: nil, format: nil, parsed_name: nil, other_parsed_name: nil) ⇒ AiNameMatchParsedRequest

Initializes the object

Parameters:

  • cultural_context (AiNameCulturalContext) (defaults to: nil) —

    AiName parser cultural context

  • format (String) (defaults to: nil) —

    Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats: /format/default/ (= ‘%t%F%m%N%L%p’) /format/FN+LN/ (= ‘%F%L’) /format/title+FN+LN/ (= ‘%t%F%L’) /format/FN+MN+LN/ (= ‘%F%M%N%L’) /format/title+FN+MN+LN/ (= ‘%t%F%M%N%L’) /format/FN+MI+LN/ (= ‘%F%m%N%L’) /format/title+FN+MI+LN/ (= ‘%t%F%m%N%L’) /format/LN/ (= ‘%L’) /format/title+LN/ (= ‘%t%L’) /format/LN+FN+MN/ (= ‘%L,%F%M%N’) /format/LN+title+FN+MN/ (= ‘%L,%t%F%M%N’) /format/LN+FN+MI/ (= ‘%L,%F%m%N’) /format/LN+title+FN+MI/ (= ‘%L,%t%F%m%N’) Custom format string - custom combination of characters and the next term placeholders: ‘%t’ - Title (prefix) ‘%F’ - First name ‘%f’ - First initial ‘%M’ - Middle name(s) ‘%m’ - Middle initial(s) ‘%N’ - Nickname ‘%L’ - Last name ‘%l’ - Last initial ‘%p’ - Postfix If no value for format option was provided, its default value is ‘%t%F%m%N%L%p’

  • parsed_name (Array<AiNameComponent>) (defaults to: nil) —

    Parsed name

  • other_parsed_name (Array<AiNameComponent>) (defaults to: nil) —

    Other parsed name to match



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 68

def initialize(
  cultural_context: nil,
  format: nil,
  parsed_name: nil,
  other_parsed_name: nil)
  self.cultural_context = cultural_context if cultural_context
  self.format = format if format
  self.parsed_name = parsed_name if parsed_name
  self.other_parsed_name = other_parsed_name if other_parsed_name
end

Instance Attribute Details

#cultural_context ⇒ AiNameCulturalContext

AiName parser cultural context

Returns:



33
34
35
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 33

def cultural_context
  @cultural_context
end

#format ⇒ String

Format of the name. Predefined format can be used by ID, or custom format can be specified. Predefined formats: /format/default/ (= ‘%t%F%m%N%L%p’) /format/FN+LN/ (= ‘%F%L’) /format/title+FN+LN/ (= ‘%t%F%L’) /format/FN+MN+LN/ (= ‘%F%M%N%L’) /format/title+FN+MN+LN/ (= ‘%t%F%M%N%L’) /format/FN+MI+LN/ (= ‘%F%m%N%L’) /format/title+FN+MI+LN/ (= ‘%t%F%m%N%L’) /format/LN/ (= ‘%L’) /format/title+LN/ (= ‘%t%L’) /format/LN+FN+MN/ (= ‘%L,%F%M%N’) /format/LN+title+FN+MN/ (= ‘%L,%t%F%M%N’) /format/LN+FN+MI/ (= ‘%L,%F%m%N’) /format/LN+title+FN+MI/ (= ‘%L,%t%F%m%N’) Custom format string - custom combination of characters and the next term placeholders: ‘%t’ - Title (prefix) ‘%F’ - First name ‘%f’ - First initial ‘%M’ - Middle name(s) ‘%m’ - Middle initial(s) ‘%N’ - Nickname ‘%L’ - Last name ‘%l’ - Last initial ‘%p’ - Postfix If no value for format option was provided, its default value is ‘%t%F%m%N%L%p’

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 36

def format
  @format
end

#other_parsed_name ⇒ Array<AiNameComponent>

Other parsed name to match

Returns:



42
43
44
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 42

def other_parsed_name
  @other_parsed_name
end

#parsed_name ⇒ Array<AiNameComponent>

Parsed name

Returns:



39
40
41
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 39

def parsed_name
  @parsed_name
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 44

def self.attribute_map
  {
    :'cultural_context' => :'culturalContext',
    :'format' => :'format',
    :'parsed_name' => :'parsedName',
    :'other_parsed_name' => :'otherParsedName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 54

def self.swagger_types
  {
    :'cultural_context' => :'AiNameCulturalContext',
    :'format' => :'String',
    :'parsed_name' => :'Array<AiNameComponent>',
    :'other_parsed_name' => :'Array<AiNameComponent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 104

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 151

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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 221

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 128

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_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


115
116
117
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 115

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 121

def hash
  [cultural_context, format, parsed_name, other_parsed_name].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



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 81

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

  if @other_parsed_name.nil?
    invalid_properties.push('invalid value for "other_parsed_name", other_parsed_name 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



201
202
203
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 201

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



207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 207

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



195
196
197
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 195

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



96
97
98
99
100
 
# File 'lib/aspose-email-cloud/models/ai_name_match_parsed_request.rb', line 96

def valid?
  return false if @parsed_name.nil?
  return false if @other_parsed_name.nil?
  true
end