buildium-ruby 2.0.1 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1060) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +1 -3
  3. data/.github/workflows/publish.yml +2 -2
  4. data/.openapi-generator/FILES +200 -405
  5. data/.openapi-generator/templates/ruby-client/Gemfile.mustache +3 -0
  6. data/.openapi-generator/templates/ruby-client/gemspec.mustache +1 -3
  7. data/.openapi-generator/templates/ruby-client/rubocop.mustache +1 -1
  8. data/.rubocop.yml +1 -1
  9. data/.tool-versions +1 -0
  10. data/CUSTOMIZATIONS.md +4 -0
  11. data/DOCS.md +404 -112
  12. data/Gemfile +1 -7
  13. data/Gemfile.lock +9 -54
  14. data/README.md +2 -2
  15. data/bin/CUSTOMIZATIONS.md +4 -0
  16. data/bin/README.md +2 -2
  17. data/bin/config.yml +5 -2
  18. data/bin/rebuild.sh +15 -9
  19. data/bin/swagger.json +17251 -8723
  20. data/buildium-ruby.gemspec +2 -4
  21. data/docs/AccountingEntityMessage.md +3 -1
  22. data/docs/AccountingEntitySaveMessage.md +3 -1
  23. data/docs/{AssociationAppliancesApi.md → AppliancesApi.md} +41 -41
  24. data/docs/ApplicantMessage.md +2 -0
  25. data/docs/AppliedVendorCreditMessage.md +20 -0
  26. data/docs/AssociationMessage.md +3 -1
  27. data/docs/AssociationMeterReadingsApi.md +344 -0
  28. data/docs/AssociationOwnershipAccountSearchMessage.md +2 -0
  29. data/docs/AssociationPostMessage.md +3 -1
  30. data/docs/AssociationSearchMessage.md +5 -1
  31. data/docs/AssociationTaxInformationMessage.md +26 -0
  32. data/docs/AssociationsApi.md +204 -217
  33. data/docs/BankAccountCheckAccountingEntitySaveMessage.md +3 -1
  34. data/docs/BankAccountCheckFileMessage.md +28 -0
  35. data/docs/BankAccountDepositPostMessage.md +1 -1
  36. data/docs/BankAccountMessage.md +3 -1
  37. data/docs/BankAccountSearchMessage.md +3 -1
  38. data/docs/BankAccountTransferAccountingEntitySaveMessage.md +3 -1
  39. data/docs/BankAccountsApi.md +412 -0
  40. data/docs/BankLockboxDataAssociationMessage.md +22 -0
  41. data/docs/BankLockboxDataAssociationOwnerMessage.md +30 -0
  42. data/docs/BankLockboxDataMessage.md +20 -0
  43. data/docs/BankLockboxDataOwnershipAccountMessage.md +26 -0
  44. data/docs/BankLockboxDataSearchMessage.md +18 -0
  45. data/docs/BillPaymentAccountingEntityMessage.md +3 -1
  46. data/docs/BillPaymentMessage.md +4 -0
  47. data/docs/BillsApi.md +1059 -0
  48. data/docs/BoardMembersApi.md +417 -0
  49. data/docs/BudgetsApi.md +329 -0
  50. data/docs/CCPaymentsMessage.md +18 -0
  51. data/docs/CCPaymentsPutMessage.md +18 -0
  52. data/docs/CancellationToken.md +22 -0
  53. data/docs/CommunicationsApi.md +39 -39
  54. data/docs/ContactRequestsApi.md +347 -0
  55. data/docs/EFTPaymentsMessage.md +18 -0
  56. data/docs/EFTPaymentsPutMessage.md +18 -0
  57. data/docs/EPaySettingsMessage.md +22 -0
  58. data/docs/EPaySettingsPutMessage.md +22 -0
  59. data/docs/FileSharingAccountMessage.md +26 -0
  60. data/docs/FileSharingAccountPutMessage.md +26 -0
  61. data/docs/FileSharingAssociationMessage.md +20 -0
  62. data/docs/FileSharingAssociationOwnerMessage.md +18 -0
  63. data/docs/FileSharingAssociationOwnerPutMessage.md +18 -0
  64. data/docs/FileSharingAssociationPutMessage.md +20 -0
  65. data/docs/FileSharingAssociationUnitMessage.md +20 -0
  66. data/docs/FileSharingAssociationUnitPutMessage.md +20 -0
  67. data/docs/FileSharingCommitteeMessage.md +22 -0
  68. data/docs/FileSharingCommitteePutMessage.md +22 -0
  69. data/docs/FileSharingLeaseMessage.md +20 -0
  70. data/docs/FileSharingLeasePutMessage.md +20 -0
  71. data/docs/FileSharingMessage.md +40 -0
  72. data/docs/FileSharingOwnershipAccountMessage.md +20 -0
  73. data/docs/FileSharingOwnershipAccountPutMessage.md +20 -0
  74. data/docs/FileSharingPutMessage.md +40 -0
  75. data/docs/FileSharingRentalMessage.md +20 -0
  76. data/docs/FileSharingRentalOwnerMessage.md +18 -0
  77. data/docs/FileSharingRentalOwnerPutMessage.md +18 -0
  78. data/docs/FileSharingRentalPutMessage.md +20 -0
  79. data/docs/FileSharingRentalUnitMesage.md +20 -0
  80. data/docs/FileSharingRentalUnitPutMesage.md +20 -0
  81. data/docs/FileSharingTenantMessage.md +20 -0
  82. data/docs/FileSharingTenantPutMessage.md +20 -0
  83. data/docs/FileSharingVendorMessage.md +18 -0
  84. data/docs/FileSharingVendorPutMessage.md +18 -0
  85. data/docs/FilesApi.md +159 -3
  86. data/docs/GeneralJournalEntryLineSaveMessage.md +1 -1
  87. data/docs/GeneralLedgerApi.md +839 -0
  88. data/docs/GeneralLedgerEntryMessage.md +30 -0
  89. data/docs/GeneralLedgerMessage.md +26 -0
  90. data/docs/GeneralLedgerSearchMessage.md +28 -0
  91. data/docs/ImageReorderRequestPutMessage.md +18 -0
  92. data/docs/InsuredTenantMessage.md +24 -0
  93. data/docs/JournalLineMessage.md +3 -1
  94. data/docs/JsonPatchOperation.md +24 -0
  95. data/docs/LeaseAutoAllocatedPaymentPostMessage.md +30 -0
  96. data/docs/LeaseLedgerPaymentPutMessage.md +28 -0
  97. data/docs/LeasePostMessage.md +5 -1
  98. data/docs/LeaseRenewalSearchMessage.md +22 -0
  99. data/docs/LeaseRentMessage.md +1 -1
  100. data/docs/LeaseTenantMessage.md +3 -1
  101. data/docs/LeaseTransactionMessage.md +3 -1
  102. data/docs/LeaseTransactionsApi.md +1627 -0
  103. data/docs/LeasesApi.md +302 -1353
  104. data/docs/ListingEntityFilePostMessage.md +22 -0
  105. data/docs/ListingsApi.md +5 -5
  106. data/docs/MeterReadingDetailMessage.md +28 -0
  107. data/docs/MeterReadingDetailPutMessage.md +24 -0
  108. data/docs/MeterReadingDetailsDeleteSearchMessage.md +20 -0
  109. data/docs/MeterReadingDetailsMessage.md +22 -0
  110. data/docs/MeterReadingDetailsPutMessage.md +22 -0
  111. data/docs/MeterReadingDetailsPutSearchMessage.md +20 -0
  112. data/docs/MeterReadingDetailsSearchMessage.md +20 -0
  113. data/docs/MeterReadingMessage.md +26 -0
  114. data/docs/MeterReadingSearchMessage.md +22 -0
  115. data/docs/MultipleBillPaymentsPostMessage.md +26 -0
  116. data/docs/OfflinePaymentsMessage.md +22 -0
  117. data/docs/OfflinePaymentsPutMessage.md +22 -0
  118. data/docs/OwnershipAccountAutoAllocatedPaymentPostMessage.md +30 -0
  119. data/docs/OwnershipAccountLedgerPaymentPutMessage.md +28 -0
  120. data/docs/OwnershipAccountTransactionMessage.md +2 -0
  121. data/docs/{AssociationOwnershipAccountsApi.md → OwnershipAccountTransactionsApi.md} +146 -644
  122. data/docs/OwnershipAccountsApi.md +667 -0
  123. data/docs/PropertyGroupsApi.md +1 -1
  124. data/docs/RentalImageMessage.md +26 -0
  125. data/docs/RentalImagePutMessage.md +20 -0
  126. data/docs/RentalMeterReadingsApi.md +344 -0
  127. data/docs/RentalOwnerContributionDataMessage.md +20 -0
  128. data/docs/RentalOwnerContributionDataPutMessage.md +20 -0
  129. data/docs/RentalOwnerContributionMessage.md +20 -0
  130. data/docs/RentalOwnerContributionPutMessage.md +20 -0
  131. data/docs/RentalOwnerContributionReminderMessage.md +20 -0
  132. data/docs/RentalOwnerContributionReminderPutMessage.md +20 -0
  133. data/docs/RentalOwnerRequestsApi.md +503 -0
  134. data/docs/RentalPropertiesApi.md +1123 -176
  135. data/docs/RentalPropertyPostMessage.md +1 -1
  136. data/docs/RentalUnitImageMessage.md +26 -0
  137. data/docs/RentalUnitImagePutMessage.md +20 -0
  138. data/docs/RentalUnitMessage.md +2 -2
  139. data/docs/RentalUnitsApi.md +639 -0
  140. data/docs/RentersInsurancePolicyMessage.md +32 -0
  141. data/docs/ResidentCenterApi.md +255 -0
  142. data/docs/ResidentRequestTaskPostMessage.md +5 -1
  143. data/docs/ResidentRequestsApi.md +349 -0
  144. data/docs/RetailCashPropertyMessage.md +24 -0
  145. data/docs/RetailCashUnitMessage.md +22 -0
  146. data/docs/RetailCashUserDataMessage.md +30 -0
  147. data/docs/RetailCashUserMessage.md +30 -0
  148. data/docs/RetailCashUserPutMessage.md +18 -0
  149. data/docs/RetailCashUsersSearchMessage.md +28 -0
  150. data/docs/SafeWaitHandle.md +20 -0
  151. data/docs/TasksApi.md +230 -1592
  152. data/docs/ToDoRequestsApi.md +347 -0
  153. data/docs/UnitEntityMessage.md +20 -0
  154. data/docs/VendorsApi.md +1 -1
  155. data/docs/VideoLinkRequestPostMessage.md +20 -0
  156. data/docs/WaitHandle.md +20 -0
  157. data/lib/buildium-ruby/api/administration_api.rb +1 -1
  158. data/lib/buildium-ruby/api/{association_appliances_api.rb → appliances_api.rb} +52 -52
  159. data/lib/buildium-ruby/api/applicants_api.rb +1 -1
  160. data/lib/buildium-ruby/api/association_meter_readings_api.rb +363 -0
  161. data/lib/buildium-ruby/api/association_owners_api.rb +1 -1
  162. data/lib/buildium-ruby/api/association_tenants_api.rb +1 -1
  163. data/lib/buildium-ruby/api/association_units_api.rb +1 -1
  164. data/lib/buildium-ruby/api/associations_api.rb +238 -284
  165. data/lib/buildium-ruby/api/bank_accounts_api.rb +387 -1
  166. data/lib/buildium-ruby/api/bills_api.rb +965 -0
  167. data/lib/buildium-ruby/api/board_members_api.rb +406 -0
  168. data/lib/buildium-ruby/api/budgets_api.rb +302 -0
  169. data/lib/buildium-ruby/api/client_leads_api.rb +1 -1
  170. data/lib/buildium-ruby/api/communications_api.rb +49 -49
  171. data/lib/buildium-ruby/api/contact_requests_api.rb +341 -0
  172. data/lib/buildium-ruby/api/files_api.rb +144 -7
  173. data/lib/buildium-ruby/api/general_ledger_api.rb +809 -0
  174. data/lib/buildium-ruby/api/lease_transactions_api.rb +1531 -0
  175. data/lib/buildium-ruby/api/leases_api.rb +193 -1191
  176. data/lib/buildium-ruby/api/listings_api.rb +5 -5
  177. data/lib/buildium-ruby/api/{association_ownership_accounts_api.rb → ownership_account_transactions_api.rb} +166 -613
  178. data/lib/buildium-ruby/api/ownership_accounts_api.rb +626 -0
  179. data/lib/buildium-ruby/api/property_groups_api.rb +3 -3
  180. data/lib/buildium-ruby/api/rental_appliances_api.rb +1 -1
  181. data/lib/buildium-ruby/api/rental_meter_readings_api.rb +363 -0
  182. data/lib/buildium-ruby/api/rental_owner_requests_api.rb +478 -0
  183. data/lib/buildium-ruby/api/rental_owners_api.rb +1 -1
  184. data/lib/buildium-ruby/api/rental_properties_api.rb +898 -54
  185. data/lib/buildium-ruby/api/rental_tenants_api.rb +1 -1
  186. data/lib/buildium-ruby/api/rental_units_api.rb +582 -1
  187. data/lib/buildium-ruby/api/resident_center_api.rb +242 -1
  188. data/lib/buildium-ruby/api/resident_requests_api.rb +344 -0
  189. data/lib/buildium-ruby/api/tasks_api.rb +345 -1624
  190. data/lib/buildium-ruby/api/to_do_requests_api.rb +341 -0
  191. data/lib/buildium-ruby/api/vendors_api.rb +3 -3
  192. data/lib/buildium-ruby/api/work_orders_api.rb +1 -1
  193. data/lib/buildium-ruby/api_client.rb +1 -1
  194. data/lib/buildium-ruby/api_error.rb +1 -1
  195. data/lib/buildium-ruby/configuration.rb +1 -1
  196. data/lib/buildium-ruby/models/account_info_message.rb +1 -1
  197. data/lib/buildium-ruby/models/accounting_entity_message.rb +14 -5
  198. data/lib/buildium-ruby/models/accounting_entity_save_message.rb +15 -5
  199. data/lib/buildium-ruby/models/accounting_lock_period_message.rb +1 -1
  200. data/lib/buildium-ruby/models/accounting_settings_message.rb +1 -1
  201. data/lib/buildium-ruby/models/address_message.rb +1 -1
  202. data/lib/buildium-ruby/models/all_tasks_message.rb +1 -1
  203. data/lib/buildium-ruby/models/announcement_message.rb +1 -1
  204. data/lib/buildium-ruby/models/announcement_post_message.rb +1 -1
  205. data/lib/buildium-ruby/models/announcement_search_message.rb +1 -1
  206. data/lib/buildium-ruby/models/announcement_sender_message.rb +1 -1
  207. data/lib/buildium-ruby/models/api_error_response.rb +1 -1
  208. data/lib/buildium-ruby/models/appliance_message.rb +1 -1
  209. data/lib/buildium-ruby/models/applicant_application_message.rb +1 -1
  210. data/lib/buildium-ruby/models/applicant_group_message.rb +1 -1
  211. data/lib/buildium-ruby/models/applicant_group_post_message.rb +1 -1
  212. data/lib/buildium-ruby/models/applicant_group_put_message.rb +1 -1
  213. data/lib/buildium-ruby/models/applicant_group_search_message.rb +1 -1
  214. data/lib/buildium-ruby/models/applicant_message.rb +46 -2
  215. data/lib/buildium-ruby/models/applicant_post_message.rb +1 -1
  216. data/lib/buildium-ruby/models/applicant_put_message.rb +1 -1
  217. data/lib/buildium-ruby/models/applicant_search_message.rb +1 -1
  218. data/lib/buildium-ruby/models/application_message.rb +1 -1
  219. data/lib/buildium-ruby/models/application_put_message.rb +1 -1
  220. data/lib/buildium-ruby/models/application_response_field_message.rb +3 -3
  221. data/lib/buildium-ruby/models/application_response_message.rb +3 -3
  222. data/lib/buildium-ruby/models/application_section_response_message.rb +1 -1
  223. data/lib/buildium-ruby/models/applied_vendor_credit_message.rb +228 -0
  224. data/lib/buildium-ruby/models/association_appliance_message.rb +1 -1
  225. data/lib/buildium-ruby/models/association_appliance_post_message.rb +1 -1
  226. data/lib/buildium-ruby/models/association_appliance_put_message.rb +1 -1
  227. data/lib/buildium-ruby/models/association_appliance_search_message.rb +1 -1
  228. data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +1 -1
  229. data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +1 -1
  230. data/lib/buildium-ruby/models/association_board_member_message.rb +1 -1
  231. data/lib/buildium-ruby/models/association_board_member_post_message.rb +1 -1
  232. data/lib/buildium-ruby/models/association_board_member_put_message.rb +1 -1
  233. data/lib/buildium-ruby/models/association_board_member_search_message.rb +1 -1
  234. data/lib/buildium-ruby/models/association_message.rb +14 -5
  235. data/lib/buildium-ruby/models/association_owner_board_term_message.rb +1 -1
  236. data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +1 -1
  237. data/lib/buildium-ruby/models/association_owner_message.rb +1 -1
  238. data/lib/buildium-ruby/models/association_owner_post_message.rb +1 -1
  239. data/lib/buildium-ruby/models/association_owner_put_message.rb +1 -1
  240. data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +1 -1
  241. data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +1 -1
  242. data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +1 -1
  243. data/lib/buildium-ruby/models/association_ownership_account_message.rb +1 -1
  244. data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +1 -1
  245. data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +1 -1
  246. data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +14 -2
  247. data/lib/buildium-ruby/models/association_post_message.rb +14 -5
  248. data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +1 -1
  249. data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +1 -1
  250. data/lib/buildium-ruby/models/association_put_message.rb +1 -1
  251. data/lib/buildium-ruby/models/association_search_message.rb +29 -5
  252. data/lib/buildium-ruby/models/association_tax_information_message.rb +292 -0
  253. data/lib/buildium-ruby/models/association_tenant_message.rb +1 -1
  254. data/lib/buildium-ruby/models/association_tenant_post_message.rb +1 -1
  255. data/lib/buildium-ruby/models/association_tenant_put_message.rb +1 -1
  256. data/lib/buildium-ruby/models/association_unit_message.rb +1 -1
  257. data/lib/buildium-ruby/models/association_unit_put_message.rb +1 -1
  258. data/lib/buildium-ruby/models/association_unit_search_message.rb +1 -1
  259. data/lib/buildium-ruby/models/association_units_post_message.rb +1 -1
  260. data/lib/buildium-ruby/models/association_user_search_message.rb +1 -1
  261. data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +15 -5
  262. data/lib/buildium-ruby/models/bank_account_check_file_message.rb +268 -0
  263. data/lib/buildium-ruby/models/bank_account_check_line_message.rb +1 -1
  264. data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +1 -1
  265. data/lib/buildium-ruby/models/bank_account_check_message.rb +1 -1
  266. data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +1 -1
  267. data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +1 -1
  268. data/lib/buildium-ruby/models/bank_account_check_post_message.rb +1 -1
  269. data/lib/buildium-ruby/models/bank_account_check_put_message.rb +1 -1
  270. data/lib/buildium-ruby/models/bank_account_check_search_message.rb +1 -1
  271. data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +1 -1
  272. data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +1 -1
  273. data/lib/buildium-ruby/models/bank_account_deposit_message.rb +1 -1
  274. data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +2 -2
  275. data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +1 -1
  276. data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +1 -1
  277. data/lib/buildium-ruby/models/bank_account_message.rb +15 -5
  278. data/lib/buildium-ruby/models/bank_account_post_message.rb +1 -1
  279. data/lib/buildium-ruby/models/bank_account_put_message.rb +1 -1
  280. data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +1 -1
  281. data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +1 -1
  282. data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +1 -1
  283. data/lib/buildium-ruby/models/bank_account_search_message.rb +17 -5
  284. data/lib/buildium-ruby/models/bank_account_transaction_message.rb +3 -3
  285. data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +1 -1
  286. data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +15 -5
  287. data/lib/buildium-ruby/models/bank_account_transfer_message.rb +1 -1
  288. data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +1 -1
  289. data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +1 -1
  290. data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +1 -1
  291. data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +1 -1
  292. data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +1 -1
  293. data/lib/buildium-ruby/models/bank_lockbox_data_association_message.rb +238 -0
  294. data/lib/buildium-ruby/models/bank_lockbox_data_association_owner_message.rb +314 -0
  295. data/lib/buildium-ruby/models/bank_lockbox_data_message.rb +229 -0
  296. data/lib/buildium-ruby/models/bank_lockbox_data_ownership_account_message.rb +293 -0
  297. data/lib/buildium-ruby/models/bank_lockbox_data_search_message.rb +220 -0
  298. data/lib/buildium-ruby/models/bill_file_message.rb +1 -1
  299. data/lib/buildium-ruby/models/bill_line_message.rb +1 -1
  300. data/lib/buildium-ruby/models/bill_line_post_message.rb +1 -1
  301. data/lib/buildium-ruby/models/bill_line_put_message.rb +1 -1
  302. data/lib/buildium-ruby/models/bill_markup_message.rb +1 -1
  303. data/lib/buildium-ruby/models/bill_markup_save_message.rb +1 -1
  304. data/lib/buildium-ruby/models/bill_message.rb +1 -1
  305. data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +15 -5
  306. data/lib/buildium-ruby/models/bill_payment_line_message.rb +1 -1
  307. data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +1 -1
  308. data/lib/buildium-ruby/models/bill_payment_message.rb +26 -2
  309. data/lib/buildium-ruby/models/bill_payment_post_message.rb +1 -1
  310. data/lib/buildium-ruby/models/bill_post_message.rb +1 -1
  311. data/lib/buildium-ruby/models/bill_put_message.rb +1 -1
  312. data/lib/buildium-ruby/models/bill_search_message.rb +1 -1
  313. data/lib/buildium-ruby/models/budget_details_message.rb +1 -1
  314. data/lib/buildium-ruby/models/budget_details_save_message.rb +1 -1
  315. data/lib/buildium-ruby/models/budget_message.rb +1 -1
  316. data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +1 -1
  317. data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +1 -1
  318. data/lib/buildium-ruby/models/budget_post_message.rb +1 -1
  319. data/lib/buildium-ruby/models/budget_put_message.rb +1 -1
  320. data/lib/buildium-ruby/models/budget_search_message.rb +1 -1
  321. data/lib/buildium-ruby/models/cancellation_token.rb +235 -0
  322. data/lib/buildium-ruby/models/cc_payments_message.rb +219 -0
  323. data/lib/buildium-ruby/models/cc_payments_put_message.rb +224 -0
  324. data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +1 -1
  325. data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +1 -1
  326. data/lib/buildium-ruby/models/check_printing_info_message.rb +1 -1
  327. data/lib/buildium-ruby/models/check_printing_info_post_message.rb +1 -1
  328. data/lib/buildium-ruby/models/check_printing_info_put_message.rb +1 -1
  329. data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +1 -1
  330. data/lib/buildium-ruby/models/client_lead_message.rb +1 -1
  331. data/lib/buildium-ruby/models/client_lead_search_message.rb +1 -1
  332. data/lib/buildium-ruby/models/contact_detail_message.rb +1 -1
  333. data/lib/buildium-ruby/models/contact_detail_phone_message.rb +1 -1
  334. data/lib/buildium-ruby/models/contact_detail_save_message.rb +1 -1
  335. data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +1 -1
  336. data/lib/buildium-ruby/models/contact_info_message.rb +1 -1
  337. data/lib/buildium-ruby/models/contact_request_task_message.rb +1 -1
  338. data/lib/buildium-ruby/models/contact_request_task_post_message.rb +1 -1
  339. data/lib/buildium-ruby/models/contact_request_task_put_message.rb +1 -1
  340. data/lib/buildium-ruby/models/contact_request_task_search_message.rb +1 -1
  341. data/lib/buildium-ruby/models/cosigner_message.rb +1 -1
  342. data/lib/buildium-ruby/models/created_by_user_message.rb +1 -1
  343. data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +1 -1
  344. data/lib/buildium-ruby/models/deposit_detail_message.rb +1 -1
  345. data/lib/buildium-ruby/models/e_pay_settings_message.rb +235 -0
  346. data/lib/buildium-ruby/models/e_pay_settings_put_message.rb +250 -0
  347. data/lib/buildium-ruby/models/eft_payments_message.rb +219 -0
  348. data/lib/buildium-ruby/models/eft_payments_put_message.rb +224 -0
  349. data/lib/buildium-ruby/models/electronic_payments_message.rb +1 -1
  350. data/lib/buildium-ruby/models/email_message.rb +1 -1
  351. data/lib/buildium-ruby/models/email_post_message.rb +1 -1
  352. data/lib/buildium-ruby/models/email_recipient_message.rb +1 -1
  353. data/lib/buildium-ruby/models/email_search_message.rb +1 -1
  354. data/lib/buildium-ruby/models/email_sender_message.rb +1 -1
  355. data/lib/buildium-ruby/models/emergency_contact_message.rb +1 -1
  356. data/lib/buildium-ruby/models/file_category_message.rb +1 -1
  357. data/lib/buildium-ruby/models/file_category_post_message.rb +1 -1
  358. data/lib/buildium-ruby/models/file_category_put_message.rb +1 -1
  359. data/lib/buildium-ruby/models/file_download_message.rb +1 -1
  360. data/lib/buildium-ruby/models/file_entity_message.rb +1 -1
  361. data/lib/buildium-ruby/models/file_message.rb +1 -1
  362. data/lib/buildium-ruby/models/file_name_post_message.rb +1 -1
  363. data/lib/buildium-ruby/models/file_put_message.rb +1 -1
  364. data/lib/buildium-ruby/models/file_search_message.rb +1 -1
  365. data/lib/buildium-ruby/models/file_sharing_account_message.rb +263 -0
  366. data/lib/buildium-ruby/models/file_sharing_account_put_message.rb +263 -0
  367. data/lib/buildium-ruby/models/file_sharing_association_message.rb +229 -0
  368. data/lib/buildium-ruby/models/file_sharing_association_owner_message.rb +219 -0
  369. data/lib/buildium-ruby/models/file_sharing_association_owner_put_message.rb +219 -0
  370. data/lib/buildium-ruby/models/file_sharing_association_put_message.rb +229 -0
  371. data/lib/buildium-ruby/models/file_sharing_association_unit_message.rb +229 -0
  372. data/lib/buildium-ruby/models/file_sharing_association_unit_put_message.rb +229 -0
  373. data/lib/buildium-ruby/models/file_sharing_committee_message.rb +239 -0
  374. data/lib/buildium-ruby/models/file_sharing_committee_put_message.rb +239 -0
  375. data/lib/buildium-ruby/models/file_sharing_lease_message.rb +229 -0
  376. data/lib/buildium-ruby/models/file_sharing_lease_put_message.rb +229 -0
  377. data/lib/buildium-ruby/models/file_sharing_message.rb +316 -0
  378. data/lib/buildium-ruby/models/file_sharing_ownership_account_message.rb +229 -0
  379. data/lib/buildium-ruby/models/file_sharing_ownership_account_put_message.rb +229 -0
  380. data/lib/buildium-ruby/models/file_sharing_put_message.rb +316 -0
  381. data/lib/buildium-ruby/models/file_sharing_rental_message.rb +229 -0
  382. data/lib/buildium-ruby/models/file_sharing_rental_owner_message.rb +219 -0
  383. data/lib/buildium-ruby/models/file_sharing_rental_owner_put_message.rb +219 -0
  384. data/lib/buildium-ruby/models/file_sharing_rental_put_message.rb +229 -0
  385. data/lib/buildium-ruby/models/file_sharing_rental_unit_mesage.rb +229 -0
  386. data/lib/buildium-ruby/models/file_sharing_rental_unit_put_mesage.rb +229 -0
  387. data/lib/buildium-ruby/models/file_sharing_tenant_message.rb +229 -0
  388. data/lib/buildium-ruby/models/file_sharing_tenant_put_message.rb +229 -0
  389. data/lib/buildium-ruby/models/file_sharing_vendor_message.rb +219 -0
  390. data/lib/buildium-ruby/models/file_sharing_vendor_put_message.rb +219 -0
  391. data/lib/buildium-ruby/models/file_upload_post_message.rb +1 -1
  392. data/lib/buildium-ruby/models/file_upload_ticket_message.rb +1 -1
  393. data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +2 -2
  394. data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +1 -1
  395. data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +1 -1
  396. data/lib/buildium-ruby/models/general_ledger_entry_message.rb +311 -0
  397. data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +1 -1
  398. data/lib/buildium-ruby/models/general_ledger_journal_message.rb +1 -1
  399. data/lib/buildium-ruby/models/general_ledger_message.rb +260 -0
  400. data/lib/buildium-ruby/models/general_ledger_search_message.rb +336 -0
  401. data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +1 -1
  402. data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +1 -1
  403. data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +1 -1
  404. data/lib/buildium-ruby/models/gl_account_balance_message.rb +1 -1
  405. data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +1 -1
  406. data/lib/buildium-ruby/models/gl_account_message.rb +1 -1
  407. data/lib/buildium-ruby/models/gl_account_post_message.rb +1 -1
  408. data/lib/buildium-ruby/models/gl_account_put_message.rb +1 -1
  409. data/lib/buildium-ruby/models/gl_accounts_search_message.rb +1 -1
  410. data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +1 -1
  411. data/lib/buildium-ruby/models/image_reorder_request_put_message.rb +225 -0
  412. data/lib/buildium-ruby/models/insured_tenant_message.rb +248 -0
  413. data/lib/buildium-ruby/models/internal_transaction_status_message.rb +1 -1
  414. data/lib/buildium-ruby/models/journal_line_message.rb +15 -5
  415. data/lib/buildium-ruby/models/journal_message.rb +1 -1
  416. data/lib/buildium-ruby/models/json_patch_operation.rb +254 -0
  417. data/lib/buildium-ruby/models/last_updated_by_user_message.rb +1 -1
  418. data/lib/buildium-ruby/models/lease_account_detail_message.rb +1 -1
  419. data/lib/buildium-ruby/models/lease_auto_allocated_payment_post_message.rb +332 -0
  420. data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +1 -1
  421. data/lib/buildium-ruby/models/lease_charge_post_message.rb +1 -1
  422. data/lib/buildium-ruby/models/lease_charge_put_message.rb +1 -1
  423. data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +1 -1
  424. data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +1 -1
  425. data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +1 -1
  426. data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +1 -1
  427. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +1 -1
  428. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +1 -1
  429. data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +1 -1
  430. data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +1 -1
  431. data/lib/buildium-ruby/models/lease_ledger_payment_put_message.rb +319 -0
  432. data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +1 -1
  433. data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +1 -1
  434. data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +1 -1
  435. data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +1 -1
  436. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +1 -1
  437. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +1 -1
  438. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +1 -1
  439. data/lib/buildium-ruby/models/lease_message.rb +1 -1
  440. data/lib/buildium-ruby/models/lease_move_out_data_message.rb +1 -1
  441. data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +1 -1
  442. data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +1 -1
  443. data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +1 -1
  444. data/lib/buildium-ruby/models/lease_post_message.rb +27 -8
  445. data/lib/buildium-ruby/models/lease_put_message.rb +1 -1
  446. data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +1 -1
  447. data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +1 -1
  448. data/lib/buildium-ruby/models/lease_renewal_message.rb +1 -1
  449. data/lib/buildium-ruby/models/lease_renewal_post_message.rb +1 -1
  450. data/lib/buildium-ruby/models/lease_renewal_search_message.rb +272 -0
  451. data/lib/buildium-ruby/models/lease_rent_charge_message.rb +1 -1
  452. data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +1 -1
  453. data/lib/buildium-ruby/models/lease_rent_message.rb +2 -2
  454. data/lib/buildium-ruby/models/lease_rent_post_message.rb +1 -1
  455. data/lib/buildium-ruby/models/lease_search_message.rb +1 -1
  456. data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +1 -1
  457. data/lib/buildium-ruby/models/lease_tenant_message.rb +15 -5
  458. data/lib/buildium-ruby/models/lease_transaction_message.rb +47 -3
  459. data/lib/buildium-ruby/models/lease_transaction_search_message.rb +1 -1
  460. data/lib/buildium-ruby/models/listing_contact_message.rb +1 -1
  461. data/lib/buildium-ruby/models/listing_contact_save_message.rb +1 -1
  462. data/lib/buildium-ruby/models/listing_entity_file_post_message.rb +248 -0
  463. data/lib/buildium-ruby/models/listing_file_message.rb +1 -1
  464. data/lib/buildium-ruby/models/listing_message.rb +1 -1
  465. data/lib/buildium-ruby/models/listing_property_message.rb +1 -1
  466. data/lib/buildium-ruby/models/listing_put_message.rb +1 -1
  467. data/lib/buildium-ruby/models/listing_search_message.rb +1 -1
  468. data/lib/buildium-ruby/models/listing_unit_message.rb +1 -1
  469. data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +1 -1
  470. data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +1 -1
  471. data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +1 -1
  472. data/lib/buildium-ruby/models/lookup_message.rb +1 -1
  473. data/lib/buildium-ruby/models/mailing_template_message.rb +1 -1
  474. data/lib/buildium-ruby/models/meter_reading_detail_message.rb +268 -0
  475. data/lib/buildium-ruby/models/meter_reading_detail_put_message.rb +263 -0
  476. data/lib/buildium-ruby/models/meter_reading_details_delete_search_message.rb +272 -0
  477. data/lib/buildium-ruby/models/meter_reading_details_message.rb +274 -0
  478. data/lib/buildium-ruby/models/meter_reading_details_put_message.rb +289 -0
  479. data/lib/buildium-ruby/models/meter_reading_details_put_search_message.rb +262 -0
  480. data/lib/buildium-ruby/models/meter_reading_details_search_message.rb +272 -0
  481. data/lib/buildium-ruby/models/meter_reading_message.rb +292 -0
  482. data/lib/buildium-ruby/models/meter_reading_search_message.rb +272 -0
  483. data/lib/buildium-ruby/models/multiple_bill_payments_post_message.rb +277 -0
  484. data/lib/buildium-ruby/models/note_message.rb +1 -1
  485. data/lib/buildium-ruby/models/note_post_message.rb +1 -1
  486. data/lib/buildium-ruby/models/note_put_message.rb +1 -1
  487. data/lib/buildium-ruby/models/note_search_message.rb +1 -1
  488. data/lib/buildium-ruby/models/offline_payments_message.rb +239 -0
  489. data/lib/buildium-ruby/models/offline_payments_put_message.rb +249 -0
  490. data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +1 -1
  491. data/lib/buildium-ruby/models/ownership_account_auto_allocated_payment_post_message.rb +332 -0
  492. data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +1 -1
  493. data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +1 -1
  494. data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +1 -1
  495. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +1 -1
  496. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +1 -1
  497. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +1 -1
  498. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +1 -1
  499. data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +1 -1
  500. data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +1 -1
  501. data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +1 -1
  502. data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +1 -1
  503. data/lib/buildium-ruby/models/ownership_account_ledger_payment_put_message.rb +320 -0
  504. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +1 -1
  505. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +1 -1
  506. data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +1 -1
  507. data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +1 -1
  508. data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +1 -1
  509. data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +1 -1
  510. data/lib/buildium-ruby/models/ownership_account_refund_message.rb +1 -1
  511. data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +1 -1
  512. data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +46 -2
  513. data/lib/buildium-ruby/models/paid_by_message.rb +1 -1
  514. data/lib/buildium-ruby/models/participant_message.rb +1 -1
  515. data/lib/buildium-ruby/models/participant_resource_message.rb +1 -1
  516. data/lib/buildium-ruby/models/payee_message.rb +1 -1
  517. data/lib/buildium-ruby/models/payment_detail_message.rb +1 -1
  518. data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +1 -1
  519. data/lib/buildium-ruby/models/payment_transactions_message.rb +1 -1
  520. data/lib/buildium-ruby/models/phone_log_message.rb +1 -1
  521. data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +1 -1
  522. data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +1 -1
  523. data/lib/buildium-ruby/models/phone_log_post_message.rb +1 -1
  524. data/lib/buildium-ruby/models/phone_log_put_message.rb +1 -1
  525. data/lib/buildium-ruby/models/phone_log_search_message.rb +1 -1
  526. data/lib/buildium-ruby/models/phone_number_message.rb +1 -1
  527. data/lib/buildium-ruby/models/phone_numbers_message.rb +1 -1
  528. data/lib/buildium-ruby/models/property_group_message.rb +1 -1
  529. data/lib/buildium-ruby/models/property_group_post_message.rb +1 -1
  530. data/lib/buildium-ruby/models/property_group_put_message.rb +1 -1
  531. data/lib/buildium-ruby/models/property_group_search_message.rb +1 -1
  532. data/lib/buildium-ruby/models/property_manager_message.rb +1 -1
  533. data/lib/buildium-ruby/models/property_message.rb +1 -1
  534. data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +1 -1
  535. data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +1 -1
  536. data/lib/buildium-ruby/models/recurring_transaction_message.rb +1 -1
  537. data/lib/buildium-ruby/models/rental_appliance_message.rb +1 -1
  538. data/lib/buildium-ruby/models/rental_appliance_post_message.rb +1 -1
  539. data/lib/buildium-ruby/models/rental_appliance_put_message.rb +1 -1
  540. data/lib/buildium-ruby/models/rental_appliance_search_message.rb +1 -1
  541. data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +1 -1
  542. data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +1 -1
  543. data/lib/buildium-ruby/models/rental_features_message.rb +1 -1
  544. data/lib/buildium-ruby/models/rental_features_put_message.rb +1 -1
  545. data/lib/buildium-ruby/models/rental_image_message.rb +292 -0
  546. data/lib/buildium-ruby/models/rental_image_put_message.rb +233 -0
  547. data/lib/buildium-ruby/models/rental_message.rb +1 -1
  548. data/lib/buildium-ruby/models/rental_owner_contribution_data_message.rb +229 -0
  549. data/lib/buildium-ruby/models/rental_owner_contribution_data_put_message.rb +229 -0
  550. data/lib/buildium-ruby/models/rental_owner_contribution_message.rb +229 -0
  551. data/lib/buildium-ruby/models/rental_owner_contribution_put_message.rb +229 -0
  552. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_message.rb +229 -0
  553. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_put_message.rb +229 -0
  554. data/lib/buildium-ruby/models/rental_owner_message.rb +1 -1
  555. data/lib/buildium-ruby/models/rental_owner_post_message.rb +1 -1
  556. data/lib/buildium-ruby/models/rental_owner_put_message.rb +1 -1
  557. data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +1 -1
  558. data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +1 -1
  559. data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +1 -1
  560. data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +1 -1
  561. data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +1 -1
  562. data/lib/buildium-ruby/models/rental_owners_search_message.rb +1 -1
  563. data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +1 -1
  564. data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +1 -1
  565. data/lib/buildium-ruby/models/rental_property_post_message.rb +2 -2
  566. data/lib/buildium-ruby/models/rental_property_put_message.rb +1 -1
  567. data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +1 -1
  568. data/lib/buildium-ruby/models/rental_search_message.rb +1 -1
  569. data/lib/buildium-ruby/models/rental_tenant_post_message.rb +1 -1
  570. data/lib/buildium-ruby/models/rental_tenant_put_message.rb +1 -1
  571. data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +1 -1
  572. data/lib/buildium-ruby/models/rental_unit_features_message.rb +1 -1
  573. data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +1 -1
  574. data/lib/buildium-ruby/models/rental_unit_image_message.rb +292 -0
  575. data/lib/buildium-ruby/models/rental_unit_image_put_message.rb +233 -0
  576. data/lib/buildium-ruby/models/rental_unit_message.rb +3 -3
  577. data/lib/buildium-ruby/models/rental_unit_put_message.rb +1 -1
  578. data/lib/buildium-ruby/models/rental_unit_search_message.rb +1 -1
  579. data/lib/buildium-ruby/models/rental_units_post_message.rb +1 -1
  580. data/lib/buildium-ruby/models/renters_insurance_policy_message.rb +324 -0
  581. data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +1 -1
  582. data/lib/buildium-ruby/models/resident_center_user_message.rb +1 -1
  583. data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +1 -1
  584. data/lib/buildium-ruby/models/resident_center_user_search_message.rb +1 -1
  585. data/lib/buildium-ruby/models/resident_request_task_message.rb +1 -1
  586. data/lib/buildium-ruby/models/resident_request_task_post_message.rb +25 -5
  587. data/lib/buildium-ruby/models/resident_request_task_put_message.rb +1 -1
  588. data/lib/buildium-ruby/models/resident_request_task_search_message.rb +1 -1
  589. data/lib/buildium-ruby/models/retail_cash_property_message.rb +282 -0
  590. data/lib/buildium-ruby/models/retail_cash_unit_message.rb +238 -0
  591. data/lib/buildium-ruby/models/retail_cash_user_data_message.rb +312 -0
  592. data/lib/buildium-ruby/models/retail_cash_user_message.rb +274 -0
  593. data/lib/buildium-ruby/models/retail_cash_user_put_message.rb +223 -0
  594. data/lib/buildium-ruby/models/retail_cash_users_search_message.rb +304 -0
  595. data/lib/buildium-ruby/models/safe_wait_handle.rb +226 -0
  596. data/lib/buildium-ruby/models/save_address_message.rb +1 -1
  597. data/lib/buildium-ruby/models/save_emergency_contact_message.rb +1 -1
  598. data/lib/buildium-ruby/models/task_category_message.rb +1 -1
  599. data/lib/buildium-ruby/models/task_category_put_message.rb +1 -1
  600. data/lib/buildium-ruby/models/task_category_response_message.rb +1 -1
  601. data/lib/buildium-ruby/models/task_category_save_message.rb +1 -1
  602. data/lib/buildium-ruby/models/task_history_file_message.rb +1 -1
  603. data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +1 -1
  604. data/lib/buildium-ruby/models/task_history_message.rb +1 -1
  605. data/lib/buildium-ruby/models/task_history_put_message.rb +1 -1
  606. data/lib/buildium-ruby/models/task_history_user_message.rb +1 -1
  607. data/lib/buildium-ruby/models/task_search_message.rb +1 -1
  608. data/lib/buildium-ruby/models/task_sub_category_message.rb +1 -1
  609. data/lib/buildium-ruby/models/tax_information_post_message.rb +1 -1
  610. data/lib/buildium-ruby/models/tax_information_save_message.rb +1 -1
  611. data/lib/buildium-ruby/models/tenant_message.rb +1 -1
  612. data/lib/buildium-ruby/models/tenant_search_message.rb +1 -1
  613. data/lib/buildium-ruby/models/to_do_task_message.rb +1 -1
  614. data/lib/buildium-ruby/models/to_do_task_post_message.rb +1 -1
  615. data/lib/buildium-ruby/models/to_do_task_put_message.rb +1 -1
  616. data/lib/buildium-ruby/models/to_do_task_search_message.rb +1 -1
  617. data/lib/buildium-ruby/models/undeposited_funds_message.rb +1 -1
  618. data/lib/buildium-ruby/models/unit_agreement_message.rb +1 -1
  619. data/lib/buildium-ruby/models/unit_entity_message.rb +229 -0
  620. data/lib/buildium-ruby/models/user_message.rb +1 -1
  621. data/lib/buildium-ruby/models/user_role_message.rb +1 -1
  622. data/lib/buildium-ruby/models/user_search_message.rb +1 -1
  623. data/lib/buildium-ruby/models/vehicle_message.rb +1 -1
  624. data/lib/buildium-ruby/models/vendor_category_message.rb +1 -1
  625. data/lib/buildium-ruby/models/vendor_category_save_message.rb +1 -1
  626. data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +1 -1
  627. data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +1 -1
  628. data/lib/buildium-ruby/models/vendor_credit_message.rb +1 -1
  629. data/lib/buildium-ruby/models/vendor_credit_post_message.rb +1 -1
  630. data/lib/buildium-ruby/models/vendor_insurance_message.rb +1 -1
  631. data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +1 -1
  632. data/lib/buildium-ruby/models/vendor_message.rb +1 -1
  633. data/lib/buildium-ruby/models/vendor_post_message.rb +1 -1
  634. data/lib/buildium-ruby/models/vendor_put_message.rb +1 -1
  635. data/lib/buildium-ruby/models/vendor_refund_line_message.rb +1 -1
  636. data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +1 -1
  637. data/lib/buildium-ruby/models/vendor_refund_message.rb +1 -1
  638. data/lib/buildium-ruby/models/vendor_refund_post_message.rb +1 -1
  639. data/lib/buildium-ruby/models/vendor_search_message.rb +1 -1
  640. data/lib/buildium-ruby/models/vendor_tax_information_message.rb +1 -1
  641. data/lib/buildium-ruby/models/vendor_transaction_message.rb +1 -1
  642. data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +1 -1
  643. data/lib/buildium-ruby/models/video_link_request_post_message.rb +238 -0
  644. data/lib/buildium-ruby/models/wait_handle.rb +226 -0
  645. data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +1 -1
  646. data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +1 -1
  647. data/lib/buildium-ruby/models/work_order_line_item_message.rb +1 -1
  648. data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +1 -1
  649. data/lib/buildium-ruby/models/work_order_message.rb +1 -1
  650. data/lib/buildium-ruby/models/work_order_post_message.rb +1 -1
  651. data/lib/buildium-ruby/models/work_order_put_message.rb +1 -1
  652. data/lib/buildium-ruby/models/work_order_search_message.rb +1 -1
  653. data/lib/buildium-ruby/models/work_order_task_message.rb +1 -1
  654. data/lib/buildium-ruby/models/work_order_task_post_message.rb +1 -1
  655. data/lib/buildium-ruby/version.rb +2 -2
  656. data/lib/buildium-ruby.rb +101 -4
  657. data/spec/api_client_spec.rb +1 -1
  658. data/spec/configuration_spec.rb +1 -1
  659. data/spec/spec_helper.rb +1 -1
  660. metadata +206 -826
  661. data/docs/AccountingApi.md +0 -2041
  662. data/lib/buildium-ruby/api/accounting_api.rb +0 -1855
  663. data/spec/api/accounting_api_spec.rb +0 -383
  664. data/spec/api/administration_api_spec.rb +0 -114
  665. data/spec/api/applicants_api_spec.rb +0 -294
  666. data/spec/api/association_appliances_api_spec.rb +0 -141
  667. data/spec/api/association_owners_api_spec.rb +0 -195
  668. data/spec/api/association_ownership_accounts_api_spec.rb +0 -385
  669. data/spec/api/association_tenants_api_spec.rb +0 -153
  670. data/spec/api/association_units_api_spec.rb +0 -147
  671. data/spec/api/associations_api_spec.rb +0 -248
  672. data/spec/api/bank_accounts_api_spec.rb +0 -420
  673. data/spec/api/client_leads_api_spec.rb +0 -66
  674. data/spec/api/communications_api_spec.rb +0 -248
  675. data/spec/api/files_api_spec.rb +0 -156
  676. data/spec/api/leases_api_spec.rb +0 -529
  677. data/spec/api/listings_api_spec.rb +0 -139
  678. data/spec/api/property_groups_api_spec.rb +0 -88
  679. data/spec/api/rental_appliances_api_spec.rb +0 -141
  680. data/spec/api/rental_owners_api_spec.rb +0 -151
  681. data/spec/api/rental_properties_api_spec.rb +0 -205
  682. data/spec/api/rental_tenants_api_spec.rb +0 -154
  683. data/spec/api/rental_units_api_spec.rb +0 -172
  684. data/spec/api/resident_center_api_spec.rb +0 -54
  685. data/spec/api/tasks_api_spec.rb +0 -493
  686. data/spec/api/vendors_api_spec.rb +0 -275
  687. data/spec/api/work_orders_api_spec.rb +0 -105
  688. data/spec/models/account_info_message_spec.rb +0 -58
  689. data/spec/models/accounting_entity_message_spec.rb +0 -50
  690. data/spec/models/accounting_entity_save_message_spec.rb +0 -44
  691. data/spec/models/accounting_lock_period_message_spec.rb +0 -46
  692. data/spec/models/accounting_settings_message_spec.rb +0 -72
  693. data/spec/models/address_message_spec.rb +0 -74
  694. data/spec/models/all_tasks_message_spec.rb +0 -130
  695. data/spec/models/announcement_message_spec.rb +0 -74
  696. data/spec/models/announcement_post_message_spec.rb +0 -64
  697. data/spec/models/announcement_search_message_spec.rb +0 -62
  698. data/spec/models/announcement_sender_message_spec.rb +0 -46
  699. data/spec/models/api_error_response_spec.rb +0 -46
  700. data/spec/models/appliance_message_spec.rb +0 -58
  701. data/spec/models/applicant_application_message_spec.rb +0 -56
  702. data/spec/models/applicant_group_message_spec.rb +0 -62
  703. data/spec/models/applicant_group_post_message_spec.rb +0 -40
  704. data/spec/models/applicant_group_put_message_spec.rb +0 -50
  705. data/spec/models/applicant_group_search_message_spec.rb +0 -66
  706. data/spec/models/applicant_message_spec.rb +0 -88
  707. data/spec/models/applicant_post_message_spec.rb +0 -64
  708. data/spec/models/applicant_put_message_spec.rb +0 -58
  709. data/spec/models/applicant_search_message_spec.rb +0 -84
  710. data/spec/models/application_message_spec.rb +0 -62
  711. data/spec/models/application_put_message_spec.rb +0 -38
  712. data/spec/models/application_response_field_message_spec.rb +0 -60
  713. data/spec/models/application_response_message_spec.rb +0 -50
  714. data/spec/models/application_section_response_message_spec.rb +0 -34
  715. data/spec/models/association_appliance_message_spec.rb +0 -76
  716. data/spec/models/association_appliance_post_message_spec.rb +0 -76
  717. data/spec/models/association_appliance_put_message_spec.rb +0 -64
  718. data/spec/models/association_appliance_search_message_spec.rb +0 -40
  719. data/spec/models/association_appliance_service_history_message_spec.rb +0 -56
  720. data/spec/models/association_appliance_service_history_post_message_spec.rb +0 -50
  721. data/spec/models/association_board_member_message_spec.rb +0 -92
  722. data/spec/models/association_board_member_post_message_spec.rb +0 -56
  723. data/spec/models/association_board_member_put_message_spec.rb +0 -50
  724. data/spec/models/association_board_member_search_message_spec.rb +0 -60
  725. data/spec/models/association_message_spec.rb +0 -100
  726. data/spec/models/association_owner_board_term_message_spec.rb +0 -68
  727. data/spec/models/association_owner_board_term_post_message_spec.rb +0 -50
  728. data/spec/models/association_owner_message_spec.rb +0 -144
  729. data/spec/models/association_owner_post_message_spec.rb +0 -116
  730. data/spec/models/association_owner_put_message_spec.rb +0 -98
  731. data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +0 -128
  732. data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +0 -34
  733. data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +0 -40
  734. data/spec/models/association_ownership_account_message_spec.rb +0 -90
  735. data/spec/models/association_ownership_account_post_message_spec.rb +0 -80
  736. data/spec/models/association_ownership_account_put_message_spec.rb +0 -34
  737. data/spec/models/association_ownership_account_search_message_spec.rb +0 -72
  738. data/spec/models/association_post_message_spec.rb +0 -76
  739. data/spec/models/association_preferred_vendor_message_spec.rb +0 -82
  740. data/spec/models/association_preferred_vendor_put_message_spec.rb +0 -34
  741. data/spec/models/association_put_message_spec.rb +0 -82
  742. data/spec/models/association_search_message_spec.rb +0 -56
  743. data/spec/models/association_tenant_message_spec.rb +0 -112
  744. data/spec/models/association_tenant_post_message_spec.rb +0 -106
  745. data/spec/models/association_tenant_put_message_spec.rb +0 -94
  746. data/spec/models/association_unit_message_spec.rb +0 -84
  747. data/spec/models/association_unit_put_message_spec.rb +0 -66
  748. data/spec/models/association_unit_search_message_spec.rb +0 -46
  749. data/spec/models/association_units_post_message_spec.rb +0 -72
  750. data/spec/models/association_user_search_message_spec.rb +0 -86
  751. data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +0 -44
  752. data/spec/models/bank_account_check_line_message_spec.rb +0 -64
  753. data/spec/models/bank_account_check_line_save_message_spec.rb +0 -58
  754. data/spec/models/bank_account_check_message_spec.rb +0 -70
  755. data/spec/models/bank_account_check_payee_message_spec.rb +0 -50
  756. data/spec/models/bank_account_check_payee_save_message_spec.rb +0 -44
  757. data/spec/models/bank_account_check_post_message_spec.rb +0 -58
  758. data/spec/models/bank_account_check_put_message_spec.rb +0 -58
  759. data/spec/models/bank_account_check_search_message_spec.rb +0 -40
  760. data/spec/models/bank_account_deposit_line_message_spec.rb +0 -64
  761. data/spec/models/bank_account_deposit_line_save_message_spec.rb +0 -58
  762. data/spec/models/bank_account_deposit_message_spec.rb +0 -64
  763. data/spec/models/bank_account_deposit_post_message_spec.rb +0 -52
  764. data/spec/models/bank_account_deposit_put_message_spec.rb +0 -46
  765. data/spec/models/bank_account_deposit_search_message_spec.rb +0 -40
  766. data/spec/models/bank_account_message_spec.rb +0 -104
  767. data/spec/models/bank_account_post_message_spec.rb +0 -78
  768. data/spec/models/bank_account_put_message_spec.rb +0 -78
  769. data/spec/models/bank_account_quick_deposit_message_spec.rb +0 -64
  770. data/spec/models/bank_account_quick_deposit_save_message_spec.rb +0 -58
  771. data/spec/models/bank_account_quick_deposit_search_message_spec.rb +0 -40
  772. data/spec/models/bank_account_search_message_spec.rb +0 -44
  773. data/spec/models/bank_account_transaction_message_spec.rb +0 -96
  774. data/spec/models/bank_account_transaction_search_message_spec.rb +0 -56
  775. data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +0 -44
  776. data/spec/models/bank_account_transfer_message_spec.rb +0 -64
  777. data/spec/models/bank_account_transfer_save_message_spec.rb +0 -58
  778. data/spec/models/bank_account_transfer_search_message_spec.rb +0 -40
  779. data/spec/models/bank_account_withdrawal_message_spec.rb +0 -64
  780. data/spec/models/bank_account_withdrawal_save_message_spec.rb +0 -58
  781. data/spec/models/bank_account_withdrawal_search_message_spec.rb +0 -40
  782. data/spec/models/bill_file_message_spec.rb +0 -64
  783. data/spec/models/bill_line_message_spec.rb +0 -64
  784. data/spec/models/bill_line_post_message_spec.rb +0 -58
  785. data/spec/models/bill_line_put_message_spec.rb +0 -64
  786. data/spec/models/bill_markup_message_spec.rb +0 -44
  787. data/spec/models/bill_markup_save_message_spec.rb +0 -44
  788. data/spec/models/bill_message_spec.rb +0 -92
  789. data/spec/models/bill_payment_accounting_entity_message_spec.rb +0 -44
  790. data/spec/models/bill_payment_line_message_spec.rb +0 -46
  791. data/spec/models/bill_payment_line_post_message_spec.rb +0 -40
  792. data/spec/models/bill_payment_message_spec.rb +0 -64
  793. data/spec/models/bill_payment_post_message_spec.rb +0 -58
  794. data/spec/models/bill_post_message_spec.rb +0 -70
  795. data/spec/models/bill_put_message_spec.rb +0 -64
  796. data/spec/models/bill_search_message_spec.rb +0 -88
  797. data/spec/models/budget_details_message_spec.rb +0 -56
  798. data/spec/models/budget_details_save_message_spec.rb +0 -40
  799. data/spec/models/budget_message_spec.rb +0 -64
  800. data/spec/models/budget_monthly_amounts_message_spec.rb +0 -100
  801. data/spec/models/budget_monthly_amounts_save_message_spec.rb +0 -100
  802. data/spec/models/budget_post_message_spec.rb +0 -62
  803. data/spec/models/budget_put_message_spec.rb +0 -40
  804. data/spec/models/budget_search_message_spec.rb +0 -46
  805. data/spec/models/charge_recurring_transaction_post_message_spec.rb +0 -84
  806. data/spec/models/charge_recurring_transaction_put_message_spec.rb +0 -90
  807. data/spec/models/check_printing_info_message_spec.rb +0 -122
  808. data/spec/models/check_printing_info_post_message_spec.rb +0 -122
  809. data/spec/models/check_printing_info_put_message_spec.rb +0 -122
  810. data/spec/models/client_lead_credit_request_message_spec.rb +0 -60
  811. data/spec/models/client_lead_message_spec.rb +0 -102
  812. data/spec/models/client_lead_search_message_spec.rb +0 -66
  813. data/spec/models/contact_detail_message_spec.rb +0 -52
  814. data/spec/models/contact_detail_phone_message_spec.rb +0 -46
  815. data/spec/models/contact_detail_save_message_spec.rb +0 -52
  816. data/spec/models/contact_detail_save_phone_message_spec.rb +0 -46
  817. data/spec/models/contact_info_message_spec.rb +0 -52
  818. data/spec/models/contact_request_task_message_spec.rb +0 -114
  819. data/spec/models/contact_request_task_post_message_spec.rb +0 -102
  820. data/spec/models/contact_request_task_put_message_spec.rb +0 -102
  821. data/spec/models/contact_request_task_search_message_spec.rb +0 -112
  822. data/spec/models/cosigner_message_spec.rb +0 -92
  823. data/spec/models/created_by_user_message_spec.rb +0 -52
  824. data/spec/models/credit_recurring_transaction_post_message_spec.rb +0 -100
  825. data/spec/models/deposit_detail_message_spec.rb +0 -40
  826. data/spec/models/electronic_payments_message_spec.rb +0 -76
  827. data/spec/models/email_message_spec.rb +0 -52
  828. data/spec/models/email_post_message_spec.rb +0 -70
  829. data/spec/models/email_recipient_message_spec.rb +0 -62
  830. data/spec/models/email_search_message_spec.rb +0 -58
  831. data/spec/models/email_sender_message_spec.rb +0 -52
  832. data/spec/models/emergency_contact_message_spec.rb +0 -52
  833. data/spec/models/file_category_message_spec.rb +0 -46
  834. data/spec/models/file_category_post_message_spec.rb +0 -34
  835. data/spec/models/file_category_put_message_spec.rb +0 -34
  836. data/spec/models/file_download_message_spec.rb +0 -34
  837. data/spec/models/file_entity_message_spec.rb +0 -50
  838. data/spec/models/file_message_spec.rb +0 -82
  839. data/spec/models/file_name_post_message_spec.rb +0 -34
  840. data/spec/models/file_put_message_spec.rb +0 -46
  841. data/spec/models/file_search_message_spec.rb +0 -74
  842. data/spec/models/file_upload_post_message_spec.rb +0 -68
  843. data/spec/models/file_upload_ticket_message_spec.rb +0 -46
  844. data/spec/models/general_journal_entry_line_save_message_spec.rb +0 -56
  845. data/spec/models/general_journal_entry_post_message_spec.rb +0 -52
  846. data/spec/models/general_journal_entry_put_message_spec.rb +0 -52
  847. data/spec/models/general_ledger_journal_line_message_spec.rb +0 -64
  848. data/spec/models/general_ledger_journal_message_spec.rb +0 -40
  849. data/spec/models/general_ledger_transaction_message_spec.rb +0 -98
  850. data/spec/models/general_ledger_transaction_search_message_spec.rb +0 -62
  851. data/spec/models/gl_account_balance_item_message_spec.rb +0 -40
  852. data/spec/models/gl_account_balance_message_spec.rb +0 -46
  853. data/spec/models/gl_account_balance_search_message_spec.rb +0 -66
  854. data/spec/models/gl_account_message_spec.rb +0 -130
  855. data/spec/models/gl_account_post_message_spec.rb +0 -84
  856. data/spec/models/gl_account_put_message_spec.rb +0 -84
  857. data/spec/models/gl_accounts_search_message_spec.rb +0 -38
  858. data/spec/models/gl_transaction_message_v1_spec.rb +0 -58
  859. data/spec/models/internal_transaction_status_message_spec.rb +0 -46
  860. data/spec/models/journal_line_message_spec.rb +0 -64
  861. data/spec/models/journal_message_spec.rb +0 -40
  862. data/spec/models/last_updated_by_user_message_spec.rb +0 -58
  863. data/spec/models/lease_account_detail_message_spec.rb +0 -40
  864. data/spec/models/lease_charge_line_save_message_spec.rb +0 -46
  865. data/spec/models/lease_charge_post_message_spec.rb +0 -46
  866. data/spec/models/lease_charge_put_message_spec.rb +0 -46
  867. data/spec/models/lease_charge_recurring_transaction_message_spec.rb +0 -108
  868. data/spec/models/lease_cosigner_post_message_spec.rb +0 -80
  869. data/spec/models/lease_ledger_credit_line_post_message_spec.rb +0 -40
  870. data/spec/models/lease_ledger_credit_post_message_spec.rb +0 -62
  871. data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +0 -40
  872. data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +0 -52
  873. data/spec/models/lease_ledger_payment_line_save_message_spec.rb +0 -40
  874. data/spec/models/lease_ledger_payment_post_message_spec.rb +0 -74
  875. data/spec/models/lease_ledger_refund_line_message_spec.rb +0 -40
  876. data/spec/models/lease_ledger_refund_line_post_message_spec.rb +0 -40
  877. data/spec/models/lease_ledger_refund_message_spec.rb +0 -82
  878. data/spec/models/lease_ledger_refund_post_message_spec.rb +0 -70
  879. data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +0 -40
  880. data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +0 -40
  881. data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +0 -52
  882. data/spec/models/lease_message_spec.rb +0 -170
  883. data/spec/models/lease_move_out_data_message_spec.rb +0 -46
  884. data/spec/models/lease_move_out_data_post_message_spec.rb +0 -46
  885. data/spec/models/lease_outstanding_balance_message_spec.rb +0 -100
  886. data/spec/models/lease_outstanding_balance_search_message_spec.rb +0 -90
  887. data/spec/models/lease_post_message_spec.rb +0 -98
  888. data/spec/models/lease_put_message_spec.rb +0 -68
  889. data/spec/models/lease_recurring_credit_message_spec.rb +0 -124
  890. data/spec/models/lease_recurring_payment_message_spec.rb +0 -118
  891. data/spec/models/lease_renewal_message_spec.rb +0 -84
  892. data/spec/models/lease_renewal_post_message_spec.rb +0 -98
  893. data/spec/models/lease_rent_charge_message_spec.rb +0 -70
  894. data/spec/models/lease_rent_charge_post_message_spec.rb +0 -52
  895. data/spec/models/lease_rent_message_spec.rb +0 -86
  896. data/spec/models/lease_rent_post_message_spec.rb +0 -44
  897. data/spec/models/lease_search_message_spec.rb +0 -108
  898. data/spec/models/lease_security_deposit_post_message_spec.rb +0 -40
  899. data/spec/models/lease_tenant_message_spec.rb +0 -44
  900. data/spec/models/lease_transaction_message_spec.rb +0 -82
  901. data/spec/models/lease_transaction_search_message_spec.rb +0 -50
  902. data/spec/models/listing_contact_message_spec.rb +0 -58
  903. data/spec/models/listing_contact_save_message_spec.rb +0 -52
  904. data/spec/models/listing_file_message_spec.rb +0 -50
  905. data/spec/models/listing_message_spec.rb +0 -88
  906. data/spec/models/listing_property_message_spec.rb +0 -90
  907. data/spec/models/listing_put_message_spec.rb +0 -64
  908. data/spec/models/listing_search_message_spec.rb +0 -44
  909. data/spec/models/listing_unit_message_spec.rb +0 -100
  910. data/spec/models/lock_period_settings_global_message_spec.rb +0 -34
  911. data/spec/models/lock_period_settings_overrides_message_spec.rb +0 -40
  912. data/spec/models/logged_by_staff_user_message_spec.rb +0 -52
  913. data/spec/models/lookup_message_spec.rb +0 -40
  914. data/spec/models/mailing_template_message_spec.rb +0 -56
  915. data/spec/models/note_message_spec.rb +0 -46
  916. data/spec/models/note_post_message_spec.rb +0 -34
  917. data/spec/models/note_put_message_spec.rb +0 -34
  918. data/spec/models/note_search_message_spec.rb +0 -46
  919. data/spec/models/outstanding_balances_line_message_spec.rb +0 -40
  920. data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +0 -108
  921. data/spec/models/ownership_account_credit_line_post_message_spec.rb +0 -40
  922. data/spec/models/ownership_account_credit_post_message_spec.rb +0 -62
  923. data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +0 -40
  924. data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +0 -52
  925. data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +0 -46
  926. data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +0 -40
  927. data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +0 -46
  928. data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +0 -46
  929. data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +0 -40
  930. data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +0 -74
  931. data/spec/models/ownership_account_outstanding_balance_message_spec.rb +0 -88
  932. data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +0 -70
  933. data/spec/models/ownership_account_recurring_credit_message_spec.rb +0 -124
  934. data/spec/models/ownership_account_recurring_payment_message_spec.rb +0 -118
  935. data/spec/models/ownership_account_refund_line_message_spec.rb +0 -40
  936. data/spec/models/ownership_account_refund_lines_post_message_spec.rb +0 -40
  937. data/spec/models/ownership_account_refund_message_spec.rb +0 -82
  938. data/spec/models/ownership_account_refund_post_message_spec.rb +0 -70
  939. data/spec/models/ownership_account_transaction_message_spec.rb +0 -82
  940. data/spec/models/paid_by_message_spec.rb +0 -40
  941. data/spec/models/participant_message_spec.rb +0 -46
  942. data/spec/models/participant_resource_message_spec.rb +0 -44
  943. data/spec/models/payee_message_spec.rb +0 -56
  944. data/spec/models/payment_detail_message_spec.rb +0 -56
  945. data/spec/models/payment_recurring_transaction_post_message_spec.rb +0 -94
  946. data/spec/models/payment_transactions_message_spec.rb +0 -46
  947. data/spec/models/phone_log_message_spec.rb +0 -64
  948. data/spec/models/phone_log_participant_post_message_spec.rb +0 -50
  949. data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +0 -44
  950. data/spec/models/phone_log_post_message_spec.rb +0 -52
  951. data/spec/models/phone_log_put_message_spec.rb +0 -46
  952. data/spec/models/phone_log_search_message_spec.rb +0 -84
  953. data/spec/models/phone_number_message_spec.rb +0 -44
  954. data/spec/models/phone_numbers_message_spec.rb +0 -52
  955. data/spec/models/property_group_message_spec.rb +0 -58
  956. data/spec/models/property_group_post_message_spec.rb +0 -46
  957. data/spec/models/property_group_put_message_spec.rb +0 -46
  958. data/spec/models/property_group_search_message_spec.rb +0 -40
  959. data/spec/models/property_manager_message_spec.rb +0 -76
  960. data/spec/models/property_message_spec.rb +0 -50
  961. data/spec/models/recurring_transaction_line_message_spec.rb +0 -40
  962. data/spec/models/recurring_transaction_line_post_message_spec.rb +0 -40
  963. data/spec/models/recurring_transaction_message_spec.rb +0 -112
  964. data/spec/models/rental_appliance_message_spec.rb +0 -76
  965. data/spec/models/rental_appliance_post_message_spec.rb +0 -76
  966. data/spec/models/rental_appliance_put_message_spec.rb +0 -64
  967. data/spec/models/rental_appliance_search_message_spec.rb +0 -40
  968. data/spec/models/rental_appliance_service_history_message_spec.rb +0 -56
  969. data/spec/models/rental_appliance_service_history_post_message_spec.rb +0 -50
  970. data/spec/models/rental_features_message_spec.rb +0 -48
  971. data/spec/models/rental_features_put_message_spec.rb +0 -48
  972. data/spec/models/rental_message_spec.rb +0 -108
  973. data/spec/models/rental_owner_message_spec.rb +0 -118
  974. data/spec/models/rental_owner_post_message_spec.rb +0 -112
  975. data/spec/models/rental_owner_put_message_spec.rb +0 -106
  976. data/spec/models/rental_owner_request_task_message_spec.rb +0 -114
  977. data/spec/models/rental_owner_request_task_post_message_spec.rb +0 -102
  978. data/spec/models/rental_owner_request_task_put_message_spec.rb +0 -96
  979. data/spec/models/rental_owner_request_task_search_message_spec.rb +0 -112
  980. data/spec/models/rental_owner_tax_information_message_spec.rb +0 -68
  981. data/spec/models/rental_owners_search_message_spec.rb +0 -74
  982. data/spec/models/rental_preferred_vendor_message_spec.rb +0 -82
  983. data/spec/models/rental_preferred_vendor_put_message_spec.rb +0 -34
  984. data/spec/models/rental_property_post_message_spec.rb +0 -92
  985. data/spec/models/rental_property_put_message_spec.rb +0 -80
  986. data/spec/models/rental_property_unit_post_message_spec.rb +0 -78
  987. data/spec/models/rental_search_message_spec.rb +0 -88
  988. data/spec/models/rental_tenant_post_message_spec.rb +0 -110
  989. data/spec/models/rental_tenant_put_message_spec.rb +0 -104
  990. data/spec/models/rental_tenant_renewal_post_message_spec.rb +0 -104
  991. data/spec/models/rental_unit_features_message_spec.rb +0 -38
  992. data/spec/models/rental_unit_features_put_message_spec.rb +0 -38
  993. data/spec/models/rental_unit_message_spec.rb +0 -108
  994. data/spec/models/rental_unit_put_message_spec.rb +0 -78
  995. data/spec/models/rental_unit_search_message_spec.rb +0 -46
  996. data/spec/models/rental_units_post_message_spec.rb +0 -84
  997. data/spec/models/requested_by_user_entity_message_spec.rb +0 -68
  998. data/spec/models/resident_center_user_message_spec.rb +0 -56
  999. data/spec/models/resident_center_user_reference_message_spec.rb +0 -62
  1000. data/spec/models/resident_center_user_search_message_spec.rb +0 -66
  1001. data/spec/models/resident_request_task_message_spec.rb +0 -144
  1002. data/spec/models/resident_request_task_post_message_spec.rb +0 -114
  1003. data/spec/models/resident_request_task_put_message_spec.rb +0 -84
  1004. data/spec/models/resident_request_task_search_message_spec.rb +0 -118
  1005. data/spec/models/save_address_message_spec.rb +0 -74
  1006. data/spec/models/save_emergency_contact_message_spec.rb +0 -52
  1007. data/spec/models/task_category_message_spec.rb +0 -52
  1008. data/spec/models/task_category_put_message_spec.rb +0 -34
  1009. data/spec/models/task_category_response_message_spec.rb +0 -52
  1010. data/spec/models/task_category_save_message_spec.rb +0 -34
  1011. data/spec/models/task_history_file_message_spec.rb +0 -64
  1012. data/spec/models/task_history_file_upload_post_message_spec.rb +0 -34
  1013. data/spec/models/task_history_message_spec.rb +0 -112
  1014. data/spec/models/task_history_put_message_spec.rb +0 -34
  1015. data/spec/models/task_history_user_message_spec.rb +0 -52
  1016. data/spec/models/task_search_message_spec.rb +0 -128
  1017. data/spec/models/task_sub_category_message_spec.rb +0 -40
  1018. data/spec/models/tax_information_post_message_spec.rb +0 -62
  1019. data/spec/models/tax_information_save_message_spec.rb +0 -68
  1020. data/spec/models/tenant_message_spec.rb +0 -128
  1021. data/spec/models/tenant_search_message_spec.rb +0 -96
  1022. data/spec/models/to_do_task_message_spec.rb +0 -108
  1023. data/spec/models/to_do_task_post_message_spec.rb +0 -96
  1024. data/spec/models/to_do_task_put_message_spec.rb +0 -96
  1025. data/spec/models/to_do_task_search_message_spec.rb +0 -112
  1026. data/spec/models/undeposited_funds_message_spec.rb +0 -34
  1027. data/spec/models/unit_agreement_message_spec.rb +0 -50
  1028. data/spec/models/user_message_spec.rb +0 -104
  1029. data/spec/models/user_role_message_spec.rb +0 -52
  1030. data/spec/models/user_search_message_spec.rb +0 -66
  1031. data/spec/models/vehicle_message_spec.rb +0 -52
  1032. data/spec/models/vendor_category_message_spec.rb +0 -46
  1033. data/spec/models/vendor_category_save_message_spec.rb +0 -34
  1034. data/spec/models/vendor_credit_line_item_message_spec.rb +0 -58
  1035. data/spec/models/vendor_credit_line_item_post_message_spec.rb +0 -52
  1036. data/spec/models/vendor_credit_message_spec.rb +0 -58
  1037. data/spec/models/vendor_credit_post_message_spec.rb +0 -52
  1038. data/spec/models/vendor_insurance_message_spec.rb +0 -46
  1039. data/spec/models/vendor_insurance_save_message_spec.rb +0 -46
  1040. data/spec/models/vendor_message_spec.rb +0 -130
  1041. data/spec/models/vendor_post_message_spec.rb +0 -118
  1042. data/spec/models/vendor_put_message_spec.rb +0 -118
  1043. data/spec/models/vendor_refund_line_message_spec.rb +0 -58
  1044. data/spec/models/vendor_refund_line_post_message_spec.rb +0 -52
  1045. data/spec/models/vendor_refund_message_spec.rb +0 -74
  1046. data/spec/models/vendor_refund_post_message_spec.rb +0 -68
  1047. data/spec/models/vendor_search_message_spec.rb +0 -84
  1048. data/spec/models/vendor_tax_information_message_spec.rb +0 -68
  1049. data/spec/models/vendor_transaction_message_spec.rb +0 -68
  1050. data/spec/models/vendor_transaction_search_message_spec.rb +0 -62
  1051. data/spec/models/work_order_entry_contact_message_spec.rb +0 -40
  1052. data/spec/models/work_order_entry_contact_resource_message_spec.rb +0 -44
  1053. data/spec/models/work_order_line_item_message_spec.rb +0 -52
  1054. data/spec/models/work_order_line_item_save_message_spec.rb +0 -52
  1055. data/spec/models/work_order_message_spec.rb +0 -110
  1056. data/spec/models/work_order_post_message_spec.rb +0 -98
  1057. data/spec/models/work_order_put_message_spec.rb +0 -86
  1058. data/spec/models/work_order_search_message_spec.rb +0 -158
  1059. data/spec/models/work_order_task_message_spec.rb +0 -88
  1060. data/spec/models/work_order_task_post_message_spec.rb +0 -78
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -20,7 +20,7 @@ module Buildium
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create a lease
23
- # 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`
23
+ # 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.
24
24
  # @param lease_post_message [LeasePostMessage]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [LeaseMessage]
