buildium-ruby 2.0.1 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1060) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +1 -3
  3. data/.github/workflows/publish.yml +2 -2
  4. data/.openapi-generator/FILES +200 -405
  5. data/.openapi-generator/templates/ruby-client/Gemfile.mustache +3 -0
  6. data/.openapi-generator/templates/ruby-client/gemspec.mustache +1 -3
  7. data/.openapi-generator/templates/ruby-client/rubocop.mustache +1 -1
  8. data/.rubocop.yml +1 -1
  9. data/.tool-versions +1 -0
  10. data/CUSTOMIZATIONS.md +4 -0
  11. data/DOCS.md +404 -112
  12. data/Gemfile +1 -7
  13. data/Gemfile.lock +9 -54
  14. data/README.md +2 -2
  15. data/bin/CUSTOMIZATIONS.md +4 -0
  16. data/bin/README.md +2 -2
  17. data/bin/config.yml +5 -2
  18. data/bin/rebuild.sh +15 -9
  19. data/bin/swagger.json +17251 -8723
  20. data/buildium-ruby.gemspec +2 -4
  21. data/docs/AccountingEntityMessage.md +3 -1
  22. data/docs/AccountingEntitySaveMessage.md +3 -1
  23. data/docs/{AssociationAppliancesApi.md → AppliancesApi.md} +41 -41
  24. data/docs/ApplicantMessage.md +2 -0
  25. data/docs/AppliedVendorCreditMessage.md +20 -0
  26. data/docs/AssociationMessage.md +3 -1
  27. data/docs/AssociationMeterReadingsApi.md +344 -0
  28. data/docs/AssociationOwnershipAccountSearchMessage.md +2 -0
  29. data/docs/AssociationPostMessage.md +3 -1
  30. data/docs/AssociationSearchMessage.md +5 -1
  31. data/docs/AssociationTaxInformationMessage.md +26 -0
  32. data/docs/AssociationsApi.md +204 -217
  33. data/docs/BankAccountCheckAccountingEntitySaveMessage.md +3 -1
  34. data/docs/BankAccountCheckFileMessage.md +28 -0
  35. data/docs/BankAccountDepositPostMessage.md +1 -1
  36. data/docs/BankAccountMessage.md +3 -1
  37. data/docs/BankAccountSearchMessage.md +3 -1
  38. data/docs/BankAccountTransferAccountingEntitySaveMessage.md +3 -1
  39. data/docs/BankAccountsApi.md +412 -0
  40. data/docs/BankLockboxDataAssociationMessage.md +22 -0
  41. data/docs/BankLockboxDataAssociationOwnerMessage.md +30 -0
  42. data/docs/BankLockboxDataMessage.md +20 -0
  43. data/docs/BankLockboxDataOwnershipAccountMessage.md +26 -0
  44. data/docs/BankLockboxDataSearchMessage.md +18 -0
  45. data/docs/BillPaymentAccountingEntityMessage.md +3 -1
  46. data/docs/BillPaymentMessage.md +4 -0
  47. data/docs/BillsApi.md +1059 -0
  48. data/docs/BoardMembersApi.md +417 -0
  49. data/docs/BudgetsApi.md +329 -0
  50. data/docs/CCPaymentsMessage.md +18 -0
  51. data/docs/CCPaymentsPutMessage.md +18 -0
  52. data/docs/CancellationToken.md +22 -0
  53. data/docs/CommunicationsApi.md +39 -39
  54. data/docs/ContactRequestsApi.md +347 -0
  55. data/docs/EFTPaymentsMessage.md +18 -0
  56. data/docs/EFTPaymentsPutMessage.md +18 -0
  57. data/docs/EPaySettingsMessage.md +22 -0
  58. data/docs/EPaySettingsPutMessage.md +22 -0
  59. data/docs/FileSharingAccountMessage.md +26 -0
  60. data/docs/FileSharingAccountPutMessage.md +26 -0
  61. data/docs/FileSharingAssociationMessage.md +20 -0
  62. data/docs/FileSharingAssociationOwnerMessage.md +18 -0
  63. data/docs/FileSharingAssociationOwnerPutMessage.md +18 -0
  64. data/docs/FileSharingAssociationPutMessage.md +20 -0
  65. data/docs/FileSharingAssociationUnitMessage.md +20 -0
  66. data/docs/FileSharingAssociationUnitPutMessage.md +20 -0
  67. data/docs/FileSharingCommitteeMessage.md +22 -0
  68. data/docs/FileSharingCommitteePutMessage.md +22 -0
  69. data/docs/FileSharingLeaseMessage.md +20 -0
  70. data/docs/FileSharingLeasePutMessage.md +20 -0
  71. data/docs/FileSharingMessage.md +40 -0
  72. data/docs/FileSharingOwnershipAccountMessage.md +20 -0
  73. data/docs/FileSharingOwnershipAccountPutMessage.md +20 -0
  74. data/docs/FileSharingPutMessage.md +40 -0
  75. data/docs/FileSharingRentalMessage.md +20 -0
  76. data/docs/FileSharingRentalOwnerMessage.md +18 -0
  77. data/docs/FileSharingRentalOwnerPutMessage.md +18 -0
  78. data/docs/FileSharingRentalPutMessage.md +20 -0
  79. data/docs/FileSharingRentalUnitMesage.md +20 -0
  80. data/docs/FileSharingRentalUnitPutMesage.md +20 -0
  81. data/docs/FileSharingTenantMessage.md +20 -0
  82. data/docs/FileSharingTenantPutMessage.md +20 -0
  83. data/docs/FileSharingVendorMessage.md +18 -0
  84. data/docs/FileSharingVendorPutMessage.md +18 -0
  85. data/docs/FilesApi.md +159 -3
  86. data/docs/GeneralJournalEntryLineSaveMessage.md +1 -1
  87. data/docs/GeneralLedgerApi.md +839 -0
  88. data/docs/GeneralLedgerEntryMessage.md +30 -0
  89. data/docs/GeneralLedgerMessage.md +26 -0
  90. data/docs/GeneralLedgerSearchMessage.md +28 -0
  91. data/docs/ImageReorderRequestPutMessage.md +18 -0
  92. data/docs/InsuredTenantMessage.md +24 -0
  93. data/docs/JournalLineMessage.md +3 -1
  94. data/docs/JsonPatchOperation.md +24 -0
  95. data/docs/LeaseAutoAllocatedPaymentPostMessage.md +30 -0
  96. data/docs/LeaseLedgerPaymentPutMessage.md +28 -0
  97. data/docs/LeasePostMessage.md +5 -1
  98. data/docs/LeaseRenewalSearchMessage.md +22 -0
  99. data/docs/LeaseRentMessage.md +1 -1
  100. data/docs/LeaseTenantMessage.md +3 -1
  101. data/docs/LeaseTransactionMessage.md +3 -1
  102. data/docs/LeaseTransactionsApi.md +1627 -0
  103. data/docs/LeasesApi.md +302 -1353
  104. data/docs/ListingEntityFilePostMessage.md +22 -0
  105. data/docs/ListingsApi.md +5 -5
  106. data/docs/MeterReadingDetailMessage.md +28 -0
  107. data/docs/MeterReadingDetailPutMessage.md +24 -0
  108. data/docs/MeterReadingDetailsDeleteSearchMessage.md +20 -0
  109. data/docs/MeterReadingDetailsMessage.md +22 -0
  110. data/docs/MeterReadingDetailsPutMessage.md +22 -0
  111. data/docs/MeterReadingDetailsPutSearchMessage.md +20 -0
  112. data/docs/MeterReadingDetailsSearchMessage.md +20 -0
  113. data/docs/MeterReadingMessage.md +26 -0
  114. data/docs/MeterReadingSearchMessage.md +22 -0
  115. data/docs/MultipleBillPaymentsPostMessage.md +26 -0
  116. data/docs/OfflinePaymentsMessage.md +22 -0
  117. data/docs/OfflinePaymentsPutMessage.md +22 -0
  118. data/docs/OwnershipAccountAutoAllocatedPaymentPostMessage.md +30 -0
  119. data/docs/OwnershipAccountLedgerPaymentPutMessage.md +28 -0
  120. data/docs/OwnershipAccountTransactionMessage.md +2 -0
  121. data/docs/{AssociationOwnershipAccountsApi.md → OwnershipAccountTransactionsApi.md} +146 -644
  122. data/docs/OwnershipAccountsApi.md +667 -0
  123. data/docs/PropertyGroupsApi.md +1 -1
  124. data/docs/RentalImageMessage.md +26 -0
  125. data/docs/RentalImagePutMessage.md +20 -0
  126. data/docs/RentalMeterReadingsApi.md +344 -0
  127. data/docs/RentalOwnerContributionDataMessage.md +20 -0
  128. data/docs/RentalOwnerContributionDataPutMessage.md +20 -0
  129. data/docs/RentalOwnerContributionMessage.md +20 -0
  130. data/docs/RentalOwnerContributionPutMessage.md +20 -0
  131. data/docs/RentalOwnerContributionReminderMessage.md +20 -0
  132. data/docs/RentalOwnerContributionReminderPutMessage.md +20 -0
  133. data/docs/RentalOwnerRequestsApi.md +503 -0
  134. data/docs/RentalPropertiesApi.md +1123 -176
  135. data/docs/RentalPropertyPostMessage.md +1 -1
  136. data/docs/RentalUnitImageMessage.md +26 -0
  137. data/docs/RentalUnitImagePutMessage.md +20 -0
  138. data/docs/RentalUnitMessage.md +2 -2
  139. data/docs/RentalUnitsApi.md +639 -0
  140. data/docs/RentersInsurancePolicyMessage.md +32 -0
  141. data/docs/ResidentCenterApi.md +255 -0
  142. data/docs/ResidentRequestTaskPostMessage.md +5 -1
  143. data/docs/ResidentRequestsApi.md +349 -0
  144. data/docs/RetailCashPropertyMessage.md +24 -0
  145. data/docs/RetailCashUnitMessage.md +22 -0
  146. data/docs/RetailCashUserDataMessage.md +30 -0
  147. data/docs/RetailCashUserMessage.md +30 -0
  148. data/docs/RetailCashUserPutMessage.md +18 -0
  149. data/docs/RetailCashUsersSearchMessage.md +28 -0
  150. data/docs/SafeWaitHandle.md +20 -0
  151. data/docs/TasksApi.md +230 -1592
  152. data/docs/ToDoRequestsApi.md +347 -0
  153. data/docs/UnitEntityMessage.md +20 -0
  154. data/docs/VendorsApi.md +1 -1
  155. data/docs/VideoLinkRequestPostMessage.md +20 -0
  156. data/docs/WaitHandle.md +20 -0
  157. data/lib/buildium-ruby/api/administration_api.rb +1 -1
  158. data/lib/buildium-ruby/api/{association_appliances_api.rb → appliances_api.rb} +52 -52
  159. data/lib/buildium-ruby/api/applicants_api.rb +1 -1
  160. data/lib/buildium-ruby/api/association_meter_readings_api.rb +363 -0
  161. data/lib/buildium-ruby/api/association_owners_api.rb +1 -1
  162. data/lib/buildium-ruby/api/association_tenants_api.rb +1 -1
  163. data/lib/buildium-ruby/api/association_units_api.rb +1 -1
  164. data/lib/buildium-ruby/api/associations_api.rb +238 -284
  165. data/lib/buildium-ruby/api/bank_accounts_api.rb +387 -1
  166. data/lib/buildium-ruby/api/bills_api.rb +965 -0
  167. data/lib/buildium-ruby/api/board_members_api.rb +406 -0
  168. data/lib/buildium-ruby/api/budgets_api.rb +302 -0
  169. data/lib/buildium-ruby/api/client_leads_api.rb +1 -1
  170. data/lib/buildium-ruby/api/communications_api.rb +49 -49
  171. data/lib/buildium-ruby/api/contact_requests_api.rb +341 -0
  172. data/lib/buildium-ruby/api/files_api.rb +144 -7
  173. data/lib/buildium-ruby/api/general_ledger_api.rb +809 -0
  174. data/lib/buildium-ruby/api/lease_transactions_api.rb +1531 -0
  175. data/lib/buildium-ruby/api/leases_api.rb +193 -1191
  176. data/lib/buildium-ruby/api/listings_api.rb +5 -5
  177. data/lib/buildium-ruby/api/{association_ownership_accounts_api.rb → ownership_account_transactions_api.rb} +166 -613
  178. data/lib/buildium-ruby/api/ownership_accounts_api.rb +626 -0
  179. data/lib/buildium-ruby/api/property_groups_api.rb +3 -3
  180. data/lib/buildium-ruby/api/rental_appliances_api.rb +1 -1
  181. data/lib/buildium-ruby/api/rental_meter_readings_api.rb +363 -0
  182. data/lib/buildium-ruby/api/rental_owner_requests_api.rb +478 -0
  183. data/lib/buildium-ruby/api/rental_owners_api.rb +1 -1
  184. data/lib/buildium-ruby/api/rental_properties_api.rb +898 -54
  185. data/lib/buildium-ruby/api/rental_tenants_api.rb +1 -1
  186. data/lib/buildium-ruby/api/rental_units_api.rb +582 -1
  187. data/lib/buildium-ruby/api/resident_center_api.rb +242 -1
  188. data/lib/buildium-ruby/api/resident_requests_api.rb +344 -0
  189. data/lib/buildium-ruby/api/tasks_api.rb +345 -1624
  190. data/lib/buildium-ruby/api/to_do_requests_api.rb +341 -0
  191. data/lib/buildium-ruby/api/vendors_api.rb +3 -3
  192. data/lib/buildium-ruby/api/work_orders_api.rb +1 -1
  193. data/lib/buildium-ruby/api_client.rb +1 -1
  194. data/lib/buildium-ruby/api_error.rb +1 -1
  195. data/lib/buildium-ruby/configuration.rb +1 -1
  196. data/lib/buildium-ruby/models/account_info_message.rb +1 -1
  197. data/lib/buildium-ruby/models/accounting_entity_message.rb +14 -5
  198. data/lib/buildium-ruby/models/accounting_entity_save_message.rb +15 -5
  199. data/lib/buildium-ruby/models/accounting_lock_period_message.rb +1 -1
  200. data/lib/buildium-ruby/models/accounting_settings_message.rb +1 -1
  201. data/lib/buildium-ruby/models/address_message.rb +1 -1
  202. data/lib/buildium-ruby/models/all_tasks_message.rb +1 -1
  203. data/lib/buildium-ruby/models/announcement_message.rb +1 -1
  204. data/lib/buildium-ruby/models/announcement_post_message.rb +1 -1
  205. data/lib/buildium-ruby/models/announcement_search_message.rb +1 -1
  206. data/lib/buildium-ruby/models/announcement_sender_message.rb +1 -1
  207. data/lib/buildium-ruby/models/api_error_response.rb +1 -1
  208. data/lib/buildium-ruby/models/appliance_message.rb +1 -1
  209. data/lib/buildium-ruby/models/applicant_application_message.rb +1 -1
  210. data/lib/buildium-ruby/models/applicant_group_message.rb +1 -1
  211. data/lib/buildium-ruby/models/applicant_group_post_message.rb +1 -1
  212. data/lib/buildium-ruby/models/applicant_group_put_message.rb +1 -1
  213. data/lib/buildium-ruby/models/applicant_group_search_message.rb +1 -1
  214. data/lib/buildium-ruby/models/applicant_message.rb +46 -2
  215. data/lib/buildium-ruby/models/applicant_post_message.rb +1 -1
  216. data/lib/buildium-ruby/models/applicant_put_message.rb +1 -1
  217. data/lib/buildium-ruby/models/applicant_search_message.rb +1 -1
  218. data/lib/buildium-ruby/models/application_message.rb +1 -1
  219. data/lib/buildium-ruby/models/application_put_message.rb +1 -1
  220. data/lib/buildium-ruby/models/application_response_field_message.rb +3 -3
  221. data/lib/buildium-ruby/models/application_response_message.rb +3 -3
  222. data/lib/buildium-ruby/models/application_section_response_message.rb +1 -1
  223. data/lib/buildium-ruby/models/applied_vendor_credit_message.rb +228 -0
  224. data/lib/buildium-ruby/models/association_appliance_message.rb +1 -1
  225. data/lib/buildium-ruby/models/association_appliance_post_message.rb +1 -1
  226. data/lib/buildium-ruby/models/association_appliance_put_message.rb +1 -1
  227. data/lib/buildium-ruby/models/association_appliance_search_message.rb +1 -1
  228. data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +1 -1
  229. data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +1 -1
  230. data/lib/buildium-ruby/models/association_board_member_message.rb +1 -1
  231. data/lib/buildium-ruby/models/association_board_member_post_message.rb +1 -1
  232. data/lib/buildium-ruby/models/association_board_member_put_message.rb +1 -1
  233. data/lib/buildium-ruby/models/association_board_member_search_message.rb +1 -1
  234. data/lib/buildium-ruby/models/association_message.rb +14 -5
  235. data/lib/buildium-ruby/models/association_owner_board_term_message.rb +1 -1
  236. data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +1 -1
  237. data/lib/buildium-ruby/models/association_owner_message.rb +1 -1
  238. data/lib/buildium-ruby/models/association_owner_post_message.rb +1 -1
  239. data/lib/buildium-ruby/models/association_owner_put_message.rb +1 -1
  240. data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +1 -1
  241. data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +1 -1
  242. data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +1 -1
  243. data/lib/buildium-ruby/models/association_ownership_account_message.rb +1 -1
  244. data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +1 -1
  245. data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +1 -1
  246. data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +14 -2
  247. data/lib/buildium-ruby/models/association_post_message.rb +14 -5
  248. data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +1 -1
  249. data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +1 -1
  250. data/lib/buildium-ruby/models/association_put_message.rb +1 -1
  251. data/lib/buildium-ruby/models/association_search_message.rb +29 -5
  252. data/lib/buildium-ruby/models/association_tax_information_message.rb +292 -0
  253. data/lib/buildium-ruby/models/association_tenant_message.rb +1 -1
  254. data/lib/buildium-ruby/models/association_tenant_post_message.rb +1 -1
  255. data/lib/buildium-ruby/models/association_tenant_put_message.rb +1 -1
  256. data/lib/buildium-ruby/models/association_unit_message.rb +1 -1
  257. data/lib/buildium-ruby/models/association_unit_put_message.rb +1 -1
  258. data/lib/buildium-ruby/models/association_unit_search_message.rb +1 -1
  259. data/lib/buildium-ruby/models/association_units_post_message.rb +1 -1
  260. data/lib/buildium-ruby/models/association_user_search_message.rb +1 -1
  261. data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +15 -5
  262. data/lib/buildium-ruby/models/bank_account_check_file_message.rb +268 -0
  263. data/lib/buildium-ruby/models/bank_account_check_line_message.rb +1 -1
  264. data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +1 -1
  265. data/lib/buildium-ruby/models/bank_account_check_message.rb +1 -1
  266. data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +1 -1
  267. data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +1 -1
  268. data/lib/buildium-ruby/models/bank_account_check_post_message.rb +1 -1
  269. data/lib/buildium-ruby/models/bank_account_check_put_message.rb +1 -1
  270. data/lib/buildium-ruby/models/bank_account_check_search_message.rb +1 -1
  271. data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +1 -1
  272. data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +1 -1
  273. data/lib/buildium-ruby/models/bank_account_deposit_message.rb +1 -1
  274. data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +2 -2
  275. data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +1 -1
  276. data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +1 -1
  277. data/lib/buildium-ruby/models/bank_account_message.rb +15 -5
  278. data/lib/buildium-ruby/models/bank_account_post_message.rb +1 -1
  279. data/lib/buildium-ruby/models/bank_account_put_message.rb +1 -1
  280. data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +1 -1
  281. data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +1 -1
  282. data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +1 -1
  283. data/lib/buildium-ruby/models/bank_account_search_message.rb +17 -5
  284. data/lib/buildium-ruby/models/bank_account_transaction_message.rb +3 -3
  285. data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +1 -1
  286. data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +15 -5
  287. data/lib/buildium-ruby/models/bank_account_transfer_message.rb +1 -1
  288. data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +1 -1
  289. data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +1 -1
  290. data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +1 -1
  291. data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +1 -1
  292. data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +1 -1
  293. data/lib/buildium-ruby/models/bank_lockbox_data_association_message.rb +238 -0
  294. data/lib/buildium-ruby/models/bank_lockbox_data_association_owner_message.rb +314 -0
  295. data/lib/buildium-ruby/models/bank_lockbox_data_message.rb +229 -0
  296. data/lib/buildium-ruby/models/bank_lockbox_data_ownership_account_message.rb +293 -0
  297. data/lib/buildium-ruby/models/bank_lockbox_data_search_message.rb +220 -0
  298. data/lib/buildium-ruby/models/bill_file_message.rb +1 -1
  299. data/lib/buildium-ruby/models/bill_line_message.rb +1 -1
  300. data/lib/buildium-ruby/models/bill_line_post_message.rb +1 -1
  301. data/lib/buildium-ruby/models/bill_line_put_message.rb +1 -1
  302. data/lib/buildium-ruby/models/bill_markup_message.rb +1 -1
  303. data/lib/buildium-ruby/models/bill_markup_save_message.rb +1 -1
  304. data/lib/buildium-ruby/models/bill_message.rb +1 -1
  305. data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +15 -5
  306. data/lib/buildium-ruby/models/bill_payment_line_message.rb +1 -1
  307. data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +1 -1
  308. data/lib/buildium-ruby/models/bill_payment_message.rb +26 -2
  309. data/lib/buildium-ruby/models/bill_payment_post_message.rb +1 -1
  310. data/lib/buildium-ruby/models/bill_post_message.rb +1 -1
  311. data/lib/buildium-ruby/models/bill_put_message.rb +1 -1
  312. data/lib/buildium-ruby/models/bill_search_message.rb +1 -1
  313. data/lib/buildium-ruby/models/budget_details_message.rb +1 -1
  314. data/lib/buildium-ruby/models/budget_details_save_message.rb +1 -1
  315. data/lib/buildium-ruby/models/budget_message.rb +1 -1
  316. data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +1 -1
  317. data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +1 -1
  318. data/lib/buildium-ruby/models/budget_post_message.rb +1 -1
  319. data/lib/buildium-ruby/models/budget_put_message.rb +1 -1
  320. data/lib/buildium-ruby/models/budget_search_message.rb +1 -1
  321. data/lib/buildium-ruby/models/cancellation_token.rb +235 -0
  322. data/lib/buildium-ruby/models/cc_payments_message.rb +219 -0
  323. data/lib/buildium-ruby/models/cc_payments_put_message.rb +224 -0
  324. data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +1 -1
  325. data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +1 -1
  326. data/lib/buildium-ruby/models/check_printing_info_message.rb +1 -1
  327. data/lib/buildium-ruby/models/check_printing_info_post_message.rb +1 -1
  328. data/lib/buildium-ruby/models/check_printing_info_put_message.rb +1 -1
  329. data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +1 -1
  330. data/lib/buildium-ruby/models/client_lead_message.rb +1 -1
  331. data/lib/buildium-ruby/models/client_lead_search_message.rb +1 -1
  332. data/lib/buildium-ruby/models/contact_detail_message.rb +1 -1
  333. data/lib/buildium-ruby/models/contact_detail_phone_message.rb +1 -1
  334. data/lib/buildium-ruby/models/contact_detail_save_message.rb +1 -1
  335. data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +1 -1
  336. data/lib/buildium-ruby/models/contact_info_message.rb +1 -1
  337. data/lib/buildium-ruby/models/contact_request_task_message.rb +1 -1
  338. data/lib/buildium-ruby/models/contact_request_task_post_message.rb +1 -1
  339. data/lib/buildium-ruby/models/contact_request_task_put_message.rb +1 -1
  340. data/lib/buildium-ruby/models/contact_request_task_search_message.rb +1 -1
  341. data/lib/buildium-ruby/models/cosigner_message.rb +1 -1
  342. data/lib/buildium-ruby/models/created_by_user_message.rb +1 -1
  343. data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +1 -1
  344. data/lib/buildium-ruby/models/deposit_detail_message.rb +1 -1
  345. data/lib/buildium-ruby/models/e_pay_settings_message.rb +235 -0
  346. data/lib/buildium-ruby/models/e_pay_settings_put_message.rb +250 -0
  347. data/lib/buildium-ruby/models/eft_payments_message.rb +219 -0
  348. data/lib/buildium-ruby/models/eft_payments_put_message.rb +224 -0
  349. data/lib/buildium-ruby/models/electronic_payments_message.rb +1 -1
  350. data/lib/buildium-ruby/models/email_message.rb +1 -1
  351. data/lib/buildium-ruby/models/email_post_message.rb +1 -1
  352. data/lib/buildium-ruby/models/email_recipient_message.rb +1 -1
  353. data/lib/buildium-ruby/models/email_search_message.rb +1 -1
  354. data/lib/buildium-ruby/models/email_sender_message.rb +1 -1
  355. data/lib/buildium-ruby/models/emergency_contact_message.rb +1 -1
  356. data/lib/buildium-ruby/models/file_category_message.rb +1 -1
  357. data/lib/buildium-ruby/models/file_category_post_message.rb +1 -1
  358. data/lib/buildium-ruby/models/file_category_put_message.rb +1 -1
  359. data/lib/buildium-ruby/models/file_download_message.rb +1 -1
  360. data/lib/buildium-ruby/models/file_entity_message.rb +1 -1
  361. data/lib/buildium-ruby/models/file_message.rb +1 -1
  362. data/lib/buildium-ruby/models/file_name_post_message.rb +1 -1
  363. data/lib/buildium-ruby/models/file_put_message.rb +1 -1
  364. data/lib/buildium-ruby/models/file_search_message.rb +1 -1
  365. data/lib/buildium-ruby/models/file_sharing_account_message.rb +263 -0
  366. data/lib/buildium-ruby/models/file_sharing_account_put_message.rb +263 -0
  367. data/lib/buildium-ruby/models/file_sharing_association_message.rb +229 -0
  368. data/lib/buildium-ruby/models/file_sharing_association_owner_message.rb +219 -0
  369. data/lib/buildium-ruby/models/file_sharing_association_owner_put_message.rb +219 -0
  370. data/lib/buildium-ruby/models/file_sharing_association_put_message.rb +229 -0
  371. data/lib/buildium-ruby/models/file_sharing_association_unit_message.rb +229 -0
  372. data/lib/buildium-ruby/models/file_sharing_association_unit_put_message.rb +229 -0
  373. data/lib/buildium-ruby/models/file_sharing_committee_message.rb +239 -0
  374. data/lib/buildium-ruby/models/file_sharing_committee_put_message.rb +239 -0
  375. data/lib/buildium-ruby/models/file_sharing_lease_message.rb +229 -0
  376. data/lib/buildium-ruby/models/file_sharing_lease_put_message.rb +229 -0
  377. data/lib/buildium-ruby/models/file_sharing_message.rb +316 -0
  378. data/lib/buildium-ruby/models/file_sharing_ownership_account_message.rb +229 -0
  379. data/lib/buildium-ruby/models/file_sharing_ownership_account_put_message.rb +229 -0
  380. data/lib/buildium-ruby/models/file_sharing_put_message.rb +316 -0
  381. data/lib/buildium-ruby/models/file_sharing_rental_message.rb +229 -0
  382. data/lib/buildium-ruby/models/file_sharing_rental_owner_message.rb +219 -0
  383. data/lib/buildium-ruby/models/file_sharing_rental_owner_put_message.rb +219 -0
  384. data/lib/buildium-ruby/models/file_sharing_rental_put_message.rb +229 -0
  385. data/lib/buildium-ruby/models/file_sharing_rental_unit_mesage.rb +229 -0
  386. data/lib/buildium-ruby/models/file_sharing_rental_unit_put_mesage.rb +229 -0
  387. data/lib/buildium-ruby/models/file_sharing_tenant_message.rb +229 -0
  388. data/lib/buildium-ruby/models/file_sharing_tenant_put_message.rb +229 -0
  389. data/lib/buildium-ruby/models/file_sharing_vendor_message.rb +219 -0
  390. data/lib/buildium-ruby/models/file_sharing_vendor_put_message.rb +219 -0
  391. data/lib/buildium-ruby/models/file_upload_post_message.rb +1 -1
  392. data/lib/buildium-ruby/models/file_upload_ticket_message.rb +1 -1
  393. data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +2 -2
  394. data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +1 -1
  395. data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +1 -1
  396. data/lib/buildium-ruby/models/general_ledger_entry_message.rb +311 -0
  397. data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +1 -1
  398. data/lib/buildium-ruby/models/general_ledger_journal_message.rb +1 -1
  399. data/lib/buildium-ruby/models/general_ledger_message.rb +260 -0
  400. data/lib/buildium-ruby/models/general_ledger_search_message.rb +336 -0
  401. data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +1 -1
  402. data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +1 -1
  403. data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +1 -1
  404. data/lib/buildium-ruby/models/gl_account_balance_message.rb +1 -1
  405. data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +1 -1
  406. data/lib/buildium-ruby/models/gl_account_message.rb +1 -1
  407. data/lib/buildium-ruby/models/gl_account_post_message.rb +1 -1
  408. data/lib/buildium-ruby/models/gl_account_put_message.rb +1 -1
  409. data/lib/buildium-ruby/models/gl_accounts_search_message.rb +1 -1
  410. data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +1 -1
  411. data/lib/buildium-ruby/models/image_reorder_request_put_message.rb +225 -0
  412. data/lib/buildium-ruby/models/insured_tenant_message.rb +248 -0
  413. data/lib/buildium-ruby/models/internal_transaction_status_message.rb +1 -1
  414. data/lib/buildium-ruby/models/journal_line_message.rb +15 -5
  415. data/lib/buildium-ruby/models/journal_message.rb +1 -1
  416. data/lib/buildium-ruby/models/json_patch_operation.rb +254 -0
  417. data/lib/buildium-ruby/models/last_updated_by_user_message.rb +1 -1
  418. data/lib/buildium-ruby/models/lease_account_detail_message.rb +1 -1
  419. data/lib/buildium-ruby/models/lease_auto_allocated_payment_post_message.rb +332 -0
  420. data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +1 -1
  421. data/lib/buildium-ruby/models/lease_charge_post_message.rb +1 -1
  422. data/lib/buildium-ruby/models/lease_charge_put_message.rb +1 -1
  423. data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +1 -1
  424. data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +1 -1
  425. data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +1 -1
  426. data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +1 -1
  427. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +1 -1
  428. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +1 -1
  429. data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +1 -1
  430. data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +1 -1
  431. data/lib/buildium-ruby/models/lease_ledger_payment_put_message.rb +319 -0
  432. data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +1 -1
  433. data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +1 -1
  434. data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +1 -1
  435. data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +1 -1
  436. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +1 -1
  437. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +1 -1
  438. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +1 -1
  439. data/lib/buildium-ruby/models/lease_message.rb +1 -1
  440. data/lib/buildium-ruby/models/lease_move_out_data_message.rb +1 -1
  441. data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +1 -1
  442. data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +1 -1
  443. data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +1 -1
  444. data/lib/buildium-ruby/models/lease_post_message.rb +27 -8
  445. data/lib/buildium-ruby/models/lease_put_message.rb +1 -1
  446. data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +1 -1
  447. data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +1 -1
  448. data/lib/buildium-ruby/models/lease_renewal_message.rb +1 -1
  449. data/lib/buildium-ruby/models/lease_renewal_post_message.rb +1 -1
  450. data/lib/buildium-ruby/models/lease_renewal_search_message.rb +272 -0
  451. data/lib/buildium-ruby/models/lease_rent_charge_message.rb +1 -1
  452. data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +1 -1
  453. data/lib/buildium-ruby/models/lease_rent_message.rb +2 -2
  454. data/lib/buildium-ruby/models/lease_rent_post_message.rb +1 -1
  455. data/lib/buildium-ruby/models/lease_search_message.rb +1 -1
  456. data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +1 -1
  457. data/lib/buildium-ruby/models/lease_tenant_message.rb +15 -5
  458. data/lib/buildium-ruby/models/lease_transaction_message.rb +47 -3
  459. data/lib/buildium-ruby/models/lease_transaction_search_message.rb +1 -1
  460. data/lib/buildium-ruby/models/listing_contact_message.rb +1 -1
  461. data/lib/buildium-ruby/models/listing_contact_save_message.rb +1 -1
  462. data/lib/buildium-ruby/models/listing_entity_file_post_message.rb +248 -0
  463. data/lib/buildium-ruby/models/listing_file_message.rb +1 -1
  464. data/lib/buildium-ruby/models/listing_message.rb +1 -1
  465. data/lib/buildium-ruby/models/listing_property_message.rb +1 -1
  466. data/lib/buildium-ruby/models/listing_put_message.rb +1 -1
  467. data/lib/buildium-ruby/models/listing_search_message.rb +1 -1
  468. data/lib/buildium-ruby/models/listing_unit_message.rb +1 -1
  469. data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +1 -1
  470. data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +1 -1
  471. data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +1 -1
  472. data/lib/buildium-ruby/models/lookup_message.rb +1 -1
  473. data/lib/buildium-ruby/models/mailing_template_message.rb +1 -1
  474. data/lib/buildium-ruby/models/meter_reading_detail_message.rb +268 -0
  475. data/lib/buildium-ruby/models/meter_reading_detail_put_message.rb +263 -0
  476. data/lib/buildium-ruby/models/meter_reading_details_delete_search_message.rb +272 -0
  477. data/lib/buildium-ruby/models/meter_reading_details_message.rb +274 -0
  478. data/lib/buildium-ruby/models/meter_reading_details_put_message.rb +289 -0
  479. data/lib/buildium-ruby/models/meter_reading_details_put_search_message.rb +262 -0
  480. data/lib/buildium-ruby/models/meter_reading_details_search_message.rb +272 -0
  481. data/lib/buildium-ruby/models/meter_reading_message.rb +292 -0
  482. data/lib/buildium-ruby/models/meter_reading_search_message.rb +272 -0
  483. data/lib/buildium-ruby/models/multiple_bill_payments_post_message.rb +277 -0
  484. data/lib/buildium-ruby/models/note_message.rb +1 -1
  485. data/lib/buildium-ruby/models/note_post_message.rb +1 -1
  486. data/lib/buildium-ruby/models/note_put_message.rb +1 -1
  487. data/lib/buildium-ruby/models/note_search_message.rb +1 -1
  488. data/lib/buildium-ruby/models/offline_payments_message.rb +239 -0
  489. data/lib/buildium-ruby/models/offline_payments_put_message.rb +249 -0
  490. data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +1 -1
  491. data/lib/buildium-ruby/models/ownership_account_auto_allocated_payment_post_message.rb +332 -0
  492. data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +1 -1
  493. data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +1 -1
  494. data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +1 -1
  495. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +1 -1
  496. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +1 -1
  497. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +1 -1
  498. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +1 -1
  499. data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +1 -1
  500. data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +1 -1
  501. data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +1 -1
  502. data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +1 -1
  503. data/lib/buildium-ruby/models/ownership_account_ledger_payment_put_message.rb +320 -0
  504. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +1 -1
  505. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +1 -1
  506. data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +1 -1
  507. data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +1 -1
  508. data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +1 -1
  509. data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +1 -1
  510. data/lib/buildium-ruby/models/ownership_account_refund_message.rb +1 -1
  511. data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +1 -1
  512. data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +46 -2
  513. data/lib/buildium-ruby/models/paid_by_message.rb +1 -1
  514. data/lib/buildium-ruby/models/participant_message.rb +1 -1
  515. data/lib/buildium-ruby/models/participant_resource_message.rb +1 -1
  516. data/lib/buildium-ruby/models/payee_message.rb +1 -1
  517. data/lib/buildium-ruby/models/payment_detail_message.rb +1 -1
  518. data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +1 -1
  519. data/lib/buildium-ruby/models/payment_transactions_message.rb +1 -1
  520. data/lib/buildium-ruby/models/phone_log_message.rb +1 -1
  521. data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +1 -1
  522. data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +1 -1
  523. data/lib/buildium-ruby/models/phone_log_post_message.rb +1 -1
  524. data/lib/buildium-ruby/models/phone_log_put_message.rb +1 -1
  525. data/lib/buildium-ruby/models/phone_log_search_message.rb +1 -1
  526. data/lib/buildium-ruby/models/phone_number_message.rb +1 -1
  527. data/lib/buildium-ruby/models/phone_numbers_message.rb +1 -1
  528. data/lib/buildium-ruby/models/property_group_message.rb +1 -1
  529. data/lib/buildium-ruby/models/property_group_post_message.rb +1 -1
  530. data/lib/buildium-ruby/models/property_group_put_message.rb +1 -1
  531. data/lib/buildium-ruby/models/property_group_search_message.rb +1 -1
  532. data/lib/buildium-ruby/models/property_manager_message.rb +1 -1
  533. data/lib/buildium-ruby/models/property_message.rb +1 -1
  534. data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +1 -1
  535. data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +1 -1
  536. data/lib/buildium-ruby/models/recurring_transaction_message.rb +1 -1
  537. data/lib/buildium-ruby/models/rental_appliance_message.rb +1 -1
  538. data/lib/buildium-ruby/models/rental_appliance_post_message.rb +1 -1
  539. data/lib/buildium-ruby/models/rental_appliance_put_message.rb +1 -1
  540. data/lib/buildium-ruby/models/rental_appliance_search_message.rb +1 -1
  541. data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +1 -1
  542. data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +1 -1
  543. data/lib/buildium-ruby/models/rental_features_message.rb +1 -1
  544. data/lib/buildium-ruby/models/rental_features_put_message.rb +1 -1
  545. data/lib/buildium-ruby/models/rental_image_message.rb +292 -0
  546. data/lib/buildium-ruby/models/rental_image_put_message.rb +233 -0
  547. data/lib/buildium-ruby/models/rental_message.rb +1 -1
  548. data/lib/buildium-ruby/models/rental_owner_contribution_data_message.rb +229 -0
  549. data/lib/buildium-ruby/models/rental_owner_contribution_data_put_message.rb +229 -0
  550. data/lib/buildium-ruby/models/rental_owner_contribution_message.rb +229 -0
  551. data/lib/buildium-ruby/models/rental_owner_contribution_put_message.rb +229 -0
  552. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_message.rb +229 -0
  553. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_put_message.rb +229 -0
  554. data/lib/buildium-ruby/models/rental_owner_message.rb +1 -1
  555. data/lib/buildium-ruby/models/rental_owner_post_message.rb +1 -1
  556. data/lib/buildium-ruby/models/rental_owner_put_message.rb +1 -1
  557. data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +1 -1
  558. data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +1 -1
  559. data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +1 -1
  560. data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +1 -1
  561. data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +1 -1
  562. data/lib/buildium-ruby/models/rental_owners_search_message.rb +1 -1
  563. data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +1 -1
  564. data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +1 -1
  565. data/lib/buildium-ruby/models/rental_property_post_message.rb +2 -2
  566. data/lib/buildium-ruby/models/rental_property_put_message.rb +1 -1
  567. data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +1 -1
  568. data/lib/buildium-ruby/models/rental_search_message.rb +1 -1
  569. data/lib/buildium-ruby/models/rental_tenant_post_message.rb +1 -1
  570. data/lib/buildium-ruby/models/rental_tenant_put_message.rb +1 -1
  571. data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +1 -1
  572. data/lib/buildium-ruby/models/rental_unit_features_message.rb +1 -1
  573. data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +1 -1
  574. data/lib/buildium-ruby/models/rental_unit_image_message.rb +292 -0
  575. data/lib/buildium-ruby/models/rental_unit_image_put_message.rb +233 -0
  576. data/lib/buildium-ruby/models/rental_unit_message.rb +3 -3
  577. data/lib/buildium-ruby/models/rental_unit_put_message.rb +1 -1
  578. data/lib/buildium-ruby/models/rental_unit_search_message.rb +1 -1
  579. data/lib/buildium-ruby/models/rental_units_post_message.rb +1 -1
  580. data/lib/buildium-ruby/models/renters_insurance_policy_message.rb +324 -0
  581. data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +1 -1
  582. data/lib/buildium-ruby/models/resident_center_user_message.rb +1 -1
  583. data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +1 -1
  584. data/lib/buildium-ruby/models/resident_center_user_search_message.rb +1 -1
  585. data/lib/buildium-ruby/models/resident_request_task_message.rb +1 -1
  586. data/lib/buildium-ruby/models/resident_request_task_post_message.rb +25 -5
  587. data/lib/buildium-ruby/models/resident_request_task_put_message.rb +1 -1
  588. data/lib/buildium-ruby/models/resident_request_task_search_message.rb +1 -1
  589. data/lib/buildium-ruby/models/retail_cash_property_message.rb +282 -0
  590. data/lib/buildium-ruby/models/retail_cash_unit_message.rb +238 -0
  591. data/lib/buildium-ruby/models/retail_cash_user_data_message.rb +312 -0
  592. data/lib/buildium-ruby/models/retail_cash_user_message.rb +274 -0
  593. data/lib/buildium-ruby/models/retail_cash_user_put_message.rb +223 -0
  594. data/lib/buildium-ruby/models/retail_cash_users_search_message.rb +304 -0
  595. data/lib/buildium-ruby/models/safe_wait_handle.rb +226 -0
  596. data/lib/buildium-ruby/models/save_address_message.rb +1 -1
  597. data/lib/buildium-ruby/models/save_emergency_contact_message.rb +1 -1
  598. data/lib/buildium-ruby/models/task_category_message.rb +1 -1
  599. data/lib/buildium-ruby/models/task_category_put_message.rb +1 -1
  600. data/lib/buildium-ruby/models/task_category_response_message.rb +1 -1
  601. data/lib/buildium-ruby/models/task_category_save_message.rb +1 -1
  602. data/lib/buildium-ruby/models/task_history_file_message.rb +1 -1
  603. data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +1 -1
  604. data/lib/buildium-ruby/models/task_history_message.rb +1 -1
  605. data/lib/buildium-ruby/models/task_history_put_message.rb +1 -1
  606. data/lib/buildium-ruby/models/task_history_user_message.rb +1 -1
  607. data/lib/buildium-ruby/models/task_search_message.rb +1 -1
  608. data/lib/buildium-ruby/models/task_sub_category_message.rb +1 -1
  609. data/lib/buildium-ruby/models/tax_information_post_message.rb +1 -1
  610. data/lib/buildium-ruby/models/tax_information_save_message.rb +1 -1
  611. data/lib/buildium-ruby/models/tenant_message.rb +1 -1
  612. data/lib/buildium-ruby/models/tenant_search_message.rb +1 -1
  613. data/lib/buildium-ruby/models/to_do_task_message.rb +1 -1
  614. data/lib/buildium-ruby/models/to_do_task_post_message.rb +1 -1
  615. data/lib/buildium-ruby/models/to_do_task_put_message.rb +1 -1
  616. data/lib/buildium-ruby/models/to_do_task_search_message.rb +1 -1
  617. data/lib/buildium-ruby/models/undeposited_funds_message.rb +1 -1
  618. data/lib/buildium-ruby/models/unit_agreement_message.rb +1 -1
  619. data/lib/buildium-ruby/models/unit_entity_message.rb +229 -0
  620. data/lib/buildium-ruby/models/user_message.rb +1 -1
  621. data/lib/buildium-ruby/models/user_role_message.rb +1 -1
  622. data/lib/buildium-ruby/models/user_search_message.rb +1 -1
  623. data/lib/buildium-ruby/models/vehicle_message.rb +1 -1
  624. data/lib/buildium-ruby/models/vendor_category_message.rb +1 -1
  625. data/lib/buildium-ruby/models/vendor_category_save_message.rb +1 -1
  626. data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +1 -1
  627. data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +1 -1
  628. data/lib/buildium-ruby/models/vendor_credit_message.rb +1 -1
  629. data/lib/buildium-ruby/models/vendor_credit_post_message.rb +1 -1
  630. data/lib/buildium-ruby/models/vendor_insurance_message.rb +1 -1
  631. data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +1 -1
  632. data/lib/buildium-ruby/models/vendor_message.rb +1 -1
  633. data/lib/buildium-ruby/models/vendor_post_message.rb +1 -1
  634. data/lib/buildium-ruby/models/vendor_put_message.rb +1 -1
  635. data/lib/buildium-ruby/models/vendor_refund_line_message.rb +1 -1
  636. data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +1 -1
  637. data/lib/buildium-ruby/models/vendor_refund_message.rb +1 -1
  638. data/lib/buildium-ruby/models/vendor_refund_post_message.rb +1 -1
  639. data/lib/buildium-ruby/models/vendor_search_message.rb +1 -1
  640. data/lib/buildium-ruby/models/vendor_tax_information_message.rb +1 -1
  641. data/lib/buildium-ruby/models/vendor_transaction_message.rb +1 -1
  642. data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +1 -1
  643. data/lib/buildium-ruby/models/video_link_request_post_message.rb +238 -0
  644. data/lib/buildium-ruby/models/wait_handle.rb +226 -0
  645. data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +1 -1
  646. data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +1 -1
  647. data/lib/buildium-ruby/models/work_order_line_item_message.rb +1 -1
  648. data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +1 -1
  649. data/lib/buildium-ruby/models/work_order_message.rb +1 -1
  650. data/lib/buildium-ruby/models/work_order_post_message.rb +1 -1
  651. data/lib/buildium-ruby/models/work_order_put_message.rb +1 -1
  652. data/lib/buildium-ruby/models/work_order_search_message.rb +1 -1
  653. data/lib/buildium-ruby/models/work_order_task_message.rb +1 -1
  654. data/lib/buildium-ruby/models/work_order_task_post_message.rb +1 -1
  655. data/lib/buildium-ruby/version.rb +2 -2
  656. data/lib/buildium-ruby.rb +101 -4
  657. data/spec/api_client_spec.rb +1 -1
  658. data/spec/configuration_spec.rb +1 -1
  659. data/spec/spec_helper.rb +1 -1
  660. metadata +206 -826
  661. data/docs/AccountingApi.md +0 -2041
  662. data/lib/buildium-ruby/api/accounting_api.rb +0 -1855
  663. data/spec/api/accounting_api_spec.rb +0 -383
  664. data/spec/api/administration_api_spec.rb +0 -114
  665. data/spec/api/applicants_api_spec.rb +0 -294
  666. data/spec/api/association_appliances_api_spec.rb +0 -141
  667. data/spec/api/association_owners_api_spec.rb +0 -195
  668. data/spec/api/association_ownership_accounts_api_spec.rb +0 -385
  669. data/spec/api/association_tenants_api_spec.rb +0 -153
  670. data/spec/api/association_units_api_spec.rb +0 -147
  671. data/spec/api/associations_api_spec.rb +0 -248
  672. data/spec/api/bank_accounts_api_spec.rb +0 -420
  673. data/spec/api/client_leads_api_spec.rb +0 -66
  674. data/spec/api/communications_api_spec.rb +0 -248
  675. data/spec/api/files_api_spec.rb +0 -156
  676. data/spec/api/leases_api_spec.rb +0 -529
  677. data/spec/api/listings_api_spec.rb +0 -139
  678. data/spec/api/property_groups_api_spec.rb +0 -88
  679. data/spec/api/rental_appliances_api_spec.rb +0 -141
  680. data/spec/api/rental_owners_api_spec.rb +0 -151
  681. data/spec/api/rental_properties_api_spec.rb +0 -205
  682. data/spec/api/rental_tenants_api_spec.rb +0 -154
  683. data/spec/api/rental_units_api_spec.rb +0 -172
  684. data/spec/api/resident_center_api_spec.rb +0 -54
  685. data/spec/api/tasks_api_spec.rb +0 -493
  686. data/spec/api/vendors_api_spec.rb +0 -275
  687. data/spec/api/work_orders_api_spec.rb +0 -105
  688. data/spec/models/account_info_message_spec.rb +0 -58
  689. data/spec/models/accounting_entity_message_spec.rb +0 -50
  690. data/spec/models/accounting_entity_save_message_spec.rb +0 -44
  691. data/spec/models/accounting_lock_period_message_spec.rb +0 -46
  692. data/spec/models/accounting_settings_message_spec.rb +0 -72
  693. data/spec/models/address_message_spec.rb +0 -74
  694. data/spec/models/all_tasks_message_spec.rb +0 -130
  695. data/spec/models/announcement_message_spec.rb +0 -74
  696. data/spec/models/announcement_post_message_spec.rb +0 -64
  697. data/spec/models/announcement_search_message_spec.rb +0 -62
  698. data/spec/models/announcement_sender_message_spec.rb +0 -46
  699. data/spec/models/api_error_response_spec.rb +0 -46
  700. data/spec/models/appliance_message_spec.rb +0 -58
  701. data/spec/models/applicant_application_message_spec.rb +0 -56
  702. data/spec/models/applicant_group_message_spec.rb +0 -62
  703. data/spec/models/applicant_group_post_message_spec.rb +0 -40
  704. data/spec/models/applicant_group_put_message_spec.rb +0 -50
  705. data/spec/models/applicant_group_search_message_spec.rb +0 -66
  706. data/spec/models/applicant_message_spec.rb +0 -88
  707. data/spec/models/applicant_post_message_spec.rb +0 -64
  708. data/spec/models/applicant_put_message_spec.rb +0 -58
  709. data/spec/models/applicant_search_message_spec.rb +0 -84
  710. data/spec/models/application_message_spec.rb +0 -62
  711. data/spec/models/application_put_message_spec.rb +0 -38
  712. data/spec/models/application_response_field_message_spec.rb +0 -60
  713. data/spec/models/application_response_message_spec.rb +0 -50
  714. data/spec/models/application_section_response_message_spec.rb +0 -34
  715. data/spec/models/association_appliance_message_spec.rb +0 -76
  716. data/spec/models/association_appliance_post_message_spec.rb +0 -76
  717. data/spec/models/association_appliance_put_message_spec.rb +0 -64
  718. data/spec/models/association_appliance_search_message_spec.rb +0 -40
  719. data/spec/models/association_appliance_service_history_message_spec.rb +0 -56
  720. data/spec/models/association_appliance_service_history_post_message_spec.rb +0 -50
  721. data/spec/models/association_board_member_message_spec.rb +0 -92
  722. data/spec/models/association_board_member_post_message_spec.rb +0 -56
  723. data/spec/models/association_board_member_put_message_spec.rb +0 -50
  724. data/spec/models/association_board_member_search_message_spec.rb +0 -60
  725. data/spec/models/association_message_spec.rb +0 -100
  726. data/spec/models/association_owner_board_term_message_spec.rb +0 -68
  727. data/spec/models/association_owner_board_term_post_message_spec.rb +0 -50
  728. data/spec/models/association_owner_message_spec.rb +0 -144
  729. data/spec/models/association_owner_post_message_spec.rb +0 -116
  730. data/spec/models/association_owner_put_message_spec.rb +0 -98
  731. data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +0 -128
  732. data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +0 -34
  733. data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +0 -40
  734. data/spec/models/association_ownership_account_message_spec.rb +0 -90
  735. data/spec/models/association_ownership_account_post_message_spec.rb +0 -80
  736. data/spec/models/association_ownership_account_put_message_spec.rb +0 -34
  737. data/spec/models/association_ownership_account_search_message_spec.rb +0 -72
  738. data/spec/models/association_post_message_spec.rb +0 -76
  739. data/spec/models/association_preferred_vendor_message_spec.rb +0 -82
  740. data/spec/models/association_preferred_vendor_put_message_spec.rb +0 -34
  741. data/spec/models/association_put_message_spec.rb +0 -82
  742. data/spec/models/association_search_message_spec.rb +0 -56
  743. data/spec/models/association_tenant_message_spec.rb +0 -112
  744. data/spec/models/association_tenant_post_message_spec.rb +0 -106
  745. data/spec/models/association_tenant_put_message_spec.rb +0 -94
  746. data/spec/models/association_unit_message_spec.rb +0 -84
  747. data/spec/models/association_unit_put_message_spec.rb +0 -66
  748. data/spec/models/association_unit_search_message_spec.rb +0 -46
  749. data/spec/models/association_units_post_message_spec.rb +0 -72
  750. data/spec/models/association_user_search_message_spec.rb +0 -86
  751. data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +0 -44
  752. data/spec/models/bank_account_check_line_message_spec.rb +0 -64
  753. data/spec/models/bank_account_check_line_save_message_spec.rb +0 -58
  754. data/spec/models/bank_account_check_message_spec.rb +0 -70
  755. data/spec/models/bank_account_check_payee_message_spec.rb +0 -50
  756. data/spec/models/bank_account_check_payee_save_message_spec.rb +0 -44
  757. data/spec/models/bank_account_check_post_message_spec.rb +0 -58
  758. data/spec/models/bank_account_check_put_message_spec.rb +0 -58
  759. data/spec/models/bank_account_check_search_message_spec.rb +0 -40
  760. data/spec/models/bank_account_deposit_line_message_spec.rb +0 -64
  761. data/spec/models/bank_account_deposit_line_save_message_spec.rb +0 -58
  762. data/spec/models/bank_account_deposit_message_spec.rb +0 -64
  763. data/spec/models/bank_account_deposit_post_message_spec.rb +0 -52
  764. data/spec/models/bank_account_deposit_put_message_spec.rb +0 -46
  765. data/spec/models/bank_account_deposit_search_message_spec.rb +0 -40
  766. data/spec/models/bank_account_message_spec.rb +0 -104
  767. data/spec/models/bank_account_post_message_spec.rb +0 -78
  768. data/spec/models/bank_account_put_message_spec.rb +0 -78
  769. data/spec/models/bank_account_quick_deposit_message_spec.rb +0 -64
  770. data/spec/models/bank_account_quick_deposit_save_message_spec.rb +0 -58
  771. data/spec/models/bank_account_quick_deposit_search_message_spec.rb +0 -40
  772. data/spec/models/bank_account_search_message_spec.rb +0 -44
  773. data/spec/models/bank_account_transaction_message_spec.rb +0 -96
  774. data/spec/models/bank_account_transaction_search_message_spec.rb +0 -56
  775. data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +0 -44
  776. data/spec/models/bank_account_transfer_message_spec.rb +0 -64
  777. data/spec/models/bank_account_transfer_save_message_spec.rb +0 -58
  778. data/spec/models/bank_account_transfer_search_message_spec.rb +0 -40
  779. data/spec/models/bank_account_withdrawal_message_spec.rb +0 -64
  780. data/spec/models/bank_account_withdrawal_save_message_spec.rb +0 -58
  781. data/spec/models/bank_account_withdrawal_search_message_spec.rb +0 -40
  782. data/spec/models/bill_file_message_spec.rb +0 -64
  783. data/spec/models/bill_line_message_spec.rb +0 -64
  784. data/spec/models/bill_line_post_message_spec.rb +0 -58
  785. data/spec/models/bill_line_put_message_spec.rb +0 -64
  786. data/spec/models/bill_markup_message_spec.rb +0 -44
  787. data/spec/models/bill_markup_save_message_spec.rb +0 -44
  788. data/spec/models/bill_message_spec.rb +0 -92
  789. data/spec/models/bill_payment_accounting_entity_message_spec.rb +0 -44
  790. data/spec/models/bill_payment_line_message_spec.rb +0 -46
  791. data/spec/models/bill_payment_line_post_message_spec.rb +0 -40
  792. data/spec/models/bill_payment_message_spec.rb +0 -64
  793. data/spec/models/bill_payment_post_message_spec.rb +0 -58
  794. data/spec/models/bill_post_message_spec.rb +0 -70
  795. data/spec/models/bill_put_message_spec.rb +0 -64
  796. data/spec/models/bill_search_message_spec.rb +0 -88
  797. data/spec/models/budget_details_message_spec.rb +0 -56
  798. data/spec/models/budget_details_save_message_spec.rb +0 -40
  799. data/spec/models/budget_message_spec.rb +0 -64
  800. data/spec/models/budget_monthly_amounts_message_spec.rb +0 -100
  801. data/spec/models/budget_monthly_amounts_save_message_spec.rb +0 -100
  802. data/spec/models/budget_post_message_spec.rb +0 -62
  803. data/spec/models/budget_put_message_spec.rb +0 -40
  804. data/spec/models/budget_search_message_spec.rb +0 -46
  805. data/spec/models/charge_recurring_transaction_post_message_spec.rb +0 -84
  806. data/spec/models/charge_recurring_transaction_put_message_spec.rb +0 -90
  807. data/spec/models/check_printing_info_message_spec.rb +0 -122
  808. data/spec/models/check_printing_info_post_message_spec.rb +0 -122
  809. data/spec/models/check_printing_info_put_message_spec.rb +0 -122
  810. data/spec/models/client_lead_credit_request_message_spec.rb +0 -60
  811. data/spec/models/client_lead_message_spec.rb +0 -102
  812. data/spec/models/client_lead_search_message_spec.rb +0 -66
  813. data/spec/models/contact_detail_message_spec.rb +0 -52
  814. data/spec/models/contact_detail_phone_message_spec.rb +0 -46
  815. data/spec/models/contact_detail_save_message_spec.rb +0 -52
  816. data/spec/models/contact_detail_save_phone_message_spec.rb +0 -46
  817. data/spec/models/contact_info_message_spec.rb +0 -52
  818. data/spec/models/contact_request_task_message_spec.rb +0 -114
  819. data/spec/models/contact_request_task_post_message_spec.rb +0 -102
  820. data/spec/models/contact_request_task_put_message_spec.rb +0 -102
  821. data/spec/models/contact_request_task_search_message_spec.rb +0 -112
  822. data/spec/models/cosigner_message_spec.rb +0 -92
  823. data/spec/models/created_by_user_message_spec.rb +0 -52
  824. data/spec/models/credit_recurring_transaction_post_message_spec.rb +0 -100
  825. data/spec/models/deposit_detail_message_spec.rb +0 -40
  826. data/spec/models/electronic_payments_message_spec.rb +0 -76
  827. data/spec/models/email_message_spec.rb +0 -52
  828. data/spec/models/email_post_message_spec.rb +0 -70
  829. data/spec/models/email_recipient_message_spec.rb +0 -62
  830. data/spec/models/email_search_message_spec.rb +0 -58
  831. data/spec/models/email_sender_message_spec.rb +0 -52
  832. data/spec/models/emergency_contact_message_spec.rb +0 -52
  833. data/spec/models/file_category_message_spec.rb +0 -46
  834. data/spec/models/file_category_post_message_spec.rb +0 -34
  835. data/spec/models/file_category_put_message_spec.rb +0 -34
  836. data/spec/models/file_download_message_spec.rb +0 -34
  837. data/spec/models/file_entity_message_spec.rb +0 -50
  838. data/spec/models/file_message_spec.rb +0 -82
  839. data/spec/models/file_name_post_message_spec.rb +0 -34
  840. data/spec/models/file_put_message_spec.rb +0 -46
  841. data/spec/models/file_search_message_spec.rb +0 -74
  842. data/spec/models/file_upload_post_message_spec.rb +0 -68
  843. data/spec/models/file_upload_ticket_message_spec.rb +0 -46
  844. data/spec/models/general_journal_entry_line_save_message_spec.rb +0 -56
  845. data/spec/models/general_journal_entry_post_message_spec.rb +0 -52
  846. data/spec/models/general_journal_entry_put_message_spec.rb +0 -52
  847. data/spec/models/general_ledger_journal_line_message_spec.rb +0 -64
  848. data/spec/models/general_ledger_journal_message_spec.rb +0 -40
  849. data/spec/models/general_ledger_transaction_message_spec.rb +0 -98
  850. data/spec/models/general_ledger_transaction_search_message_spec.rb +0 -62
  851. data/spec/models/gl_account_balance_item_message_spec.rb +0 -40
  852. data/spec/models/gl_account_balance_message_spec.rb +0 -46
  853. data/spec/models/gl_account_balance_search_message_spec.rb +0 -66
  854. data/spec/models/gl_account_message_spec.rb +0 -130
  855. data/spec/models/gl_account_post_message_spec.rb +0 -84
  856. data/spec/models/gl_account_put_message_spec.rb +0 -84
  857. data/spec/models/gl_accounts_search_message_spec.rb +0 -38
  858. data/spec/models/gl_transaction_message_v1_spec.rb +0 -58
  859. data/spec/models/internal_transaction_status_message_spec.rb +0 -46
  860. data/spec/models/journal_line_message_spec.rb +0 -64
  861. data/spec/models/journal_message_spec.rb +0 -40
  862. data/spec/models/last_updated_by_user_message_spec.rb +0 -58
  863. data/spec/models/lease_account_detail_message_spec.rb +0 -40
  864. data/spec/models/lease_charge_line_save_message_spec.rb +0 -46
  865. data/spec/models/lease_charge_post_message_spec.rb +0 -46
  866. data/spec/models/lease_charge_put_message_spec.rb +0 -46
  867. data/spec/models/lease_charge_recurring_transaction_message_spec.rb +0 -108
  868. data/spec/models/lease_cosigner_post_message_spec.rb +0 -80
  869. data/spec/models/lease_ledger_credit_line_post_message_spec.rb +0 -40
  870. data/spec/models/lease_ledger_credit_post_message_spec.rb +0 -62
  871. data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +0 -40
  872. data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +0 -52
  873. data/spec/models/lease_ledger_payment_line_save_message_spec.rb +0 -40
  874. data/spec/models/lease_ledger_payment_post_message_spec.rb +0 -74
  875. data/spec/models/lease_ledger_refund_line_message_spec.rb +0 -40
  876. data/spec/models/lease_ledger_refund_line_post_message_spec.rb +0 -40
  877. data/spec/models/lease_ledger_refund_message_spec.rb +0 -82
  878. data/spec/models/lease_ledger_refund_post_message_spec.rb +0 -70
  879. data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +0 -40
  880. data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +0 -40
  881. data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +0 -52
  882. data/spec/models/lease_message_spec.rb +0 -170
  883. data/spec/models/lease_move_out_data_message_spec.rb +0 -46
  884. data/spec/models/lease_move_out_data_post_message_spec.rb +0 -46
  885. data/spec/models/lease_outstanding_balance_message_spec.rb +0 -100
  886. data/spec/models/lease_outstanding_balance_search_message_spec.rb +0 -90
  887. data/spec/models/lease_post_message_spec.rb +0 -98
  888. data/spec/models/lease_put_message_spec.rb +0 -68
  889. data/spec/models/lease_recurring_credit_message_spec.rb +0 -124
  890. data/spec/models/lease_recurring_payment_message_spec.rb +0 -118
  891. data/spec/models/lease_renewal_message_spec.rb +0 -84
  892. data/spec/models/lease_renewal_post_message_spec.rb +0 -98
  893. data/spec/models/lease_rent_charge_message_spec.rb +0 -70
  894. data/spec/models/lease_rent_charge_post_message_spec.rb +0 -52
  895. data/spec/models/lease_rent_message_spec.rb +0 -86
  896. data/spec/models/lease_rent_post_message_spec.rb +0 -44
  897. data/spec/models/lease_search_message_spec.rb +0 -108
  898. data/spec/models/lease_security_deposit_post_message_spec.rb +0 -40
  899. data/spec/models/lease_tenant_message_spec.rb +0 -44
  900. data/spec/models/lease_transaction_message_spec.rb +0 -82
  901. data/spec/models/lease_transaction_search_message_spec.rb +0 -50
  902. data/spec/models/listing_contact_message_spec.rb +0 -58
  903. data/spec/models/listing_contact_save_message_spec.rb +0 -52
  904. data/spec/models/listing_file_message_spec.rb +0 -50
  905. data/spec/models/listing_message_spec.rb +0 -88
  906. data/spec/models/listing_property_message_spec.rb +0 -90
  907. data/spec/models/listing_put_message_spec.rb +0 -64
  908. data/spec/models/listing_search_message_spec.rb +0 -44
  909. data/spec/models/listing_unit_message_spec.rb +0 -100
  910. data/spec/models/lock_period_settings_global_message_spec.rb +0 -34
  911. data/spec/models/lock_period_settings_overrides_message_spec.rb +0 -40
  912. data/spec/models/logged_by_staff_user_message_spec.rb +0 -52
  913. data/spec/models/lookup_message_spec.rb +0 -40
  914. data/spec/models/mailing_template_message_spec.rb +0 -56
  915. data/spec/models/note_message_spec.rb +0 -46
  916. data/spec/models/note_post_message_spec.rb +0 -34
  917. data/spec/models/note_put_message_spec.rb +0 -34
  918. data/spec/models/note_search_message_spec.rb +0 -46
  919. data/spec/models/outstanding_balances_line_message_spec.rb +0 -40
  920. data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +0 -108
  921. data/spec/models/ownership_account_credit_line_post_message_spec.rb +0 -40
  922. data/spec/models/ownership_account_credit_post_message_spec.rb +0 -62
  923. data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +0 -40
  924. data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +0 -52
  925. data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +0 -46
  926. data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +0 -40
  927. data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +0 -46
  928. data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +0 -46
  929. data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +0 -40
  930. data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +0 -74
  931. data/spec/models/ownership_account_outstanding_balance_message_spec.rb +0 -88
  932. data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +0 -70
  933. data/spec/models/ownership_account_recurring_credit_message_spec.rb +0 -124
  934. data/spec/models/ownership_account_recurring_payment_message_spec.rb +0 -118
  935. data/spec/models/ownership_account_refund_line_message_spec.rb +0 -40
  936. data/spec/models/ownership_account_refund_lines_post_message_spec.rb +0 -40
  937. data/spec/models/ownership_account_refund_message_spec.rb +0 -82
  938. data/spec/models/ownership_account_refund_post_message_spec.rb +0 -70
  939. data/spec/models/ownership_account_transaction_message_spec.rb +0 -82
  940. data/spec/models/paid_by_message_spec.rb +0 -40
  941. data/spec/models/participant_message_spec.rb +0 -46
  942. data/spec/models/participant_resource_message_spec.rb +0 -44
  943. data/spec/models/payee_message_spec.rb +0 -56
  944. data/spec/models/payment_detail_message_spec.rb +0 -56
  945. data/spec/models/payment_recurring_transaction_post_message_spec.rb +0 -94
  946. data/spec/models/payment_transactions_message_spec.rb +0 -46
  947. data/spec/models/phone_log_message_spec.rb +0 -64
  948. data/spec/models/phone_log_participant_post_message_spec.rb +0 -50
  949. data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +0 -44
  950. data/spec/models/phone_log_post_message_spec.rb +0 -52
  951. data/spec/models/phone_log_put_message_spec.rb +0 -46
  952. data/spec/models/phone_log_search_message_spec.rb +0 -84
  953. data/spec/models/phone_number_message_spec.rb +0 -44
  954. data/spec/models/phone_numbers_message_spec.rb +0 -52
  955. data/spec/models/property_group_message_spec.rb +0 -58
  956. data/spec/models/property_group_post_message_spec.rb +0 -46
  957. data/spec/models/property_group_put_message_spec.rb +0 -46
  958. data/spec/models/property_group_search_message_spec.rb +0 -40
  959. data/spec/models/property_manager_message_spec.rb +0 -76
  960. data/spec/models/property_message_spec.rb +0 -50
  961. data/spec/models/recurring_transaction_line_message_spec.rb +0 -40
  962. data/spec/models/recurring_transaction_line_post_message_spec.rb +0 -40
  963. data/spec/models/recurring_transaction_message_spec.rb +0 -112
  964. data/spec/models/rental_appliance_message_spec.rb +0 -76
  965. data/spec/models/rental_appliance_post_message_spec.rb +0 -76
  966. data/spec/models/rental_appliance_put_message_spec.rb +0 -64
  967. data/spec/models/rental_appliance_search_message_spec.rb +0 -40
  968. data/spec/models/rental_appliance_service_history_message_spec.rb +0 -56
  969. data/spec/models/rental_appliance_service_history_post_message_spec.rb +0 -50
  970. data/spec/models/rental_features_message_spec.rb +0 -48
  971. data/spec/models/rental_features_put_message_spec.rb +0 -48
  972. data/spec/models/rental_message_spec.rb +0 -108
  973. data/spec/models/rental_owner_message_spec.rb +0 -118
  974. data/spec/models/rental_owner_post_message_spec.rb +0 -112
  975. data/spec/models/rental_owner_put_message_spec.rb +0 -106
  976. data/spec/models/rental_owner_request_task_message_spec.rb +0 -114
  977. data/spec/models/rental_owner_request_task_post_message_spec.rb +0 -102
  978. data/spec/models/rental_owner_request_task_put_message_spec.rb +0 -96
  979. data/spec/models/rental_owner_request_task_search_message_spec.rb +0 -112
  980. data/spec/models/rental_owner_tax_information_message_spec.rb +0 -68
  981. data/spec/models/rental_owners_search_message_spec.rb +0 -74
  982. data/spec/models/rental_preferred_vendor_message_spec.rb +0 -82
  983. data/spec/models/rental_preferred_vendor_put_message_spec.rb +0 -34
  984. data/spec/models/rental_property_post_message_spec.rb +0 -92
  985. data/spec/models/rental_property_put_message_spec.rb +0 -80
  986. data/spec/models/rental_property_unit_post_message_spec.rb +0 -78
  987. data/spec/models/rental_search_message_spec.rb +0 -88
  988. data/spec/models/rental_tenant_post_message_spec.rb +0 -110
  989. data/spec/models/rental_tenant_put_message_spec.rb +0 -104
  990. data/spec/models/rental_tenant_renewal_post_message_spec.rb +0 -104
  991. data/spec/models/rental_unit_features_message_spec.rb +0 -38
  992. data/spec/models/rental_unit_features_put_message_spec.rb +0 -38
  993. data/spec/models/rental_unit_message_spec.rb +0 -108
  994. data/spec/models/rental_unit_put_message_spec.rb +0 -78
  995. data/spec/models/rental_unit_search_message_spec.rb +0 -46
  996. data/spec/models/rental_units_post_message_spec.rb +0 -84
  997. data/spec/models/requested_by_user_entity_message_spec.rb +0 -68
  998. data/spec/models/resident_center_user_message_spec.rb +0 -56
  999. data/spec/models/resident_center_user_reference_message_spec.rb +0 -62
  1000. data/spec/models/resident_center_user_search_message_spec.rb +0 -66
  1001. data/spec/models/resident_request_task_message_spec.rb +0 -144
  1002. data/spec/models/resident_request_task_post_message_spec.rb +0 -114
  1003. data/spec/models/resident_request_task_put_message_spec.rb +0 -84
  1004. data/spec/models/resident_request_task_search_message_spec.rb +0 -118
  1005. data/spec/models/save_address_message_spec.rb +0 -74
  1006. data/spec/models/save_emergency_contact_message_spec.rb +0 -52
  1007. data/spec/models/task_category_message_spec.rb +0 -52
  1008. data/spec/models/task_category_put_message_spec.rb +0 -34
  1009. data/spec/models/task_category_response_message_spec.rb +0 -52
  1010. data/spec/models/task_category_save_message_spec.rb +0 -34
  1011. data/spec/models/task_history_file_message_spec.rb +0 -64
  1012. data/spec/models/task_history_file_upload_post_message_spec.rb +0 -34
  1013. data/spec/models/task_history_message_spec.rb +0 -112
  1014. data/spec/models/task_history_put_message_spec.rb +0 -34
  1015. data/spec/models/task_history_user_message_spec.rb +0 -52
  1016. data/spec/models/task_search_message_spec.rb +0 -128
  1017. data/spec/models/task_sub_category_message_spec.rb +0 -40
  1018. data/spec/models/tax_information_post_message_spec.rb +0 -62
  1019. data/spec/models/tax_information_save_message_spec.rb +0 -68
  1020. data/spec/models/tenant_message_spec.rb +0 -128
  1021. data/spec/models/tenant_search_message_spec.rb +0 -96
  1022. data/spec/models/to_do_task_message_spec.rb +0 -108
  1023. data/spec/models/to_do_task_post_message_spec.rb +0 -96
  1024. data/spec/models/to_do_task_put_message_spec.rb +0 -96
  1025. data/spec/models/to_do_task_search_message_spec.rb +0 -112
  1026. data/spec/models/undeposited_funds_message_spec.rb +0 -34
  1027. data/spec/models/unit_agreement_message_spec.rb +0 -50
  1028. data/spec/models/user_message_spec.rb +0 -104
  1029. data/spec/models/user_role_message_spec.rb +0 -52
  1030. data/spec/models/user_search_message_spec.rb +0 -66
  1031. data/spec/models/vehicle_message_spec.rb +0 -52
  1032. data/spec/models/vendor_category_message_spec.rb +0 -46
  1033. data/spec/models/vendor_category_save_message_spec.rb +0 -34
  1034. data/spec/models/vendor_credit_line_item_message_spec.rb +0 -58
  1035. data/spec/models/vendor_credit_line_item_post_message_spec.rb +0 -52
  1036. data/spec/models/vendor_credit_message_spec.rb +0 -58
  1037. data/spec/models/vendor_credit_post_message_spec.rb +0 -52
  1038. data/spec/models/vendor_insurance_message_spec.rb +0 -46
  1039. data/spec/models/vendor_insurance_save_message_spec.rb +0 -46
  1040. data/spec/models/vendor_message_spec.rb +0 -130
  1041. data/spec/models/vendor_post_message_spec.rb +0 -118
  1042. data/spec/models/vendor_put_message_spec.rb +0 -118
  1043. data/spec/models/vendor_refund_line_message_spec.rb +0 -58
  1044. data/spec/models/vendor_refund_line_post_message_spec.rb +0 -52
  1045. data/spec/models/vendor_refund_message_spec.rb +0 -74
  1046. data/spec/models/vendor_refund_post_message_spec.rb +0 -68
  1047. data/spec/models/vendor_search_message_spec.rb +0 -84
  1048. data/spec/models/vendor_tax_information_message_spec.rb +0 -68
  1049. data/spec/models/vendor_transaction_message_spec.rb +0 -68
  1050. data/spec/models/vendor_transaction_search_message_spec.rb +0 -62
  1051. data/spec/models/work_order_entry_contact_message_spec.rb +0 -40
  1052. data/spec/models/work_order_entry_contact_resource_message_spec.rb +0 -44
  1053. data/spec/models/work_order_line_item_message_spec.rb +0 -52
  1054. data/spec/models/work_order_line_item_save_message_spec.rb +0 -52
  1055. data/spec/models/work_order_message_spec.rb +0 -110
  1056. data/spec/models/work_order_post_message_spec.rb +0 -98
  1057. data/spec/models/work_order_put_message_spec.rb +0 -86
  1058. data/spec/models/work_order_search_message_spec.rb +0 -158
  1059. data/spec/models/work_order_task_message_spec.rb +0 -88
  1060. data/spec/models/work_order_task_post_message_spec.rb +0 -78
