buildium-ruby 2.0.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
data/docs/LeasesApi.md CHANGED
@@ -5,39 +5,26 @@ All URIs are relative to *https://api.buildium.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_lease**](LeasesApi.md#create_lease) | **POST** /v1/leases | Create a lease |
8
- | [**create_lease_charge_recurring_transaction**](LeasesApi.md#create_lease_charge_recurring_transaction) | **POST** /v1/leases/{leaseId}/recurringcharges | Create a recurring charge |
9
- | [**create_lease_credit**](LeasesApi.md#create_lease_credit) | **POST** /v1/leases/{leaseId}/credits | Create a credit |
10
- | [**create_lease_credit_recurring_transaction**](LeasesApi.md#create_lease_credit_recurring_transaction) | **POST** /v1/leases/{leaseId}/recurringcredits | Create a recurring credit |
11
- | [**create_lease_ledger_charge**](LeasesApi.md#create_lease_ledger_charge) | **POST** /v1/leases/{leaseId}/charges | Create a charge |
12
- | [**create_lease_ledger_deposit_withholding**](LeasesApi.md#create_lease_ledger_deposit_withholding) | **POST** /v1/leases/{leaseId}/applieddeposits | Create a deposit withholding |
13
- | [**create_lease_ledger_refund**](LeasesApi.md#create_lease_ledger_refund) | **POST** /v1/leases/{leaseId}/refunds | Create a refund |
14
8
  | [**create_lease_note**](LeasesApi.md#create_lease_note) | **POST** /v1/leases/{leaseId}/notes | Create a note |
15
- | [**create_lease_recurring_payment**](LeasesApi.md#create_lease_recurring_payment) | **POST** /v1/leases/{leaseId}/recurringpayments | Create a recurring payment |
16
- | [**create_lease_reverse_payment**](LeasesApi.md#create_lease_reverse_payment) | **POST** /v1/leases/{leaseId}/reversepayments | Create a payment reversal |
9
+ | [**create_lease_renewal**](LeasesApi.md#create_lease_renewal) | **POST** /v1/leases/{leaseId}/renewals | Create a lease renewal |
17
10
  | [**create_move_out_data**](LeasesApi.md#create_move_out_data) | **POST** /v1/leases/{leaseId}/moveouts | Create a move out |
18
- | [**create_payment**](LeasesApi.md#create_payment) | **POST** /v1/leases/{leaseId}/payments | Create a payment |
11
+ | [**get_all_lease_renewals**](LeasesApi.md#get_all_lease_renewals) | **GET** /v1/leases/{leaseId}/renewals | Retrieve all renewals |
12
+ | [**get_all_lease_renewals_for_all_properties**](LeasesApi.md#get_all_lease_renewals_for_all_properties) | **GET** /v1/leases/renewals | Retrieve all upcoming renewals |
19
13
  | [**get_lease_by_id**](LeasesApi.md#get_lease_by_id) | **GET** /v1/leases/{leaseId} | Retrieve a lease |
20
- | [**get_lease_charge_recurring_transaction_by_id**](LeasesApi.md#get_lease_charge_recurring_transaction_by_id) | **GET** /v1/leases/{leaseId}/recurringcharges/{transactionId} | Retrieve a recurring charge |
21
- | [**get_lease_ledger_refund_by_id**](LeasesApi.md#get_lease_ledger_refund_by_id) | **GET** /v1/leases/{leaseId}/refunds/{refundId} | Retrieve a refund |
22
- | [**get_lease_ledger_transaction_by_id**](LeasesApi.md#get_lease_ledger_transaction_by_id) | **GET** /v1/leases/{leaseId}/transactions/{transactionId} | Retrieve a lease transaction |
23
- | [**get_lease_ledgers**](LeasesApi.md#get_lease_ledgers) | **GET** /v1/leases/{leaseId}/transactions | Retrieve all lease transactions |
14
+ | [**get_lease_epay_settings_by_id**](LeasesApi.md#get_lease_epay_settings_by_id) | **GET** /v1/leases/{leaseId}/epaysettings | Retrieve ePay settings |
24
15
  | [**get_lease_move_out_data_by_tenant_id**](LeasesApi.md#get_lease_move_out_data_by_tenant_id) | **GET** /v1/leases/{leaseId}/moveouts/{tenantId} | Retrieve a move out |
25
16
  | [**get_lease_move_out_information_by_id**](LeasesApi.md#get_lease_move_out_information_by_id) | **GET** /v1/leases/{leaseId}/moveouts | Retrieve all move outs |
26
17
  | [**get_lease_note_by_note_id**](LeasesApi.md#get_lease_note_by_note_id) | **GET** /v1/leases/{leaseId}/notes/{noteId} | Retrieve a note |
27
18
  | [**get_lease_notes**](LeasesApi.md#get_lease_notes) | **GET** /v1/leases/{leaseId}/notes | Retrieve all notes |
28
- | [**get_lease_outstanding_balances**](LeasesApi.md#get_lease_outstanding_balances) | **GET** /v1/leases/outstandingbalances | Retrieve all outstanding balances |
29
- | [**get_lease_recurring_credit_by_id**](LeasesApi.md#get_lease_recurring_credit_by_id) | **GET** /v1/leases/{leaseId}/recurringcredits/{transactionId} | Retrieve a recurring credit |
30
- | [**get_lease_recurring_transactions**](LeasesApi.md#get_lease_recurring_transactions) | **GET** /v1/leases/{leaseId}/recurringtransactions | Retrieve all recurring transactions |
19
+ | [**get_lease_renewal_by_id**](LeasesApi.md#get_lease_renewal_by_id) | **GET** /v1/leases/{leaseId}/renewals/{renewalId} | Retrieve a renewal |
31
20
  | [**get_leases**](LeasesApi.md#get_leases) | **GET** /v1/leases | Retrieve all leases |
32
- | [**get_recurring_lease_payments_by_id**](LeasesApi.md#get_recurring_lease_payments_by_id) | **GET** /v1/leases/{leaseId}/recurringpayments/{paymentId} | Retrieve a recurring payment |
33
21
  | [**get_rent**](LeasesApi.md#get_rent) | **GET** /v1/leases/{leaseId}/rent | Retrieve all rent schedules |
34
22
  | [**get_rent_by_id**](LeasesApi.md#get_rent_by_id) | **GET** /v1/leases/{leaseId}/rent/{rentId} | Retrieve a rent schedule |
35
- | [**lease_renewals_external_api_read_get_all_lease_renewals**](LeasesApi.md#lease_renewals_external_api_read_get_all_lease_renewals) | **GET** /v1/leases/{leaseId}/renewals | Retrieve all lease renewals |
36
- | [**lease_renewals_external_api_read_get_lease_renewal_by_id**](LeasesApi.md#lease_renewals_external_api_read_get_lease_renewal_by_id) | **GET** /v1/leases/{leaseId}/renewals/{renewalId} | Retrieve a lease renewal |
37
- | [**lease_renewals_external_api_write_create_lease_renewal**](LeasesApi.md#lease_renewals_external_api_write_create_lease_renewal) | **POST** /v1/leases/{leaseId}/renewals | Create a lease renewal |
23
+ | [**get_renters_insurance_policies**](LeasesApi.md#get_renters_insurance_policies) | **GET** /v1/leases/{leaseId}/rentersinsurance | Retrieve all insurance policies |
24
+ | [**get_renters_insurance_policy_by_id**](LeasesApi.md#get_renters_insurance_policy_by_id) | **GET** /v1/leases/{leaseId}/rentersinsurance/{policyId} | Retrieve an insurance policy |
38
25
  | [**undo_tenant_moveout**](LeasesApi.md#undo_tenant_moveout) | **DELETE** /v1/leases/{leaseId}/moveouts/{tenantId} | Delete a move out |
39
26
  | [**update_lease**](LeasesApi.md#update_lease) | **PUT** /v1/leases/{leaseId} | Update a lease |
40
- | [**update_lease_charge**](LeasesApi.md#update_lease_charge) | **PUT** /v1/leases/{leaseId}/charges/{chargeId} | Update a charge |
27
+ | [**update_lease_epay_settings**](LeasesApi.md#update_lease_epay_settings) | **PUT** /v1/leases/{leaseId}/epaysettings | Update ePay settings |
41
28
  | [**update_lease_note**](LeasesApi.md#update_lease_note) | **PUT** /v1/leases/{leaseId}/notes/{noteId} | Update a note |
42
29
 
43
30
 
@@ -47,7 +34,7 @@ All URIs are relative to *https://api.buildium.com*
47
34
 
48
35
  Create a lease
49
36
 
50
- Creates a signed lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
37
+ Creates a signed lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit` <br /><h4>Optional Permissions:</h4><br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View` In order to add tenants to the lease using the ApplicantIds property, you must have this permission.
51
38
 
52
39
  ### Examples
53
40
 
@@ -68,7 +55,7 @@ Buildium.configure do |config|
68
55
  end
69
56
 
70
57
  api_instance = Buildium::LeasesApi.new
71
- lease_post_message = Buildium::LeasePostMessage.new({lease_type: 'Fixed', unit_id: 37, lease_from_date: Date.today, send_welcome_email: false, tenants: [Buildium::RentalTenantPutMessage.new({first_name: 'first_name_example', last_name: 'last_name_example', address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'})})]}) # LeasePostMessage |
58
+ lease_post_message = Buildium::LeasePostMessage.new({lease_type: 'Fixed', unit_id: 37, lease_from_date: Date.today, send_welcome_email: false}) # LeasePostMessage |
72
59
 
73
60
  begin
74
61
  # Create a lease
@@ -117,13 +104,13 @@ end
117
104
  - **Accept**: application/json
118
105
 
119
106
 
120
- ## create_lease_charge_recurring_transaction
107
+ ## create_lease_note
121
108
 
122
- > <LeaseChargeRecurringTransactionMessage> create_lease_charge_recurring_transaction(lease_id, charge_recurring_transaction_post_message)
109
+ > <NoteMessage> create_lease_note(lease_id, note_post_message)
123
110
 
124
- Create a recurring charge
111
+ Create a note
125
112
 
126
- Creates a recurring charge transaction that will post automatically on the specified lease ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
113
+ Creates a lease note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
127
114
 
128
115
  ### Examples
129
116
 
@@ -145,32 +132,32 @@ end
145
132
 
146
133
  api_instance = Buildium::LeasesApi.new
147
134
  lease_id = 56 # Integer |
148
- charge_recurring_transaction_post_message = Buildium::ChargeRecurringTransactionPostMessage.new({gl_account_id: 37, amount: 3.56, first_occurrence_date: Date.today, post_days_in_advance: 37, frequency: 'Monthly'}) # ChargeRecurringTransactionPostMessage |
135
+ note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
149
136
 
150
137
  begin
151
- # Create a recurring charge
152
- result = api_instance.create_lease_charge_recurring_transaction(lease_id, charge_recurring_transaction_post_message)
138
+ # Create a note
139
+ result = api_instance.create_lease_note(lease_id, note_post_message)
153
140
  p result
154
141
  rescue Buildium::ApiError => e
155
- puts "Error when calling LeasesApi->create_lease_charge_recurring_transaction: #{e}"
142
+ puts "Error when calling LeasesApi->create_lease_note: #{e}"
156
143
  end
157
144
  ```
158
145
 
159
- #### Using the create_lease_charge_recurring_transaction_with_http_info variant
146
+ #### Using the create_lease_note_with_http_info variant
160
147
 
161
148
  This returns an Array which contains the response data, status code and headers.
162
149
 
163
- > <Array(<LeaseChargeRecurringTransactionMessage>, Integer, Hash)> create_lease_charge_recurring_transaction_with_http_info(lease_id, charge_recurring_transaction_post_message)
150
+ > <Array(<NoteMessage>, Integer, Hash)> create_lease_note_with_http_info(lease_id, note_post_message)
164
151
 
165
152
  ```ruby
166
153
  begin
167
- # Create a recurring charge
168
- data, status_code, headers = api_instance.create_lease_charge_recurring_transaction_with_http_info(lease_id, charge_recurring_transaction_post_message)
154
+ # Create a note
155
+ data, status_code, headers = api_instance.create_lease_note_with_http_info(lease_id, note_post_message)
169
156
  p status_code # => 2xx
170
157
  p headers # => { ... }
171
- p data # => <LeaseChargeRecurringTransactionMessage>
158
+ p data # => <NoteMessage>
172
159
  rescue Buildium::ApiError => e
173
- puts "Error when calling LeasesApi->create_lease_charge_recurring_transaction_with_http_info: #{e}"
160
+ puts "Error when calling LeasesApi->create_lease_note_with_http_info: #{e}"
174
161
  end
175
162
  ```
176
163
 
@@ -179,11 +166,11 @@ end
179
166
  | Name | Type | Description | Notes |
180
167
  | ---- | ---- | ----------- | ----- |
181
168
  | **lease_id** | **Integer** | | |
182
- | **charge_recurring_transaction_post_message** | [**ChargeRecurringTransactionPostMessage**](ChargeRecurringTransactionPostMessage.md) | | |
169
+ | **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
183
170
 
184
171
  ### Return type
185
172
 
186
- [**LeaseChargeRecurringTransactionMessage**](LeaseChargeRecurringTransactionMessage.md)
173
+ [**NoteMessage**](NoteMessage.md)
187
174
 
188
175
  ### Authorization
189
176
 
@@ -195,13 +182,13 @@ end
195
182
  - **Accept**: application/json
196
183
 
197
184
 
198
- ## create_lease_credit
185
+ ## create_lease_renewal
199
186
 
200
- > <LeaseTransactionMessage> create_lease_credit(lease_id, lease_ledger_credit_post_message)
187
+ > <LeaseRenewalMessage> create_lease_renewal(lease_id, lease_renewal_post_message)
201
188
 
202
- Create a credit
189
+ Create a lease renewal
203
190
 
204
- Creates a lease ledger credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
191
+ Creates a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
205
192
 
206
193
  ### Examples
207
194
 
@@ -222,33 +209,33 @@ Buildium.configure do |config|
222
209
  end
223
210
 
224
211
  api_instance = Buildium::LeasesApi.new
225
- lease_id = 56 # Integer | The lease unique identifier.
226
- lease_ledger_credit_post_message = Buildium::LeaseLedgerCreditPostMessage.new({date: Date.today, credit_type: 'WaiveUnpaid', lines: [Buildium::LeaseLedgerCreditLinePostMessage.new({amount: 3.56, gl_account_id: 37})]}) # LeaseLedgerCreditPostMessage |
212
+ lease_id = 56 # Integer |
213
+ lease_renewal_post_message = Buildium::LeaseRenewalPostMessage.new({lease_type: 'Fixed', rent: Buildium::LeaseRentPostMessage.new({cycle: 'Monthly', charges: [Buildium::LeaseRentChargePostMessage.new({amount: 3.56, gl_account_id: 37, next_due_date: Date.today})]}), send_welcome_email: false}) # LeaseRenewalPostMessage |
227
214
 
228
215
  begin
229
- # Create a credit
230
- result = api_instance.create_lease_credit(lease_id, lease_ledger_credit_post_message)
216
+ # Create a lease renewal
217
+ result = api_instance.create_lease_renewal(lease_id, lease_renewal_post_message)
231
218
  p result
232
219
  rescue Buildium::ApiError => e
233
- puts "Error when calling LeasesApi->create_lease_credit: #{e}"
220
+ puts "Error when calling LeasesApi->create_lease_renewal: #{e}"
234
221
  end
235
222
  ```
236
223
 
237
- #### Using the create_lease_credit_with_http_info variant
224
+ #### Using the create_lease_renewal_with_http_info variant
238
225
 
239
226
  This returns an Array which contains the response data, status code and headers.
240
227
 
241
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> create_lease_credit_with_http_info(lease_id, lease_ledger_credit_post_message)
228
+ > <Array(<LeaseRenewalMessage>, Integer, Hash)> create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message)
242
229
 
243
230
  ```ruby
244
231
  begin
245
- # Create a credit
246
- data, status_code, headers = api_instance.create_lease_credit_with_http_info(lease_id, lease_ledger_credit_post_message)
232
+ # Create a lease renewal
233
+ data, status_code, headers = api_instance.create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message)
247
234
  p status_code # => 2xx
248
235
  p headers # => { ... }
249
- p data # => <LeaseTransactionMessage>
236
+ p data # => <LeaseRenewalMessage>
250
237
  rescue Buildium::ApiError => e
251
- puts "Error when calling LeasesApi->create_lease_credit_with_http_info: #{e}"
238
+ puts "Error when calling LeasesApi->create_lease_renewal_with_http_info: #{e}"
252
239
  end
253
240
  ```
254
241
 
@@ -256,12 +243,12 @@ end
256
243
 
257
244
  | Name | Type | Description | Notes |
258
245
  | ---- | ---- | ----------- | ----- |
259
- | **lease_id** | **Integer** | The lease unique identifier. | |
260
- | **lease_ledger_credit_post_message** | [**LeaseLedgerCreditPostMessage**](LeaseLedgerCreditPostMessage.md) | | |
246
+ | **lease_id** | **Integer** | | |
247
+ | **lease_renewal_post_message** | [**LeaseRenewalPostMessage**](LeaseRenewalPostMessage.md) | | |
261
248
 
262
249
  ### Return type
263
250
 
264
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
251
+ [**LeaseRenewalMessage**](LeaseRenewalMessage.md)
265
252
 
266
253
  ### Authorization
267
254
 
@@ -273,13 +260,13 @@ end
273
260
  - **Accept**: application/json
274
261
 
275
262
 
276
- ## create_lease_credit_recurring_transaction
263
+ ## create_move_out_data
277
264
 
278
- > <LeaseRecurringCreditMessage> create_lease_credit_recurring_transaction(lease_id, credit_recurring_transaction_post_message)
265
+ > <LeaseMoveOutDataMessage> create_move_out_data(lease_id, lease_move_out_data_post_message)
279
266
 
280
- Create a recurring credit
267
+ Create a move out
281
268
 
282
- Creates a recurring credit transaction on the specified lease ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
269
+ Creates move out data for a single tenant on a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` `Edit`
283
270
 
284
271
  ### Examples
285
272
 
@@ -301,32 +288,32 @@ end
301
288
 
302
289
  api_instance = Buildium::LeasesApi.new
303
290
  lease_id = 56 # Integer |
304
- credit_recurring_transaction_post_message = Buildium::CreditRecurringTransactionPostMessage.new({credit_type: 'WaiveUnpaid', post_days_in_advance: 37, frequency: 'Monthly', first_occurrence_date: Date.today}) # CreditRecurringTransactionPostMessage |
291
+ lease_move_out_data_post_message = Buildium::LeaseMoveOutDataPostMessage.new({tenant_id: 37, move_out_date: Date.today}) # LeaseMoveOutDataPostMessage |
305
292
 
306
293
  begin
307
- # Create a recurring credit
308
- result = api_instance.create_lease_credit_recurring_transaction(lease_id, credit_recurring_transaction_post_message)
294
+ # Create a move out
295
+ result = api_instance.create_move_out_data(lease_id, lease_move_out_data_post_message)
309
296
  p result
310
297
  rescue Buildium::ApiError => e
311
- puts "Error when calling LeasesApi->create_lease_credit_recurring_transaction: #{e}"
298
+ puts "Error when calling LeasesApi->create_move_out_data: #{e}"
312
299
  end
313
300
  ```
314
301
 
315
- #### Using the create_lease_credit_recurring_transaction_with_http_info variant
302
+ #### Using the create_move_out_data_with_http_info variant
316
303
 
317
304
  This returns an Array which contains the response data, status code and headers.
318
305
 
319
- > <Array(<LeaseRecurringCreditMessage>, Integer, Hash)> create_lease_credit_recurring_transaction_with_http_info(lease_id, credit_recurring_transaction_post_message)
306
+ > <Array(<LeaseMoveOutDataMessage>, Integer, Hash)> create_move_out_data_with_http_info(lease_id, lease_move_out_data_post_message)
320
307
 
321
308
  ```ruby
322
309
  begin
323
- # Create a recurring credit
324
- data, status_code, headers = api_instance.create_lease_credit_recurring_transaction_with_http_info(lease_id, credit_recurring_transaction_post_message)
310
+ # Create a move out
311
+ data, status_code, headers = api_instance.create_move_out_data_with_http_info(lease_id, lease_move_out_data_post_message)
325
312
  p status_code # => 2xx
326
313
  p headers # => { ... }
327
- p data # => <LeaseRecurringCreditMessage>
314
+ p data # => <LeaseMoveOutDataMessage>
328
315
  rescue Buildium::ApiError => e
329
- puts "Error when calling LeasesApi->create_lease_credit_recurring_transaction_with_http_info: #{e}"
316
+ puts "Error when calling LeasesApi->create_move_out_data_with_http_info: #{e}"
330
317
  end
331
318
  ```
332
319
 
@@ -335,11 +322,11 @@ end
335
322
  | Name | Type | Description | Notes |
336
323
  | ---- | ---- | ----------- | ----- |
337
324
  | **lease_id** | **Integer** | | |
338
- | **credit_recurring_transaction_post_message** | [**CreditRecurringTransactionPostMessage**](CreditRecurringTransactionPostMessage.md) | | |
325
+ | **lease_move_out_data_post_message** | [**LeaseMoveOutDataPostMessage**](LeaseMoveOutDataPostMessage.md) | | |
339
326
 
340
327
  ### Return type
341
328
 
342
- [**LeaseRecurringCreditMessage**](LeaseRecurringCreditMessage.md)
329
+ [**LeaseMoveOutDataMessage**](LeaseMoveOutDataMessage.md)
343
330
 
344
331
  ### Authorization
345
332
 
@@ -351,13 +338,13 @@ end
351
338
  - **Accept**: application/json
352
339
 
353
340
 
354
- ## create_lease_ledger_charge
341
+ ## get_all_lease_renewals
355
342
 
356
- > <Array<LeaseTransactionMessage>> create_lease_ledger_charge(lease_id, lease_charge_post_message)
343
+ > <Array<LeaseRenewalMessage>> get_all_lease_renewals(lease_id, opts)
357
344
 
358
- Create a charge
345
+ Retrieve all renewals
359
346
 
360
- Creates a charge transaction on a specific lease ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
347
+ Retrieves all renewals for a specific a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
361
348
 
362
349
  ### Examples
363
350
 
@@ -379,32 +366,36 @@ end
379
366
 
380
367
  api_instance = Buildium::LeasesApi.new
381
368
  lease_id = 56 # Integer |
382
- lease_charge_post_message = Buildium::LeaseChargePostMessage.new # LeaseChargePostMessage |
369
+ opts = {
370
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
371
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
372
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
373
+ }
383
374
 
384
375
  begin
385
- # Create a charge
386
- result = api_instance.create_lease_ledger_charge(lease_id, lease_charge_post_message)
376
+ # Retrieve all renewals
377
+ result = api_instance.get_all_lease_renewals(lease_id, opts)
387
378
  p result
388
379
  rescue Buildium::ApiError => e
389
- puts "Error when calling LeasesApi->create_lease_ledger_charge: #{e}"
380
+ puts "Error when calling LeasesApi->get_all_lease_renewals: #{e}"
390
381
  end
391
382
  ```
392
383
 
393
- #### Using the create_lease_ledger_charge_with_http_info variant
384
+ #### Using the get_all_lease_renewals_with_http_info variant
394
385
 
395
386
  This returns an Array which contains the response data, status code and headers.
396
387
 
397
- > <Array(<Array<LeaseTransactionMessage>>, Integer, Hash)> create_lease_ledger_charge_with_http_info(lease_id, lease_charge_post_message)
388
+ > <Array(<Array<LeaseRenewalMessage>>, Integer, Hash)> get_all_lease_renewals_with_http_info(lease_id, opts)
398
389
 
399
390
  ```ruby
400
391
  begin
401
- # Create a charge
402
- data, status_code, headers = api_instance.create_lease_ledger_charge_with_http_info(lease_id, lease_charge_post_message)
392
+ # Retrieve all renewals
393
+ data, status_code, headers = api_instance.get_all_lease_renewals_with_http_info(lease_id, opts)
403
394
  p status_code # => 2xx
404
395
  p headers # => { ... }
405
- p data # => <Array<LeaseTransactionMessage>>
396
+ p data # => <Array<LeaseRenewalMessage>>
406
397
  rescue Buildium::ApiError => e
407
- puts "Error when calling LeasesApi->create_lease_ledger_charge_with_http_info: #{e}"
398
+ puts "Error when calling LeasesApi->get_all_lease_renewals_with_http_info: #{e}"
408
399
  end
409
400
  ```
410
401
 
@@ -413,11 +404,13 @@ end
413
404
  | Name | Type | Description | Notes |
414
405
  | ---- | ---- | ----------- | ----- |
415
406
  | **lease_id** | **Integer** | | |
416
- | **lease_charge_post_message** | [**LeaseChargePostMessage**](LeaseChargePostMessage.md) | | |
407
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
408
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
409
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
417
410
 
418
411
  ### Return type
419
412
 
420
- [**Array&lt;LeaseTransactionMessage&gt;**](LeaseTransactionMessage.md)
413
+ [**Array&lt;LeaseRenewalMessage&gt;**](LeaseRenewalMessage.md)
421
414
 
422
415
  ### Authorization
423
416
 
@@ -425,17 +418,17 @@ end
425
418
 
426
419
  ### HTTP request headers
427
420
 
428
- - **Content-Type**: application/json
421
+ - **Content-Type**: Not defined
429
422
  - **Accept**: application/json
430
423
 
431
424
 
432
- ## create_lease_ledger_deposit_withholding
425
+ ## get_all_lease_renewals_for_all_properties
433
426
 
434
- > <LeaseTransactionMessage> create_lease_ledger_deposit_withholding(lease_id, lease_ledger_deposit_withholding_post_message)
427
+ > <Array<LeaseRenewalMessage>> get_all_lease_renewals_for_all_properties(esignaturestatuses, opts)
435
428
 
436
- Create a deposit withholding
429
+ Retrieve all upcoming renewals
437
430
 
438
- Withholds a resident deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Ledger</span> - `View` `Edit` <span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View`
431
+ Retrieves all upcoming lease renewals across all rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
439
432
 
440
433
  ### Examples
441
434
 
@@ -456,33 +449,39 @@ Buildium.configure do |config|
456
449
  end
457
450
 
458
451
  api_instance = Buildium::LeasesApi.new
459
- lease_id = 56 # Integer |
460
- lease_ledger_deposit_withholding_post_message = Buildium::LeaseLedgerDepositWithholdingPostMessage.new({entry_date: Date.today, deposit_liability_gl_account_id: 37}) # LeaseLedgerDepositWithholdingPostMessage |
452
+ esignaturestatuses = ['Unknown'] # Array<String> | Filters result to any lease renewal with an esignature status that matches the given statuses.
453
+ opts = {
454
+ propertyids: [37], # Array<Integer> | Filters results to only include leases whose unit belongs to the specified set of property ids.
455
+ rentalownerids: [37], # Array<Integer> | Filters results to any lease whose unit belongs to a property with rental owner in the specified set of rental owner ids.
456
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
457
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
458
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
459
+ }
461
460
 
462
461
  begin
463
- # Create a deposit withholding
464
- result = api_instance.create_lease_ledger_deposit_withholding(lease_id, lease_ledger_deposit_withholding_post_message)
462
+ # Retrieve all upcoming renewals
463
+ result = api_instance.get_all_lease_renewals_for_all_properties(esignaturestatuses, opts)
465
464
  p result
466
465
  rescue Buildium::ApiError => e
467
- puts "Error when calling LeasesApi->create_lease_ledger_deposit_withholding: #{e}"
466
+ puts "Error when calling LeasesApi->get_all_lease_renewals_for_all_properties: #{e}"
468
467
  end
469
468
  ```
470
469
 
471
- #### Using the create_lease_ledger_deposit_withholding_with_http_info variant
470
+ #### Using the get_all_lease_renewals_for_all_properties_with_http_info variant
472
471
 
473
472
  This returns an Array which contains the response data, status code and headers.
474
473
 
475
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> create_lease_ledger_deposit_withholding_with_http_info(lease_id, lease_ledger_deposit_withholding_post_message)
474
+ > <Array(<Array<LeaseRenewalMessage>>, Integer, Hash)> get_all_lease_renewals_for_all_properties_with_http_info(esignaturestatuses, opts)
476
475
 
477
476
  ```ruby
478
477
  begin
479
- # Create a deposit withholding
480
- data, status_code, headers = api_instance.create_lease_ledger_deposit_withholding_with_http_info(lease_id, lease_ledger_deposit_withholding_post_message)
478
+ # Retrieve all upcoming renewals
479
+ data, status_code, headers = api_instance.get_all_lease_renewals_for_all_properties_with_http_info(esignaturestatuses, opts)
481
480
  p status_code # => 2xx
482
481
  p headers # => { ... }
483
- p data # => <LeaseTransactionMessage>
482
+ p data # => <Array<LeaseRenewalMessage>>
484
483
  rescue Buildium::ApiError => e
485
- puts "Error when calling LeasesApi->create_lease_ledger_deposit_withholding_with_http_info: #{e}"
484
+ puts "Error when calling LeasesApi->get_all_lease_renewals_for_all_properties_with_http_info: #{e}"
486
485
  end
487
486
  ```
488
487
 
@@ -490,12 +489,16 @@ end
490
489
 
491
490
  | Name | Type | Description | Notes |
492
491
  | ---- | ---- | ----------- | ----- |
493
- | **lease_id** | **Integer** | | |
494
- | **lease_ledger_deposit_withholding_post_message** | [**LeaseLedgerDepositWithholdingPostMessage**](LeaseLedgerDepositWithholdingPostMessage.md) | | |
492
+ | **esignaturestatuses** | [**Array&lt;String&gt;**](String.md) | Filters result to any lease renewal with an esignature status that matches the given statuses. | |
493
+ | **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only include leases whose unit belongs to the specified set of property ids. | [optional] |
494
+ | **rentalownerids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to any lease whose unit belongs to a property with rental owner in the specified set of rental owner ids. | [optional] |
495
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
496
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
497
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
495
498
 
496
499
  ### Return type
497
500
 
498
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
501
+ [**Array&lt;LeaseRenewalMessage&gt;**](LeaseRenewalMessage.md)
499
502
 
500
503
  ### Authorization
501
504
 
@@ -503,17 +506,17 @@ end
503
506
 
504
507
  ### HTTP request headers
505
508
 
506
- - **Content-Type**: application/json
509
+ - **Content-Type**: Not defined
507
510
  - **Accept**: application/json
508
511
 
509
512
 
510
- ## create_lease_ledger_refund
513
+ ## get_lease_by_id
511
514
 
512
- > <LeaseLedgerRefundMessage> create_lease_ledger_refund(lease_id, lease_ledger_refund_post_message)
515
+ > <LeaseMessage> get_lease_by_id(lease_id)
513
516
 
514
- Create a refund
517
+ Retrieve a lease
515
518
 
516
- Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
519
+ Retrieves a specific lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
517
520
 
518
521
  ### Examples
519
522
 
@@ -534,33 +537,32 @@ Buildium.configure do |config|
534
537
  end
535
538
 
536
539
  api_instance = Buildium::LeasesApi.new
537
- lease_id = 56 # Integer |
538
- lease_ledger_refund_post_message = Buildium::LeaseLedgerRefundPostMessage.new({date: Date.today, payee_user_ids: [37], bank_account_id: 37, address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'}), lines: [Buildium::LeaseLedgerRefundLinePostMessage.new({amount: 3.56, gl_account_id: 37})]}) # LeaseLedgerRefundPostMessage |
540
+ lease_id = 56 # Integer | The lease identifier.
539
541
 
540
542
  begin
541
- # Create a refund
542
- result = api_instance.create_lease_ledger_refund(lease_id, lease_ledger_refund_post_message)
543
+ # Retrieve a lease
544
+ result = api_instance.get_lease_by_id(lease_id)
543
545
  p result
544
546
  rescue Buildium::ApiError => e
545
- puts "Error when calling LeasesApi->create_lease_ledger_refund: #{e}"
547
+ puts "Error when calling LeasesApi->get_lease_by_id: #{e}"
546
548
  end
547
549
  ```
548
550
 
549
- #### Using the create_lease_ledger_refund_with_http_info variant
551
+ #### Using the get_lease_by_id_with_http_info variant
550
552
 
551
553
  This returns an Array which contains the response data, status code and headers.
552
554
 
553
- > <Array(<LeaseLedgerRefundMessage>, Integer, Hash)> create_lease_ledger_refund_with_http_info(lease_id, lease_ledger_refund_post_message)
555
+ > <Array(<LeaseMessage>, Integer, Hash)> get_lease_by_id_with_http_info(lease_id)
554
556
 
555
557
  ```ruby
556
558
  begin
557
- # Create a refund
558
- data, status_code, headers = api_instance.create_lease_ledger_refund_with_http_info(lease_id, lease_ledger_refund_post_message)
559
+ # Retrieve a lease
560
+ data, status_code, headers = api_instance.get_lease_by_id_with_http_info(lease_id)
559
561
  p status_code # => 2xx
560
562
  p headers # => { ... }
561
- p data # => <LeaseLedgerRefundMessage>
563
+ p data # => <LeaseMessage>
562
564
  rescue Buildium::ApiError => e
563
- puts "Error when calling LeasesApi->create_lease_ledger_refund_with_http_info: #{e}"
565
+ puts "Error when calling LeasesApi->get_lease_by_id_with_http_info: #{e}"
564
566
  end
565
567
  ```
566
568
 
@@ -568,12 +570,11 @@ end
568
570
 
569
571
  | Name | Type | Description | Notes |
570
572
  | ---- | ---- | ----------- | ----- |
571
- | **lease_id** | **Integer** | | |
572
- | **lease_ledger_refund_post_message** | [**LeaseLedgerRefundPostMessage**](LeaseLedgerRefundPostMessage.md) | | |
573
+ | **lease_id** | **Integer** | The lease identifier. | |
573
574
 
574
575
  ### Return type
575
576
 
576
- [**LeaseLedgerRefundMessage**](LeaseLedgerRefundMessage.md)
577
+ [**LeaseMessage**](LeaseMessage.md)
577
578
 
578
579
  ### Authorization
579
580
 
@@ -581,17 +582,17 @@ end
581
582
 
582
583
  ### HTTP request headers
583
584
 
584
- - **Content-Type**: application/json
585
+ - **Content-Type**: Not defined
585
586
  - **Accept**: application/json
586
587
 
587
588
 
588
- ## create_lease_note
589
+ ## get_lease_epay_settings_by_id
589
590
 
590
- > <NoteMessage> create_lease_note(lease_id, note_post_message)
591
+ > <EPaySettingsMessage> get_lease_epay_settings_by_id(lease_id)
591
592
 
592
- Create a note
593
+ Retrieve ePay settings
593
594
 
594
- Creates a lease note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
595
+ Retrieves ePay settings for a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
595
596
 
596
597
  ### Examples
597
598
 
@@ -613,32 +614,31 @@ end
613
614
 
614
615
  api_instance = Buildium::LeasesApi.new
615
616
  lease_id = 56 # Integer |
616
- note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
617
617
 
618
618
  begin
619
- # Create a note
620
- result = api_instance.create_lease_note(lease_id, note_post_message)
619
+ # Retrieve ePay settings
620
+ result = api_instance.get_lease_epay_settings_by_id(lease_id)
621
621
  p result
622
622
  rescue Buildium::ApiError => e
623
- puts "Error when calling LeasesApi->create_lease_note: #{e}"
623
+ puts "Error when calling LeasesApi->get_lease_epay_settings_by_id: #{e}"
624
624
  end
625
625
  ```
626
626
 
627
- #### Using the create_lease_note_with_http_info variant
627
+ #### Using the get_lease_epay_settings_by_id_with_http_info variant
628
628
 
629
629
  This returns an Array which contains the response data, status code and headers.
630
630
 
631
- > <Array(<NoteMessage>, Integer, Hash)> create_lease_note_with_http_info(lease_id, note_post_message)
631
+ > <Array(<EPaySettingsMessage>, Integer, Hash)> get_lease_epay_settings_by_id_with_http_info(lease_id)
632
632
 
633
633
  ```ruby
634
634
  begin
635
- # Create a note
636
- data, status_code, headers = api_instance.create_lease_note_with_http_info(lease_id, note_post_message)
635
+ # Retrieve ePay settings
636
+ data, status_code, headers = api_instance.get_lease_epay_settings_by_id_with_http_info(lease_id)
637
637
  p status_code # => 2xx
638
638
  p headers # => { ... }
639
- p data # => <NoteMessage>
639
+ p data # => <EPaySettingsMessage>
640
640
  rescue Buildium::ApiError => e
641
- puts "Error when calling LeasesApi->create_lease_note_with_http_info: #{e}"
641
+ puts "Error when calling LeasesApi->get_lease_epay_settings_by_id_with_http_info: #{e}"
642
642
  end
643
643
  ```
644
644
 
@@ -647,11 +647,10 @@ end
647
647
  | Name | Type | Description | Notes |
648
648
  | ---- | ---- | ----------- | ----- |
649
649
  | **lease_id** | **Integer** | | |
650
- | **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
651
650
 
652
651
  ### Return type
653
652
 
654
- [**NoteMessage**](NoteMessage.md)
653
+ [**EPaySettingsMessage**](EPaySettingsMessage.md)
655
654
 
656
655
  ### Authorization
657
656
 
@@ -659,17 +658,17 @@ end
659
658
 
660
659
  ### HTTP request headers
661
660
 
662
- - **Content-Type**: application/json
661
+ - **Content-Type**: Not defined
663
662
  - **Accept**: application/json
664
663
 
665
664
 
666
- ## create_lease_recurring_payment
665
+ ## get_lease_move_out_data_by_tenant_id
667
666
 
668
- > <LeaseRecurringPaymentMessage> create_lease_recurring_payment(lease_id, payment_recurring_transaction_post_message)
667
+ > <LeaseMoveOutDataMessage> get_lease_move_out_data_by_tenant_id(lease_id, tenant_id)
669
668
 
670
- Create a recurring payment
669
+ Retrieve a move out
671
670
 
672
- Creates a recurring payment that will post automatically on the specified lease ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Transactions</span> - `View` `Edit`
671
+ Retrieves move out data for a single tenant on a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`
673
672
 
674
673
  ### Examples
675
674
 
@@ -691,32 +690,32 @@ end
691
690
 
692
691
  api_instance = Buildium::LeasesApi.new
693
692
  lease_id = 56 # Integer |
694
- payment_recurring_transaction_post_message = Buildium::PaymentRecurringTransactionPostMessage.new({payment_method: 'Check', first_occurrence_date: Date.today, post_days_in_advance: 37, frequency: 'Monthly'}) # PaymentRecurringTransactionPostMessage |
693
+ tenant_id = 56 # Integer |
695
694
 
696
695
  begin
697
- # Create a recurring payment
698
- result = api_instance.create_lease_recurring_payment(lease_id, payment_recurring_transaction_post_message)
696
+ # Retrieve a move out
697
+ result = api_instance.get_lease_move_out_data_by_tenant_id(lease_id, tenant_id)
699
698
  p result
700
699
  rescue Buildium::ApiError => e
701
- puts "Error when calling LeasesApi->create_lease_recurring_payment: #{e}"
700
+ puts "Error when calling LeasesApi->get_lease_move_out_data_by_tenant_id: #{e}"
702
701
  end
703
702
  ```
704
703
 
705
- #### Using the create_lease_recurring_payment_with_http_info variant
704
+ #### Using the get_lease_move_out_data_by_tenant_id_with_http_info variant
706
705
 
707
706
  This returns an Array which contains the response data, status code and headers.
708
707
 
709
- > <Array(<LeaseRecurringPaymentMessage>, Integer, Hash)> create_lease_recurring_payment_with_http_info(lease_id, payment_recurring_transaction_post_message)
708
+ > <Array(<LeaseMoveOutDataMessage>, Integer, Hash)> get_lease_move_out_data_by_tenant_id_with_http_info(lease_id, tenant_id)
710
709
 
711
710
  ```ruby
712
711
  begin
713
- # Create a recurring payment
714
- data, status_code, headers = api_instance.create_lease_recurring_payment_with_http_info(lease_id, payment_recurring_transaction_post_message)
712
+ # Retrieve a move out
713
+ data, status_code, headers = api_instance.get_lease_move_out_data_by_tenant_id_with_http_info(lease_id, tenant_id)
715
714
  p status_code # => 2xx
716
715
  p headers # => { ... }
717
- p data # => <LeaseRecurringPaymentMessage>
716
+ p data # => <LeaseMoveOutDataMessage>
718
717
  rescue Buildium::ApiError => e
719
- puts "Error when calling LeasesApi->create_lease_recurring_payment_with_http_info: #{e}"
718
+ puts "Error when calling LeasesApi->get_lease_move_out_data_by_tenant_id_with_http_info: #{e}"
720
719
  end
721
720
  ```
722
721
 
@@ -725,11 +724,11 @@ end
725
724
  | Name | Type | Description | Notes |
726
725
  | ---- | ---- | ----------- | ----- |
727
726
  | **lease_id** | **Integer** | | |
728
- | **payment_recurring_transaction_post_message** | [**PaymentRecurringTransactionPostMessage**](PaymentRecurringTransactionPostMessage.md) | | |
727
+ | **tenant_id** | **Integer** | | |
729
728
 
730
729
  ### Return type
731
730
 
732
- [**LeaseRecurringPaymentMessage**](LeaseRecurringPaymentMessage.md)
731
+ [**LeaseMoveOutDataMessage**](LeaseMoveOutDataMessage.md)
733
732
 
734
733
  ### Authorization
735
734
 
@@ -737,17 +736,17 @@ end
737
736
 
738
737
  ### HTTP request headers
739
738
 
740
- - **Content-Type**: application/json
739
+ - **Content-Type**: Not defined
741
740
  - **Accept**: application/json
742
741
 
743
742
 
744
- ## create_lease_reverse_payment
743
+ ## get_lease_move_out_information_by_id
745
744
 
746
- > <LeaseTransactionMessage> create_lease_reverse_payment(lease_id, lease_ledger_reverse_payment_post_message)
745
+ > <Array<LeaseMoveOutDataMessage>> get_lease_move_out_information_by_id(lease_id, opts)
747
746
 
748
- Create a payment reversal
747
+ Retrieve all move outs
749
748
 
750
- Reverses a lease ledger payment. Note, this action can only be taken on a payment that has been deposited. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
749
+ Retrieves a list of move out dates for a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`
751
750
 
752
751
  ### Examples
753
752
 
@@ -768,33 +767,37 @@ Buildium.configure do |config|
768
767
  end
769
768
 
770
769
  api_instance = Buildium::LeasesApi.new
771
- lease_id = 56 # Integer | The lease unique identifier.
772
- lease_ledger_reverse_payment_post_message = Buildium::LeaseLedgerReversePaymentPostMessage.new({entry_date: Date.today, payment_transaction_id: 37}) # LeaseLedgerReversePaymentPostMessage |
770
+ lease_id = 56 # Integer |
771
+ opts = {
772
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
773
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
774
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
775
+ }
773
776
 
774
777
  begin
775
- # Create a payment reversal
776
- result = api_instance.create_lease_reverse_payment(lease_id, lease_ledger_reverse_payment_post_message)
778
+ # Retrieve all move outs
779
+ result = api_instance.get_lease_move_out_information_by_id(lease_id, opts)
777
780
  p result
778
781
  rescue Buildium::ApiError => e
779
- puts "Error when calling LeasesApi->create_lease_reverse_payment: #{e}"
782
+ puts "Error when calling LeasesApi->get_lease_move_out_information_by_id: #{e}"
780
783
  end
781
784
  ```
782
785
 
783
- #### Using the create_lease_reverse_payment_with_http_info variant
786
+ #### Using the get_lease_move_out_information_by_id_with_http_info variant
784
787
 
785
788
  This returns an Array which contains the response data, status code and headers.
786
789
 
787
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> create_lease_reverse_payment_with_http_info(lease_id, lease_ledger_reverse_payment_post_message)
790
+ > <Array(<Array<LeaseMoveOutDataMessage>>, Integer, Hash)> get_lease_move_out_information_by_id_with_http_info(lease_id, opts)
788
791
 
789
792
  ```ruby
790
793
  begin
791
- # Create a payment reversal
792
- data, status_code, headers = api_instance.create_lease_reverse_payment_with_http_info(lease_id, lease_ledger_reverse_payment_post_message)
794
+ # Retrieve all move outs
795
+ data, status_code, headers = api_instance.get_lease_move_out_information_by_id_with_http_info(lease_id, opts)
793
796
  p status_code # => 2xx
794
797
  p headers # => { ... }
795
- p data # => <LeaseTransactionMessage>
798
+ p data # => <Array<LeaseMoveOutDataMessage>>
796
799
  rescue Buildium::ApiError => e
797
- puts "Error when calling LeasesApi->create_lease_reverse_payment_with_http_info: #{e}"
800
+ puts "Error when calling LeasesApi->get_lease_move_out_information_by_id_with_http_info: #{e}"
798
801
  end
799
802
  ```
800
803
 
@@ -802,12 +805,14 @@ end
802
805
 
803
806
  | Name | Type | Description | Notes |
804
807
  | ---- | ---- | ----------- | ----- |
805
- | **lease_id** | **Integer** | The lease unique identifier. | |
806
- | **lease_ledger_reverse_payment_post_message** | [**LeaseLedgerReversePaymentPostMessage**](LeaseLedgerReversePaymentPostMessage.md) | | |
808
+ | **lease_id** | **Integer** | | |
809
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
810
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
811
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
807
812
 
808
813
  ### Return type
809
814
 
810
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
815
+ [**Array&lt;LeaseMoveOutDataMessage&gt;**](LeaseMoveOutDataMessage.md)
811
816
 
812
817
  ### Authorization
813
818
 
@@ -815,17 +820,17 @@ end
815
820
 
816
821
  ### HTTP request headers
817
822
 
818
- - **Content-Type**: application/json
823
+ - **Content-Type**: Not defined
819
824
  - **Accept**: application/json
820
825
 
821
826
 
822
- ## create_move_out_data
827
+ ## get_lease_note_by_note_id
823
828
 
824
- > <LeaseMoveOutDataMessage> create_move_out_data(lease_id, lease_move_out_data_post_message)
829
+ > <NoteMessage> get_lease_note_by_note_id(lease_id, note_id)
825
830
 
826
- Create a move out
831
+ Retrieve a note
827
832
 
828
- Creates move out data for a single tenant on a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` `Edit`
833
+ Retrieves a lease note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
829
834
 
830
835
  ### Examples
831
836
 
@@ -847,32 +852,32 @@ end
847
852
 
848
853
  api_instance = Buildium::LeasesApi.new
849
854
  lease_id = 56 # Integer |
850
- lease_move_out_data_post_message = Buildium::LeaseMoveOutDataPostMessage.new({tenant_id: 37, move_out_date: Date.today}) # LeaseMoveOutDataPostMessage |
855
+ note_id = 56 # Integer |
851
856
 
852
857
  begin
853
- # Create a move out
854
- result = api_instance.create_move_out_data(lease_id, lease_move_out_data_post_message)
858
+ # Retrieve a note
859
+ result = api_instance.get_lease_note_by_note_id(lease_id, note_id)
855
860
  p result
856
861
  rescue Buildium::ApiError => e
857
- puts "Error when calling LeasesApi->create_move_out_data: #{e}"
862
+ puts "Error when calling LeasesApi->get_lease_note_by_note_id: #{e}"
858
863
  end
859
864
  ```
860
865
 
861
- #### Using the create_move_out_data_with_http_info variant
866
+ #### Using the get_lease_note_by_note_id_with_http_info variant
862
867
 
863
868
  This returns an Array which contains the response data, status code and headers.
864
869
 
865
- > <Array(<LeaseMoveOutDataMessage>, Integer, Hash)> create_move_out_data_with_http_info(lease_id, lease_move_out_data_post_message)
870
+ > <Array(<NoteMessage>, Integer, Hash)> get_lease_note_by_note_id_with_http_info(lease_id, note_id)
866
871
 
867
872
  ```ruby
868
873
  begin
869
- # Create a move out
870
- data, status_code, headers = api_instance.create_move_out_data_with_http_info(lease_id, lease_move_out_data_post_message)
874
+ # Retrieve a note
875
+ data, status_code, headers = api_instance.get_lease_note_by_note_id_with_http_info(lease_id, note_id)
871
876
  p status_code # => 2xx
872
877
  p headers # => { ... }
873
- p data # => <LeaseMoveOutDataMessage>
878
+ p data # => <NoteMessage>
874
879
  rescue Buildium::ApiError => e
875
- puts "Error when calling LeasesApi->create_move_out_data_with_http_info: #{e}"
880
+ puts "Error when calling LeasesApi->get_lease_note_by_note_id_with_http_info: #{e}"
876
881
  end
877
882
  ```
878
883
 
@@ -881,11 +886,11 @@ end
881
886
  | Name | Type | Description | Notes |
882
887
  | ---- | ---- | ----------- | ----- |
883
888
  | **lease_id** | **Integer** | | |
884
- | **lease_move_out_data_post_message** | [**LeaseMoveOutDataPostMessage**](LeaseMoveOutDataPostMessage.md) | | |
889
+ | **note_id** | **Integer** | | |
885
890
 
886
891
  ### Return type
887
892
 
888
- [**LeaseMoveOutDataMessage**](LeaseMoveOutDataMessage.md)
893
+ [**NoteMessage**](NoteMessage.md)
889
894
 
890
895
  ### Authorization
891
896
 
@@ -893,17 +898,17 @@ end
893
898
 
894
899
  ### HTTP request headers
895
900
 
896
- - **Content-Type**: application/json
901
+ - **Content-Type**: Not defined
897
902
  - **Accept**: application/json
898
903
 
899
904
 
900
- ## create_payment
905
+ ## get_lease_notes
901
906
 
902
- > <LeaseTransactionMessage> create_payment(lease_id, lease_ledger_payment_post_message)
907
+ > <Array<NoteMessage>> get_lease_notes(lease_id, opts)
903
908
 
904
- Create a payment
909
+ Retrieve all notes
905
910
 
906
- Creates a lease ledger payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
911
+ Retrieves all lease notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
907
912
 
908
913
  ### Examples
909
914
 
@@ -924,33 +929,40 @@ Buildium.configure do |config|
924
929
  end
925
930
 
926
931
  api_instance = Buildium::LeasesApi.new
927
- lease_id = 56 # Integer | The lease unique identifier.
928
- lease_ledger_payment_post_message = Buildium::LeaseLedgerPaymentPostMessage.new({date: Date.today, payment_method: 'Check', send_email_receipt: false, lines: [Buildium::LeaseLedgerPaymentLineSaveMessage.new({amount: 3.56, gl_account_id: 37})]}) # LeaseLedgerPaymentPostMessage |
932
+ lease_id = 56 # Integer |
933
+ opts = {
934
+ updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
935
+ updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
936
+ lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
937
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
938
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
939
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
940
+ }
929
941
 
930
942
  begin
931
- # Create a payment
932
- result = api_instance.create_payment(lease_id, lease_ledger_payment_post_message)
943
+ # Retrieve all notes
944
+ result = api_instance.get_lease_notes(lease_id, opts)
933
945
  p result
934
946
  rescue Buildium::ApiError => e
935
- puts "Error when calling LeasesApi->create_payment: #{e}"
947
+ puts "Error when calling LeasesApi->get_lease_notes: #{e}"
936
948
  end
937
949
  ```
938
950
 
939
- #### Using the create_payment_with_http_info variant
951
+ #### Using the get_lease_notes_with_http_info variant
940
952
 
941
953
  This returns an Array which contains the response data, status code and headers.
942
954
 
943
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> create_payment_with_http_info(lease_id, lease_ledger_payment_post_message)
955
+ > <Array(<Array<NoteMessage>>, Integer, Hash)> get_lease_notes_with_http_info(lease_id, opts)
944
956
 
945
957
  ```ruby
946
958
  begin
947
- # Create a payment
948
- data, status_code, headers = api_instance.create_payment_with_http_info(lease_id, lease_ledger_payment_post_message)
959
+ # Retrieve all notes
960
+ data, status_code, headers = api_instance.get_lease_notes_with_http_info(lease_id, opts)
949
961
  p status_code # => 2xx
950
962
  p headers # => { ... }
951
- p data # => <LeaseTransactionMessage>
963
+ p data # => <Array<NoteMessage>>
952
964
  rescue Buildium::ApiError => e
953
- puts "Error when calling LeasesApi->create_payment_with_http_info: #{e}"
965
+ puts "Error when calling LeasesApi->get_lease_notes_with_http_info: #{e}"
954
966
  end
955
967
  ```
956
968
 
@@ -958,12 +970,17 @@ end
958
970
 
959
971
  | Name | Type | Description | Notes |
960
972
  | ---- | ---- | ----------- | ----- |
961
- | **lease_id** | **Integer** | The lease unique identifier. | |
962
- | **lease_ledger_payment_post_message** | [**LeaseLedgerPaymentPostMessage**](LeaseLedgerPaymentPostMessage.md) | | |
973
+ | **lease_id** | **Integer** | | |
974
+ | **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
975
+ | **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
976
+ | **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
977
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
978
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
979
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
963
980
 
964
981
  ### Return type
965
982
 
966
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
983
+ [**Array&lt;NoteMessage&gt;**](NoteMessage.md)
967
984
 
968
985
  ### Authorization
969
986
 
@@ -971,17 +988,17 @@ end
971
988
 
972
989
  ### HTTP request headers
973
990
 
974
- - **Content-Type**: application/json
991
+ - **Content-Type**: Not defined
975
992
  - **Accept**: application/json
976
993
 
977
994
 
978
- ## get_lease_by_id
995
+ ## get_lease_renewal_by_id
979
996
 
980
- > <LeaseMessage> get_lease_by_id(lease_id)
997
+ > <LeaseRenewalMessage> get_lease_renewal_by_id(lease_id, renewal_id)
981
998
 
982
- Retrieve a lease
999
+ Retrieve a renewal
983
1000
 
984
- Retrieves a specific lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1001
+ Retrieves a specific renewal for a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
985
1002
 
986
1003
  ### Examples
987
1004
 
@@ -1002,32 +1019,33 @@ Buildium.configure do |config|
1002
1019
  end
1003
1020
 
1004
1021
  api_instance = Buildium::LeasesApi.new
1005
- lease_id = 56 # Integer | The lease identifier.
1022
+ lease_id = 56 # Integer |
1023
+ renewal_id = 56 # Integer |
1006
1024
 
1007
1025
  begin
1008
- # Retrieve a lease
1009
- result = api_instance.get_lease_by_id(lease_id)
1026
+ # Retrieve a renewal
1027
+ result = api_instance.get_lease_renewal_by_id(lease_id, renewal_id)
1010
1028
  p result
1011
1029
  rescue Buildium::ApiError => e
1012
- puts "Error when calling LeasesApi->get_lease_by_id: #{e}"
1030
+ puts "Error when calling LeasesApi->get_lease_renewal_by_id: #{e}"
1013
1031
  end
1014
1032
  ```
1015
1033
 
1016
- #### Using the get_lease_by_id_with_http_info variant
1034
+ #### Using the get_lease_renewal_by_id_with_http_info variant
1017
1035
 
1018
1036
  This returns an Array which contains the response data, status code and headers.
1019
1037
 
1020
- > <Array(<LeaseMessage>, Integer, Hash)> get_lease_by_id_with_http_info(lease_id)
1038
+ > <Array(<LeaseRenewalMessage>, Integer, Hash)> get_lease_renewal_by_id_with_http_info(lease_id, renewal_id)
1021
1039
 
1022
1040
  ```ruby
1023
1041
  begin
1024
- # Retrieve a lease
1025
- data, status_code, headers = api_instance.get_lease_by_id_with_http_info(lease_id)
1042
+ # Retrieve a renewal
1043
+ data, status_code, headers = api_instance.get_lease_renewal_by_id_with_http_info(lease_id, renewal_id)
1026
1044
  p status_code # => 2xx
1027
1045
  p headers # => { ... }
1028
- p data # => <LeaseMessage>
1046
+ p data # => <LeaseRenewalMessage>
1029
1047
  rescue Buildium::ApiError => e
1030
- puts "Error when calling LeasesApi->get_lease_by_id_with_http_info: #{e}"
1048
+ puts "Error when calling LeasesApi->get_lease_renewal_by_id_with_http_info: #{e}"
1031
1049
  end
1032
1050
  ```
1033
1051
 
@@ -1035,11 +1053,12 @@ end
1035
1053
 
1036
1054
  | Name | Type | Description | Notes |
1037
1055
  | ---- | ---- | ----------- | ----- |
1038
- | **lease_id** | **Integer** | The lease identifier. | |
1056
+ | **lease_id** | **Integer** | | |
1057
+ | **renewal_id** | **Integer** | | |
1039
1058
 
1040
1059
  ### Return type
1041
1060
 
1042
- [**LeaseMessage**](LeaseMessage.md)
1061
+ [**LeaseRenewalMessage**](LeaseRenewalMessage.md)
1043
1062
 
1044
1063
  ### Authorization
1045
1064
 
@@ -1051,925 +1070,13 @@ end
1051
1070
  - **Accept**: application/json
1052
1071
 
1053
1072
 
1054
- ## get_lease_charge_recurring_transaction_by_id
1073
+ ## get_leases
1055
1074
 
1056
- > <LeaseChargeRecurringTransactionMessage> get_lease_charge_recurring_transaction_by_id(lease_id, transaction_id)
1075
+ > <Array<LeaseMessage>> get_leases(opts)
1057
1076
 
1058
- Retrieve a recurring charge
1077
+ Retrieve all leases
1059
1078
 
1060
- Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1061
-
1062
- ### Examples
1063
-
1064
- ```ruby
1065
- require 'time'
1066
- require 'buildium-ruby'
1067
- # setup authorization
1068
- Buildium.configure do |config|
1069
- # Configure API key authorization: clientId
1070
- config.api_key['clientId'] = 'YOUR API KEY'
1071
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1072
- # config.api_key_prefix['clientId'] = 'Bearer'
1073
-
1074
- # Configure API key authorization: clientSecret
1075
- config.api_key['clientSecret'] = 'YOUR API KEY'
1076
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1077
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1078
- end
1079
-
1080
- api_instance = Buildium::LeasesApi.new
1081
- lease_id = 56 # Integer |
1082
- transaction_id = 56 # Integer |
1083
-
1084
- begin
1085
- # Retrieve a recurring charge
1086
- result = api_instance.get_lease_charge_recurring_transaction_by_id(lease_id, transaction_id)
1087
- p result
1088
- rescue Buildium::ApiError => e
1089
- puts "Error when calling LeasesApi->get_lease_charge_recurring_transaction_by_id: #{e}"
1090
- end
1091
- ```
1092
-
1093
- #### Using the get_lease_charge_recurring_transaction_by_id_with_http_info variant
1094
-
1095
- This returns an Array which contains the response data, status code and headers.
1096
-
1097
- > <Array(<LeaseChargeRecurringTransactionMessage>, Integer, Hash)> get_lease_charge_recurring_transaction_by_id_with_http_info(lease_id, transaction_id)
1098
-
1099
- ```ruby
1100
- begin
1101
- # Retrieve a recurring charge
1102
- data, status_code, headers = api_instance.get_lease_charge_recurring_transaction_by_id_with_http_info(lease_id, transaction_id)
1103
- p status_code # => 2xx
1104
- p headers # => { ... }
1105
- p data # => <LeaseChargeRecurringTransactionMessage>
1106
- rescue Buildium::ApiError => e
1107
- puts "Error when calling LeasesApi->get_lease_charge_recurring_transaction_by_id_with_http_info: #{e}"
1108
- end
1109
- ```
1110
-
1111
- ### Parameters
1112
-
1113
- | Name | Type | Description | Notes |
1114
- | ---- | ---- | ----------- | ----- |
1115
- | **lease_id** | **Integer** | | |
1116
- | **transaction_id** | **Integer** | | |
1117
-
1118
- ### Return type
1119
-
1120
- [**LeaseChargeRecurringTransactionMessage**](LeaseChargeRecurringTransactionMessage.md)
1121
-
1122
- ### Authorization
1123
-
1124
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1125
-
1126
- ### HTTP request headers
1127
-
1128
- - **Content-Type**: Not defined
1129
- - **Accept**: application/json
1130
-
1131
-
1132
- ## get_lease_ledger_refund_by_id
1133
-
1134
- > <LeaseLedgerRefundMessage> get_lease_ledger_refund_by_id(lease_id, refund_id)
1135
-
1136
- Retrieve a refund
1137
-
1138
- Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
1139
-
1140
- ### Examples
1141
-
1142
- ```ruby
1143
- require 'time'
1144
- require 'buildium-ruby'
1145
- # setup authorization
1146
- Buildium.configure do |config|
1147
- # Configure API key authorization: clientId
1148
- config.api_key['clientId'] = 'YOUR API KEY'
1149
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1150
- # config.api_key_prefix['clientId'] = 'Bearer'
1151
-
1152
- # Configure API key authorization: clientSecret
1153
- config.api_key['clientSecret'] = 'YOUR API KEY'
1154
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1155
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1156
- end
1157
-
1158
- api_instance = Buildium::LeasesApi.new
1159
- lease_id = 56 # Integer |
1160
- refund_id = 56 # Integer |
1161
-
1162
- begin
1163
- # Retrieve a refund
1164
- result = api_instance.get_lease_ledger_refund_by_id(lease_id, refund_id)
1165
- p result
1166
- rescue Buildium::ApiError => e
1167
- puts "Error when calling LeasesApi->get_lease_ledger_refund_by_id: #{e}"
1168
- end
1169
- ```
1170
-
1171
- #### Using the get_lease_ledger_refund_by_id_with_http_info variant
1172
-
1173
- This returns an Array which contains the response data, status code and headers.
1174
-
1175
- > <Array(<LeaseLedgerRefundMessage>, Integer, Hash)> get_lease_ledger_refund_by_id_with_http_info(lease_id, refund_id)
1176
-
1177
- ```ruby
1178
- begin
1179
- # Retrieve a refund
1180
- data, status_code, headers = api_instance.get_lease_ledger_refund_by_id_with_http_info(lease_id, refund_id)
1181
- p status_code # => 2xx
1182
- p headers # => { ... }
1183
- p data # => <LeaseLedgerRefundMessage>
1184
- rescue Buildium::ApiError => e
1185
- puts "Error when calling LeasesApi->get_lease_ledger_refund_by_id_with_http_info: #{e}"
1186
- end
1187
- ```
1188
-
1189
- ### Parameters
1190
-
1191
- | Name | Type | Description | Notes |
1192
- | ---- | ---- | ----------- | ----- |
1193
- | **lease_id** | **Integer** | | |
1194
- | **refund_id** | **Integer** | | |
1195
-
1196
- ### Return type
1197
-
1198
- [**LeaseLedgerRefundMessage**](LeaseLedgerRefundMessage.md)
1199
-
1200
- ### Authorization
1201
-
1202
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1203
-
1204
- ### HTTP request headers
1205
-
1206
- - **Content-Type**: Not defined
1207
- - **Accept**: application/json
1208
-
1209
-
1210
- ## get_lease_ledger_transaction_by_id
1211
-
1212
- > <LeaseTransactionMessage> get_lease_ledger_transaction_by_id(lease_id, transaction_id)
1213
-
1214
- Retrieve a lease transaction
1215
-
1216
- Retrieves a specific lease transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Transactions</span> - `View`
1217
-
1218
- ### Examples
1219
-
1220
- ```ruby
1221
- require 'time'
1222
- require 'buildium-ruby'
1223
- # setup authorization
1224
- Buildium.configure do |config|
1225
- # Configure API key authorization: clientId
1226
- config.api_key['clientId'] = 'YOUR API KEY'
1227
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1228
- # config.api_key_prefix['clientId'] = 'Bearer'
1229
-
1230
- # Configure API key authorization: clientSecret
1231
- config.api_key['clientSecret'] = 'YOUR API KEY'
1232
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1233
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1234
- end
1235
-
1236
- api_instance = Buildium::LeasesApi.new
1237
- lease_id = 56 # Integer |
1238
- transaction_id = 56 # Integer |
1239
-
1240
- begin
1241
- # Retrieve a lease transaction
1242
- result = api_instance.get_lease_ledger_transaction_by_id(lease_id, transaction_id)
1243
- p result
1244
- rescue Buildium::ApiError => e
1245
- puts "Error when calling LeasesApi->get_lease_ledger_transaction_by_id: #{e}"
1246
- end
1247
- ```
1248
-
1249
- #### Using the get_lease_ledger_transaction_by_id_with_http_info variant
1250
-
1251
- This returns an Array which contains the response data, status code and headers.
1252
-
1253
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> get_lease_ledger_transaction_by_id_with_http_info(lease_id, transaction_id)
1254
-
1255
- ```ruby
1256
- begin
1257
- # Retrieve a lease transaction
1258
- data, status_code, headers = api_instance.get_lease_ledger_transaction_by_id_with_http_info(lease_id, transaction_id)
1259
- p status_code # => 2xx
1260
- p headers # => { ... }
1261
- p data # => <LeaseTransactionMessage>
1262
- rescue Buildium::ApiError => e
1263
- puts "Error when calling LeasesApi->get_lease_ledger_transaction_by_id_with_http_info: #{e}"
1264
- end
1265
- ```
1266
-
1267
- ### Parameters
1268
-
1269
- | Name | Type | Description | Notes |
1270
- | ---- | ---- | ----------- | ----- |
1271
- | **lease_id** | **Integer** | | |
1272
- | **transaction_id** | **Integer** | | |
1273
-
1274
- ### Return type
1275
-
1276
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
1277
-
1278
- ### Authorization
1279
-
1280
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1281
-
1282
- ### HTTP request headers
1283
-
1284
- - **Content-Type**: Not defined
1285
- - **Accept**: application/json
1286
-
1287
-
1288
- ## get_lease_ledgers
1289
-
1290
- > <Array<LeaseTransactionMessage>> get_lease_ledgers(lease_id, opts)
1291
-
1292
- Retrieve all lease transactions
1293
-
1294
- Retrieves all the transactions for a specific lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1295
-
1296
- ### Examples
1297
-
1298
- ```ruby
1299
- require 'time'
1300
- require 'buildium-ruby'
1301
- # setup authorization
1302
- Buildium.configure do |config|
1303
- # Configure API key authorization: clientId
1304
- config.api_key['clientId'] = 'YOUR API KEY'
1305
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1306
- # config.api_key_prefix['clientId'] = 'Bearer'
1307
-
1308
- # Configure API key authorization: clientSecret
1309
- config.api_key['clientSecret'] = 'YOUR API KEY'
1310
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1311
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1312
- end
1313
-
1314
- api_instance = Buildium::LeasesApi.new
1315
- lease_id = 56 # Integer |
1316
- opts = {
1317
- transactiondatefrom: Date.parse('2013-10-20'), # Date | Filters results to any lease transaction whose start date is greater than or equal to the specified value.
1318
- transactiondateto: Date.parse('2013-10-20'), # Date | Filters results to any lease transaction whose end date is less than or equal to the specified value.
1319
- transactiontypes: ['Bill'], # Array<String> | Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.
1320
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1321
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1322
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1323
- }
1324
-
1325
- begin
1326
- # Retrieve all lease transactions
1327
- result = api_instance.get_lease_ledgers(lease_id, opts)
1328
- p result
1329
- rescue Buildium::ApiError => e
1330
- puts "Error when calling LeasesApi->get_lease_ledgers: #{e}"
1331
- end
1332
- ```
1333
-
1334
- #### Using the get_lease_ledgers_with_http_info variant
1335
-
1336
- This returns an Array which contains the response data, status code and headers.
1337
-
1338
- > <Array(<Array<LeaseTransactionMessage>>, Integer, Hash)> get_lease_ledgers_with_http_info(lease_id, opts)
1339
-
1340
- ```ruby
1341
- begin
1342
- # Retrieve all lease transactions
1343
- data, status_code, headers = api_instance.get_lease_ledgers_with_http_info(lease_id, opts)
1344
- p status_code # => 2xx
1345
- p headers # => { ... }
1346
- p data # => <Array<LeaseTransactionMessage>>
1347
- rescue Buildium::ApiError => e
1348
- puts "Error when calling LeasesApi->get_lease_ledgers_with_http_info: #{e}"
1349
- end
1350
- ```
1351
-
1352
- ### Parameters
1353
-
1354
- | Name | Type | Description | Notes |
1355
- | ---- | ---- | ----------- | ----- |
1356
- | **lease_id** | **Integer** | | |
1357
- | **transactiondatefrom** | **Date** | Filters results to any lease transaction whose start date is greater than or equal to the specified value. | [optional] |
1358
- | **transactiondateto** | **Date** | Filters results to any lease transaction whose end date is less than or equal to the specified value. | [optional] |
1359
- | **transactiontypes** | [**Array&lt;String&gt;**](String.md) | Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned. | [optional] |
1360
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1361
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1362
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1363
-
1364
- ### Return type
1365
-
1366
- [**Array&lt;LeaseTransactionMessage&gt;**](LeaseTransactionMessage.md)
1367
-
1368
- ### Authorization
1369
-
1370
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1371
-
1372
- ### HTTP request headers
1373
-
1374
- - **Content-Type**: Not defined
1375
- - **Accept**: application/json
1376
-
1377
-
1378
- ## get_lease_move_out_data_by_tenant_id
1379
-
1380
- > <LeaseMoveOutDataMessage> get_lease_move_out_data_by_tenant_id(lease_id, tenant_id)
1381
-
1382
- Retrieve a move out
1383
-
1384
- Retrieves move out data for a single tenant on a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`
1385
-
1386
- ### Examples
1387
-
1388
- ```ruby
1389
- require 'time'
1390
- require 'buildium-ruby'
1391
- # setup authorization
1392
- Buildium.configure do |config|
1393
- # Configure API key authorization: clientId
1394
- config.api_key['clientId'] = 'YOUR API KEY'
1395
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1396
- # config.api_key_prefix['clientId'] = 'Bearer'
1397
-
1398
- # Configure API key authorization: clientSecret
1399
- config.api_key['clientSecret'] = 'YOUR API KEY'
1400
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1401
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1402
- end
1403
-
1404
- api_instance = Buildium::LeasesApi.new
1405
- lease_id = 56 # Integer |
1406
- tenant_id = 56 # Integer |
1407
-
1408
- begin
1409
- # Retrieve a move out
1410
- result = api_instance.get_lease_move_out_data_by_tenant_id(lease_id, tenant_id)
1411
- p result
1412
- rescue Buildium::ApiError => e
1413
- puts "Error when calling LeasesApi->get_lease_move_out_data_by_tenant_id: #{e}"
1414
- end
1415
- ```
1416
-
1417
- #### Using the get_lease_move_out_data_by_tenant_id_with_http_info variant
1418
-
1419
- This returns an Array which contains the response data, status code and headers.
1420
-
1421
- > <Array(<LeaseMoveOutDataMessage>, Integer, Hash)> get_lease_move_out_data_by_tenant_id_with_http_info(lease_id, tenant_id)
1422
-
1423
- ```ruby
1424
- begin
1425
- # Retrieve a move out
1426
- data, status_code, headers = api_instance.get_lease_move_out_data_by_tenant_id_with_http_info(lease_id, tenant_id)
1427
- p status_code # => 2xx
1428
- p headers # => { ... }
1429
- p data # => <LeaseMoveOutDataMessage>
1430
- rescue Buildium::ApiError => e
1431
- puts "Error when calling LeasesApi->get_lease_move_out_data_by_tenant_id_with_http_info: #{e}"
1432
- end
1433
- ```
1434
-
1435
- ### Parameters
1436
-
1437
- | Name | Type | Description | Notes |
1438
- | ---- | ---- | ----------- | ----- |
1439
- | **lease_id** | **Integer** | | |
1440
- | **tenant_id** | **Integer** | | |
1441
-
1442
- ### Return type
1443
-
1444
- [**LeaseMoveOutDataMessage**](LeaseMoveOutDataMessage.md)
1445
-
1446
- ### Authorization
1447
-
1448
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1449
-
1450
- ### HTTP request headers
1451
-
1452
- - **Content-Type**: Not defined
1453
- - **Accept**: application/json
1454
-
1455
-
1456
- ## get_lease_move_out_information_by_id
1457
-
1458
- > <Array<LeaseMoveOutDataMessage>> get_lease_move_out_information_by_id(lease_id, opts)
1459
-
1460
- Retrieve all move outs
1461
-
1462
- Retrieves a list of move out dates for a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`
1463
-
1464
- ### Examples
1465
-
1466
- ```ruby
1467
- require 'time'
1468
- require 'buildium-ruby'
1469
- # setup authorization
1470
- Buildium.configure do |config|
1471
- # Configure API key authorization: clientId
1472
- config.api_key['clientId'] = 'YOUR API KEY'
1473
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1474
- # config.api_key_prefix['clientId'] = 'Bearer'
1475
-
1476
- # Configure API key authorization: clientSecret
1477
- config.api_key['clientSecret'] = 'YOUR API KEY'
1478
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1479
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1480
- end
1481
-
1482
- api_instance = Buildium::LeasesApi.new
1483
- lease_id = 56 # Integer |
1484
- opts = {
1485
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1486
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1487
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1488
- }
1489
-
1490
- begin
1491
- # Retrieve all move outs
1492
- result = api_instance.get_lease_move_out_information_by_id(lease_id, opts)
1493
- p result
1494
- rescue Buildium::ApiError => e
1495
- puts "Error when calling LeasesApi->get_lease_move_out_information_by_id: #{e}"
1496
- end
1497
- ```
1498
-
1499
- #### Using the get_lease_move_out_information_by_id_with_http_info variant
1500
-
1501
- This returns an Array which contains the response data, status code and headers.
1502
-
1503
- > <Array(<Array<LeaseMoveOutDataMessage>>, Integer, Hash)> get_lease_move_out_information_by_id_with_http_info(lease_id, opts)
1504
-
1505
- ```ruby
1506
- begin
1507
- # Retrieve all move outs
1508
- data, status_code, headers = api_instance.get_lease_move_out_information_by_id_with_http_info(lease_id, opts)
1509
- p status_code # => 2xx
1510
- p headers # => { ... }
1511
- p data # => <Array<LeaseMoveOutDataMessage>>
1512
- rescue Buildium::ApiError => e
1513
- puts "Error when calling LeasesApi->get_lease_move_out_information_by_id_with_http_info: #{e}"
1514
- end
1515
- ```
1516
-
1517
- ### Parameters
1518
-
1519
- | Name | Type | Description | Notes |
1520
- | ---- | ---- | ----------- | ----- |
1521
- | **lease_id** | **Integer** | | |
1522
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1523
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1524
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1525
-
1526
- ### Return type
1527
-
1528
- [**Array&lt;LeaseMoveOutDataMessage&gt;**](LeaseMoveOutDataMessage.md)
1529
-
1530
- ### Authorization
1531
-
1532
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1533
-
1534
- ### HTTP request headers
1535
-
1536
- - **Content-Type**: Not defined
1537
- - **Accept**: application/json
1538
-
1539
-
1540
- ## get_lease_note_by_note_id
1541
-
1542
- > <NoteMessage> get_lease_note_by_note_id(lease_id, note_id)
1543
-
1544
- Retrieve a note
1545
-
1546
- Retrieves a lease note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1547
-
1548
- ### Examples
1549
-
1550
- ```ruby
1551
- require 'time'
1552
- require 'buildium-ruby'
1553
- # setup authorization
1554
- Buildium.configure do |config|
1555
- # Configure API key authorization: clientId
1556
- config.api_key['clientId'] = 'YOUR API KEY'
1557
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1558
- # config.api_key_prefix['clientId'] = 'Bearer'
1559
-
1560
- # Configure API key authorization: clientSecret
1561
- config.api_key['clientSecret'] = 'YOUR API KEY'
1562
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1563
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1564
- end
1565
-
1566
- api_instance = Buildium::LeasesApi.new
1567
- lease_id = 56 # Integer |
1568
- note_id = 56 # Integer |
1569
-
1570
- begin
1571
- # Retrieve a note
1572
- result = api_instance.get_lease_note_by_note_id(lease_id, note_id)
1573
- p result
1574
- rescue Buildium::ApiError => e
1575
- puts "Error when calling LeasesApi->get_lease_note_by_note_id: #{e}"
1576
- end
1577
- ```
1578
-
1579
- #### Using the get_lease_note_by_note_id_with_http_info variant
1580
-
1581
- This returns an Array which contains the response data, status code and headers.
1582
-
1583
- > <Array(<NoteMessage>, Integer, Hash)> get_lease_note_by_note_id_with_http_info(lease_id, note_id)
1584
-
1585
- ```ruby
1586
- begin
1587
- # Retrieve a note
1588
- data, status_code, headers = api_instance.get_lease_note_by_note_id_with_http_info(lease_id, note_id)
1589
- p status_code # => 2xx
1590
- p headers # => { ... }
1591
- p data # => <NoteMessage>
1592
- rescue Buildium::ApiError => e
1593
- puts "Error when calling LeasesApi->get_lease_note_by_note_id_with_http_info: #{e}"
1594
- end
1595
- ```
1596
-
1597
- ### Parameters
1598
-
1599
- | Name | Type | Description | Notes |
1600
- | ---- | ---- | ----------- | ----- |
1601
- | **lease_id** | **Integer** | | |
1602
- | **note_id** | **Integer** | | |
1603
-
1604
- ### Return type
1605
-
1606
- [**NoteMessage**](NoteMessage.md)
1607
-
1608
- ### Authorization
1609
-
1610
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1611
-
1612
- ### HTTP request headers
1613
-
1614
- - **Content-Type**: Not defined
1615
- - **Accept**: application/json
1616
-
1617
-
1618
- ## get_lease_notes
1619
-
1620
- > <Array<NoteMessage>> get_lease_notes(lease_id, opts)
1621
-
1622
- Retrieve all notes
1623
-
1624
- Retrieves all lease notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1625
-
1626
- ### Examples
1627
-
1628
- ```ruby
1629
- require 'time'
1630
- require 'buildium-ruby'
1631
- # setup authorization
1632
- Buildium.configure do |config|
1633
- # Configure API key authorization: clientId
1634
- config.api_key['clientId'] = 'YOUR API KEY'
1635
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1636
- # config.api_key_prefix['clientId'] = 'Bearer'
1637
-
1638
- # Configure API key authorization: clientSecret
1639
- config.api_key['clientSecret'] = 'YOUR API KEY'
1640
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1641
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1642
- end
1643
-
1644
- api_instance = Buildium::LeasesApi.new
1645
- lease_id = 56 # Integer |
1646
- opts = {
1647
- updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
1648
- updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
1649
- lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
1650
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1651
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1652
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1653
- }
1654
-
1655
- begin
1656
- # Retrieve all notes
1657
- result = api_instance.get_lease_notes(lease_id, opts)
1658
- p result
1659
- rescue Buildium::ApiError => e
1660
- puts "Error when calling LeasesApi->get_lease_notes: #{e}"
1661
- end
1662
- ```
1663
-
1664
- #### Using the get_lease_notes_with_http_info variant
1665
-
1666
- This returns an Array which contains the response data, status code and headers.
1667
-
1668
- > <Array(<Array<NoteMessage>>, Integer, Hash)> get_lease_notes_with_http_info(lease_id, opts)
1669
-
1670
- ```ruby
1671
- begin
1672
- # Retrieve all notes
1673
- data, status_code, headers = api_instance.get_lease_notes_with_http_info(lease_id, opts)
1674
- p status_code # => 2xx
1675
- p headers # => { ... }
1676
- p data # => <Array<NoteMessage>>
1677
- rescue Buildium::ApiError => e
1678
- puts "Error when calling LeasesApi->get_lease_notes_with_http_info: #{e}"
1679
- end
1680
- ```
1681
-
1682
- ### Parameters
1683
-
1684
- | Name | Type | Description | Notes |
1685
- | ---- | ---- | ----------- | ----- |
1686
- | **lease_id** | **Integer** | | |
1687
- | **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
1688
- | **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
1689
- | **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
1690
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1691
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1692
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1693
-
1694
- ### Return type
1695
-
1696
- [**Array&lt;NoteMessage&gt;**](NoteMessage.md)
1697
-
1698
- ### Authorization
1699
-
1700
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1701
-
1702
- ### HTTP request headers
1703
-
1704
- - **Content-Type**: Not defined
1705
- - **Accept**: application/json
1706
-
1707
-
1708
- ## get_lease_outstanding_balances
1709
-
1710
- > <Array<LeaseOutstandingBalanceMessage>> get_lease_outstanding_balances(opts)
1711
-
1712
- Retrieve all outstanding balances
1713
-
1714
- Retrieves a list of lease outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Outstanding Balances</span> - `View`
1715
-
1716
- ### Examples
1717
-
1718
- ```ruby
1719
- require 'time'
1720
- require 'buildium-ruby'
1721
- # setup authorization
1722
- Buildium.configure do |config|
1723
- # Configure API key authorization: clientId
1724
- config.api_key['clientId'] = 'YOUR API KEY'
1725
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1726
- # config.api_key_prefix['clientId'] = 'Bearer'
1727
-
1728
- # Configure API key authorization: clientSecret
1729
- config.api_key['clientSecret'] = 'YOUR API KEY'
1730
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1731
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1732
- end
1733
-
1734
- api_instance = Buildium::LeasesApi.new
1735
- opts = {
1736
- entitytype: 'Rental', # String |
1737
- entityid: 56, # Integer |
1738
- leasestatuses: ['Active'], # Array<String> |
1739
- leaseids: [37], # Array<Integer> |
1740
- pastdueemail: 'NoEmailAddress', # String |
1741
- balanceduration: 'TotalBalance', # String |
1742
- evictionstatus: 'NotEvictionPending', # String |
1743
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1744
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1745
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1746
- }
1747
-
1748
- begin
1749
- # Retrieve all outstanding balances
1750
- result = api_instance.get_lease_outstanding_balances(opts)
1751
- p result
1752
- rescue Buildium::ApiError => e
1753
- puts "Error when calling LeasesApi->get_lease_outstanding_balances: #{e}"
1754
- end
1755
- ```
1756
-
1757
- #### Using the get_lease_outstanding_balances_with_http_info variant
1758
-
1759
- This returns an Array which contains the response data, status code and headers.
1760
-
1761
- > <Array(<Array<LeaseOutstandingBalanceMessage>>, Integer, Hash)> get_lease_outstanding_balances_with_http_info(opts)
1762
-
1763
- ```ruby
1764
- begin
1765
- # Retrieve all outstanding balances
1766
- data, status_code, headers = api_instance.get_lease_outstanding_balances_with_http_info(opts)
1767
- p status_code # => 2xx
1768
- p headers # => { ... }
1769
- p data # => <Array<LeaseOutstandingBalanceMessage>>
1770
- rescue Buildium::ApiError => e
1771
- puts "Error when calling LeasesApi->get_lease_outstanding_balances_with_http_info: #{e}"
1772
- end
1773
- ```
1774
-
1775
- ### Parameters
1776
-
1777
- | Name | Type | Description | Notes |
1778
- | ---- | ---- | ----------- | ----- |
1779
- | **entitytype** | **String** | | [optional] |
1780
- | **entityid** | **Integer** | | [optional] |
1781
- | **leasestatuses** | [**Array&lt;String&gt;**](String.md) | | [optional] |
1782
- | **leaseids** | [**Array&lt;Integer&gt;**](Integer.md) | | [optional] |
1783
- | **pastdueemail** | **String** | | [optional] |
1784
- | **balanceduration** | **String** | | [optional] |
1785
- | **evictionstatus** | **String** | | [optional] |
1786
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1787
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1788
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1789
-
1790
- ### Return type
1791
-
1792
- [**Array&lt;LeaseOutstandingBalanceMessage&gt;**](LeaseOutstandingBalanceMessage.md)
1793
-
1794
- ### Authorization
1795
-
1796
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1797
-
1798
- ### HTTP request headers
1799
-
1800
- - **Content-Type**: Not defined
1801
- - **Accept**: application/json
1802
-
1803
-
1804
- ## get_lease_recurring_credit_by_id
1805
-
1806
- > <LeaseRecurringCreditMessage> get_lease_recurring_credit_by_id(lease_id, transaction_id)
1807
-
1808
- Retrieve a recurring credit
1809
-
1810
- Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1811
-
1812
- ### Examples
1813
-
1814
- ```ruby
1815
- require 'time'
1816
- require 'buildium-ruby'
1817
- # setup authorization
1818
- Buildium.configure do |config|
1819
- # Configure API key authorization: clientId
1820
- config.api_key['clientId'] = 'YOUR API KEY'
1821
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1822
- # config.api_key_prefix['clientId'] = 'Bearer'
1823
-
1824
- # Configure API key authorization: clientSecret
1825
- config.api_key['clientSecret'] = 'YOUR API KEY'
1826
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1827
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1828
- end
1829
-
1830
- api_instance = Buildium::LeasesApi.new
1831
- lease_id = 56 # Integer |
1832
- transaction_id = 56 # Integer |
1833
-
1834
- begin
1835
- # Retrieve a recurring credit
1836
- result = api_instance.get_lease_recurring_credit_by_id(lease_id, transaction_id)
1837
- p result
1838
- rescue Buildium::ApiError => e
1839
- puts "Error when calling LeasesApi->get_lease_recurring_credit_by_id: #{e}"
1840
- end
1841
- ```
1842
-
1843
- #### Using the get_lease_recurring_credit_by_id_with_http_info variant
1844
-
1845
- This returns an Array which contains the response data, status code and headers.
1846
-
1847
- > <Array(<LeaseRecurringCreditMessage>, Integer, Hash)> get_lease_recurring_credit_by_id_with_http_info(lease_id, transaction_id)
1848
-
1849
- ```ruby
1850
- begin
1851
- # Retrieve a recurring credit
1852
- data, status_code, headers = api_instance.get_lease_recurring_credit_by_id_with_http_info(lease_id, transaction_id)
1853
- p status_code # => 2xx
1854
- p headers # => { ... }
1855
- p data # => <LeaseRecurringCreditMessage>
1856
- rescue Buildium::ApiError => e
1857
- puts "Error when calling LeasesApi->get_lease_recurring_credit_by_id_with_http_info: #{e}"
1858
- end
1859
- ```
1860
-
1861
- ### Parameters
1862
-
1863
- | Name | Type | Description | Notes |
1864
- | ---- | ---- | ----------- | ----- |
1865
- | **lease_id** | **Integer** | | |
1866
- | **transaction_id** | **Integer** | | |
1867
-
1868
- ### Return type
1869
-
1870
- [**LeaseRecurringCreditMessage**](LeaseRecurringCreditMessage.md)
1871
-
1872
- ### Authorization
1873
-
1874
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1875
-
1876
- ### HTTP request headers
1877
-
1878
- - **Content-Type**: Not defined
1879
- - **Accept**: application/json
1880
-
1881
-
1882
- ## get_lease_recurring_transactions
1883
-
1884
- > <Array<RecurringTransactionMessage>> get_lease_recurring_transactions(lease_id, opts)
1885
-
1886
- Retrieve all recurring transactions
1887
-
1888
- Retrieves all recurring transactions. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1889
-
1890
- ### Examples
1891
-
1892
- ```ruby
1893
- require 'time'
1894
- require 'buildium-ruby'
1895
- # setup authorization
1896
- Buildium.configure do |config|
1897
- # Configure API key authorization: clientId
1898
- config.api_key['clientId'] = 'YOUR API KEY'
1899
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1900
- # config.api_key_prefix['clientId'] = 'Bearer'
1901
-
1902
- # Configure API key authorization: clientSecret
1903
- config.api_key['clientSecret'] = 'YOUR API KEY'
1904
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1905
- # config.api_key_prefix['clientSecret'] = 'Bearer'
1906
- end
1907
-
1908
- api_instance = Buildium::LeasesApi.new
1909
- lease_id = 56 # Integer |
1910
- opts = {
1911
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1912
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1913
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1914
- }
1915
-
1916
- begin
1917
- # Retrieve all recurring transactions
1918
- result = api_instance.get_lease_recurring_transactions(lease_id, opts)
1919
- p result
1920
- rescue Buildium::ApiError => e
1921
- puts "Error when calling LeasesApi->get_lease_recurring_transactions: #{e}"
1922
- end
1923
- ```
1924
-
1925
- #### Using the get_lease_recurring_transactions_with_http_info variant
1926
-
1927
- This returns an Array which contains the response data, status code and headers.
1928
-
1929
- > <Array(<Array<RecurringTransactionMessage>>, Integer, Hash)> get_lease_recurring_transactions_with_http_info(lease_id, opts)
1930
-
1931
- ```ruby
1932
- begin
1933
- # Retrieve all recurring transactions
1934
- data, status_code, headers = api_instance.get_lease_recurring_transactions_with_http_info(lease_id, opts)
1935
- p status_code # => 2xx
1936
- p headers # => { ... }
1937
- p data # => <Array<RecurringTransactionMessage>>
1938
- rescue Buildium::ApiError => e
1939
- puts "Error when calling LeasesApi->get_lease_recurring_transactions_with_http_info: #{e}"
1940
- end
1941
- ```
1942
-
1943
- ### Parameters
1944
-
1945
- | Name | Type | Description | Notes |
1946
- | ---- | ---- | ----------- | ----- |
1947
- | **lease_id** | **Integer** | | |
1948
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1949
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1950
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1951
-
1952
- ### Return type
1953
-
1954
- [**Array&lt;RecurringTransactionMessage&gt;**](RecurringTransactionMessage.md)
1955
-
1956
- ### Authorization
1957
-
1958
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1959
-
1960
- ### HTTP request headers
1961
-
1962
- - **Content-Type**: Not defined
1963
- - **Accept**: application/json
1964
-
1965
-
1966
- ## get_leases
1967
-
1968
- > <Array<LeaseMessage>> get_leases(opts)
1969
-
1970
- Retrieve all leases
1971
-
1972
- Retrieves a list of leases. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1079
+ Retrieves a list of leases. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1973
1080
 
1974
1081
  ### Examples
1975
1082
 
@@ -2069,84 +1176,6 @@ end
2069
1176
  - **Accept**: application/json
2070
1177
 
2071
1178
 
2072
- ## get_recurring_lease_payments_by_id
2073
-
2074
- > <LeaseRecurringPaymentMessage> get_recurring_lease_payments_by_id(lease_id, payment_id)
2075
-
2076
- Retrieve a recurring payment
2077
-
2078
- Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Transactions</span> - `View`
2079
-
2080
- ### Examples
2081
-
2082
- ```ruby
2083
- require 'time'
2084
- require 'buildium-ruby'
2085
- # setup authorization
2086
- Buildium.configure do |config|
2087
- # Configure API key authorization: clientId
2088
- config.api_key['clientId'] = 'YOUR API KEY'
2089
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2090
- # config.api_key_prefix['clientId'] = 'Bearer'
2091
-
2092
- # Configure API key authorization: clientSecret
2093
- config.api_key['clientSecret'] = 'YOUR API KEY'
2094
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2095
- # config.api_key_prefix['clientSecret'] = 'Bearer'
2096
- end
2097
-
2098
- api_instance = Buildium::LeasesApi.new
2099
- lease_id = 56 # Integer |
2100
- payment_id = 56 # Integer |
2101
-
2102
- begin
2103
- # Retrieve a recurring payment
2104
- result = api_instance.get_recurring_lease_payments_by_id(lease_id, payment_id)
2105
- p result
2106
- rescue Buildium::ApiError => e
2107
- puts "Error when calling LeasesApi->get_recurring_lease_payments_by_id: #{e}"
2108
- end
2109
- ```
2110
-
2111
- #### Using the get_recurring_lease_payments_by_id_with_http_info variant
2112
-
2113
- This returns an Array which contains the response data, status code and headers.
2114
-
2115
- > <Array(<LeaseRecurringPaymentMessage>, Integer, Hash)> get_recurring_lease_payments_by_id_with_http_info(lease_id, payment_id)
2116
-
2117
- ```ruby
2118
- begin
2119
- # Retrieve a recurring payment
2120
- data, status_code, headers = api_instance.get_recurring_lease_payments_by_id_with_http_info(lease_id, payment_id)
2121
- p status_code # => 2xx
2122
- p headers # => { ... }
2123
- p data # => <LeaseRecurringPaymentMessage>
2124
- rescue Buildium::ApiError => e
2125
- puts "Error when calling LeasesApi->get_recurring_lease_payments_by_id_with_http_info: #{e}"
2126
- end
2127
- ```
2128
-
2129
- ### Parameters
2130
-
2131
- | Name | Type | Description | Notes |
2132
- | ---- | ---- | ----------- | ----- |
2133
- | **lease_id** | **Integer** | | |
2134
- | **payment_id** | **Integer** | | |
2135
-
2136
- ### Return type
2137
-
2138
- [**LeaseRecurringPaymentMessage**](LeaseRecurringPaymentMessage.md)
2139
-
2140
- ### Authorization
2141
-
2142
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2143
-
2144
- ### HTTP request headers
2145
-
2146
- - **Content-Type**: Not defined
2147
- - **Accept**: application/json
2148
-
2149
-
2150
1179
  ## get_rent
2151
1180
 
2152
1181
  > <Array<LeaseRentMessage>> get_rent(lease_id, opts)
@@ -2309,13 +1338,13 @@ end
2309
1338
  - **Accept**: application/json
2310
1339
 
2311
1340
 
2312
- ## lease_renewals_external_api_read_get_all_lease_renewals
1341
+ ## get_renters_insurance_policies
2313
1342
 
2314
- > <Array<LeaseRenewalMessage>> lease_renewals_external_api_read_get_all_lease_renewals(lease_id, opts)
1343
+ > <Array<RentersInsurancePolicyMessage>> get_renters_insurance_policies(lease_id, opts)
2315
1344
 
2316
- Retrieve all lease renewals
1345
+ Retrieve all insurance policies
2317
1346
 
2318
- Retrieves all lease renewals. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1347
+ Retrieves all renters insurance policies for a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
2319
1348
 
2320
1349
  ### Examples
2321
1350
 
@@ -2344,29 +1373,29 @@ opts = {
2344
1373
  }
2345
1374
 
2346
1375
  begin
2347
- # Retrieve all lease renewals
2348
- result = api_instance.lease_renewals_external_api_read_get_all_lease_renewals(lease_id, opts)
1376
+ # Retrieve all insurance policies
1377
+ result = api_instance.get_renters_insurance_policies(lease_id, opts)
2349
1378
  p result
2350
1379
  rescue Buildium::ApiError => e
2351
- puts "Error when calling LeasesApi->lease_renewals_external_api_read_get_all_lease_renewals: #{e}"
1380
+ puts "Error when calling LeasesApi->get_renters_insurance_policies: #{e}"
2352
1381
  end
2353
1382
  ```
2354
1383
 
2355
- #### Using the lease_renewals_external_api_read_get_all_lease_renewals_with_http_info variant
1384
+ #### Using the get_renters_insurance_policies_with_http_info variant
2356
1385
 
2357
1386
  This returns an Array which contains the response data, status code and headers.
2358
1387
 
2359
- > <Array(<Array<LeaseRenewalMessage>>, Integer, Hash)> lease_renewals_external_api_read_get_all_lease_renewals_with_http_info(lease_id, opts)
1388
+ > <Array(<Array<RentersInsurancePolicyMessage>>, Integer, Hash)> get_renters_insurance_policies_with_http_info(lease_id, opts)
2360
1389
 
2361
1390
  ```ruby
2362
1391
  begin
2363
- # Retrieve all lease renewals
2364
- data, status_code, headers = api_instance.lease_renewals_external_api_read_get_all_lease_renewals_with_http_info(lease_id, opts)
1392
+ # Retrieve all insurance policies
1393
+ data, status_code, headers = api_instance.get_renters_insurance_policies_with_http_info(lease_id, opts)
2365
1394
  p status_code # => 2xx
2366
1395
  p headers # => { ... }
2367
- p data # => <Array<LeaseRenewalMessage>>
1396
+ p data # => <Array<RentersInsurancePolicyMessage>>
2368
1397
  rescue Buildium::ApiError => e
2369
- puts "Error when calling LeasesApi->lease_renewals_external_api_read_get_all_lease_renewals_with_http_info: #{e}"
1398
+ puts "Error when calling LeasesApi->get_renters_insurance_policies_with_http_info: #{e}"
2370
1399
  end
2371
1400
  ```
2372
1401
 
@@ -2381,7 +1410,7 @@ end
2381
1410
 
2382
1411
  ### Return type
2383
1412
 
2384
- [**Array&lt;LeaseRenewalMessage&gt;**](LeaseRenewalMessage.md)
1413
+ [**Array&lt;RentersInsurancePolicyMessage&gt;**](RentersInsurancePolicyMessage.md)
2385
1414
 
2386
1415
  ### Authorization
2387
1416
 
@@ -2393,13 +1422,13 @@ end
2393
1422
  - **Accept**: application/json
2394
1423
 
2395
1424
 
2396
- ## lease_renewals_external_api_read_get_lease_renewal_by_id
1425
+ ## get_renters_insurance_policy_by_id
2397
1426
 
2398
- > <LeaseRenewalMessage> lease_renewals_external_api_read_get_lease_renewal_by_id(lease_id, renewal_id)
1427
+ > <RentersInsurancePolicyMessage> get_renters_insurance_policy_by_id(lease_id, policy_id)
2399
1428
 
2400
- Retrieve a lease renewal
1429
+ Retrieve an insurance policy
2401
1430
 
2402
- Retrieves a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1431
+ Retrieves a renters insurance policy. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
2403
1432
 
2404
1433
  ### Examples
2405
1434
 
@@ -2421,32 +1450,32 @@ end
2421
1450
 
2422
1451
  api_instance = Buildium::LeasesApi.new
2423
1452
  lease_id = 56 # Integer |
2424
- renewal_id = 56 # Integer |
1453
+ policy_id = 56 # Integer |
2425
1454
 
2426
1455
  begin
2427
- # Retrieve a lease renewal
2428
- result = api_instance.lease_renewals_external_api_read_get_lease_renewal_by_id(lease_id, renewal_id)
1456
+ # Retrieve an insurance policy
1457
+ result = api_instance.get_renters_insurance_policy_by_id(lease_id, policy_id)
2429
1458
  p result
2430
1459
  rescue Buildium::ApiError => e
2431
- puts "Error when calling LeasesApi->lease_renewals_external_api_read_get_lease_renewal_by_id: #{e}"
1460
+ puts "Error when calling LeasesApi->get_renters_insurance_policy_by_id: #{e}"
2432
1461
  end
2433
1462
  ```
2434
1463
 
2435
- #### Using the lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info variant
1464
+ #### Using the get_renters_insurance_policy_by_id_with_http_info variant
2436
1465
 
2437
1466
  This returns an Array which contains the response data, status code and headers.
2438
1467
 
2439
- > <Array(<LeaseRenewalMessage>, Integer, Hash)> lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info(lease_id, renewal_id)
1468
+ > <Array(<RentersInsurancePolicyMessage>, Integer, Hash)> get_renters_insurance_policy_by_id_with_http_info(lease_id, policy_id)
2440
1469
 
2441
1470
  ```ruby
2442
1471
  begin
2443
- # Retrieve a lease renewal
2444
- data, status_code, headers = api_instance.lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info(lease_id, renewal_id)
1472
+ # Retrieve an insurance policy
1473
+ data, status_code, headers = api_instance.get_renters_insurance_policy_by_id_with_http_info(lease_id, policy_id)
2445
1474
  p status_code # => 2xx
2446
1475
  p headers # => { ... }
2447
- p data # => <LeaseRenewalMessage>
1476
+ p data # => <RentersInsurancePolicyMessage>
2448
1477
  rescue Buildium::ApiError => e
2449
- puts "Error when calling LeasesApi->lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info: #{e}"
1478
+ puts "Error when calling LeasesApi->get_renters_insurance_policy_by_id_with_http_info: #{e}"
2450
1479
  end
2451
1480
  ```
2452
1481
 
@@ -2455,11 +1484,11 @@ end
2455
1484
  | Name | Type | Description | Notes |
2456
1485
  | ---- | ---- | ----------- | ----- |
2457
1486
  | **lease_id** | **Integer** | | |
2458
- | **renewal_id** | **Integer** | | |
1487
+ | **policy_id** | **Integer** | | |
2459
1488
 
2460
1489
  ### Return type
2461
1490
 
2462
- [**LeaseRenewalMessage**](LeaseRenewalMessage.md)
1491
+ [**RentersInsurancePolicyMessage**](RentersInsurancePolicyMessage.md)
2463
1492
 
2464
1493
  ### Authorization
2465
1494
 
@@ -2471,84 +1500,6 @@ end
2471
1500
  - **Accept**: application/json
2472
1501
 
2473
1502
 
2474
- ## lease_renewals_external_api_write_create_lease_renewal
2475
-
2476
- > <LeaseRenewalMessage> lease_renewals_external_api_write_create_lease_renewal(lease_id, lease_renewal_post_message)
2477
-
2478
- Create a lease renewal
2479
-
2480
- Creates a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
2481
-
2482
- ### Examples
2483
-
2484
- ```ruby
2485
- require 'time'
2486
- require 'buildium-ruby'
2487
- # setup authorization
2488
- Buildium.configure do |config|
2489
- # Configure API key authorization: clientId
2490
- config.api_key['clientId'] = 'YOUR API KEY'
2491
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2492
- # config.api_key_prefix['clientId'] = 'Bearer'
2493
-
2494
- # Configure API key authorization: clientSecret
2495
- config.api_key['clientSecret'] = 'YOUR API KEY'
2496
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2497
- # config.api_key_prefix['clientSecret'] = 'Bearer'
2498
- end
2499
-
2500
- api_instance = Buildium::LeasesApi.new
2501
- lease_id = 56 # Integer |
2502
- lease_renewal_post_message = Buildium::LeaseRenewalPostMessage.new({lease_type: 'Fixed', rent: Buildium::LeaseRentPostMessage.new({cycle: 'Monthly', charges: [Buildium::LeaseRentChargePostMessage.new({amount: 3.56, gl_account_id: 37, next_due_date: Date.today})]}), send_welcome_email: false}) # LeaseRenewalPostMessage |
2503
-
2504
- begin
2505
- # Create a lease renewal
2506
- result = api_instance.lease_renewals_external_api_write_create_lease_renewal(lease_id, lease_renewal_post_message)
2507
- p result
2508
- rescue Buildium::ApiError => e
2509
- puts "Error when calling LeasesApi->lease_renewals_external_api_write_create_lease_renewal: #{e}"
2510
- end
2511
- ```
2512
-
2513
- #### Using the lease_renewals_external_api_write_create_lease_renewal_with_http_info variant
2514
-
2515
- This returns an Array which contains the response data, status code and headers.
2516
-
2517
- > <Array(<LeaseRenewalMessage>, Integer, Hash)> lease_renewals_external_api_write_create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message)
2518
-
2519
- ```ruby
2520
- begin
2521
- # Create a lease renewal
2522
- data, status_code, headers = api_instance.lease_renewals_external_api_write_create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message)
2523
- p status_code # => 2xx
2524
- p headers # => { ... }
2525
- p data # => <LeaseRenewalMessage>
2526
- rescue Buildium::ApiError => e
2527
- puts "Error when calling LeasesApi->lease_renewals_external_api_write_create_lease_renewal_with_http_info: #{e}"
2528
- end
2529
- ```
2530
-
2531
- ### Parameters
2532
-
2533
- | Name | Type | Description | Notes |
2534
- | ---- | ---- | ----------- | ----- |
2535
- | **lease_id** | **Integer** | | |
2536
- | **lease_renewal_post_message** | [**LeaseRenewalPostMessage**](LeaseRenewalPostMessage.md) | | |
2537
-
2538
- ### Return type
2539
-
2540
- [**LeaseRenewalMessage**](LeaseRenewalMessage.md)
2541
-
2542
- ### Authorization
2543
-
2544
- [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2545
-
2546
- ### HTTP request headers
2547
-
2548
- - **Content-Type**: application/json
2549
- - **Accept**: application/json
2550
-
2551
-
2552
1503
  ## undo_tenant_moveout
2553
1504
 
2554
1505
  > undo_tenant_moveout(lease_id, tenant_id)
@@ -2704,13 +1655,13 @@ end
2704
1655
  - **Accept**: application/json
2705
1656
 
2706
1657
 
2707
- ## update_lease_charge
1658
+ ## update_lease_epay_settings
2708
1659
 
2709
- > <LeaseTransactionMessage> update_lease_charge(lease_id, charge_id, lease_charge_put_message)
1660
+ > <EPaySettingsMessage> update_lease_epay_settings(lease_id, e_pay_settings_put_message)
2710
1661
 
2711
- Update a charge
1662
+ Update ePay settings
2712
1663
 
2713
- Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
1664
+ Updates ePay settings for a lease <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
2714
1665
 
2715
1666
  ### Examples
2716
1667
 
@@ -2732,33 +1683,32 @@ end
2732
1683
 
2733
1684
  api_instance = Buildium::LeasesApi.new
2734
1685
  lease_id = 56 # Integer |
2735
- charge_id = 56 # Integer |
2736
- lease_charge_put_message = Buildium::LeaseChargePutMessage.new({date: Date.today, lines: [Buildium::LeaseChargeLineSaveMessage.new({amount: 3.56, gl_account_id: 37})]}) # LeaseChargePutMessage |
1686
+ e_pay_settings_put_message = Buildium::EPaySettingsPutMessage.new({eft_payments: Buildium::EFTPaymentsPutMessage.new({payments_enabled: false}), credit_card_payments: Buildium::CCPaymentsPutMessage.new({payments_enabled: false}), offline_payments: Buildium::OfflinePaymentsPutMessage.new({display_info_in_resident_center: false, display_company_address: false})}) # EPaySettingsPutMessage |
2737
1687
 
2738
1688
  begin
2739
- # Update a charge
2740
- result = api_instance.update_lease_charge(lease_id, charge_id, lease_charge_put_message)
1689
+ # Update ePay settings
1690
+ result = api_instance.update_lease_epay_settings(lease_id, e_pay_settings_put_message)
2741
1691
  p result
2742
1692
  rescue Buildium::ApiError => e
2743
- puts "Error when calling LeasesApi->update_lease_charge: #{e}"
1693
+ puts "Error when calling LeasesApi->update_lease_epay_settings: #{e}"
2744
1694
  end
2745
1695
  ```
2746
1696
 
2747
- #### Using the update_lease_charge_with_http_info variant
1697
+ #### Using the update_lease_epay_settings_with_http_info variant
2748
1698
 
2749
1699
  This returns an Array which contains the response data, status code and headers.
2750
1700
 
2751
- > <Array(<LeaseTransactionMessage>, Integer, Hash)> update_lease_charge_with_http_info(lease_id, charge_id, lease_charge_put_message)
1701
+ > <Array(<EPaySettingsMessage>, Integer, Hash)> update_lease_epay_settings_with_http_info(lease_id, e_pay_settings_put_message)
2752
1702
 
2753
1703
  ```ruby
2754
1704
  begin
2755
- # Update a charge
2756
- data, status_code, headers = api_instance.update_lease_charge_with_http_info(lease_id, charge_id, lease_charge_put_message)
1705
+ # Update ePay settings
1706
+ data, status_code, headers = api_instance.update_lease_epay_settings_with_http_info(lease_id, e_pay_settings_put_message)
2757
1707
  p status_code # => 2xx
2758
1708
  p headers # => { ... }
2759
- p data # => <LeaseTransactionMessage>
1709
+ p data # => <EPaySettingsMessage>
2760
1710
  rescue Buildium::ApiError => e
2761
- puts "Error when calling LeasesApi->update_lease_charge_with_http_info: #{e}"
1711
+ puts "Error when calling LeasesApi->update_lease_epay_settings_with_http_info: #{e}"
2762
1712
  end
2763
1713
  ```
2764
1714
 
@@ -2767,12 +1717,11 @@ end
2767
1717
  | Name | Type | Description | Notes |
2768
1718
  | ---- | ---- | ----------- | ----- |
2769
1719
  | **lease_id** | **Integer** | | |
2770
- | **charge_id** | **Integer** | | |
2771
- | **lease_charge_put_message** | [**LeaseChargePutMessage**](LeaseChargePutMessage.md) | | |
1720
+ | **e_pay_settings_put_message** | [**EPaySettingsPutMessage**](EPaySettingsPutMessage.md) | | |
2772
1721
 
2773
1722
  ### Return type
2774
1723
 
2775
- [**LeaseTransactionMessage**](LeaseTransactionMessage.md)
1724
+ [**EPaySettingsMessage**](EPaySettingsMessage.md)
2776
1725
 
2777
1726
  ### Authorization
2778
1727