Class: MailSlurpClient::SearchInboxesOptions

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchInboxesOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 125

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

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

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

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

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

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

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

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

Instance Attribute Details

#before ⇒ Object

Optional filter by created before given date time



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

def before
  @before
end

#domain_id ⇒ Object

Optional domain ID filter



48
49
50
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 48

def domain_id
  @domain_id
end

#favourite ⇒ Object

Optionally filter results for favourites only



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

def favourite
  @favourite
end

#inbox_function ⇒ Object

Optional filter by inbox function



45
46
47
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 45

def inbox_function
  @inbox_function
end

#inbox_type ⇒ Object

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).



42
43
44
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 42

def inbox_type
  @inbox_type
end

#page_index ⇒ Object

Optional page index in list pagination



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

def page_index
  @page_index
end

#page_size ⇒ Object

Optional page size in list pagination



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

def page_size
  @page_size
end

#search ⇒ Object

Optionally filter by search words partial matching ID, tags, name, and email address



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

def search
  @search
end

#since ⇒ Object

Optional filter by created after given date time



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

def since
  @since
end

#sort_direction ⇒ Object

Optional createdAt sort direction ASC or DESC



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

def sort_direction
  @sort_direction
end

#tag ⇒ Object

Optionally filter by tags. Will return inboxes that include given tags



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

def tag
  @tag
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 73

def self.attribute_map
  {
    :'page_index' => :'pageIndex',
    :'page_size' => :'pageSize',
    :'sort_direction' => :'sortDirection',
    :'favourite' => :'favourite',
    :'search' => :'search',
    :'tag' => :'tag',
    :'since' => :'since',
    :'before' => :'before',
    :'inbox_type' => :'inboxType',
    :'inbox_function' => :'inboxFunction',
    :'domain_id' => :'domainId'
  }
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



265
266
267
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 265

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 107

def self.openapi_nullable
  Set.new([
    :'page_index',
    :'page_size',
    :'sort_direction',
    :'favourite',
    :'search',
    :'tag',
    :'since',
    :'before',
    :'inbox_type',
    :'inbox_function',
    :'domain_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 90

def self.openapi_types
  {
    :'page_index' => :'Integer',
    :'page_size' => :'Integer',
    :'sort_direction' => :'String',
    :'favourite' => :'Boolean',
    :'search' => :'String',
    :'tag' => :'String',
    :'since' => :'DateTime',
    :'before' => :'DateTime',
    :'inbox_type' => :'String',
    :'inbox_function' => :'String',
    :'domain_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      page_index == o.page_index &&
      page_size == o.page_size &&
      sort_direction == o.sort_direction &&
      favourite == o.favourite &&
      search == o.search &&
      tag == o.tag &&
      since == o.since &&
      before == o.before &&
      inbox_type == o.inbox_type &&
      inbox_function == o.inbox_function &&
      domain_id == o.domain_id
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



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
324
325
326
327
328
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 293

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 362

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



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

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


252
253
254
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 258

def hash
  [page_index, page_size, sort_direction, favourite, search, tag, since, before, inbox_type, inbox_function, domain_id].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



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

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



338
339
340
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 344

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



332
333
334
 
# File 'lib/mailslurp_client/models/search_inboxes_options.rb', line 332

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



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

def valid?
  sort_direction_validator = EnumAttributeValidator.new('String', ["ASC", "DESC"])
  return false unless sort_direction_validator.valid?(@sort_direction)
  inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"])
  return false unless inbox_type_validator.valid?(@inbox_type)
  inbox_function_validator = EnumAttributeValidator.new('String', ["ALIAS", "THREAD", "CATCH_ALL", "CONNECTOR"])
  return false unless inbox_function_validator.valid?(@inbox_function)
  true
end