buildium-ruby 2.0.1 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1060) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +1 -3
  3. data/.github/workflows/publish.yml +2 -2
  4. data/.openapi-generator/FILES +200 -405
  5. data/.openapi-generator/templates/ruby-client/Gemfile.mustache +3 -0
  6. data/.openapi-generator/templates/ruby-client/gemspec.mustache +1 -3
  7. data/.openapi-generator/templates/ruby-client/rubocop.mustache +1 -1
  8. data/.rubocop.yml +1 -1
  9. data/.tool-versions +1 -0
  10. data/CUSTOMIZATIONS.md +4 -0
  11. data/DOCS.md +404 -112
  12. data/Gemfile +1 -7
  13. data/Gemfile.lock +9 -54
  14. data/README.md +2 -2
  15. data/bin/CUSTOMIZATIONS.md +4 -0
  16. data/bin/README.md +2 -2
  17. data/bin/config.yml +5 -2
  18. data/bin/rebuild.sh +15 -9
  19. data/bin/swagger.json +17251 -8723
  20. data/buildium-ruby.gemspec +2 -4
  21. data/docs/AccountingEntityMessage.md +3 -1
  22. data/docs/AccountingEntitySaveMessage.md +3 -1
  23. data/docs/{AssociationAppliancesApi.md → AppliancesApi.md} +41 -41
  24. data/docs/ApplicantMessage.md +2 -0
  25. data/docs/AppliedVendorCreditMessage.md +20 -0
  26. data/docs/AssociationMessage.md +3 -1
  27. data/docs/AssociationMeterReadingsApi.md +344 -0
  28. data/docs/AssociationOwnershipAccountSearchMessage.md +2 -0
  29. data/docs/AssociationPostMessage.md +3 -1
  30. data/docs/AssociationSearchMessage.md +5 -1
  31. data/docs/AssociationTaxInformationMessage.md +26 -0
  32. data/docs/AssociationsApi.md +204 -217
  33. data/docs/BankAccountCheckAccountingEntitySaveMessage.md +3 -1
  34. data/docs/BankAccountCheckFileMessage.md +28 -0
  35. data/docs/BankAccountDepositPostMessage.md +1 -1
  36. data/docs/BankAccountMessage.md +3 -1
  37. data/docs/BankAccountSearchMessage.md +3 -1
  38. data/docs/BankAccountTransferAccountingEntitySaveMessage.md +3 -1
  39. data/docs/BankAccountsApi.md +412 -0
  40. data/docs/BankLockboxDataAssociationMessage.md +22 -0
  41. data/docs/BankLockboxDataAssociationOwnerMessage.md +30 -0
  42. data/docs/BankLockboxDataMessage.md +20 -0
  43. data/docs/BankLockboxDataOwnershipAccountMessage.md +26 -0
  44. data/docs/BankLockboxDataSearchMessage.md +18 -0
  45. data/docs/BillPaymentAccountingEntityMessage.md +3 -1
  46. data/docs/BillPaymentMessage.md +4 -0
  47. data/docs/BillsApi.md +1059 -0
  48. data/docs/BoardMembersApi.md +417 -0
  49. data/docs/BudgetsApi.md +329 -0
  50. data/docs/CCPaymentsMessage.md +18 -0
  51. data/docs/CCPaymentsPutMessage.md +18 -0
  52. data/docs/CancellationToken.md +22 -0
  53. data/docs/CommunicationsApi.md +39 -39
  54. data/docs/ContactRequestsApi.md +347 -0
  55. data/docs/EFTPaymentsMessage.md +18 -0
  56. data/docs/EFTPaymentsPutMessage.md +18 -0
  57. data/docs/EPaySettingsMessage.md +22 -0
  58. data/docs/EPaySettingsPutMessage.md +22 -0
  59. data/docs/FileSharingAccountMessage.md +26 -0
  60. data/docs/FileSharingAccountPutMessage.md +26 -0
  61. data/docs/FileSharingAssociationMessage.md +20 -0
  62. data/docs/FileSharingAssociationOwnerMessage.md +18 -0
  63. data/docs/FileSharingAssociationOwnerPutMessage.md +18 -0
  64. data/docs/FileSharingAssociationPutMessage.md +20 -0
  65. data/docs/FileSharingAssociationUnitMessage.md +20 -0
  66. data/docs/FileSharingAssociationUnitPutMessage.md +20 -0
  67. data/docs/FileSharingCommitteeMessage.md +22 -0
  68. data/docs/FileSharingCommitteePutMessage.md +22 -0
  69. data/docs/FileSharingLeaseMessage.md +20 -0
  70. data/docs/FileSharingLeasePutMessage.md +20 -0
  71. data/docs/FileSharingMessage.md +40 -0
  72. data/docs/FileSharingOwnershipAccountMessage.md +20 -0
  73. data/docs/FileSharingOwnershipAccountPutMessage.md +20 -0
  74. data/docs/FileSharingPutMessage.md +40 -0
  75. data/docs/FileSharingRentalMessage.md +20 -0
  76. data/docs/FileSharingRentalOwnerMessage.md +18 -0
  77. data/docs/FileSharingRentalOwnerPutMessage.md +18 -0
  78. data/docs/FileSharingRentalPutMessage.md +20 -0
  79. data/docs/FileSharingRentalUnitMesage.md +20 -0
  80. data/docs/FileSharingRentalUnitPutMesage.md +20 -0
  81. data/docs/FileSharingTenantMessage.md +20 -0
  82. data/docs/FileSharingTenantPutMessage.md +20 -0
  83. data/docs/FileSharingVendorMessage.md +18 -0
  84. data/docs/FileSharingVendorPutMessage.md +18 -0
  85. data/docs/FilesApi.md +159 -3
  86. data/docs/GeneralJournalEntryLineSaveMessage.md +1 -1
  87. data/docs/GeneralLedgerApi.md +839 -0
  88. data/docs/GeneralLedgerEntryMessage.md +30 -0
  89. data/docs/GeneralLedgerMessage.md +26 -0
  90. data/docs/GeneralLedgerSearchMessage.md +28 -0
  91. data/docs/ImageReorderRequestPutMessage.md +18 -0
  92. data/docs/InsuredTenantMessage.md +24 -0
  93. data/docs/JournalLineMessage.md +3 -1
  94. data/docs/JsonPatchOperation.md +24 -0
  95. data/docs/LeaseAutoAllocatedPaymentPostMessage.md +30 -0
  96. data/docs/LeaseLedgerPaymentPutMessage.md +28 -0
  97. data/docs/LeasePostMessage.md +5 -1
  98. data/docs/LeaseRenewalSearchMessage.md +22 -0
  99. data/docs/LeaseRentMessage.md +1 -1
  100. data/docs/LeaseTenantMessage.md +3 -1
  101. data/docs/LeaseTransactionMessage.md +3 -1
  102. data/docs/LeaseTransactionsApi.md +1627 -0
  103. data/docs/LeasesApi.md +302 -1353
  104. data/docs/ListingEntityFilePostMessage.md +22 -0
  105. data/docs/ListingsApi.md +5 -5
  106. data/docs/MeterReadingDetailMessage.md +28 -0
  107. data/docs/MeterReadingDetailPutMessage.md +24 -0
  108. data/docs/MeterReadingDetailsDeleteSearchMessage.md +20 -0
  109. data/docs/MeterReadingDetailsMessage.md +22 -0
  110. data/docs/MeterReadingDetailsPutMessage.md +22 -0
  111. data/docs/MeterReadingDetailsPutSearchMessage.md +20 -0
  112. data/docs/MeterReadingDetailsSearchMessage.md +20 -0
  113. data/docs/MeterReadingMessage.md +26 -0
  114. data/docs/MeterReadingSearchMessage.md +22 -0
  115. data/docs/MultipleBillPaymentsPostMessage.md +26 -0
  116. data/docs/OfflinePaymentsMessage.md +22 -0
  117. data/docs/OfflinePaymentsPutMessage.md +22 -0
  118. data/docs/OwnershipAccountAutoAllocatedPaymentPostMessage.md +30 -0
  119. data/docs/OwnershipAccountLedgerPaymentPutMessage.md +28 -0
  120. data/docs/OwnershipAccountTransactionMessage.md +2 -0
  121. data/docs/{AssociationOwnershipAccountsApi.md → OwnershipAccountTransactionsApi.md} +146 -644
  122. data/docs/OwnershipAccountsApi.md +667 -0
  123. data/docs/PropertyGroupsApi.md +1 -1
  124. data/docs/RentalImageMessage.md +26 -0
  125. data/docs/RentalImagePutMessage.md +20 -0
  126. data/docs/RentalMeterReadingsApi.md +344 -0
  127. data/docs/RentalOwnerContributionDataMessage.md +20 -0
  128. data/docs/RentalOwnerContributionDataPutMessage.md +20 -0
  129. data/docs/RentalOwnerContributionMessage.md +20 -0
  130. data/docs/RentalOwnerContributionPutMessage.md +20 -0
  131. data/docs/RentalOwnerContributionReminderMessage.md +20 -0
  132. data/docs/RentalOwnerContributionReminderPutMessage.md +20 -0
  133. data/docs/RentalOwnerRequestsApi.md +503 -0
  134. data/docs/RentalPropertiesApi.md +1123 -176
  135. data/docs/RentalPropertyPostMessage.md +1 -1
  136. data/docs/RentalUnitImageMessage.md +26 -0
  137. data/docs/RentalUnitImagePutMessage.md +20 -0
  138. data/docs/RentalUnitMessage.md +2 -2
  139. data/docs/RentalUnitsApi.md +639 -0
  140. data/docs/RentersInsurancePolicyMessage.md +32 -0
  141. data/docs/ResidentCenterApi.md +255 -0
  142. data/docs/ResidentRequestTaskPostMessage.md +5 -1
  143. data/docs/ResidentRequestsApi.md +349 -0
  144. data/docs/RetailCashPropertyMessage.md +24 -0
  145. data/docs/RetailCashUnitMessage.md +22 -0
  146. data/docs/RetailCashUserDataMessage.md +30 -0
  147. data/docs/RetailCashUserMessage.md +30 -0
  148. data/docs/RetailCashUserPutMessage.md +18 -0
  149. data/docs/RetailCashUsersSearchMessage.md +28 -0
  150. data/docs/SafeWaitHandle.md +20 -0
  151. data/docs/TasksApi.md +230 -1592
  152. data/docs/ToDoRequestsApi.md +347 -0
  153. data/docs/UnitEntityMessage.md +20 -0
  154. data/docs/VendorsApi.md +1 -1
  155. data/docs/VideoLinkRequestPostMessage.md +20 -0
  156. data/docs/WaitHandle.md +20 -0
  157. data/lib/buildium-ruby/api/administration_api.rb +1 -1
  158. data/lib/buildium-ruby/api/{association_appliances_api.rb → appliances_api.rb} +52 -52
  159. data/lib/buildium-ruby/api/applicants_api.rb +1 -1
  160. data/lib/buildium-ruby/api/association_meter_readings_api.rb +363 -0
  161. data/lib/buildium-ruby/api/association_owners_api.rb +1 -1
  162. data/lib/buildium-ruby/api/association_tenants_api.rb +1 -1
  163. data/lib/buildium-ruby/api/association_units_api.rb +1 -1
  164. data/lib/buildium-ruby/api/associations_api.rb +238 -284
  165. data/lib/buildium-ruby/api/bank_accounts_api.rb +387 -1
  166. data/lib/buildium-ruby/api/bills_api.rb +965 -0
  167. data/lib/buildium-ruby/api/board_members_api.rb +406 -0
  168. data/lib/buildium-ruby/api/budgets_api.rb +302 -0
  169. data/lib/buildium-ruby/api/client_leads_api.rb +1 -1
  170. data/lib/buildium-ruby/api/communications_api.rb +49 -49
  171. data/lib/buildium-ruby/api/contact_requests_api.rb +341 -0
  172. data/lib/buildium-ruby/api/files_api.rb +144 -7
  173. data/lib/buildium-ruby/api/general_ledger_api.rb +809 -0
  174. data/lib/buildium-ruby/api/lease_transactions_api.rb +1531 -0
  175. data/lib/buildium-ruby/api/leases_api.rb +193 -1191
  176. data/lib/buildium-ruby/api/listings_api.rb +5 -5
  177. data/lib/buildium-ruby/api/{association_ownership_accounts_api.rb → ownership_account_transactions_api.rb} +166 -613
  178. data/lib/buildium-ruby/api/ownership_accounts_api.rb +626 -0
  179. data/lib/buildium-ruby/api/property_groups_api.rb +3 -3
  180. data/lib/buildium-ruby/api/rental_appliances_api.rb +1 -1
  181. data/lib/buildium-ruby/api/rental_meter_readings_api.rb +363 -0
  182. data/lib/buildium-ruby/api/rental_owner_requests_api.rb +478 -0
  183. data/lib/buildium-ruby/api/rental_owners_api.rb +1 -1
  184. data/lib/buildium-ruby/api/rental_properties_api.rb +898 -54
  185. data/lib/buildium-ruby/api/rental_tenants_api.rb +1 -1
  186. data/lib/buildium-ruby/api/rental_units_api.rb +582 -1
  187. data/lib/buildium-ruby/api/resident_center_api.rb +242 -1
  188. data/lib/buildium-ruby/api/resident_requests_api.rb +344 -0
  189. data/lib/buildium-ruby/api/tasks_api.rb +345 -1624
  190. data/lib/buildium-ruby/api/to_do_requests_api.rb +341 -0
  191. data/lib/buildium-ruby/api/vendors_api.rb +3 -3
  192. data/lib/buildium-ruby/api/work_orders_api.rb +1 -1
  193. data/lib/buildium-ruby/api_client.rb +1 -1
  194. data/lib/buildium-ruby/api_error.rb +1 -1
  195. data/lib/buildium-ruby/configuration.rb +1 -1
  196. data/lib/buildium-ruby/models/account_info_message.rb +1 -1
  197. data/lib/buildium-ruby/models/accounting_entity_message.rb +14 -5
  198. data/lib/buildium-ruby/models/accounting_entity_save_message.rb +15 -5
  199. data/lib/buildium-ruby/models/accounting_lock_period_message.rb +1 -1
  200. data/lib/buildium-ruby/models/accounting_settings_message.rb +1 -1
  201. data/lib/buildium-ruby/models/address_message.rb +1 -1
  202. data/lib/buildium-ruby/models/all_tasks_message.rb +1 -1
  203. data/lib/buildium-ruby/models/announcement_message.rb +1 -1
  204. data/lib/buildium-ruby/models/announcement_post_message.rb +1 -1
  205. data/lib/buildium-ruby/models/announcement_search_message.rb +1 -1
  206. data/lib/buildium-ruby/models/announcement_sender_message.rb +1 -1
  207. data/lib/buildium-ruby/models/api_error_response.rb +1 -1
  208. data/lib/buildium-ruby/models/appliance_message.rb +1 -1
  209. data/lib/buildium-ruby/models/applicant_application_message.rb +1 -1
  210. data/lib/buildium-ruby/models/applicant_group_message.rb +1 -1
  211. data/lib/buildium-ruby/models/applicant_group_post_message.rb +1 -1
  212. data/lib/buildium-ruby/models/applicant_group_put_message.rb +1 -1
  213. data/lib/buildium-ruby/models/applicant_group_search_message.rb +1 -1
  214. data/lib/buildium-ruby/models/applicant_message.rb +46 -2
  215. data/lib/buildium-ruby/models/applicant_post_message.rb +1 -1
  216. data/lib/buildium-ruby/models/applicant_put_message.rb +1 -1
  217. data/lib/buildium-ruby/models/applicant_search_message.rb +1 -1
  218. data/lib/buildium-ruby/models/application_message.rb +1 -1
  219. data/lib/buildium-ruby/models/application_put_message.rb +1 -1
  220. data/lib/buildium-ruby/models/application_response_field_message.rb +3 -3
  221. data/lib/buildium-ruby/models/application_response_message.rb +3 -3
  222. data/lib/buildium-ruby/models/application_section_response_message.rb +1 -1
  223. data/lib/buildium-ruby/models/applied_vendor_credit_message.rb +228 -0
  224. data/lib/buildium-ruby/models/association_appliance_message.rb +1 -1
  225. data/lib/buildium-ruby/models/association_appliance_post_message.rb +1 -1
  226. data/lib/buildium-ruby/models/association_appliance_put_message.rb +1 -1
  227. data/lib/buildium-ruby/models/association_appliance_search_message.rb +1 -1
  228. data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +1 -1
  229. data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +1 -1
  230. data/lib/buildium-ruby/models/association_board_member_message.rb +1 -1
  231. data/lib/buildium-ruby/models/association_board_member_post_message.rb +1 -1
  232. data/lib/buildium-ruby/models/association_board_member_put_message.rb +1 -1
  233. data/lib/buildium-ruby/models/association_board_member_search_message.rb +1 -1
  234. data/lib/buildium-ruby/models/association_message.rb +14 -5
  235. data/lib/buildium-ruby/models/association_owner_board_term_message.rb +1 -1
  236. data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +1 -1
  237. data/lib/buildium-ruby/models/association_owner_message.rb +1 -1
  238. data/lib/buildium-ruby/models/association_owner_post_message.rb +1 -1
  239. data/lib/buildium-ruby/models/association_owner_put_message.rb +1 -1
  240. data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +1 -1
  241. data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +1 -1
  242. data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +1 -1
  243. data/lib/buildium-ruby/models/association_ownership_account_message.rb +1 -1
  244. data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +1 -1
  245. data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +1 -1
  246. data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +14 -2
  247. data/lib/buildium-ruby/models/association_post_message.rb +14 -5
  248. data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +1 -1
  249. data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +1 -1
  250. data/lib/buildium-ruby/models/association_put_message.rb +1 -1
  251. data/lib/buildium-ruby/models/association_search_message.rb +29 -5
  252. data/lib/buildium-ruby/models/association_tax_information_message.rb +292 -0
  253. data/lib/buildium-ruby/models/association_tenant_message.rb +1 -1
  254. data/lib/buildium-ruby/models/association_tenant_post_message.rb +1 -1
  255. data/lib/buildium-ruby/models/association_tenant_put_message.rb +1 -1
  256. data/lib/buildium-ruby/models/association_unit_message.rb +1 -1
  257. data/lib/buildium-ruby/models/association_unit_put_message.rb +1 -1
  258. data/lib/buildium-ruby/models/association_unit_search_message.rb +1 -1
  259. data/lib/buildium-ruby/models/association_units_post_message.rb +1 -1
  260. data/lib/buildium-ruby/models/association_user_search_message.rb +1 -1
  261. data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +15 -5
  262. data/lib/buildium-ruby/models/bank_account_check_file_message.rb +268 -0
  263. data/lib/buildium-ruby/models/bank_account_check_line_message.rb +1 -1
  264. data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +1 -1
  265. data/lib/buildium-ruby/models/bank_account_check_message.rb +1 -1
  266. data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +1 -1
  267. data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +1 -1
  268. data/lib/buildium-ruby/models/bank_account_check_post_message.rb +1 -1
  269. data/lib/buildium-ruby/models/bank_account_check_put_message.rb +1 -1
  270. data/lib/buildium-ruby/models/bank_account_check_search_message.rb +1 -1
  271. data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +1 -1
  272. data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +1 -1
  273. data/lib/buildium-ruby/models/bank_account_deposit_message.rb +1 -1
  274. data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +2 -2
  275. data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +1 -1
  276. data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +1 -1
  277. data/lib/buildium-ruby/models/bank_account_message.rb +15 -5
  278. data/lib/buildium-ruby/models/bank_account_post_message.rb +1 -1
  279. data/lib/buildium-ruby/models/bank_account_put_message.rb +1 -1
  280. data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +1 -1
  281. data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +1 -1
  282. data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +1 -1
  283. data/lib/buildium-ruby/models/bank_account_search_message.rb +17 -5
  284. data/lib/buildium-ruby/models/bank_account_transaction_message.rb +3 -3
  285. data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +1 -1
  286. data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +15 -5
  287. data/lib/buildium-ruby/models/bank_account_transfer_message.rb +1 -1
  288. data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +1 -1
  289. data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +1 -1
  290. data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +1 -1
  291. data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +1 -1
  292. data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +1 -1
  293. data/lib/buildium-ruby/models/bank_lockbox_data_association_message.rb +238 -0
  294. data/lib/buildium-ruby/models/bank_lockbox_data_association_owner_message.rb +314 -0
  295. data/lib/buildium-ruby/models/bank_lockbox_data_message.rb +229 -0
  296. data/lib/buildium-ruby/models/bank_lockbox_data_ownership_account_message.rb +293 -0
  297. data/lib/buildium-ruby/models/bank_lockbox_data_search_message.rb +220 -0
  298. data/lib/buildium-ruby/models/bill_file_message.rb +1 -1
  299. data/lib/buildium-ruby/models/bill_line_message.rb +1 -1
  300. data/lib/buildium-ruby/models/bill_line_post_message.rb +1 -1
  301. data/lib/buildium-ruby/models/bill_line_put_message.rb +1 -1
  302. data/lib/buildium-ruby/models/bill_markup_message.rb +1 -1
  303. data/lib/buildium-ruby/models/bill_markup_save_message.rb +1 -1
  304. data/lib/buildium-ruby/models/bill_message.rb +1 -1
  305. data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +15 -5
  306. data/lib/buildium-ruby/models/bill_payment_line_message.rb +1 -1
  307. data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +1 -1
  308. data/lib/buildium-ruby/models/bill_payment_message.rb +26 -2
  309. data/lib/buildium-ruby/models/bill_payment_post_message.rb +1 -1
  310. data/lib/buildium-ruby/models/bill_post_message.rb +1 -1
  311. data/lib/buildium-ruby/models/bill_put_message.rb +1 -1
  312. data/lib/buildium-ruby/models/bill_search_message.rb +1 -1
  313. data/lib/buildium-ruby/models/budget_details_message.rb +1 -1
  314. data/lib/buildium-ruby/models/budget_details_save_message.rb +1 -1
  315. data/lib/buildium-ruby/models/budget_message.rb +1 -1
  316. data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +1 -1
  317. data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +1 -1
  318. data/lib/buildium-ruby/models/budget_post_message.rb +1 -1
  319. data/lib/buildium-ruby/models/budget_put_message.rb +1 -1
  320. data/lib/buildium-ruby/models/budget_search_message.rb +1 -1
  321. data/lib/buildium-ruby/models/cancellation_token.rb +235 -0
  322. data/lib/buildium-ruby/models/cc_payments_message.rb +219 -0
  323. data/lib/buildium-ruby/models/cc_payments_put_message.rb +224 -0
  324. data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +1 -1
  325. data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +1 -1
  326. data/lib/buildium-ruby/models/check_printing_info_message.rb +1 -1
  327. data/lib/buildium-ruby/models/check_printing_info_post_message.rb +1 -1
  328. data/lib/buildium-ruby/models/check_printing_info_put_message.rb +1 -1
  329. data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +1 -1
  330. data/lib/buildium-ruby/models/client_lead_message.rb +1 -1
  331. data/lib/buildium-ruby/models/client_lead_search_message.rb +1 -1
  332. data/lib/buildium-ruby/models/contact_detail_message.rb +1 -1
  333. data/lib/buildium-ruby/models/contact_detail_phone_message.rb +1 -1
  334. data/lib/buildium-ruby/models/contact_detail_save_message.rb +1 -1
  335. data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +1 -1
  336. data/lib/buildium-ruby/models/contact_info_message.rb +1 -1
  337. data/lib/buildium-ruby/models/contact_request_task_message.rb +1 -1
  338. data/lib/buildium-ruby/models/contact_request_task_post_message.rb +1 -1
  339. data/lib/buildium-ruby/models/contact_request_task_put_message.rb +1 -1
  340. data/lib/buildium-ruby/models/contact_request_task_search_message.rb +1 -1
  341. data/lib/buildium-ruby/models/cosigner_message.rb +1 -1
  342. data/lib/buildium-ruby/models/created_by_user_message.rb +1 -1
  343. data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +1 -1
  344. data/lib/buildium-ruby/models/deposit_detail_message.rb +1 -1
  345. data/lib/buildium-ruby/models/e_pay_settings_message.rb +235 -0
  346. data/lib/buildium-ruby/models/e_pay_settings_put_message.rb +250 -0
  347. data/lib/buildium-ruby/models/eft_payments_message.rb +219 -0
  348. data/lib/buildium-ruby/models/eft_payments_put_message.rb +224 -0
  349. data/lib/buildium-ruby/models/electronic_payments_message.rb +1 -1
  350. data/lib/buildium-ruby/models/email_message.rb +1 -1
  351. data/lib/buildium-ruby/models/email_post_message.rb +1 -1
  352. data/lib/buildium-ruby/models/email_recipient_message.rb +1 -1
  353. data/lib/buildium-ruby/models/email_search_message.rb +1 -1
  354. data/lib/buildium-ruby/models/email_sender_message.rb +1 -1
  355. data/lib/buildium-ruby/models/emergency_contact_message.rb +1 -1
  356. data/lib/buildium-ruby/models/file_category_message.rb +1 -1
  357. data/lib/buildium-ruby/models/file_category_post_message.rb +1 -1
  358. data/lib/buildium-ruby/models/file_category_put_message.rb +1 -1
  359. data/lib/buildium-ruby/models/file_download_message.rb +1 -1
  360. data/lib/buildium-ruby/models/file_entity_message.rb +1 -1
  361. data/lib/buildium-ruby/models/file_message.rb +1 -1
  362. data/lib/buildium-ruby/models/file_name_post_message.rb +1 -1
  363. data/lib/buildium-ruby/models/file_put_message.rb +1 -1
  364. data/lib/buildium-ruby/models/file_search_message.rb +1 -1
  365. data/lib/buildium-ruby/models/file_sharing_account_message.rb +263 -0
  366. data/lib/buildium-ruby/models/file_sharing_account_put_message.rb +263 -0
  367. data/lib/buildium-ruby/models/file_sharing_association_message.rb +229 -0
  368. data/lib/buildium-ruby/models/file_sharing_association_owner_message.rb +219 -0
  369. data/lib/buildium-ruby/models/file_sharing_association_owner_put_message.rb +219 -0
  370. data/lib/buildium-ruby/models/file_sharing_association_put_message.rb +229 -0
  371. data/lib/buildium-ruby/models/file_sharing_association_unit_message.rb +229 -0
  372. data/lib/buildium-ruby/models/file_sharing_association_unit_put_message.rb +229 -0
  373. data/lib/buildium-ruby/models/file_sharing_committee_message.rb +239 -0
  374. data/lib/buildium-ruby/models/file_sharing_committee_put_message.rb +239 -0
  375. data/lib/buildium-ruby/models/file_sharing_lease_message.rb +229 -0
  376. data/lib/buildium-ruby/models/file_sharing_lease_put_message.rb +229 -0
  377. data/lib/buildium-ruby/models/file_sharing_message.rb +316 -0
  378. data/lib/buildium-ruby/models/file_sharing_ownership_account_message.rb +229 -0
  379. data/lib/buildium-ruby/models/file_sharing_ownership_account_put_message.rb +229 -0
  380. data/lib/buildium-ruby/models/file_sharing_put_message.rb +316 -0
  381. data/lib/buildium-ruby/models/file_sharing_rental_message.rb +229 -0
  382. data/lib/buildium-ruby/models/file_sharing_rental_owner_message.rb +219 -0
  383. data/lib/buildium-ruby/models/file_sharing_rental_owner_put_message.rb +219 -0
  384. data/lib/buildium-ruby/models/file_sharing_rental_put_message.rb +229 -0
  385. data/lib/buildium-ruby/models/file_sharing_rental_unit_mesage.rb +229 -0
  386. data/lib/buildium-ruby/models/file_sharing_rental_unit_put_mesage.rb +229 -0
  387. data/lib/buildium-ruby/models/file_sharing_tenant_message.rb +229 -0
  388. data/lib/buildium-ruby/models/file_sharing_tenant_put_message.rb +229 -0
  389. data/lib/buildium-ruby/models/file_sharing_vendor_message.rb +219 -0
  390. data/lib/buildium-ruby/models/file_sharing_vendor_put_message.rb +219 -0
  391. data/lib/buildium-ruby/models/file_upload_post_message.rb +1 -1
  392. data/lib/buildium-ruby/models/file_upload_ticket_message.rb +1 -1
  393. data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +2 -2
  394. data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +1 -1
  395. data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +1 -1
  396. data/lib/buildium-ruby/models/general_ledger_entry_message.rb +311 -0
  397. data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +1 -1
  398. data/lib/buildium-ruby/models/general_ledger_journal_message.rb +1 -1
  399. data/lib/buildium-ruby/models/general_ledger_message.rb +260 -0
  400. data/lib/buildium-ruby/models/general_ledger_search_message.rb +336 -0
  401. data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +1 -1
  402. data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +1 -1
  403. data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +1 -1
  404. data/lib/buildium-ruby/models/gl_account_balance_message.rb +1 -1
  405. data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +1 -1
  406. data/lib/buildium-ruby/models/gl_account_message.rb +1 -1
  407. data/lib/buildium-ruby/models/gl_account_post_message.rb +1 -1
  408. data/lib/buildium-ruby/models/gl_account_put_message.rb +1 -1
  409. data/lib/buildium-ruby/models/gl_accounts_search_message.rb +1 -1
  410. data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +1 -1
  411. data/lib/buildium-ruby/models/image_reorder_request_put_message.rb +225 -0
  412. data/lib/buildium-ruby/models/insured_tenant_message.rb +248 -0
  413. data/lib/buildium-ruby/models/internal_transaction_status_message.rb +1 -1
  414. data/lib/buildium-ruby/models/journal_line_message.rb +15 -5
  415. data/lib/buildium-ruby/models/journal_message.rb +1 -1
  416. data/lib/buildium-ruby/models/json_patch_operation.rb +254 -0
  417. data/lib/buildium-ruby/models/last_updated_by_user_message.rb +1 -1
  418. data/lib/buildium-ruby/models/lease_account_detail_message.rb +1 -1
  419. data/lib/buildium-ruby/models/lease_auto_allocated_payment_post_message.rb +332 -0
  420. data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +1 -1
  421. data/lib/buildium-ruby/models/lease_charge_post_message.rb +1 -1
  422. data/lib/buildium-ruby/models/lease_charge_put_message.rb +1 -1
  423. data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +1 -1
  424. data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +1 -1
  425. data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +1 -1
  426. data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +1 -1
  427. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +1 -1
  428. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +1 -1
  429. data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +1 -1
  430. data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +1 -1
  431. data/lib/buildium-ruby/models/lease_ledger_payment_put_message.rb +319 -0
  432. data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +1 -1
  433. data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +1 -1
  434. data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +1 -1
  435. data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +1 -1
  436. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +1 -1
  437. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +1 -1
  438. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +1 -1
  439. data/lib/buildium-ruby/models/lease_message.rb +1 -1
  440. data/lib/buildium-ruby/models/lease_move_out_data_message.rb +1 -1
  441. data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +1 -1
  442. data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +1 -1
  443. data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +1 -1
  444. data/lib/buildium-ruby/models/lease_post_message.rb +27 -8
  445. data/lib/buildium-ruby/models/lease_put_message.rb +1 -1
  446. data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +1 -1
  447. data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +1 -1
  448. data/lib/buildium-ruby/models/lease_renewal_message.rb +1 -1
  449. data/lib/buildium-ruby/models/lease_renewal_post_message.rb +1 -1
  450. data/lib/buildium-ruby/models/lease_renewal_search_message.rb +272 -0
  451. data/lib/buildium-ruby/models/lease_rent_charge_message.rb +1 -1
  452. data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +1 -1
  453. data/lib/buildium-ruby/models/lease_rent_message.rb +2 -2
  454. data/lib/buildium-ruby/models/lease_rent_post_message.rb +1 -1
  455. data/lib/buildium-ruby/models/lease_search_message.rb +1 -1
  456. data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +1 -1
  457. data/lib/buildium-ruby/models/lease_tenant_message.rb +15 -5
  458. data/lib/buildium-ruby/models/lease_transaction_message.rb +47 -3
  459. data/lib/buildium-ruby/models/lease_transaction_search_message.rb +1 -1
  460. data/lib/buildium-ruby/models/listing_contact_message.rb +1 -1
  461. data/lib/buildium-ruby/models/listing_contact_save_message.rb +1 -1
  462. data/lib/buildium-ruby/models/listing_entity_file_post_message.rb +248 -0
  463. data/lib/buildium-ruby/models/listing_file_message.rb +1 -1
  464. data/lib/buildium-ruby/models/listing_message.rb +1 -1
  465. data/lib/buildium-ruby/models/listing_property_message.rb +1 -1
  466. data/lib/buildium-ruby/models/listing_put_message.rb +1 -1
  467. data/lib/buildium-ruby/models/listing_search_message.rb +1 -1
  468. data/lib/buildium-ruby/models/listing_unit_message.rb +1 -1
  469. data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +1 -1
  470. data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +1 -1
  471. data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +1 -1
  472. data/lib/buildium-ruby/models/lookup_message.rb +1 -1
  473. data/lib/buildium-ruby/models/mailing_template_message.rb +1 -1
  474. data/lib/buildium-ruby/models/meter_reading_detail_message.rb +268 -0
  475. data/lib/buildium-ruby/models/meter_reading_detail_put_message.rb +263 -0
  476. data/lib/buildium-ruby/models/meter_reading_details_delete_search_message.rb +272 -0
  477. data/lib/buildium-ruby/models/meter_reading_details_message.rb +274 -0
  478. data/lib/buildium-ruby/models/meter_reading_details_put_message.rb +289 -0
  479. data/lib/buildium-ruby/models/meter_reading_details_put_search_message.rb +262 -0
  480. data/lib/buildium-ruby/models/meter_reading_details_search_message.rb +272 -0
  481. data/lib/buildium-ruby/models/meter_reading_message.rb +292 -0
  482. data/lib/buildium-ruby/models/meter_reading_search_message.rb +272 -0
  483. data/lib/buildium-ruby/models/multiple_bill_payments_post_message.rb +277 -0
  484. data/lib/buildium-ruby/models/note_message.rb +1 -1
  485. data/lib/buildium-ruby/models/note_post_message.rb +1 -1
  486. data/lib/buildium-ruby/models/note_put_message.rb +1 -1
  487. data/lib/buildium-ruby/models/note_search_message.rb +1 -1
  488. data/lib/buildium-ruby/models/offline_payments_message.rb +239 -0
  489. data/lib/buildium-ruby/models/offline_payments_put_message.rb +249 -0
  490. data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +1 -1
  491. data/lib/buildium-ruby/models/ownership_account_auto_allocated_payment_post_message.rb +332 -0
  492. data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +1 -1
  493. data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +1 -1
  494. data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +1 -1
  495. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +1 -1
  496. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +1 -1
  497. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +1 -1
  498. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +1 -1
  499. data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +1 -1
  500. data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +1 -1
  501. data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +1 -1
  502. data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +1 -1
  503. data/lib/buildium-ruby/models/ownership_account_ledger_payment_put_message.rb +320 -0
  504. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +1 -1
  505. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +1 -1
  506. data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +1 -1
  507. data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +1 -1
  508. data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +1 -1
  509. data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +1 -1
  510. data/lib/buildium-ruby/models/ownership_account_refund_message.rb +1 -1
  511. data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +1 -1
  512. data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +46 -2
  513. data/lib/buildium-ruby/models/paid_by_message.rb +1 -1
  514. data/lib/buildium-ruby/models/participant_message.rb +1 -1
  515. data/lib/buildium-ruby/models/participant_resource_message.rb +1 -1
  516. data/lib/buildium-ruby/models/payee_message.rb +1 -1
  517. data/lib/buildium-ruby/models/payment_detail_message.rb +1 -1
  518. data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +1 -1
  519. data/lib/buildium-ruby/models/payment_transactions_message.rb +1 -1
  520. data/lib/buildium-ruby/models/phone_log_message.rb +1 -1
  521. data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +1 -1
  522. data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +1 -1
  523. data/lib/buildium-ruby/models/phone_log_post_message.rb +1 -1
  524. data/lib/buildium-ruby/models/phone_log_put_message.rb +1 -1
  525. data/lib/buildium-ruby/models/phone_log_search_message.rb +1 -1
  526. data/lib/buildium-ruby/models/phone_number_message.rb +1 -1
  527. data/lib/buildium-ruby/models/phone_numbers_message.rb +1 -1
  528. data/lib/buildium-ruby/models/property_group_message.rb +1 -1
  529. data/lib/buildium-ruby/models/property_group_post_message.rb +1 -1
  530. data/lib/buildium-ruby/models/property_group_put_message.rb +1 -1
  531. data/lib/buildium-ruby/models/property_group_search_message.rb +1 -1
  532. data/lib/buildium-ruby/models/property_manager_message.rb +1 -1
  533. data/lib/buildium-ruby/models/property_message.rb +1 -1
  534. data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +1 -1
  535. data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +1 -1
  536. data/lib/buildium-ruby/models/recurring_transaction_message.rb +1 -1
  537. data/lib/buildium-ruby/models/rental_appliance_message.rb +1 -1
  538. data/lib/buildium-ruby/models/rental_appliance_post_message.rb +1 -1
  539. data/lib/buildium-ruby/models/rental_appliance_put_message.rb +1 -1
  540. data/lib/buildium-ruby/models/rental_appliance_search_message.rb +1 -1
  541. data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +1 -1
  542. data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +1 -1
  543. data/lib/buildium-ruby/models/rental_features_message.rb +1 -1
  544. data/lib/buildium-ruby/models/rental_features_put_message.rb +1 -1
  545. data/lib/buildium-ruby/models/rental_image_message.rb +292 -0
  546. data/lib/buildium-ruby/models/rental_image_put_message.rb +233 -0
  547. data/lib/buildium-ruby/models/rental_message.rb +1 -1
  548. data/lib/buildium-ruby/models/rental_owner_contribution_data_message.rb +229 -0
  549. data/lib/buildium-ruby/models/rental_owner_contribution_data_put_message.rb +229 -0
  550. data/lib/buildium-ruby/models/rental_owner_contribution_message.rb +229 -0
  551. data/lib/buildium-ruby/models/rental_owner_contribution_put_message.rb +229 -0
  552. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_message.rb +229 -0
  553. data/lib/buildium-ruby/models/rental_owner_contribution_reminder_put_message.rb +229 -0
  554. data/lib/buildium-ruby/models/rental_owner_message.rb +1 -1
  555. data/lib/buildium-ruby/models/rental_owner_post_message.rb +1 -1
  556. data/lib/buildium-ruby/models/rental_owner_put_message.rb +1 -1
  557. data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +1 -1
  558. data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +1 -1
  559. data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +1 -1
  560. data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +1 -1
  561. data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +1 -1
  562. data/lib/buildium-ruby/models/rental_owners_search_message.rb +1 -1
  563. data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +1 -1
  564. data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +1 -1
  565. data/lib/buildium-ruby/models/rental_property_post_message.rb +2 -2
  566. data/lib/buildium-ruby/models/rental_property_put_message.rb +1 -1
  567. data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +1 -1
  568. data/lib/buildium-ruby/models/rental_search_message.rb +1 -1
  569. data/lib/buildium-ruby/models/rental_tenant_post_message.rb +1 -1
  570. data/lib/buildium-ruby/models/rental_tenant_put_message.rb +1 -1
  571. data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +1 -1
  572. data/lib/buildium-ruby/models/rental_unit_features_message.rb +1 -1
  573. data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +1 -1
  574. data/lib/buildium-ruby/models/rental_unit_image_message.rb +292 -0
  575. data/lib/buildium-ruby/models/rental_unit_image_put_message.rb +233 -0
  576. data/lib/buildium-ruby/models/rental_unit_message.rb +3 -3
  577. data/lib/buildium-ruby/models/rental_unit_put_message.rb +1 -1
  578. data/lib/buildium-ruby/models/rental_unit_search_message.rb +1 -1
  579. data/lib/buildium-ruby/models/rental_units_post_message.rb +1 -1
  580. data/lib/buildium-ruby/models/renters_insurance_policy_message.rb +324 -0
  581. data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +1 -1
  582. data/lib/buildium-ruby/models/resident_center_user_message.rb +1 -1
  583. data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +1 -1
  584. data/lib/buildium-ruby/models/resident_center_user_search_message.rb +1 -1
  585. data/lib/buildium-ruby/models/resident_request_task_message.rb +1 -1
  586. data/lib/buildium-ruby/models/resident_request_task_post_message.rb +25 -5
  587. data/lib/buildium-ruby/models/resident_request_task_put_message.rb +1 -1
  588. data/lib/buildium-ruby/models/resident_request_task_search_message.rb +1 -1
  589. data/lib/buildium-ruby/models/retail_cash_property_message.rb +282 -0
  590. data/lib/buildium-ruby/models/retail_cash_unit_message.rb +238 -0
  591. data/lib/buildium-ruby/models/retail_cash_user_data_message.rb +312 -0
  592. data/lib/buildium-ruby/models/retail_cash_user_message.rb +274 -0
  593. data/lib/buildium-ruby/models/retail_cash_user_put_message.rb +223 -0
  594. data/lib/buildium-ruby/models/retail_cash_users_search_message.rb +304 -0
  595. data/lib/buildium-ruby/models/safe_wait_handle.rb +226 -0
  596. data/lib/buildium-ruby/models/save_address_message.rb +1 -1
  597. data/lib/buildium-ruby/models/save_emergency_contact_message.rb +1 -1
  598. data/lib/buildium-ruby/models/task_category_message.rb +1 -1
  599. data/lib/buildium-ruby/models/task_category_put_message.rb +1 -1
  600. data/lib/buildium-ruby/models/task_category_response_message.rb +1 -1
  601. data/lib/buildium-ruby/models/task_category_save_message.rb +1 -1
  602. data/lib/buildium-ruby/models/task_history_file_message.rb +1 -1
  603. data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +1 -1
  604. data/lib/buildium-ruby/models/task_history_message.rb +1 -1
  605. data/lib/buildium-ruby/models/task_history_put_message.rb +1 -1
  606. data/lib/buildium-ruby/models/task_history_user_message.rb +1 -1
  607. data/lib/buildium-ruby/models/task_search_message.rb +1 -1
  608. data/lib/buildium-ruby/models/task_sub_category_message.rb +1 -1
  609. data/lib/buildium-ruby/models/tax_information_post_message.rb +1 -1
  610. data/lib/buildium-ruby/models/tax_information_save_message.rb +1 -1
  611. data/lib/buildium-ruby/models/tenant_message.rb +1 -1
  612. data/lib/buildium-ruby/models/tenant_search_message.rb +1 -1
  613. data/lib/buildium-ruby/models/to_do_task_message.rb +1 -1
  614. data/lib/buildium-ruby/models/to_do_task_post_message.rb +1 -1
  615. data/lib/buildium-ruby/models/to_do_task_put_message.rb +1 -1
  616. data/lib/buildium-ruby/models/to_do_task_search_message.rb +1 -1
  617. data/lib/buildium-ruby/models/undeposited_funds_message.rb +1 -1
  618. data/lib/buildium-ruby/models/unit_agreement_message.rb +1 -1
  619. data/lib/buildium-ruby/models/unit_entity_message.rb +229 -0
  620. data/lib/buildium-ruby/models/user_message.rb +1 -1
  621. data/lib/buildium-ruby/models/user_role_message.rb +1 -1
  622. data/lib/buildium-ruby/models/user_search_message.rb +1 -1
  623. data/lib/buildium-ruby/models/vehicle_message.rb +1 -1
  624. data/lib/buildium-ruby/models/vendor_category_message.rb +1 -1
  625. data/lib/buildium-ruby/models/vendor_category_save_message.rb +1 -1
  626. data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +1 -1
  627. data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +1 -1
  628. data/lib/buildium-ruby/models/vendor_credit_message.rb +1 -1
  629. data/lib/buildium-ruby/models/vendor_credit_post_message.rb +1 -1
  630. data/lib/buildium-ruby/models/vendor_insurance_message.rb +1 -1
  631. data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +1 -1
  632. data/lib/buildium-ruby/models/vendor_message.rb +1 -1
  633. data/lib/buildium-ruby/models/vendor_post_message.rb +1 -1
  634. data/lib/buildium-ruby/models/vendor_put_message.rb +1 -1
  635. data/lib/buildium-ruby/models/vendor_refund_line_message.rb +1 -1
  636. data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +1 -1
  637. data/lib/buildium-ruby/models/vendor_refund_message.rb +1 -1
  638. data/lib/buildium-ruby/models/vendor_refund_post_message.rb +1 -1
  639. data/lib/buildium-ruby/models/vendor_search_message.rb +1 -1
  640. data/lib/buildium-ruby/models/vendor_tax_information_message.rb +1 -1
  641. data/lib/buildium-ruby/models/vendor_transaction_message.rb +1 -1
  642. data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +1 -1
  643. data/lib/buildium-ruby/models/video_link_request_post_message.rb +238 -0
  644. data/lib/buildium-ruby/models/wait_handle.rb +226 -0
  645. data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +1 -1
  646. data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +1 -1
  647. data/lib/buildium-ruby/models/work_order_line_item_message.rb +1 -1
  648. data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +1 -1
  649. data/lib/buildium-ruby/models/work_order_message.rb +1 -1
  650. data/lib/buildium-ruby/models/work_order_post_message.rb +1 -1
  651. data/lib/buildium-ruby/models/work_order_put_message.rb +1 -1
  652. data/lib/buildium-ruby/models/work_order_search_message.rb +1 -1
  653. data/lib/buildium-ruby/models/work_order_task_message.rb +1 -1
  654. data/lib/buildium-ruby/models/work_order_task_post_message.rb +1 -1
  655. data/lib/buildium-ruby/version.rb +2 -2
  656. data/lib/buildium-ruby.rb +101 -4
  657. data/spec/api_client_spec.rb +1 -1
  658. data/spec/configuration_spec.rb +1 -1
  659. data/spec/spec_helper.rb +1 -1
  660. metadata +206 -826
  661. data/docs/AccountingApi.md +0 -2041
  662. data/lib/buildium-ruby/api/accounting_api.rb +0 -1855
  663. data/spec/api/accounting_api_spec.rb +0 -383
  664. data/spec/api/administration_api_spec.rb +0 -114
  665. data/spec/api/applicants_api_spec.rb +0 -294
  666. data/spec/api/association_appliances_api_spec.rb +0 -141
  667. data/spec/api/association_owners_api_spec.rb +0 -195
  668. data/spec/api/association_ownership_accounts_api_spec.rb +0 -385
  669. data/spec/api/association_tenants_api_spec.rb +0 -153
  670. data/spec/api/association_units_api_spec.rb +0 -147
  671. data/spec/api/associations_api_spec.rb +0 -248
  672. data/spec/api/bank_accounts_api_spec.rb +0 -420
  673. data/spec/api/client_leads_api_spec.rb +0 -66
  674. data/spec/api/communications_api_spec.rb +0 -248
  675. data/spec/api/files_api_spec.rb +0 -156
  676. data/spec/api/leases_api_spec.rb +0 -529
  677. data/spec/api/listings_api_spec.rb +0 -139
  678. data/spec/api/property_groups_api_spec.rb +0 -88
  679. data/spec/api/rental_appliances_api_spec.rb +0 -141
  680. data/spec/api/rental_owners_api_spec.rb +0 -151
  681. data/spec/api/rental_properties_api_spec.rb +0 -205
  682. data/spec/api/rental_tenants_api_spec.rb +0 -154
  683. data/spec/api/rental_units_api_spec.rb +0 -172
  684. data/spec/api/resident_center_api_spec.rb +0 -54
  685. data/spec/api/tasks_api_spec.rb +0 -493
  686. data/spec/api/vendors_api_spec.rb +0 -275
  687. data/spec/api/work_orders_api_spec.rb +0 -105
  688. data/spec/models/account_info_message_spec.rb +0 -58
  689. data/spec/models/accounting_entity_message_spec.rb +0 -50
  690. data/spec/models/accounting_entity_save_message_spec.rb +0 -44
  691. data/spec/models/accounting_lock_period_message_spec.rb +0 -46
  692. data/spec/models/accounting_settings_message_spec.rb +0 -72
  693. data/spec/models/address_message_spec.rb +0 -74
  694. data/spec/models/all_tasks_message_spec.rb +0 -130
  695. data/spec/models/announcement_message_spec.rb +0 -74
  696. data/spec/models/announcement_post_message_spec.rb +0 -64
  697. data/spec/models/announcement_search_message_spec.rb +0 -62
  698. data/spec/models/announcement_sender_message_spec.rb +0 -46
  699. data/spec/models/api_error_response_spec.rb +0 -46
  700. data/spec/models/appliance_message_spec.rb +0 -58
  701. data/spec/models/applicant_application_message_spec.rb +0 -56
  702. data/spec/models/applicant_group_message_spec.rb +0 -62
  703. data/spec/models/applicant_group_post_message_spec.rb +0 -40
  704. data/spec/models/applicant_group_put_message_spec.rb +0 -50
  705. data/spec/models/applicant_group_search_message_spec.rb +0 -66
  706. data/spec/models/applicant_message_spec.rb +0 -88
  707. data/spec/models/applicant_post_message_spec.rb +0 -64
  708. data/spec/models/applicant_put_message_spec.rb +0 -58
  709. data/spec/models/applicant_search_message_spec.rb +0 -84
  710. data/spec/models/application_message_spec.rb +0 -62
  711. data/spec/models/application_put_message_spec.rb +0 -38
  712. data/spec/models/application_response_field_message_spec.rb +0 -60
  713. data/spec/models/application_response_message_spec.rb +0 -50
  714. data/spec/models/application_section_response_message_spec.rb +0 -34
  715. data/spec/models/association_appliance_message_spec.rb +0 -76
  716. data/spec/models/association_appliance_post_message_spec.rb +0 -76
  717. data/spec/models/association_appliance_put_message_spec.rb +0 -64
  718. data/spec/models/association_appliance_search_message_spec.rb +0 -40
  719. data/spec/models/association_appliance_service_history_message_spec.rb +0 -56
  720. data/spec/models/association_appliance_service_history_post_message_spec.rb +0 -50
  721. data/spec/models/association_board_member_message_spec.rb +0 -92
  722. data/spec/models/association_board_member_post_message_spec.rb +0 -56
  723. data/spec/models/association_board_member_put_message_spec.rb +0 -50
  724. data/spec/models/association_board_member_search_message_spec.rb +0 -60
  725. data/spec/models/association_message_spec.rb +0 -100
  726. data/spec/models/association_owner_board_term_message_spec.rb +0 -68
  727. data/spec/models/association_owner_board_term_post_message_spec.rb +0 -50
  728. data/spec/models/association_owner_message_spec.rb +0 -144
  729. data/spec/models/association_owner_post_message_spec.rb +0 -116
  730. data/spec/models/association_owner_put_message_spec.rb +0 -98
  731. data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +0 -128
  732. data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +0 -34
  733. data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +0 -40
  734. data/spec/models/association_ownership_account_message_spec.rb +0 -90
  735. data/spec/models/association_ownership_account_post_message_spec.rb +0 -80
  736. data/spec/models/association_ownership_account_put_message_spec.rb +0 -34
  737. data/spec/models/association_ownership_account_search_message_spec.rb +0 -72
  738. data/spec/models/association_post_message_spec.rb +0 -76
  739. data/spec/models/association_preferred_vendor_message_spec.rb +0 -82
  740. data/spec/models/association_preferred_vendor_put_message_spec.rb +0 -34
  741. data/spec/models/association_put_message_spec.rb +0 -82
  742. data/spec/models/association_search_message_spec.rb +0 -56
  743. data/spec/models/association_tenant_message_spec.rb +0 -112
  744. data/spec/models/association_tenant_post_message_spec.rb +0 -106
  745. data/spec/models/association_tenant_put_message_spec.rb +0 -94
  746. data/spec/models/association_unit_message_spec.rb +0 -84
  747. data/spec/models/association_unit_put_message_spec.rb +0 -66
  748. data/spec/models/association_unit_search_message_spec.rb +0 -46
  749. data/spec/models/association_units_post_message_spec.rb +0 -72
  750. data/spec/models/association_user_search_message_spec.rb +0 -86
  751. data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +0 -44
  752. data/spec/models/bank_account_check_line_message_spec.rb +0 -64
  753. data/spec/models/bank_account_check_line_save_message_spec.rb +0 -58
  754. data/spec/models/bank_account_check_message_spec.rb +0 -70
  755. data/spec/models/bank_account_check_payee_message_spec.rb +0 -50
  756. data/spec/models/bank_account_check_payee_save_message_spec.rb +0 -44
  757. data/spec/models/bank_account_check_post_message_spec.rb +0 -58
  758. data/spec/models/bank_account_check_put_message_spec.rb +0 -58
  759. data/spec/models/bank_account_check_search_message_spec.rb +0 -40
  760. data/spec/models/bank_account_deposit_line_message_spec.rb +0 -64
  761. data/spec/models/bank_account_deposit_line_save_message_spec.rb +0 -58
  762. data/spec/models/bank_account_deposit_message_spec.rb +0 -64
  763. data/spec/models/bank_account_deposit_post_message_spec.rb +0 -52
  764. data/spec/models/bank_account_deposit_put_message_spec.rb +0 -46
  765. data/spec/models/bank_account_deposit_search_message_spec.rb +0 -40
  766. data/spec/models/bank_account_message_spec.rb +0 -104
  767. data/spec/models/bank_account_post_message_spec.rb +0 -78
  768. data/spec/models/bank_account_put_message_spec.rb +0 -78
  769. data/spec/models/bank_account_quick_deposit_message_spec.rb +0 -64
  770. data/spec/models/bank_account_quick_deposit_save_message_spec.rb +0 -58
  771. data/spec/models/bank_account_quick_deposit_search_message_spec.rb +0 -40
  772. data/spec/models/bank_account_search_message_spec.rb +0 -44
  773. data/spec/models/bank_account_transaction_message_spec.rb +0 -96
  774. data/spec/models/bank_account_transaction_search_message_spec.rb +0 -56
  775. data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +0 -44
  776. data/spec/models/bank_account_transfer_message_spec.rb +0 -64
  777. data/spec/models/bank_account_transfer_save_message_spec.rb +0 -58
  778. data/spec/models/bank_account_transfer_search_message_spec.rb +0 -40
  779. data/spec/models/bank_account_withdrawal_message_spec.rb +0 -64
  780. data/spec/models/bank_account_withdrawal_save_message_spec.rb +0 -58
  781. data/spec/models/bank_account_withdrawal_search_message_spec.rb +0 -40
  782. data/spec/models/bill_file_message_spec.rb +0 -64
  783. data/spec/models/bill_line_message_spec.rb +0 -64
  784. data/spec/models/bill_line_post_message_spec.rb +0 -58
  785. data/spec/models/bill_line_put_message_spec.rb +0 -64
  786. data/spec/models/bill_markup_message_spec.rb +0 -44
  787. data/spec/models/bill_markup_save_message_spec.rb +0 -44
  788. data/spec/models/bill_message_spec.rb +0 -92
  789. data/spec/models/bill_payment_accounting_entity_message_spec.rb +0 -44
  790. data/spec/models/bill_payment_line_message_spec.rb +0 -46
  791. data/spec/models/bill_payment_line_post_message_spec.rb +0 -40
  792. data/spec/models/bill_payment_message_spec.rb +0 -64
  793. data/spec/models/bill_payment_post_message_spec.rb +0 -58
  794. data/spec/models/bill_post_message_spec.rb +0 -70
  795. data/spec/models/bill_put_message_spec.rb +0 -64
  796. data/spec/models/bill_search_message_spec.rb +0 -88
  797. data/spec/models/budget_details_message_spec.rb +0 -56
  798. data/spec/models/budget_details_save_message_spec.rb +0 -40
  799. data/spec/models/budget_message_spec.rb +0 -64
  800. data/spec/models/budget_monthly_amounts_message_spec.rb +0 -100
  801. data/spec/models/budget_monthly_amounts_save_message_spec.rb +0 -100
  802. data/spec/models/budget_post_message_spec.rb +0 -62
  803. data/spec/models/budget_put_message_spec.rb +0 -40
  804. data/spec/models/budget_search_message_spec.rb +0 -46
  805. data/spec/models/charge_recurring_transaction_post_message_spec.rb +0 -84
  806. data/spec/models/charge_recurring_transaction_put_message_spec.rb +0 -90
  807. data/spec/models/check_printing_info_message_spec.rb +0 -122
  808. data/spec/models/check_printing_info_post_message_spec.rb +0 -122
  809. data/spec/models/check_printing_info_put_message_spec.rb +0 -122
  810. data/spec/models/client_lead_credit_request_message_spec.rb +0 -60
  811. data/spec/models/client_lead_message_spec.rb +0 -102
  812. data/spec/models/client_lead_search_message_spec.rb +0 -66
  813. data/spec/models/contact_detail_message_spec.rb +0 -52
  814. data/spec/models/contact_detail_phone_message_spec.rb +0 -46
  815. data/spec/models/contact_detail_save_message_spec.rb +0 -52
  816. data/spec/models/contact_detail_save_phone_message_spec.rb +0 -46
  817. data/spec/models/contact_info_message_spec.rb +0 -52
  818. data/spec/models/contact_request_task_message_spec.rb +0 -114
  819. data/spec/models/contact_request_task_post_message_spec.rb +0 -102
  820. data/spec/models/contact_request_task_put_message_spec.rb +0 -102
  821. data/spec/models/contact_request_task_search_message_spec.rb +0 -112
  822. data/spec/models/cosigner_message_spec.rb +0 -92
  823. data/spec/models/created_by_user_message_spec.rb +0 -52
  824. data/spec/models/credit_recurring_transaction_post_message_spec.rb +0 -100
  825. data/spec/models/deposit_detail_message_spec.rb +0 -40
  826. data/spec/models/electronic_payments_message_spec.rb +0 -76
  827. data/spec/models/email_message_spec.rb +0 -52
  828. data/spec/models/email_post_message_spec.rb +0 -70
  829. data/spec/models/email_recipient_message_spec.rb +0 -62
  830. data/spec/models/email_search_message_spec.rb +0 -58
  831. data/spec/models/email_sender_message_spec.rb +0 -52
  832. data/spec/models/emergency_contact_message_spec.rb +0 -52
  833. data/spec/models/file_category_message_spec.rb +0 -46
  834. data/spec/models/file_category_post_message_spec.rb +0 -34
  835. data/spec/models/file_category_put_message_spec.rb +0 -34
  836. data/spec/models/file_download_message_spec.rb +0 -34
  837. data/spec/models/file_entity_message_spec.rb +0 -50
  838. data/spec/models/file_message_spec.rb +0 -82
  839. data/spec/models/file_name_post_message_spec.rb +0 -34
  840. data/spec/models/file_put_message_spec.rb +0 -46
  841. data/spec/models/file_search_message_spec.rb +0 -74
  842. data/spec/models/file_upload_post_message_spec.rb +0 -68
  843. data/spec/models/file_upload_ticket_message_spec.rb +0 -46
  844. data/spec/models/general_journal_entry_line_save_message_spec.rb +0 -56
  845. data/spec/models/general_journal_entry_post_message_spec.rb +0 -52
  846. data/spec/models/general_journal_entry_put_message_spec.rb +0 -52
  847. data/spec/models/general_ledger_journal_line_message_spec.rb +0 -64
  848. data/spec/models/general_ledger_journal_message_spec.rb +0 -40
  849. data/spec/models/general_ledger_transaction_message_spec.rb +0 -98
  850. data/spec/models/general_ledger_transaction_search_message_spec.rb +0 -62
  851. data/spec/models/gl_account_balance_item_message_spec.rb +0 -40
  852. data/spec/models/gl_account_balance_message_spec.rb +0 -46
  853. data/spec/models/gl_account_balance_search_message_spec.rb +0 -66
  854. data/spec/models/gl_account_message_spec.rb +0 -130
  855. data/spec/models/gl_account_post_message_spec.rb +0 -84
  856. data/spec/models/gl_account_put_message_spec.rb +0 -84
  857. data/spec/models/gl_accounts_search_message_spec.rb +0 -38
  858. data/spec/models/gl_transaction_message_v1_spec.rb +0 -58
  859. data/spec/models/internal_transaction_status_message_spec.rb +0 -46
  860. data/spec/models/journal_line_message_spec.rb +0 -64
  861. data/spec/models/journal_message_spec.rb +0 -40
  862. data/spec/models/last_updated_by_user_message_spec.rb +0 -58
  863. data/spec/models/lease_account_detail_message_spec.rb +0 -40
  864. data/spec/models/lease_charge_line_save_message_spec.rb +0 -46
  865. data/spec/models/lease_charge_post_message_spec.rb +0 -46
  866. data/spec/models/lease_charge_put_message_spec.rb +0 -46
  867. data/spec/models/lease_charge_recurring_transaction_message_spec.rb +0 -108
  868. data/spec/models/lease_cosigner_post_message_spec.rb +0 -80
  869. data/spec/models/lease_ledger_credit_line_post_message_spec.rb +0 -40
  870. data/spec/models/lease_ledger_credit_post_message_spec.rb +0 -62
  871. data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +0 -40
  872. data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +0 -52
  873. data/spec/models/lease_ledger_payment_line_save_message_spec.rb +0 -40
  874. data/spec/models/lease_ledger_payment_post_message_spec.rb +0 -74
  875. data/spec/models/lease_ledger_refund_line_message_spec.rb +0 -40
  876. data/spec/models/lease_ledger_refund_line_post_message_spec.rb +0 -40
  877. data/spec/models/lease_ledger_refund_message_spec.rb +0 -82
  878. data/spec/models/lease_ledger_refund_post_message_spec.rb +0 -70
  879. data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +0 -40
  880. data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +0 -40
  881. data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +0 -52
  882. data/spec/models/lease_message_spec.rb +0 -170
  883. data/spec/models/lease_move_out_data_message_spec.rb +0 -46
  884. data/spec/models/lease_move_out_data_post_message_spec.rb +0 -46
  885. data/spec/models/lease_outstanding_balance_message_spec.rb +0 -100
  886. data/spec/models/lease_outstanding_balance_search_message_spec.rb +0 -90
  887. data/spec/models/lease_post_message_spec.rb +0 -98
  888. data/spec/models/lease_put_message_spec.rb +0 -68
  889. data/spec/models/lease_recurring_credit_message_spec.rb +0 -124
  890. data/spec/models/lease_recurring_payment_message_spec.rb +0 -118
  891. data/spec/models/lease_renewal_message_spec.rb +0 -84
  892. data/spec/models/lease_renewal_post_message_spec.rb +0 -98
  893. data/spec/models/lease_rent_charge_message_spec.rb +0 -70
  894. data/spec/models/lease_rent_charge_post_message_spec.rb +0 -52
  895. data/spec/models/lease_rent_message_spec.rb +0 -86
  896. data/spec/models/lease_rent_post_message_spec.rb +0 -44
  897. data/spec/models/lease_search_message_spec.rb +0 -108
  898. data/spec/models/lease_security_deposit_post_message_spec.rb +0 -40
  899. data/spec/models/lease_tenant_message_spec.rb +0 -44
  900. data/spec/models/lease_transaction_message_spec.rb +0 -82
  901. data/spec/models/lease_transaction_search_message_spec.rb +0 -50
  902. data/spec/models/listing_contact_message_spec.rb +0 -58
  903. data/spec/models/listing_contact_save_message_spec.rb +0 -52
  904. data/spec/models/listing_file_message_spec.rb +0 -50
  905. data/spec/models/listing_message_spec.rb +0 -88
  906. data/spec/models/listing_property_message_spec.rb +0 -90
  907. data/spec/models/listing_put_message_spec.rb +0 -64
  908. data/spec/models/listing_search_message_spec.rb +0 -44
  909. data/spec/models/listing_unit_message_spec.rb +0 -100
  910. data/spec/models/lock_period_settings_global_message_spec.rb +0 -34
  911. data/spec/models/lock_period_settings_overrides_message_spec.rb +0 -40
  912. data/spec/models/logged_by_staff_user_message_spec.rb +0 -52
  913. data/spec/models/lookup_message_spec.rb +0 -40
  914. data/spec/models/mailing_template_message_spec.rb +0 -56
  915. data/spec/models/note_message_spec.rb +0 -46
  916. data/spec/models/note_post_message_spec.rb +0 -34
  917. data/spec/models/note_put_message_spec.rb +0 -34
  918. data/spec/models/note_search_message_spec.rb +0 -46
  919. data/spec/models/outstanding_balances_line_message_spec.rb +0 -40
  920. data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +0 -108
  921. data/spec/models/ownership_account_credit_line_post_message_spec.rb +0 -40
  922. data/spec/models/ownership_account_credit_post_message_spec.rb +0 -62
  923. data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +0 -40
  924. data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +0 -52
  925. data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +0 -46
  926. data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +0 -40
  927. data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +0 -46
  928. data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +0 -46
  929. data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +0 -40
  930. data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +0 -74
  931. data/spec/models/ownership_account_outstanding_balance_message_spec.rb +0 -88
  932. data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +0 -70
  933. data/spec/models/ownership_account_recurring_credit_message_spec.rb +0 -124
  934. data/spec/models/ownership_account_recurring_payment_message_spec.rb +0 -118
  935. data/spec/models/ownership_account_refund_line_message_spec.rb +0 -40
  936. data/spec/models/ownership_account_refund_lines_post_message_spec.rb +0 -40
  937. data/spec/models/ownership_account_refund_message_spec.rb +0 -82
  938. data/spec/models/ownership_account_refund_post_message_spec.rb +0 -70
  939. data/spec/models/ownership_account_transaction_message_spec.rb +0 -82
  940. data/spec/models/paid_by_message_spec.rb +0 -40
  941. data/spec/models/participant_message_spec.rb +0 -46
  942. data/spec/models/participant_resource_message_spec.rb +0 -44
  943. data/spec/models/payee_message_spec.rb +0 -56
  944. data/spec/models/payment_detail_message_spec.rb +0 -56
  945. data/spec/models/payment_recurring_transaction_post_message_spec.rb +0 -94
  946. data/spec/models/payment_transactions_message_spec.rb +0 -46
  947. data/spec/models/phone_log_message_spec.rb +0 -64
  948. data/spec/models/phone_log_participant_post_message_spec.rb +0 -50
  949. data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +0 -44
  950. data/spec/models/phone_log_post_message_spec.rb +0 -52
  951. data/spec/models/phone_log_put_message_spec.rb +0 -46
  952. data/spec/models/phone_log_search_message_spec.rb +0 -84
  953. data/spec/models/phone_number_message_spec.rb +0 -44
  954. data/spec/models/phone_numbers_message_spec.rb +0 -52
  955. data/spec/models/property_group_message_spec.rb +0 -58
  956. data/spec/models/property_group_post_message_spec.rb +0 -46
  957. data/spec/models/property_group_put_message_spec.rb +0 -46
  958. data/spec/models/property_group_search_message_spec.rb +0 -40
  959. data/spec/models/property_manager_message_spec.rb +0 -76
  960. data/spec/models/property_message_spec.rb +0 -50
  961. data/spec/models/recurring_transaction_line_message_spec.rb +0 -40
  962. data/spec/models/recurring_transaction_line_post_message_spec.rb +0 -40
  963. data/spec/models/recurring_transaction_message_spec.rb +0 -112
  964. data/spec/models/rental_appliance_message_spec.rb +0 -76
  965. data/spec/models/rental_appliance_post_message_spec.rb +0 -76
  966. data/spec/models/rental_appliance_put_message_spec.rb +0 -64
  967. data/spec/models/rental_appliance_search_message_spec.rb +0 -40
  968. data/spec/models/rental_appliance_service_history_message_spec.rb +0 -56
  969. data/spec/models/rental_appliance_service_history_post_message_spec.rb +0 -50
  970. data/spec/models/rental_features_message_spec.rb +0 -48
  971. data/spec/models/rental_features_put_message_spec.rb +0 -48
  972. data/spec/models/rental_message_spec.rb +0 -108
  973. data/spec/models/rental_owner_message_spec.rb +0 -118
  974. data/spec/models/rental_owner_post_message_spec.rb +0 -112
  975. data/spec/models/rental_owner_put_message_spec.rb +0 -106
  976. data/spec/models/rental_owner_request_task_message_spec.rb +0 -114
  977. data/spec/models/rental_owner_request_task_post_message_spec.rb +0 -102
  978. data/spec/models/rental_owner_request_task_put_message_spec.rb +0 -96
  979. data/spec/models/rental_owner_request_task_search_message_spec.rb +0 -112
  980. data/spec/models/rental_owner_tax_information_message_spec.rb +0 -68
  981. data/spec/models/rental_owners_search_message_spec.rb +0 -74
  982. data/spec/models/rental_preferred_vendor_message_spec.rb +0 -82
  983. data/spec/models/rental_preferred_vendor_put_message_spec.rb +0 -34
  984. data/spec/models/rental_property_post_message_spec.rb +0 -92
  985. data/spec/models/rental_property_put_message_spec.rb +0 -80
  986. data/spec/models/rental_property_unit_post_message_spec.rb +0 -78
  987. data/spec/models/rental_search_message_spec.rb +0 -88
  988. data/spec/models/rental_tenant_post_message_spec.rb +0 -110
  989. data/spec/models/rental_tenant_put_message_spec.rb +0 -104
  990. data/spec/models/rental_tenant_renewal_post_message_spec.rb +0 -104
  991. data/spec/models/rental_unit_features_message_spec.rb +0 -38
  992. data/spec/models/rental_unit_features_put_message_spec.rb +0 -38
  993. data/spec/models/rental_unit_message_spec.rb +0 -108
  994. data/spec/models/rental_unit_put_message_spec.rb +0 -78
  995. data/spec/models/rental_unit_search_message_spec.rb +0 -46
  996. data/spec/models/rental_units_post_message_spec.rb +0 -84
  997. data/spec/models/requested_by_user_entity_message_spec.rb +0 -68
  998. data/spec/models/resident_center_user_message_spec.rb +0 -56
  999. data/spec/models/resident_center_user_reference_message_spec.rb +0 -62
  1000. data/spec/models/resident_center_user_search_message_spec.rb +0 -66
  1001. data/spec/models/resident_request_task_message_spec.rb +0 -144
  1002. data/spec/models/resident_request_task_post_message_spec.rb +0 -114
  1003. data/spec/models/resident_request_task_put_message_spec.rb +0 -84
  1004. data/spec/models/resident_request_task_search_message_spec.rb +0 -118
  1005. data/spec/models/save_address_message_spec.rb +0 -74
  1006. data/spec/models/save_emergency_contact_message_spec.rb +0 -52
  1007. data/spec/models/task_category_message_spec.rb +0 -52
  1008. data/spec/models/task_category_put_message_spec.rb +0 -34
  1009. data/spec/models/task_category_response_message_spec.rb +0 -52
  1010. data/spec/models/task_category_save_message_spec.rb +0 -34
  1011. data/spec/models/task_history_file_message_spec.rb +0 -64
  1012. data/spec/models/task_history_file_upload_post_message_spec.rb +0 -34
  1013. data/spec/models/task_history_message_spec.rb +0 -112
  1014. data/spec/models/task_history_put_message_spec.rb +0 -34
  1015. data/spec/models/task_history_user_message_spec.rb +0 -52
  1016. data/spec/models/task_search_message_spec.rb +0 -128
  1017. data/spec/models/task_sub_category_message_spec.rb +0 -40
  1018. data/spec/models/tax_information_post_message_spec.rb +0 -62
  1019. data/spec/models/tax_information_save_message_spec.rb +0 -68
  1020. data/spec/models/tenant_message_spec.rb +0 -128
  1021. data/spec/models/tenant_search_message_spec.rb +0 -96
  1022. data/spec/models/to_do_task_message_spec.rb +0 -108
  1023. data/spec/models/to_do_task_post_message_spec.rb +0 -96
  1024. data/spec/models/to_do_task_put_message_spec.rb +0 -96
  1025. data/spec/models/to_do_task_search_message_spec.rb +0 -112
  1026. data/spec/models/undeposited_funds_message_spec.rb +0 -34
  1027. data/spec/models/unit_agreement_message_spec.rb +0 -50
  1028. data/spec/models/user_message_spec.rb +0 -104
  1029. data/spec/models/user_role_message_spec.rb +0 -52
  1030. data/spec/models/user_search_message_spec.rb +0 -66
  1031. data/spec/models/vehicle_message_spec.rb +0 -52
  1032. data/spec/models/vendor_category_message_spec.rb +0 -46
  1033. data/spec/models/vendor_category_save_message_spec.rb +0 -34
  1034. data/spec/models/vendor_credit_line_item_message_spec.rb +0 -58
  1035. data/spec/models/vendor_credit_line_item_post_message_spec.rb +0 -52
  1036. data/spec/models/vendor_credit_message_spec.rb +0 -58
  1037. data/spec/models/vendor_credit_post_message_spec.rb +0 -52
  1038. data/spec/models/vendor_insurance_message_spec.rb +0 -46
  1039. data/spec/models/vendor_insurance_save_message_spec.rb +0 -46
  1040. data/spec/models/vendor_message_spec.rb +0 -130
  1041. data/spec/models/vendor_post_message_spec.rb +0 -118
  1042. data/spec/models/vendor_put_message_spec.rb +0 -118
  1043. data/spec/models/vendor_refund_line_message_spec.rb +0 -58
  1044. data/spec/models/vendor_refund_line_post_message_spec.rb +0 -52
  1045. data/spec/models/vendor_refund_message_spec.rb +0 -74
  1046. data/spec/models/vendor_refund_post_message_spec.rb +0 -68
  1047. data/spec/models/vendor_search_message_spec.rb +0 -84
  1048. data/spec/models/vendor_tax_information_message_spec.rb +0 -68
  1049. data/spec/models/vendor_transaction_message_spec.rb +0 -68
  1050. data/spec/models/vendor_transaction_search_message_spec.rb +0 -62
  1051. data/spec/models/work_order_entry_contact_message_spec.rb +0 -40
  1052. data/spec/models/work_order_entry_contact_resource_message_spec.rb +0 -44
  1053. data/spec/models/work_order_line_item_message_spec.rb +0 -52
  1054. data/spec/models/work_order_line_item_save_message_spec.rb +0 -52
  1055. data/spec/models/work_order_message_spec.rb +0 -110
  1056. data/spec/models/work_order_post_message_spec.rb +0 -98
  1057. data/spec/models/work_order_put_message_spec.rb +0 -86
  1058. data/spec/models/work_order_search_message_spec.rb +0 -158
  1059. data/spec/models/work_order_task_message_spec.rb +0 -88
  1060. data/spec/models/work_order_task_post_message_spec.rb +0 -78
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Open API, powered by Buildium
3
3
 
