Class: MailSlurpClient::SearchEmailsOptions

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchEmailsOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 99

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

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

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

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

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

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

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

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

Instance Attribute Details

#before ⇒ Object

Optional filter emails received before given date time



39
40
41
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 39

def before
  @before
end

#inbox_ids ⇒ Object

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.



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

def inbox_ids
  @inbox_ids
end

#page_index ⇒ Object

Optional page index in email list pagination



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

def page_index
  @page_index
end

#page_size ⇒ Object

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results



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

def page_size
  @page_size
end

#search_filter ⇒ Object

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body



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

def search_filter
  @search_filter
end

#since ⇒ Object

Optional filter emails received after given date time



36
37
38
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 36

def since
  @since
end

#sort_direction ⇒ Object

Optional createdAt sort direction ASC or DESC



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

def sort_direction
  @sort_direction
end

#unread_only ⇒ Object

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly



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

def unread_only
  @unread_only
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'inbox_ids' => :'inboxIds',
    :'page_index' => :'pageIndex',
    :'page_size' => :'pageSize',
    :'sort_direction' => :'sortDirection',
    :'unread_only' => :'unreadOnly',
    :'search_filter' => :'searchFilter',
    :'since' => :'since',
    :'before' => :'before'
  }
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



217
218
219
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 217

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 78

def self.openapi_types
  {
    :'inbox_ids' => :'Array<String>',
    :'page_index' => :'Integer',
    :'page_size' => :'Integer',
    :'sort_direction' => :'String',
    :'unread_only' => :'Boolean',
    :'search_filter' => :'String',
    :'since' => :'DateTime',
    :'before' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      inbox_ids == o.inbox_ids &&
      page_index == o.page_index &&
      page_size == o.page_size &&
      sort_direction == o.sort_direction &&
      unread_only == o.unread_only &&
      search_filter == o.search_filter &&
      since == o.since &&
      before == o.before
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 245

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 314

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



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

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


204
205
206
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 210

def hash
  [inbox_ids, page_index, page_size, sort_direction, unread_only, search_filter, since, before].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



149
150
151
152
153
154
155
156
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  if !@page_size.nil? && @page_size > 100
    invalid_properties.push('invalid value for "page_size", must be smaller than or equal to 100.')
  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



290
291
292
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 296

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



284
285
286
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 284

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



160
161
162
163
164
165
 
# File 'lib/mailslurp_client/models/search_emails_options.rb', line 160

def valid?
  return false if !@page_size.nil? && @page_size > 100
  sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
  return false unless sort_direction_validator.valid?(@sort_direction)
  true
end