@@ -30,7 +30,7 @@ module Buildium
30
30
  end
31
31
 
32
32
  # Create a lease
33
- # Creates a signed lease. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
33
+ # Creates a signed lease. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Tenants&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;h4&gt;Optional Permissions:&lt;/h4&gt;&lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Applicants&lt;/span&gt; - &#x60;View&#x60; In order to add tenants to the lease using the ApplicantIds property, you must have this permission.
34
34
  # @param lease_post_message [LeasePostMessage]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(LeaseMessage, Integer, Hash)>] LeaseMessage data, response status code and response headers
@@ -87,450 +87,6 @@ module Buildium
87
87
  return data, status_code, headers
88
88
  end
89
89
 
90
- # Create a recurring charge
91
- # 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`
92
- # @param lease_id [Integer]
93
- # @param charge_recurring_transaction_post_message [ChargeRecurringTransactionPostMessage]
94
- # @param [Hash] opts the optional parameters
95
- # @return [LeaseChargeRecurringTransactionMessage]
96
- def create_lease_charge_recurring_transaction(lease_id, charge_recurring_transaction_post_message, opts = {})
97
- data, _status_code, _headers = create_lease_charge_recurring_transaction_with_http_info(lease_id, charge_recurring_transaction_post_message, opts)
98
- data
99
- end
100
-
101
- # Create a recurring charge
102
- # Creates a recurring charge transaction that will post automatically on the specified lease ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
103
- # @param lease_id [Integer]
104
- # @param charge_recurring_transaction_post_message [ChargeRecurringTransactionPostMessage]
105
- # @param [Hash] opts the optional parameters
106
- # @return [Array<(LeaseChargeRecurringTransactionMessage, Integer, Hash)>] LeaseChargeRecurringTransactionMessage data, response status code and response headers
107
- def create_lease_charge_recurring_transaction_with_http_info(lease_id, charge_recurring_transaction_post_message, opts = {})
108
- if @api_client.config.debugging
109
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_charge_recurring_transaction ...'
110
- end
111
- # verify the required parameter 'lease_id' is set
112
- if @api_client.config.client_side_validation && lease_id.nil?
113
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_charge_recurring_transaction"
114
- end
115
- # verify the required parameter 'charge_recurring_transaction_post_message' is set
116
- if @api_client.config.client_side_validation && charge_recurring_transaction_post_message.nil?
117
- fail ArgumentError, "Missing the required parameter 'charge_recurring_transaction_post_message' when calling LeasesApi.create_lease_charge_recurring_transaction"
118
- end
119
- # resource path
120
- local_var_path = '/v1/leases/{leaseId}/recurringcharges'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
121
-
122
- # query parameters
123
- query_params = opts[:query_params] || {}
124
-
125
- # header parameters
126
- header_params = opts[:header_params] || {}
127
- # HTTP header 'Accept' (if needed)
128
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
129
- # HTTP header 'Content-Type'
130
- content_type = @api_client.select_header_content_type(['application/json'])
131
- if !content_type.nil?
132
- header_params['Content-Type'] = content_type
133
- end
134
-
135
- # form parameters
136
- form_params = opts[:form_params] || {}
137
-
138
- # http body (model)
139
- post_body = opts[:debug_body] || @api_client.object_to_http_body(charge_recurring_transaction_post_message)
140
-
141
- # return_type
142
- return_type = opts[:debug_return_type] || 'LeaseChargeRecurringTransactionMessage'
143
-
144
- # auth_names
145
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
146
-
147
- new_options = opts.merge(
148
- :operation => :"LeasesApi.create_lease_charge_recurring_transaction",
149
- :header_params => header_params,
150
- :query_params => query_params,
151
- :form_params => form_params,
152
- :body => post_body,
153
- :auth_names => auth_names,
154
- :return_type => return_type
155
- )
156
-
157
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
158
- if @api_client.config.debugging
159
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_charge_recurring_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
160
- end
161
- return data, status_code, headers
162
- end
163
-
164
- # Create a credit
165
- # Creates a lease ledger credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
166
- # @param lease_id [Integer] The lease unique identifier.
167
- # @param lease_ledger_credit_post_message [LeaseLedgerCreditPostMessage]
168
- # @param [Hash] opts the optional parameters
169
- # @return [LeaseTransactionMessage]
170
- def create_lease_credit(lease_id, lease_ledger_credit_post_message, opts = {})
171
- data, _status_code, _headers = create_lease_credit_with_http_info(lease_id, lease_ledger_credit_post_message, opts)
172
- data
173
- end
174
-
175
- # Create a credit
176
- # Creates a lease ledger credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
177
- # @param lease_id [Integer] The lease unique identifier.
178
- # @param lease_ledger_credit_post_message [LeaseLedgerCreditPostMessage]
179
- # @param [Hash] opts the optional parameters
180
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
181
- def create_lease_credit_with_http_info(lease_id, lease_ledger_credit_post_message, opts = {})
182
- if @api_client.config.debugging
183
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_credit ...'
184
- end
185
- # verify the required parameter 'lease_id' is set
186
- if @api_client.config.client_side_validation && lease_id.nil?
187
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_credit"
188
- end
189
- # verify the required parameter 'lease_ledger_credit_post_message' is set
190
- if @api_client.config.client_side_validation && lease_ledger_credit_post_message.nil?
191
- fail ArgumentError, "Missing the required parameter 'lease_ledger_credit_post_message' when calling LeasesApi.create_lease_credit"
192
- end
193
- # resource path
194
- local_var_path = '/v1/leases/{leaseId}/credits'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
195
-
196
- # query parameters
197
- query_params = opts[:query_params] || {}
198
-
199
- # header parameters
200
- header_params = opts[:header_params] || {}
201
- # HTTP header 'Accept' (if needed)
202
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
203
- # HTTP header 'Content-Type'
204
- content_type = @api_client.select_header_content_type(['application/json'])
205
- if !content_type.nil?
206
- header_params['Content-Type'] = content_type
207
- end
208
-
209
- # form parameters
210
- form_params = opts[:form_params] || {}
211
-
212
- # http body (model)
213
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_ledger_credit_post_message)
214
-
215
- # return_type
216
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
217
-
218
- # auth_names
219
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
220
-
221
- new_options = opts.merge(
222
- :operation => :"LeasesApi.create_lease_credit",
223
- :header_params => header_params,
224
- :query_params => query_params,
225
- :form_params => form_params,
226
- :body => post_body,
227
- :auth_names => auth_names,
228
- :return_type => return_type
229
- )
230
-
231
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
232
- if @api_client.config.debugging
233
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
234
- end
235
- return data, status_code, headers
236
- end
237
-
238
- # Create a recurring credit
239
- # 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`
240
- # @param lease_id [Integer]
241
- # @param credit_recurring_transaction_post_message [CreditRecurringTransactionPostMessage]
242
- # @param [Hash] opts the optional parameters
243
- # @return [LeaseRecurringCreditMessage]
244
- def create_lease_credit_recurring_transaction(lease_id, credit_recurring_transaction_post_message, opts = {})
245
- data, _status_code, _headers = create_lease_credit_recurring_transaction_with_http_info(lease_id, credit_recurring_transaction_post_message, opts)
246
- data
247
- end
248
-
249
- # Create a recurring credit
250
- # Creates a recurring credit transaction on the specified lease ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
251
- # @param lease_id [Integer]
252
- # @param credit_recurring_transaction_post_message [CreditRecurringTransactionPostMessage]
253
- # @param [Hash] opts the optional parameters
254
- # @return [Array<(LeaseRecurringCreditMessage, Integer, Hash)>] LeaseRecurringCreditMessage data, response status code and response headers
255
- def create_lease_credit_recurring_transaction_with_http_info(lease_id, credit_recurring_transaction_post_message, opts = {})
256
- if @api_client.config.debugging
257
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_credit_recurring_transaction ...'
258
- end
259
- # verify the required parameter 'lease_id' is set
260
- if @api_client.config.client_side_validation && lease_id.nil?
261
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_credit_recurring_transaction"
262
- end
263
- # verify the required parameter 'credit_recurring_transaction_post_message' is set
264
- if @api_client.config.client_side_validation && credit_recurring_transaction_post_message.nil?
265
- fail ArgumentError, "Missing the required parameter 'credit_recurring_transaction_post_message' when calling LeasesApi.create_lease_credit_recurring_transaction"
266
- end
267
- # resource path
268
- local_var_path = '/v1/leases/{leaseId}/recurringcredits'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
269
-
270
- # query parameters
271
- query_params = opts[:query_params] || {}
272
-
273
- # header parameters
274
- header_params = opts[:header_params] || {}
275
- # HTTP header 'Accept' (if needed)
276
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
277
- # HTTP header 'Content-Type'
278
- content_type = @api_client.select_header_content_type(['application/json'])
279
- if !content_type.nil?
280
- header_params['Content-Type'] = content_type
281
- end
282
-
283
- # form parameters
284
- form_params = opts[:form_params] || {}
285
-
286
- # http body (model)
287
- post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_recurring_transaction_post_message)
288
-
289
- # return_type
290
- return_type = opts[:debug_return_type] || 'LeaseRecurringCreditMessage'
291
-
292
- # auth_names
293
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
294
-
295
- new_options = opts.merge(
296
- :operation => :"LeasesApi.create_lease_credit_recurring_transaction",
297
- :header_params => header_params,
298
- :query_params => query_params,
299
- :form_params => form_params,
300
- :body => post_body,
301
- :auth_names => auth_names,
302
- :return_type => return_type
303
- )
304
-
305
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
306
- if @api_client.config.debugging
307
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_credit_recurring_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
308
- end
309
- return data, status_code, headers
310
- end
311
-
312
- # Create a charge
313
- # 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`
314
- # @param lease_id [Integer]
315
- # @param lease_charge_post_message [LeaseChargePostMessage]
316
- # @param [Hash] opts the optional parameters
317
- # @return [Array<LeaseTransactionMessage>]
318
- def create_lease_ledger_charge(lease_id, lease_charge_post_message, opts = {})
319
- data, _status_code, _headers = create_lease_ledger_charge_with_http_info(lease_id, lease_charge_post_message, opts)
320
- data
321
- end
322
-
323
- # Create a charge
324
- # Creates a charge transaction on a specific lease ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
325
- # @param lease_id [Integer]
326
- # @param lease_charge_post_message [LeaseChargePostMessage]
327
- # @param [Hash] opts the optional parameters
328
- # @return [Array<(Array<LeaseTransactionMessage>, Integer, Hash)>] Array<LeaseTransactionMessage> data, response status code and response headers
329
- def create_lease_ledger_charge_with_http_info(lease_id, lease_charge_post_message, opts = {})
330
- if @api_client.config.debugging
331
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_ledger_charge ...'
332
- end
333
- # verify the required parameter 'lease_id' is set
334
- if @api_client.config.client_side_validation && lease_id.nil?
335
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_ledger_charge"
336
- end
337
- # verify the required parameter 'lease_charge_post_message' is set
338
- if @api_client.config.client_side_validation && lease_charge_post_message.nil?
339
- fail ArgumentError, "Missing the required parameter 'lease_charge_post_message' when calling LeasesApi.create_lease_ledger_charge"
340
- end
341
- # resource path
342
- local_var_path = '/v1/leases/{leaseId}/charges'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
343
-
344
- # query parameters
345
- query_params = opts[:query_params] || {}
346
-
347
- # header parameters
348
- header_params = opts[:header_params] || {}
349
- # HTTP header 'Accept' (if needed)
350
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
351
- # HTTP header 'Content-Type'
352
- content_type = @api_client.select_header_content_type(['application/json'])
353
- if !content_type.nil?
354
- header_params['Content-Type'] = content_type
355
- end
356
-
357
- # form parameters
358
- form_params = opts[:form_params] || {}
359
-
360
- # http body (model)
361
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_charge_post_message)
362
-
363
- # return_type
364
- return_type = opts[:debug_return_type] || 'Array<LeaseTransactionMessage>'
365
-
366
- # auth_names
367
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
368
-
369
- new_options = opts.merge(
370
- :operation => :"LeasesApi.create_lease_ledger_charge",
371
- :header_params => header_params,
372
- :query_params => query_params,
373
- :form_params => form_params,
374
- :body => post_body,
375
- :auth_names => auth_names,
376
- :return_type => return_type
377
- )
378
-
379
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
380
- if @api_client.config.debugging
381
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_ledger_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
- end
383
- return data, status_code, headers
384
- end
385
-
386
- # Create a deposit withholding
387
- # 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`
388
- # @param lease_id [Integer]
389
- # @param lease_ledger_deposit_withholding_post_message [LeaseLedgerDepositWithholdingPostMessage]
390
- # @param [Hash] opts the optional parameters
391
- # @return [LeaseTransactionMessage]
392
- def create_lease_ledger_deposit_withholding(lease_id, lease_ledger_deposit_withholding_post_message, opts = {})
393
- data, _status_code, _headers = create_lease_ledger_deposit_withholding_with_http_info(lease_id, lease_ledger_deposit_withholding_post_message, opts)
394
- data
395
- end
396
-
397
- # Create a deposit withholding
398
- # Withholds a resident deposit by reallocating the funds from a liability account to an income account to cover an expense(s). &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease Ledger&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Accounting &amp;gt; General Ledger Accounts&lt;/span&gt; - &#x60;View&#x60;
399
- # @param lease_id [Integer]
400
- # @param lease_ledger_deposit_withholding_post_message [LeaseLedgerDepositWithholdingPostMessage]
401
- # @param [Hash] opts the optional parameters
402
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
403
- def create_lease_ledger_deposit_withholding_with_http_info(lease_id, lease_ledger_deposit_withholding_post_message, opts = {})
404
- if @api_client.config.debugging
405
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_ledger_deposit_withholding ...'
406
- end
407
- # verify the required parameter 'lease_id' is set
408
- if @api_client.config.client_side_validation && lease_id.nil?
409
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_ledger_deposit_withholding"
410
- end
411
- # verify the required parameter 'lease_ledger_deposit_withholding_post_message' is set
412
- if @api_client.config.client_side_validation && lease_ledger_deposit_withholding_post_message.nil?
413
- fail ArgumentError, "Missing the required parameter 'lease_ledger_deposit_withholding_post_message' when calling LeasesApi.create_lease_ledger_deposit_withholding"
414
- end
415
- # resource path
416
- local_var_path = '/v1/leases/{leaseId}/applieddeposits'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
417
-
418
- # query parameters
419
- query_params = opts[:query_params] || {}
420
-
421
- # header parameters
422
- header_params = opts[:header_params] || {}
423
- # HTTP header 'Accept' (if needed)
424
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
425
- # HTTP header 'Content-Type'
426
- content_type = @api_client.select_header_content_type(['application/json'])
427
- if !content_type.nil?
428
- header_params['Content-Type'] = content_type
429
- end
430
-
431
- # form parameters
432
- form_params = opts[:form_params] || {}
433
-
434
- # http body (model)
435
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_ledger_deposit_withholding_post_message)
436
-
437
- # return_type
438
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
439
-
440
- # auth_names
441
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
442
-
443
- new_options = opts.merge(
444
- :operation => :"LeasesApi.create_lease_ledger_deposit_withholding",
445
- :header_params => header_params,
446
- :query_params => query_params,
447
- :form_params => form_params,
448
- :body => post_body,
449
- :auth_names => auth_names,
450
- :return_type => return_type
451
- )
452
-
453
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
454
- if @api_client.config.debugging
455
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_ledger_deposit_withholding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
456
- end
457
- return data, status_code, headers
458
- end
459
-
460
- # Create a refund
461
- # Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
462
- # @param lease_id [Integer]
463
- # @param lease_ledger_refund_post_message [LeaseLedgerRefundPostMessage]
464
- # @param [Hash] opts the optional parameters
465
- # @return [LeaseLedgerRefundMessage]
466
- def create_lease_ledger_refund(lease_id, lease_ledger_refund_post_message, opts = {})
467
- data, _status_code, _headers = create_lease_ledger_refund_with_http_info(lease_id, lease_ledger_refund_post_message, opts)
468
- data
469
- end
470
-
471
- # Create a refund
472
- # Creates a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
473
- # @param lease_id [Integer]
474
- # @param lease_ledger_refund_post_message [LeaseLedgerRefundPostMessage]
475
- # @param [Hash] opts the optional parameters
476
- # @return [Array<(LeaseLedgerRefundMessage, Integer, Hash)>] LeaseLedgerRefundMessage data, response status code and response headers
477
- def create_lease_ledger_refund_with_http_info(lease_id, lease_ledger_refund_post_message, opts = {})
478
- if @api_client.config.debugging
479
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_ledger_refund ...'
480
- end
481
- # verify the required parameter 'lease_id' is set
482
- if @api_client.config.client_side_validation && lease_id.nil?
483
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_ledger_refund"
484
- end
485
- # verify the required parameter 'lease_ledger_refund_post_message' is set
486
- if @api_client.config.client_side_validation && lease_ledger_refund_post_message.nil?
487
- fail ArgumentError, "Missing the required parameter 'lease_ledger_refund_post_message' when calling LeasesApi.create_lease_ledger_refund"
488
- end
489
- # resource path
490
- local_var_path = '/v1/leases/{leaseId}/refunds'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
491
-
492
- # query parameters
493
- query_params = opts[:query_params] || {}
494
-
495
- # header parameters
496
- header_params = opts[:header_params] || {}
497
- # HTTP header 'Accept' (if needed)
498
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
499
- # HTTP header 'Content-Type'
500
- content_type = @api_client.select_header_content_type(['application/json'])
501
- if !content_type.nil?
502
- header_params['Content-Type'] = content_type
503
- end
504
-
505
- # form parameters
506
- form_params = opts[:form_params] || {}
507
-
508
- # http body (model)
509
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_ledger_refund_post_message)
510
-
511
- # return_type
512
- return_type = opts[:debug_return_type] || 'LeaseLedgerRefundMessage'
513
-
514
- # auth_names
515
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
516
-
517
- new_options = opts.merge(
518
- :operation => :"LeasesApi.create_lease_ledger_refund",
519
- :header_params => header_params,
520
- :query_params => query_params,
521
- :form_params => form_params,
522
- :body => post_body,
523
- :auth_names => auth_names,
524
- :return_type => return_type
525
- )
526
-
527
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
528
- if @api_client.config.debugging
529
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_ledger_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
530
- end
531
- return data, status_code, headers
532
- end
533
-
534
90
  # Create a note