4
- #GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
4
+ # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> ​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
5
5
 
6
6
  The version of the OpenAPI document: v1
7
7
 
@@ -19,31 +19,31 @@ module Buildium
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create a contact request
23
- # Creates a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
24
- # @param contact_request_task_post_message [ContactRequestTaskPostMessage]
22
+ # Create a task category
23
+ # Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
24
+ # @param task_category_save_message [TaskCategorySaveMessage]
25
25
  # @param [Hash] opts the optional parameters
26
- # @return [ContactRequestTaskMessage]
27
- def create_contact_request_task(contact_request_task_post_message, opts = {})
28
- data, _status_code, _headers = create_contact_request_task_with_http_info(contact_request_task_post_message, opts)
26
+ # @return [TaskCategoryMessage]
27
+ def create_task_category(task_category_save_message, opts = {})
28
+ data, _status_code, _headers = create_task_category_with_http_info(task_category_save_message, opts)
29
29
  data
30
30
  end
31
31
 
32
- # Create a contact request
33
- # Creates a contact request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
34
- # @param contact_request_task_post_message [ContactRequestTaskPostMessage]
32
+ # Create a task category
33
+ # Create a task category. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
34
+ # @param task_category_save_message [TaskCategorySaveMessage]
35
35
  # @param [Hash] opts the optional parameters
