xero-ruby 3.2.1 → 3.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (229) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +70 -1
  3. data/lib/xero-ruby/api/accounting_api.rb +11 -2
  4. data/lib/xero-ruby/api/app_store_api.rb +87 -0
  5. data/lib/xero-ruby/api/finance_api.rb +866 -0
  6. data/lib/xero-ruby/api/payroll_au_api.rb +14 -14
  7. data/lib/xero-ruby/api/payroll_nz_api.rb +18 -12
  8. data/lib/xero-ruby/api/payroll_uk_api.rb +14 -2
  9. data/lib/xero-ruby/api_client.rb +21 -3
  10. data/lib/xero-ruby/configuration.rb +4 -0
  11. data/lib/xero-ruby/models/accounting/account.rb +34 -34
  12. data/lib/xero-ruby/models/accounting/account_type.rb +22 -22
  13. data/lib/xero-ruby/models/accounting/action.rb +2 -2
  14. data/lib/xero-ruby/models/accounting/address.rb +2 -2
  15. data/lib/xero-ruby/models/accounting/address_for_organisation.rb +3 -3
  16. data/lib/xero-ruby/models/accounting/bank_transaction.rb +11 -11
  17. data/lib/xero-ruby/models/accounting/bank_transfer.rb +35 -1
  18. data/lib/xero-ruby/models/accounting/batch_payment.rb +4 -4
  19. data/lib/xero-ruby/models/accounting/branding_theme.rb +1 -1
  20. data/lib/xero-ruby/models/accounting/budget.rb +2 -2
  21. data/lib/xero-ruby/models/accounting/budget_balance.rb +2 -2
  22. data/lib/xero-ruby/models/accounting/contact.rb +89 -4
  23. data/lib/xero-ruby/models/accounting/contact_group.rb +2 -2
  24. data/lib/xero-ruby/models/accounting/country_code.rb +240 -240
  25. data/lib/xero-ruby/models/accounting/credit_note.rb +8 -8
  26. data/lib/xero-ruby/models/accounting/currency_code.rb +166 -166
  27. data/lib/xero-ruby/models/accounting/employee.rb +4 -4
  28. data/lib/xero-ruby/models/accounting/expense_claim.rb +5 -5
  29. data/lib/xero-ruby/models/accounting/external_link.rb +5 -5
  30. data/lib/xero-ruby/models/accounting/invoice.rb +14 -14
  31. data/lib/xero-ruby/models/accounting/journal.rb +25 -25
  32. data/lib/xero-ruby/models/accounting/line_amount_types.rb +3 -3
  33. data/lib/xero-ruby/models/accounting/linked_transaction.rb +8 -8
  34. data/lib/xero-ruby/models/accounting/manual_journal.rb +5 -5
  35. data/lib/xero-ruby/models/accounting/organisation.rb +70 -70
  36. data/lib/xero-ruby/models/accounting/overpayment.rb +6 -6
  37. data/lib/xero-ruby/models/accounting/payment.rb +21 -11
  38. data/lib/xero-ruby/models/accounting/payment_term_type.rb +4 -4
  39. data/lib/xero-ruby/models/accounting/phone.rb +5 -5
  40. data/lib/xero-ruby/models/accounting/prepayment.rb +7 -7
  41. data/lib/xero-ruby/models/accounting/purchase_order.rb +5 -5
  42. data/lib/xero-ruby/models/accounting/quote_line_amount_types.rb +3 -3
  43. data/lib/xero-ruby/models/accounting/quote_status_codes.rb +6 -6
  44. data/lib/xero-ruby/models/accounting/receipt.rb +5 -5
  45. data/lib/xero-ruby/models/accounting/repeating_invoice.rb +5 -5
  46. data/lib/xero-ruby/models/accounting/report.rb +1 -1
  47. data/lib/xero-ruby/models/accounting/row_type.rb +4 -4
  48. data/lib/xero-ruby/models/accounting/schedule.rb +8 -8
  49. data/lib/xero-ruby/models/accounting/tax_rate.rb +78 -78
  50. data/lib/xero-ruby/models/accounting/tax_type.rb +59 -59
  51. data/lib/xero-ruby/models/accounting/time_zone.rb +109 -108
  52. data/lib/xero-ruby/models/accounting/tracking_category.rb +3 -3
  53. data/lib/xero-ruby/models/accounting/tracking_option.rb +3 -3
  54. data/lib/xero-ruby/models/accounting/user.rb +7 -7
  55. data/lib/xero-ruby/models/app_store/plan.rb +311 -0
  56. data/lib/xero-ruby/models/app_store/price.rb +257 -0
  57. data/lib/xero-ruby/models/app_store/problem_details.rb +272 -0
  58. data/lib/xero-ruby/models/app_store/product.rb +288 -0
  59. data/lib/xero-ruby/models/app_store/subscription.rb +361 -0
  60. data/lib/xero-ruby/models/app_store/subscription_item.rb +344 -0
  61. data/lib/xero-ruby/models/assets/asset_status.rb +3 -3
  62. data/lib/xero-ruby/models/assets/asset_status_query_param.rb +3 -3
  63. data/lib/xero-ruby/models/assets/book_depreciation_setting.rb +11 -11
  64. data/lib/xero-ruby/models/files/object_group.rb +12 -11
  65. data/lib/xero-ruby/models/files/object_type.rb +56 -55
  66. data/lib/xero-ruby/models/finance/account_usage.rb +342 -0
  67. data/lib/xero-ruby/models/finance/account_usage_response.rb +254 -0
  68. data/lib/xero-ruby/models/finance/balance_sheet_account_detail.rb +262 -0
  69. data/lib/xero-ruby/models/finance/balance_sheet_account_group.rb +234 -0
  70. data/lib/xero-ruby/models/finance/balance_sheet_account_type.rb +244 -0
  71. data/lib/xero-ruby/models/finance/balance_sheet_response.rb +252 -0
  72. data/lib/xero-ruby/models/finance/bank_statement_response.rb +232 -0
  73. data/lib/xero-ruby/models/finance/cash_account_response.rb +262 -0
  74. data/lib/xero-ruby/models/finance/cash_balance.rb +242 -0
  75. data/lib/xero-ruby/models/finance/cash_validation_response.rb +262 -0
  76. data/lib/xero-ruby/models/finance/cashflow_account.rb +282 -0
  77. data/lib/xero-ruby/models/finance/cashflow_activity.rb +244 -0
  78. data/lib/xero-ruby/models/finance/cashflow_response.rb +254 -0
  79. data/lib/xero-ruby/models/finance/cashflow_type.rb +244 -0
  80. data/lib/xero-ruby/models/finance/contact_detail.rb +274 -0
  81. data/lib/xero-ruby/models/finance/contact_total_detail.rb +242 -0
  82. data/lib/xero-ruby/models/finance/contact_total_other.rb +252 -0
  83. data/lib/xero-ruby/models/finance/current_statement_response.rb +272 -0
  84. data/lib/xero-ruby/models/finance/data_source_response.rb +362 -0
  85. data/lib/xero-ruby/models/finance/history_record_response.rb +262 -0
  86. data/lib/xero-ruby/models/finance/income_by_contact_response.rb +284 -0
  87. data/lib/xero-ruby/models/finance/lock_history_model.rb +242 -0
  88. data/lib/xero-ruby/models/finance/lock_history_response.rb +244 -0
  89. data/lib/xero-ruby/models/finance/manual_journal_total.rb +222 -0
  90. data/lib/xero-ruby/models/finance/pnl_account.rb +272 -0
  91. data/lib/xero-ruby/models/finance/pnl_account_class.rb +234 -0
  92. data/lib/xero-ruby/models/finance/pnl_account_type.rb +244 -0
  93. data/lib/xero-ruby/models/finance/practice_response.rb +262 -0
  94. data/lib/xero-ruby/models/finance/problem.rb +252 -0
  95. data/lib/xero-ruby/models/finance/problem_type.rb +39 -0
  96. data/lib/xero-ruby/models/finance/profit_and_loss_response.rb +262 -0
  97. data/lib/xero-ruby/models/finance/report_history_model.rb +242 -0
  98. data/lib/xero-ruby/models/finance/report_history_response.rb +244 -0
  99. data/lib/xero-ruby/models/finance/statement_balance_response.rb +232 -0
  100. data/lib/xero-ruby/models/finance/statement_lines_response.rb +382 -0
  101. data/lib/xero-ruby/models/finance/total_detail.rb +242 -0
  102. data/lib/xero-ruby/models/finance/total_other.rb +242 -0
  103. data/lib/xero-ruby/models/finance/trial_balance_account.rb +312 -0
  104. data/lib/xero-ruby/models/finance/trial_balance_entry.rb +232 -0
  105. data/lib/xero-ruby/models/finance/trial_balance_movement.rb +252 -0
  106. data/lib/xero-ruby/models/finance/trial_balance_response.rb +244 -0
  107. data/lib/xero-ruby/models/finance/user_activities_response.rb +244 -0
  108. data/lib/xero-ruby/models/finance/user_response.rb +336 -0
  109. data/lib/xero-ruby/models/payroll_au/account_type.rb +23 -23
  110. data/lib/xero-ruby/models/payroll_au/allowance_category.rb +41 -0
  111. data/lib/xero-ruby/models/payroll_au/allowance_type.rb +10 -7
  112. data/lib/xero-ruby/models/payroll_au/calendar_type.rb +6 -6
  113. data/lib/xero-ruby/models/payroll_au/deduction_type.rb +3 -3
  114. data/lib/xero-ruby/models/payroll_au/deduction_type_calculation_type.rb +3 -3
  115. data/lib/xero-ruby/models/payroll_au/earnings_rate.rb +14 -4
  116. data/lib/xero-ruby/models/payroll_au/earnings_rate_calculation_type.rb +3 -3
  117. data/lib/xero-ruby/models/payroll_au/earnings_type.rb +12 -10
  118. data/lib/xero-ruby/models/payroll_au/employee.rb +34 -5
  119. data/lib/xero-ruby/models/payroll_au/employee_status.rb +2 -2
  120. data/lib/xero-ruby/models/payroll_au/employment_basis.rb +5 -5
  121. data/lib/xero-ruby/models/payroll_au/employment_termination_payment_type.rb +2 -2
  122. data/lib/xero-ruby/models/payroll_au/entitlement_final_pay_payout_type.rb +2 -2
  123. data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb +5 -5
  124. data/lib/xero-ruby/models/payroll_au/leave_period_status.rb +2 -2
  125. data/lib/xero-ruby/models/payroll_au/leave_type_contribution_type.rb +4 -4
  126. data/lib/xero-ruby/models/payroll_au/manual_tax_type.rb +6 -5
  127. data/lib/xero-ruby/models/payroll_au/pay_run_status.rb +2 -2
  128. data/lib/xero-ruby/models/payroll_au/payment_frequency_type.rb +7 -7
  129. data/lib/xero-ruby/models/payroll_au/payroll_calendar.rb +11 -1
  130. data/lib/xero-ruby/models/payroll_au/rate_type.rb +3 -3
  131. data/lib/xero-ruby/models/payroll_au/residency_status.rb +3 -3
  132. data/lib/xero-ruby/models/payroll_au/state.rb +8 -8
  133. data/lib/xero-ruby/models/payroll_au/super_fund_type.rb +2 -2
  134. data/lib/xero-ruby/models/payroll_au/superannuation_calculation_type.rb +3 -3
  135. data/lib/xero-ruby/models/payroll_au/superannuation_contribution_type.rb +4 -4
  136. data/lib/xero-ruby/models/payroll_au/tfn_exemption_type.rb +4 -4
  137. data/lib/xero-ruby/models/payroll_au/timesheet_status.rb +5 -5
  138. data/lib/xero-ruby/models/payroll_nz/account.rb +4 -4
  139. data/lib/xero-ruby/models/payroll_nz/bank_account.rb +2 -2
  140. data/lib/xero-ruby/models/payroll_nz/benefit.rb +5 -5
  141. data/lib/xero-ruby/models/payroll_nz/calendar_type.rb +7 -7
  142. data/lib/xero-ruby/models/payroll_nz/deduction.rb +4 -4
  143. data/lib/xero-ruby/models/payroll_nz/earnings_rate.rb +18 -18
  144. data/lib/xero-ruby/models/payroll_nz/employee.rb +2 -2
  145. data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb +4 -4
  146. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_balance.rb +6 -6
  147. data/lib/xero-ruby/models/payroll_nz/employee_statutory_leave_summary.rb +8 -8
  148. data/lib/xero-ruby/models/payroll_nz/employee_tax.rb +5 -5
  149. data/lib/xero-ruby/models/payroll_nz/leave_period.rb +2 -2
  150. data/lib/xero-ruby/models/payroll_nz/pay_run.rb +5 -5
  151. data/lib/xero-ruby/models/payroll_nz/pay_slip.rb +3 -3
  152. data/lib/xero-ruby/models/payroll_nz/payment_method.rb +3 -3
  153. data/lib/xero-ruby/models/payroll_nz/reimbursement.rb +8 -8
  154. data/lib/xero-ruby/models/payroll_nz/salary_and_wage.rb +5 -5
  155. data/lib/xero-ruby/models/payroll_nz/statutory_deduction_category.rb +11 -11
  156. data/lib/xero-ruby/models/payroll_nz/tax_code.rb +19 -19
  157. data/lib/xero-ruby/models/payroll_nz/tax_settings.rb +2 -2
  158. data/lib/xero-ruby/models/payroll_nz/timesheet.rb +4 -4
  159. data/lib/xero-ruby/models/payroll_uk/account.rb +7 -7
  160. data/lib/xero-ruby/models/payroll_uk/benefit.rb +4 -4
  161. data/lib/xero-ruby/models/payroll_uk/deduction.rb +12 -12
  162. data/lib/xero-ruby/models/payroll_uk/earnings_rate.rb +28 -28
  163. data/lib/xero-ruby/models/payroll_uk/employee.rb +2 -2
  164. data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb +4 -4
  165. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_balance.rb +6 -6
  166. data/lib/xero-ruby/models/payroll_uk/employee_statutory_leave_summary.rb +8 -8
  167. data/lib/xero-ruby/models/payroll_uk/employment.rb +8 -8
  168. data/lib/xero-ruby/models/payroll_uk/leave_period.rb +2 -2
  169. data/lib/xero-ruby/models/payroll_uk/pay_run.rb +11 -11
  170. data/lib/xero-ruby/models/payroll_uk/pay_run_calendar.rb +6 -6
  171. data/lib/xero-ruby/models/payroll_uk/payment_method.rb +3 -3
  172. data/lib/xero-ruby/models/payroll_uk/payslip.rb +3 -3
  173. data/lib/xero-ruby/models/payroll_uk/salary_and_wage.rb +5 -5
  174. data/lib/xero-ruby/models/payroll_uk/statutory_deduction_category.rb +14 -14
  175. data/lib/xero-ruby/models/payroll_uk/timesheet.rb +3 -3
  176. data/lib/xero-ruby/models/projects/charge_type.rb +3 -3
  177. data/lib/xero-ruby/models/projects/currency_code.rb +164 -164
  178. data/lib/xero-ruby/models/projects/project_status.rb +2 -2
  179. data/lib/xero-ruby/models/projects/task.rb +3 -3
  180. data/lib/xero-ruby/models/projects/time_entry.rb +3 -3
  181. data/lib/xero-ruby/version.rb +2 -2
  182. data/lib/xero-ruby.rb +52 -0
  183. data/spec/api_client_spec.rb +3 -0
  184. data/spec/app_store/api/app_store_api_spec.rb +45 -0
  185. data/spec/app_store/models/plan_spec.rb +62 -0
  186. data/spec/app_store/models/price_spec.rb +52 -0
  187. data/spec/app_store/models/problem_details_spec.rb +70 -0
  188. data/spec/app_store/models/product_spec.rb +56 -0
  189. data/spec/app_store/models/subscription_item_spec.rb +70 -0
  190. data/spec/app_store/models/subscription_spec.rb +82 -0
  191. data/spec/configuration_spec.rb +1 -0
  192. data/spec/finance/api/finance_api_spec.rb +156 -0
  193. data/spec/finance/models/account_usage_response_spec.rb +58 -0
  194. data/spec/finance/models/account_usage_spec.rb +112 -0
  195. data/spec/finance/models/balance_sheet_account_detail_spec.rb +64 -0
  196. data/spec/finance/models/balance_sheet_account_group_spec.rb +46 -0
  197. data/spec/finance/models/balance_sheet_account_type_spec.rb +52 -0
  198. data/spec/finance/models/balance_sheet_response_spec.rb +58 -0
  199. data/spec/finance/models/bank_statement_response_spec.rb +46 -0
  200. data/spec/finance/models/cash_account_response_spec.rb +64 -0
  201. data/spec/finance/models/cash_balance_spec.rb +52 -0
  202. data/spec/finance/models/cash_validation_response_spec.rb +64 -0
  203. data/spec/finance/models/cashflow_account_spec.rb +76 -0
  204. data/spec/finance/models/cashflow_activity_spec.rb +52 -0
  205. data/spec/finance/models/cashflow_response_spec.rb +58 -0
  206. data/spec/finance/models/cashflow_type_spec.rb +52 -0
  207. data/spec/finance/models/current_statement_response_spec.rb +70 -0
  208. data/spec/finance/models/data_source_response_spec.rb +124 -0
  209. data/spec/finance/models/history_record_response_spec.rb +64 -0
  210. data/spec/finance/models/lock_history_model_spec.rb +52 -0
  211. data/spec/finance/models/lock_history_response_spec.rb +52 -0
  212. data/spec/finance/models/pnl_account_class_spec.rb +46 -0
  213. data/spec/finance/models/pnl_account_spec.rb +70 -0
  214. data/spec/finance/models/pnl_account_type_spec.rb +52 -0
  215. data/spec/finance/models/practice_response_spec.rb +64 -0
  216. data/spec/finance/models/problem_spec.rb +58 -0
  217. data/spec/finance/models/problem_type_spec.rb +34 -0
  218. data/spec/finance/models/profit_and_loss_response_spec.rb +64 -0
  219. data/spec/finance/models/report_history_model_spec.rb +52 -0
  220. data/spec/finance/models/report_history_response_spec.rb +52 -0
  221. data/spec/finance/models/statement_balance_response_spec.rb +46 -0
  222. data/spec/finance/models/statement_lines_response_spec.rb +136 -0
  223. data/spec/finance/models/trial_balance_account_spec.rb +94 -0
  224. data/spec/finance/models/trial_balance_entry_spec.rb +46 -0
  225. data/spec/finance/models/trial_balance_movement_spec.rb +58 -0
  226. data/spec/finance/models/trial_balance_response_spec.rb +52 -0
  227. data/spec/finance/models/user_activities_response_spec.rb +52 -0
  228. data/spec/finance/models/user_response_spec.rb +106 -0
  229. metadata +143 -3
