Class: XeroRuby::Accounting::Report

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

AGED_PAYABLES_BY_CONTACT = 
"AgedPayablesByContact".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Report

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 91

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

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

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

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

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

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

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

Instance Attribute Details

#contacts ⇒ Object

Returns the value of attribute contacts.



39
40
41
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 39

def contacts
  @contacts
end

#report_date ⇒ Object

Date of report



33
34
35
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 33

def report_date
  @report_date
end

#report_id ⇒ Object

See Prepayment Types



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

def report_id
  @report_id
end

#report_name ⇒ Object

See Prepayment Types



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

def report_name
  @report_name
end

#report_title ⇒ Object

See Prepayment Types



30
31
32
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 30

def report_title
  @report_title
end

#report_type ⇒ Object

See Prepayment Types



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

def report_type
  @report_type
end

#updated_date_utc ⇒ Object

Updated Date



36
37
38
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 36

def updated_date_utc
  @updated_date_utc
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
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 64

def self.attribute_map
  {
    :'report_id' => :'ReportID',
    :'report_name' => :'ReportName',
    :'report_type' => :'ReportType',
    :'report_title' => :'ReportTitle',
    :'report_date' => :'ReportDate',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'contacts' => :'Contacts'
  }
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



189
190
191
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 189

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 77

def self.openapi_types
  {
    :'report_id' => :'String',
    :'report_name' => :'String',
    :'report_type' => :'String',
    :'report_title' => :'String',
    :'report_date' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'contacts' => :'Array<TenNinetyNineContact>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      report_id == o.report_id &&
      report_name == o.report_name &&
      report_type == o.report_type &&
      report_title == o.report_title &&
      report_date == o.report_date &&
      updated_date_utc == o.updated_date_utc &&
      contacts == o.contacts
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



217
218
219
220
221
222
223
224
225
226
227
228
229
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
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 217

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::Accounting.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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 290

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 196

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


176
177
178
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 182

def hash
  [report_id, report_name, report_type, report_title, report_date, updated_date_utc, contacts].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



137
138
139
140
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 306

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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



282
283
284
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 282

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 264

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



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 270

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



258
259
260
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 258

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



144
145
146
147
148
 
# File 'lib/xero-ruby/models/accounting/report.rb', line 144

def valid?
  report_type_validator = EnumAttributeValidator.new('String', ["AgedPayablesByContact"])
  return false unless report_type_validator.valid?(@report_type)
  true
end