36
- # @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
37
- def create_contact_request_task_with_http_info(contact_request_task_post_message, opts = {})
36
+ # @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
37
+ def create_task_category_with_http_info(task_category_save_message, opts = {})
38
38
  if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: TasksApi.create_contact_request_task ...'
39
+ @api_client.config.logger.debug 'Calling API: TasksApi.create_task_category ...'
40
40
  end
41
- # verify the required parameter 'contact_request_task_post_message' is set
42
- if @api_client.config.client_side_validation && contact_request_task_post_message.nil?
43
- fail ArgumentError, "Missing the required parameter 'contact_request_task_post_message' when calling TasksApi.create_contact_request_task"
41
+ # verify the required parameter 'task_category_save_message' is set
42
+ if @api_client.config.client_side_validation && task_category_save_message.nil?
43
+ fail ArgumentError, "Missing the required parameter 'task_category_save_message' when calling TasksApi.create_task_category"
44
44
  end
45
45
  # resource path
46
- local_var_path = '/v1/tasks/contactrequests'
46
+ local_var_path = '/v1/tasks/categories'
47
47
 
48
48
  # query parameters
49
49
  query_params = opts[:query_params] || {}
@@ -62,16 +62,16 @@ module Buildium
62
62
  form_params = opts[:form_params] || {}
