Class: Buildium::FileSearchMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/file_search_message.rb

Overview

An object that contains search criteria for retrieving files.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileSearchMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 101

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

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

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

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

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

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

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

Instance Attribute Details

#category_id ⇒ Object

Filters results to any file associated with the specified category identifier.



26
27
28
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 26

def category_id
  @category_id
end

#entity_id ⇒ Object

Filters results to any file associated with the specified entity identifier. This filter is used in conjunction with the ‘EntityType` field which must be set to the type of entity this identifier references.



20
21
22
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 20

def entity_id
  @entity_id
end

#entity_type ⇒ Object

Specifies the type of entity that ‘EntityId` refers to. This field is required if `EntityId` is specified.



23
24
25
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 23

def entity_type
  @entity_type
end

#physical_file_names ⇒ Object

Filters results to any files with a ‘PhysicalFileName`exactly matching one of the provided values.



38
39
40
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 38

def physical_file_names
  @physical_file_names
end

#title_or_description ⇒ Object

Filters results to files whose title or description contains the specified value.



29
30
31
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 29

def title_or_description
  @title_or_description
end

#uploaded_from ⇒ Object

Filters results to any files that were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.



32
33
34
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 32

def uploaded_from
  @uploaded_from
end

#uploaded_to ⇒ Object

Filters results to any files that were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.



35
36
37
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 35

def uploaded_to
  @uploaded_to
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 63

def self.attribute_map
  {
    :'entity_id' => :'EntityId',
    :'entity_type' => :'EntityType',
    :'category_id' => :'CategoryId',
    :'title_or_description' => :'TitleOrDescription',
    :'uploaded_from' => :'UploadedFrom',
    :'uploaded_to' => :'UploadedTo',
    :'physical_file_names' => :'PhysicalFileNames'
  }
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



199
200
201
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 199

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 81

def self.openapi_types
  {
    :'entity_id' => :'Integer',
    :'entity_type' => :'String',
    :'category_id' => :'Integer',
    :'title_or_description' => :'String',
    :'uploaded_from' => :'Date',
    :'uploaded_to' => :'Date',
    :'physical_file_names' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_id == o.entity_id &&
      entity_type == o.entity_type &&
      category_id == o.category_id &&
      title_or_description == o.title_or_description &&
      uploaded_from == o.uploaded_from &&
      uploaded_to == o.uploaded_to &&
      physical_file_names == o.physical_file_names
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



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
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 230

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 301

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 206

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


186
187
188
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



192
193
194
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 192

def hash
  [entity_id, entity_type, category_id, title_or_description, uploaded_from, uploaded_to, physical_file_names].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



147
148
149
150
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 147

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



277
278
279
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 277

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 283

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



271
272
273
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 271

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



154
155
156
157
158
 
# File 'lib/buildium-ruby/models/file_search_message.rb', line 154

def valid?
  entity_type_validator = EnumAttributeValidator.new('String', ["Account", "Association", "AssociationOwner", "AssociationUnit", "Lease", "OwnershipAccount", "PublicAsset", "Rental", "RentalOwner", "RentalUnit", "Tenant", "Vendor"])
  return false unless entity_type_validator.valid?(@entity_type)
  true
end