Class: XeroRuby::Files::FileObject

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/files/file_object.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
# File 'lib/xero-ruby/models/files/file_object.rb', line 73

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_date_utcObject

Created date in UTC


29
30
31
# File 'lib/xero-ruby/models/files/file_object.rb', line 29

def created_date_utc
  @created_date_utc
end

#folder_idObject

Folder relation object's UUID


41
42
43
# File 'lib/xero-ruby/models/files/file_object.rb', line 41

def folder_id
  @folder_id
end

#idObject

File object's UUID


38
39
40
# File 'lib/xero-ruby/models/files/file_object.rb', line 38

def id
  @id
end

#mime_typeObject

MimeType of the file (image/png, image/jpeg, application/pdf, etc..)


23
24
25
# File 'lib/xero-ruby/models/files/file_object.rb', line 23

def mime_type
  @mime_type
end

#nameObject

File Name


20
21
22
# File 'lib/xero-ruby/models/files/file_object.rb', line 20

def name
  @name
end

#sizeObject

Numeric value in bytes


26
27
28
# File 'lib/xero-ruby/models/files/file_object.rb', line 26

def size
  @size
end

#updated_date_utcObject

Updated date in UTC


32
33
34
# File 'lib/xero-ruby/models/files/file_object.rb', line 32

def updated_date_utc
  @updated_date_utc
end

#userObject

Returns the value of attribute user


35
36
37
# File 'lib/xero-ruby/models/files/file_object.rb', line 35

def user
  @user
end

Class Method Details

.attribute_mapObject

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


44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/xero-ruby/models/files/file_object.rb', line 44

def self.attribute_map
  {
    :'name' => :'Name',
    :'mime_type' => :'MimeType',
    :'size' => :'Size',
    :'created_date_utc' => :'CreatedDateUtc',
    :'updated_date_utc' => :'UpdatedDateUtc',
    :'user' => :'User',
    :'id' => :'Id',
    :'folder_id' => :'FolderId'
  }
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


162
163
164
# File 'lib/xero-ruby/models/files/file_object.rb', line 162

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

.openapi_typesObject

Attribute type mapping.


58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/xero-ruby/models/files/file_object.rb', line 58

def self.openapi_types
  {
    :'name' => :'String',
    :'mime_type' => :'String',
    :'size' => :'Integer',
    :'created_date_utc' => :'String',
    :'updated_date_utc' => :'String',
    :'user' => :'User',
    :'id' => :'String',
    :'folder_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/xero-ruby/models/files/file_object.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      mime_type == o.mime_type &&
      size == o.size &&
      created_date_utc == o.created_date_utc &&
      updated_date_utc == o.updated_date_utc &&
      user == o.user &&
      id == o.id &&
      folder_id == o.folder_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


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/xero-ruby/models/files/file_object.rb', line 190

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Files.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/xero-ruby/models/files/file_object.rb', line 263

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/xero-ruby/models/files/file_object.rb', line 169

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

149
150
151
# File 'lib/xero-ruby/models/files/file_object.rb', line 149

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


155
156
157
# File 'lib/xero-ruby/models/files/file_object.rb', line 155

def hash
  [name, mime_type, size, created_date_utc, updated_date_utc, user, id, folder_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


121
122
123
124
# File 'lib/xero-ruby/models/files/file_object.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


279
280
281
282
283
284
285
286
287
288
# File 'lib/xero-ruby/models/files/file_object.rb', line 279

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


255
256
257
# File 'lib/xero-ruby/models/files/file_object.rb', line 255

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


237
238
239
# File 'lib/xero-ruby/models/files/file_object.rb', line 237

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


243
244
245
246
247
248
249
250
251
252
# File 'lib/xero-ruby/models/files/file_object.rb', line 243

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


231
232
233
# File 'lib/xero-ruby/models/files/file_object.rb', line 231

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


128
129
130
# File 'lib/xero-ruby/models/files/file_object.rb', line 128

def valid?
  true
end