63
63
 
64
64
  # http body (model)
65
- post_body = opts[:debug_body] || @api_client.object_to_http_body(contact_request_task_post_message)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(task_category_save_message)
66
66
 
67
67
  # return_type
68
- return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
68
+ return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
69
69
 
70
70
  # auth_names
71
71
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
72
72
 
73
73
  new_options = opts.merge(
74
- :operation => :"TasksApi.create_contact_request_task",
74
+ :operation => :"TasksApi.create_task_category",
75
75
  :header_params => header_params,
76
76
  :query_params => query_params,
77
77
  :form_params => form_params,
@@ -82,36 +82,48 @@ module Buildium
82
82
 
83
83
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
84
  if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: TasksApi#create_contact_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ @api_client.config.logger.debug "API called: TasksApi#create_task_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
86
  end
87
87
  return data, status_code, headers
88
88
  end
89
89
 
90
- # Create a rental owner request
91
- # Creates a rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
92
- # @param rental_owner_request_task_post_message [RentalOwnerRequestTaskPostMessage]
90
+ # Delete task history file
91
+ # Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit` `Delete`
92
+ # @param task_id [Integer]
93
+ # @param task_history_id [Integer]
94
+ # @param file_id [Integer]
93
95
  # @param [Hash] opts the optional parameters
94
- # @return [RentalOwnerRequestTaskMessage]
95
- def create_rental_owner_request_task(rental_owner_request_task_post_message, opts = {})
96
- data, _status_code, _headers = create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts)
97
- data
96
+ # @return [nil]
97
+ def delete_task_history_file(task_id, task_history_id, file_id, opts = {})
98
+ delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts)
99
+ nil
98
100
  end
99
101
 
100
- # Create a rental owner request
101
- # Creates a rental owner request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
102
- # @param rental_owner_request_task_post_message [RentalOwnerRequestTaskPostMessage]
102
+ # Delete task history file
103
+ # Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &#x60;Delete&#x60;
104
+ # @param task_id [Integer]
105
+ # @param task_history_id [Integer]
106
+ # @param file_id [Integer]
103
107
  # @param [Hash] opts the optional parameters
104
- # @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
105
- def create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts = {})
108
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
109
+ def delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts = {})
106
110
  if @api_client.config.debugging
107
- @api_client.config.logger.debug 'Calling API: TasksApi.create_rental_owner_request_task ...'
111
+ @api_client.config.logger.debug 'Calling API: TasksApi.delete_task_history_file ...'
112
+ end
113
+ # verify the required parameter 'task_id' is set
114
+ if @api_client.config.client_side_validation && task_id.nil?
115
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.delete_task_history_file"
108
116
  end
109
- # verify the required parameter 'rental_owner_request_task_post_message' is set
110
- if @api_client.config.client_side_validation && rental_owner_request_task_post_message.nil?
111
- fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_post_message' when calling TasksApi.create_rental_owner_request_task"
117
+ # verify the required parameter 'task_history_id' is set
118
+ if @api_client.config.client_side_validation && task_history_id.nil?
119
+ fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.delete_task_history_file"
120
+ end
121
+ # verify the required parameter 'file_id' is set
122
+ if @api_client.config.client_side_validation && file_id.nil?
123
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.delete_task_history_file"
112
124
  end
113
125
  # resource path
114
- local_var_path = '/v1/tasks/rentalownerrequests'
126
+ local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
115
127
 
116
128
  # query parameters
117
129
  query_params = opts[:query_params] || {}
@@ -120,26 +132,21 @@ module Buildium
120
132
  header_params = opts[:header_params] || {}
121
133
  # HTTP header 'Accept' (if needed)
122
134
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
- # HTTP header 'Content-Type'
124
- content_type = @api_client.select_header_content_type(['application/json'])
125
- if !content_type.nil?
126
- header_params['Content-Type'] = content_type
127
- end
128
135
 
129
136
  # form parameters
130
137
  form_params = opts[:form_params] || {}
131
138
 
132
139
  # http body (model)
133
- post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_owner_request_task_post_message)
140
+ post_body = opts[:debug_body]
134
141
 
135
142
  # return_type
136
- return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
143
+ return_type = opts[:debug_return_type]
137
144
 
138
145
  # auth_names
139
146
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
140
147
 
141
148
  new_options = opts.merge(
142
- :operation => :"TasksApi.create_rental_owner_request_task",
149
+ :operation => :"TasksApi.delete_task_history_file",
143
150
  :header_params => header_params,
144
151
  :query_params => query_params,
145
152
  :form_params => form_params,
@@ -148,66 +155,64 @@ module Buildium
148
155
  :return_type => return_type
149
156
  )
150
157
 
151
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
158
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
152
159
  if @api_client.config.debugging