535
91
  # Creates a lease note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
536
92
  # @param lease_id [Integer]
@@ -605,111 +161,37 @@ module Buildium
605
161
  return data, status_code, headers
606
162
  end
607
163
 
608
- # Create a recurring payment
609
- # 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`
164
+ # Create a lease renewal
165
+ # Creates a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
610
166
  # @param lease_id [Integer]
611
- # @param payment_recurring_transaction_post_message [PaymentRecurringTransactionPostMessage]
167
+ # @param lease_renewal_post_message [LeaseRenewalPostMessage]
612
168
  # @param [Hash] opts the optional parameters
613
- # @return [LeaseRecurringPaymentMessage]
614
- def create_lease_recurring_payment(lease_id, payment_recurring_transaction_post_message, opts = {})
615
- data, _status_code, _headers = create_lease_recurring_payment_with_http_info(lease_id, payment_recurring_transaction_post_message, opts)
169
+ # @return [LeaseRenewalMessage]
170
+ def create_lease_renewal(lease_id, lease_renewal_post_message, opts = {})
171
+ data, _status_code, _headers = create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message, opts)
616
172
  data
617
173
  end
618
174
 
619
- # Create a recurring payment
620
- # Creates a recurring payment that will post automatically on the specified lease ledger. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease Transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
175
+ # Create a lease renewal
176
+ # Creates a lease renewal. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
621
177
  # @param lease_id [Integer]