@@ -0,0 +1,244 @@
1
+ =begin
2
+ #Xero Finance API
3
+
4
+ #The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ require 'time'
13
+ require 'date'
14
+
15
+ module XeroRuby::Finance
16
+ require 'bigdecimal'
17
+
18
+ class CashflowActivity
19
+ # Name of the cashflow activity type. It will be either Operating Activities, Investing Activities or Financing Activities
20
+ attr_accessor :name
21
+
22
+ # Total value of the activity type
23
+ attr_accessor :total
24
+
25
+
26
+ attr_accessor :cashflow_types
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'name' => :'name',
32
+ :'total' => :'total',
33
+ :'cashflow_types' => :'cashflowTypes'
34
+ }
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.openapi_types
39
+ {
40
+ :'name' => :'String',
41
+ :'total' => :'BigDecimal',
42
+ :'cashflow_types' => :'Array<CashflowType>'
43
+ }
44
+ end
45
+
46
+ # Initializes the object
47
+ # @param [Hash] attributes Model attributes in the form of hash
48
+ def initialize(attributes = {})
49
+ if (!attributes.is_a?(Hash))
50
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::CashflowActivity` initialize method"
51
+ end
52
+
53
+ # check to see if the attribute exists and convert string to symbol for hash key
54
+ attributes = attributes.each_with_object({}) { |(k, v), h|
55
+ if (!self.class.attribute_map.key?(k.to_sym))
56
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::CashflowActivity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
57
+ end
58
+ h[k.to_sym] = v
59
+ }
60
+
61
+ if attributes.key?(:'name')
62
+ self.name = attributes[:'name']
63
+ end
64
+
65
+ if attributes.key?(:'total')
66
+ self.total = attributes[:'total']
67
+ end
68
+
69
+ if attributes.key?(:'cashflow_types')
70
+ if (value = attributes[:'cashflow_types']).is_a?(Array)
71
+ self.cashflow_types = value
72
+ end
73
+ end
74
+ end
75
+
76
+ # Show invalid properties with the reasons. Usually used together with valid?
77
+ # @return Array for valid properties with the reasons
78
+ def list_invalid_properties
79
+ invalid_properties = Array.new
80
+ invalid_properties
81
+ end
82
+
83
+ # Check to see if the all the properties in the model are valid
84
+ # @return true if the model is valid
85
+ def valid?
86
+ true
87
+ end
88
+
89
+ # Checks equality by comparing each attribute.
90
+ # @param [Object] Object to be compared
91
+ def ==(o)
92
+ return true if self.equal?(o)
93
+ self.class == o.class &&
94
+ name == o.name &&
95
+ total == o.total &&
96
+ cashflow_types == o.cashflow_types
97
+ end
98
+
99
+ # @see the `==` method
100
+ # @param [Object] Object to be compared
101
+ def eql?(o)
102
+ self == o
103
+ end
104
+
105
+ # Calculates hash code according to all attributes.
106
+ # @return [Integer] Hash code
107
+ def hash
108
+ [name, total, cashflow_types].hash
109
+ end
110
+
111
+ # Builds the object from hash
112
+ # @param [Hash] attributes Model attributes in the form of hash
113
+ # @return [Object] Returns the model itself
114
+ def self.build_from_hash(attributes)
115
+ new.build_from_hash(attributes)
116
+ end
117
+
118
+ # Builds the object from hash
119
+ # @param [Hash] attributes Model attributes in the form of hash
120
+ # @return [Object] Returns the model itself
121
+ def build_from_hash(attributes)
122
+ return nil unless attributes.is_a?(Hash)
123
+ self.class.openapi_types.each_pair do |key, type|
124
+ if type =~ /\AArray<(.*)>/i
125
+ # check to ensure the input is an array given that the attribute
126
+ # is documented as an array but the input is not
127
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
128
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
129
+ end
130
+ elsif !attributes[self.class.attribute_map[key]].nil?
131
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
132
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
133
+ end
134
+
135
+ self
136
+ end
137
+
138
+ # Deserializes the data based on type
139
+ # @param string type Data type
140
+ # @param string value Value to be deserialized
141
+ # @return [Object] Deserialized data
142
+ def _deserialize(type, value)
143
+ case type.to_sym
144
+ when :DateTime
145
+ DateTime.parse(parse_date(value))
146
+ when :Date
147
+ Date.parse(parse_date(value))
148
+ when :String
149
+ value.to_s
150
+ when :Integer
151
+ value.to_i
152
+ when :Float
153
+ value.to_f
154
+ when :BigDecimal
155
+ BigDecimal(value.to_s)
156
+ when :Boolean
157
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
158
+ true
159
+ else
160
+ false
161
+ end
162
+ when :Object
163
+ # generic object (usually a Hash), return directly
164
+ value
165
+ when /\AArray<(?<inner_type>.+)>\z/
166
+ inner_type = Regexp.last_match[:inner_type]
167
+ value.map { |v| _deserialize(inner_type, v) }
168
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
169
+ k_type = Regexp.last_match[:k_type]
170
+ v_type = Regexp.last_match[:v_type]
171
+ {}.tap do |hash|
172
+ value.each do |k, v|
173
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
174
+ end
175
+ end
176
+ else # model
177
+ XeroRuby::Finance.const_get(type).build_from_hash(value)
178
+ end
179
+ end
180
+
181
+ # Returns the string representation of the object
182
+ # @return [String] String presentation of the object
183
+ def to_s
184
+ to_hash.to_s
185
+ end
186
+
187
+ # to_body is an alias to to_hash (backward compatibility)
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_body
190
+ to_hash
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash(downcase: false)
196
+ hash = {}
197
+ self.class.attribute_map.each_pair do |attr, param|
198
+ value = self.send(attr)
199
+ next if value.nil?
200
+ key = downcase ? attr : param
201
+ hash[key] = _to_hash(value, downcase: downcase)
202
+ end
203
+ hash
204
+ end
205
+
206
+ # Returns the object in the form of hash with snake_case
207
+ def to_attributes
208
+ to_hash(downcase: true)
209
+ end
210
+
211
+ # Outputs non-array value in the form of hash
212
+ # For object, use to_hash. Otherwise, just return the value
213
+ # @param [Object] value Any valid value
214
+ # @return [Hash] Returns the value in the form of hash
215
+ def _to_hash(value, downcase: false)
216
+ if value.is_a?(Array)
217
+ value.map do |v|
218
+ v.to_hash(downcase: downcase)
219
+ end
220
+ elsif value.is_a?(Hash)
221
+ {}.tap do |hash|
222
+ value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
223
+ end
224
+ elsif value.respond_to? :to_hash
225
+ value.to_hash(downcase: downcase)
226
+ else
227
+ value
228
+ end
229
+ end
230
+
231
+ def parse_date(datestring)
232
+ if datestring.include?('Date')
233
+ date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
234
+ original, date, timezone = *date_pattern.match(datestring)
235
+ date = (date.to_i / 1000)
236
+ Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
237
+ elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
238
+ Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
239
+ else # handle date 'types' for small subset of payroll API's
240
+ Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
241
+ end
242
+ end
243
+ end
244
+ end
@@ -0,0 +1,254 @@
1
+ =begin
2
+ #Xero Finance API
3
+
4
+ #The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
5
+
6
+ Contact: api@xero.com
7
+ Generated by: https://openapi-generator.tech
8
+ OpenAPI Generator version: 4.3.1
9
+
10
+ =end
11
+
12
+ require 'time'
13
+ require 'date'
14
+
15
+ module XeroRuby::Finance
16
+ require 'bigdecimal'
17
+
18
+ class CashflowResponse
19
+ # Start date of the report
20
+ attr_accessor :start_date
21
+
22
+ # End date of the report
23
+ attr_accessor :end_date
24
+
25
+
26
+ attr_accessor :cash_balance
27
+
28
+ # Break down of cash and cash equivalents for the period
29
+ attr_accessor :cashflow_activities
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'start_date' => :'startDate',
35
+ :'end_date' => :'endDate',
36
+ :'cash_balance' => :'cashBalance',
37
+ :'cashflow_activities' => :'cashflowActivities'
38
+ }
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'start_date' => :'Date',
45
+ :'end_date' => :'Date',
46
+ :'cash_balance' => :'CashBalance',
47
+ :'cashflow_activities' => :'Array<CashflowActivity>'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::CashflowResponse` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ attributes = attributes.each_with_object({}) { |(k, v), h|
60
+ if (!self.class.attribute_map.key?(k.to_sym))
61
+ fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::CashflowResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
+ end
63
+ h[k.to_sym] = v
64
+ }
65
+
66
+ if attributes.key?(:'start_date')
67
+ self.start_date = attributes[:'start_date']
68
+ end
69
+
70
+ if attributes.key?(:'end_date')
71
+ self.end_date = attributes[:'end_date']
72
+ end
73
+
74
+ if attributes.key?(:'cash_balance')
75
+ self.cash_balance = attributes[:'cash_balance']
76
+ end
77
+
78
+ if attributes.key?(:'cashflow_activities')
79
+ if (value = attributes[:'cashflow_activities']).is_a?(Array)
80
+ self.cashflow_activities = value
81
+ end
82
+ end
83
+ end
84
+
85
+ # Show invalid properties with the reasons. Usually used together with valid?
86
+ # @return Array for valid properties with the reasons
87
+ def list_invalid_properties
88
+ invalid_properties = Array.new
89
+ invalid_properties
90
+ end
91
+
92
+ # Check to see if the all the properties in the model are valid
93
+ # @return true if the model is valid
94
+ def valid?
95
+ true
96
+ end
97
+
98
+ # Checks equality by comparing each attribute.
99
+ # @param [Object] Object to be compared
100
+ def ==(o)
101
+ return true if self.equal?(o)
102
+ self.class == o.class &&
103
+ start_date == o.start_date &&
104
+ end_date == o.end_date &&
105
+ cash_balance == o.cash_balance &&
106
+ cashflow_activities == o.cashflow_activities
107
+ end
108
+
109
+ # @see the `==` method
110
+ # @param [Object] Object to be compared
111
+ def eql?(o)
112
+ self == o
113
+ end
114
+
115
+ # Calculates hash code according to all attributes.
116
+ # @return [Integer] Hash code
117
+ def hash
118
+ [start_date, end_date, cash_balance, cashflow_activities].hash
119
+ end
120
+
121
+ # Builds the object from hash
122
+ # @param [Hash] attributes Model attributes in the form of hash
123
+ # @return [Object] Returns the model itself
124
+ def self.build_from_hash(attributes)
125
+ new.build_from_hash(attributes)
126
+ end
127
+
128
+ # Builds the object from hash
129
+ # @param [Hash] attributes Model attributes in the form of hash
130
+ # @return [Object] Returns the model itself
131
+ def build_from_hash(attributes)
132
+ return nil unless attributes.is_a?(Hash)
133
+ self.class.openapi_types.each_pair do |key, type|
134
+ if type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
138
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
139
+ end
140
+ elsif !attributes[self.class.attribute_map[key]].nil?
141
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
142
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
143
+ end
144
+
145
+ self
146
+ end
147
+
148
+ # Deserializes the data based on type
149
+ # @param string type Data type
150
+ # @param string value Value to be deserialized
151
+ # @return [Object] Deserialized data
152
+ def _deserialize(type, value)
153
+ case type.to_sym
154
+ when :DateTime
155
+ DateTime.parse(parse_date(value))
156
+ when :Date
157
+ Date.parse(parse_date(value))
158
+ when :String
159
+ value.to_s
160
+ when :Integer
161
+ value.to_i
162
+ when :Float
163
+ value.to_f
164
+ when :BigDecimal
165
+ BigDecimal(value.to_s)
166
+ when :Boolean
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ XeroRuby::Finance.const_get(type).build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash(downcase: false)
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ next if value.nil?
210
+ key = downcase ? attr : param
211
+ hash[key] = _to_hash(value, downcase: downcase)
212
+ end
213
+ hash
214
+ end
215
+
216
+ # Returns the object in the form of hash with snake_case
217
+ def to_attributes
218
+ to_hash(downcase: true)
219
+ end
220
+
221
+ # Outputs non-array value in the form of hash
222
+ # For object, use to_hash. Otherwise, just return the value
223
+ # @param [Object] value Any valid value
224
+ # @return [Hash] Returns the value in the form of hash
225
+ def _to_hash(value, downcase: false)
226
+ if value.is_a?(Array)
227
+ value.map do |v|
228
+ v.to_hash(downcase: downcase)
229
+ end
230
+ elsif value.is_a?(Hash)
231
+ {}.tap do |hash|
232
+ value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
233
+ end
234
+ elsif value.respond_to? :to_hash
235
+ value.to_hash(downcase: downcase)
236
+ else
237
+ value
238
+ end
239
+ end
240
+
241
+ def parse_date(datestring)
242
+ if datestring.include?('Date')
243
+ date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
244
+ original, date, timezone = *date_pattern.match(datestring)
245
+ date = (date.to_i / 1000)
246
+ Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
247
+ elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
248
+ Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
249
+ else # handle date 'types' for small subset of payroll API's
250
+ Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
251
+ end
252
+ end
253
+ end
254
+ end