153
- @api_client.config.logger.debug "API called: TasksApi#create_rental_owner_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
160
+ @api_client.config.logger.debug "API called: TasksApi#delete_task_history_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
161
  end
155
162
  return data, status_code, headers
156
163
  end
157
164
 
158
- # Create a resident request
159
- # Creates a resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
160
- # @param resident_request_task_post_message [ResidentRequestTaskPostMessage]
165
+ # Retrieve all task categories
166
+ # Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
161
167
  # @param [Hash] opts the optional parameters
162
- # @return [ResidentRequestTaskMessage]
163
- def create_resource(resident_request_task_post_message, opts = {})
164
- data, _status_code, _headers = create_resource_with_http_info(resident_request_task_post_message, opts)
168
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
169
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
170
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
171
+ # @return [Array<TaskCategoryMessage>]
172
+ def get_all_task_categories(opts = {})
173
+ data, _status_code, _headers = get_all_task_categories_with_http_info(opts)
165
174
  data
166
175
  end
167
176
 
168
- # Create a resident request
169
- # Creates a resident request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
170
- # @param resident_request_task_post_message [ResidentRequestTaskPostMessage]
177
+ # Retrieve all task categories
178
+ # Retrieves a list of task categories. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
171
179
  # @param [Hash] opts the optional parameters
172
- # @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
173
- def create_resource_with_http_info(resident_request_task_post_message, opts = {})
180
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
181
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
182
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
183
+ # @return [Array<(Array<TaskCategoryMessage>, Integer, Hash)>] Array<TaskCategoryMessage> data, response status code and response headers
184
+ def get_all_task_categories_with_http_info(opts = {})
174
185
  if @api_client.config.debugging
175
- @api_client.config.logger.debug 'Calling API: TasksApi.create_resource ...'
176
- end
177
- # verify the required parameter 'resident_request_task_post_message' is set
178
- if @api_client.config.client_side_validation && resident_request_task_post_message.nil?
179
- fail ArgumentError, "Missing the required parameter 'resident_request_task_post_message' when calling TasksApi.create_resource"
186
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_categories ...'
180
187
  end
181
188
  # resource path
182
- local_var_path = '/v1/tasks/residentrequests'
189
+ local_var_path = '/v1/tasks/categories'
183
190
 
184
191
  # query parameters
185
192
  query_params = opts[:query_params] || {}
193
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
194
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
195
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
186
196
 
187
197
  # header parameters
188
198
  header_params = opts[:header_params] || {}
189
199
  # HTTP header 'Accept' (if needed)
190
200
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
191
- # HTTP header 'Content-Type'
192
- content_type = @api_client.select_header_content_type(['application/json'])
193
- if !content_type.nil?
194
- header_params['Content-Type'] = content_type
195
- end
196
201
 
197
202
  # form parameters
198
203
  form_params = opts[:form_params] || {}
199
204
 
200
205
  # http body (model)
201
- post_body = opts[:debug_body] || @api_client.object_to_http_body(resident_request_task_post_message)
206
+ post_body = opts[:debug_body]
202
207
 
203
208
  # return_type
204
- return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
209
+ return_type = opts[:debug_return_type] || 'Array<TaskCategoryMessage>'
205
210
 
206
211
  # auth_names
207
212
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
208
213
 
209
214
  new_options = opts.merge(
210
- :operation => :"TasksApi.create_resource",
215
+ :operation => :"TasksApi.get_all_task_categories",
211
216
  :header_params => header_params,
212
217
  :query_params => query_params,
213
218
  :form_params => form_params,
@@ -216,66 +221,76 @@ module Buildium
216
221
  :return_type => return_type
217
222
  )
218
223
 
219
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
224
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
220
225
  if @api_client.config.debugging
221
- @api_client.config.logger.debug "API called: TasksApi#create_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
+ @api_client.config.logger.debug "API called: TasksApi#get_all_task_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
227
  end
223
228
  return data, status_code, headers
224
229
  end
225
230
 
226
- # Create a task category
227
- # Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
228
- # @param task_category_save_message [TaskCategorySaveMessage]
231
+ # Retrieve all task history files
232
+ # Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
233
+ # @param task_id [Integer]
234
+ # @param task_history_id [Integer]
229
235
  # @param [Hash] opts the optional parameters
230
- # @return [TaskCategoryMessage]
231
- def create_task_category(task_category_save_message, opts = {})
232
- data, _status_code, _headers = create_task_category_with_http_info(task_category_save_message, opts)
236
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
237
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
238
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
239
+ # @return [Array<TaskHistoryFileMessage>]
240
+ def get_all_task_history_files(task_id, task_history_id, opts = {})
241
+ data, _status_code, _headers = get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
233
242
  data
234
243
  end
235
244
 
236
- # Create a task category
237
- # Create a task category. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
238
- # @param task_category_save_message [TaskCategorySaveMessage]
245
+ # Retrieve all task history files
246
+ # Retrieves the metadata for all files associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
247
+ # @param task_id [Integer]
248
+ # @param task_history_id [Integer]
239
249
  # @param [Hash] opts the optional parameters
240
- # @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
241
- def create_task_category_with_http_info(task_category_save_message, opts = {})
250
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
251
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
252
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
253
+ # @return [Array<(Array<TaskHistoryFileMessage>, Integer, Hash)>] Array<TaskHistoryFileMessage> data, response status code and response headers
254
+ def get_all_task_history_files_with_http_info(task_id, task_history_id, opts = {})
242
255
  if @api_client.config.debugging
243
- @api_client.config.logger.debug 'Calling API: TasksApi.create_task_category ...'
256
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_history_files ...'
244
257
  end
245
- # verify the required parameter 'task_category_save_message' is set
246
- if @api_client.config.client_side_validation && task_category_save_message.nil?
247
- fail ArgumentError, "Missing the required parameter 'task_category_save_message' when calling TasksApi.create_task_category"
258
+ # verify the required parameter 'task_id' is set
259
+ if @api_client.config.client_side_validation && task_id.nil?
260
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_all_task_history_files"
261
+ end
262
+ # verify the required parameter 'task_history_id' is set
263
+ if @api_client.config.client_side_validation && task_history_id.nil?
264
+ fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_all_task_history_files"
248
265
  end
249
266
  # resource path
250
- local_var_path = '/v1/tasks/categories'
267
+ local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
251
268
 
252
269
  # query parameters
253
270
  query_params = opts[:query_params] || {}
271
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
272
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
273
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
254
274
 
255
275
  # header parameters
256
276
  header_params = opts[:header_params] || {}
257
277
  # HTTP header 'Accept' (if needed)
258
278
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
259
- # HTTP header 'Content-Type'
260
- content_type = @api_client.select_header_content_type(['application/json'])
261
- if !content_type.nil?
262
- header_params['Content-Type'] = content_type
263
- end
264
279
 
265
280
  # form parameters
266
281
  form_params = opts[:form_params] || {}
267
282
 
268
283
  # http body (model)
269
- post_body = opts[:debug_body] || @api_client.object_to_http_body(task_category_save_message)
284
+ post_body = opts[:debug_body]
270
285
 
271
286
  # return_type
272
- return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
287
+ return_type = opts[:debug_return_type] || 'Array<TaskHistoryFileMessage>'
273
288
 
274
289
  # auth_names
275
290
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
276
291
 
277
292
  new_options = opts.merge(
278
- :operation => :"TasksApi.create_task_category",
293
+ :operation => :"TasksApi.get_all_task_history_files",
279
294
  :header_params => header_params,
280
295
  :query_params => query_params,
281
296
  :form_params => form_params,
@@ -284,66 +299,122 @@ module Buildium
284
299
  :return_type => return_type
285
300
  )
286
301
 
287
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
302
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
288
303
  if @api_client.config.debugging
289
- @api_client.config.logger.debug "API called: TasksApi#create_task_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
304
+ @api_client.config.logger.debug "API called: TasksApi#get_all_task_history_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
290
305
  end
291
306
  return data, status_code, headers
292
307
  end
293
308
 
294
- # Create a to do task
295
- # Creates a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
296
- # @param to_do_task_post_message [ToDoTaskPostMessage]
309
+ # Retrieve all tasks
310
+ # Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
297
311
  # @param [Hash] opts the optional parameters
298
- # @return [ToDoTaskMessage]
299
- def create_to_do_task(to_do_task_post_message, opts = {})
300
- data, _status_code, _headers = create_to_do_task_with_http_info(to_do_task_post_message, opts)
312
+ # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
313
+ # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
314
+ # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
315
+ # @option opts [String] :type Filters results to any task associated with the task type specified.
316
+ # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
317
+ # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
318
+ # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
319
+ # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
320
+ # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
321
+ # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
322
+ # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
323
+ # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
324
+ # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
325
+ # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
326
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
327
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
328
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
329
+ # @return [Array<AllTasksMessage>]
330
+ def get_all_tasks(opts = {})
331
+ data, _status_code, _headers = get_all_tasks_with_http_info(opts)
301
332
  data
302
333
  end
303
334
 
304
- # Create a to do task
305
- # Creates a to do task. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
306
- # @param to_do_task_post_message [ToDoTaskPostMessage]
335
+ # Retrieve all tasks
336
+ # Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
307
337
  # @param [Hash] opts the optional parameters
308
- # @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
309
- def create_to_do_task_with_http_info(to_do_task_post_message, opts = {})
338
+ # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
339
+ # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
340
+ # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
341
+ # @option opts [String] :type Filters results to any task associated with the task type specified.
342
+ # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
343
+ # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
344
+ # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
345
+ # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
346
+ # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
347
+ # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
348
+ # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
349
+ # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
350
+ # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
351
+ # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
352
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
353
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
354
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
355
+ # @return [Array<(Array<AllTasksMessage>, Integer, Hash)>] Array<AllTasksMessage> data, response status code and response headers
356
+ def get_all_tasks_with_http_info(opts = {})
310
357
  if @api_client.config.debugging
311
- @api_client.config.logger.debug 'Calling API: TasksApi.create_to_do_task ...'
358
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_all_tasks ...'
359
+ end
360
+ allowable_values = ["Rental", "RentalOwner", "Association"]
361
+ if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
362
+ fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
363
+ end
364
+ allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
365
+ if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
366
+ fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
367
+ end
368
+ allowable_values = ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"]
369
+ if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
370
+ fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
312
371
  end
313
- # verify the required parameter 'to_do_task_post_message' is set
314
- if @api_client.config.client_side_validation && to_do_task_post_message.nil?
315
- fail ArgumentError, "Missing the required parameter 'to_do_task_post_message' when calling TasksApi.create_to_do_task"
372
+ allowable_values = ["Low", "Normal", "High"]
373
+ if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
374
+ fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
316
375
  end
317
376
  # resource path
318
- local_var_path = '/v1/tasks/todorequests'
377
+ local_var_path = '/v1/tasks'
319
378
 
320
379
  # query parameters
321
380
  query_params = opts[:query_params] || {}
381
+ query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
382
+ query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
383
+ query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
384
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
385
+ query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
386
+ query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
387
+ query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
388
+ query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
389
+ query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
390
+ query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
391
+ query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
392
+ query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
393
+ query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
394
+ query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
395
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
396
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
397
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
322
398
 
323
399
  # header parameters
324
400
  header_params = opts[:header_params] || {}
325
401
  # HTTP header 'Accept' (if needed)
326
402
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
327
- # HTTP header 'Content-Type'
328
- content_type = @api_client.select_header_content_type(['application/json'])
329
- if !content_type.nil?
330
- header_params['Content-Type'] = content_type
331
- end
332
403
 
333
404
  # form parameters
334
405
  form_params = opts[:form_params] || {}
335
406
 
336
407
  # http body (model)
337
- post_body = opts[:debug_body] || @api_client.object_to_http_body(to_do_task_post_message)
408
+ post_body = opts[:debug_body]
338
409
 
339
410
  # return_type
340
- return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
411
+ return_type = opts[:debug_return_type] || 'Array<AllTasksMessage>'
341
412
 
342
413
  # auth_names
343
414
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
344
415
 
345
416
  new_options = opts.merge(
346
- :operation => :"TasksApi.create_to_do_task",
417
+ :operation => :"TasksApi.get_all_tasks",
347
418
  :header_params => header_params,
348
419
  :query_params => query_params,
349
420
  :form_params => form_params,
@@ -352,1269 +423,50 @@ module Buildium
352
423
  :return_type => return_type
353
424
  )
354
425
 
355
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
426
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
356
427
  if @api_client.config.debugging
357
- @api_client.config.logger.debug "API called: TasksApi#create_to_do_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
428
+ @api_client.config.logger.debug "API called: TasksApi#get_all_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
358
429
  end
359
430
  return data, status_code, headers
360
431
  end
361
432
 
362
- # Delete task history file
363
- # Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit` `Delete`
433
+ # Download a task history file
434
+ # Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
364
435
  # @param task_id [Integer]
365
436
  # @param task_history_id [Integer]
366
437
  # @param file_id [Integer]
367
438
  # @param [Hash] opts the optional parameters
368
- # @return [nil]
369
- def delete_task_history_file(task_id, task_history_id, file_id, opts = {})
370
- delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts)
371
- nil
439
+ # @return [FileDownloadMessage]
440
+ def get_file_download_request(task_id, task_history_id, file_id, opts = {})
441
+ data, _status_code, _headers = get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts)
442
+ data
372
443
  end
373
444
 
374
- # Delete task history file
375
- # Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60; &#x60;Delete&#x60;
445
+ # Download a task history file
446
+ # Downloads a specific file associated to the task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
376
447
  # @param task_id [Integer]
377
448
  # @param task_history_id [Integer]
378
449
  # @param file_id [Integer]
379
450
  # @param [Hash] opts the optional parameters