622
- # @param payment_recurring_transaction_post_message [PaymentRecurringTransactionPostMessage]
623
- # @param [Hash] opts the optional parameters
624
- # @return [Array<(LeaseRecurringPaymentMessage, Integer, Hash)>] LeaseRecurringPaymentMessage data, response status code and response headers
625
- def create_lease_recurring_payment_with_http_info(lease_id, payment_recurring_transaction_post_message, opts = {})
626
- if @api_client.config.debugging
627
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_recurring_payment ...'
628
- end
629
- # verify the required parameter 'lease_id' is set
630
- if @api_client.config.client_side_validation && lease_id.nil?
631
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_recurring_payment"
632
- end
633
- # verify the required parameter 'payment_recurring_transaction_post_message' is set
634
- if @api_client.config.client_side_validation && payment_recurring_transaction_post_message.nil?
635
- fail ArgumentError, "Missing the required parameter 'payment_recurring_transaction_post_message' when calling LeasesApi.create_lease_recurring_payment"
636
- end
637
- # resource path
638
- local_var_path = '/v1/leases/{leaseId}/recurringpayments'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
639
-
640
- # query parameters
641
- query_params = opts[:query_params] || {}
642
-
643
- # header parameters
644
- header_params = opts[:header_params] || {}
645
- # HTTP header 'Accept' (if needed)
646
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
647
- # HTTP header 'Content-Type'
648
- content_type = @api_client.select_header_content_type(['application/json'])
649
- if !content_type.nil?
650
- header_params['Content-Type'] = content_type
651
- end
652
-
653
- # form parameters
654
- form_params = opts[:form_params] || {}
655
-
656
- # http body (model)
657
- post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_recurring_transaction_post_message)
658
-
659
- # return_type
660
- return_type = opts[:debug_return_type] || 'LeaseRecurringPaymentMessage'
661
-
662
- # auth_names
663
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
664
-
665
- new_options = opts.merge(
666
- :operation => :"LeasesApi.create_lease_recurring_payment",
667
- :header_params => header_params,
668
- :query_params => query_params,
669
- :form_params => form_params,
670
- :body => post_body,
671
- :auth_names => auth_names,
672
- :return_type => return_type
673
- )
674
-
675
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
676
- if @api_client.config.debugging
677
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_recurring_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
678
- end
679
- return data, status_code, headers
680
- end
681
-
682
- # Create a payment reversal
683
- # 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`
684
- # @param lease_id [Integer] The lease unique identifier.
685
- # @param lease_ledger_reverse_payment_post_message [LeaseLedgerReversePaymentPostMessage]
686
- # @param [Hash] opts the optional parameters
687
- # @return [LeaseTransactionMessage]
688
- def create_lease_reverse_payment(lease_id, lease_ledger_reverse_payment_post_message, opts = {})
689
- data, _status_code, _headers = create_lease_reverse_payment_with_http_info(lease_id, lease_ledger_reverse_payment_post_message, opts)
690
- data
691
- end
692
-
693
- # Create a payment reversal
694
- # Reverses a lease ledger payment. Note, this action can only be taken on a payment that has been deposited. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
695
- # @param lease_id [Integer] The lease unique identifier.
696
- # @param lease_ledger_reverse_payment_post_message [LeaseLedgerReversePaymentPostMessage]
178
+ # @param lease_renewal_post_message [LeaseRenewalPostMessage]
697
179
  # @param [Hash] opts the optional parameters
