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
@@ -4,20 +4,110 @@ All URIs are relative to *https://api.buildium.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**create_rental_image_upload_file_request_async**](RentalPropertiesApi.md#create_rental_image_upload_file_request_async) | **POST** /v1/rentals/{propertyId}/images/uploadrequests | Upload a rental image |
7
8
  | [**create_rental_property**](RentalPropertiesApi.md#create_rental_property) | **POST** /v1/rentals | Create a property |
8
9
  | [**create_rental_property_note**](RentalPropertiesApi.md#create_rental_property_note) | **POST** /v1/rentals/{propertyId}/notes | Create a note |
10
+ | [**create_video_link_request**](RentalPropertiesApi.md#create_video_link_request) | **POST** /v1/rentals/{propertyId}/images/videolinkrequests | Create an image for a rental using a video link |
11
+ | [**delete_rental_image**](RentalPropertiesApi.md#delete_rental_image) | **DELETE** /v1/rentals/{propertyId}/images/{imageId} | Delete a property image |
9
12
  | [**get_all_rentals**](RentalPropertiesApi.md#get_all_rentals) | **GET** /v1/rentals | Retrieve all properties |
13
+ | [**get_e_pay_settings_for_rental_property**](RentalPropertiesApi.md#get_e_pay_settings_for_rental_property) | **GET** /v1/rentals/{propertyId}/epaysettings | Retrieve ePay settings |
10
14
  | [**get_features_by_rental_property_id**](RentalPropertiesApi.md#get_features_by_rental_property_id) | **GET** /v1/rentals/{propertyId}/amenities | Retrieve all amenities |
11
15
  | [**get_rental_by_id**](RentalPropertiesApi.md#get_rental_by_id) | **GET** /v1/rentals/{propertyId} | Retrieve a property |
16
+ | [**get_rental_image_by_id**](RentalPropertiesApi.md#get_rental_image_by_id) | **GET** /v1/rentals/{propertyId}/images/{imageId} | Retrieve a property image |
17
+ | [**get_rental_image_download_url_by_id**](RentalPropertiesApi.md#get_rental_image_download_url_by_id) | **POST** /v1/rentals/{propertyId}/images/{imageId}/downloadrequests | Download a property image |
18
+ | [**get_rental_images**](RentalPropertiesApi.md#get_rental_images) | **GET** /v1/rentals/{propertyId}/images | Retrieve all property images |
12
19
  | [**get_rental_note_by_note_id**](RentalPropertiesApi.md#get_rental_note_by_note_id) | **GET** /v1/rentals/{propertyId}/notes/{noteId} | Retrieve a note |
13
20
  | [**get_rental_notes**](RentalPropertiesApi.md#get_rental_notes) | **GET** /v1/rentals/{propertyId}/notes | Retrieve all notes |
14
21
  | [**get_rental_preferred_vendors**](RentalPropertiesApi.md#get_rental_preferred_vendors) | **GET** /v1/rentals/{propertyId}/vendors | Retrieve all preferred vendors |
22
+ | [**inactivate_rental_property**](RentalPropertiesApi.md#inactivate_rental_property) | **POST** /v1/rentals/{propertyId}/inactivationrequest | Inactivate a property |
23
+ | [**reactivate_rental_property**](RentalPropertiesApi.md#reactivate_rental_property) | **POST** /v1/rentals/{propertyId}/reactivationrequest | Reactivate a property |
24
+ | [**reorder_rental_images**](RentalPropertiesApi.md#reorder_rental_images) | **PUT** /v1/rentals/{propertyId}/images/order | Update property image order |
25
+ | [**update_e_pay_settings_for_rental**](RentalPropertiesApi.md#update_e_pay_settings_for_rental) | **PUT** /v1/rentals/{propertyId}/epaysettings | Update ePay settings |
15
26
  | [**update_rental_features**](RentalPropertiesApi.md#update_rental_features) | **PUT** /v1/rentals/{propertyId}/amenities | Update amenities |
27
+ | [**update_rental_image**](RentalPropertiesApi.md#update_rental_image) | **PUT** /v1/rentals/{propertyId}/images/{imageId} | Update a property image |
16
28
  | [**update_rental_preferred_vendors**](RentalPropertiesApi.md#update_rental_preferred_vendors) | **PUT** /v1/rentals/{propertyId}/vendors | Update preferred vendors |
17
29
  | [**update_rental_property**](RentalPropertiesApi.md#update_rental_property) | **PUT** /v1/rentals/{propertyId} | Update a property |
18
30
  | [**update_rental_property_note**](RentalPropertiesApi.md#update_rental_property_note) | **PUT** /v1/rentals/{propertyId}/notes/{noteId} | Update a note |
19
31
 
20
32
 
33
+ ## create_rental_image_upload_file_request_async
34
+
35
+ > <FileUploadTicketMessage> create_rental_image_upload_file_request_async(property_id, listing_entity_file_post_message)
36
+
37
+ Upload a rental image
38
+
39
+ Uploads an image and associates it to the specified rental record. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/rentals/{rentalId}/images/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
40
+
41
+ ### Examples
42
+
43
+ ```ruby
44
+ require 'time'
45
+ require 'buildium-ruby'
46
+ # setup authorization
47
+ Buildium.configure do |config|
48
+ # Configure API key authorization: clientId
49
+ config.api_key['clientId'] = 'YOUR API KEY'
50
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
51
+ # config.api_key_prefix['clientId'] = 'Bearer'
52
+
53
+ # Configure API key authorization: clientSecret
54
+ config.api_key['clientSecret'] = 'YOUR API KEY'
55
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
56
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
57
+ end
58
+
59
+ api_instance = Buildium::RentalPropertiesApi.new
60
+ property_id = 56 # Integer |
61
+ listing_entity_file_post_message = Buildium::ListingEntityFilePostMessage.new({file_name: 'file_name_example', show_in_listing: false}) # ListingEntityFilePostMessage |
62
+
63
+ begin
64
+ # Upload a rental image
65
+ result = api_instance.create_rental_image_upload_file_request_async(property_id, listing_entity_file_post_message)
66
+ p result
67
+ rescue Buildium::ApiError => e
68
+ puts "Error when calling RentalPropertiesApi->create_rental_image_upload_file_request_async: #{e}"
69
+ end
70
+ ```
71
+
72
+ #### Using the create_rental_image_upload_file_request_async_with_http_info variant
73
+
74
+ This returns an Array which contains the response data, status code and headers.
75
+
76
+ > <Array(<FileUploadTicketMessage>, Integer, Hash)> create_rental_image_upload_file_request_async_with_http_info(property_id, listing_entity_file_post_message)
77
+
78
+ ```ruby
79
+ begin
80
+ # Upload a rental image
81
+ data, status_code, headers = api_instance.create_rental_image_upload_file_request_async_with_http_info(property_id, listing_entity_file_post_message)
82
+ p status_code # => 2xx
83
+ p headers # => { ... }
84
+ p data # => <FileUploadTicketMessage>
85
+ rescue Buildium::ApiError => e
86
+ puts "Error when calling RentalPropertiesApi->create_rental_image_upload_file_request_async_with_http_info: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ | Name | Type | Description | Notes |
93
+ | ---- | ---- | ----------- | ----- |
94
+ | **property_id** | **Integer** | | |
95
+ | **listing_entity_file_post_message** | [**ListingEntityFilePostMessage**](ListingEntityFilePostMessage.md) | | |
96
+
97
+ ### Return type
98
+
99
+ [**FileUploadTicketMessage**](FileUploadTicketMessage.md)
100
+
101
+ ### Authorization
102
+
103
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: application/json
108
+ - **Accept**: application/json
109
+
110
+
21
111
  ## create_rental_property
22
112
 
23
113
  > <RentalMessage> create_rental_property(rental_property_post_message)
@@ -52,25 +142,901 @@ begin
52
142
  result = api_instance.create_rental_property(rental_property_post_message)
53
143
  p result
54
144
  rescue Buildium::ApiError => e
55
- puts "Error when calling RentalPropertiesApi->create_rental_property: #{e}"
145
+ puts "Error when calling RentalPropertiesApi->create_rental_property: #{e}"
146
+ end
147
+ ```
148
+
149
+ #### Using the create_rental_property_with_http_info variant
150
+
151
+ This returns an Array which contains the response data, status code and headers.
152
+
153
+ > <Array(<RentalMessage>, Integer, Hash)> create_rental_property_with_http_info(rental_property_post_message)
154
+
155
+ ```ruby
156
+ begin
157
+ # Create a property
158
+ data, status_code, headers = api_instance.create_rental_property_with_http_info(rental_property_post_message)
159
+ p status_code # => 2xx
160
+ p headers # => { ... }
161
+ p data # => <RentalMessage>
162
+ rescue Buildium::ApiError => e
163
+ puts "Error when calling RentalPropertiesApi->create_rental_property_with_http_info: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ | Name | Type | Description | Notes |
170
+ | ---- | ---- | ----------- | ----- |
171
+ | **rental_property_post_message** | [**RentalPropertyPostMessage**](RentalPropertyPostMessage.md) | | |
172
+
173
+ ### Return type
174
+
175
+ [**RentalMessage**](RentalMessage.md)
176
+
177
+ ### Authorization
178
+
179
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: application/json
184
+ - **Accept**: application/json
185
+
186
+
187
+ ## create_rental_property_note
188
+
189
+ > <NoteMessage> create_rental_property_note(property_id, note_post_message)
190
+
191
+ Create a note
192
+
193
+ Creates a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
194
+
195
+ ### Examples
196
+
197
+ ```ruby
198
+ require 'time'
199
+ require 'buildium-ruby'
200
+ # setup authorization
201
+ Buildium.configure do |config|
202
+ # Configure API key authorization: clientId
203
+ config.api_key['clientId'] = 'YOUR API KEY'
204
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
205
+ # config.api_key_prefix['clientId'] = 'Bearer'
206
+
207
+ # Configure API key authorization: clientSecret
208
+ config.api_key['clientSecret'] = 'YOUR API KEY'
209
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
210
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
211
+ end
212
+
213
+ api_instance = Buildium::RentalPropertiesApi.new
214
+ property_id = 56 # Integer |
215
+ note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
216
+
217
+ begin
218
+ # Create a note
219
+ result = api_instance.create_rental_property_note(property_id, note_post_message)
220
+ p result
221
+ rescue Buildium::ApiError => e
222
+ puts "Error when calling RentalPropertiesApi->create_rental_property_note: #{e}"
223
+ end
224
+ ```
225
+
226
+ #### Using the create_rental_property_note_with_http_info variant
227
+
228
+ This returns an Array which contains the response data, status code and headers.
229
+
230
+ > <Array(<NoteMessage>, Integer, Hash)> create_rental_property_note_with_http_info(property_id, note_post_message)
231
+
232
+ ```ruby
233
+ begin
234
+ # Create a note
235
+ data, status_code, headers = api_instance.create_rental_property_note_with_http_info(property_id, note_post_message)
236
+ p status_code # => 2xx
237
+ p headers # => { ... }
238
+ p data # => <NoteMessage>
239
+ rescue Buildium::ApiError => e
240
+ puts "Error when calling RentalPropertiesApi->create_rental_property_note_with_http_info: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Name | Type | Description | Notes |
247
+ | ---- | ---- | ----------- | ----- |
248
+ | **property_id** | **Integer** | | |
249
+ | **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
250
+
251
+ ### Return type
252
+
253
+ [**NoteMessage**](NoteMessage.md)
254
+
255
+ ### Authorization
256
+
257
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
258
+
259
+ ### HTTP request headers
260
+
261
+ - **Content-Type**: application/json
262
+ - **Accept**: application/json
263
+
264
+
265
+ ## create_video_link_request
266
+
267
+ > <RentalImageMessage> create_video_link_request(property_id, video_link_request_post_message)
268
+
269
+ Create an image for a rental using a video link
270
+
271
+ Creates an image for a rental using a video link. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
272
+
273
+ ### Examples
274
+
275
+ ```ruby
276
+ require 'time'
277
+ require 'buildium-ruby'
278
+ # setup authorization
279
+ Buildium.configure do |config|
280
+ # Configure API key authorization: clientId
281
+ config.api_key['clientId'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ # config.api_key_prefix['clientId'] = 'Bearer'
284
+
285
+ # Configure API key authorization: clientSecret
286
+ config.api_key['clientSecret'] = 'YOUR API KEY'
287
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
288
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
289
+ end
290
+
291
+ api_instance = Buildium::RentalPropertiesApi.new
292
+ property_id = 56 # Integer |
293
+ video_link_request_post_message = Buildium::VideoLinkRequestPostMessage.new({video_url: 'video_url_example', show_in_listing: false}) # VideoLinkRequestPostMessage |
294
+
295
+ begin
296
+ # Create an image for a rental using a video link
297
+ result = api_instance.create_video_link_request(property_id, video_link_request_post_message)
298
+ p result
299
+ rescue Buildium::ApiError => e
300
+ puts "Error when calling RentalPropertiesApi->create_video_link_request: #{e}"
301
+ end
302
+ ```
303
+
304
+ #### Using the create_video_link_request_with_http_info variant
305
+
306
+ This returns an Array which contains the response data, status code and headers.
307
+
308
+ > <Array(<RentalImageMessage>, Integer, Hash)> create_video_link_request_with_http_info(property_id, video_link_request_post_message)
309
+
310
+ ```ruby
311
+ begin
312
+ # Create an image for a rental using a video link
313
+ data, status_code, headers = api_instance.create_video_link_request_with_http_info(property_id, video_link_request_post_message)
314
+ p status_code # => 2xx
315
+ p headers # => { ... }
316
+ p data # => <RentalImageMessage>
317
+ rescue Buildium::ApiError => e
318
+ puts "Error when calling RentalPropertiesApi->create_video_link_request_with_http_info: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ | Name | Type | Description | Notes |
325
+ | ---- | ---- | ----------- | ----- |
326
+ | **property_id** | **Integer** | | |
327
+ | **video_link_request_post_message** | [**VideoLinkRequestPostMessage**](VideoLinkRequestPostMessage.md) | | |
328
+
329
+ ### Return type
330
+
331
+ [**RentalImageMessage**](RentalImageMessage.md)
332
+
333
+ ### Authorization
334
+
335
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: application/json
340
+ - **Accept**: application/json
341
+
342
+
343
+ ## delete_rental_image
344
+
345
+ > delete_rental_image(property_id, image_id)
346
+
347
+ Delete a property image
348
+
349
+ Deletes a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit` `Delete`
350
+
351
+ ### Examples
352
+
353
+ ```ruby
354
+ require 'time'
355
+ require 'buildium-ruby'
356
+ # setup authorization
357
+ Buildium.configure do |config|
358
+ # Configure API key authorization: clientId
359
+ config.api_key['clientId'] = 'YOUR API KEY'
360
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
361
+ # config.api_key_prefix['clientId'] = 'Bearer'
362
+
363
+ # Configure API key authorization: clientSecret
364
+ config.api_key['clientSecret'] = 'YOUR API KEY'
365
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
366
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
367
+ end
368
+
369
+ api_instance = Buildium::RentalPropertiesApi.new
370
+ property_id = 56 # Integer |
371
+ image_id = 56 # Integer |
372
+
373
+ begin
374
+ # Delete a property image
375
+ api_instance.delete_rental_image(property_id, image_id)
376
+ rescue Buildium::ApiError => e
377
+ puts "Error when calling RentalPropertiesApi->delete_rental_image: #{e}"
378
+ end
379
+ ```
380
+
381
+ #### Using the delete_rental_image_with_http_info variant
382
+
383
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
384
+
385
+ > <Array(nil, Integer, Hash)> delete_rental_image_with_http_info(property_id, image_id)
386
+
387
+ ```ruby
388
+ begin
389
+ # Delete a property image
390
+ data, status_code, headers = api_instance.delete_rental_image_with_http_info(property_id, image_id)
391
+ p status_code # => 2xx
392
+ p headers # => { ... }
393
+ p data # => nil
394
+ rescue Buildium::ApiError => e
395
+ puts "Error when calling RentalPropertiesApi->delete_rental_image_with_http_info: #{e}"
396
+ end
397
+ ```
398
+
399
+ ### Parameters
400
+
401
+ | Name | Type | Description | Notes |
402
+ | ---- | ---- | ----------- | ----- |
403
+ | **property_id** | **Integer** | | |
404
+ | **image_id** | **Integer** | | |
405
+
406
+ ### Return type
407
+
408
+ nil (empty response body)
409
+
410
+ ### Authorization
411
+
412
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
413
+
414
+ ### HTTP request headers
415
+
416
+ - **Content-Type**: Not defined
417
+ - **Accept**: application/json
418
+
419
+
420
+ ## get_all_rentals
421
+
422
+ > <Array<RentalMessage>> get_all_rentals(opts)
423
+
424
+ Retrieve all properties
425
+
426
+ Retrieves a list of rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
427
+
428
+ ### Examples
429
+
430
+ ```ruby
431
+ require 'time'
432
+ require 'buildium-ruby'
433
+ # setup authorization
434
+ Buildium.configure do |config|
435
+ # Configure API key authorization: clientId
436
+ config.api_key['clientId'] = 'YOUR API KEY'
437
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
438
+ # config.api_key_prefix['clientId'] = 'Bearer'
439
+
440
+ # Configure API key authorization: clientSecret
441
+ config.api_key['clientSecret'] = 'YOUR API KEY'
442
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
443
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
444
+ end
445
+
446
+ api_instance = Buildium::RentalPropertiesApi.new
447
+ opts = {
448
+ location: 'location_example', # String | Filters results to only rental properties whose city or state *contains* the specified value.
449
+ types: ['Residential'], # Array<String> | Filters results by the rental type. If no type is provided all types will be returned.
450
+ subtypes: ['CondoTownhome'], # Array<String> | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.
451
+ status: 'Active', # String | Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned.
452
+ rentalownerids: [37], # Array<Integer> | Filters results to only rental properties whose RentalOwnerId matches the specified Id.
453
+ propertyids: [37], # Array<Integer> | Filters results to only rental properties units whose Rental matches the specified Id.
454
+ lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
455
+ lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
456
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
457
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
458
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
459
+ }
460
+
461
+ begin
462
+ # Retrieve all properties
463
+ result = api_instance.get_all_rentals(opts)
464
+ p result
465
+ rescue Buildium::ApiError => e
466
+ puts "Error when calling RentalPropertiesApi->get_all_rentals: #{e}"
467
+ end
468
+ ```
469
+
470
+ #### Using the get_all_rentals_with_http_info variant
471
+
472
+ This returns an Array which contains the response data, status code and headers.
473
+
474
+ > <Array(<Array<RentalMessage>>, Integer, Hash)> get_all_rentals_with_http_info(opts)
475
+
476
+ ```ruby
477
+ begin
478
+ # Retrieve all properties
479
+ data, status_code, headers = api_instance.get_all_rentals_with_http_info(opts)
480
+ p status_code # => 2xx
481
+ p headers # => { ... }
482
+ p data # => <Array<RentalMessage>>
483
+ rescue Buildium::ApiError => e
484
+ puts "Error when calling RentalPropertiesApi->get_all_rentals_with_http_info: #{e}"
485
+ end
486
+ ```
487
+
488
+ ### Parameters
489
+
490
+ | Name | Type | Description | Notes |
491
+ | ---- | ---- | ----------- | ----- |
492
+ | **location** | **String** | Filters results to only rental properties whose city or state *contains* the specified value. | [optional] |
493
+ | **types** | [**Array&lt;String&gt;**](String.md) | Filters results by the rental type. If no type is provided all types will be returned. | [optional] |
494
+ | **subtypes** | [**Array&lt;String&gt;**](String.md) | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned. | [optional] |
495
+ | **status** | **String** | Filters results by the status of the rental property. If no status is specified both &#x60;active&#x60; and &#x60;inactive&#x60; rental properties will be returned. | [optional] |
496
+ | **rentalownerids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties whose RentalOwnerId matches the specified Id. | [optional] |
497
+ | **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties units whose Rental matches the specified Id. | [optional] |
498
+ | **lastupdatedfrom** | **Time** | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
499
+ | **lastupdatedto** | **Time** | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
500
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
501
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
502
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
503
+
504
+ ### Return type
505
+
506
+ [**Array&lt;RentalMessage&gt;**](RentalMessage.md)
507
+
508
+ ### Authorization
509
+
510
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
511
+
512
+ ### HTTP request headers
513
+
514
+ - **Content-Type**: Not defined
515
+ - **Accept**: application/json
516
+
517
+
518
+ ## get_e_pay_settings_for_rental_property
519
+
520
+ > <EPaySettingsMessage> get_e_pay_settings_for_rental_property(property_id)
521
+
522
+ Retrieve ePay settings
523
+
524
+ Retrieves ePay settings for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
525
+
526
+ ### Examples
527
+
528
+ ```ruby
529
+ require 'time'
530
+ require 'buildium-ruby'
531
+ # setup authorization
532
+ Buildium.configure do |config|
533
+ # Configure API key authorization: clientId
534
+ config.api_key['clientId'] = 'YOUR API KEY'
535
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
536
+ # config.api_key_prefix['clientId'] = 'Bearer'
537
+
538
+ # Configure API key authorization: clientSecret
539
+ config.api_key['clientSecret'] = 'YOUR API KEY'
540
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
541
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
542
+ end
543
+
544
+ api_instance = Buildium::RentalPropertiesApi.new
545
+ property_id = 56 # Integer |
546
+
547
+ begin
548
+ # Retrieve ePay settings
549
+ result = api_instance.get_e_pay_settings_for_rental_property(property_id)
550
+ p result
551
+ rescue Buildium::ApiError => e
552
+ puts "Error when calling RentalPropertiesApi->get_e_pay_settings_for_rental_property: #{e}"
553
+ end
554
+ ```
555
+
556
+ #### Using the get_e_pay_settings_for_rental_property_with_http_info variant
557
+
558
+ This returns an Array which contains the response data, status code and headers.
559
+
560
+ > <Array(<EPaySettingsMessage>, Integer, Hash)> get_e_pay_settings_for_rental_property_with_http_info(property_id)
561
+
562
+ ```ruby
563
+ begin
564
+ # Retrieve ePay settings
565
+ data, status_code, headers = api_instance.get_e_pay_settings_for_rental_property_with_http_info(property_id)
566
+ p status_code # => 2xx
567
+ p headers # => { ... }
568
+ p data # => <EPaySettingsMessage>
569
+ rescue Buildium::ApiError => e
570
+ puts "Error when calling RentalPropertiesApi->get_e_pay_settings_for_rental_property_with_http_info: #{e}"
571
+ end
572
+ ```
573
+
574
+ ### Parameters
575
+
576
+ | Name | Type | Description | Notes |
577
+ | ---- | ---- | ----------- | ----- |
578
+ | **property_id** | **Integer** | | |
579
+
580
+ ### Return type
581
+
582
+ [**EPaySettingsMessage**](EPaySettingsMessage.md)
583
+
584
+ ### Authorization
585
+
586
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
587
+
588
+ ### HTTP request headers
589
+
590
+ - **Content-Type**: Not defined
591
+ - **Accept**: application/json
592
+
593
+
594
+ ## get_features_by_rental_property_id
595
+
596
+ > <RentalFeaturesMessage> get_features_by_rental_property_id(property_id)
597
+
598
+ Retrieve all amenities
599
+
600
+ Retrieve all the amenities for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
601
+
602
+ ### Examples
603
+
604
+ ```ruby
605
+ require 'time'
606
+ require 'buildium-ruby'
607
+ # setup authorization
608
+ Buildium.configure do |config|
609
+ # Configure API key authorization: clientId
610
+ config.api_key['clientId'] = 'YOUR API KEY'
611
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
612
+ # config.api_key_prefix['clientId'] = 'Bearer'
613
+
614
+ # Configure API key authorization: clientSecret
615
+ config.api_key['clientSecret'] = 'YOUR API KEY'
616
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
617
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
618
+ end
619
+
620
+ api_instance = Buildium::RentalPropertiesApi.new
621
+ property_id = 56 # Integer |
622
+
623
+ begin
624
+ # Retrieve all amenities
625
+ result = api_instance.get_features_by_rental_property_id(property_id)
626
+ p result
627
+ rescue Buildium::ApiError => e
628
+ puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id: #{e}"
629
+ end
630
+ ```
631
+
632
+ #### Using the get_features_by_rental_property_id_with_http_info variant
633
+
634
+ This returns an Array which contains the response data, status code and headers.
635
+
636
+ > <Array(<RentalFeaturesMessage>, Integer, Hash)> get_features_by_rental_property_id_with_http_info(property_id)
637
+
638
+ ```ruby
639
+ begin
640
+ # Retrieve all amenities
641
+ data, status_code, headers = api_instance.get_features_by_rental_property_id_with_http_info(property_id)
642
+ p status_code # => 2xx
643
+ p headers # => { ... }
644
+ p data # => <RentalFeaturesMessage>
645
+ rescue Buildium::ApiError => e
646
+ puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id_with_http_info: #{e}"
647
+ end
648
+ ```
649
+
650
+ ### Parameters
651
+
652
+ | Name | Type | Description | Notes |
653
+ | ---- | ---- | ----------- | ----- |
654
+ | **property_id** | **Integer** | | |
655
+
656
+ ### Return type
657
+
658
+ [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
659
+
660
+ ### Authorization
661
+
662
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
663
+
664
+ ### HTTP request headers
665
+
666
+ - **Content-Type**: Not defined
667
+ - **Accept**: application/json
668
+
669
+
670
+ ## get_rental_by_id
671
+
672
+ > <RentalMessage> get_rental_by_id(property_id)
673
+
674
+ Retrieve a property
675
+
676
+ Retrieve a specific rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
677
+
678
+ ### Examples
679
+
680
+ ```ruby
681
+ require 'time'
682
+ require 'buildium-ruby'
683
+ # setup authorization
684
+ Buildium.configure do |config|
685
+ # Configure API key authorization: clientId
686
+ config.api_key['clientId'] = 'YOUR API KEY'
687
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
688
+ # config.api_key_prefix['clientId'] = 'Bearer'
689
+
690
+ # Configure API key authorization: clientSecret
691
+ config.api_key['clientSecret'] = 'YOUR API KEY'
692
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
693
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
694
+ end
695
+
696
+ api_instance = Buildium::RentalPropertiesApi.new
697
+ property_id = 56 # Integer | The rental property identifier.
698
+
699
+ begin
700
+ # Retrieve a property
701
+ result = api_instance.get_rental_by_id(property_id)
702
+ p result
703
+ rescue Buildium::ApiError => e
704
+ puts "Error when calling RentalPropertiesApi->get_rental_by_id: #{e}"
705
+ end
706
+ ```
707
+
708
+ #### Using the get_rental_by_id_with_http_info variant
709
+
710
+ This returns an Array which contains the response data, status code and headers.
711
+
712
+ > <Array(<RentalMessage>, Integer, Hash)> get_rental_by_id_with_http_info(property_id)
713
+
714
+ ```ruby
715
+ begin
716
+ # Retrieve a property
717
+ data, status_code, headers = api_instance.get_rental_by_id_with_http_info(property_id)
718
+ p status_code # => 2xx
719
+ p headers # => { ... }
720
+ p data # => <RentalMessage>
721
+ rescue Buildium::ApiError => e
722
+ puts "Error when calling RentalPropertiesApi->get_rental_by_id_with_http_info: #{e}"
723
+ end
724
+ ```
725
+
726
+ ### Parameters
727
+
728
+ | Name | Type | Description | Notes |
729
+ | ---- | ---- | ----------- | ----- |
730
+ | **property_id** | **Integer** | The rental property identifier. | |
731
+
732
+ ### Return type
733
+
734
+ [**RentalMessage**](RentalMessage.md)
735
+
736
+ ### Authorization
737
+
738
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
739
+
740
+ ### HTTP request headers
741
+
742
+ - **Content-Type**: Not defined
743
+ - **Accept**: application/json
744
+
745
+
746
+ ## get_rental_image_by_id
747
+
748
+ > <RentalImageMessage> get_rental_image_by_id(property_id, image_id)
749
+
750
+ Retrieve a property image
751
+
752
+ Retrieves a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
753
+
754
+ ### Examples
755
+
756
+ ```ruby
757
+ require 'time'
758
+ require 'buildium-ruby'
759
+ # setup authorization
760
+ Buildium.configure do |config|
761
+ # Configure API key authorization: clientId
762
+ config.api_key['clientId'] = 'YOUR API KEY'
763
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
764
+ # config.api_key_prefix['clientId'] = 'Bearer'
765
+
766
+ # Configure API key authorization: clientSecret
767
+ config.api_key['clientSecret'] = 'YOUR API KEY'
768
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
769
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
770
+ end
771
+
772
+ api_instance = Buildium::RentalPropertiesApi.new
773
+ property_id = 56 # Integer |
774
+ image_id = 56 # Integer |
775
+
776
+ begin
777
+ # Retrieve a property image
778
+ result = api_instance.get_rental_image_by_id(property_id, image_id)
779
+ p result
780
+ rescue Buildium::ApiError => e
781
+ puts "Error when calling RentalPropertiesApi->get_rental_image_by_id: #{e}"
782
+ end
783
+ ```
784
+
785
+ #### Using the get_rental_image_by_id_with_http_info variant
786
+
787
+ This returns an Array which contains the response data, status code and headers.
788
+
789
+ > <Array(<RentalImageMessage>, Integer, Hash)> get_rental_image_by_id_with_http_info(property_id, image_id)
790
+
791
+ ```ruby
792
+ begin
793
+ # Retrieve a property image
794
+ data, status_code, headers = api_instance.get_rental_image_by_id_with_http_info(property_id, image_id)
795
+ p status_code # => 2xx
796
+ p headers # => { ... }
797
+ p data # => <RentalImageMessage>
798
+ rescue Buildium::ApiError => e
799
+ puts "Error when calling RentalPropertiesApi->get_rental_image_by_id_with_http_info: #{e}"
800
+ end
801
+ ```
802
+
803
+ ### Parameters
804
+
805
+ | Name | Type | Description | Notes |
806
+ | ---- | ---- | ----------- | ----- |
807
+ | **property_id** | **Integer** | | |
808
+ | **image_id** | **Integer** | | |
809
+
810
+ ### Return type
811
+
812
+ [**RentalImageMessage**](RentalImageMessage.md)
813
+
814
+ ### Authorization
815
+
816
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
817
+
818
+ ### HTTP request headers
819
+
820
+ - **Content-Type**: Not defined
821
+ - **Accept**: application/json
822
+
823
+
824
+ ## get_rental_image_download_url_by_id
825
+
826
+ > <FileDownloadMessage> get_rental_image_download_url_by_id(property_id, image_id)
827
+
828
+ Download a property image
829
+
830
+ Use this endpoint to create a temporary URL that can be used to download a property image. This URL expires after 5 minutes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
831
+
832
+ ### Examples
833
+
834
+ ```ruby
835
+ require 'time'
836
+ require 'buildium-ruby'
837
+ # setup authorization
838
+ Buildium.configure do |config|
839
+ # Configure API key authorization: clientId
840
+ config.api_key['clientId'] = 'YOUR API KEY'
841
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
842
+ # config.api_key_prefix['clientId'] = 'Bearer'
843
+
844
+ # Configure API key authorization: clientSecret
845
+ config.api_key['clientSecret'] = 'YOUR API KEY'
846
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
847
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
848
+ end
849
+
850
+ api_instance = Buildium::RentalPropertiesApi.new
851
+ property_id = 56 # Integer |
852
+ image_id = 56 # Integer |
853
+
854
+ begin
855
+ # Download a property image
856
+ result = api_instance.get_rental_image_download_url_by_id(property_id, image_id)
857
+ p result
858
+ rescue Buildium::ApiError => e
859
+ puts "Error when calling RentalPropertiesApi->get_rental_image_download_url_by_id: #{e}"
860
+ end
861
+ ```
862
+
863
+ #### Using the get_rental_image_download_url_by_id_with_http_info variant
864
+
865
+ This returns an Array which contains the response data, status code and headers.
866
+
867
+ > <Array(<FileDownloadMessage>, Integer, Hash)> get_rental_image_download_url_by_id_with_http_info(property_id, image_id)
868
+
869
+ ```ruby
870
+ begin
871
+ # Download a property image
872
+ data, status_code, headers = api_instance.get_rental_image_download_url_by_id_with_http_info(property_id, image_id)
873
+ p status_code # => 2xx
874
+ p headers # => { ... }
875
+ p data # => <FileDownloadMessage>
876
+ rescue Buildium::ApiError => e
877
+ puts "Error when calling RentalPropertiesApi->get_rental_image_download_url_by_id_with_http_info: #{e}"
878
+ end
879
+ ```
880
+
881
+ ### Parameters
882
+
883
+ | Name | Type | Description | Notes |
884
+ | ---- | ---- | ----------- | ----- |
885
+ | **property_id** | **Integer** | | |
886
+ | **image_id** | **Integer** | | |
887
+
888
+ ### Return type
889
+
890
+ [**FileDownloadMessage**](FileDownloadMessage.md)
891
+
892
+ ### Authorization
893
+
894
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
895
+
896
+ ### HTTP request headers
897
+
898
+ - **Content-Type**: Not defined
899
+ - **Accept**: application/json
900
+
901
+
902
+ ## get_rental_images
903
+
904
+ > <Array<RentalImageMessage>> get_rental_images(property_id, opts)
905
+
906
+ Retrieve all property images
907
+
908
+ Retrieves all images for a rental property. Note this endpoint will only return file metadata such as file names and descriptions. To download files make requests to the [Download File](#tag/Rental-Properties/operation/GetRentalImageDownloadUrlById) endpoint. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
909
+
910
+ ### Examples
911
+
912
+ ```ruby
913
+ require 'time'
914
+ require 'buildium-ruby'
915
+ # setup authorization
916
+ Buildium.configure do |config|
917
+ # Configure API key authorization: clientId
918
+ config.api_key['clientId'] = 'YOUR API KEY'
919
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
920
+ # config.api_key_prefix['clientId'] = 'Bearer'
921
+
922
+ # Configure API key authorization: clientSecret
923
+ config.api_key['clientSecret'] = 'YOUR API KEY'
924
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
925
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
926
+ end
927
+
928
+ api_instance = Buildium::RentalPropertiesApi.new
929
+ property_id = 56 # Integer |
930
+ opts = {
931
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
932
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
933
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
934
+ }
935
+
936
+ begin
937
+ # Retrieve all property images
938
+ result = api_instance.get_rental_images(property_id, opts)
939
+ p result
940
+ rescue Buildium::ApiError => e
941
+ puts "Error when calling RentalPropertiesApi->get_rental_images: #{e}"
942
+ end
943
+ ```
944
+
945
+ #### Using the get_rental_images_with_http_info variant
946
+
947
+ This returns an Array which contains the response data, status code and headers.
948
+
949
+ > <Array(<Array<RentalImageMessage>>, Integer, Hash)> get_rental_images_with_http_info(property_id, opts)
950
+
951
+ ```ruby
952
+ begin
953
+ # Retrieve all property images
954
+ data, status_code, headers = api_instance.get_rental_images_with_http_info(property_id, opts)
955
+ p status_code # => 2xx
956
+ p headers # => { ... }
957
+ p data # => <Array<RentalImageMessage>>
958
+ rescue Buildium::ApiError => e
959
+ puts "Error when calling RentalPropertiesApi->get_rental_images_with_http_info: #{e}"
960
+ end
961
+ ```
962
+
963
+ ### Parameters
964
+
965
+ | Name | Type | Description | Notes |
966
+ | ---- | ---- | ----------- | ----- |
967
+ | **property_id** | **Integer** | | |
968
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
969
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
970
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
971
+
972
+ ### Return type
973
+
974
+ [**Array&lt;RentalImageMessage&gt;**](RentalImageMessage.md)
975
+
976
+ ### Authorization
977
+
978
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
979
+
980
+ ### HTTP request headers
981
+
982
+ - **Content-Type**: Not defined
983
+ - **Accept**: application/json
984
+
985
+
986
+ ## get_rental_note_by_note_id
987
+
988
+ > <NoteMessage> get_rental_note_by_note_id(property_id, note_id)
989
+
990
+ Retrieve a note
991
+
992
+ Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
993
+
994
+ ### Examples
995
+
996
+ ```ruby
997
+ require 'time'
998
+ require 'buildium-ruby'
999
+ # setup authorization
1000
+ Buildium.configure do |config|
1001
+ # Configure API key authorization: clientId
1002
+ config.api_key['clientId'] = 'YOUR API KEY'
1003
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1004
+ # config.api_key_prefix['clientId'] = 'Bearer'
1005
+
1006
+ # Configure API key authorization: clientSecret
1007
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1008
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1009
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1010
+ end
1011
+
1012
+ api_instance = Buildium::RentalPropertiesApi.new
1013
+ property_id = 56 # Integer |
1014
+ note_id = 56 # Integer |
1015
+
1016
+ begin
1017
+ # Retrieve a note
1018
+ result = api_instance.get_rental_note_by_note_id(property_id, note_id)
1019
+ p result
1020
+ rescue Buildium::ApiError => e
1021
+ puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id: #{e}"
56
1022
  end
57
1023
  ```
58
1024
 
59
- #### Using the create_rental_property_with_http_info variant
1025
+ #### Using the get_rental_note_by_note_id_with_http_info variant
60
1026
 
61
1027
  This returns an Array which contains the response data, status code and headers.
62
1028
 
63
- > <Array(<RentalMessage>, Integer, Hash)> create_rental_property_with_http_info(rental_property_post_message)
1029
+ > <Array(<NoteMessage>, Integer, Hash)> get_rental_note_by_note_id_with_http_info(property_id, note_id)
64
1030
 
65
1031
  ```ruby
66
1032
  begin
67
- # Create a property
68
- data, status_code, headers = api_instance.create_rental_property_with_http_info(rental_property_post_message)
1033
+ # Retrieve a note
1034
+ data, status_code, headers = api_instance.get_rental_note_by_note_id_with_http_info(property_id, note_id)
69
1035
  p status_code # => 2xx
70
1036
  p headers # => { ... }
71
- p data # => <RentalMessage>
1037
+ p data # => <NoteMessage>
72
1038
  rescue Buildium::ApiError => e
73
- puts "Error when calling RentalPropertiesApi->create_rental_property_with_http_info: #{e}"
1039
+ puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id_with_http_info: #{e}"
74
1040
  end
75
1041
  ```
76
1042
 
@@ -78,11 +1044,12 @@ end
78
1044
 
79
1045
  | Name | Type | Description | Notes |
80
1046
  | ---- | ---- | ----------- | ----- |
81
- | **rental_property_post_message** | [**RentalPropertyPostMessage**](RentalPropertyPostMessage.md) | | |
1047
+ | **property_id** | **Integer** | | |
1048
+ | **note_id** | **Integer** | | |
82
1049
 
83
1050
  ### Return type
84
1051
 
85
- [**RentalMessage**](RentalMessage.md)
1052
+ [**NoteMessage**](NoteMessage.md)
86
1053
 
87
1054
  ### Authorization
88
1055
 
@@ -90,17 +1057,17 @@ end
90
1057
 
91
1058
  ### HTTP request headers
92
1059
 
93
- - **Content-Type**: application/json
1060
+ - **Content-Type**: Not defined
94
1061
  - **Accept**: application/json
95
1062
 
96
1063
 
97
- ## create_rental_property_note
1064
+ ## get_rental_notes
98
1065
 
99
- > <NoteMessage> create_rental_property_note(property_id, note_post_message)
1066
+ > <Array<NoteMessage>> get_rental_notes(property_id, opts)
100
1067
 
101
- Create a note
1068
+ Retrieve all notes
102
1069
 
103
- Creates a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
1070
+ Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
104
1071
 
105
1072
  ### Examples
106
1073
 
@@ -122,32 +1089,39 @@ end
122
1089
 
123
1090
  api_instance = Buildium::RentalPropertiesApi.new
124
1091
  property_id = 56 # Integer |
125
- note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
1092
+ opts = {
1093
+ updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
1094
+ updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
1095
+ lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
1096
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1097
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1098
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1099
+ }
126
1100
 
127
1101
  begin
128
- # Create a note
129
- result = api_instance.create_rental_property_note(property_id, note_post_message)
1102
+ # Retrieve all notes
1103
+ result = api_instance.get_rental_notes(property_id, opts)
130
1104
  p result
131
1105
  rescue Buildium::ApiError => e
132
- puts "Error when calling RentalPropertiesApi->create_rental_property_note: #{e}"
1106
+ puts "Error when calling RentalPropertiesApi->get_rental_notes: #{e}"
133
1107
  end
134
1108
  ```
135
1109
 
136
- #### Using the create_rental_property_note_with_http_info variant
1110
+ #### Using the get_rental_notes_with_http_info variant
137
1111
 
138
1112
  This returns an Array which contains the response data, status code and headers.
139
1113
 
140
- > <Array(<NoteMessage>, Integer, Hash)> create_rental_property_note_with_http_info(property_id, note_post_message)
1114
+ > <Array(<Array<NoteMessage>>, Integer, Hash)> get_rental_notes_with_http_info(property_id, opts)
141
1115
 
142
1116
  ```ruby
143
1117
  begin
144
- # Create a note
145
- data, status_code, headers = api_instance.create_rental_property_note_with_http_info(property_id, note_post_message)
1118
+ # Retrieve all notes
1119
+ data, status_code, headers = api_instance.get_rental_notes_with_http_info(property_id, opts)
146
1120
  p status_code # => 2xx
147
1121
  p headers # => { ... }
148
- p data # => <NoteMessage>
1122
+ p data # => <Array<NoteMessage>>
149
1123
  rescue Buildium::ApiError => e
150
- puts "Error when calling RentalPropertiesApi->create_rental_property_note_with_http_info: #{e}"
1124
+ puts "Error when calling RentalPropertiesApi->get_rental_notes_with_http_info: #{e}"
151
1125
  end
152
1126
  ```
153
1127
 
@@ -156,11 +1130,16 @@ end
156
1130
  | Name | Type | Description | Notes |
157
1131
  | ---- | ---- | ----------- | ----- |
158
1132
  | **property_id** | **Integer** | | |
159
- | **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
1133
+ | **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
1134
+ | **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
1135
+ | **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
1136
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1137
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1138
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
160
1139
 
161
1140
  ### Return type
162
1141
 
163
- [**NoteMessage**](NoteMessage.md)
1142
+ [**Array&lt;NoteMessage&gt;**](NoteMessage.md)
164
1143
 
165
1144
  ### Authorization
166
1145
 
@@ -168,17 +1147,17 @@ end
168
1147
 
169
1148
  ### HTTP request headers
170
1149
 
171
- - **Content-Type**: application/json
1150
+ - **Content-Type**: Not defined
172
1151
  - **Accept**: application/json
173
1152
 
174
1153
 
175
- ## get_all_rentals
1154
+ ## get_rental_preferred_vendors
176
1155
 
177
- > <Array<RentalMessage>> get_all_rentals(opts)
1156
+ > <Array<RentalPreferredVendorMessage>> get_rental_preferred_vendors(property_id, opts)
178
1157
 
179
- Retrieve all properties
1158
+ Retrieve all preferred vendors
180
1159
 
181
- Retrieves a list of rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
1160
+ Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`
182
1161
 
183
1162
  ### Examples
184
1163
 
@@ -199,44 +1178,37 @@ Buildium.configure do |config|
199
1178
  end
200
1179
 
201
1180
  api_instance = Buildium::RentalPropertiesApi.new
1181
+ property_id = 56 # Integer |
202
1182
  opts = {
203
- location: 'location_example', # String | Filters results to only rental properties whose city or state *contains* the specified value.
204
- types: ['Residential'], # Array<String> | Filters results by the rental type. If no type is provided all types will be returned.
205
- subtypes: ['CondoTownhome'], # Array<String> | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.
206
- status: 'Active', # String | Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned.
207
- rentalownerids: [37], # Array<Integer> | Filters results to only rental properties whose RentalOwnerId matches the specified Id.
208
- propertyids: [37], # Array<Integer> | Filters results to only rental properties units whose Rental matches the specified Id.
209
- lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
210
- lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
211
1183
  orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
212
1184
  offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
213
1185
  limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
214
1186
  }
215
1187
 
216
1188
  begin
217
- # Retrieve all properties
218
- result = api_instance.get_all_rentals(opts)
1189
+ # Retrieve all preferred vendors
1190
+ result = api_instance.get_rental_preferred_vendors(property_id, opts)
219
1191
  p result
220
1192
  rescue Buildium::ApiError => e
221
- puts "Error when calling RentalPropertiesApi->get_all_rentals: #{e}"
1193
+ puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors: #{e}"
222
1194
  end
223
1195
  ```
224
1196
 
225
- #### Using the get_all_rentals_with_http_info variant
1197
+ #### Using the get_rental_preferred_vendors_with_http_info variant
226
1198
 
227
1199
  This returns an Array which contains the response data, status code and headers.
228
1200
 
229
- > <Array(<Array<RentalMessage>>, Integer, Hash)> get_all_rentals_with_http_info(opts)
1201
+ > <Array(<Array<RentalPreferredVendorMessage>>, Integer, Hash)> get_rental_preferred_vendors_with_http_info(property_id, opts)
230
1202
 
231
1203
  ```ruby
232
1204
  begin
233
- # Retrieve all properties
234
- data, status_code, headers = api_instance.get_all_rentals_with_http_info(opts)
1205
+ # Retrieve all preferred vendors
1206
+ data, status_code, headers = api_instance.get_rental_preferred_vendors_with_http_info(property_id, opts)
235
1207
  p status_code # => 2xx
236
1208
  p headers # => { ... }
237
- p data # => <Array<RentalMessage>>
1209
+ p data # => <Array<RentalPreferredVendorMessage>>
238
1210
  rescue Buildium::ApiError => e
239
- puts "Error when calling RentalPropertiesApi->get_all_rentals_with_http_info: #{e}"
1211
+ puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors_with_http_info: #{e}"
240
1212
  end
241
1213
  ```
242
1214
 
@@ -244,21 +1216,14 @@ end
244
1216
 
245
1217
  | Name | Type | Description | Notes |
246
1218
  | ---- | ---- | ----------- | ----- |
247
- | **location** | **String** | Filters results to only rental properties whose city or state *contains* the specified value. | [optional] |
248
- | **types** | [**Array&lt;String&gt;**](String.md) | Filters results by the rental type. If no type is provided all types will be returned. | [optional] |
249
- | **subtypes** | [**Array&lt;String&gt;**](String.md) | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned. | [optional] |
250
- | **status** | **String** | Filters results by the status of the rental property. If no status is specified both &#x60;active&#x60; and &#x60;inactive&#x60; rental properties will be returned. | [optional] |
251
- | **rentalownerids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties whose RentalOwnerId matches the specified Id. | [optional] |
252
- | **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties units whose Rental matches the specified Id. | [optional] |
253
- | **lastupdatedfrom** | **Time** | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
254
- | **lastupdatedto** | **Time** | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
1219
+ | **property_id** | **Integer** | | |
255
1220
  | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
256
1221
  | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
257
1222
  | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
258
1223
 
259
1224
  ### Return type
260
1225
 
261
- [**Array&lt;RentalMessage&gt;**](RentalMessage.md)
1226
+ [**Array&lt;RentalPreferredVendorMessage&gt;**](RentalPreferredVendorMessage.md)
262
1227
 
263
1228
  ### Authorization
264
1229
 
@@ -270,13 +1235,13 @@ end
270
1235
  - **Accept**: application/json
271
1236
 
272
1237
 
273
- ## get_features_by_rental_property_id
1238
+ ## inactivate_rental_property
274
1239
 
275
- > <RentalFeaturesMessage> get_features_by_rental_property_id(property_id)
1240
+ > inactivate_rental_property(property_id)
276
1241
 
277
- Retrieve all amenities
1242
+ Inactivate a property
278
1243
 
279
- Retrieve all the amenities for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
1244
+ Inactivates a rental property and all associated units. Any associated property's owners that have no remaining active properties will be inactivated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
280
1245
 
281
1246
  ### Examples
282
1247
 
@@ -300,29 +1265,28 @@ api_instance = Buildium::RentalPropertiesApi.new
300
1265
  property_id = 56 # Integer |
301
1266
 
302
1267
  begin
303
- # Retrieve all amenities
304
- result = api_instance.get_features_by_rental_property_id(property_id)
305
- p result
1268
+ # Inactivate a property
1269
+ api_instance.inactivate_rental_property(property_id)
306
1270
  rescue Buildium::ApiError => e
307
- puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id: #{e}"
1271
+ puts "Error when calling RentalPropertiesApi->inactivate_rental_property: #{e}"
308
1272
  end
309
1273
  ```
310
1274
 
311
- #### Using the get_features_by_rental_property_id_with_http_info variant
1275
+ #### Using the inactivate_rental_property_with_http_info variant
312
1276
 
313
- This returns an Array which contains the response data, status code and headers.
1277
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
314
1278
 
315
- > <Array(<RentalFeaturesMessage>, Integer, Hash)> get_features_by_rental_property_id_with_http_info(property_id)
1279
+ > <Array(nil, Integer, Hash)> inactivate_rental_property_with_http_info(property_id)
316
1280
 
317
1281
  ```ruby
318
1282
  begin
319
- # Retrieve all amenities
320
- data, status_code, headers = api_instance.get_features_by_rental_property_id_with_http_info(property_id)
1283
+ # Inactivate a property
1284
+ data, status_code, headers = api_instance.inactivate_rental_property_with_http_info(property_id)
321
1285
  p status_code # => 2xx
322
1286
  p headers # => { ... }
323
- p data # => <RentalFeaturesMessage>
1287
+ p data # => nil
324
1288
  rescue Buildium::ApiError => e
325
- puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id_with_http_info: #{e}"
1289
+ puts "Error when calling RentalPropertiesApi->inactivate_rental_property_with_http_info: #{e}"
326
1290
  end
327
1291
  ```
328
1292
 
@@ -334,7 +1298,7 @@ end
334
1298
 
335
1299
  ### Return type
336
1300
 
337
- [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
1301
+ nil (empty response body)
338
1302
 
339
1303
  ### Authorization
340
1304
 
@@ -346,13 +1310,13 @@ end
346
1310
  - **Accept**: application/json
347
1311
 
348
1312
 
349
- ## get_rental_by_id
1313
+ ## reactivate_rental_property
350
1314
 
351
- > <RentalMessage> get_rental_by_id(property_id)
1315
+ > reactivate_rental_property(property_id)
352
1316
 
353
- Retrieve a property
1317
+ Reactivate a property
354
1318
 
355
- Retrieve a specific rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
1319
+ Reactivates a rental property and all associated units. Any inactive rental owners assigned to this property will also be reactivated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
356
1320
 
357
1321
  ### Examples
358
1322
 
@@ -373,32 +1337,31 @@ Buildium.configure do |config|
373
1337
  end
374
1338
 
375
1339
  api_instance = Buildium::RentalPropertiesApi.new
376
- property_id = 56 # Integer | The rental property identifier.
1340
+ property_id = 56 # Integer |
377
1341
 
378
1342
  begin
379
- # Retrieve a property
380
- result = api_instance.get_rental_by_id(property_id)
381
- p result
1343
+ # Reactivate a property
1344
+ api_instance.reactivate_rental_property(property_id)
382
1345
  rescue Buildium::ApiError => e
383
- puts "Error when calling RentalPropertiesApi->get_rental_by_id: #{e}"
1346
+ puts "Error when calling RentalPropertiesApi->reactivate_rental_property: #{e}"
384
1347
  end
385
1348
  ```
386
1349
 
387
- #### Using the get_rental_by_id_with_http_info variant
1350
+ #### Using the reactivate_rental_property_with_http_info variant
388
1351
 
389
- This returns an Array which contains the response data, status code and headers.
1352
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
390
1353
 
391
- > <Array(<RentalMessage>, Integer, Hash)> get_rental_by_id_with_http_info(property_id)
1354
+ > <Array(nil, Integer, Hash)> reactivate_rental_property_with_http_info(property_id)
392
1355
 
393
1356
  ```ruby
394
1357
  begin
395
- # Retrieve a property
396
- data, status_code, headers = api_instance.get_rental_by_id_with_http_info(property_id)
1358
+ # Reactivate a property
1359
+ data, status_code, headers = api_instance.reactivate_rental_property_with_http_info(property_id)
397
1360
  p status_code # => 2xx
398
1361
  p headers # => { ... }
399
- p data # => <RentalMessage>
1362
+ p data # => nil
400
1363
  rescue Buildium::ApiError => e
401
- puts "Error when calling RentalPropertiesApi->get_rental_by_id_with_http_info: #{e}"
1364
+ puts "Error when calling RentalPropertiesApi->reactivate_rental_property_with_http_info: #{e}"
402
1365
  end
403
1366
  ```
404
1367
 
@@ -406,11 +1369,11 @@ end
406
1369
 
407
1370
  | Name | Type | Description | Notes |
408
1371
  | ---- | ---- | ----------- | ----- |
409
- | **property_id** | **Integer** | The rental property identifier. | |
1372
+ | **property_id** | **Integer** | | |
410
1373
 
411
1374
  ### Return type
412
1375
 
413
- [**RentalMessage**](RentalMessage.md)
1376
+ nil (empty response body)
414
1377
 
415
1378
  ### Authorization
416
1379
 
@@ -422,13 +1385,13 @@ end
422
1385
  - **Accept**: application/json
423
1386
 
424
1387
 
425
- ## get_rental_note_by_note_id
1388
+ ## reorder_rental_images
426
1389
 
427
- > <NoteMessage> get_rental_note_by_note_id(property_id, note_id)
1390
+ > <Array<RentalImageMessage>> reorder_rental_images(property_id, image_reorder_request_put_message)
428
1391
 
429
- Retrieve a note
1392
+ Update property image order
430
1393
 
431
- Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
1394
+ Updates the image display order within the Buildium web application and in any associated rental listings. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
432
1395
 
433
1396
  ### Examples
434
1397
 
@@ -450,32 +1413,32 @@ end
450
1413
 
451
1414
  api_instance = Buildium::RentalPropertiesApi.new
452
1415
  property_id = 56 # Integer |
453
- note_id = 56 # Integer |
1416
+ image_reorder_request_put_message = Buildium::ImageReorderRequestPutMessage.new({ids: [37]}) # ImageReorderRequestPutMessage |
454
1417
 
455
1418
  begin
456
- # Retrieve a note
457
- result = api_instance.get_rental_note_by_note_id(property_id, note_id)
1419
+ # Update property image order
1420
+ result = api_instance.reorder_rental_images(property_id, image_reorder_request_put_message)
458
1421
  p result
459
1422
  rescue Buildium::ApiError => e
460
- puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id: #{e}"
1423
+ puts "Error when calling RentalPropertiesApi->reorder_rental_images: #{e}"
461
1424
  end
462
1425
  ```
463
1426
 
464
- #### Using the get_rental_note_by_note_id_with_http_info variant
1427
+ #### Using the reorder_rental_images_with_http_info variant
465
1428
 
466
1429
  This returns an Array which contains the response data, status code and headers.
467
1430
 
468
- > <Array(<NoteMessage>, Integer, Hash)> get_rental_note_by_note_id_with_http_info(property_id, note_id)
1431
+ > <Array(<Array<RentalImageMessage>>, Integer, Hash)> reorder_rental_images_with_http_info(property_id, image_reorder_request_put_message)
469
1432
 
470
1433
  ```ruby
471
1434
  begin
472
- # Retrieve a note
473
- data, status_code, headers = api_instance.get_rental_note_by_note_id_with_http_info(property_id, note_id)
1435
+ # Update property image order
1436
+ data, status_code, headers = api_instance.reorder_rental_images_with_http_info(property_id, image_reorder_request_put_message)
474
1437
  p status_code # => 2xx
475
1438
  p headers # => { ... }
476
- p data # => <NoteMessage>
1439
+ p data # => <Array<RentalImageMessage>>
477
1440
  rescue Buildium::ApiError => e
478
- puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id_with_http_info: #{e}"
1441
+ puts "Error when calling RentalPropertiesApi->reorder_rental_images_with_http_info: #{e}"
479
1442
  end
480
1443
  ```
481
1444
 
@@ -484,11 +1447,11 @@ end
484
1447
  | Name | Type | Description | Notes |
485
1448
  | ---- | ---- | ----------- | ----- |
486
1449
  | **property_id** | **Integer** | | |
487
- | **note_id** | **Integer** | | |
1450
+ | **image_reorder_request_put_message** | [**ImageReorderRequestPutMessage**](ImageReorderRequestPutMessage.md) | | |
488
1451
 
489
1452
  ### Return type
490
1453
 
491
- [**NoteMessage**](NoteMessage.md)
1454
+ [**Array&lt;RentalImageMessage&gt;**](RentalImageMessage.md)
492
1455
 
493
1456
  ### Authorization
494
1457
 
@@ -496,17 +1459,17 @@ end
496
1459
 
497
1460
  ### HTTP request headers
498
1461
 
499
- - **Content-Type**: Not defined
1462
+ - **Content-Type**: application/json
500
1463
  - **Accept**: application/json
501
1464
 
502
1465
 
503
- ## get_rental_notes
1466
+ ## update_e_pay_settings_for_rental
504
1467
 
505
- > <Array<NoteMessage>> get_rental_notes(property_id, opts)
1468
+ > <EPaySettingsMessage> update_e_pay_settings_for_rental(property_id, e_pay_settings_put_message)
506
1469
 
507
- Retrieve all notes
1470
+ Update ePay settings
508
1471
 
509
- Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
1472
+ Updates ePay settings for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
510
1473
 
511
1474
  ### Examples
512
1475
 
@@ -528,39 +1491,32 @@ end
528
1491
 
529
1492
  api_instance = Buildium::RentalPropertiesApi.new
530
1493
  property_id = 56 # Integer |
531
- opts = {
532
- updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
533
- updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
534
- lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
535
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
536
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
537
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
538
- }
1494
+ e_pay_settings_put_message = Buildium::EPaySettingsPutMessage.new({eft_payments: Buildium::EFTPaymentsPutMessage.new({payments_enabled: false}), credit_card_payments: Buildium::CCPaymentsPutMessage.new({payments_enabled: false}), offline_payments: Buildium::OfflinePaymentsPutMessage.new({display_info_in_resident_center: false, display_company_address: false})}) # EPaySettingsPutMessage |
539
1495
 
540
1496
  begin
541
- # Retrieve all notes
542
- result = api_instance.get_rental_notes(property_id, opts)
1497
+ # Update ePay settings
1498
+ result = api_instance.update_e_pay_settings_for_rental(property_id, e_pay_settings_put_message)
543
1499
  p result
544
1500
  rescue Buildium::ApiError => e
545
- puts "Error when calling RentalPropertiesApi->get_rental_notes: #{e}"
1501
+ puts "Error when calling RentalPropertiesApi->update_e_pay_settings_for_rental: #{e}"
546
1502
  end
547
1503
  ```
548
1504
 
549
- #### Using the get_rental_notes_with_http_info variant
1505
+ #### Using the update_e_pay_settings_for_rental_with_http_info variant
550
1506
 
551
1507
  This returns an Array which contains the response data, status code and headers.
552
1508
 
553
- > <Array(<Array<NoteMessage>>, Integer, Hash)> get_rental_notes_with_http_info(property_id, opts)
1509
+ > <Array(<EPaySettingsMessage>, Integer, Hash)> update_e_pay_settings_for_rental_with_http_info(property_id, e_pay_settings_put_message)
554
1510
 
555
1511
  ```ruby
556
1512
  begin
557
- # Retrieve all notes
558
- data, status_code, headers = api_instance.get_rental_notes_with_http_info(property_id, opts)
1513
+ # Update ePay settings
1514
+ data, status_code, headers = api_instance.update_e_pay_settings_for_rental_with_http_info(property_id, e_pay_settings_put_message)
559
1515
  p status_code # => 2xx
560
1516
  p headers # => { ... }
561
- p data # => <Array<NoteMessage>>
1517
+ p data # => <EPaySettingsMessage>
562
1518
  rescue Buildium::ApiError => e
563
- puts "Error when calling RentalPropertiesApi->get_rental_notes_with_http_info: #{e}"
1519
+ puts "Error when calling RentalPropertiesApi->update_e_pay_settings_for_rental_with_http_info: #{e}"
564
1520
  end
565
1521
  ```
566
1522
 
@@ -569,16 +1525,11 @@ end
569
1525
  | Name | Type | Description | Notes |
570
1526
  | ---- | ---- | ----------- | ----- |
571
1527
  | **property_id** | **Integer** | | |
572
- | **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
573
- | **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
574
- | **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
575
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
576
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
577
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1528
+ | **e_pay_settings_put_message** | [**EPaySettingsPutMessage**](EPaySettingsPutMessage.md) | | |
578
1529
 
579
1530
  ### Return type
580
1531
 
581
- [**Array&lt;NoteMessage&gt;**](NoteMessage.md)
1532
+ [**EPaySettingsMessage**](EPaySettingsMessage.md)
582
1533
 
583
1534
  ### Authorization
584
1535
 
@@ -586,17 +1537,17 @@ end
586
1537
 
587
1538
  ### HTTP request headers
588
1539
 
589
- - **Content-Type**: Not defined
1540
+ - **Content-Type**: application/json
590
1541
  - **Accept**: application/json
591
1542
 
592
1543
 
593
- ## get_rental_preferred_vendors
1544
+ ## update_rental_features
594
1545
 
595
- > <Array<RentalPreferredVendorMessage>> get_rental_preferred_vendors(property_id, opts)
1546
+ > <RentalFeaturesMessage> update_rental_features(property_id, rental_features_put_message)
596
1547
 
597
- Retrieve all preferred vendors
1548
+ Update amenities
598
1549
 
599
- Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`
1550
+ Updates the amenities for a rental property. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
600
1551
 
601
1552
  ### Examples
602
1553
 
@@ -618,36 +1569,32 @@ end
618
1569
 
619
1570
  api_instance = Buildium::RentalPropertiesApi.new
620
1571
  property_id = 56 # Integer |
621
- opts = {
622
- orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
623
- offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
624
- limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
625
- }
1572
+ rental_features_put_message = Buildium::RentalFeaturesPutMessage.new # RentalFeaturesPutMessage |
626
1573
 
627
1574
  begin
628
- # Retrieve all preferred vendors
629
- result = api_instance.get_rental_preferred_vendors(property_id, opts)
1575
+ # Update amenities
1576
+ result = api_instance.update_rental_features(property_id, rental_features_put_message)
630
1577
  p result
631
1578
  rescue Buildium::ApiError => e
632
- puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors: #{e}"
1579
+ puts "Error when calling RentalPropertiesApi->update_rental_features: #{e}"
633
1580
  end
634
1581
  ```
635
1582
 
636
- #### Using the get_rental_preferred_vendors_with_http_info variant
1583
+ #### Using the update_rental_features_with_http_info variant
637
1584
 
638
1585
  This returns an Array which contains the response data, status code and headers.
639
1586
 
640
- > <Array(<Array<RentalPreferredVendorMessage>>, Integer, Hash)> get_rental_preferred_vendors_with_http_info(property_id, opts)
1587
+ > <Array(<RentalFeaturesMessage>, Integer, Hash)> update_rental_features_with_http_info(property_id, rental_features_put_message)
641
1588
 
642
1589
  ```ruby
643
1590
  begin
644
- # Retrieve all preferred vendors
645
- data, status_code, headers = api_instance.get_rental_preferred_vendors_with_http_info(property_id, opts)
1591
+ # Update amenities
1592
+ data, status_code, headers = api_instance.update_rental_features_with_http_info(property_id, rental_features_put_message)
646
1593
  p status_code # => 2xx
647
1594
  p headers # => { ... }
648
- p data # => <Array<RentalPreferredVendorMessage>>
1595
+ p data # => <RentalFeaturesMessage>
649
1596
  rescue Buildium::ApiError => e
650
- puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors_with_http_info: #{e}"
1597
+ puts "Error when calling RentalPropertiesApi->update_rental_features_with_http_info: #{e}"
651
1598
  end
652
1599
  ```
653
1600
 
@@ -656,13 +1603,11 @@ end
656
1603
  | Name | Type | Description | Notes |
657
1604
  | ---- | ---- | ----------- | ----- |
658
1605
  | **property_id** | **Integer** | | |
659
- | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
660
- | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
661
- | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
1606
+ | **rental_features_put_message** | [**RentalFeaturesPutMessage**](RentalFeaturesPutMessage.md) | | |
662
1607
 
663
1608
  ### Return type
664
1609
 
665
- [**Array&lt;RentalPreferredVendorMessage&gt;**](RentalPreferredVendorMessage.md)
1610
+ [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
666
1611
 
667
1612
  ### Authorization
668
1613
 
@@ -670,17 +1615,17 @@ end
670
1615
 
671
1616
  ### HTTP request headers
672
1617
 
673
- - **Content-Type**: Not defined
1618
+ - **Content-Type**: application/json
674
1619
  - **Accept**: application/json
675
1620
 
676
1621
 
677
- ## update_rental_features
1622
+ ## update_rental_image
678
1623
 
679
- > <RentalFeaturesMessage> update_rental_features(property_id, rental_features_put_message)
1624
+ > <RentalImageMessage> update_rental_image(property_id, image_id, rental_image_put_message)
680
1625
 
681
- Update amenities
1626
+ Update a property image
682
1627
 
683
- Updates the amenities for a rental property. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
1628
+ Updates a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
684
1629
 
685
1630
  ### Examples
686
1631
 
@@ -702,32 +1647,33 @@ end
702
1647
 
703
1648
  api_instance = Buildium::RentalPropertiesApi.new
704
1649
  property_id = 56 # Integer |
705
- rental_features_put_message = Buildium::RentalFeaturesPutMessage.new # RentalFeaturesPutMessage |
1650
+ image_id = 56 # Integer |
1651
+ rental_image_put_message = Buildium::RentalImagePutMessage.new({show_in_listing: false}) # RentalImagePutMessage |
706
1652
 
707
1653
  begin
708
- # Update amenities
709
- result = api_instance.update_rental_features(property_id, rental_features_put_message)
1654
+ # Update a property image
1655
+ result = api_instance.update_rental_image(property_id, image_id, rental_image_put_message)
710
1656
  p result
711
1657
  rescue Buildium::ApiError => e
712
- puts "Error when calling RentalPropertiesApi->update_rental_features: #{e}"
1658
+ puts "Error when calling RentalPropertiesApi->update_rental_image: #{e}"
713
1659
  end
714
1660
  ```
715
1661
 
716
- #### Using the update_rental_features_with_http_info variant
1662
+ #### Using the update_rental_image_with_http_info variant
717
1663
 
718
1664
  This returns an Array which contains the response data, status code and headers.
719
1665
 
720
- > <Array(<RentalFeaturesMessage>, Integer, Hash)> update_rental_features_with_http_info(property_id, rental_features_put_message)
1666
+ > <Array(<RentalImageMessage>, Integer, Hash)> update_rental_image_with_http_info(property_id, image_id, rental_image_put_message)
721
1667
 
722
1668
  ```ruby
723
1669
  begin
724
- # Update amenities
725
- data, status_code, headers = api_instance.update_rental_features_with_http_info(property_id, rental_features_put_message)
1670
+ # Update a property image
1671
+ data, status_code, headers = api_instance.update_rental_image_with_http_info(property_id, image_id, rental_image_put_message)
726
1672
  p status_code # => 2xx
727
1673
  p headers # => { ... }
728
- p data # => <RentalFeaturesMessage>
1674
+ p data # => <RentalImageMessage>
729
1675
  rescue Buildium::ApiError => e
730
- puts "Error when calling RentalPropertiesApi->update_rental_features_with_http_info: #{e}"
1676
+ puts "Error when calling RentalPropertiesApi->update_rental_image_with_http_info: #{e}"
731
1677
  end
732
1678
  ```
733
1679
 
@@ -736,11 +1682,12 @@ end
736
1682
  | Name | Type | Description | Notes |
737
1683
  | ---- | ---- | ----------- | ----- |
738
1684
  | **property_id** | **Integer** | | |
739
- | **rental_features_put_message** | [**RentalFeaturesPutMessage**](RentalFeaturesPutMessage.md) | | |
1685
+ | **image_id** | **Integer** | | |
1686
+ | **rental_image_put_message** | [**RentalImagePutMessage**](RentalImagePutMessage.md) | | |
740
1687
 
741
1688
  ### Return type
742
1689
 
743
- [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
1690
+ [**RentalImageMessage**](RentalImageMessage.md)
744
1691
 
745
1692
  ### Authorization
746
1693