380
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
381
- def delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts = {})
382
- if @api_client.config.debugging
383
- @api_client.config.logger.debug 'Calling API: TasksApi.delete_task_history_file ...'
384
- end
385
- # verify the required parameter 'task_id' is set
386
- if @api_client.config.client_side_validation && task_id.nil?
387
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.delete_task_history_file"
388
- end
389
- # verify the required parameter 'task_history_id' is set
390
- if @api_client.config.client_side_validation && task_history_id.nil?
391
- fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.delete_task_history_file"
392
- end
393
- # verify the required parameter 'file_id' is set
394
- if @api_client.config.client_side_validation && file_id.nil?
395
- fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.delete_task_history_file"
396
- end
397
- # resource path
398
- local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
399
-
400
- # query parameters
401
- query_params = opts[:query_params] || {}
402
-
403
- # header parameters
404
- header_params = opts[:header_params] || {}
405
- # HTTP header 'Accept' (if needed)
406
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
407
-
408
- # form parameters
409
- form_params = opts[:form_params] || {}
410
-
411
- # http body (model)
412
- post_body = opts[:debug_body]
413
-
414
- # return_type
415
- return_type = opts[:debug_return_type]
416
-
417
- # auth_names
418
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
419
-
420
- new_options = opts.merge(
421
- :operation => :"TasksApi.delete_task_history_file",
422
- :header_params => header_params,
423
- :query_params => query_params,
424
- :form_params => form_params,
425
- :body => post_body,
426
- :auth_names => auth_names,
427
- :return_type => return_type
428
- )
429
-
430
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
431
- if @api_client.config.debugging
432
- @api_client.config.logger.debug "API called: TasksApi#delete_task_history_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
433
- end
434
- return data, status_code, headers
435
- end
436
-
437
- # Retrieve all rental owner requests
438
- # Retrieves all rental owner requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
439
- # @param [Hash] opts the optional parameters
440
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
441
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
442
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
443
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
444
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
445
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
446
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
447
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
448
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
449
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
450
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
451
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
452
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
453
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
454
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
455
- # @return [Array<RentalOwnerRequestTaskMessage>]
456
- def get_all_rental_owner_request_tasks(opts = {})
457
- data, _status_code, _headers = get_all_rental_owner_request_tasks_with_http_info(opts)
458
- data
459
- end
460
-
461
- # Retrieve all rental owner requests
462
- # Retrieves all rental owner requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
463
- # @param [Hash] opts the optional parameters
464
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
465
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
466
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
467
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
468
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
469
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
470
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
471
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
472
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
473
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
474
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
475
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
476
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
477
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
478
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
479
- # @return [Array<(Array<RentalOwnerRequestTaskMessage>, Integer, Hash)>] Array<RentalOwnerRequestTaskMessage> data, response status code and response headers
480
- def get_all_rental_owner_request_tasks_with_http_info(opts = {})
481
- if @api_client.config.debugging
482
- @api_client.config.logger.debug 'Calling API: TasksApi.get_all_rental_owner_request_tasks ...'
483
- end
484
- allowable_values = ["Rental", "RentalOwner", "Association"]
485
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
486
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
487
- end
488
- allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
489
- if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
490
- fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
491
- end
492
- allowable_values = ["Low", "Normal", "High"]
493
- if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
494
- fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
495
- end
496
- # resource path
497
- local_var_path = '/v1/tasks/rentalownerrequests'
498
-
499
- # query parameters
500
- query_params = opts[:query_params] || {}
501
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
502
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
503
- query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
504
- query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
505
- query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
506
- query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
507
- query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
508
- query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
509
- query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
510
- query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
511
- query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
512
- query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
513
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
514
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
515
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
516
-
517
- # header parameters
518
- header_params = opts[:header_params] || {}
519
- # HTTP header 'Accept' (if needed)
520
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
521
-
522
- # form parameters
523
- form_params = opts[:form_params] || {}
524
-
525
- # http body (model)
526
- post_body = opts[:debug_body]
527
-
528
- # return_type
529
- return_type = opts[:debug_return_type] || 'Array<RentalOwnerRequestTaskMessage>'
530
-
531
- # auth_names
532
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
533
-
534
- new_options = opts.merge(
535
- :operation => :"TasksApi.get_all_rental_owner_request_tasks",
536
- :header_params => header_params,
537
- :query_params => query_params,
538
- :form_params => form_params,
539
- :body => post_body,
540
- :auth_names => auth_names,
541
- :return_type => return_type
542
- )
543
-
544
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
545
- if @api_client.config.debugging
546
- @api_client.config.logger.debug "API called: TasksApi#get_all_rental_owner_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
547
- end
548
- return data, status_code, headers
549
- end
550
-
551
- # Retrieve all task categories
552
- # Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
553
- # @param [Hash] opts the optional parameters
554
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
555
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
556
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
557
- # @return [Array<TaskCategoryMessage>]
558
- def get_all_task_categories(opts = {})
559
- data, _status_code, _headers = get_all_task_categories_with_http_info(opts)
560
- data
561
- end
562
-
563
- # Retrieve all task categories
564
- # Retrieves a list of task categories. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
565
- # @param [Hash] opts the optional parameters
566
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
567
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
568
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
569
- # @return [Array<(Array<TaskCategoryMessage>, Integer, Hash)>] Array<TaskCategoryMessage> data, response status code and response headers
570
- def get_all_task_categories_with_http_info(opts = {})
571
- if @api_client.config.debugging
572
- @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_categories ...'
573
- end
574
- # resource path
575
- local_var_path = '/v1/tasks/categories'
576
-
577
- # query parameters
578
- query_params = opts[:query_params] || {}
579
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
580
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
581
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
582
-
583
- # header parameters
584
- header_params = opts[:header_params] || {}
585
- # HTTP header 'Accept' (if needed)
586
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
587
-
588
- # form parameters
589
- form_params = opts[:form_params] || {}
590
-
591
- # http body (model)
592
- post_body = opts[:debug_body]
593
-
594
- # return_type
595
- return_type = opts[:debug_return_type] || 'Array<TaskCategoryMessage>'
596
-
597
- # auth_names
598
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
599
-
600
- new_options = opts.merge(
601
- :operation => :"TasksApi.get_all_task_categories",
602
- :header_params => header_params,
603
- :query_params => query_params,
604
- :form_params => form_params,
605
- :body => post_body,
606
- :auth_names => auth_names,
607
- :return_type => return_type
608
- )
609
-
610
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
611
- if @api_client.config.debugging
612
- @api_client.config.logger.debug "API called: TasksApi#get_all_task_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
613
- end
614
- return data, status_code, headers
615
- end
616
-
617
- # Retrieve all task history files
618
- # Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
619
- # @param task_id [Integer]
620
- # @param task_history_id [Integer]
621
- # @param [Hash] opts the optional parameters
622
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
623
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
624
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
625
- # @return [Array<TaskHistoryFileMessage>]
626
- def get_all_task_history_files(task_id, task_history_id, opts = {})
627
- data, _status_code, _headers = get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
628
- data
629
- end
630
-
631
- # Retrieve all task history files
632
- # Retrieves the metadata for all files associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
633
- # @param task_id [Integer]
634
- # @param task_history_id [Integer]
635
- # @param [Hash] opts the optional parameters
636
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
637
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
638
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
639
- # @return [Array<(Array<TaskHistoryFileMessage>, Integer, Hash)>] Array<TaskHistoryFileMessage> data, response status code and response headers
640
- def get_all_task_history_files_with_http_info(task_id, task_history_id, opts = {})
641
- if @api_client.config.debugging
642
- @api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_history_files ...'
643
- end
644
- # verify the required parameter 'task_id' is set
645
- if @api_client.config.client_side_validation && task_id.nil?
646
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_all_task_history_files"
647
- end
648
- # verify the required parameter 'task_history_id' is set
649
- if @api_client.config.client_side_validation && task_history_id.nil?
650
- fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_all_task_history_files"
651
- end
652
- # resource path
653
- local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
654
-
655
- # query parameters
656
- query_params = opts[:query_params] || {}
657
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
658
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
659
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
660
-
661
- # header parameters
662
- header_params = opts[:header_params] || {}
663
- # HTTP header 'Accept' (if needed)
664
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
665
-
666
- # form parameters
667
- form_params = opts[:form_params] || {}
668
-
669
- # http body (model)
670
- post_body = opts[:debug_body]
671
-
672
- # return_type
673
- return_type = opts[:debug_return_type] || 'Array<TaskHistoryFileMessage>'
674
-
675
- # auth_names
676
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
677
-
678
- new_options = opts.merge(
679
- :operation => :"TasksApi.get_all_task_history_files",
680
- :header_params => header_params,
681
- :query_params => query_params,
682
- :form_params => form_params,
683
- :body => post_body,
684
- :auth_names => auth_names,
685
- :return_type => return_type
686
- )
687
-
688
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
689
- if @api_client.config.debugging
690
- @api_client.config.logger.debug "API called: TasksApi#get_all_task_history_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
691
- end
692
- return data, status_code, headers
693
- end
694
-
695
- # Retrieve all tasks
696
- # Retrieves a list of tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
697
- # @param [Hash] opts the optional parameters
698
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
699
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
700
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
701
- # @option opts [String] :type Filters results to any task associated with the task type specified.
702
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
703
- # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
704
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
705
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
706
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
707
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
708
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
709
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
710
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
711
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
712
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
713
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
714
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
715
- # @return [Array<AllTasksMessage>]
716
- def get_all_tasks(opts = {})
717
- data, _status_code, _headers = get_all_tasks_with_http_info(opts)
718
- data
719
- end
720
-
721
- # Retrieve all tasks
722
- # Retrieves a list of tasks. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
723
- # @param [Hash] opts the optional parameters
724
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
725
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
726
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
727
- # @option opts [String] :type Filters results to any task associated with the task type specified.
728
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
729
- # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
730
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
731
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
732
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
733
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
734
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
735
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
736
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
737
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
738
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
739
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
740
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
741
- # @return [Array<(Array<AllTasksMessage>, Integer, Hash)>] Array<AllTasksMessage> data, response status code and response headers
742
- def get_all_tasks_with_http_info(opts = {})
743
- if @api_client.config.debugging
744
- @api_client.config.logger.debug 'Calling API: TasksApi.get_all_tasks ...'
745
- end
746
- allowable_values = ["Rental", "RentalOwner", "Association"]
747
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
748
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
749
- end
750
- allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
751
- if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
752
- fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
753
- end
754
- allowable_values = ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"]
755
- if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
756
- fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
757
- end
758
- allowable_values = ["Low", "Normal", "High"]
759
- if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
760
- fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
761
- end
762
- # resource path
763
- local_var_path = '/v1/tasks'
764
-
765
- # query parameters
766
- query_params = opts[:query_params] || {}
767
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
768
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
769
- query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
770
- query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
771
- query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
772
- query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
773
- query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
774
- query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
775
- query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
776
- query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
777
- query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
778
- query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
779
- query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
780
- query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
781
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
782
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
783
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
784
-
785
- # header parameters
786
- header_params = opts[:header_params] || {}
787
- # HTTP header 'Accept' (if needed)
788
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
789
-
790
- # form parameters
791
- form_params = opts[:form_params] || {}
792
-
793
- # http body (model)
794
- post_body = opts[:debug_body]
795
-
796
- # return_type
797
- return_type = opts[:debug_return_type] || 'Array<AllTasksMessage>'
798
-
799
- # auth_names
800
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
801
-
802
- new_options = opts.merge(
803
- :operation => :"TasksApi.get_all_tasks",
804
- :header_params => header_params,
805
- :query_params => query_params,
806
- :form_params => form_params,
807
- :body => post_body,
808
- :auth_names => auth_names,
809
- :return_type => return_type
810
- )
811
-
812
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
813
- if @api_client.config.debugging
814
- @api_client.config.logger.debug "API called: TasksApi#get_all_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
815
- end
816
- return data, status_code, headers
817
- end
818
-
819
- # Retrieve a contact request
820
- # Retrieves a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
821
- # @param contact_request_task_id [Integer] The contact request identifier.
822
- # @param [Hash] opts the optional parameters
823
- # @return [ContactRequestTaskMessage]
824
- def get_contact_request_task_by_id(contact_request_task_id, opts = {})
825
- data, _status_code, _headers = get_contact_request_task_by_id_with_http_info(contact_request_task_id, opts)
826
- data
827
- end
828
-
829
- # Retrieve a contact request
830
- # Retrieves a contact request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
831
- # @param contact_request_task_id [Integer] The contact request identifier.
832
- # @param [Hash] opts the optional parameters
833
- # @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
834
- def get_contact_request_task_by_id_with_http_info(contact_request_task_id, opts = {})
835
- if @api_client.config.debugging
836
- @api_client.config.logger.debug 'Calling API: TasksApi.get_contact_request_task_by_id ...'
837
- end
838
- # verify the required parameter 'contact_request_task_id' is set
839
- if @api_client.config.client_side_validation && contact_request_task_id.nil?
840
- fail ArgumentError, "Missing the required parameter 'contact_request_task_id' when calling TasksApi.get_contact_request_task_by_id"
841
- end
842
- # resource path
843
- local_var_path = '/v1/tasks/contactrequests/{contactRequestTaskId}'.sub('{' + 'contactRequestTaskId' + '}', CGI.escape(contact_request_task_id.to_s))
844
-
845
- # query parameters
846
- query_params = opts[:query_params] || {}
847
-
848
- # header parameters
849
- header_params = opts[:header_params] || {}
850
- # HTTP header 'Accept' (if needed)
851
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
852
-
853
- # form parameters
854
- form_params = opts[:form_params] || {}
855
-
856
- # http body (model)
857
- post_body = opts[:debug_body]
858
-
859
- # return_type
860
- return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
861
-
862
- # auth_names
863
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
864
-
865
- new_options = opts.merge(
866
- :operation => :"TasksApi.get_contact_request_task_by_id",
867
- :header_params => header_params,
868
- :query_params => query_params,
869
- :form_params => form_params,
870
- :body => post_body,
871
- :auth_names => auth_names,
872
- :return_type => return_type
873
- )
874
-
875
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
876
- if @api_client.config.debugging
877
- @api_client.config.logger.debug "API called: TasksApi#get_contact_request_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
878
- end
879
- return data, status_code, headers
880
- end
881
-
882
- # Retrieve all contact requests
883
- # Retrieves a list of contact requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
884
- # @param [Hash] opts the optional parameters
885
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
886
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
887
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
888
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
889
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
890
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
891
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
892
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
893
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
894
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
895
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
896
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
897
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
898
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
899
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
900
- # @return [Array<ContactRequestTaskMessage>]
901
- def get_contact_request_tasks(opts = {})
902
- data, _status_code, _headers = get_contact_request_tasks_with_http_info(opts)
903
- data
904
- end
905
-
906
- # Retrieve all contact requests
907
- # Retrieves a list of contact requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
908
- # @param [Hash] opts the optional parameters
909
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
910
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
911
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
912
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
913
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
914
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
915
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
916
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
917
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
918
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
919
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
920
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
921
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
922
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
923
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
924
- # @return [Array<(Array<ContactRequestTaskMessage>, Integer, Hash)>] Array<ContactRequestTaskMessage> data, response status code and response headers
925
- def get_contact_request_tasks_with_http_info(opts = {})
926
- if @api_client.config.debugging
927
- @api_client.config.logger.debug 'Calling API: TasksApi.get_contact_request_tasks ...'
928
- end
929
- allowable_values = ["Rental", "RentalOwner", "Association"]
930
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
931
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
932
- end
933
- allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
934
- if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
935
- fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
936
- end
937
- allowable_values = ["Low", "Normal", "High"]
938
- if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
939
- fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
940
- end
941
- # resource path
942
- local_var_path = '/v1/tasks/contactrequests'
943
-
944
- # query parameters
945
- query_params = opts[:query_params] || {}
946
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
947
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
948
- query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
949
- query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
950
- query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
951
- query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
952
- query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
953
- query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
954
- query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
955
- query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
956
- query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
957
- query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
958
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
959
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
960
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
961
-
962
- # header parameters
963
- header_params = opts[:header_params] || {}
964
- # HTTP header 'Accept' (if needed)
965
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
966
-
967
- # form parameters
968
- form_params = opts[:form_params] || {}
969
-
970
- # http body (model)
971
- post_body = opts[:debug_body]
972
-
973
- # return_type
974
- return_type = opts[:debug_return_type] || 'Array<ContactRequestTaskMessage>'
975
-
976
- # auth_names
977
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
978
-
979
- new_options = opts.merge(
980
- :operation => :"TasksApi.get_contact_request_tasks",
981
- :header_params => header_params,
982
- :query_params => query_params,
983
- :form_params => form_params,
984
- :body => post_body,
985
- :auth_names => auth_names,
986
- :return_type => return_type
987
- )
988
-
989
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
990
- if @api_client.config.debugging
991
- @api_client.config.logger.debug "API called: TasksApi#get_contact_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
992
- end
993
- return data, status_code, headers
994
- end
995
-
996
- # Download a task history file
997
- # Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
998
- # @param task_id [Integer]
999
- # @param task_history_id [Integer]
1000
- # @param file_id [Integer]
1001
- # @param [Hash] opts the optional parameters
1002
- # @return [FileDownloadMessage]
1003
- def get_file_download_request(task_id, task_history_id, file_id, opts = {})
1004
- data, _status_code, _headers = get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts)
1005
- data
1006
- end
1007
-
1008
- # Download a task history file
1009
- # Downloads a specific file associated to the task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1010
- # @param task_id [Integer]
1011
- # @param task_history_id [Integer]
1012
- # @param file_id [Integer]
1013
- # @param [Hash] opts the optional parameters
1014
- # @return [Array<(FileDownloadMessage, Integer, Hash)>] FileDownloadMessage data, response status code and response headers
1015
- def get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts = {})
1016
- if @api_client.config.debugging
1017
- @api_client.config.logger.debug 'Calling API: TasksApi.get_file_download_request ...'
1018
- end
1019
- # verify the required parameter 'task_id' is set
1020
- if @api_client.config.client_side_validation && task_id.nil?
1021
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_file_download_request"
1022
- end
1023
- # verify the required parameter 'task_history_id' is set
1024
- if @api_client.config.client_side_validation && task_history_id.nil?
1025
- fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_file_download_request"
1026
- end
1027
- # verify the required parameter 'file_id' is set
1028
- if @api_client.config.client_side_validation && file_id.nil?
1029
- fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_file_download_request"
1030
- end
1031
- # resource path
1032
- local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}/downloadrequest'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
1033
-
1034
- # query parameters
1035
- query_params = opts[:query_params] || {}
1036
-
1037
- # header parameters
1038
- header_params = opts[:header_params] || {}
1039
- # HTTP header 'Accept' (if needed)
1040
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1041
-
1042
- # form parameters
1043
- form_params = opts[:form_params] || {}
1044
-
1045
- # http body (model)
1046
- post_body = opts[:debug_body]
1047
-
1048
- # return_type
1049
- return_type = opts[:debug_return_type] || 'FileDownloadMessage'
1050
-
1051
- # auth_names
1052
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1053
-
1054
- new_options = opts.merge(
1055
- :operation => :"TasksApi.get_file_download_request",
1056
- :header_params => header_params,
1057
- :query_params => query_params,
1058
- :form_params => form_params,
1059
- :body => post_body,
1060
- :auth_names => auth_names,
1061
- :return_type => return_type
1062
- )
1063
-
1064
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1065
- if @api_client.config.debugging
1066
- @api_client.config.logger.debug "API called: TasksApi#get_file_download_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1067
- end
1068
- return data, status_code, headers
1069
- end
1070
-
1071
- # Retrieve a rental owner request
1072
- # Retrieves a specific rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1073
- # @param rental_owner_request_task_id [Integer] The rental owner request identifier.
1074
- # @param [Hash] opts the optional parameters
1075
- # @return [RentalOwnerRequestTaskMessage]
1076
- def get_rental_owner_request_task_by_id(rental_owner_request_task_id, opts = {})
1077
- data, _status_code, _headers = get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts)
1078
- data
1079
- end
1080
-
1081
- # Retrieve a rental owner request
1082
- # Retrieves a specific rental owner request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1083
- # @param rental_owner_request_task_id [Integer] The rental owner request identifier.
1084
- # @param [Hash] opts the optional parameters
1085
- # @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
1086
- def get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts = {})
1087
- if @api_client.config.debugging
1088
- @api_client.config.logger.debug 'Calling API: TasksApi.get_rental_owner_request_task_by_id ...'
1089
- end
1090
- # verify the required parameter 'rental_owner_request_task_id' is set
1091
- if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
1092
- fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling TasksApi.get_rental_owner_request_task_by_id"
1093
- end
1094
- # resource path
1095
- local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_id.to_s))
1096
-
1097
- # query parameters
1098
- query_params = opts[:query_params] || {}
1099
-
1100
- # header parameters
1101
- header_params = opts[:header_params] || {}
1102
- # HTTP header 'Accept' (if needed)
1103
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1104
-
1105
- # form parameters
1106
- form_params = opts[:form_params] || {}
1107
-
1108
- # http body (model)
1109
- post_body = opts[:debug_body]
1110
-
1111
- # return_type
1112
- return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
1113
-
1114
- # auth_names
1115
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1116
-
1117
- new_options = opts.merge(
1118
- :operation => :"TasksApi.get_rental_owner_request_task_by_id",
1119
- :header_params => header_params,
1120
- :query_params => query_params,
1121
- :form_params => form_params,
1122
- :body => post_body,
1123
- :auth_names => auth_names,
1124
- :return_type => return_type
1125
- )
1126
-
1127
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1128
- if @api_client.config.debugging
1129
- @api_client.config.logger.debug "API called: TasksApi#get_rental_owner_request_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1130
- end
1131
- return data, status_code, headers
1132
- end
1133
-
1134
- # Retrieve a resident request
1135
- # Retrieves a specific resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1136
- # @param resident_request_task_id [Integer] The resident request identifier.
1137
- # @param [Hash] opts the optional parameters
1138
- # @return [ResidentRequestTaskMessage]
1139
- def get_resident_request_task(resident_request_task_id, opts = {})
1140
- data, _status_code, _headers = get_resident_request_task_with_http_info(resident_request_task_id, opts)
1141
- data
1142
- end
1143
-
1144
- # Retrieve a resident request
1145
- # Retrieves a specific resident request. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1146
- # @param resident_request_task_id [Integer] The resident request identifier.
1147
- # @param [Hash] opts the optional parameters
1148
- # @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
1149
- def get_resident_request_task_with_http_info(resident_request_task_id, opts = {})
1150
- if @api_client.config.debugging
1151
- @api_client.config.logger.debug 'Calling API: TasksApi.get_resident_request_task ...'
1152
- end
1153
- # verify the required parameter 'resident_request_task_id' is set
1154
- if @api_client.config.client_side_validation && resident_request_task_id.nil?
1155
- fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling TasksApi.get_resident_request_task"
1156
- end
1157
- # resource path
1158
- local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_id.to_s))
1159
-
1160
- # query parameters
1161
- query_params = opts[:query_params] || {}
1162
-
1163
- # header parameters
1164
- header_params = opts[:header_params] || {}
1165
- # HTTP header 'Accept' (if needed)
1166
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1167
-
1168
- # form parameters
1169
- form_params = opts[:form_params] || {}
1170
-
1171
- # http body (model)
1172
- post_body = opts[:debug_body]
1173
-
1174
- # return_type
1175
- return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
1176
-
1177
- # auth_names
1178
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1179
-
1180
- new_options = opts.merge(
1181
- :operation => :"TasksApi.get_resident_request_task",
1182
- :header_params => header_params,
1183
- :query_params => query_params,
1184
- :form_params => form_params,
1185
- :body => post_body,
1186
- :auth_names => auth_names,
1187
- :return_type => return_type
1188
- )
1189
-
1190
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1191
- if @api_client.config.debugging
1192
- @api_client.config.logger.debug "API called: TasksApi#get_resident_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1193
- end
1194
- return data, status_code, headers
1195
- end
1196
-
1197
- # Retrieve all resident requests
1198
- # Retrieves a list of resident requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1199
- # @param [Hash] opts the optional parameters
1200
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
1201
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
1202
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
1203
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
1204
- # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
1205
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
1206
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
1207
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
1208
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
1209
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
1210
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
1211
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
1212
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
1213
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1214
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1215
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1216
- # @return [Array<ResidentRequestTaskMessage>]
1217
- def get_resident_request_tasks(opts = {})
1218
- data, _status_code, _headers = get_resident_request_tasks_with_http_info(opts)
1219
- data
1220
- end
1221
-
1222
- # Retrieve all resident requests
1223
- # Retrieves a list of resident requests. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1224
- # @param [Hash] opts the optional parameters
1225
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
1226
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
1227
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
1228
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
1229
- # @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
1230
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
1231
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
1232
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
1233
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
1234
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
1235
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
1236
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
1237
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
1238
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1239
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1240
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1241
- # @return [Array<(Array<ResidentRequestTaskMessage>, Integer, Hash)>] Array<ResidentRequestTaskMessage> data, response status code and response headers
1242
- def get_resident_request_tasks_with_http_info(opts = {})
1243
- if @api_client.config.debugging
1244
- @api_client.config.logger.debug 'Calling API: TasksApi.get_resident_request_tasks ...'
1245
- end
1246
- allowable_values = ["Rental", "RentalOwner", "Association"]
1247
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
1248
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
1249
- end
1250
- allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
1251
- if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
1252
- fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
1253
- end
1254
- allowable_values = ["Low", "Normal", "High"]
1255
- if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
1256
- fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
1257
- end
1258
- # resource path
1259
- local_var_path = '/v1/tasks/residentrequests'
1260
-
1261
- # query parameters
1262
- query_params = opts[:query_params] || {}
1263
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
1264
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
1265
- query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
1266
- query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
1267
- query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
1268
- query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
1269
- query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
1270
- query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
1271
- query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
1272
- query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
1273
- query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
1274
- query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
1275
- query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
1276
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1277
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1278
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1279
-
1280
- # header parameters
1281
- header_params = opts[:header_params] || {}
1282
- # HTTP header 'Accept' (if needed)
1283
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1284
-
1285
- # form parameters
1286
- form_params = opts[:form_params] || {}
1287
-
1288
- # http body (model)
1289
- post_body = opts[:debug_body]
1290
-
1291
- # return_type
1292
- return_type = opts[:debug_return_type] || 'Array<ResidentRequestTaskMessage>'
1293
-
1294
- # auth_names
1295
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1296
-
1297
- new_options = opts.merge(
1298
- :operation => :"TasksApi.get_resident_request_tasks",
1299
- :header_params => header_params,
1300
- :query_params => query_params,
1301
- :form_params => form_params,
1302
- :body => post_body,
1303
- :auth_names => auth_names,
1304
- :return_type => return_type
1305
- )
1306
-
1307
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1308
- if @api_client.config.debugging
1309
- @api_client.config.logger.debug "API called: TasksApi#get_resident_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1310
- end
1311
- return data, status_code, headers
1312
- end
1313
-
1314
- # Retrieve a task
1315
- # Retrieves a specific task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1316
- # @param task_id [Integer] The task identifier
1317
- # @param [Hash] opts the optional parameters
1318
- # @return [AllTasksMessage]
1319
- def get_task_by_id(task_id, opts = {})
1320
- data, _status_code, _headers = get_task_by_id_with_http_info(task_id, opts)
1321
- data
1322
- end
1323
-
1324
- # Retrieve a task
1325
- # Retrieves a specific task. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1326
- # @param task_id [Integer] The task identifier
1327
- # @param [Hash] opts the optional parameters
1328
- # @return [Array<(AllTasksMessage, Integer, Hash)>] AllTasksMessage data, response status code and response headers
1329
- def get_task_by_id_with_http_info(task_id, opts = {})
1330
- if @api_client.config.debugging
1331
- @api_client.config.logger.debug 'Calling API: TasksApi.get_task_by_id ...'
1332
- end
1333
- # verify the required parameter 'task_id' is set
1334
- if @api_client.config.client_side_validation && task_id.nil?
1335
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_by_id"
1336
- end
1337
- # resource path
1338
- local_var_path = '/v1/tasks/{taskId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
1339
-
1340
- # query parameters
1341
- query_params = opts[:query_params] || {}
1342
-
1343
- # header parameters
1344
- header_params = opts[:header_params] || {}
1345
- # HTTP header 'Accept' (if needed)
1346
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1347
-
1348
- # form parameters
1349
- form_params = opts[:form_params] || {}
1350
-
1351
- # http body (model)
1352
- post_body = opts[:debug_body]
1353
-
1354
- # return_type
1355
- return_type = opts[:debug_return_type] || 'AllTasksMessage'
1356
-
1357
- # auth_names
1358
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1359
-
1360
- new_options = opts.merge(
1361
- :operation => :"TasksApi.get_task_by_id",
1362
- :header_params => header_params,
1363
- :query_params => query_params,
1364
- :form_params => form_params,
1365
- :body => post_body,
1366
- :auth_names => auth_names,
1367
- :return_type => return_type
1368
- )
1369
-
1370
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1371
- if @api_client.config.debugging
1372
- @api_client.config.logger.debug "API called: TasksApi#get_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1373
- end
1374
- return data, status_code, headers
1375
- end
1376
-
1377
- # Retrieve a task category
1378
- # Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1379
- # @param task_category_id [Integer] The task category identifier.
1380
- # @param [Hash] opts the optional parameters
1381
- # @return [TaskCategoryMessage]
1382
- def get_task_category_by_id(task_category_id, opts = {})
1383
- data, _status_code, _headers = get_task_category_by_id_with_http_info(task_category_id, opts)
1384
- data
1385
- end
1386
-
1387
- # Retrieve a task category
1388
- # Retrieves a specific task category. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1389
- # @param task_category_id [Integer] The task category identifier.
1390
- # @param [Hash] opts the optional parameters
1391
- # @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
1392
- def get_task_category_by_id_with_http_info(task_category_id, opts = {})
1393
- if @api_client.config.debugging
1394
- @api_client.config.logger.debug 'Calling API: TasksApi.get_task_category_by_id ...'
1395
- end
1396
- # verify the required parameter 'task_category_id' is set
1397
- if @api_client.config.client_side_validation && task_category_id.nil?
1398
- fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.get_task_category_by_id"
1399
- end
1400
- # resource path
1401
- local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_id.to_s))
1402
-
1403
- # query parameters
1404
- query_params = opts[:query_params] || {}
1405
-
1406
- # header parameters
1407
- header_params = opts[:header_params] || {}
1408
- # HTTP header 'Accept' (if needed)
1409
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1410
-
1411
- # form parameters
1412
- form_params = opts[:form_params] || {}
1413
-
1414
- # http body (model)
1415
- post_body = opts[:debug_body]
1416
-
1417
- # return_type
1418
- return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
1419
-
1420
- # auth_names
1421
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1422
-
1423
- new_options = opts.merge(
1424
- :operation => :"TasksApi.get_task_category_by_id",
1425
- :header_params => header_params,
1426
- :query_params => query_params,
1427
- :form_params => form_params,
1428
- :body => post_body,
1429
- :auth_names => auth_names,
1430
- :return_type => return_type
1431
- )
1432
-
1433
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1434
- if @api_client.config.debugging
1435
- @api_client.config.logger.debug "API called: TasksApi#get_task_category_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1436
- end
1437
- return data, status_code, headers
1438
- end
1439
-
1440
- # Retrieve all task history
1441
- # Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1442
- # @param task_id [Integer]
1443
- # @param [Hash] opts the optional parameters
1444
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1445
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1446
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1447
- # @return [Array<TaskHistoryMessage>]
1448
- def get_task_histories(task_id, opts = {})
1449
- data, _status_code, _headers = get_task_histories_with_http_info(task_id, opts)
1450
- data
1451
- end
1452
-
1453
- # Retrieve all task history
1454
- # Retrieves all task history records for a specific task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1455
- # @param task_id [Integer]
1456
- # @param [Hash] opts the optional parameters
1457
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1458
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1459
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1460
- # @return [Array<(Array<TaskHistoryMessage>, Integer, Hash)>] Array<TaskHistoryMessage> data, response status code and response headers
1461
- def get_task_histories_with_http_info(task_id, opts = {})
1462
- if @api_client.config.debugging
1463
- @api_client.config.logger.debug 'Calling API: TasksApi.get_task_histories ...'
1464
- end
1465
- # verify the required parameter 'task_id' is set
1466
- if @api_client.config.client_side_validation && task_id.nil?
1467
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_histories"
1468
- end
1469
- # resource path
1470
- local_var_path = '/v1/tasks/{taskId}/history'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
1471
-
1472
- # query parameters
1473
- query_params = opts[:query_params] || {}
1474
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1475
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1476
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1477
-
1478
- # header parameters
1479
- header_params = opts[:header_params] || {}
1480
- # HTTP header 'Accept' (if needed)
1481
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1482
-
1483
- # form parameters
1484
- form_params = opts[:form_params] || {}
1485
-
1486
- # http body (model)
1487
- post_body = opts[:debug_body]
1488
-
1489
- # return_type
1490
- return_type = opts[:debug_return_type] || 'Array<TaskHistoryMessage>'
1491
-
1492
- # auth_names
1493
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1494
-
1495
- new_options = opts.merge(
1496
- :operation => :"TasksApi.get_task_histories",
1497
- :header_params => header_params,
1498
- :query_params => query_params,
1499
- :form_params => form_params,
1500
- :body => post_body,
1501
- :auth_names => auth_names,
1502
- :return_type => return_type
1503
- )
1504
-
1505
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1506
- if @api_client.config.debugging
1507
- @api_client.config.logger.debug "API called: TasksApi#get_task_histories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1508
- end
1509
- return data, status_code, headers
1510
- end
1511
-
1512
- # Retrieve a task history
1513
- # Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1514
- # @param task_id [Integer]
1515
- # @param task_history_id [Integer]
1516
- # @param [Hash] opts the optional parameters
1517
- # @return [TaskHistoryMessage]
1518
- def get_task_history_by_id(task_id, task_history_id, opts = {})
1519
- data, _status_code, _headers = get_task_history_by_id_with_http_info(task_id, task_history_id, opts)
1520
- data
1521
- end
1522
-
1523
- # Retrieve a task history
1524
- # Retrieves a specific task history record for a task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1525
- # @param task_id [Integer]
1526
- # @param task_history_id [Integer]
1527
- # @param [Hash] opts the optional parameters
1528
- # @return [Array<(TaskHistoryMessage, Integer, Hash)>] TaskHistoryMessage data, response status code and response headers
1529
- def get_task_history_by_id_with_http_info(task_id, task_history_id, opts = {})
1530
- if @api_client.config.debugging
1531
- @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_by_id ...'
1532
- end
1533
- # verify the required parameter 'task_id' is set
1534
- if @api_client.config.client_side_validation && task_id.nil?
1535
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_by_id"
1536
- end
1537
- # verify the required parameter 'task_history_id' is set
1538
- if @api_client.config.client_side_validation && task_history_id.nil?
1539
- fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_by_id"
1540
- end
1541
- # resource path
1542
- local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
1543
-
1544
- # query parameters
1545
- query_params = opts[:query_params] || {}
1546
-
1547
- # header parameters
1548
- header_params = opts[:header_params] || {}
1549
- # HTTP header 'Accept' (if needed)
1550
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1551
-
1552
- # form parameters
1553
- form_params = opts[:form_params] || {}
1554
-
1555
- # http body (model)
1556
- post_body = opts[:debug_body]
1557
-
1558
- # return_type
1559
- return_type = opts[:debug_return_type] || 'TaskHistoryMessage'
1560
-
1561
- # auth_names
1562
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1563
-
1564
- new_options = opts.merge(
1565
- :operation => :"TasksApi.get_task_history_by_id",
1566
- :header_params => header_params,
1567
- :query_params => query_params,
1568
- :form_params => form_params,
1569
- :body => post_body,
1570
- :auth_names => auth_names,
1571
- :return_type => return_type
1572
- )
1573
-
1574
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1575
- if @api_client.config.debugging
1576
- @api_client.config.logger.debug "API called: TasksApi#get_task_history_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1577
- end
1578
- return data, status_code, headers
1579
- end
1580
-
1581
- # Retrieve a task history file
1582
- # Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1583
- # @param task_id [Integer]
1584
- # @param task_history_id [Integer]
1585
- # @param file_id [Integer]
1586
- # @param [Hash] opts the optional parameters
1587
- # @return [TaskHistoryFileMessage]
1588
- def get_task_history_file_by_id(task_id, task_history_id, file_id, opts = {})
1589
- data, _status_code, _headers = get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts)
1590
- data
1591
- end
1592
-
1593
- # Retrieve a task history file
1594
- # Retrieves the metadata for a specific file associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1595
- # @param task_id [Integer]
1596
- # @param task_history_id [Integer]
1597
- # @param file_id [Integer]
1598
- # @param [Hash] opts the optional parameters
1599
- # @return [Array<(TaskHistoryFileMessage, Integer, Hash)>] TaskHistoryFileMessage data, response status code and response headers
1600
- def get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts = {})
451
+ # @return [Array<(FileDownloadMessage, Integer, Hash)>] FileDownloadMessage data, response status code and response headers
452
+ def get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts = {})
1601
453
  if @api_client.config.debugging