698
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
699
- def create_lease_reverse_payment_with_http_info(lease_id, lease_ledger_reverse_payment_post_message, opts = {})
180
+ # @return [Array<(LeaseRenewalMessage, Integer, Hash)>] LeaseRenewalMessage data, response status code and response headers
181
+ def create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message, opts = {})
700
182
  if @api_client.config.debugging
701
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_reverse_payment ...'
183
+ @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_renewal ...'
702
184
  end
703
185
  # verify the required parameter 'lease_id' is set
704
186
  if @api_client.config.client_side_validation && lease_id.nil?
705
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_reverse_payment"
187
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_lease_renewal"
706
188
  end
707
- # verify the required parameter 'lease_ledger_reverse_payment_post_message' is set
708
- if @api_client.config.client_side_validation && lease_ledger_reverse_payment_post_message.nil?
709
- fail ArgumentError, "Missing the required parameter 'lease_ledger_reverse_payment_post_message' when calling LeasesApi.create_lease_reverse_payment"
189
+ # verify the required parameter 'lease_renewal_post_message' is set
190
+ if @api_client.config.client_side_validation && lease_renewal_post_message.nil?
191
+ fail ArgumentError, "Missing the required parameter 'lease_renewal_post_message' when calling LeasesApi.create_lease_renewal"
710
192
  end