@@ -0,0 +1,277 @@
1
+ =begin
2
+ #Open API, powered by Buildium
3
+
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
+
6
+ The version of the OpenAPI document: v1
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Buildium
17
+ class MultipleBillPaymentsPostMessage
18
+ # Unique identifier of the bank account that the payment was made from.
19
+ attr_accessor :bank_account_id
20
+
21
+ # Date the payment was made.
22
+ attr_accessor :entry_date
23
+
24
+ # Indicates whether to queue local check printing. Bank account associated with the bill must have check printing enabled to be true.
25
+ attr_accessor :queue_checks_for_printing
26
+
27
+ # Unique identifiers of bills.
28
+ attr_accessor :bill_ids
29
+
30
+ # Unique identifiers of the vendor credits to apply to the payment.
31
+ attr_accessor :vendor_credit_ids
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'bank_account_id' => :'BankAccountId',
37
+ :'entry_date' => :'EntryDate',
38
+ :'queue_checks_for_printing' => :'QueueChecksForPrinting',
39
+ :'bill_ids' => :'BillIds',
40
+ :'vendor_credit_ids' => :'VendorCreditIds'
41
+ }
42
+ end
43
+
44
+ # Returns all the JSON keys this model knows about
45
+ def self.acceptable_attributes
46
+ attribute_map.values
47
+ end
48
+
49
+ # Attribute type mapping.
50
+ def self.openapi_types
51
+ {
52
+ :'bank_account_id' => :'Integer',
53
+ :'entry_date' => :'Date',
54
+ :'queue_checks_for_printing' => :'Boolean',
55
+ :'bill_ids' => :'Array<Integer>',
56
+ :'vendor_credit_ids' => :'Array<Integer>'
57
+ }
58
+ end
59
+
60
+ # List of attributes with nullable: true
61
+ def self.openapi_nullable
62
+ Set.new([
63
+ ])
64
+ end
65
+
66
+ # Initializes the object
67
+ # @param [Hash] attributes Model attributes in the form of hash
68
+ def initialize(attributes = {})
69
+ if (!attributes.is_a?(Hash))
70
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::MultipleBillPaymentsPostMessage` initialize method"
71
+ end
72
+
73
+ # check to see if the attribute exists and convert string to symbol for hash key
74
+ attributes = attributes.each_with_object({}) { |(k, v), h|
75
+ if (!self.class.attribute_map.key?(k.to_sym))
76
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Buildium::MultipleBillPaymentsPostMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
77
+ end
78
+ h[k.to_sym] = v
79
+ }
80
+
81
+ if attributes.key?(:'bank_account_id')
82
+ self.bank_account_id = attributes[:'bank_account_id']
83
+ end
84
+
85
+ if attributes.key?(:'entry_date')
86
+ self.entry_date = attributes[:'entry_date']
87
+ end
88
+
89
+ if attributes.key?(:'queue_checks_for_printing')
90
+ self.queue_checks_for_printing = attributes[:'queue_checks_for_printing']
91
+ end
92
+
93
+ if attributes.key?(:'bill_ids')
94
+ if (value = attributes[:'bill_ids']).is_a?(Array)
95
+ self.bill_ids = value
96
+ end
97
+ end
98
+
99
+ if attributes.key?(:'vendor_credit_ids')
100
+ if (value = attributes[:'vendor_credit_ids']).is_a?(Array)
101
+ self.vendor_credit_ids = value
102
+ end
103
+ end
104
+ end
105
+
106
+ # Show invalid properties with the reasons. Usually used together with valid?
107
+ # @return Array for valid properties with the reasons
108
+ def list_invalid_properties
109
+ invalid_properties = Array.new
110
+ if @bank_account_id.nil?
111
+ invalid_properties.push('invalid value for "bank_account_id", bank_account_id cannot be nil.')
112
+ end
113
+
114
+ if @entry_date.nil?
115
+ invalid_properties.push('invalid value for "entry_date", entry_date cannot be nil.')
116
+ end
117
+
118
+ if @bill_ids.nil?
119
+ invalid_properties.push('invalid value for "bill_ids", bill_ids cannot be nil.')
120
+ end
121
+
122
+ invalid_properties
123
+ end
124
+
125
+ # Check to see if the all the properties in the model are valid
126
+ # @return true if the model is valid
127
+ def valid?
128
+ return false if @bank_account_id.nil?
129
+ return false if @entry_date.nil?
130
+ return false if @bill_ids.nil?
131
+ true
132
+ end
133
+
134
+ # Checks equality by comparing each attribute.
135
+ # @param [Object] Object to be compared
136
+ def ==(o)
137
+ return true if self.equal?(o)
138
+ self.class == o.class &&
139
+ bank_account_id == o.bank_account_id &&
140
+ entry_date == o.entry_date &&
141
+ queue_checks_for_printing == o.queue_checks_for_printing &&
142
+ bill_ids == o.bill_ids &&
143
+ vendor_credit_ids == o.vendor_credit_ids
144
+ end
145
+
146
+ # @see the `==` method
147
+ # @param [Object] Object to be compared
148
+ def eql?(o)
149
+ self == o
150
+ end
151
+
152
+ # Calculates hash code according to all attributes.
153
+ # @return [Integer] Hash code
154
+ def hash
155
+ [bank_account_id, entry_date, queue_checks_for_printing, bill_ids, vendor_credit_ids].hash
156
+ end
157
+
158
+ # Builds the object from hash
159
+ # @param [Hash] attributes Model attributes in the form of hash
160
+ # @return [Object] Returns the model itself
161
+ def self.build_from_hash(attributes)
162
+ new.build_from_hash(attributes)
163
+ end
164
+
165
+ # Builds the object from hash
166
+ # @param [Hash] attributes Model attributes in the form of hash
167
+ # @return [Object] Returns the model itself
168
+ def build_from_hash(attributes)
169
+ return unless attributes.is_a?(Hash)
170
+ attributes = attributes.transform_keys(&:to_sym)
171
+ self.class.openapi_types.each_pair do |key, type|
172
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
173
+ self.send("#{key}=", nil)
174
+ elsif type =~ /\AArray<(.*)>/i
175
+ # check to ensure the input is an array given that the attribute
176
+ # is documented as an array but the input is not
177
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
178
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
179
+ end
180
+ elsif !attributes[self.class.attribute_map[key]].nil?
181
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
182
+ end
183
+ end
184
+
185
+ self
186
+ end
187
+
188
+ # Deserializes the data based on type
189
+ # @param string type Data type
190
+ # @param string value Value to be deserialized
191
+ # @return [Object] Deserialized data
192
+ def _deserialize(type, value)
193
+ case type.to_sym
194
+ when :Time
195
+ Time.parse(value)
196
+ when :Date
197
+ Date.parse(value)
198
+ when :String
199
+ value.to_s
200
+ when :Integer
201
+ value.to_i
202
+ when :Float
203
+ value.to_f
204
+ when :Boolean
205
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
206
+ true
207
+ else
208
+ false
209
+ end
210
+ when :Object
211
+ # generic object (usually a Hash), return directly
212
+ value
213
+ when /\AArray<(?<inner_type>.+)>\z/
214
+ inner_type = Regexp.last_match[:inner_type]
215
+ value.map { |v| _deserialize(inner_type, v) }
216
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
217
+ k_type = Regexp.last_match[:k_type]
218
+ v_type = Regexp.last_match[:v_type]
219
+ {}.tap do |hash|
220
+ value.each do |k, v|
221
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
222
+ end
223
+ end
224
+ else # model
225
+ # models (e.g. Pet) or oneOf
226
+ klass = Buildium.const_get(type)
227
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
228
+ end
229
+ end
230
+
231
+ # Returns the string representation of the object
232
+ # @return [String] String presentation of the object
233
+ def to_s
234
+ to_hash.to_s
235
+ end
236
+
237
+ # to_body is an alias to to_hash (backward compatibility)
238
+ # @return [Hash] Returns the object in the form of hash
239
+ def to_body
240
+ to_hash
241
+ end
242
+
243
+ # Returns the object in the form of hash
244
+ # @return [Hash] Returns the object in the form of hash
245
+ def to_hash
246
+ hash = {}
247
+ self.class.attribute_map.each_pair do |attr, param|
248
+ value = self.send(attr)
249
+ if value.nil?
250
+ is_nullable = self.class.openapi_nullable.include?(attr)
251
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
252
+ end
253
+
254
+ hash[param] = _to_hash(value)
255
+ end
256
+ hash
257
+ end
258
+
259
+ # Outputs non-array value in the form of hash
260
+ # For object, use to_hash. Otherwise, just return the value
261
+ # @param [Object] value Any valid value
262
+ # @return [Hash] Returns the value in the form of hash
263
+ def _to_hash(value)
264
+ if value.is_a?(Array)
265
+ value.compact.map { |v| _to_hash(v) }
266
+ elsif value.is_a?(Hash)
267
+ {}.tap do |hash|
268
+ value.each { |k, v| hash[k] = _to_hash(v) }
269
+ end
270
+ elsif value.respond_to? :to_hash
271
+ value.to_hash
272
+ else
273
+ value
274
+ end
275
+ end
276
+ end
277
+ end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -0,0 +1,239 @@
1
+ =begin
2
+ #Open API, powered by Buildium
3
+
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
+
6
+ The version of the OpenAPI document: v1
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Buildium
17
+ # Offline payment settings.
18
+ class OfflinePaymentsMessage
19
+ # Indicates whether the offline payment information is displayed in the Buildium Resident Center.
20
+ attr_accessor :display_info_in_resident_center
21
+
22
+ # Indicates whether to display the company address along with the offline payment information. If `DisplayInfoInResidentCenter` is false the company address will not be displayed.
23
+ attr_accessor :display_company_address
24
+
25
+ # Directions for how to make offline payments. If `DisplayInfoInResidentCenter` is false the payment instructions will not be displayed.
26
+ attr_accessor :payment_instructions
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'display_info_in_resident_center' => :'DisplayInfoInResidentCenter',
32
+ :'display_company_address' => :'DisplayCompanyAddress',
33
+ :'payment_instructions' => :'PaymentInstructions'
34
+ }
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'display_info_in_resident_center' => :'Boolean',
46
+ :'display_company_address' => :'Boolean',
47
+ :'payment_instructions' => :'String'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::OfflinePaymentsMessage` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ attributes = attributes.each_with_object({}) { |(k, v), h|
66
+ if (!self.class.attribute_map.key?(k.to_sym))
67
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Buildium::OfflinePaymentsMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
68
+ end
69
+ h[k.to_sym] = v
70
+ }
71
+
72
+ if attributes.key?(:'display_info_in_resident_center')
73
+ self.display_info_in_resident_center = attributes[:'display_info_in_resident_center']
74
+ end
75
+
76
+ if attributes.key?(:'display_company_address')
77
+ self.display_company_address = attributes[:'display_company_address']
78
+ end
79
+
80
+ if attributes.key?(:'payment_instructions')
81
+ self.payment_instructions = attributes[:'payment_instructions']
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
+ display_info_in_resident_center == o.display_info_in_resident_center &&
104
+ display_company_address == o.display_company_address &&
105
+ payment_instructions == o.payment_instructions
106
+ end
107
+
108
+ # @see the `==` method
109
+ # @param [Object] Object to be compared
110
+ def eql?(o)
111
+ self == o
112
+ end
113
+
114
+ # Calculates hash code according to all attributes.
115
+ # @return [Integer] Hash code
116
+ def hash
117
+ [display_info_in_resident_center, display_company_address, payment_instructions].hash
118
+ end
119
+
120
+ # Builds the object from hash
121
+ # @param [Hash] attributes Model attributes in the form of hash
122
+ # @return [Object] Returns the model itself
123
+ def self.build_from_hash(attributes)
124
+ new.build_from_hash(attributes)
125
+ end
126
+
127
+ # Builds the object from hash
128
+ # @param [Hash] attributes Model attributes in the form of hash
129
+ # @return [Object] Returns the model itself
130
+ def build_from_hash(attributes)
131
+ return unless attributes.is_a?(Hash)
132
+ attributes = attributes.transform_keys(&:to_sym)
133
+ self.class.openapi_types.each_pair do |key, type|
134
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
135
+ self.send("#{key}=", nil)
136
+ elsif type =~ /\AArray<(.*)>/i
137
+ # check to ensure the input is an array given that the attribute
138
+ # is documented as an array but the input is not
139
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
140
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
141
+ end
142
+ elsif !attributes[self.class.attribute_map[key]].nil?
143
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
144
+ end
145
+ end
146
+
147
+ self
148
+ end
149
+
150
+ # Deserializes the data based on type
151
+ # @param string type Data type
152
+ # @param string value Value to be deserialized
153
+ # @return [Object] Deserialized data
154
+ def _deserialize(type, value)
155
+ case type.to_sym
156
+ when :Time
157
+ Time.parse(value)
158
+ when :Date
159
+ Date.parse(value)
160
+ when :String
161
+ value.to_s
162
+ when :Integer
163
+ value.to_i
164
+ when :Float
165
+ value.to_f
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
+ # models (e.g. Pet) or oneOf
188
+ klass = Buildium.const_get(type)
189
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
190
+ end
191
+ end
192
+
193
+ # Returns the string representation of the object
194
+ # @return [String] String presentation of the object
195
+ def to_s
196
+ to_hash.to_s
197
+ end
198
+
199
+ # to_body is an alias to to_hash (backward compatibility)
200
+ # @return [Hash] Returns the object in the form of hash
201
+ def to_body
202
+ to_hash
203
+ end
204
+
205
+ # Returns the object in the form of hash
206
+ # @return [Hash] Returns the object in the form of hash
207
+ def to_hash
208
+ hash = {}
209
+ self.class.attribute_map.each_pair do |attr, param|
210
+ value = self.send(attr)
211
+ if value.nil?
212
+ is_nullable = self.class.openapi_nullable.include?(attr)
213
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
214
+ end
215
+
216
+ hash[param] = _to_hash(value)
217
+ end
218
+ hash
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)
226
+ if value.is_a?(Array)
227
+ value.compact.map { |v| _to_hash(v) }
228
+ elsif value.is_a?(Hash)
229
+ {}.tap do |hash|
230
+ value.each { |k, v| hash[k] = _to_hash(v) }
231
+ end
232
+ elsif value.respond_to? :to_hash
233
+ value.to_hash
234
+ else
235
+ value
236
+ end
237
+ end
238
+ end
239
+ end