1602
- @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_file_by_id ...'
454
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_file_download_request ...'
1603
455
  end
1604
456
  # verify the required parameter 'task_id' is set
1605
457
  if @api_client.config.client_side_validation && task_id.nil?
1606
- fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_file_by_id"
458
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_file_download_request"
1607
459
  end
1608
460
  # verify the required parameter 'task_history_id' is set
1609
461
  if @api_client.config.client_side_validation && task_history_id.nil?
1610
- fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_file_by_id"
462
+ fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_file_download_request"
1611
463
  end
1612
464
  # verify the required parameter 'file_id' is set
1613
465
  if @api_client.config.client_side_validation && file_id.nil?
1614
- fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_task_history_file_by_id"
466
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_file_download_request"
1615
467
  end
1616
468
  # resource path
1617
- local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
469
+ local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}/downloadrequest'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
1618
470
 
1619
471
  # query parameters
1620
472
  query_params = opts[:query_params] || {}
@@ -1631,13 +483,13 @@ module Buildium
1631
483
  post_body = opts[:debug_body]
1632
484
 
1633
485
  # return_type
1634
- return_type = opts[:debug_return_type] || 'TaskHistoryFileMessage'
486
+ return_type = opts[:debug_return_type] || 'FileDownloadMessage'
1635
487
 
1636
488
  # auth_names
1637
489
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1638
490
 
1639
491
  new_options = opts.merge(
1640
- :operation => :"TasksApi.get_task_history_file_by_id",
492
+ :operation => :"TasksApi.get_file_download_request",
1641
493
  :header_params => header_params,
1642
494
  :query_params => query_params,
1643
495
  :form_params => form_params,
@@ -1646,38 +498,38 @@ module Buildium
1646
498
  :return_type => return_type
1647
499
  )
1648
500
 
1649
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
501
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1650
502
  if @api_client.config.debugging
1651
- @api_client.config.logger.debug "API called: TasksApi#get_task_history_file_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
+ @api_client.config.logger.debug "API called: TasksApi#get_file_download_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1652
504
  end
1653
505
  return data, status_code, headers
1654
506
  end
1655
507
 
1656
- # Retrieve a to do task
1657
- # Retrieves a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
1658
- # @param to_do_task_id [Integer] The to do task identifier
508
+ # Retrieve a task
509
+ # Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
510
+ # @param task_id [Integer] The task identifier
1659
511
  # @param [Hash] opts the optional parameters
1660
- # @return [ToDoTaskMessage]
1661
- def get_to_do_task_by_id(to_do_task_id, opts = {})
1662
- data, _status_code, _headers = get_to_do_task_by_id_with_http_info(to_do_task_id, opts)
512
+ # @return [AllTasksMessage]
513
+ def get_task_by_id(task_id, opts = {})
514
+ data, _status_code, _headers = get_task_by_id_with_http_info(task_id, opts)
1663
515
  data
1664
516
  end
1665
517
 
1666
- # Retrieve a to do task
1667
- # Retrieves a to do task. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
1668
- # @param to_do_task_id [Integer] The to do task identifier
518
+ # Retrieve a task
519
+ # Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
520
+ # @param task_id [Integer] The task identifier
1669
521
  # @param [Hash] opts the optional parameters
1670
- # @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
1671
- def get_to_do_task_by_id_with_http_info(to_do_task_id, opts = {})
522
+ # @return [Array<(AllTasksMessage, Integer, Hash)>] AllTasksMessage data, response status code and response headers
523
+ def get_task_by_id_with_http_info(task_id, opts = {})
1672
524
  if @api_client.config.debugging
1673
- @api_client.config.logger.debug 'Calling API: TasksApi.get_to_do_task_by_id ...'
525
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_task_by_id ...'
1674
526
  end
1675
- # verify the required parameter 'to_do_task_id' is set
1676
- if @api_client.config.client_side_validation && to_do_task_id.nil?
1677
- fail ArgumentError, "Missing the required parameter 'to_do_task_id' when calling TasksApi.get_to_do_task_by_id"
527
+ # verify the required parameter 'task_id' is set
528
+ if @api_client.config.client_side_validation && task_id.nil?
529
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_by_id"
1678
530
  end
1679
531
  # resource path
1680
- local_var_path = '/v1/tasks/todorequests/{toDoTaskId}'.sub('{' + 'toDoTaskId' + '}', CGI.escape(to_do_task_id.to_s))
532
+ local_var_path = '/v1/tasks/{taskId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
1681
533
 
1682
534
  # query parameters
1683
535
  query_params = opts[:query_params] || {}
@@ -1694,13 +546,13 @@ module Buildium
1694
546
  post_body = opts[:debug_body]
1695
547
 
1696
548
  # return_type
1697
- return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
549
+ return_type = opts[:debug_return_type] || 'AllTasksMessage'
1698
550
 
1699
551
  # auth_names
1700
552
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1701
553
 
1702
554
  new_options = opts.merge(
1703
- :operation => :"TasksApi.get_to_do_task_by_id",
555
+ :operation => :"TasksApi.get_task_by_id",
1704
556
  :header_params => header_params,
1705
557
  :query_params => query_params,
1706
558
  :form_params => form_params,
@@ -1711,90 +563,39 @@ module Buildium
1711
563
 
1712
564
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1713
565
  if @api_client.config.debugging
1714
- @api_client.config.logger.debug "API called: TasksApi#get_to_do_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
566
+ @api_client.config.logger.debug "API called: TasksApi#get_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1715
567
  end
1716
568
  return data, status_code, headers
1717
569
  end
1718
570
 
1719
- # Retrieve all to do tasks
1720
- # Retrieves a list of to do tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
571
+ # Retrieve a task category
572
+ # Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
573
+ # @param task_category_id [Integer] The task category identifier.
1721
574
  # @param [Hash] opts the optional parameters
1722
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
1723
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
1724
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
1725
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
1726
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
1727
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
1728
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
1729
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
1730
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
1731
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
1732
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
1733
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
1734
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1735
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1736
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1737
- # @return [Array<ToDoTaskMessage>]
1738
- def get_to_do_tasks(opts = {})
1739
- data, _status_code, _headers = get_to_do_tasks_with_http_info(opts)
575
+ # @return [TaskCategoryMessage]
576
+ def get_task_category_by_id(task_category_id, opts = {})
577
+ data, _status_code, _headers = get_task_category_by_id_with_http_info(task_category_id, opts)
1740
578
  data
1741
579
  end
1742
580
 
1743
- # Retrieve all to do tasks
1744
- # Retrieves a list of to do tasks. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
581
+ # Retrieve a task category
582
+ # Retrieves a specific task category. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
583
+ # @param task_category_id [Integer] The task category identifier.
1745
584
  # @param [Hash] opts the optional parameters
1746
- # @option opts [String] :entitytype Specifies the type of entity that the &#x60;EntityId&#x60; field refers to. This field is required if the &#x60;EntityId&#x60; field is populated.
1747
- # @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the &#x60;EntityType&#x60; field.
1748
- # @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
1749
- # @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
1750
- # @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
1751
- # @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
1752
- # @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
1753
- # @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
1754
- # @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
1755
- # @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
1756
- # @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
1757
- # @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
1758
- # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
1759
- # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
1760
- # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
1761
- # @return [Array<(Array<ToDoTaskMessage>, Integer, Hash)>] Array<ToDoTaskMessage> data, response status code and response headers
1762
- def get_to_do_tasks_with_http_info(opts = {})
585
+ # @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
586
+ def get_task_category_by_id_with_http_info(task_category_id, opts = {})
1763
587
  if @api_client.config.debugging
1764
- @api_client.config.logger.debug 'Calling API: TasksApi.get_to_do_tasks ...'
1765
- end
1766
- allowable_values = ["Rental", "RentalOwner", "Association"]
1767
- if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
1768
- fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
1769
- end
1770
- allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
1771
- if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
1772
- fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
588
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_task_category_by_id ...'
1773
589
  end
1774
- allowable_values = ["Low", "Normal", "High"]
1775
- if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
1776
- fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
590
+ # verify the required parameter 'task_category_id' is set
591
+ if @api_client.config.client_side_validation && task_category_id.nil?
592
+ fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.get_task_category_by_id"
1777
593
  end
1778
594
  # resource path
1779
- local_var_path = '/v1/tasks/todorequests'
595
+ local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_id.to_s))
1780
596
 
1781
597
  # query parameters
1782
598
  query_params = opts[:query_params] || {}
1783
- query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
1784
- query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
1785
- query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
1786
- query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
1787
- query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
1788
- query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
1789
- query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
1790
- query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
1791
- query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
1792
- query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
1793
- query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
1794
- query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
1795
- query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
1796
- query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1797
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1798
599
 
1799
600
  # header parameters
1800
601
  header_params = opts[:header_params] || {}
@@ -1808,13 +609,13 @@ module Buildium
1808
609
  post_body = opts[:debug_body]
1809
610
 
1810
611
  # return_type
1811
- return_type = opts[:debug_return_type] || 'Array<ToDoTaskMessage>'
612
+ return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
1812
613
 
1813
614
  # auth_names
1814
615
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1815
616
 
1816
617
  new_options = opts.merge(
1817
- :operation => :"TasksApi.get_to_do_tasks",
618
+ :operation => :"TasksApi.get_task_category_by_id",
1818
619
  :header_params => header_params,
1819
620
  :query_params => query_params,
1820
621
  :form_params => form_params,
@@ -1825,70 +626,68 @@ module Buildium
1825
626
 
1826
627
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1827
628
  if @api_client.config.debugging
1828
- @api_client.config.logger.debug "API called: TasksApi#get_to_do_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
629
+ @api_client.config.logger.debug "API called: TasksApi#get_task_category_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1829
630
  end
1830
631
  return data, status_code, headers
1831
632
  end
1832
633
 
1833
- # Update a contact request
1834
- # Updates a contact request. <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\">Tasks &gt; Tasks</span> - `View` `Edit`
1835
- # @param contact_request_task_id [Integer] The contact request identifier.
1836
- # @param contact_request_task_put_message [ContactRequestTaskPutMessage]
634
+ # Retrieve all task history
635
+ # Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
636
+ # @param task_id [Integer]
1837
637
  # @param [Hash] opts the optional parameters
1838
- # @return [ContactRequestTaskMessage]
1839
- def update_contact_request_task(contact_request_task_id, contact_request_task_put_message, opts = {})
1840
- data, _status_code, _headers = update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message, opts)
638
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
639
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
640
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
641
+ # @return [Array<TaskHistoryMessage>]
642
+ def get_task_histories(task_id, opts = {})
643
+ data, _status_code, _headers = get_task_histories_with_http_info(task_id, opts)
1841
644
  data
1842
645
  end
1843
646
 