711
193
  # resource path
712
- local_var_path = '/v1/leases/{leaseId}/reversepayments'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
194
+ local_var_path = '/v1/leases/{leaseId}/renewals'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
713
195
 
714
196
  # query parameters
715
197
  query_params = opts[:query_params] || {}
@@ -728,16 +210,16 @@ module Buildium
728
210
  form_params = opts[:form_params] || {}
729
211
 
730
212
  # http body (model)
731
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_ledger_reverse_payment_post_message)
213
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_renewal_post_message)
732
214
 
733
215
  # return_type
734
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
216
+ return_type = opts[:debug_return_type] || 'LeaseRenewalMessage'
735
217
 
736
218
  # auth_names
737
219
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
738
220
 
739
221
  new_options = opts.merge(
740
- :operation => :"LeasesApi.create_lease_reverse_payment",
222
+ :operation => :"LeasesApi.create_lease_renewal",
741
223
  :header_params => header_params,
742
224
  :query_params => query_params,
743
225
  :form_params => form_params,
@@ -748,7 +230,7 @@ module Buildium
748
230
 
749
231
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
750
232
  if @api_client.config.debugging
751
- @api_client.config.logger.debug "API called: LeasesApi#create_lease_reverse_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ @api_client.config.logger.debug "API called: LeasesApi#create_lease_renewal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
752
234
  end
753
235
  return data, status_code, headers
754
236
  end
@@ -827,177 +309,43 @@ module Buildium
827
309
  return data, status_code, headers
828
310
  end
829
311
 
830
- # Create a payment
831
- # Creates a lease ledger payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
832
- # @param lease_id [Integer] The lease unique identifier.
833
- # @param lease_ledger_payment_post_message [LeaseLedgerPaymentPostMessage]
834
- # @param [Hash] opts the optional parameters
835
- # @return [LeaseTransactionMessage]
836
- def create_payment(lease_id, lease_ledger_payment_post_message, opts = {})
837
- data, _status_code, _headers = create_payment_with_http_info(lease_id, lease_ledger_payment_post_message, opts)
838
- data
839
- end
840
-
841
- # Create a payment
842
- # Creates a lease ledger payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
843
- # @param lease_id [Integer] The lease unique identifier.
844
- # @param lease_ledger_payment_post_message [LeaseLedgerPaymentPostMessage]
845
- # @param [Hash] opts the optional parameters
846
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
847
- def create_payment_with_http_info(lease_id, lease_ledger_payment_post_message, opts = {})
848
- if @api_client.config.debugging
849
- @api_client.config.logger.debug 'Calling API: LeasesApi.create_payment ...'
850
- end
851
- # verify the required parameter 'lease_id' is set
852
- if @api_client.config.client_side_validation && lease_id.nil?
853
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.create_payment"
854
- end
855
- # verify the required parameter 'lease_ledger_payment_post_message' is set
856
- if @api_client.config.client_side_validation && lease_ledger_payment_post_message.nil?
857
- fail ArgumentError, "Missing the required parameter 'lease_ledger_payment_post_message' when calling LeasesApi.create_payment"
858
- end
859
- # resource path
860
- local_var_path = '/v1/leases/{leaseId}/payments'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
861
-
862
- # query parameters
863
- query_params = opts[:query_params] || {}
864
-
865
- # header parameters
866
- header_params = opts[:header_params] || {}
867
- # HTTP header 'Accept' (if needed)
868
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
869
- # HTTP header 'Content-Type'
870
- content_type = @api_client.select_header_content_type(['application/json'])
871
- if !content_type.nil?
872
- header_params['Content-Type'] = content_type
873
- end
874
-
875
- # form parameters
876
- form_params = opts[:form_params] || {}
877
-
878
- # http body (model)
879
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_ledger_payment_post_message)
880
-
881
- # return_type
882
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
883
-
884
- # auth_names
885
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
886
-
887
- new_options = opts.merge(
888
- :operation => :"LeasesApi.create_payment",
889
- :header_params => header_params,
890
- :query_params => query_params,
891
- :form_params => form_params,
892
- :body => post_body,
893
- :auth_names => auth_names,
894
- :return_type => return_type
895
- )
896
-
897
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
898
- if @api_client.config.debugging
899
- @api_client.config.logger.debug "API called: LeasesApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
900
- end
901
- return data, status_code, headers
902
- end
903
-
904
- # Retrieve a lease
905
- # Retrieves a specific lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
906
- # @param lease_id [Integer] The lease identifier.
907
- # @param [Hash] opts the optional parameters
908
- # @return [LeaseMessage]
909
- def get_lease_by_id(lease_id, opts = {})
910
- data, _status_code, _headers = get_lease_by_id_with_http_info(lease_id, opts)
911
- data
912
- end
913
-
914
- # Retrieve a lease
915
- # Retrieves a specific lease. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
916
- # @param lease_id [Integer] The lease identifier.
917
- # @param [Hash] opts the optional parameters
918
- # @return [Array<(LeaseMessage, Integer, Hash)>] LeaseMessage data, response status code and response headers
919
- def get_lease_by_id_with_http_info(lease_id, opts = {})
920
- if @api_client.config.debugging
921
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_by_id ...'
922
- end
923
- # verify the required parameter 'lease_id' is set
924
- if @api_client.config.client_side_validation && lease_id.nil?
925
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_by_id"
926
- end
927
- # resource path
928
- local_var_path = '/v1/leases/{leaseId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
929
-
930
- # query parameters
931
- query_params = opts[:query_params] || {}
932
-
933
- # header parameters
934
- header_params = opts[:header_params] || {}
935
- # HTTP header 'Accept' (if needed)
936
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
937
-
938
- # form parameters
939
- form_params = opts[:form_params] || {}
940
-
941
- # http body (model)
942
- post_body = opts[:debug_body]
943
-
944
- # return_type
945
- return_type = opts[:debug_return_type] || 'LeaseMessage'
946
-
947
- # auth_names
948
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
949
-
950
- new_options = opts.merge(
951
- :operation => :"LeasesApi.get_lease_by_id",
952
- :header_params => header_params,
953
- :query_params => query_params,
954
- :form_params => form_params,
955
- :body => post_body,
956
- :auth_names => auth_names,
957
- :return_type => return_type
958
- )
959
-
960
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
961
- if @api_client.config.debugging
962
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
963
- end
964
- return data, status_code, headers
965
- end
966
-
967
- # Retrieve a recurring charge
968
- # Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
312
+ # Retrieve all renewals
313
+ # Retrieves all renewals for a specific a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
969
314
  # @param lease_id [Integer]
970
- # @param transaction_id [Integer]
971
315
  # @param [Hash] opts the optional parameters
972
- # @return [LeaseChargeRecurringTransactionMessage]
973
- def get_lease_charge_recurring_transaction_by_id(lease_id, transaction_id, opts = {})
974
- data, _status_code, _headers = get_lease_charge_recurring_transaction_by_id_with_http_info(lease_id, transaction_id, opts)
316
+ # @option opts [String] :orderby &#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.
317
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
318
+ # @option opts [Integer] :limit &#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.
319
+ # @return [Array<LeaseRenewalMessage>]
320
+ def get_all_lease_renewals(lease_id, opts = {})
321
+ data, _status_code, _headers = get_all_lease_renewals_with_http_info(lease_id, opts)
975
322
  data
976
323
  end
977
324
 
978
- # Retrieve a recurring charge
979
- # Retrieves a recurring charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60;
325
+ # Retrieve all renewals
326
+ # Retrieves all renewals for a specific a lease. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
980
327
  # @param lease_id [Integer]
981
- # @param transaction_id [Integer]
982
328
  # @param [Hash] opts the optional parameters
983
- # @return [Array<(LeaseChargeRecurringTransactionMessage, Integer, Hash)>] LeaseChargeRecurringTransactionMessage data, response status code and response headers
984
- def get_lease_charge_recurring_transaction_by_id_with_http_info(lease_id, transaction_id, opts = {})
329
+ # @option opts [String] :orderby &#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.
330
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
331
+ # @option opts [Integer] :limit &#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.
332
+ # @return [Array<(Array<LeaseRenewalMessage>, Integer, Hash)>] Array<LeaseRenewalMessage> data, response status code and response headers
333
+ def get_all_lease_renewals_with_http_info(lease_id, opts = {})
985
334
  if @api_client.config.debugging
986
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_charge_recurring_transaction_by_id ...'
335
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_all_lease_renewals ...'
987
336
  end
988
337
  # verify the required parameter 'lease_id' is set
989
338
  if @api_client.config.client_side_validation && lease_id.nil?
990
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_charge_recurring_transaction_by_id"
991
- end
992
- # verify the required parameter 'transaction_id' is set
993
- if @api_client.config.client_side_validation && transaction_id.nil?
994
- fail ArgumentError, "Missing the required parameter 'transaction_id' when calling LeasesApi.get_lease_charge_recurring_transaction_by_id"
339
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_all_lease_renewals"
995
340
  end
996
341
  # resource path
997
- local_var_path = '/v1/leases/{leaseId}/recurringcharges/{transactionId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s))
342
+ local_var_path = '/v1/leases/{leaseId}/renewals'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
998
343
 
999
344
  # query parameters
1000
345
  query_params = opts[:query_params] || {}
346
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
347
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
348
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1001
349
 
1002
350
  # header parameters
1003
351
  header_params = opts[:header_params] || {}
@@ -1011,13 +359,13 @@ module Buildium
1011
359
  post_body = opts[:debug_body]
1012
360
 
1013
361
  # return_type
1014
- return_type = opts[:debug_return_type] || 'LeaseChargeRecurringTransactionMessage'
362
+ return_type = opts[:debug_return_type] || 'Array<LeaseRenewalMessage>'
1015
363
 
1016
364
  # auth_names
1017
365
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1018
366
 
1019
367
  new_options = opts.merge(
1020
- :operation => :"LeasesApi.get_lease_charge_recurring_transaction_by_id",
368
+ :operation => :"LeasesApi.get_all_lease_renewals",
1021
369
  :header_params => header_params,
1022
370
  :query_params => query_params,
1023
371
  :form_params => form_params,
@@ -1028,45 +376,55 @@ module Buildium
1028
376
 
1029
377
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1030
378
  if @api_client.config.debugging
1031
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_charge_recurring_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
379
+ @api_client.config.logger.debug "API called: LeasesApi#get_all_lease_renewals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1032
380
  end
1033
381
  return data, status_code, headers
1034
382
  end
1035
383
 
1036
- # Retrieve a refund
1037
- # Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
1038
- # @param lease_id [Integer]
1039
- # @param refund_id [Integer]
384
+ # Retrieve all upcoming renewals
385
+ # Retrieves all upcoming lease renewals across all rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
386
+ # @param esignaturestatuses [Array<String>] Filters result to any lease renewal with an esignature status that matches the given statuses.
1040
387
  # @param [Hash] opts the optional parameters
1041
- # @return [LeaseLedgerRefundMessage]
1042
- def get_lease_ledger_refund_by_id(lease_id, refund_id, opts = {})
1043
- data, _status_code, _headers = get_lease_ledger_refund_by_id_with_http_info(lease_id, refund_id, opts)
388
+ # @option opts [Array<Integer>] :propertyids Filters results to only include leases whose unit belongs to the specified set of property ids.
389
+ # @option opts [Array<Integer>] :rentalownerids Filters results to any lease whose unit belongs to a property with rental owner in the specified set of rental owner ids.
390
+ # @option opts [String] :orderby &#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.
391
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
392
+ # @option opts [Integer] :limit &#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.
393
+ # @return [Array<LeaseRenewalMessage>]
394
+ def get_all_lease_renewals_for_all_properties(esignaturestatuses, opts = {})
395
+ data, _status_code, _headers = get_all_lease_renewals_for_all_properties_with_http_info(esignaturestatuses, opts)
1044
396
  data
1045
397
  end
1046
398
 
1047
- # Retrieve a refund
1048
- # Retrieves a refund. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Accounting &amp;gt; Bank Accounts&lt;/span&gt; - &#x60;View&#x60;
1049
- # @param lease_id [Integer]
1050
- # @param refund_id [Integer]
399
+ # Retrieve all upcoming renewals
400
+ # Retrieves all upcoming lease renewals across all rental properties. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
401
+ # @param esignaturestatuses [Array<String>] Filters result to any lease renewal with an esignature status that matches the given statuses.
1051
402
  # @param [Hash] opts the optional parameters
1052
- # @return [Array<(LeaseLedgerRefundMessage, Integer, Hash)>] LeaseLedgerRefundMessage data, response status code and response headers
1053
- def get_lease_ledger_refund_by_id_with_http_info(lease_id, refund_id, opts = {})
403
+ # @option opts [Array<Integer>] :propertyids Filters results to only include leases whose unit belongs to the specified set of property ids.
404
+ # @option opts [Array<Integer>] :rentalownerids Filters results to any lease whose unit belongs to a property with rental owner in the specified set of rental owner ids.
405
+ # @option opts [String] :orderby &#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.
406
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
407
+ # @option opts [Integer] :limit &#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.
408
+ # @return [Array<(Array<LeaseRenewalMessage>, Integer, Hash)>] Array<LeaseRenewalMessage> data, response status code and response headers
409
+ def get_all_lease_renewals_for_all_properties_with_http_info(esignaturestatuses, opts = {})
1054
410
  if @api_client.config.debugging
1055
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_ledger_refund_by_id ...'
1056
- end
1057
- # verify the required parameter 'lease_id' is set
1058
- if @api_client.config.client_side_validation && lease_id.nil?
1059
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_ledger_refund_by_id"
411
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_all_lease_renewals_for_all_properties ...'
1060
412
  end
1061
- # verify the required parameter 'refund_id' is set
1062
- if @api_client.config.client_side_validation && refund_id.nil?
1063
- fail ArgumentError, "Missing the required parameter 'refund_id' when calling LeasesApi.get_lease_ledger_refund_by_id"
413
+ # verify the required parameter 'esignaturestatuses' is set
414
+ if @api_client.config.client_side_validation && esignaturestatuses.nil?
415
+ fail ArgumentError, "Missing the required parameter 'esignaturestatuses' when calling LeasesApi.get_all_lease_renewals_for_all_properties"
1064
416
  end
1065
417
  # resource path
1066
- local_var_path = '/v1/leases/{leaseId}/refunds/{refundId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'refundId' + '}', CGI.escape(refund_id.to_s))
418
+ local_var_path = '/v1/leases/renewals'
1067
419
 
1068
420
  # query parameters
1069
421
  query_params = opts[:query_params] || {}
422
+ query_params[:'esignaturestatuses'] = @api_client.build_collection_param(esignaturestatuses, :multi)
423
+ query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil?
424
+ query_params[:'rentalownerids'] = @api_client.build_collection_param(opts[:'rentalownerids'], :multi) if !opts[:'rentalownerids'].nil?
425
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
426
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
427
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1070
428
 
1071
429
  # header parameters
1072
430
  header_params = opts[:header_params] || {}
@@ -1080,13 +438,13 @@ module Buildium
1080
438
  post_body = opts[:debug_body]
1081
439
 
1082
440
  # return_type
1083
- return_type = opts[:debug_return_type] || 'LeaseLedgerRefundMessage'
441
+ return_type = opts[:debug_return_type] || 'Array<LeaseRenewalMessage>'
1084
442
 
1085
443
  # auth_names
1086
444
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1087
445
 
1088
446
  new_options = opts.merge(
1089
- :operation => :"LeasesApi.get_lease_ledger_refund_by_id",
447
+ :operation => :"LeasesApi.get_all_lease_renewals_for_all_properties",
1090
448
  :header_params => header_params,
1091
449
  :query_params => query_params,
1092
450
  :form_params => form_params,
@@ -1097,42 +455,36 @@ module Buildium
1097
455
 
1098
456
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1099
457
  if @api_client.config.debugging
1100
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_ledger_refund_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
458
+ @api_client.config.logger.debug "API called: LeasesApi#get_all_lease_renewals_for_all_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1101
459
  end
1102
460
  return data, status_code, headers
1103
461
  end
1104
462
 
1105
- # Retrieve a lease transaction
1106
- # Retrieves a specific lease transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Transactions</span> - `View`
1107
- # @param lease_id [Integer]
1108
- # @param transaction_id [Integer]
463
+ # Retrieve a lease
464
+ # Retrieves a specific lease. <br /><br /><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
465
+ # @param lease_id [Integer] The lease identifier.
1109
466
  # @param [Hash] opts the optional parameters
1110
- # @return [LeaseTransactionMessage]
1111
- def get_lease_ledger_transaction_by_id(lease_id, transaction_id, opts = {})
1112
- data, _status_code, _headers = get_lease_ledger_transaction_by_id_with_http_info(lease_id, transaction_id, opts)
467
+ # @return [LeaseMessage]
468
+ def get_lease_by_id(lease_id, opts = {})
469
+ data, _status_code, _headers = get_lease_by_id_with_http_info(lease_id, opts)
1113
470
  data
1114
471
  end
1115
472
 
1116
- # Retrieve a lease transaction
1117
- # Retrieves a specific lease transaction. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease Transactions&lt;/span&gt; - &#x60;View&#x60;
1118
- # @param lease_id [Integer]
1119
- # @param transaction_id [Integer]
473
+ # Retrieve a lease
474
+ # Retrieves a specific lease. &lt;br /&gt;&lt;br /&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
475
+ # @param lease_id [Integer] The lease identifier.
1120
476
  # @param [Hash] opts the optional parameters
1121
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
1122
- def get_lease_ledger_transaction_by_id_with_http_info(lease_id, transaction_id, opts = {})
477
+ # @return [Array<(LeaseMessage, Integer, Hash)>] LeaseMessage data, response status code and response headers
478
+ def get_lease_by_id_with_http_info(lease_id, opts = {})
1123
479
  if @api_client.config.debugging
1124
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_ledger_transaction_by_id ...'
480
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_by_id ...'
1125
481
  end
1126
482
  # verify the required parameter 'lease_id' is set
1127
483
  if @api_client.config.client_side_validation && lease_id.nil?
1128
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_ledger_transaction_by_id"
1129
- end
1130
- # verify the required parameter 'transaction_id' is set
1131
- if @api_client.config.client_side_validation && transaction_id.nil?
1132
- fail ArgumentError, "Missing the required parameter 'transaction_id' when calling LeasesApi.get_lease_ledger_transaction_by_id"
484
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_by_id"
1133
485
  end
1134
486
  # resource path
1135
- local_var_path = '/v1/leases/{leaseId}/transactions/{transactionId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s))
487
+ local_var_path = '/v1/leases/{leaseId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
1136
488
 
1137
489
  # query parameters
1138
490
  query_params = opts[:query_params] || {}
@@ -1149,13 +501,13 @@ module Buildium
1149
501
  post_body = opts[:debug_body]
1150
502
 
1151
503
  # return_type
1152
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
504
+ return_type = opts[:debug_return_type] || 'LeaseMessage'
1153
505
 
1154
506
  # auth_names
1155
507
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1156
508
 
1157
509
  new_options = opts.merge(
1158
- :operation => :"LeasesApi.get_lease_ledger_transaction_by_id",
510
+ :operation => :"LeasesApi.get_lease_by_id",
1159
511
  :header_params => header_params,
1160
512
  :query_params => query_params,
1161
513
  :form_params => form_params,
@@ -1166,61 +518,39 @@ module Buildium
1166
518
 
1167
519
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1168
520
  if @api_client.config.debugging
1169
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_ledger_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
521
+ @api_client.config.logger.debug "API called: LeasesApi#get_lease_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1170
522
  end
1171
523
  return data, status_code, headers
1172
524
  end
1173
525
 
1174
- # Retrieve all lease transactions
1175
- # Retrieves all the transactions for a specific lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
526
+ # Retrieve ePay settings
527
+ # Retrieves ePay settings for a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1176
528
  # @param lease_id [Integer]
1177
529
  # @param [Hash] opts the optional parameters
1178
- # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value.
1179
- # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value.
1180
- # @option opts [Array<String>] :transactiontypes 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.
1181
- # @option opts [String] :orderby &#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.
1182
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1183
- # @option opts [Integer] :limit &#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.
1184
- # @return [Array<LeaseTransactionMessage>]
1185
- def get_lease_ledgers(lease_id, opts = {})
1186
- data, _status_code, _headers = get_lease_ledgers_with_http_info(lease_id, opts)
530
+ # @return [EPaySettingsMessage]
531
+ def get_lease_epay_settings_by_id(lease_id, opts = {})
532
+ data, _status_code, _headers = get_lease_epay_settings_by_id_with_http_info(lease_id, opts)
1187
533
  data
1188
534
  end
1189
535
 
1190
- # Retrieve all lease transactions
1191
- # Retrieves all the transactions for a specific lease. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60;
536
+ # Retrieve ePay settings
537
+ # Retrieves ePay settings for a lease. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
1192
538
  # @param lease_id [Integer]
1193
539
  # @param [Hash] opts the optional parameters
1194
- # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value.
1195
- # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value.
1196
- # @option opts [Array<String>] :transactiontypes 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.
1197
- # @option opts [String] :orderby &#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.
1198
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1199
- # @option opts [Integer] :limit &#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.
1200
- # @return [Array<(Array<LeaseTransactionMessage>, Integer, Hash)>] Array<LeaseTransactionMessage> data, response status code and response headers
1201
- def get_lease_ledgers_with_http_info(lease_id, opts = {})
540
+ # @return [Array<(EPaySettingsMessage, Integer, Hash)>] EPaySettingsMessage data, response status code and response headers
541
+ def get_lease_epay_settings_by_id_with_http_info(lease_id, opts = {})
1202
542
  if @api_client.config.debugging
1203
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_ledgers ...'
543
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_epay_settings_by_id ...'
1204
544
  end
1205
545
  # verify the required parameter 'lease_id' is set
1206
546
  if @api_client.config.client_side_validation && lease_id.nil?
1207
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_ledgers"
1208
- end
1209
- allowable_values = ["Bill", "Check", "Charge", "Payment", "Credit", "Refund", "ApplyDeposit", "ElectronicFundsTransfer", "Other", "Deposit", "GeneralJournalEntry", "OwnerContribution", "ReversePayment", "ReverseElectronicFundsTransfer", "VendorCredit", "RentalApplicationFeePayment", "ReverseRentalApplicationFeePayment", "ReverseOwnerContribution", "VendorRefund", "UnreversedPayment", "UnreversedElectronicFundsTransfer", "UnreversedOwnerContribution", "UnreversedRentalApplicationFeePayment"]
1210
- if @api_client.config.client_side_validation && opts[:'transactiontypes'] && !opts[:'transactiontypes'].all? { |item| allowable_values.include?(item) }
1211
- fail ArgumentError, "invalid value for \"transactiontypes\", must include one of #{allowable_values}"
547
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_epay_settings_by_id"
1212
548
  end
1213
549
  # resource path
1214
- local_var_path = '/v1/leases/{leaseId}/transactions'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
550
+ local_var_path = '/v1/leases/{leaseId}/epaysettings'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
1215
551
 
1216
- # query parameters
1217
- query_params = opts[:query_params] || {}
1218
- query_params[:'transactiondatefrom'] = opts[:'transactiondatefrom'] if !opts[:'transactiondatefrom'].nil?
1219
- query_params[:'transactiondateto'] = opts[:'transactiondateto'] if !opts[:'transactiondateto'].nil?
1220
- query_params[:'transactiontypes'] = @api_client.build_collection_param(opts[:'transactiontypes'], :multi) if !opts[:'transactiontypes'].nil?
1221
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1222
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1223
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
552
+ # query parameters
553
+ query_params = opts[:query_params] || {}
1224
554
 
1225
555
  # header parameters
1226
556
  header_params = opts[:header_params] || {}
@@ -1234,13 +564,13 @@ module Buildium
1234
564
  post_body = opts[:debug_body]
1235
565
 
1236
566
  # return_type
1237
- return_type = opts[:debug_return_type] || 'Array<LeaseTransactionMessage>'
567
+ return_type = opts[:debug_return_type] || 'EPaySettingsMessage'
1238
568
 
1239
569
  # auth_names
1240
570
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1241
571
 
1242
572
  new_options = opts.merge(
1243
- :operation => :"LeasesApi.get_lease_ledgers",
573
+ :operation => :"LeasesApi.get_lease_epay_settings_by_id",
1244
574
  :header_params => header_params,
1245
575
  :query_params => query_params,
1246
576
  :form_params => form_params,
@@ -1251,7 +581,7 @@ module Buildium
1251
581
 
1252
582
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1253
583
  if @api_client.config.debugging
1254
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_ledgers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
584
+ @api_client.config.logger.debug "API called: LeasesApi#get_lease_epay_settings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1255
585
  end
1256
586
  return data, status_code, headers
1257
587
  end
@@ -1547,219 +877,40 @@ module Buildium
1547
877
  return data, status_code, headers
1548
878
  end
1549
879
 
1550
- # Retrieve all outstanding balances
1551
- # Retrieves a list of lease outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Outstanding Balances</span> - `View`
1552
- # @param [Hash] opts the optional parameters
1553
- # @option opts [String] :entitytype
1554
- # @option opts [Integer] :entityid
1555
- # @option opts [Array<String>] :leasestatuses
1556
- # @option opts [Array<Integer>] :leaseids
1557
- # @option opts [String] :pastdueemail
1558
- # @option opts [String] :balanceduration
1559
- # @option opts [String] :evictionstatus
1560
- # @option opts [String] :orderby &#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.
1561
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1562
- # @option opts [Integer] :limit &#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.
1563
- # @return [Array<LeaseOutstandingBalanceMessage>]
1564
- def get_lease_outstanding_balances(opts = {})
1565
- data, _status_code, _headers = get_lease_outstanding_balances_with_http_info(opts)
1566
- data
1567
- end
1568
-
1569
- # Retrieve all outstanding balances
1570
- # Retrieves a list of lease outstanding balances. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Outstanding Balances&lt;/span&gt; - &#x60;View&#x60;
1571
- # @param [Hash] opts the optional parameters
1572
- # @option opts [String] :entitytype
1573
- # @option opts [Integer] :entityid
1574
- # @option opts [Array<String>] :leasestatuses
1575
- # @option opts [Array<Integer>] :leaseids
1576
- # @option opts [String] :pastdueemail
1577
- # @option opts [String] :balanceduration
1578
- # @option opts [String] :evictionstatus
1579
- # @option opts [String] :orderby &#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.
1580
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1581
- # @option opts [Integer] :limit &#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.
1582
- # @return [Array<(Array<LeaseOutstandingBalanceMessage>, Integer, Hash)>] Array<LeaseOutstandingBalanceMessage> data, response status code and response headers
1583
- def get_lease_outstanding_balances_with_http_info(opts = {})
1584
- if @api_client.config.debugging
1585
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_outstanding_balances ...'
1586
- end
1587
- allowable_values = ["Rental", "RentalOwner"]
1588
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
1589
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
1590
- end
1591
- allowable_values = ["Active", "Past", "Future"]
1592
- if @api_client.config.client_side_validation && opts[:'leasestatuses'] && !opts[:'leasestatuses'].all? { |item| allowable_values.include?(item) }
1593
- fail ArgumentError, "invalid value for \"leasestatuses\", must include one of #{allowable_values}"
1594
- end
1595
- allowable_values = ["NoEmailAddress", "Sent"]
1596
- if @api_client.config.client_side_validation && opts[:'pastdueemail'] && !allowable_values.include?(opts[:'pastdueemail'])
1597
- fail ArgumentError, "invalid value for \"pastdueemail\", must be one of #{allowable_values}"
1598
- end
1599
- allowable_values = ["TotalBalance", "Balance0to30Days", "Balance31to60Days", "Balance61to90Days", "BalanceOver90Days"]
1600
- if @api_client.config.client_side_validation && opts[:'balanceduration'] && !allowable_values.include?(opts[:'balanceduration'])
1601
- fail ArgumentError, "invalid value for \"balanceduration\", must be one of #{allowable_values}"
1602
- end
1603
- allowable_values = ["NotEvictionPending", "EvictionPending"]
1604
- if @api_client.config.client_side_validation && opts[:'evictionstatus'] && !allowable_values.include?(opts[:'evictionstatus'])
1605
- fail ArgumentError, "invalid value for \"evictionstatus\", must be one of #{allowable_values}"
1606
- end
1607
- # resource path
1608
- local_var_path = '/v1/leases/outstandingbalances'
1609
-
1610
- # query parameters
1611
- query_params = opts[:query_params] || {}
1612
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
1613
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
1614
- query_params[:'leasestatuses'] = @api_client.build_collection_param(opts[:'leasestatuses'], :multi) if !opts[:'leasestatuses'].nil?
1615
- query_params[:'leaseids'] = @api_client.build_collection_param(opts[:'leaseids'], :multi) if !opts[:'leaseids'].nil?
1616
- query_params[:'pastdueemail'] = opts[:'pastdueemail'] if !opts[:'pastdueemail'].nil?
1617
- query_params[:'balanceduration'] = opts[:'balanceduration'] if !opts[:'balanceduration'].nil?
1618
- query_params[:'evictionstatus'] = opts[:'evictionstatus'] if !opts[:'evictionstatus'].nil?
1619
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1620
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1621
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1622
-
1623
- # header parameters
1624
- header_params = opts[:header_params] || {}
1625
- # HTTP header 'Accept' (if needed)
1626
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1627
-
1628
- # form parameters
1629
- form_params = opts[:form_params] || {}
1630
-
1631
- # http body (model)
1632
- post_body = opts[:debug_body]
1633
-
1634
- # return_type
1635
- return_type = opts[:debug_return_type] || 'Array<LeaseOutstandingBalanceMessage>'
1636
-
1637
- # auth_names
1638
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1639
-
1640
- new_options = opts.merge(
1641
- :operation => :"LeasesApi.get_lease_outstanding_balances",
1642
- :header_params => header_params,
1643
- :query_params => query_params,
1644
- :form_params => form_params,
1645
- :body => post_body,
1646
- :auth_names => auth_names,
1647
- :return_type => return_type
1648
- )
1649
-
1650
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1651
- if @api_client.config.debugging
1652
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_outstanding_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1653
- end
1654
- return data, status_code, headers
1655
- end
1656
-
1657
- # Retrieve a recurring credit
1658
- # Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
880
+ # Retrieve a renewal
881
+ # Retrieves a specific renewal for a given lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1659
882
  # @param lease_id [Integer]
1660
- # @param transaction_id [Integer]
883
+ # @param renewal_id [Integer]
1661
884
  # @param [Hash] opts the optional parameters
1662
- # @return [LeaseRecurringCreditMessage]
1663
- def get_lease_recurring_credit_by_id(lease_id, transaction_id, opts = {})
1664
- data, _status_code, _headers = get_lease_recurring_credit_by_id_with_http_info(lease_id, transaction_id, opts)
885
+ # @return [LeaseRenewalMessage]
886
+ def get_lease_renewal_by_id(lease_id, renewal_id, opts = {})
887
+ data, _status_code, _headers = get_lease_renewal_by_id_with_http_info(lease_id, renewal_id, opts)
1665
888
  data
1666
889
  end
1667
890
 
1668
- # Retrieve a recurring credit
1669
- # Retrieves a recurring credit. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60;
891
+ # Retrieve a renewal
892
+ # Retrieves a specific renewal for a given lease. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
1670
893
  # @param lease_id [Integer]
1671
- # @param transaction_id [Integer]
894
+ # @param renewal_id [Integer]
1672
895
  # @param [Hash] opts the optional parameters
1673
- # @return [Array<(LeaseRecurringCreditMessage, Integer, Hash)>] LeaseRecurringCreditMessage data, response status code and response headers
1674
- def get_lease_recurring_credit_by_id_with_http_info(lease_id, transaction_id, opts = {})
896
+ # @return [Array<(LeaseRenewalMessage, Integer, Hash)>] LeaseRenewalMessage data, response status code and response headers
897
+ def get_lease_renewal_by_id_with_http_info(lease_id, renewal_id, opts = {})
1675
898
  if @api_client.config.debugging
1676
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_recurring_credit_by_id ...'
899
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_renewal_by_id ...'
1677
900
  end
1678
901
  # verify the required parameter 'lease_id' is set
1679
902
  if @api_client.config.client_side_validation && lease_id.nil?
1680
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_recurring_credit_by_id"
1681
- end
1682
- # verify the required parameter 'transaction_id' is set
1683
- if @api_client.config.client_side_validation && transaction_id.nil?
1684
- fail ArgumentError, "Missing the required parameter 'transaction_id' when calling LeasesApi.get_lease_recurring_credit_by_id"
1685
- end
1686
- # resource path
1687
- local_var_path = '/v1/leases/{leaseId}/recurringcredits/{transactionId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s))
1688
-
1689
- # query parameters
1690
- query_params = opts[:query_params] || {}
1691
-
1692
- # header parameters
1693
- header_params = opts[:header_params] || {}
1694
- # HTTP header 'Accept' (if needed)
1695
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1696
-
1697
- # form parameters
1698
- form_params = opts[:form_params] || {}
1699
-
1700
- # http body (model)
1701
- post_body = opts[:debug_body]
1702
-
1703
- # return_type
1704
- return_type = opts[:debug_return_type] || 'LeaseRecurringCreditMessage'
1705
-
1706
- # auth_names
1707
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1708
-
1709
- new_options = opts.merge(
1710
- :operation => :"LeasesApi.get_lease_recurring_credit_by_id",
1711
- :header_params => header_params,
1712
- :query_params => query_params,
1713
- :form_params => form_params,
1714
- :body => post_body,
1715
- :auth_names => auth_names,
1716
- :return_type => return_type
1717
- )
1718
-
1719
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1720
- if @api_client.config.debugging
1721
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_recurring_credit_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1722
- end
1723
- return data, status_code, headers
1724
- end
1725
-
1726
- # Retrieve all recurring transactions
1727
- # Retrieves all recurring transactions. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1728
- # @param lease_id [Integer]
1729
- # @param [Hash] opts the optional parameters
1730
- # @option opts [String] :orderby &#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.
1731
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1732
- # @option opts [Integer] :limit &#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.
1733
- # @return [Array<RecurringTransactionMessage>]
1734
- def get_lease_recurring_transactions(lease_id, opts = {})
1735
- data, _status_code, _headers = get_lease_recurring_transactions_with_http_info(lease_id, opts)
1736
- data
1737
- end
1738
-
1739
- # Retrieve all recurring transactions
1740
- # Retrieves all recurring transactions. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60;
1741
- # @param lease_id [Integer]
1742
- # @param [Hash] opts the optional parameters
1743
- # @option opts [String] :orderby &#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.
1744
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1745
- # @option opts [Integer] :limit &#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.
1746
- # @return [Array<(Array<RecurringTransactionMessage>, Integer, Hash)>] Array<RecurringTransactionMessage> data, response status code and response headers
1747
- def get_lease_recurring_transactions_with_http_info(lease_id, opts = {})
1748
- if @api_client.config.debugging
1749
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_recurring_transactions ...'
903
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_renewal_by_id"
1750
904
  end
1751
- # verify the required parameter 'lease_id' is set
1752
- if @api_client.config.client_side_validation && lease_id.nil?
1753
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_lease_recurring_transactions"
905
+ # verify the required parameter 'renewal_id' is set
906
+ if @api_client.config.client_side_validation && renewal_id.nil?
907
+ fail ArgumentError, "Missing the required parameter 'renewal_id' when calling LeasesApi.get_lease_renewal_by_id"
1754
908
  end
1755
909
  # resource path
1756
- local_var_path = '/v1/leases/{leaseId}/recurringtransactions'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
910
+ local_var_path = '/v1/leases/{leaseId}/renewals/{renewalId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'renewalId' + '}', CGI.escape(renewal_id.to_s))
1757
911
 
1758
912
  # query parameters
1759
913
  query_params = opts[:query_params] || {}
1760
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1761
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1762
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1763
914
 
1764
915
  # header parameters
1765
916
  header_params = opts[:header_params] || {}
@@ -1773,13 +924,13 @@ module Buildium
1773
924
  post_body = opts[:debug_body]
1774
925
 
1775
926
  # return_type
1776
- return_type = opts[:debug_return_type] || 'Array<RecurringTransactionMessage>'
927
+ return_type = opts[:debug_return_type] || 'LeaseRenewalMessage'
1777
928
 
1778
929
  # auth_names
1779
930
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1780
931
 
1781
932
  new_options = opts.merge(
1782
- :operation => :"LeasesApi.get_lease_recurring_transactions",
933
+ :operation => :"LeasesApi.get_lease_renewal_by_id",
1783
934
  :header_params => header_params,
1784
935
  :query_params => query_params,
1785
936
  :form_params => form_params,
@@ -1790,7 +941,7 @@ module Buildium
1790
941
 
1791
942
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1792
943
  if @api_client.config.debugging
1793
- @api_client.config.logger.debug "API called: LeasesApi#get_lease_recurring_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
944
+ @api_client.config.logger.debug "API called: LeasesApi#get_lease_renewal_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1794
945
  end
1795
946
  return data, status_code, headers
1796
947
  end
@@ -1905,75 +1056,6 @@ module Buildium
1905
1056
  return data, status_code, headers
1906
1057
  end
1907
1058
 
1908
- # Retrieve a recurring payment
1909
- # Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease Transactions</span> - `View`
1910
- # @param lease_id [Integer]
1911
- # @param payment_id [Integer]
1912
- # @param [Hash] opts the optional parameters
1913
- # @return [LeaseRecurringPaymentMessage]
1914
- def get_recurring_lease_payments_by_id(lease_id, payment_id, opts = {})
1915
- data, _status_code, _headers = get_recurring_lease_payments_by_id_with_http_info(lease_id, payment_id, opts)
1916
- data
1917
- end
1918
-
1919
- # Retrieve a recurring payment
1920
- # Retrieves a recurring payment. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease Transactions&lt;/span&gt; - &#x60;View&#x60;
1921
- # @param lease_id [Integer]
1922
- # @param payment_id [Integer]
1923
- # @param [Hash] opts the optional parameters
1924
- # @return [Array<(LeaseRecurringPaymentMessage, Integer, Hash)>] LeaseRecurringPaymentMessage data, response status code and response headers
1925
- def get_recurring_lease_payments_by_id_with_http_info(lease_id, payment_id, opts = {})
1926
- if @api_client.config.debugging
1927
- @api_client.config.logger.debug 'Calling API: LeasesApi.get_recurring_lease_payments_by_id ...'
1928
- end
1929
- # verify the required parameter 'lease_id' is set
1930
- if @api_client.config.client_side_validation && lease_id.nil?
1931
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_recurring_lease_payments_by_id"
1932
- end
1933
- # verify the required parameter 'payment_id' is set
1934
- if @api_client.config.client_side_validation && payment_id.nil?
1935
- fail ArgumentError, "Missing the required parameter 'payment_id' when calling LeasesApi.get_recurring_lease_payments_by_id"
1936
- end
1937
- # resource path
1938
- local_var_path = '/v1/leases/{leaseId}/recurringpayments/{paymentId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s))
1939
-
1940
- # query parameters
1941
- query_params = opts[:query_params] || {}
1942
-
1943
- # header parameters
1944
- header_params = opts[:header_params] || {}
1945
- # HTTP header 'Accept' (if needed)
1946
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1947
-
1948
- # form parameters
1949
- form_params = opts[:form_params] || {}
1950
-
1951
- # http body (model)
1952
- post_body = opts[:debug_body]
1953
-
1954
- # return_type
1955
- return_type = opts[:debug_return_type] || 'LeaseRecurringPaymentMessage'
1956
-
1957
- # auth_names
1958
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1959
-
1960
- new_options = opts.merge(
1961
- :operation => :"LeasesApi.get_recurring_lease_payments_by_id",
1962
- :header_params => header_params,
1963
- :query_params => query_params,
1964
- :form_params => form_params,
1965
- :body => post_body,
1966
- :auth_names => auth_names,
1967
- :return_type => return_type
1968
- )
1969
-
1970
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1971
- if @api_client.config.debugging
1972
- @api_client.config.logger.debug "API called: LeasesApi#get_recurring_lease_payments_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1973
- end
1974
- return data, status_code, headers
1975
- end
1976
-
1977
1059
  # Retrieve all rent schedules
1978
1060
  # The rent schedule provides details (dollar amount, day of the month, etc) of the recurring charges that are applied to the lease ledger each rent cycle. A lease may have more than one rent schedule associated with it if the rent terms change within the duration of the lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View`
1979
1061
  # @param lease_id [Integer]
@@ -2115,37 +1197,37 @@ module Buildium
2115
1197
  return data, status_code, headers
2116
1198
  end
2117
1199
 
2118
- # Retrieve all lease renewals
2119
- # Retrieves all lease renewals. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1200
+ # Retrieve all insurance policies
1201
+ # Retrieves all renters insurance policies for a lease. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
2120
1202
  # @param lease_id [Integer]
2121
1203
  # @param [Hash] opts the optional parameters
2122
1204
  # @option opts [String] :orderby &#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.
2123
1205
  # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
2124
1206
  # @option opts [Integer] :limit &#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.
2125
- # @return [Array<LeaseRenewalMessage>]
2126
- def lease_renewals_external_api_read_get_all_lease_renewals(lease_id, opts = {})
2127
- data, _status_code, _headers = lease_renewals_external_api_read_get_all_lease_renewals_with_http_info(lease_id, opts)
1207
+ # @return [Array<RentersInsurancePolicyMessage>]
1208
+ def get_renters_insurance_policies(lease_id, opts = {})
1209
+ data, _status_code, _headers = get_renters_insurance_policies_with_http_info(lease_id, opts)
2128
1210
  data
2129
1211
  end
2130
1212
 
2131
- # Retrieve all lease renewals
2132
- # Retrieves all lease renewals. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
1213
+ # Retrieve all insurance policies
1214
+ # Retrieves all renters insurance policies for a lease. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
2133
1215
  # @param lease_id [Integer]
2134
1216
  # @param [Hash] opts the optional parameters
2135
1217
  # @option opts [String] :orderby &#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.
2136
1218
  # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
2137
1219
  # @option opts [Integer] :limit &#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.
2138
- # @return [Array<(Array<LeaseRenewalMessage>, Integer, Hash)>] Array<LeaseRenewalMessage> data, response status code and response headers
2139
- def lease_renewals_external_api_read_get_all_lease_renewals_with_http_info(lease_id, opts = {})
1220
+ # @return [Array<(Array<RentersInsurancePolicyMessage>, Integer, Hash)>] Array<RentersInsurancePolicyMessage> data, response status code and response headers
1221
+ def get_renters_insurance_policies_with_http_info(lease_id, opts = {})
2140
1222
  if @api_client.config.debugging
2141
- @api_client.config.logger.debug 'Calling API: LeasesApi.lease_renewals_external_api_read_get_all_lease_renewals ...'
1223
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_renters_insurance_policies ...'
2142
1224
  end
2143
1225
  # verify the required parameter 'lease_id' is set
2144
1226
  if @api_client.config.client_side_validation && lease_id.nil?
2145
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.lease_renewals_external_api_read_get_all_lease_renewals"
1227
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_renters_insurance_policies"
2146
1228
  end
2147
1229
  # resource path
2148
- local_var_path = '/v1/leases/{leaseId}/renewals'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
1230
+ local_var_path = '/v1/leases/{leaseId}/rentersinsurance'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
2149
1231
 
2150
1232
  # query parameters
2151
1233
  query_params = opts[:query_params] || {}
@@ -2165,13 +1247,13 @@ module Buildium
2165
1247
  post_body = opts[:debug_body]
2166
1248
 
2167
1249
  # return_type
2168
- return_type = opts[:debug_return_type] || 'Array<LeaseRenewalMessage>'
1250
+ return_type = opts[:debug_return_type] || 'Array<RentersInsurancePolicyMessage>'
2169
1251
 
2170
1252
  # auth_names
2171
1253
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2172
1254
 
2173
1255
  new_options = opts.merge(
2174
- :operation => :"LeasesApi.lease_renewals_external_api_read_get_all_lease_renewals",
1256
+ :operation => :"LeasesApi.get_renters_insurance_policies",
2175
1257
  :header_params => header_params,
2176
1258
  :query_params => query_params,
2177
1259
  :form_params => form_params,
@@ -2182,42 +1264,42 @@ module Buildium
2182
1264
 
2183
1265
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2184
1266
  if @api_client.config.debugging
2185
- @api_client.config.logger.debug "API called: LeasesApi#lease_renewals_external_api_read_get_all_lease_renewals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1267
+ @api_client.config.logger.debug "API called: LeasesApi#get_renters_insurance_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2186
1268
  end
2187
1269
  return data, status_code, headers
2188
1270
  end
2189
1271
 
2190
- # Retrieve a lease renewal
2191
- # Retrieves a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
1272
+ # Retrieve an insurance policy
1273
+ # Retrieves a renters insurance policy. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View`
2192
1274
  # @param lease_id [Integer]
2193
- # @param renewal_id [Integer]
1275
+ # @param policy_id [Integer]
2194
1276
  # @param [Hash] opts the optional parameters
2195
- # @return [LeaseRenewalMessage]
2196
- def lease_renewals_external_api_read_get_lease_renewal_by_id(lease_id, renewal_id, opts = {})
2197
- data, _status_code, _headers = lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info(lease_id, renewal_id, opts)
1277
+ # @return [RentersInsurancePolicyMessage]
1278
+ def get_renters_insurance_policy_by_id(lease_id, policy_id, opts = {})
1279
+ data, _status_code, _headers = get_renters_insurance_policy_by_id_with_http_info(lease_id, policy_id, opts)
2198
1280
  data
2199
1281
  end
2200
1282
 
2201
- # Retrieve a lease renewal
2202
- # Retrieves a lease renewal. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
1283
+ # Retrieve an insurance policy
1284
+ # Retrieves a renters insurance policy. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60;
2203
1285
  # @param lease_id [Integer]
2204
- # @param renewal_id [Integer]
1286
+ # @param policy_id [Integer]
2205
1287
  # @param [Hash] opts the optional parameters
2206
- # @return [Array<(LeaseRenewalMessage, Integer, Hash)>] LeaseRenewalMessage data, response status code and response headers
2207
- def lease_renewals_external_api_read_get_lease_renewal_by_id_with_http_info(lease_id, renewal_id, opts = {})
1288
+ # @return [Array<(RentersInsurancePolicyMessage, Integer, Hash)>] RentersInsurancePolicyMessage data, response status code and response headers
1289
+ def get_renters_insurance_policy_by_id_with_http_info(lease_id, policy_id, opts = {})
2208
1290
  if @api_client.config.debugging
2209
- @api_client.config.logger.debug 'Calling API: LeasesApi.lease_renewals_external_api_read_get_lease_renewal_by_id ...'
1291
+ @api_client.config.logger.debug 'Calling API: LeasesApi.get_renters_insurance_policy_by_id ...'
2210
1292
  end
2211
1293
  # verify the required parameter 'lease_id' is set
2212
1294
  if @api_client.config.client_side_validation && lease_id.nil?
2213
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.lease_renewals_external_api_read_get_lease_renewal_by_id"
1295
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.get_renters_insurance_policy_by_id"
2214
1296
  end
2215
- # verify the required parameter 'renewal_id' is set
2216
- if @api_client.config.client_side_validation && renewal_id.nil?
2217
- fail ArgumentError, "Missing the required parameter 'renewal_id' when calling LeasesApi.lease_renewals_external_api_read_get_lease_renewal_by_id"
1297
+ # verify the required parameter 'policy_id' is set
1298
+ if @api_client.config.client_side_validation && policy_id.nil?
1299
+ fail ArgumentError, "Missing the required parameter 'policy_id' when calling LeasesApi.get_renters_insurance_policy_by_id"
2218
1300
  end
2219
1301
  # resource path
2220
- local_var_path = '/v1/leases/{leaseId}/renewals/{renewalId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'renewalId' + '}', CGI.escape(renewal_id.to_s))
1302
+ local_var_path = '/v1/leases/{leaseId}/rentersinsurance/{policyId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'policyId' + '}', CGI.escape(policy_id.to_s))
2221
1303
 
2222
1304
  # query parameters
2223
1305
  query_params = opts[:query_params] || {}
@@ -2234,13 +1316,13 @@ module Buildium
2234
1316
  post_body = opts[:debug_body]
2235
1317
 
2236
1318
  # return_type
2237
- return_type = opts[:debug_return_type] || 'LeaseRenewalMessage'
1319
+ return_type = opts[:debug_return_type] || 'RentersInsurancePolicyMessage'
2238
1320
 
2239
1321
  # auth_names
2240
1322
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2241
1323
 
2242
1324
  new_options = opts.merge(
2243
- :operation => :"LeasesApi.lease_renewals_external_api_read_get_lease_renewal_by_id",
1325
+ :operation => :"LeasesApi.get_renters_insurance_policy_by_id",
2244
1326
  :header_params => header_params,
2245
1327
  :query_params => query_params,
2246
1328
  :form_params => form_params,
@@ -2251,81 +1333,7 @@ module Buildium
2251
1333
 
2252
1334
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2253
1335
  if @api_client.config.debugging
2254
- @api_client.config.logger.debug "API called: LeasesApi#lease_renewals_external_api_read_get_lease_renewal_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2255
- end
2256
- return data, status_code, headers
2257
- end
2258
-
2259
- # Create a lease renewal
2260
- # Creates a lease renewal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
2261
- # @param lease_id [Integer]
2262
- # @param lease_renewal_post_message [LeaseRenewalPostMessage]
2263
- # @param [Hash] opts the optional parameters
2264
- # @return [LeaseRenewalMessage]
2265
- def lease_renewals_external_api_write_create_lease_renewal(lease_id, lease_renewal_post_message, opts = {})
2266
- data, _status_code, _headers = lease_renewals_external_api_write_create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message, opts)
2267
- data
2268
- end
2269
-
2270
- # Create a lease renewal
2271
- # Creates a lease renewal. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
2272
- # @param lease_id [Integer]
2273
- # @param lease_renewal_post_message [LeaseRenewalPostMessage]
2274
- # @param [Hash] opts the optional parameters
2275
- # @return [Array<(LeaseRenewalMessage, Integer, Hash)>] LeaseRenewalMessage data, response status code and response headers
2276
- def lease_renewals_external_api_write_create_lease_renewal_with_http_info(lease_id, lease_renewal_post_message, opts = {})
2277
- if @api_client.config.debugging
2278
- @api_client.config.logger.debug 'Calling API: LeasesApi.lease_renewals_external_api_write_create_lease_renewal ...'
2279
- end
2280
- # verify the required parameter 'lease_id' is set
2281
- if @api_client.config.client_side_validation && lease_id.nil?
2282
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.lease_renewals_external_api_write_create_lease_renewal"
2283
- end
2284
- # verify the required parameter 'lease_renewal_post_message' is set
2285
- if @api_client.config.client_side_validation && lease_renewal_post_message.nil?
2286
- fail ArgumentError, "Missing the required parameter 'lease_renewal_post_message' when calling LeasesApi.lease_renewals_external_api_write_create_lease_renewal"
2287
- end
2288
- # resource path
2289
- local_var_path = '/v1/leases/{leaseId}/renewals'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
2290
-
2291
- # query parameters
2292
- query_params = opts[:query_params] || {}
2293
-
2294
- # header parameters
2295
- header_params = opts[:header_params] || {}
2296
- # HTTP header 'Accept' (if needed)
2297
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2298
- # HTTP header 'Content-Type'
2299
- content_type = @api_client.select_header_content_type(['application/json'])
2300
- if !content_type.nil?
2301
- header_params['Content-Type'] = content_type
2302
- end
2303
-
2304
- # form parameters
2305
- form_params = opts[:form_params] || {}
2306
-
2307
- # http body (model)
2308
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_renewal_post_message)
2309
-
2310
- # return_type
2311
- return_type = opts[:debug_return_type] || 'LeaseRenewalMessage'
2312
-
2313
- # auth_names
2314
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2315
-
2316
- new_options = opts.merge(
2317
- :operation => :"LeasesApi.lease_renewals_external_api_write_create_lease_renewal",
2318
- :header_params => header_params,
2319
- :query_params => query_params,
2320
- :form_params => form_params,
2321
- :body => post_body,
2322
- :auth_names => auth_names,
2323
- :return_type => return_type
2324
- )
2325
-
2326
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2327
- if @api_client.config.debugging
2328
- @api_client.config.logger.debug "API called: LeasesApi#lease_renewals_external_api_write_create_lease_renewal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1336
+ @api_client.config.logger.debug "API called: LeasesApi#get_renters_insurance_policy_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2329
1337
  end
2330
1338
  return data, status_code, headers
2331
1339
  end
@@ -2473,43 +1481,37 @@ module Buildium
2473
1481
  return data, status_code, headers
2474
1482
  end
2475
1483
 
2476
- # Update a charge
2477
- # Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Lease transactions</span> - `View` `Edit`
1484
+ # Update ePay settings
1485
+ # Updates ePay settings for a lease <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Leases</span> - `View` `Edit`
2478
1486
  # @param lease_id [Integer]
2479
- # @param charge_id [Integer]
2480
- # @param lease_charge_put_message [LeaseChargePutMessage]
1487
+ # @param e_pay_settings_put_message [EPaySettingsPutMessage]
2481
1488
  # @param [Hash] opts the optional parameters
2482
- # @return [LeaseTransactionMessage]
2483
- def update_lease_charge(lease_id, charge_id, lease_charge_put_message, opts = {})
2484
- data, _status_code, _headers = update_lease_charge_with_http_info(lease_id, charge_id, lease_charge_put_message, opts)
1489
+ # @return [EPaySettingsMessage]
1490
+ def update_lease_epay_settings(lease_id, e_pay_settings_put_message, opts = {})
1491
+ data, _status_code, _headers = update_lease_epay_settings_with_http_info(lease_id, e_pay_settings_put_message, opts)
2485
1492
  data
2486
1493
  end
2487
1494
 
2488
- # Update a charge
2489
- # Updates a charge. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Lease transactions&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
1495
+ # Update ePay settings
1496
+ # Updates ePay settings for a lease &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Rentals &amp;gt; Leases&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
2490
1497
  # @param lease_id [Integer]
2491
- # @param charge_id [Integer]
2492
- # @param lease_charge_put_message [LeaseChargePutMessage]
1498
+ # @param e_pay_settings_put_message [EPaySettingsPutMessage]
2493
1499
  # @param [Hash] opts the optional parameters
2494
- # @return [Array<(LeaseTransactionMessage, Integer, Hash)>] LeaseTransactionMessage data, response status code and response headers
2495
- def update_lease_charge_with_http_info(lease_id, charge_id, lease_charge_put_message, opts = {})
1500
+ # @return [Array<(EPaySettingsMessage, Integer, Hash)>] EPaySettingsMessage data, response status code and response headers
1501
+ def update_lease_epay_settings_with_http_info(lease_id, e_pay_settings_put_message, opts = {})
2496
1502
  if @api_client.config.debugging
2497
- @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_charge ...'
1503
+ @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_epay_settings ...'
2498
1504
  end
2499
1505
  # verify the required parameter 'lease_id' is set
2500
1506
  if @api_client.config.client_side_validation && lease_id.nil?
2501
- fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.update_lease_charge"
2502
- end
2503
- # verify the required parameter 'charge_id' is set
2504
- if @api_client.config.client_side_validation && charge_id.nil?
2505
- fail ArgumentError, "Missing the required parameter 'charge_id' when calling LeasesApi.update_lease_charge"
1507
+ fail ArgumentError, "Missing the required parameter 'lease_id' when calling LeasesApi.update_lease_epay_settings"
2506
1508
  end
2507
- # verify the required parameter 'lease_charge_put_message' is set
2508
- if @api_client.config.client_side_validation && lease_charge_put_message.nil?
2509
- fail ArgumentError, "Missing the required parameter 'lease_charge_put_message' when calling LeasesApi.update_lease_charge"
1509
+ # verify the required parameter 'e_pay_settings_put_message' is set
1510
+ if @api_client.config.client_side_validation && e_pay_settings_put_message.nil?
1511
+ fail ArgumentError, "Missing the required parameter 'e_pay_settings_put_message' when calling LeasesApi.update_lease_epay_settings"
2510
1512
  end
2511
1513
  # resource path
2512
- local_var_path = '/v1/leases/{leaseId}/charges/{chargeId}'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s)).sub('{' + 'chargeId' + '}', CGI.escape(charge_id.to_s))
1514
+ local_var_path = '/v1/leases/{leaseId}/epaysettings'.sub('{' + 'leaseId' + '}', CGI.escape(lease_id.to_s))
2513
1515
 