1844
- # Update a contact request
1845
- # Updates a contact request. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
1846
- # @param contact_request_task_id [Integer] The contact request identifier.
1847
- # @param contact_request_task_put_message [ContactRequestTaskPutMessage]
647
+ # Retrieve all task history
648
+ # Retrieves all task history records for a specific task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
649
+ # @param task_id [Integer]
1848
650
  # @param [Hash] opts the optional parameters
1849
- # @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
1850
- def update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message, opts = {})
651
+ # @option opts [String] :orderby &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.
652
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.
653
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.
654
+ # @return [Array<(Array<TaskHistoryMessage>, Integer, Hash)>] Array<TaskHistoryMessage> data, response status code and response headers
655
+ def get_task_histories_with_http_info(task_id, opts = {})
1851
656
  if @api_client.config.debugging
1852
- @api_client.config.logger.debug 'Calling API: TasksApi.update_contact_request_task ...'
1853
- end
1854
- # verify the required parameter 'contact_request_task_id' is set
1855
- if @api_client.config.client_side_validation && contact_request_task_id.nil?
1856
- fail ArgumentError, "Missing the required parameter 'contact_request_task_id' when calling TasksApi.update_contact_request_task"
657
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_task_histories ...'
1857
658
  end
1858
- # verify the required parameter 'contact_request_task_put_message' is set
1859
- if @api_client.config.client_side_validation && contact_request_task_put_message.nil?
1860
- fail ArgumentError, "Missing the required parameter 'contact_request_task_put_message' when calling TasksApi.update_contact_request_task"
659
+ # verify the required parameter 'task_id' is set
660
+ if @api_client.config.client_side_validation && task_id.nil?
661
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_histories"
1861
662
  end
1862
663
  # resource path
1863
- local_var_path = '/v1/tasks/contactrequests/{contactRequestTaskId}'.sub('{' + 'contactRequestTaskId' + '}', CGI.escape(contact_request_task_id.to_s))
664
+ local_var_path = '/v1/tasks/{taskId}/history'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
1864
665
 
1865
666
  # query parameters
1866
667
  query_params = opts[:query_params] || {}
668
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
669
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
670
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1867
671
 
1868
672
  # header parameters
1869
673
  header_params = opts[:header_params] || {}
1870
674
  # HTTP header 'Accept' (if needed)
1871
675
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1872
- # HTTP header 'Content-Type'
1873
- content_type = @api_client.select_header_content_type(['application/json'])
1874
- if !content_type.nil?
1875
- header_params['Content-Type'] = content_type
1876
- end
1877
676
 
1878
677
  # form parameters
1879
678
  form_params = opts[:form_params] || {}
1880
679
 
1881
680
  # http body (model)
1882
- post_body = opts[:debug_body] || @api_client.object_to_http_body(contact_request_task_put_message)
681
+ post_body = opts[:debug_body]
1883
682
 
1884
683
  # return_type
1885
- return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
684
+ return_type = opts[:debug_return_type] || 'Array<TaskHistoryMessage>'
1886
685
 
1887
686
  # auth_names
1888
687
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1889
688
 
1890
689
  new_options = opts.merge(
1891
- :operation => :"TasksApi.update_contact_request_task",
690
+ :operation => :"TasksApi.get_task_histories",
1892
691
  :header_params => header_params,
1893
692
  :query_params => query_params,
1894
693
  :form_params => form_params,
@@ -1897,44 +696,44 @@ module Buildium
1897
696
  :return_type => return_type
1898
697
  )
1899
698
 
1900
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
699
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1901
700
  if @api_client.config.debugging
1902
- @api_client.config.logger.debug "API called: TasksApi#update_contact_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
701
+ @api_client.config.logger.debug "API called: TasksApi#get_task_histories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
702
  end
1904
703
  return data, status_code, headers
1905
704
  end
1906
705
 
1907
- # Update a rental owner request
1908
- # Updates a rental owner request. <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\">Tasks &gt; Tasks</span> - `View` `Edit`
1909
- # @param rental_owner_request_task_id [Integer] The rental owner request identifier.
1910
- # @param rental_owner_request_task_put_message [RentalOwnerRequestTaskPutMessage]
706
+ # Retrieve a task history
707
+ # Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
708
+ # @param task_id [Integer]
709
+ # @param task_history_id [Integer]
1911
710
  # @param [Hash] opts the optional parameters
1912
- # @return [RentalOwnerRequestTaskMessage]
1913
- def update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
1914
- data, _status_code, _headers = update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts)
711
+ # @return [TaskHistoryMessage]
712
+ def get_task_history_by_id(task_id, task_history_id, opts = {})
713
+ data, _status_code, _headers = get_task_history_by_id_with_http_info(task_id, task_history_id, opts)
1915
714
  data
1916
715
  end
1917
716
 
1918
- # Update a rental owner request
1919
- # Updates a rental owner request. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
1920
- # @param rental_owner_request_task_id [Integer] The rental owner request identifier.
1921
- # @param rental_owner_request_task_put_message [RentalOwnerRequestTaskPutMessage]
717
+ # Retrieve a task history
718
+ # Retrieves a specific task history record for a task. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
719
+ # @param task_id [Integer]
720
+ # @param task_history_id [Integer]
1922
721
  # @param [Hash] opts the optional parameters
1923
- # @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
1924
- def update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
722
+ # @return [Array<(TaskHistoryMessage, Integer, Hash)>] TaskHistoryMessage data, response status code and response headers
723
+ def get_task_history_by_id_with_http_info(task_id, task_history_id, opts = {})
1925
724
  if @api_client.config.debugging
1926
- @api_client.config.logger.debug 'Calling API: TasksApi.update_rental_owner_request_task ...'
725
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_by_id ...'
1927
726
  end
1928
- # verify the required parameter 'rental_owner_request_task_id' is set
1929
- if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
1930
- fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling TasksApi.update_rental_owner_request_task"
727
+ # verify the required parameter 'task_id' is set
728
+ if @api_client.config.client_side_validation && task_id.nil?
729
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_by_id"
1931
730
  end
1932
- # verify the required parameter 'rental_owner_request_task_put_message' is set
1933
- if @api_client.config.client_side_validation && rental_owner_request_task_put_message.nil?
1934
- fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_put_message' when calling TasksApi.update_rental_owner_request_task"
731
+ # verify the required parameter 'task_history_id' is set
732
+ if @api_client.config.client_side_validation && task_history_id.nil?
733
+ fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_by_id"
1935
734
  end
1936
735
  # resource path
1937
- local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_id.to_s))
736
+ local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
1938
737
 
1939
738
  # query parameters
1940
739
  query_params = opts[:query_params] || {}
@@ -1943,26 +742,21 @@ module Buildium
1943
742
  header_params = opts[:header_params] || {}
1944
743
  # HTTP header 'Accept' (if needed)
1945
744
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1946
- # HTTP header 'Content-Type'
1947
- content_type = @api_client.select_header_content_type(['application/json'])
1948
- if !content_type.nil?
1949
- header_params['Content-Type'] = content_type
1950
- end
1951
745
 
1952
746
  # form parameters
1953
747
  form_params = opts[:form_params] || {}
1954
748
 
1955
749
  # http body (model)
1956
- post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_owner_request_task_put_message)
750
+ post_body = opts[:debug_body]
1957
751
 
1958
752
  # return_type
1959
- return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
753
+ return_type = opts[:debug_return_type] || 'TaskHistoryMessage'
1960
754
 
1961
755
  # auth_names
1962
756
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
1963
757
 
1964
758
  new_options = opts.merge(
1965
- :operation => :"TasksApi.update_rental_owner_request_task",
759
+ :operation => :"TasksApi.get_task_history_by_id",
1966
760
  :header_params => header_params,
1967
761
  :query_params => query_params,
1968
762
  :form_params => form_params,
@@ -1971,44 +765,50 @@ module Buildium
1971
765
  :return_type => return_type
1972
766
  )
1973
767
 
1974
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
768
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1975
769
  if @api_client.config.debugging
1976
- @api_client.config.logger.debug "API called: TasksApi#update_rental_owner_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
770
+ @api_client.config.logger.debug "API called: TasksApi#get_task_history_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1977
771
  end
1978
772
  return data, status_code, headers
1979
773
  end
1980
774
 
1981
- # Update a resident request
1982
- # Update a resident request. <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\">Tasks &gt; Tasks</span> - `View` `Edit`
1983
- # @param resident_request_task_id [Integer] The resident request identifier.
1984
- # @param resident_request_task_put_message [ResidentRequestTaskPutMessage]
775
+ # Retrieve a task history file
776
+ # Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
777
+ # @param task_id [Integer]
778
+ # @param task_history_id [Integer]
779
+ # @param file_id [Integer]
1985
780
  # @param [Hash] opts the optional parameters
1986
- # @return [ResidentRequestTaskMessage]
1987
- def update_resource(resident_request_task_id, resident_request_task_put_message, opts = {})
1988
- data, _status_code, _headers = update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts)
781
+ # @return [TaskHistoryFileMessage]
782
+ def get_task_history_file_by_id(task_id, task_history_id, file_id, opts = {})
783
+ data, _status_code, _headers = get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts)
1989
784
  data
1990
785
  end
1991
786
 
1992
- # Update a resident request
1993
- # Update a resident request. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
1994
- # @param resident_request_task_id [Integer] The resident request identifier.
1995
- # @param resident_request_task_put_message [ResidentRequestTaskPutMessage]
787
+ # Retrieve a task history file
788
+ # Retrieves the metadata for a specific file associated with a task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60;
789
+ # @param task_id [Integer]
790
+ # @param task_history_id [Integer]
791
+ # @param file_id [Integer]
1996
792
  # @param [Hash] opts the optional parameters
1997
- # @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
1998
- def update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts = {})
793
+ # @return [Array<(TaskHistoryFileMessage, Integer, Hash)>] TaskHistoryFileMessage data, response status code and response headers
794
+ def get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts = {})
1999
795
  if @api_client.config.debugging
2000
- @api_client.config.logger.debug 'Calling API: TasksApi.update_resource ...'
796
+ @api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_file_by_id ...'
797
+ end
798
+ # verify the required parameter 'task_id' is set
799
+ if @api_client.config.client_side_validation && task_id.nil?
800
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_file_by_id"
2001
801
  end
2002
- # verify the required parameter 'resident_request_task_id' is set
2003
- if @api_client.config.client_side_validation && resident_request_task_id.nil?
2004
- fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling TasksApi.update_resource"
802
+ # verify the required parameter 'task_history_id' is set
803
+ if @api_client.config.client_side_validation && task_history_id.nil?
804
+ fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_file_by_id"
2005
805
  end
2006
- # verify the required parameter 'resident_request_task_put_message' is set
2007
- if @api_client.config.client_side_validation && resident_request_task_put_message.nil?
2008
- fail ArgumentError, "Missing the required parameter 'resident_request_task_put_message' when calling TasksApi.update_resource"
806
+ # verify the required parameter 'file_id' is set
807
+ if @api_client.config.client_side_validation && file_id.nil?
808
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_task_history_file_by_id"
2009
809
  end
2010
810
  # resource path
2011
- local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_id.to_s))
811
+ local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
2012
812
 
2013
813
  # query parameters
2014
814
  query_params = opts[:query_params] || {}
@@ -2017,26 +817,21 @@ module Buildium
2017
817
  header_params = opts[:header_params] || {}
2018
818
  # HTTP header 'Accept' (if needed)
2019
819
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2020
- # HTTP header 'Content-Type'
2021
- content_type = @api_client.select_header_content_type(['application/json'])
2022
- if !content_type.nil?
2023
- header_params['Content-Type'] = content_type
2024
- end
2025
820
 
2026
821
  # form parameters
2027
822
  form_params = opts[:form_params] || {}
2028
823
 
2029
824
  # http body (model)
2030
- post_body = opts[:debug_body] || @api_client.object_to_http_body(resident_request_task_put_message)
825
+ post_body = opts[:debug_body]
2031
826
 
2032
827
  # return_type
2033
- return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
828
+ return_type = opts[:debug_return_type] || 'TaskHistoryFileMessage'
2034
829
 
2035
830
  # auth_names
2036
831
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2037
832
 
2038
833
  new_options = opts.merge(
2039
- :operation => :"TasksApi.update_resource",
834
+ :operation => :"TasksApi.get_task_history_file_by_id",
2040
835
  :header_params => header_params,
2041
836
  :query_params => query_params,
2042
837
  :form_params => form_params,
@@ -2045,9 +840,9 @@ module Buildium
2045
840
  :return_type => return_type
2046
841
  )
2047
842
 
2048
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
843
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2049
844
  if @api_client.config.debugging
2050
- @api_client.config.logger.debug "API called: TasksApi#update_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
845
+ @api_client.config.logger.debug "API called: TasksApi#get_task_history_file_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2051
846
  end
2052
847
  return data, status_code, headers
2053
848
  end
@@ -2206,82 +1001,8 @@ module Buildium
2206
1001
  return data, status_code, headers
2207
1002
  end
2208
1003
 
2209
- # Update a to do task
2210
- # Updates a to do task <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\">Tasks &gt; Tasks</span> - `View` `Edit`
2211
- # @param to_do_task_id [Integer] The to do task identifier.
2212
- # @param to_do_task_put_message [ToDoTaskPutMessage]
2213
- # @param [Hash] opts the optional parameters
2214
- # @return [ToDoTaskMessage]
2215
- def update_to_do_task(to_do_task_id, to_do_task_put_message, opts = {})
2216
- data, _status_code, _headers = update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message, opts)
2217
- data
2218
- end
2219
-
2220
- # Update a to do task
2221
- # Updates a to do task &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; Any field not included in the update request will be set to either an empty string or &#x60;null&#x60; in the database depending on the field definition. &lt;br /&gt;The recommended workflow to ensure no data is inadvertently overwritten is to execute a &#x60;GET&#x60; request for the resource you&#39;re about to update and then use this response to fill any of the fields that are not being updated. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
2222
- # @param to_do_task_id [Integer] The to do task identifier.
2223
- # @param to_do_task_put_message [ToDoTaskPutMessage]
2224
- # @param [Hash] opts the optional parameters
2225
- # @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
2226
- def update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message, opts = {})
2227
- if @api_client.config.debugging
2228
- @api_client.config.logger.debug 'Calling API: TasksApi.update_to_do_task ...'
2229
- end
2230
- # verify the required parameter 'to_do_task_id' is set
2231
- if @api_client.config.client_side_validation && to_do_task_id.nil?
2232
- fail ArgumentError, "Missing the required parameter 'to_do_task_id' when calling TasksApi.update_to_do_task"
2233
- end
2234
- # verify the required parameter 'to_do_task_put_message' is set
2235
- if @api_client.config.client_side_validation && to_do_task_put_message.nil?
2236
- fail ArgumentError, "Missing the required parameter 'to_do_task_put_message' when calling TasksApi.update_to_do_task"
2237
- end
2238
- # resource path
2239
- local_var_path = '/v1/tasks/todorequests/{toDoTaskId}'.sub('{' + 'toDoTaskId' + '}', CGI.escape(to_do_task_id.to_s))
2240
-
2241
- # query parameters
2242
- query_params = opts[:query_params] || {}
2243
-
2244
- # header parameters
2245
- header_params = opts[:header_params] || {}
2246
- # HTTP header 'Accept' (if needed)
2247
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2248
- # HTTP header 'Content-Type'
2249
- content_type = @api_client.select_header_content_type(['application/json'])
2250
- if !content_type.nil?
2251
- header_params['Content-Type'] = content_type
2252
- end
2253
-
2254
- # form parameters
2255
- form_params = opts[:form_params] || {}
2256
-
2257
- # http body (model)
2258
- post_body = opts[:debug_body] || @api_client.object_to_http_body(to_do_task_put_message)
2259
-
2260
- # return_type
2261
- return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
2262
-
2263
- # auth_names
2264
- auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
2265
-
2266
- new_options = opts.merge(
2267
- :operation => :"TasksApi.update_to_do_task",
2268
- :header_params => header_params,
2269
- :query_params => query_params,
2270
- :form_params => form_params,
2271
- :body => post_body,
2272
- :auth_names => auth_names,
2273
- :return_type => return_type
2274
- )
2275
-
2276
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2277
- if @api_client.config.debugging
2278
- @api_client.config.logger.debug "API called: TasksApi#update_to_do_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2279
- end
2280
- return data, status_code, headers
2281
- end
2282
-
2283
1004
  # Upload a task history file
2284
- # Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <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/tasks/{taskId}/history/{taskHistoryId}/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 /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
1005
+ # Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <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/tasks/{taskId}/history/{taskHistoryId}/files/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\">Tasks &gt; Tasks</span> - `View` `Edit`
2285
1006
  # @param task_id [Integer]
2286
1007
  # @param task_history_id [Integer]
2287
1008
  # @param task_history_file_upload_post_message [TaskHistoryFileUploadPostMessage]
@@ -2293,7 +1014,7 @@ module Buildium
2293
1014
  end
2294
1015
 
2295
1016
  # Upload a task history file
2296
- # Uploads a file and associates it to the specified task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;Uploading a file requires making two API requests. Each step is outlined below. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 1 - Save file metadata&lt;/strong&gt;&lt;br /&gt; The first step in the file upload process is to submit the file metadata to &#x60;/v1/tasks/{taskId}/history/{taskHistoryId}/uploadrequests&#x60;. 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. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; 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. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 2 - Upload the file binary&lt;/strong&gt;&lt;br /&gt; 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: &lt;br /&gt; 1. Form a POST request using the value of the &#x60;BucketUrl&#x60; property as the URL. &lt;br /&gt;&lt;br /&gt; 2. Set the &#x60;Content-Type&#x60; header to &#x60;multipart/form-data&#x60;. &lt;br /&gt;&lt;br /&gt; 3. Copy the fields from the &#x60;FormData&#x60; property to this request as form-data key/value pairs. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; These values must added to the request form-data in the order they were received in the response. &lt;br /&gt;&lt;br /&gt; 4. Lastly create a form-data key named &#x60;file&#x60; and set the value to the file binary. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; This must be the last field in the form-data list. &lt;br /&gt;&lt;br /&gt;This image shows what the POST request should look like if you&#39;re using Postman: &lt;img src&#x3D;\&quot;file-upload-example.png\&quot; /&gt;&lt;br /&gt;&lt;br /&gt; 5. Send the POST request! A successful request will return with a &#x60;204 - NO CONTENT&#x60; HTTP response code. For any failure responses, please refer to &lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\&quot;&gt;AWS documentation&lt;/a&gt; on REST error responses. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
1017
+ # Uploads a file and associates it to the specified task history record. &lt;br /&gt;&lt;br /&gt;This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do&#39;s. &lt;br /&gt;&lt;br /&gt;Uploading a file requires making two API requests. Each step is outlined below. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 1 - Save file metadata&lt;/strong&gt;&lt;br /&gt; The first step in the file upload process is to submit the file metadata to &#x60;/v1/tasks/{taskId}/history/{taskHistoryId}/files/uploadrequests&#x60;. 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. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; 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. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;Step 2 - Upload the file binary&lt;/strong&gt;&lt;br /&gt; 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: &lt;br /&gt; 1. Form a POST request using the value of the &#x60;BucketUrl&#x60; property as the URL. &lt;br /&gt;&lt;br /&gt; 2. Set the &#x60;Content-Type&#x60; header to &#x60;multipart/form-data&#x60;. &lt;br /&gt;&lt;br /&gt; 3. Copy the fields from the &#x60;FormData&#x60; property to this request as form-data key/value pairs. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; These values must added to the request form-data in the order they were received in the response. &lt;br /&gt;&lt;br /&gt; 4. Lastly create a form-data key named &#x60;file&#x60; and set the value to the file binary. &lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; This must be the last field in the form-data list. &lt;br /&gt;&lt;br /&gt;This image shows what the POST request should look like if you&#39;re using Postman: &lt;img src&#x3D;\&quot;file-upload-example.png\&quot; /&gt;&lt;br /&gt;&lt;br /&gt; 5. Send the POST request! A successful request will return with a &#x60;204 - NO CONTENT&#x60; HTTP response code. For any failure responses, please refer to &lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\&quot;&gt;AWS documentation&lt;/a&gt; on REST error responses. &lt;br /&gt;&lt;br /&gt;&lt;strong&gt;NOTE:&lt;/strong&gt; The file identifier is not generated in this response. To retrieve the file identifier, call &#x60;/v1/files&#x60; and pass the &#x60;PhysicalFileName&#x60; value received from the response of this endpoint into the &#x60;physicalfilenames&#x60; query parameter. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;Tasks &amp;gt; Tasks&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;
2297
1018
  # @param task_id [Integer]
2298
1019
  # @param task_history_id [Integer]
2299
1020
  # @param task_history_file_upload_post_message [TaskHistoryFileUploadPostMessage]