2514
1516
  # query parameters
2515
1517
  query_params = opts[:query_params] || {}
@@ -2528,16 +1530,16 @@ module Buildium
2528
1530
  form_params = opts[:form_params] || {}
2529
1531
 
2530
1532
  # http body (model)
2531
- post_body = opts[:debug_body] || @api_client.object_to_http_body(lease_charge_put_message)
1533
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(e_pay_settings_put_message)
2532
1534
 
2533
1535
  # return_type
2534
- return_type = opts[:debug_return_type] || 'LeaseTransactionMessage'
1536
+ return_type = opts[:debug_return_type] || 'EPaySettingsMessage'
2535
1537
 
2536
1538
  # auth_names
2537
1539
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2538
1540
 
2539
1541
  new_options = opts.merge(
2540
- :operation => :"LeasesApi.update_lease_charge",
1542
+ :operation => :"LeasesApi.update_lease_epay_settings",
2541
1543
  :header_params => header_params,
2542
1544
  :query_params => query_params,
2543
1545
  :form_params => form_params,
@@ -2548,7 +1550,7 @@ module Buildium
2548
1550
 
2549
1551
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2550
1552
  if @api_client.config.debugging
2551
- @api_client.config.logger.debug "API called: LeasesApi#update_lease_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1553
+ @api_client.config.logger.debug "API called: LeasesApi#update_lease_epay_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2552
1554
  end
2553
1555
  return data, status_code, headers
2554
1556
  end