buildium-ruby 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1229) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ci.yml +27 -0
  3. data/.github/workflows/publish.yml +48 -0
  4. data/.gitignore +39 -0
  5. data/.openapi-generator/FILES +1215 -0
  6. data/.openapi-generator/VERSION +1 -0
  7. data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
  8. data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
  9. data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
  10. data/.openapi-generator-ignore +26 -0
  11. data/.rspec +2 -0
  12. data/.rubocop.yml +124 -0
  13. data/CUSTOMIZATIONS.md +11 -0
  14. data/DOCS.md +811 -0
  15. data/Gemfile +9 -0
  16. data/Gemfile.lock +75 -0
  17. data/README.md +118 -0
  18. data/Rakefile +10 -0
  19. data/bin/CUSTOMIZATIONS.md +11 -0
  20. data/bin/README.md +118 -0
  21. data/bin/config.yml +9 -0
  22. data/bin/rebuild.sh +49 -0
  23. data/bin/swagger.json +52218 -0
  24. data/buildium-ruby.gemspec +39 -0
  25. data/docs/AccountInfoMessage.md +26 -0
  26. data/docs/AccountingApi.md +2041 -0
  27. data/docs/AccountingEntityMessage.md +22 -0
  28. data/docs/AccountingEntitySaveMessage.md +20 -0
  29. data/docs/AccountingLockPeriodMessage.md +22 -0
  30. data/docs/AccountingSettingsMessage.md +28 -0
  31. data/docs/AddressMessage.md +30 -0
  32. data/docs/AdministrationApi.md +485 -0
  33. data/docs/AllTasksMessage.md +46 -0
  34. data/docs/AnnouncementMessage.md +30 -0
  35. data/docs/AnnouncementPostMessage.md +28 -0
  36. data/docs/AnnouncementSearchMessage.md +26 -0
  37. data/docs/AnnouncementSenderMessage.md +22 -0
  38. data/docs/ApiError.md +20 -0
  39. data/docs/ApiErrorResponse.md +22 -0
  40. data/docs/ApplianceMessage.md +26 -0
  41. data/docs/ApplicantApplicationMessage.md +24 -0
  42. data/docs/ApplicantGroupMessage.md +26 -0
  43. data/docs/ApplicantGroupPostMessage.md +20 -0
  44. data/docs/ApplicantGroupPutMessage.md +22 -0
  45. data/docs/ApplicantGroupSearchMessage.md +26 -0
  46. data/docs/ApplicantMessage.md +36 -0
  47. data/docs/ApplicantPostMessage.md +28 -0
  48. data/docs/ApplicantPutMessage.md +26 -0
  49. data/docs/ApplicantSearchMessage.md +32 -0
  50. data/docs/ApplicantsApi.md +1489 -0
  51. data/docs/ApplicationMessage.md +26 -0
  52. data/docs/ApplicationPutMessage.md +18 -0
  53. data/docs/ApplicationResponseFieldMessage.md +24 -0
  54. data/docs/ApplicationResponseMessage.md +22 -0
  55. data/docs/ApplicationSectionResponseMessage.md +18 -0
  56. data/docs/AssociationApplianceMessage.md +32 -0
  57. data/docs/AssociationAppliancePostMessage.md +32 -0
  58. data/docs/AssociationAppliancePutMessage.md +28 -0
  59. data/docs/AssociationApplianceSearchMessage.md +20 -0
  60. data/docs/AssociationApplianceServiceHistoryMessage.md +24 -0
  61. data/docs/AssociationApplianceServiceHistoryPostMessage.md +22 -0
  62. data/docs/AssociationAppliancesApi.md +646 -0
  63. data/docs/AssociationBoardMemberMessage.md +36 -0
  64. data/docs/AssociationBoardMemberPostMessage.md +24 -0
  65. data/docs/AssociationBoardMemberPutMessage.md +22 -0
  66. data/docs/AssociationBoardMemberSearchMessage.md +24 -0
  67. data/docs/AssociationMessage.md +40 -0
  68. data/docs/AssociationOwnerBoardTermMessage.md +28 -0
  69. data/docs/AssociationOwnerBoardTermPostMessage.md +22 -0
  70. data/docs/AssociationOwnerMessage.md +52 -0
  71. data/docs/AssociationOwnerPostMessage.md +44 -0
  72. data/docs/AssociationOwnerPutMessage.md +38 -0
  73. data/docs/AssociationOwnerToExistingOwnershipAccountPostMessage.md +48 -0
  74. data/docs/AssociationOwnerUnitOccupancyPutMessage.md +18 -0
  75. data/docs/AssociationOwnerUnitOccupancyStatusMessage.md +20 -0
  76. data/docs/AssociationOwnersApi.md +916 -0
  77. data/docs/AssociationOwnershipAccountMessage.md +34 -0
  78. data/docs/AssociationOwnershipAccountPostMessage.md +32 -0
  79. data/docs/AssociationOwnershipAccountPutMessage.md +18 -0
  80. data/docs/AssociationOwnershipAccountSearchMessage.md +28 -0
  81. data/docs/AssociationOwnershipAccountsApi.md +2042 -0
  82. data/docs/AssociationPostMessage.md +32 -0
  83. data/docs/AssociationPreferredVendorMessage.md +34 -0
  84. data/docs/AssociationPreferredVendorPutMessage.md +18 -0
  85. data/docs/AssociationPutMessage.md +34 -0
  86. data/docs/AssociationSearchMessage.md +24 -0
  87. data/docs/AssociationTenantMessage.md +44 -0
  88. data/docs/AssociationTenantPostMessage.md +42 -0
  89. data/docs/AssociationTenantPutMessage.md +38 -0
  90. data/docs/AssociationTenantsApi.md +671 -0
  91. data/docs/AssociationUnitMessage.md +32 -0
  92. data/docs/AssociationUnitPutMessage.md +26 -0
  93. data/docs/AssociationUnitSearchMessage.md +22 -0
  94. data/docs/AssociationUnitsApi.md +659 -0
  95. data/docs/AssociationUnitsPostMessage.md +28 -0
  96. data/docs/AssociationUserSearchMessage.md +34 -0
  97. data/docs/AssociationsApi.md +1235 -0
  98. data/docs/BankAccountCheckAccountingEntitySaveMessage.md +20 -0
  99. data/docs/BankAccountCheckLineMessage.md +28 -0
  100. data/docs/BankAccountCheckLineSaveMessage.md +26 -0
  101. data/docs/BankAccountCheckMessage.md +30 -0
  102. data/docs/BankAccountCheckPayeeMessage.md +22 -0
  103. data/docs/BankAccountCheckPayeeSaveMessage.md +20 -0
  104. data/docs/BankAccountCheckPostMessage.md +26 -0
  105. data/docs/BankAccountCheckPutMessage.md +26 -0
  106. data/docs/BankAccountCheckSearchMessage.md +20 -0
  107. data/docs/BankAccountDepositLineMessage.md +28 -0
  108. data/docs/BankAccountDepositLineSaveMessage.md +26 -0
  109. data/docs/BankAccountDepositMessage.md +28 -0
  110. data/docs/BankAccountDepositPostMessage.md +24 -0
  111. data/docs/BankAccountDepositPutMessage.md +22 -0
  112. data/docs/BankAccountDepositSearchMessage.md +20 -0
  113. data/docs/BankAccountMessage.md +40 -0
  114. data/docs/BankAccountPostMessage.md +30 -0
  115. data/docs/BankAccountPutMessage.md +30 -0
  116. data/docs/BankAccountQuickDepositMessage.md +28 -0
  117. data/docs/BankAccountQuickDepositSaveMessage.md +26 -0
  118. data/docs/BankAccountQuickDepositSearchMessage.md +20 -0
  119. data/docs/BankAccountSearchMessage.md +20 -0
  120. data/docs/BankAccountTransactionMessage.md +36 -0
  121. data/docs/BankAccountTransactionSearchMessage.md +24 -0
  122. data/docs/BankAccountTransferAccountingEntitySaveMessage.md +20 -0
  123. data/docs/BankAccountTransferMessage.md +28 -0
  124. data/docs/BankAccountTransferSaveMessage.md +26 -0
  125. data/docs/BankAccountTransferSearchMessage.md +20 -0
  126. data/docs/BankAccountWithdrawalMessage.md +28 -0
  127. data/docs/BankAccountWithdrawalSaveMessage.md +26 -0
  128. data/docs/BankAccountWithdrawalSearchMessage.md +20 -0
  129. data/docs/BankAccountsApi.md +2224 -0
  130. data/docs/BillFileMessage.md +28 -0
  131. data/docs/BillLineMessage.md +28 -0
  132. data/docs/BillLinePostMessage.md +26 -0
  133. data/docs/BillLinePutMessage.md +28 -0
  134. data/docs/BillMarkupMessage.md +20 -0
  135. data/docs/BillMarkupSaveMessage.md +20 -0
  136. data/docs/BillMessage.md +36 -0
  137. data/docs/BillPaymentAccountingEntityMessage.md +20 -0
  138. data/docs/BillPaymentLineMessage.md +22 -0
  139. data/docs/BillPaymentLinePostMessage.md +20 -0
  140. data/docs/BillPaymentMessage.md +28 -0
  141. data/docs/BillPaymentPostMessage.md +26 -0
  142. data/docs/BillPostMessage.md +30 -0
  143. data/docs/BillPutMessage.md +28 -0
  144. data/docs/BillSearchMessage.md +32 -0
  145. data/docs/BudgetDetailsMessage.md +24 -0
  146. data/docs/BudgetDetailsSaveMessage.md +20 -0
  147. data/docs/BudgetMessage.md +28 -0
  148. data/docs/BudgetMonthlyAmountsMessage.md +40 -0
  149. data/docs/BudgetMonthlyAmountsSaveMessage.md +40 -0
  150. data/docs/BudgetPostMessage.md +26 -0
  151. data/docs/BudgetPutMessage.md +20 -0
  152. data/docs/BudgetSearchMessage.md +22 -0
  153. data/docs/ChargeRecurringTransactionPostMessage.md +32 -0
  154. data/docs/ChargeRecurringTransactionPutMessage.md +34 -0
  155. data/docs/CheckPrintingInfoMessage.md +46 -0
  156. data/docs/CheckPrintingInfoPostMessage.md +46 -0
  157. data/docs/CheckPrintingInfoPutMessage.md +46 -0
  158. data/docs/ClientLeadCreditRequestMessage.md +24 -0
  159. data/docs/ClientLeadMessage.md +38 -0
  160. data/docs/ClientLeadSearchMessage.md +26 -0
  161. data/docs/ClientLeadsApi.md +177 -0
  162. data/docs/CommunicationsApi.md +1238 -0
  163. data/docs/ContactDetailMessage.md +24 -0
  164. data/docs/ContactDetailPhoneMessage.md +22 -0
  165. data/docs/ContactDetailSaveMessage.md +24 -0
  166. data/docs/ContactDetailSavePhoneMessage.md +22 -0
  167. data/docs/ContactInfoMessage.md +24 -0
  168. data/docs/ContactRequestTaskMessage.md +42 -0
  169. data/docs/ContactRequestTaskPostMessage.md +38 -0
  170. data/docs/ContactRequestTaskPutMessage.md +38 -0
  171. data/docs/ContactRequestTaskSearchMessage.md +40 -0
  172. data/docs/CosignerMessage.md +36 -0
  173. data/docs/CreatedByUserMessage.md +24 -0
  174. data/docs/CreditRecurringTransactionPostMessage.md +36 -0
  175. data/docs/DepositDetailMessage.md +20 -0
  176. data/docs/ElectronicPaymentsMessage.md +32 -0
  177. data/docs/EmailMessage.md +24 -0
  178. data/docs/EmailPostMessage.md +30 -0
  179. data/docs/EmailRecipientMessage.md +26 -0
  180. data/docs/EmailSearchMessage.md +26 -0
  181. data/docs/EmailSenderMessage.md +24 -0
  182. data/docs/EmergencyContactMessage.md +24 -0
  183. data/docs/FileCategoryMessage.md +22 -0
  184. data/docs/FileCategoryPostMessage.md +18 -0
  185. data/docs/FileCategoryPutMessage.md +18 -0
  186. data/docs/FileDownloadMessage.md +18 -0
  187. data/docs/FileEntityMessage.md +22 -0
  188. data/docs/FileMessage.md +34 -0
  189. data/docs/FileNamePostMessage.md +18 -0
  190. data/docs/FilePutMessage.md +22 -0
  191. data/docs/FileSearchMessage.md +30 -0
  192. data/docs/FileUploadPostMessage.md +28 -0
  193. data/docs/FileUploadTicketMessage.md +22 -0
  194. data/docs/FilesApi.md +730 -0
  195. data/docs/GLAccountBalanceItemMessage.md +20 -0
  196. data/docs/GLAccountBalanceMessage.md +22 -0
  197. data/docs/GLAccountBalanceSearchMessage.md +26 -0
  198. data/docs/GLAccountMessage.md +46 -0
  199. data/docs/GLAccountPostMessage.md +32 -0
  200. data/docs/GLAccountPutMessage.md +32 -0
  201. data/docs/GLAccountsSearchMessage.md +18 -0
  202. data/docs/GLTransactionMessageV1.md +26 -0
  203. data/docs/GeneralJournalEntryLineSaveMessage.md +24 -0
  204. data/docs/GeneralJournalEntryPostMessage.md +24 -0
  205. data/docs/GeneralJournalEntryPutMessage.md +24 -0
  206. data/docs/GeneralLedgerJournalLineMessage.md +28 -0
  207. data/docs/GeneralLedgerJournalMessage.md +20 -0
  208. data/docs/GeneralLedgerTransactionMessage.md +38 -0
  209. data/docs/GeneralLedgerTransactionSearchMessage.md +26 -0
  210. data/docs/InternalTransactionStatusMessage.md +22 -0
  211. data/docs/JournalLineMessage.md +28 -0
  212. data/docs/JournalMessage.md +20 -0
  213. data/docs/LastUpdatedByUserMessage.md +26 -0
  214. data/docs/LeaseAccountDetailMessage.md +20 -0
  215. data/docs/LeaseChargeLineSaveMessage.md +22 -0
  216. data/docs/LeaseChargePostMessage.md +22 -0
  217. data/docs/LeaseChargePutMessage.md +22 -0
  218. data/docs/LeaseChargeRecurringTransactionMessage.md +40 -0
  219. data/docs/LeaseCosignerPostMessage.md +32 -0
  220. data/docs/LeaseLedgerCreditLinePostMessage.md +20 -0
  221. data/docs/LeaseLedgerCreditPostMessage.md +26 -0
  222. data/docs/LeaseLedgerDepositWithholdingLinePostMessage.md +20 -0
  223. data/docs/LeaseLedgerDepositWithholdingPostMessage.md +24 -0
  224. data/docs/LeaseLedgerPaymentLineSaveMessage.md +20 -0
  225. data/docs/LeaseLedgerPaymentPostMessage.md +30 -0
  226. data/docs/LeaseLedgerRefundLineMessage.md +20 -0
  227. data/docs/LeaseLedgerRefundLinePostMessage.md +20 -0
  228. data/docs/LeaseLedgerRefundMessage.md +34 -0
  229. data/docs/LeaseLedgerRefundPostMessage.md +30 -0
  230. data/docs/LeaseLedgerReversePaymentNSFChargePostMessage.md +20 -0
  231. data/docs/LeaseLedgerReversePaymentOtherBankChargePostMessage.md +20 -0
  232. data/docs/LeaseLedgerReversePaymentPostMessage.md +24 -0
  233. data/docs/LeaseMessage.md +58 -0
  234. data/docs/LeaseMoveOutDataMessage.md +22 -0
  235. data/docs/LeaseMoveOutDataPostMessage.md +22 -0
  236. data/docs/LeaseOutstandingBalanceMessage.md +40 -0
  237. data/docs/LeaseOutstandingBalanceSearchMessage.md +30 -0
  238. data/docs/LeasePostMessage.md +38 -0
  239. data/docs/LeasePutMessage.md +28 -0
  240. data/docs/LeaseRecurringCreditMessage.md +44 -0
  241. data/docs/LeaseRecurringPaymentMessage.md +42 -0
  242. data/docs/LeaseRenewalMessage.md +32 -0
  243. data/docs/LeaseRenewalPostMessage.md +38 -0
  244. data/docs/LeaseRentChargeMessage.md +30 -0
  245. data/docs/LeaseRentChargePostMessage.md +24 -0
  246. data/docs/LeaseRentMessage.md +34 -0
  247. data/docs/LeaseRentPostMessage.md +20 -0
  248. data/docs/LeaseSearchMessage.md +40 -0
  249. data/docs/LeaseSecurityDepositPostMessage.md +20 -0
  250. data/docs/LeaseTenantMessage.md +20 -0
  251. data/docs/LeaseTransactionMessage.md +34 -0
  252. data/docs/LeaseTransactionSearchMessage.md +22 -0
  253. data/docs/LeasesApi.md +2865 -0
  254. data/docs/ListingContactMessage.md +26 -0
  255. data/docs/ListingContactSaveMessage.md +24 -0
  256. data/docs/ListingFileMessage.md +22 -0
  257. data/docs/ListingMessage.md +36 -0
  258. data/docs/ListingPropertyMessage.md +34 -0
  259. data/docs/ListingPutMessage.md +28 -0
  260. data/docs/ListingSearchMessage.md +20 -0
  261. data/docs/ListingUnitMessage.md +36 -0
  262. data/docs/ListingsApi.md +642 -0
  263. data/docs/LockPeriodSettingsGlobalMessage.md +18 -0
  264. data/docs/LockPeriodSettingsOverridesMessage.md +20 -0
  265. data/docs/LoggedByStaffUserMessage.md +24 -0
  266. data/docs/LookupMessage.md +20 -0
  267. data/docs/MailingTemplateMessage.md +24 -0
  268. data/docs/NoteMessage.md +22 -0
  269. data/docs/NotePostMessage.md +18 -0
  270. data/docs/NotePutMessage.md +18 -0
  271. data/docs/NoteSearchMessage.md +22 -0
  272. data/docs/OutstandingBalancesLineMessage.md +20 -0
  273. data/docs/OwnershipAccountChargeRecurringTransactionMessage.md +40 -0
  274. data/docs/OwnershipAccountCreditLinePostMessage.md +20 -0
  275. data/docs/OwnershipAccountCreditPostMessage.md +26 -0
  276. data/docs/OwnershipAccountDepositWithholdingLinePostMessage.md +20 -0
  277. data/docs/OwnershipAccountDepositWithholdingPostMessage.md +24 -0
  278. data/docs/OwnershipAccountLedgerChargeLinesPutMessage.md +22 -0
  279. data/docs/OwnershipAccountLedgerChargeLinesSaveMessage.md +20 -0
  280. data/docs/OwnershipAccountLedgerChargePostMessage.md +22 -0
  281. data/docs/OwnershipAccountLedgerChargePutMessage.md +22 -0
  282. data/docs/OwnershipAccountLedgerPaymentLineSaveMessage.md +20 -0
  283. data/docs/OwnershipAccountLedgerPaymentPostMessage.md +30 -0
  284. data/docs/OwnershipAccountOutstandingBalanceMessage.md +36 -0
  285. data/docs/OwnershipAccountOutstandingBalanceSearchMessage.md +26 -0
  286. data/docs/OwnershipAccountRecurringCreditMessage.md +44 -0
  287. data/docs/OwnershipAccountRecurringPaymentMessage.md +42 -0
  288. data/docs/OwnershipAccountRefundLineMessage.md +20 -0
  289. data/docs/OwnershipAccountRefundLinesPostMessage.md +20 -0
  290. data/docs/OwnershipAccountRefundMessage.md +34 -0
  291. data/docs/OwnershipAccountRefundPostMessage.md +30 -0
  292. data/docs/OwnershipAccountTransactionMessage.md +34 -0
  293. data/docs/PaidByMessage.md +20 -0
  294. data/docs/ParticipantMessage.md +22 -0
  295. data/docs/ParticipantResourceMessage.md +20 -0
  296. data/docs/PayeeMessage.md +24 -0
  297. data/docs/PaymentDetailMessage.md +24 -0
  298. data/docs/PaymentRecurringTransactionPostMessage.md +34 -0
  299. data/docs/PaymentTransactionsMessage.md +22 -0
  300. data/docs/PhoneLogMessage.md +28 -0
  301. data/docs/PhoneLogParticipantPostMessage.md +22 -0
  302. data/docs/PhoneLogParticipantUnitAgreementPostMessage.md +20 -0
  303. data/docs/PhoneLogPostMessage.md +24 -0
  304. data/docs/PhoneLogPutMessage.md +22 -0
  305. data/docs/PhoneLogSearchMessage.md +32 -0
  306. data/docs/PhoneNumberMessage.md +20 -0
  307. data/docs/PhoneNumbersMessage.md +24 -0
  308. data/docs/PropertyGroupMessage.md +26 -0
  309. data/docs/PropertyGroupPostMessage.md +22 -0
  310. data/docs/PropertyGroupPutMessage.md +22 -0
  311. data/docs/PropertyGroupSearchMessage.md +20 -0
  312. data/docs/PropertyGroupsApi.md +327 -0
  313. data/docs/PropertyManagerMessage.md +32 -0
  314. data/docs/PropertyMessage.md +22 -0
  315. data/docs/RecurringTransactionLineMessage.md +20 -0
  316. data/docs/RecurringTransactionLinePostMessage.md +20 -0
  317. data/docs/RecurringTransactionMessage.md +40 -0
  318. data/docs/RentalApplianceMessage.md +32 -0
  319. data/docs/RentalAppliancePostMessage.md +32 -0
  320. data/docs/RentalAppliancePutMessage.md +28 -0
  321. data/docs/RentalApplianceSearchMessage.md +20 -0
  322. data/docs/RentalApplianceServiceHistoryMessage.md +24 -0
  323. data/docs/RentalApplianceServiceHistoryPostMessage.md +22 -0
  324. data/docs/RentalAppliancesApi.md +646 -0
  325. data/docs/RentalFeaturesMessage.md +20 -0
  326. data/docs/RentalFeaturesPutMessage.md +20 -0
  327. data/docs/RentalMessage.md +40 -0
  328. data/docs/RentalOwnerMessage.md +46 -0
  329. data/docs/RentalOwnerPostMessage.md +44 -0
  330. data/docs/RentalOwnerPutMessage.md +42 -0
  331. data/docs/RentalOwnerRequestTaskMessage.md +42 -0
  332. data/docs/RentalOwnerRequestTaskPostMessage.md +38 -0
  333. data/docs/RentalOwnerRequestTaskPutMessage.md +36 -0
  334. data/docs/RentalOwnerRequestTaskSearchMessage.md +40 -0
  335. data/docs/RentalOwnerTaxInformationMessage.md +28 -0
  336. data/docs/RentalOwnersApi.md +667 -0
  337. data/docs/RentalOwnersSearchMessage.md +30 -0
  338. data/docs/RentalPreferredVendorMessage.md +34 -0
  339. data/docs/RentalPreferredVendorPutMessage.md +18 -0
  340. data/docs/RentalPropertiesApi.md +989 -0
  341. data/docs/RentalPropertyPostMessage.md +36 -0
  342. data/docs/RentalPropertyPutMessage.md +32 -0
  343. data/docs/RentalPropertyUnitPostMessage.md +30 -0
  344. data/docs/RentalSearchMessage.md +32 -0
  345. data/docs/RentalTenantPostMessage.md +42 -0
  346. data/docs/RentalTenantPutMessage.md +40 -0
  347. data/docs/RentalTenantRenewalPostMessage.md +40 -0
  348. data/docs/RentalTenantsApi.md +673 -0
  349. data/docs/RentalUnitFeaturesMessage.md +18 -0
  350. data/docs/RentalUnitFeaturesPutMessage.md +18 -0
  351. data/docs/RentalUnitMessage.md +40 -0
  352. data/docs/RentalUnitPutMessage.md +30 -0
  353. data/docs/RentalUnitSearchMessage.md +22 -0
  354. data/docs/RentalUnitsApi.md +815 -0
  355. data/docs/RentalUnitsPostMessage.md +32 -0
  356. data/docs/RequestedByUserEntityMessage.md +28 -0
  357. data/docs/ResidentCenterApi.md +100 -0
  358. data/docs/ResidentCenterUserMessage.md +24 -0
  359. data/docs/ResidentCenterUserReferenceMessage.md +26 -0
  360. data/docs/ResidentCenterUserSearchMessage.md +26 -0
  361. data/docs/ResidentRequestTaskMessage.md +52 -0
  362. data/docs/ResidentRequestTaskPostMessage.md +42 -0
  363. data/docs/ResidentRequestTaskPutMessage.md +32 -0
  364. data/docs/ResidentRequestTaskSearchMessage.md +42 -0
  365. data/docs/SaveAddressMessage.md +30 -0
  366. data/docs/SaveEmergencyContactMessage.md +24 -0
  367. data/docs/TaskCategoryMessage.md +24 -0
  368. data/docs/TaskCategoryPutMessage.md +18 -0
  369. data/docs/TaskCategoryResponseMessage.md +24 -0
  370. data/docs/TaskCategorySaveMessage.md +18 -0
  371. data/docs/TaskHistoryFileMessage.md +28 -0
  372. data/docs/TaskHistoryFileUploadPostMessage.md +18 -0
  373. data/docs/TaskHistoryMessage.md +40 -0
  374. data/docs/TaskHistoryPutMessage.md +18 -0
  375. data/docs/TaskHistoryUserMessage.md +24 -0
  376. data/docs/TaskSearchMessage.md +44 -0
  377. data/docs/TaskSubCategoryMessage.md +20 -0
  378. data/docs/TasksApi.md +2528 -0
  379. data/docs/TaxInformationPostMessage.md +26 -0
  380. data/docs/TaxInformationSaveMessage.md +28 -0
  381. data/docs/TenantMessage.md +48 -0
  382. data/docs/TenantSearchMessage.md +36 -0
  383. data/docs/ToDoTaskMessage.md +40 -0
  384. data/docs/ToDoTaskPostMessage.md +36 -0
  385. data/docs/ToDoTaskPutMessage.md +36 -0
  386. data/docs/ToDoTaskSearchMessage.md +40 -0
  387. data/docs/UndepositedFundsMessage.md +18 -0
  388. data/docs/UnitAgreementMessage.md +22 -0
  389. data/docs/UserMessage.md +40 -0
  390. data/docs/UserRoleMessage.md +24 -0
  391. data/docs/UserSearchMessage.md +26 -0
  392. data/docs/VehicleMessage.md +24 -0
  393. data/docs/VendorCategoryMessage.md +22 -0
  394. data/docs/VendorCategorySaveMessage.md +18 -0
  395. data/docs/VendorCreditLineItemMessage.md +26 -0
  396. data/docs/VendorCreditLineItemPostMessage.md +24 -0
  397. data/docs/VendorCreditMessage.md +26 -0
  398. data/docs/VendorCreditPostMessage.md +24 -0
  399. data/docs/VendorInsuranceMessage.md +22 -0
  400. data/docs/VendorInsuranceSaveMessage.md +22 -0
  401. data/docs/VendorMessage.md +50 -0
  402. data/docs/VendorPostMessage.md +46 -0
  403. data/docs/VendorPutMessage.md +46 -0
  404. data/docs/VendorRefundLineMessage.md +26 -0
  405. data/docs/VendorRefundLinePostMessage.md +24 -0
  406. data/docs/VendorRefundMessage.md +30 -0
  407. data/docs/VendorRefundPostMessage.md +28 -0
  408. data/docs/VendorSearchMessage.md +32 -0
  409. data/docs/VendorTaxInformationMessage.md +28 -0
  410. data/docs/VendorTransactionMessage.md +28 -0
  411. data/docs/VendorTransactionSearchMessage.md +26 -0
  412. data/docs/VendorsApi.md +1396 -0
  413. data/docs/WorkOrderEntryContactMessage.md +20 -0
  414. data/docs/WorkOrderEntryContactResourceMessage.md +20 -0
  415. data/docs/WorkOrderLineItemMessage.md +24 -0
  416. data/docs/WorkOrderLineItemSaveMessage.md +24 -0
  417. data/docs/WorkOrderMessage.md +42 -0
  418. data/docs/WorkOrderPostMessage.md +38 -0
  419. data/docs/WorkOrderPutMessage.md +34 -0
  420. data/docs/WorkOrderSearchMessage.md +54 -0
  421. data/docs/WorkOrderTaskMessage.md +32 -0
  422. data/docs/WorkOrderTaskPostMessage.md +30 -0
  423. data/docs/WorkOrdersApi.md +361 -0
  424. data/lib/buildium-ruby/api/accounting_api.rb +1855 -0
  425. data/lib/buildium-ruby/api/administration_api.rb +417 -0
  426. data/lib/buildium-ruby/api/applicants_api.rb +1368 -0
  427. data/lib/buildium-ruby/api/association_appliances_api.rb +577 -0
  428. data/lib/buildium-ruby/api/association_owners_api.rb +849 -0
  429. data/lib/buildium-ruby/api/association_ownership_accounts_api.rb +1890 -0
  430. data/lib/buildium-ruby/api/association_tenants_api.rb +628 -0
  431. data/lib/buildium-ruby/api/association_units_api.rb +606 -0
  432. data/lib/buildium-ruby/api/associations_api.rb +1143 -0
  433. data/lib/buildium-ruby/api/bank_accounts_api.rb +2085 -0
  434. data/lib/buildium-ruby/api/client_leads_api.rb +174 -0
  435. data/lib/buildium-ruby/api/communications_api.rb +1097 -0
  436. data/lib/buildium-ruby/api/files_api.rb +652 -0
  437. data/lib/buildium-ruby/api/leases_api.rb +2636 -0
  438. data/lib/buildium-ruby/api/listings_api.rb +569 -0
  439. data/lib/buildium-ruby/api/property_groups_api.rb +299 -0
  440. data/lib/buildium-ruby/api/rental_appliances_api.rb +577 -0
  441. data/lib/buildium-ruby/api/rental_owners_api.rb +622 -0
  442. data/lib/buildium-ruby/api/rental_properties_api.rb +916 -0
  443. data/lib/buildium-ruby/api/rental_tenants_api.rb +635 -0
  444. data/lib/buildium-ruby/api/rental_units_api.rb +743 -0
  445. data/lib/buildium-ruby/api/resident_center_api.rb +111 -0
  446. data/lib/buildium-ruby/api/tasks_api.rb +2363 -0
  447. data/lib/buildium-ruby/api/vendors_api.rb +1285 -0
  448. data/lib/buildium-ruby/api/work_orders_api.rb +366 -0
  449. data/lib/buildium-ruby/api_client.rb +426 -0
  450. data/lib/buildium-ruby/api_error.rb +57 -0
  451. data/lib/buildium-ruby/configuration.rb +319 -0
  452. data/lib/buildium-ruby/models/account_info_message.rb +257 -0
  453. data/lib/buildium-ruby/models/accounting_entity_message.rb +273 -0
  454. data/lib/buildium-ruby/models/accounting_entity_save_message.rb +273 -0
  455. data/lib/buildium-ruby/models/accounting_lock_period_message.rb +242 -0
  456. data/lib/buildium-ruby/models/accounting_settings_message.rb +314 -0
  457. data/lib/buildium-ruby/models/address_message.rb +313 -0
  458. data/lib/buildium-ruby/models/all_tasks_message.rb +413 -0
  459. data/lib/buildium-ruby/models/announcement_message.rb +301 -0
  460. data/lib/buildium-ruby/models/announcement_post_message.rb +295 -0
  461. data/lib/buildium-ruby/models/announcement_search_message.rb +292 -0
  462. data/lib/buildium-ruby/models/announcement_sender_message.rb +239 -0
  463. data/lib/buildium-ruby/models/api_error_response.rb +237 -0
  464. data/lib/buildium-ruby/models/appliance_message.rb +259 -0
  465. data/lib/buildium-ruby/models/applicant_application_message.rb +282 -0
  466. data/lib/buildium-ruby/models/applicant_group_message.rb +294 -0
  467. data/lib/buildium-ruby/models/applicant_group_post_message.rb +235 -0
  468. data/lib/buildium-ruby/models/applicant_group_put_message.rb +284 -0
  469. data/lib/buildium-ruby/models/applicant_group_search_message.rb +296 -0
  470. data/lib/buildium-ruby/models/applicant_message.rb +312 -0
  471. data/lib/buildium-ruby/models/applicant_post_message.rb +283 -0
  472. data/lib/buildium-ruby/models/applicant_put_message.rb +267 -0
  473. data/lib/buildium-ruby/models/applicant_search_message.rb +326 -0
  474. data/lib/buildium-ruby/models/application_message.rb +294 -0
  475. data/lib/buildium-ruby/models/application_put_message.rb +257 -0
  476. data/lib/buildium-ruby/models/application_response_field_message.rb +294 -0
  477. data/lib/buildium-ruby/models/application_response_message.rb +274 -0
  478. data/lib/buildium-ruby/models/application_section_response_message.rb +219 -0
  479. data/lib/buildium-ruby/models/association_appliance_message.rb +288 -0
  480. data/lib/buildium-ruby/models/association_appliance_post_message.rb +298 -0
  481. data/lib/buildium-ruby/models/association_appliance_put_message.rb +273 -0
  482. data/lib/buildium-ruby/models/association_appliance_search_message.rb +232 -0
  483. data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +282 -0
  484. data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +282 -0
  485. data/lib/buildium-ruby/models/association_board_member_message.rb +344 -0
  486. data/lib/buildium-ruby/models/association_board_member_post_message.rb +293 -0
  487. data/lib/buildium-ruby/models/association_board_member_put_message.rb +278 -0
  488. data/lib/buildium-ruby/models/association_board_member_search_message.rb +274 -0
  489. data/lib/buildium-ruby/models/association_message.rb +327 -0
  490. data/lib/buildium-ruby/models/association_owner_board_term_message.rb +303 -0
  491. data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +278 -0
  492. data/lib/buildium-ruby/models/association_owner_message.rb +440 -0
  493. data/lib/buildium-ruby/models/association_owner_post_message.rb +398 -0
  494. data/lib/buildium-ruby/models/association_owner_put_message.rb +363 -0
  495. data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +428 -0
  496. data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +223 -0
  497. data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +228 -0
  498. data/lib/buildium-ruby/models/association_ownership_account_message.rb +347 -0
  499. data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +346 -0
  500. data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +223 -0
  501. data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +296 -0
  502. data/lib/buildium-ruby/models/association_post_message.rb +302 -0
  503. data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +300 -0
  504. data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +225 -0
  505. data/lib/buildium-ruby/models/association_put_message.rb +322 -0
  506. data/lib/buildium-ruby/models/association_search_message.rb +283 -0
  507. data/lib/buildium-ruby/models/association_tenant_message.rb +350 -0
  508. data/lib/buildium-ruby/models/association_tenant_post_message.rb +354 -0
  509. data/lib/buildium-ruby/models/association_tenant_put_message.rb +329 -0
  510. data/lib/buildium-ruby/models/association_unit_message.rb +334 -0
  511. data/lib/buildium-ruby/models/association_unit_put_message.rb +313 -0
  512. data/lib/buildium-ruby/models/association_unit_search_message.rb +241 -0
  513. data/lib/buildium-ruby/models/association_units_post_message.rb +328 -0
  514. data/lib/buildium-ruby/models/association_user_search_message.rb +324 -0
  515. data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +272 -0
  516. data/lib/buildium-ruby/models/bank_account_check_line_message.rb +267 -0
  517. data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +272 -0
  518. data/lib/buildium-ruby/models/bank_account_check_message.rb +279 -0
  519. data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +272 -0
  520. data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +272 -0
  521. data/lib/buildium-ruby/models/bank_account_check_post_message.rb +274 -0
  522. data/lib/buildium-ruby/models/bank_account_check_put_message.rb +274 -0
  523. data/lib/buildium-ruby/models/bank_account_check_search_message.rb +238 -0
  524. data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +267 -0
  525. data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +257 -0
  526. data/lib/buildium-ruby/models/bank_account_deposit_message.rb +272 -0
  527. data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +257 -0
  528. data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +250 -0
  529. data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +238 -0
  530. data/lib/buildium-ruby/models/bank_account_message.rb +360 -0
  531. data/lib/buildium-ruby/models/bank_account_post_message.rb +338 -0
  532. data/lib/buildium-ruby/models/bank_account_put_message.rb +343 -0
  533. data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +267 -0
  534. data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +277 -0
  535. data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +238 -0
  536. data/lib/buildium-ruby/models/bank_account_search_message.rb +263 -0
  537. data/lib/buildium-ruby/models/bank_account_transaction_message.rb +359 -0
  538. data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +292 -0
  539. data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +272 -0
  540. data/lib/buildium-ruby/models/bank_account_transfer_message.rb +267 -0
  541. data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +277 -0
  542. data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +238 -0
  543. data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +267 -0
  544. data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +277 -0
  545. data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +238 -0
  546. data/lib/buildium-ruby/models/bill_file_message.rb +268 -0
  547. data/lib/buildium-ruby/models/bill_line_message.rb +266 -0
  548. data/lib/buildium-ruby/models/bill_line_post_message.rb +272 -0
  549. data/lib/buildium-ruby/models/bill_line_put_message.rb +282 -0
  550. data/lib/buildium-ruby/models/bill_markup_message.rb +263 -0
  551. data/lib/buildium-ruby/models/bill_markup_save_message.rb +273 -0
  552. data/lib/buildium-ruby/models/bill_message.rb +344 -0
  553. data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +263 -0
  554. data/lib/buildium-ruby/models/bill_payment_line_message.rb +238 -0
  555. data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +238 -0
  556. data/lib/buildium-ruby/models/bill_payment_message.rb +270 -0
  557. data/lib/buildium-ruby/models/bill_payment_post_message.rb +275 -0
  558. data/lib/buildium-ruby/models/bill_post_message.rb +301 -0
  559. data/lib/buildium-ruby/models/bill_put_message.rb +286 -0
  560. data/lib/buildium-ruby/models/bill_search_message.rb +336 -0
  561. data/lib/buildium-ruby/models/budget_details_message.rb +281 -0
  562. data/lib/buildium-ruby/models/budget_details_save_message.rb +237 -0
  563. data/lib/buildium-ruby/models/budget_message.rb +269 -0
  564. data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +328 -0
  565. data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +388 -0
  566. data/lib/buildium-ruby/models/budget_post_message.rb +319 -0
  567. data/lib/buildium-ruby/models/budget_put_message.rb +240 -0
  568. data/lib/buildium-ruby/models/budget_search_message.rb +240 -0
  569. data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +359 -0
  570. data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +374 -0
  571. data/lib/buildium-ruby/models/check_printing_info_message.rb +392 -0
  572. data/lib/buildium-ruby/models/check_printing_info_post_message.rb +392 -0
  573. data/lib/buildium-ruby/models/check_printing_info_put_message.rb +407 -0
  574. data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +295 -0
  575. data/lib/buildium-ruby/models/client_lead_message.rb +363 -0
  576. data/lib/buildium-ruby/models/client_lead_search_message.rb +285 -0
  577. data/lib/buildium-ruby/models/contact_detail_message.rb +248 -0
  578. data/lib/buildium-ruby/models/contact_detail_phone_message.rb +239 -0
  579. data/lib/buildium-ruby/models/contact_detail_save_message.rb +253 -0
  580. data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +239 -0
  581. data/lib/buildium-ruby/models/contact_info_message.rb +248 -0
  582. data/lib/buildium-ruby/models/contact_request_task_message.rb +381 -0
  583. data/lib/buildium-ruby/models/contact_request_task_post_message.rb +388 -0
  584. data/lib/buildium-ruby/models/contact_request_task_put_message.rb +388 -0
  585. data/lib/buildium-ruby/models/contact_request_task_search_message.rb +366 -0
  586. data/lib/buildium-ruby/models/cosigner_message.rb +343 -0
  587. data/lib/buildium-ruby/models/created_by_user_message.rb +248 -0
  588. data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +388 -0
  589. data/lib/buildium-ruby/models/deposit_detail_message.rb +231 -0
  590. data/lib/buildium-ruby/models/electronic_payments_message.rb +288 -0
  591. data/lib/buildium-ruby/models/email_message.rb +247 -0
  592. data/lib/buildium-ruby/models/email_post_message.rb +307 -0
  593. data/lib/buildium-ruby/models/email_recipient_message.rb +292 -0
  594. data/lib/buildium-ruby/models/email_search_message.rb +268 -0
  595. data/lib/buildium-ruby/models/email_sender_message.rb +248 -0
  596. data/lib/buildium-ruby/models/emergency_contact_message.rb +249 -0
  597. data/lib/buildium-ruby/models/file_category_message.rb +239 -0
  598. data/lib/buildium-ruby/models/file_category_post_message.rb +224 -0
  599. data/lib/buildium-ruby/models/file_category_put_message.rb +224 -0
  600. data/lib/buildium-ruby/models/file_download_message.rb +218 -0
  601. data/lib/buildium-ruby/models/file_entity_message.rb +273 -0
  602. data/lib/buildium-ruby/models/file_message.rb +297 -0
  603. data/lib/buildium-ruby/models/file_name_post_message.rb +223 -0
  604. data/lib/buildium-ruby/models/file_put_message.rb +248 -0
  605. data/lib/buildium-ruby/models/file_search_message.rb +315 -0
  606. data/lib/buildium-ruby/models/file_upload_post_message.rb +322 -0
  607. data/lib/buildium-ruby/models/file_upload_ticket_message.rb +240 -0
  608. data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +297 -0
  609. data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +264 -0
  610. data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +264 -0
  611. data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +267 -0
  612. data/lib/buildium-ruby/models/general_ledger_journal_message.rb +230 -0
  613. data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +349 -0
  614. data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +310 -0
  615. data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +228 -0
  616. data/lib/buildium-ruby/models/gl_account_balance_message.rb +240 -0
  617. data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +317 -0
  618. data/lib/buildium-ruby/models/gl_account_message.rb +419 -0
  619. data/lib/buildium-ruby/models/gl_account_post_message.rb +349 -0
  620. data/lib/buildium-ruby/models/gl_account_put_message.rb +344 -0
  621. data/lib/buildium-ruby/models/gl_accounts_search_message.rb +243 -0
  622. data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +258 -0
  623. data/lib/buildium-ruby/models/internal_transaction_status_message.rb +239 -0
  624. data/lib/buildium-ruby/models/journal_line_message.rb +268 -0
  625. data/lib/buildium-ruby/models/journal_message.rb +230 -0
  626. data/lib/buildium-ruby/models/last_updated_by_user_message.rb +259 -0
  627. data/lib/buildium-ruby/models/lease_account_detail_message.rb +229 -0
  628. data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +249 -0
  629. data/lib/buildium-ruby/models/lease_charge_post_message.rb +241 -0
  630. data/lib/buildium-ruby/models/lease_charge_put_message.rb +250 -0
  631. data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +374 -0
  632. data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +330 -0
  633. data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +239 -0
  634. data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +309 -0
  635. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +238 -0
  636. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +260 -0
  637. data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +239 -0
  638. data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +335 -0
  639. data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +228 -0
  640. data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +238 -0
  641. data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +301 -0
  642. data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +306 -0
  643. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +239 -0
  644. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +239 -0
  645. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +256 -0
  646. data/lib/buildium-ruby/models/lease_message.rb +496 -0
  647. data/lib/buildium-ruby/models/lease_move_out_data_message.rb +238 -0
  648. data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +248 -0
  649. data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +330 -0
  650. data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +345 -0
  651. data/lib/buildium-ruby/models/lease_post_message.rb +379 -0
  652. data/lib/buildium-ruby/models/lease_put_message.rb +322 -0
  653. data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +408 -0
  654. data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +397 -0
  655. data/lib/buildium-ruby/models/lease_renewal_message.rb +336 -0
  656. data/lib/buildium-ruby/models/lease_renewal_post_message.rb +378 -0
  657. data/lib/buildium-ruby/models/lease_rent_charge_message.rb +278 -0
  658. data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +263 -0
  659. data/lib/buildium-ruby/models/lease_rent_message.rb +334 -0
  660. data/lib/buildium-ruby/models/lease_rent_post_message.rb +275 -0
  661. data/lib/buildium-ruby/models/lease_search_message.rb +359 -0
  662. data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +239 -0
  663. data/lib/buildium-ruby/models/lease_tenant_message.rb +262 -0
  664. data/lib/buildium-ruby/models/lease_transaction_message.rb +298 -0
  665. data/lib/buildium-ruby/models/lease_transaction_search_message.rb +263 -0
  666. data/lib/buildium-ruby/models/listing_contact_message.rb +259 -0
  667. data/lib/buildium-ruby/models/listing_contact_save_message.rb +253 -0
  668. data/lib/buildium-ruby/models/listing_file_message.rb +272 -0
  669. data/lib/buildium-ruby/models/listing_message.rb +305 -0
  670. data/lib/buildium-ruby/models/listing_property_message.rb +326 -0
  671. data/lib/buildium-ruby/models/listing_put_message.rb +283 -0
  672. data/lib/buildium-ruby/models/listing_search_message.rb +262 -0
  673. data/lib/buildium-ruby/models/listing_unit_message.rb +358 -0
  674. data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +218 -0
  675. data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +227 -0
  676. data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +249 -0
  677. data/lib/buildium-ruby/models/lookup_message.rb +226 -0
  678. data/lib/buildium-ruby/models/mailing_template_message.rb +282 -0
  679. data/lib/buildium-ruby/models/note_message.rb +237 -0
  680. data/lib/buildium-ruby/models/note_post_message.rb +223 -0
  681. data/lib/buildium-ruby/models/note_put_message.rb +223 -0
  682. data/lib/buildium-ruby/models/note_search_message.rb +238 -0
  683. data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +228 -0
  684. data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +374 -0
  685. data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +238 -0
  686. data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +309 -0
  687. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +238 -0
  688. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +260 -0
  689. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +248 -0
  690. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +238 -0
  691. data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +250 -0
  692. data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +250 -0
  693. data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +239 -0
  694. data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +335 -0
  695. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +310 -0
  696. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +308 -0
  697. data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +408 -0
  698. data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +397 -0
  699. data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +228 -0
  700. data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +238 -0
  701. data/lib/buildium-ruby/models/ownership_account_refund_message.rb +301 -0
  702. data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +306 -0
  703. data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +298 -0
  704. data/lib/buildium-ruby/models/paid_by_message.rb +228 -0
  705. data/lib/buildium-ruby/models/participant_message.rb +240 -0
  706. data/lib/buildium-ruby/models/participant_resource_message.rb +263 -0
  707. data/lib/buildium-ruby/models/payee_message.rb +283 -0
  708. data/lib/buildium-ruby/models/payment_detail_message.rb +281 -0
  709. data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +378 -0
  710. data/lib/buildium-ruby/models/payment_transactions_message.rb +237 -0
  711. data/lib/buildium-ruby/models/phone_log_message.rb +266 -0
  712. data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +282 -0
  713. data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +263 -0
  714. data/lib/buildium-ruby/models/phone_log_post_message.rb +267 -0
  715. data/lib/buildium-ruby/models/phone_log_put_message.rb +253 -0
  716. data/lib/buildium-ruby/models/phone_log_search_message.rb +336 -0
  717. data/lib/buildium-ruby/models/phone_number_message.rb +263 -0
  718. data/lib/buildium-ruby/models/phone_numbers_message.rb +249 -0
  719. data/lib/buildium-ruby/models/property_group_message.rb +259 -0
  720. data/lib/buildium-ruby/models/property_group_post_message.rb +250 -0
  721. data/lib/buildium-ruby/models/property_group_put_message.rb +250 -0
  722. data/lib/buildium-ruby/models/property_group_search_message.rb +230 -0
  723. data/lib/buildium-ruby/models/property_manager_message.rb +291 -0
  724. data/lib/buildium-ruby/models/property_message.rb +273 -0
  725. data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +228 -0
  726. data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +238 -0
  727. data/lib/buildium-ruby/models/recurring_transaction_message.rb +388 -0
  728. data/lib/buildium-ruby/models/rental_appliance_message.rb +288 -0
  729. data/lib/buildium-ruby/models/rental_appliance_post_message.rb +298 -0
  730. data/lib/buildium-ruby/models/rental_appliance_put_message.rb +273 -0
  731. data/lib/buildium-ruby/models/rental_appliance_search_message.rb +232 -0
  732. data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +282 -0
  733. data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +282 -0
  734. data/lib/buildium-ruby/models/rental_features_message.rb +255 -0
  735. data/lib/buildium-ruby/models/rental_features_put_message.rb +254 -0
  736. data/lib/buildium-ruby/models/rental_message.rb +373 -0
  737. data/lib/buildium-ruby/models/rental_owner_message.rb +361 -0
  738. data/lib/buildium-ruby/models/rental_owner_post_message.rb +363 -0
  739. data/lib/buildium-ruby/models/rental_owner_put_message.rb +354 -0
  740. data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +381 -0
  741. data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +384 -0
  742. data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +369 -0
  743. data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +366 -0
  744. data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +302 -0
  745. data/lib/buildium-ruby/models/rental_owners_search_message.rb +314 -0
  746. data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +300 -0
  747. data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +225 -0
  748. data/lib/buildium-ruby/models/rental_property_post_message.rb +365 -0
  749. data/lib/buildium-ruby/models/rental_property_put_message.rb +341 -0
  750. data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +333 -0
  751. data/lib/buildium-ruby/models/rental_search_message.rb +330 -0
  752. data/lib/buildium-ruby/models/rental_tenant_post_message.rb +388 -0
  753. data/lib/buildium-ruby/models/rental_tenant_put_message.rb +373 -0
  754. data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +373 -0
  755. data/lib/buildium-ruby/models/rental_unit_features_message.rb +243 -0
  756. data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +242 -0
  757. data/lib/buildium-ruby/models/rental_unit_message.rb +374 -0
  758. data/lib/buildium-ruby/models/rental_unit_put_message.rb +333 -0
  759. data/lib/buildium-ruby/models/rental_unit_search_message.rb +240 -0
  760. data/lib/buildium-ruby/models/rental_units_post_message.rb +348 -0
  761. data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +303 -0
  762. data/lib/buildium-ruby/models/resident_center_user_message.rb +280 -0
  763. data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +292 -0
  764. data/lib/buildium-ruby/models/resident_center_user_search_message.rb +288 -0
  765. data/lib/buildium-ruby/models/resident_request_task_message.rb +429 -0
  766. data/lib/buildium-ruby/models/resident_request_task_post_message.rb +409 -0
  767. data/lib/buildium-ruby/models/resident_request_task_put_message.rb +349 -0
  768. data/lib/buildium-ruby/models/resident_request_task_search_message.rb +376 -0
  769. data/lib/buildium-ruby/models/save_address_message.rb +323 -0
  770. data/lib/buildium-ruby/models/save_emergency_contact_message.rb +248 -0
  771. data/lib/buildium-ruby/models/task_category_message.rb +251 -0
  772. data/lib/buildium-ruby/models/task_category_put_message.rb +224 -0
  773. data/lib/buildium-ruby/models/task_category_response_message.rb +248 -0
  774. data/lib/buildium-ruby/models/task_category_save_message.rb +224 -0
  775. data/lib/buildium-ruby/models/task_history_file_message.rb +268 -0
  776. data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +223 -0
  777. data/lib/buildium-ruby/models/task_history_message.rb +376 -0
  778. data/lib/buildium-ruby/models/task_history_put_message.rb +223 -0
  779. data/lib/buildium-ruby/models/task_history_user_message.rb +249 -0
  780. data/lib/buildium-ruby/models/task_search_message.rb +398 -0
  781. data/lib/buildium-ruby/models/task_sub_category_message.rb +229 -0
  782. data/lib/buildium-ruby/models/tax_information_post_message.rb +292 -0
  783. data/lib/buildium-ruby/models/tax_information_save_message.rb +307 -0
  784. data/lib/buildium-ruby/models/tenant_message.rb +404 -0
  785. data/lib/buildium-ruby/models/tenant_search_message.rb +339 -0
  786. data/lib/buildium-ruby/models/to_do_task_message.rb +372 -0
  787. data/lib/buildium-ruby/models/to_do_task_post_message.rb +374 -0
  788. data/lib/buildium-ruby/models/to_do_task_put_message.rb +374 -0
  789. data/lib/buildium-ruby/models/to_do_task_search_message.rb +366 -0
  790. data/lib/buildium-ruby/models/undeposited_funds_message.rb +217 -0
  791. data/lib/buildium-ruby/models/unit_agreement_message.rb +273 -0
  792. data/lib/buildium-ruby/models/user_message.rb +354 -0
  793. data/lib/buildium-ruby/models/user_role_message.rb +249 -0
  794. data/lib/buildium-ruby/models/user_search_message.rb +297 -0
  795. data/lib/buildium-ruby/models/vehicle_message.rb +249 -0
  796. data/lib/buildium-ruby/models/vendor_category_message.rb +239 -0
  797. data/lib/buildium-ruby/models/vendor_category_save_message.rb +223 -0
  798. data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +257 -0
  799. data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +262 -0
  800. data/lib/buildium-ruby/models/vendor_credit_message.rb +260 -0
  801. data/lib/buildium-ruby/models/vendor_credit_post_message.rb +260 -0
  802. data/lib/buildium-ruby/models/vendor_insurance_message.rb +239 -0
  803. data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +239 -0
  804. data/lib/buildium-ruby/models/vendor_message.rb +377 -0
  805. data/lib/buildium-ruby/models/vendor_post_message.rb +364 -0
  806. data/lib/buildium-ruby/models/vendor_put_message.rb +364 -0
  807. data/lib/buildium-ruby/models/vendor_refund_line_message.rb +257 -0
  808. data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +262 -0
  809. data/lib/buildium-ruby/models/vendor_refund_message.rb +314 -0
  810. data/lib/buildium-ruby/models/vendor_refund_post_message.rb +324 -0
  811. data/lib/buildium-ruby/models/vendor_search_message.rb +334 -0
  812. data/lib/buildium-ruby/models/vendor_tax_information_message.rb +302 -0
  813. data/lib/buildium-ruby/models/vendor_transaction_message.rb +302 -0
  814. data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +292 -0
  815. data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +231 -0
  816. data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +263 -0
  817. data/lib/buildium-ruby/models/work_order_line_item_message.rb +249 -0
  818. data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +258 -0
  819. data/lib/buildium-ruby/models/work_order_message.rb +372 -0
  820. data/lib/buildium-ruby/models/work_order_post_message.rb +363 -0
  821. data/lib/buildium-ruby/models/work_order_put_message.rb +344 -0
  822. data/lib/buildium-ruby/models/work_order_search_message.rb +452 -0
  823. data/lib/buildium-ruby/models/work_order_task_message.rb +346 -0
  824. data/lib/buildium-ruby/models/work_order_task_post_message.rb +345 -0
  825. data/lib/buildium-ruby/version.rb +15 -0
  826. data/lib/buildium-ruby.rb +438 -0
  827. data/openapitools.json +7 -0
  828. data/spec/api/accounting_api_spec.rb +383 -0
  829. data/spec/api/administration_api_spec.rb +114 -0
  830. data/spec/api/applicants_api_spec.rb +294 -0
  831. data/spec/api/association_appliances_api_spec.rb +141 -0
  832. data/spec/api/association_owners_api_spec.rb +195 -0
  833. data/spec/api/association_ownership_accounts_api_spec.rb +385 -0
  834. data/spec/api/association_tenants_api_spec.rb +153 -0
  835. data/spec/api/association_units_api_spec.rb +147 -0
  836. data/spec/api/associations_api_spec.rb +248 -0
  837. data/spec/api/bank_accounts_api_spec.rb +420 -0
  838. data/spec/api/client_leads_api_spec.rb +66 -0
  839. data/spec/api/communications_api_spec.rb +248 -0
  840. data/spec/api/files_api_spec.rb +156 -0
  841. data/spec/api/leases_api_spec.rb +529 -0
  842. data/spec/api/listings_api_spec.rb +139 -0
  843. data/spec/api/property_groups_api_spec.rb +88 -0
  844. data/spec/api/rental_appliances_api_spec.rb +141 -0
  845. data/spec/api/rental_owners_api_spec.rb +151 -0
  846. data/spec/api/rental_properties_api_spec.rb +205 -0
  847. data/spec/api/rental_tenants_api_spec.rb +154 -0
  848. data/spec/api/rental_units_api_spec.rb +172 -0
  849. data/spec/api/resident_center_api_spec.rb +54 -0
  850. data/spec/api/tasks_api_spec.rb +493 -0
  851. data/spec/api/vendors_api_spec.rb +275 -0
  852. data/spec/api/work_orders_api_spec.rb +105 -0
  853. data/spec/api_client_spec.rb +188 -0
  854. data/spec/configuration_spec.rb +42 -0
  855. data/spec/models/account_info_message_spec.rb +58 -0
  856. data/spec/models/accounting_entity_message_spec.rb +50 -0
  857. data/spec/models/accounting_entity_save_message_spec.rb +44 -0
  858. data/spec/models/accounting_lock_period_message_spec.rb +46 -0
  859. data/spec/models/accounting_settings_message_spec.rb +72 -0
  860. data/spec/models/address_message_spec.rb +74 -0
  861. data/spec/models/all_tasks_message_spec.rb +130 -0
  862. data/spec/models/announcement_message_spec.rb +74 -0
  863. data/spec/models/announcement_post_message_spec.rb +64 -0
  864. data/spec/models/announcement_search_message_spec.rb +62 -0
  865. data/spec/models/announcement_sender_message_spec.rb +46 -0
  866. data/spec/models/api_error_response_spec.rb +46 -0
  867. data/spec/models/appliance_message_spec.rb +58 -0
  868. data/spec/models/applicant_application_message_spec.rb +56 -0
  869. data/spec/models/applicant_group_message_spec.rb +62 -0
  870. data/spec/models/applicant_group_post_message_spec.rb +40 -0
  871. data/spec/models/applicant_group_put_message_spec.rb +50 -0
  872. data/spec/models/applicant_group_search_message_spec.rb +66 -0
  873. data/spec/models/applicant_message_spec.rb +88 -0
  874. data/spec/models/applicant_post_message_spec.rb +64 -0
  875. data/spec/models/applicant_put_message_spec.rb +58 -0
  876. data/spec/models/applicant_search_message_spec.rb +84 -0
  877. data/spec/models/application_message_spec.rb +62 -0
  878. data/spec/models/application_put_message_spec.rb +38 -0
  879. data/spec/models/application_response_field_message_spec.rb +60 -0
  880. data/spec/models/application_response_message_spec.rb +50 -0
  881. data/spec/models/application_section_response_message_spec.rb +34 -0
  882. data/spec/models/association_appliance_message_spec.rb +76 -0
  883. data/spec/models/association_appliance_post_message_spec.rb +76 -0
  884. data/spec/models/association_appliance_put_message_spec.rb +64 -0
  885. data/spec/models/association_appliance_search_message_spec.rb +40 -0
  886. data/spec/models/association_appliance_service_history_message_spec.rb +56 -0
  887. data/spec/models/association_appliance_service_history_post_message_spec.rb +50 -0
  888. data/spec/models/association_board_member_message_spec.rb +92 -0
  889. data/spec/models/association_board_member_post_message_spec.rb +56 -0
  890. data/spec/models/association_board_member_put_message_spec.rb +50 -0
  891. data/spec/models/association_board_member_search_message_spec.rb +60 -0
  892. data/spec/models/association_message_spec.rb +100 -0
  893. data/spec/models/association_owner_board_term_message_spec.rb +68 -0
  894. data/spec/models/association_owner_board_term_post_message_spec.rb +50 -0
  895. data/spec/models/association_owner_message_spec.rb +144 -0
  896. data/spec/models/association_owner_post_message_spec.rb +116 -0
  897. data/spec/models/association_owner_put_message_spec.rb +98 -0
  898. data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +128 -0
  899. data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +34 -0
  900. data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +40 -0
  901. data/spec/models/association_ownership_account_message_spec.rb +90 -0
  902. data/spec/models/association_ownership_account_post_message_spec.rb +80 -0
  903. data/spec/models/association_ownership_account_put_message_spec.rb +34 -0
  904. data/spec/models/association_ownership_account_search_message_spec.rb +72 -0
  905. data/spec/models/association_post_message_spec.rb +76 -0
  906. data/spec/models/association_preferred_vendor_message_spec.rb +82 -0
  907. data/spec/models/association_preferred_vendor_put_message_spec.rb +34 -0
  908. data/spec/models/association_put_message_spec.rb +82 -0
  909. data/spec/models/association_search_message_spec.rb +56 -0
  910. data/spec/models/association_tenant_message_spec.rb +112 -0
  911. data/spec/models/association_tenant_post_message_spec.rb +106 -0
  912. data/spec/models/association_tenant_put_message_spec.rb +94 -0
  913. data/spec/models/association_unit_message_spec.rb +84 -0
  914. data/spec/models/association_unit_put_message_spec.rb +66 -0
  915. data/spec/models/association_unit_search_message_spec.rb +46 -0
  916. data/spec/models/association_units_post_message_spec.rb +72 -0
  917. data/spec/models/association_user_search_message_spec.rb +86 -0
  918. data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +44 -0
  919. data/spec/models/bank_account_check_line_message_spec.rb +64 -0
  920. data/spec/models/bank_account_check_line_save_message_spec.rb +58 -0
  921. data/spec/models/bank_account_check_message_spec.rb +70 -0
  922. data/spec/models/bank_account_check_payee_message_spec.rb +50 -0
  923. data/spec/models/bank_account_check_payee_save_message_spec.rb +44 -0
  924. data/spec/models/bank_account_check_post_message_spec.rb +58 -0
  925. data/spec/models/bank_account_check_put_message_spec.rb +58 -0
  926. data/spec/models/bank_account_check_search_message_spec.rb +40 -0
  927. data/spec/models/bank_account_deposit_line_message_spec.rb +64 -0
  928. data/spec/models/bank_account_deposit_line_save_message_spec.rb +58 -0
  929. data/spec/models/bank_account_deposit_message_spec.rb +64 -0
  930. data/spec/models/bank_account_deposit_post_message_spec.rb +52 -0
  931. data/spec/models/bank_account_deposit_put_message_spec.rb +46 -0
  932. data/spec/models/bank_account_deposit_search_message_spec.rb +40 -0
  933. data/spec/models/bank_account_message_spec.rb +104 -0
  934. data/spec/models/bank_account_post_message_spec.rb +78 -0
  935. data/spec/models/bank_account_put_message_spec.rb +78 -0
  936. data/spec/models/bank_account_quick_deposit_message_spec.rb +64 -0
  937. data/spec/models/bank_account_quick_deposit_save_message_spec.rb +58 -0
  938. data/spec/models/bank_account_quick_deposit_search_message_spec.rb +40 -0
  939. data/spec/models/bank_account_search_message_spec.rb +44 -0
  940. data/spec/models/bank_account_transaction_message_spec.rb +96 -0
  941. data/spec/models/bank_account_transaction_search_message_spec.rb +56 -0
  942. data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +44 -0
  943. data/spec/models/bank_account_transfer_message_spec.rb +64 -0
  944. data/spec/models/bank_account_transfer_save_message_spec.rb +58 -0
  945. data/spec/models/bank_account_transfer_search_message_spec.rb +40 -0
  946. data/spec/models/bank_account_withdrawal_message_spec.rb +64 -0
  947. data/spec/models/bank_account_withdrawal_save_message_spec.rb +58 -0
  948. data/spec/models/bank_account_withdrawal_search_message_spec.rb +40 -0
  949. data/spec/models/bill_file_message_spec.rb +64 -0
  950. data/spec/models/bill_line_message_spec.rb +64 -0
  951. data/spec/models/bill_line_post_message_spec.rb +58 -0
  952. data/spec/models/bill_line_put_message_spec.rb +64 -0
  953. data/spec/models/bill_markup_message_spec.rb +44 -0
  954. data/spec/models/bill_markup_save_message_spec.rb +44 -0
  955. data/spec/models/bill_message_spec.rb +92 -0
  956. data/spec/models/bill_payment_accounting_entity_message_spec.rb +44 -0
  957. data/spec/models/bill_payment_line_message_spec.rb +46 -0
  958. data/spec/models/bill_payment_line_post_message_spec.rb +40 -0
  959. data/spec/models/bill_payment_message_spec.rb +64 -0
  960. data/spec/models/bill_payment_post_message_spec.rb +58 -0
  961. data/spec/models/bill_post_message_spec.rb +70 -0
  962. data/spec/models/bill_put_message_spec.rb +64 -0
  963. data/spec/models/bill_search_message_spec.rb +88 -0
  964. data/spec/models/budget_details_message_spec.rb +56 -0
  965. data/spec/models/budget_details_save_message_spec.rb +40 -0
  966. data/spec/models/budget_message_spec.rb +64 -0
  967. data/spec/models/budget_monthly_amounts_message_spec.rb +100 -0
  968. data/spec/models/budget_monthly_amounts_save_message_spec.rb +100 -0
  969. data/spec/models/budget_post_message_spec.rb +62 -0
  970. data/spec/models/budget_put_message_spec.rb +40 -0
  971. data/spec/models/budget_search_message_spec.rb +46 -0
  972. data/spec/models/charge_recurring_transaction_post_message_spec.rb +84 -0
  973. data/spec/models/charge_recurring_transaction_put_message_spec.rb +90 -0
  974. data/spec/models/check_printing_info_message_spec.rb +122 -0
  975. data/spec/models/check_printing_info_post_message_spec.rb +122 -0
  976. data/spec/models/check_printing_info_put_message_spec.rb +122 -0
  977. data/spec/models/client_lead_credit_request_message_spec.rb +60 -0
  978. data/spec/models/client_lead_message_spec.rb +102 -0
  979. data/spec/models/client_lead_search_message_spec.rb +66 -0
  980. data/spec/models/contact_detail_message_spec.rb +52 -0
  981. data/spec/models/contact_detail_phone_message_spec.rb +46 -0
  982. data/spec/models/contact_detail_save_message_spec.rb +52 -0
  983. data/spec/models/contact_detail_save_phone_message_spec.rb +46 -0
  984. data/spec/models/contact_info_message_spec.rb +52 -0
  985. data/spec/models/contact_request_task_message_spec.rb +114 -0
  986. data/spec/models/contact_request_task_post_message_spec.rb +102 -0
  987. data/spec/models/contact_request_task_put_message_spec.rb +102 -0
  988. data/spec/models/contact_request_task_search_message_spec.rb +112 -0
  989. data/spec/models/cosigner_message_spec.rb +92 -0
  990. data/spec/models/created_by_user_message_spec.rb +52 -0
  991. data/spec/models/credit_recurring_transaction_post_message_spec.rb +100 -0
  992. data/spec/models/deposit_detail_message_spec.rb +40 -0
  993. data/spec/models/electronic_payments_message_spec.rb +76 -0
  994. data/spec/models/email_message_spec.rb +52 -0
  995. data/spec/models/email_post_message_spec.rb +70 -0
  996. data/spec/models/email_recipient_message_spec.rb +62 -0
  997. data/spec/models/email_search_message_spec.rb +58 -0
  998. data/spec/models/email_sender_message_spec.rb +52 -0
  999. data/spec/models/emergency_contact_message_spec.rb +52 -0
  1000. data/spec/models/file_category_message_spec.rb +46 -0
  1001. data/spec/models/file_category_post_message_spec.rb +34 -0
  1002. data/spec/models/file_category_put_message_spec.rb +34 -0
  1003. data/spec/models/file_download_message_spec.rb +34 -0
  1004. data/spec/models/file_entity_message_spec.rb +50 -0
  1005. data/spec/models/file_message_spec.rb +82 -0
  1006. data/spec/models/file_name_post_message_spec.rb +34 -0
  1007. data/spec/models/file_put_message_spec.rb +46 -0
  1008. data/spec/models/file_search_message_spec.rb +74 -0
  1009. data/spec/models/file_upload_post_message_spec.rb +68 -0
  1010. data/spec/models/file_upload_ticket_message_spec.rb +46 -0
  1011. data/spec/models/general_journal_entry_line_save_message_spec.rb +56 -0
  1012. data/spec/models/general_journal_entry_post_message_spec.rb +52 -0
  1013. data/spec/models/general_journal_entry_put_message_spec.rb +52 -0
  1014. data/spec/models/general_ledger_journal_line_message_spec.rb +64 -0
  1015. data/spec/models/general_ledger_journal_message_spec.rb +40 -0
  1016. data/spec/models/general_ledger_transaction_message_spec.rb +98 -0
  1017. data/spec/models/general_ledger_transaction_search_message_spec.rb +62 -0
  1018. data/spec/models/gl_account_balance_item_message_spec.rb +40 -0
  1019. data/spec/models/gl_account_balance_message_spec.rb +46 -0
  1020. data/spec/models/gl_account_balance_search_message_spec.rb +66 -0
  1021. data/spec/models/gl_account_message_spec.rb +130 -0
  1022. data/spec/models/gl_account_post_message_spec.rb +84 -0
  1023. data/spec/models/gl_account_put_message_spec.rb +84 -0
  1024. data/spec/models/gl_accounts_search_message_spec.rb +38 -0
  1025. data/spec/models/gl_transaction_message_v1_spec.rb +58 -0
  1026. data/spec/models/internal_transaction_status_message_spec.rb +46 -0
  1027. data/spec/models/journal_line_message_spec.rb +64 -0
  1028. data/spec/models/journal_message_spec.rb +40 -0
  1029. data/spec/models/last_updated_by_user_message_spec.rb +58 -0
  1030. data/spec/models/lease_account_detail_message_spec.rb +40 -0
  1031. data/spec/models/lease_charge_line_save_message_spec.rb +46 -0
  1032. data/spec/models/lease_charge_post_message_spec.rb +46 -0
  1033. data/spec/models/lease_charge_put_message_spec.rb +46 -0
  1034. data/spec/models/lease_charge_recurring_transaction_message_spec.rb +108 -0
  1035. data/spec/models/lease_cosigner_post_message_spec.rb +80 -0
  1036. data/spec/models/lease_ledger_credit_line_post_message_spec.rb +40 -0
  1037. data/spec/models/lease_ledger_credit_post_message_spec.rb +62 -0
  1038. data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +40 -0
  1039. data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +52 -0
  1040. data/spec/models/lease_ledger_payment_line_save_message_spec.rb +40 -0
  1041. data/spec/models/lease_ledger_payment_post_message_spec.rb +74 -0
  1042. data/spec/models/lease_ledger_refund_line_message_spec.rb +40 -0
  1043. data/spec/models/lease_ledger_refund_line_post_message_spec.rb +40 -0
  1044. data/spec/models/lease_ledger_refund_message_spec.rb +82 -0
  1045. data/spec/models/lease_ledger_refund_post_message_spec.rb +70 -0
  1046. data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +40 -0
  1047. data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +40 -0
  1048. data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +52 -0
  1049. data/spec/models/lease_message_spec.rb +170 -0
  1050. data/spec/models/lease_move_out_data_message_spec.rb +46 -0
  1051. data/spec/models/lease_move_out_data_post_message_spec.rb +46 -0
  1052. data/spec/models/lease_outstanding_balance_message_spec.rb +100 -0
  1053. data/spec/models/lease_outstanding_balance_search_message_spec.rb +90 -0
  1054. data/spec/models/lease_post_message_spec.rb +98 -0
  1055. data/spec/models/lease_put_message_spec.rb +68 -0
  1056. data/spec/models/lease_recurring_credit_message_spec.rb +124 -0
  1057. data/spec/models/lease_recurring_payment_message_spec.rb +118 -0
  1058. data/spec/models/lease_renewal_message_spec.rb +84 -0
  1059. data/spec/models/lease_renewal_post_message_spec.rb +98 -0
  1060. data/spec/models/lease_rent_charge_message_spec.rb +70 -0
  1061. data/spec/models/lease_rent_charge_post_message_spec.rb +52 -0
  1062. data/spec/models/lease_rent_message_spec.rb +86 -0
  1063. data/spec/models/lease_rent_post_message_spec.rb +44 -0
  1064. data/spec/models/lease_search_message_spec.rb +108 -0
  1065. data/spec/models/lease_security_deposit_post_message_spec.rb +40 -0
  1066. data/spec/models/lease_tenant_message_spec.rb +44 -0
  1067. data/spec/models/lease_transaction_message_spec.rb +82 -0
  1068. data/spec/models/lease_transaction_search_message_spec.rb +50 -0
  1069. data/spec/models/listing_contact_message_spec.rb +58 -0
  1070. data/spec/models/listing_contact_save_message_spec.rb +52 -0
  1071. data/spec/models/listing_file_message_spec.rb +50 -0
  1072. data/spec/models/listing_message_spec.rb +88 -0
  1073. data/spec/models/listing_property_message_spec.rb +90 -0
  1074. data/spec/models/listing_put_message_spec.rb +64 -0
  1075. data/spec/models/listing_search_message_spec.rb +44 -0
  1076. data/spec/models/listing_unit_message_spec.rb +100 -0
  1077. data/spec/models/lock_period_settings_global_message_spec.rb +34 -0
  1078. data/spec/models/lock_period_settings_overrides_message_spec.rb +40 -0
  1079. data/spec/models/logged_by_staff_user_message_spec.rb +52 -0
  1080. data/spec/models/lookup_message_spec.rb +40 -0
  1081. data/spec/models/mailing_template_message_spec.rb +56 -0
  1082. data/spec/models/note_message_spec.rb +46 -0
  1083. data/spec/models/note_post_message_spec.rb +34 -0
  1084. data/spec/models/note_put_message_spec.rb +34 -0
  1085. data/spec/models/note_search_message_spec.rb +46 -0
  1086. data/spec/models/outstanding_balances_line_message_spec.rb +40 -0
  1087. data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +108 -0
  1088. data/spec/models/ownership_account_credit_line_post_message_spec.rb +40 -0
  1089. data/spec/models/ownership_account_credit_post_message_spec.rb +62 -0
  1090. data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +40 -0
  1091. data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +52 -0
  1092. data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +46 -0
  1093. data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +40 -0
  1094. data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +46 -0
  1095. data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +46 -0
  1096. data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +40 -0
  1097. data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +74 -0
  1098. data/spec/models/ownership_account_outstanding_balance_message_spec.rb +88 -0
  1099. data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +70 -0
  1100. data/spec/models/ownership_account_recurring_credit_message_spec.rb +124 -0
  1101. data/spec/models/ownership_account_recurring_payment_message_spec.rb +118 -0
  1102. data/spec/models/ownership_account_refund_line_message_spec.rb +40 -0
  1103. data/spec/models/ownership_account_refund_lines_post_message_spec.rb +40 -0
  1104. data/spec/models/ownership_account_refund_message_spec.rb +82 -0
  1105. data/spec/models/ownership_account_refund_post_message_spec.rb +70 -0
  1106. data/spec/models/ownership_account_transaction_message_spec.rb +82 -0
  1107. data/spec/models/paid_by_message_spec.rb +40 -0
  1108. data/spec/models/participant_message_spec.rb +46 -0
  1109. data/spec/models/participant_resource_message_spec.rb +44 -0
  1110. data/spec/models/payee_message_spec.rb +56 -0
  1111. data/spec/models/payment_detail_message_spec.rb +56 -0
  1112. data/spec/models/payment_recurring_transaction_post_message_spec.rb +94 -0
  1113. data/spec/models/payment_transactions_message_spec.rb +46 -0
  1114. data/spec/models/phone_log_message_spec.rb +64 -0
  1115. data/spec/models/phone_log_participant_post_message_spec.rb +50 -0
  1116. data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +44 -0
  1117. data/spec/models/phone_log_post_message_spec.rb +52 -0
  1118. data/spec/models/phone_log_put_message_spec.rb +46 -0
  1119. data/spec/models/phone_log_search_message_spec.rb +84 -0
  1120. data/spec/models/phone_number_message_spec.rb +44 -0
  1121. data/spec/models/phone_numbers_message_spec.rb +52 -0
  1122. data/spec/models/property_group_message_spec.rb +58 -0
  1123. data/spec/models/property_group_post_message_spec.rb +46 -0
  1124. data/spec/models/property_group_put_message_spec.rb +46 -0
  1125. data/spec/models/property_group_search_message_spec.rb +40 -0
  1126. data/spec/models/property_manager_message_spec.rb +76 -0
  1127. data/spec/models/property_message_spec.rb +50 -0
  1128. data/spec/models/recurring_transaction_line_message_spec.rb +40 -0
  1129. data/spec/models/recurring_transaction_line_post_message_spec.rb +40 -0
  1130. data/spec/models/recurring_transaction_message_spec.rb +112 -0
  1131. data/spec/models/rental_appliance_message_spec.rb +76 -0
  1132. data/spec/models/rental_appliance_post_message_spec.rb +76 -0
  1133. data/spec/models/rental_appliance_put_message_spec.rb +64 -0
  1134. data/spec/models/rental_appliance_search_message_spec.rb +40 -0
  1135. data/spec/models/rental_appliance_service_history_message_spec.rb +56 -0
  1136. data/spec/models/rental_appliance_service_history_post_message_spec.rb +50 -0
  1137. data/spec/models/rental_features_message_spec.rb +48 -0
  1138. data/spec/models/rental_features_put_message_spec.rb +48 -0
  1139. data/spec/models/rental_message_spec.rb +108 -0
  1140. data/spec/models/rental_owner_message_spec.rb +118 -0
  1141. data/spec/models/rental_owner_post_message_spec.rb +112 -0
  1142. data/spec/models/rental_owner_put_message_spec.rb +106 -0
  1143. data/spec/models/rental_owner_request_task_message_spec.rb +114 -0
  1144. data/spec/models/rental_owner_request_task_post_message_spec.rb +102 -0
  1145. data/spec/models/rental_owner_request_task_put_message_spec.rb +96 -0
  1146. data/spec/models/rental_owner_request_task_search_message_spec.rb +112 -0
  1147. data/spec/models/rental_owner_tax_information_message_spec.rb +68 -0
  1148. data/spec/models/rental_owners_search_message_spec.rb +74 -0
  1149. data/spec/models/rental_preferred_vendor_message_spec.rb +82 -0
  1150. data/spec/models/rental_preferred_vendor_put_message_spec.rb +34 -0
  1151. data/spec/models/rental_property_post_message_spec.rb +92 -0
  1152. data/spec/models/rental_property_put_message_spec.rb +80 -0
  1153. data/spec/models/rental_property_unit_post_message_spec.rb +78 -0
  1154. data/spec/models/rental_search_message_spec.rb +88 -0
  1155. data/spec/models/rental_tenant_post_message_spec.rb +110 -0
  1156. data/spec/models/rental_tenant_put_message_spec.rb +104 -0
  1157. data/spec/models/rental_tenant_renewal_post_message_spec.rb +104 -0
  1158. data/spec/models/rental_unit_features_message_spec.rb +38 -0
  1159. data/spec/models/rental_unit_features_put_message_spec.rb +38 -0
  1160. data/spec/models/rental_unit_message_spec.rb +108 -0
  1161. data/spec/models/rental_unit_put_message_spec.rb +78 -0
  1162. data/spec/models/rental_unit_search_message_spec.rb +46 -0
  1163. data/spec/models/rental_units_post_message_spec.rb +84 -0
  1164. data/spec/models/requested_by_user_entity_message_spec.rb +68 -0
  1165. data/spec/models/resident_center_user_message_spec.rb +56 -0
  1166. data/spec/models/resident_center_user_reference_message_spec.rb +62 -0
  1167. data/spec/models/resident_center_user_search_message_spec.rb +66 -0
  1168. data/spec/models/resident_request_task_message_spec.rb +144 -0
  1169. data/spec/models/resident_request_task_post_message_spec.rb +114 -0
  1170. data/spec/models/resident_request_task_put_message_spec.rb +84 -0
  1171. data/spec/models/resident_request_task_search_message_spec.rb +118 -0
  1172. data/spec/models/save_address_message_spec.rb +74 -0
  1173. data/spec/models/save_emergency_contact_message_spec.rb +52 -0
  1174. data/spec/models/task_category_message_spec.rb +52 -0
  1175. data/spec/models/task_category_put_message_spec.rb +34 -0
  1176. data/spec/models/task_category_response_message_spec.rb +52 -0
  1177. data/spec/models/task_category_save_message_spec.rb +34 -0
  1178. data/spec/models/task_history_file_message_spec.rb +64 -0
  1179. data/spec/models/task_history_file_upload_post_message_spec.rb +34 -0
  1180. data/spec/models/task_history_message_spec.rb +112 -0
  1181. data/spec/models/task_history_put_message_spec.rb +34 -0
  1182. data/spec/models/task_history_user_message_spec.rb +52 -0
  1183. data/spec/models/task_search_message_spec.rb +128 -0
  1184. data/spec/models/task_sub_category_message_spec.rb +40 -0
  1185. data/spec/models/tax_information_post_message_spec.rb +62 -0
  1186. data/spec/models/tax_information_save_message_spec.rb +68 -0
  1187. data/spec/models/tenant_message_spec.rb +128 -0
  1188. data/spec/models/tenant_search_message_spec.rb +96 -0
  1189. data/spec/models/to_do_task_message_spec.rb +108 -0
  1190. data/spec/models/to_do_task_post_message_spec.rb +96 -0
  1191. data/spec/models/to_do_task_put_message_spec.rb +96 -0
  1192. data/spec/models/to_do_task_search_message_spec.rb +112 -0
  1193. data/spec/models/undeposited_funds_message_spec.rb +34 -0
  1194. data/spec/models/unit_agreement_message_spec.rb +50 -0
  1195. data/spec/models/user_message_spec.rb +104 -0
  1196. data/spec/models/user_role_message_spec.rb +52 -0
  1197. data/spec/models/user_search_message_spec.rb +66 -0
  1198. data/spec/models/vehicle_message_spec.rb +52 -0
  1199. data/spec/models/vendor_category_message_spec.rb +46 -0
  1200. data/spec/models/vendor_category_save_message_spec.rb +34 -0
  1201. data/spec/models/vendor_credit_line_item_message_spec.rb +58 -0
  1202. data/spec/models/vendor_credit_line_item_post_message_spec.rb +52 -0
  1203. data/spec/models/vendor_credit_message_spec.rb +58 -0
  1204. data/spec/models/vendor_credit_post_message_spec.rb +52 -0
  1205. data/spec/models/vendor_insurance_message_spec.rb +46 -0
  1206. data/spec/models/vendor_insurance_save_message_spec.rb +46 -0
  1207. data/spec/models/vendor_message_spec.rb +130 -0
  1208. data/spec/models/vendor_post_message_spec.rb +118 -0
  1209. data/spec/models/vendor_put_message_spec.rb +118 -0
  1210. data/spec/models/vendor_refund_line_message_spec.rb +58 -0
  1211. data/spec/models/vendor_refund_line_post_message_spec.rb +52 -0
  1212. data/spec/models/vendor_refund_message_spec.rb +74 -0
  1213. data/spec/models/vendor_refund_post_message_spec.rb +68 -0
  1214. data/spec/models/vendor_search_message_spec.rb +84 -0
  1215. data/spec/models/vendor_tax_information_message_spec.rb +68 -0
  1216. data/spec/models/vendor_transaction_message_spec.rb +68 -0
  1217. data/spec/models/vendor_transaction_search_message_spec.rb +62 -0
  1218. data/spec/models/work_order_entry_contact_message_spec.rb +40 -0
  1219. data/spec/models/work_order_entry_contact_resource_message_spec.rb +44 -0
  1220. data/spec/models/work_order_line_item_message_spec.rb +52 -0
  1221. data/spec/models/work_order_line_item_save_message_spec.rb +52 -0
  1222. data/spec/models/work_order_message_spec.rb +110 -0
  1223. data/spec/models/work_order_post_message_spec.rb +98 -0
  1224. data/spec/models/work_order_put_message_spec.rb +86 -0
  1225. data/spec/models/work_order_search_message_spec.rb +158 -0
  1226. data/spec/models/work_order_task_message_spec.rb +88 -0
  1227. data/spec/models/work_order_task_post_message_spec.rb +78 -0
  1228. data/spec/spec_helper.rb +111 -0
  1229. metadata +1725 -0
@@ -0,0 +1,989 @@
1
+ # Buildium::RentalPropertiesApi
2
+
3
+ All URIs are relative to *https://api.buildium.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_rental_property**](RentalPropertiesApi.md#create_rental_property) | **POST** /v1/rentals | Create a property |
8
+ | [**create_rental_property_note**](RentalPropertiesApi.md#create_rental_property_note) | **POST** /v1/rentals/{propertyId}/notes | Create a note |
9
+ | [**get_all_rentals**](RentalPropertiesApi.md#get_all_rentals) | **GET** /v1/rentals | Retrieve all properties |
10
+ | [**get_features_by_rental_property_id**](RentalPropertiesApi.md#get_features_by_rental_property_id) | **GET** /v1/rentals/{propertyId}/amenities | Retrieve all amenities |
11
+ | [**get_rental_by_id**](RentalPropertiesApi.md#get_rental_by_id) | **GET** /v1/rentals/{propertyId} | Retrieve a property |
12
+ | [**get_rental_note_by_note_id**](RentalPropertiesApi.md#get_rental_note_by_note_id) | **GET** /v1/rentals/{propertyId}/notes/{noteId} | Retrieve a note |
13
+ | [**get_rental_notes**](RentalPropertiesApi.md#get_rental_notes) | **GET** /v1/rentals/{propertyId}/notes | Retrieve all notes |
14
+ | [**get_rental_preferred_vendors**](RentalPropertiesApi.md#get_rental_preferred_vendors) | **GET** /v1/rentals/{propertyId}/vendors | Retrieve all preferred vendors |
15
+ | [**update_rental_features**](RentalPropertiesApi.md#update_rental_features) | **PUT** /v1/rentals/{propertyId}/amenities | Update amenities |
16
+ | [**update_rental_preferred_vendors**](RentalPropertiesApi.md#update_rental_preferred_vendors) | **PUT** /v1/rentals/{propertyId}/vendors | Update preferred vendors |
17
+ | [**update_rental_property**](RentalPropertiesApi.md#update_rental_property) | **PUT** /v1/rentals/{propertyId} | Update a property |
18
+ | [**update_rental_property_note**](RentalPropertiesApi.md#update_rental_property_note) | **PUT** /v1/rentals/{propertyId}/notes/{noteId} | Update a note |
19
+
20
+
21
+ ## create_rental_property
22
+
23
+ > <RentalMessage> create_rental_property(rental_property_post_message)
24
+
25
+ Create a property
26
+
27
+ Creates a new rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
28
+
29
+ ### Examples
30
+
31
+ ```ruby
32
+ require 'time'
33
+ require 'buildium-ruby'
34
+ # setup authorization
35
+ Buildium.configure do |config|
36
+ # Configure API key authorization: clientId
37
+ config.api_key['clientId'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ # config.api_key_prefix['clientId'] = 'Bearer'
40
+
41
+ # Configure API key authorization: clientSecret
42
+ config.api_key['clientSecret'] = 'YOUR API KEY'
43
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
44
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
45
+ end
46
+
47
+ api_instance = Buildium::RentalPropertiesApi.new
48
+ rental_property_post_message = Buildium::RentalPropertyPostMessage.new({name: 'name_example', address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'}), rental_sub_type: 'CondoTownhome', operating_bank_account_id: 37}) # RentalPropertyPostMessage |
49
+
50
+ begin
51
+ # Create a property
52
+ result = api_instance.create_rental_property(rental_property_post_message)
53
+ p result
54
+ rescue Buildium::ApiError => e
55
+ puts "Error when calling RentalPropertiesApi->create_rental_property: #{e}"
56
+ end
57
+ ```
58
+
59
+ #### Using the create_rental_property_with_http_info variant
60
+
61
+ This returns an Array which contains the response data, status code and headers.
62
+
63
+ > <Array(<RentalMessage>, Integer, Hash)> create_rental_property_with_http_info(rental_property_post_message)
64
+
65
+ ```ruby
66
+ begin
67
+ # Create a property
68
+ data, status_code, headers = api_instance.create_rental_property_with_http_info(rental_property_post_message)
69
+ p status_code # => 2xx
70
+ p headers # => { ... }
71
+ p data # => <RentalMessage>
72
+ rescue Buildium::ApiError => e
73
+ puts "Error when calling RentalPropertiesApi->create_rental_property_with_http_info: #{e}"
74
+ end
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Name | Type | Description | Notes |
80
+ | ---- | ---- | ----------- | ----- |
81
+ | **rental_property_post_message** | [**RentalPropertyPostMessage**](RentalPropertyPostMessage.md) | | |
82
+
83
+ ### Return type
84
+
85
+ [**RentalMessage**](RentalMessage.md)
86
+
87
+ ### Authorization
88
+
89
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: application/json
94
+ - **Accept**: application/json
95
+
96
+
97
+ ## create_rental_property_note
98
+
99
+ > <NoteMessage> create_rental_property_note(property_id, note_post_message)
100
+
101
+ Create a note
102
+
103
+ Creates a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
104
+
105
+ ### Examples
106
+
107
+ ```ruby
108
+ require 'time'
109
+ require 'buildium-ruby'
110
+ # setup authorization
111
+ Buildium.configure do |config|
112
+ # Configure API key authorization: clientId
113
+ config.api_key['clientId'] = 'YOUR API KEY'
114
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
115
+ # config.api_key_prefix['clientId'] = 'Bearer'
116
+
117
+ # Configure API key authorization: clientSecret
118
+ config.api_key['clientSecret'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
121
+ end
122
+
123
+ api_instance = Buildium::RentalPropertiesApi.new
124
+ property_id = 56 # Integer |
125
+ note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
126
+
127
+ begin
128
+ # Create a note
129
+ result = api_instance.create_rental_property_note(property_id, note_post_message)
130
+ p result
131
+ rescue Buildium::ApiError => e
132
+ puts "Error when calling RentalPropertiesApi->create_rental_property_note: #{e}"
133
+ end
134
+ ```
135
+
136
+ #### Using the create_rental_property_note_with_http_info variant
137
+
138
+ This returns an Array which contains the response data, status code and headers.
139
+
140
+ > <Array(<NoteMessage>, Integer, Hash)> create_rental_property_note_with_http_info(property_id, note_post_message)
141
+
142
+ ```ruby
143
+ begin
144
+ # Create a note
145
+ data, status_code, headers = api_instance.create_rental_property_note_with_http_info(property_id, note_post_message)
146
+ p status_code # => 2xx
147
+ p headers # => { ... }
148
+ p data # => <NoteMessage>
149
+ rescue Buildium::ApiError => e
150
+ puts "Error when calling RentalPropertiesApi->create_rental_property_note_with_http_info: #{e}"
151
+ end
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Name | Type | Description | Notes |
157
+ | ---- | ---- | ----------- | ----- |
158
+ | **property_id** | **Integer** | | |
159
+ | **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
160
+
161
+ ### Return type
162
+
163
+ [**NoteMessage**](NoteMessage.md)
164
+
165
+ ### Authorization
166
+
167
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: application/json
172
+ - **Accept**: application/json
173
+
174
+
175
+ ## get_all_rentals
176
+
177
+ > <Array<RentalMessage>> get_all_rentals(opts)
178
+
179
+ Retrieve all properties
180
+
181
+ Retrieves a list of rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
182
+
183
+ ### Examples
184
+
185
+ ```ruby
186
+ require 'time'
187
+ require 'buildium-ruby'
188
+ # setup authorization
189
+ Buildium.configure do |config|
190
+ # Configure API key authorization: clientId
191
+ config.api_key['clientId'] = 'YOUR API KEY'
192
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
193
+ # config.api_key_prefix['clientId'] = 'Bearer'
194
+
195
+ # Configure API key authorization: clientSecret
196
+ config.api_key['clientSecret'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
199
+ end
200
+
201
+ api_instance = Buildium::RentalPropertiesApi.new
202
+ opts = {
203
+ location: 'location_example', # String | Filters results to only rental properties whose city or state *contains* the specified value.
204
+ types: ['Residential'], # Array<String> | Filters results by the rental type. If no type is provided all types will be returned.
205
+ subtypes: ['CondoTownhome'], # Array<String> | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.
206
+ status: 'Active', # String | Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned.
207
+ rentalownerids: [37], # Array<Integer> | Filters results to only rental properties whose RentalOwnerId matches the specified Id.
208
+ propertyids: [37], # Array<Integer> | Filters results to only rental properties units whose Rental matches the specified Id.
209
+ lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
210
+ lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
211
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
212
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
213
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
214
+ }
215
+
216
+ begin
217
+ # Retrieve all properties
218
+ result = api_instance.get_all_rentals(opts)
219
+ p result
220
+ rescue Buildium::ApiError => e
221
+ puts "Error when calling RentalPropertiesApi->get_all_rentals: #{e}"
222
+ end
223
+ ```
224
+
225
+ #### Using the get_all_rentals_with_http_info variant
226
+
227
+ This returns an Array which contains the response data, status code and headers.
228
+
229
+ > <Array(<Array<RentalMessage>>, Integer, Hash)> get_all_rentals_with_http_info(opts)
230
+
231
+ ```ruby
232
+ begin
233
+ # Retrieve all properties
234
+ data, status_code, headers = api_instance.get_all_rentals_with_http_info(opts)
235
+ p status_code # => 2xx
236
+ p headers # => { ... }
237
+ p data # => <Array<RentalMessage>>
238
+ rescue Buildium::ApiError => e
239
+ puts "Error when calling RentalPropertiesApi->get_all_rentals_with_http_info: #{e}"
240
+ end
241
+ ```
242
+
243
+ ### Parameters
244
+
245
+ | Name | Type | Description | Notes |
246
+ | ---- | ---- | ----------- | ----- |
247
+ | **location** | **String** | Filters results to only rental properties whose city or state *contains* the specified value. | [optional] |
248
+ | **types** | [**Array&lt;String&gt;**](String.md) | Filters results by the rental type. If no type is provided all types will be returned. | [optional] |
249
+ | **subtypes** | [**Array&lt;String&gt;**](String.md) | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned. | [optional] |
250
+ | **status** | **String** | Filters results by the status of the rental property. If no status is specified both &#x60;active&#x60; and &#x60;inactive&#x60; rental properties will be returned. | [optional] |
251
+ | **rentalownerids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties whose RentalOwnerId matches the specified Id. | [optional] |
252
+ | **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only rental properties units whose Rental matches the specified Id. | [optional] |
253
+ | **lastupdatedfrom** | **Time** | Filters results to any rental properties that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
254
+ | **lastupdatedto** | **Time** | Filters results to any rental properties that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
255
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
256
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
257
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
258
+
259
+ ### Return type
260
+
261
+ [**Array&lt;RentalMessage&gt;**](RentalMessage.md)
262
+
263
+ ### Authorization
264
+
265
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
266
+
267
+ ### HTTP request headers
268
+
269
+ - **Content-Type**: Not defined
270
+ - **Accept**: application/json
271
+
272
+
273
+ ## get_features_by_rental_property_id
274
+
275
+ > <RentalFeaturesMessage> get_features_by_rental_property_id(property_id)
276
+
277
+ Retrieve all amenities
278
+
279
+ Retrieve all the amenities for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
280
+
281
+ ### Examples
282
+
283
+ ```ruby
284
+ require 'time'
285
+ require 'buildium-ruby'
286
+ # setup authorization
287
+ Buildium.configure do |config|
288
+ # Configure API key authorization: clientId
289
+ config.api_key['clientId'] = 'YOUR API KEY'
290
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
291
+ # config.api_key_prefix['clientId'] = 'Bearer'
292
+
293
+ # Configure API key authorization: clientSecret
294
+ config.api_key['clientSecret'] = 'YOUR API KEY'
295
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
296
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
297
+ end
298
+
299
+ api_instance = Buildium::RentalPropertiesApi.new
300
+ property_id = 56 # Integer |
301
+
302
+ begin
303
+ # Retrieve all amenities
304
+ result = api_instance.get_features_by_rental_property_id(property_id)
305
+ p result
306
+ rescue Buildium::ApiError => e
307
+ puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id: #{e}"
308
+ end
309
+ ```
310
+
311
+ #### Using the get_features_by_rental_property_id_with_http_info variant
312
+
313
+ This returns an Array which contains the response data, status code and headers.
314
+
315
+ > <Array(<RentalFeaturesMessage>, Integer, Hash)> get_features_by_rental_property_id_with_http_info(property_id)
316
+
317
+ ```ruby
318
+ begin
319
+ # Retrieve all amenities
320
+ data, status_code, headers = api_instance.get_features_by_rental_property_id_with_http_info(property_id)
321
+ p status_code # => 2xx
322
+ p headers # => { ... }
323
+ p data # => <RentalFeaturesMessage>
324
+ rescue Buildium::ApiError => e
325
+ puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id_with_http_info: #{e}"
326
+ end
327
+ ```
328
+
329
+ ### Parameters
330
+
331
+ | Name | Type | Description | Notes |
332
+ | ---- | ---- | ----------- | ----- |
333
+ | **property_id** | **Integer** | | |
334
+
335
+ ### Return type
336
+
337
+ [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
338
+
339
+ ### Authorization
340
+
341
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
342
+
343
+ ### HTTP request headers
344
+
345
+ - **Content-Type**: Not defined
346
+ - **Accept**: application/json
347
+
348
+
349
+ ## get_rental_by_id
350
+
351
+ > <RentalMessage> get_rental_by_id(property_id)
352
+
353
+ Retrieve a property
354
+
355
+ Retrieve a specific rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
356
+
357
+ ### Examples
358
+
359
+ ```ruby
360
+ require 'time'
361
+ require 'buildium-ruby'
362
+ # setup authorization
363
+ Buildium.configure do |config|
364
+ # Configure API key authorization: clientId
365
+ config.api_key['clientId'] = 'YOUR API KEY'
366
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
367
+ # config.api_key_prefix['clientId'] = 'Bearer'
368
+
369
+ # Configure API key authorization: clientSecret
370
+ config.api_key['clientSecret'] = 'YOUR API KEY'
371
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
372
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
373
+ end
374
+
375
+ api_instance = Buildium::RentalPropertiesApi.new
376
+ property_id = 56 # Integer | The rental property identifier.
377
+
378
+ begin
379
+ # Retrieve a property
380
+ result = api_instance.get_rental_by_id(property_id)
381
+ p result
382
+ rescue Buildium::ApiError => e
383
+ puts "Error when calling RentalPropertiesApi->get_rental_by_id: #{e}"
384
+ end
385
+ ```
386
+
387
+ #### Using the get_rental_by_id_with_http_info variant
388
+
389
+ This returns an Array which contains the response data, status code and headers.
390
+
391
+ > <Array(<RentalMessage>, Integer, Hash)> get_rental_by_id_with_http_info(property_id)
392
+
393
+ ```ruby
394
+ begin
395
+ # Retrieve a property
396
+ data, status_code, headers = api_instance.get_rental_by_id_with_http_info(property_id)
397
+ p status_code # => 2xx
398
+ p headers # => { ... }
399
+ p data # => <RentalMessage>
400
+ rescue Buildium::ApiError => e
401
+ puts "Error when calling RentalPropertiesApi->get_rental_by_id_with_http_info: #{e}"
402
+ end
403
+ ```
404
+
405
+ ### Parameters
406
+
407
+ | Name | Type | Description | Notes |
408
+ | ---- | ---- | ----------- | ----- |
409
+ | **property_id** | **Integer** | The rental property identifier. | |
410
+
411
+ ### Return type
412
+
413
+ [**RentalMessage**](RentalMessage.md)
414
+
415
+ ### Authorization
416
+
417
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
418
+
419
+ ### HTTP request headers
420
+
421
+ - **Content-Type**: Not defined
422
+ - **Accept**: application/json
423
+
424
+
425
+ ## get_rental_note_by_note_id
426
+
427
+ > <NoteMessage> get_rental_note_by_note_id(property_id, note_id)
428
+
429
+ Retrieve a note
430
+
431
+ Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
432
+
433
+ ### Examples
434
+
435
+ ```ruby
436
+ require 'time'
437
+ require 'buildium-ruby'
438
+ # setup authorization
439
+ Buildium.configure do |config|
440
+ # Configure API key authorization: clientId
441
+ config.api_key['clientId'] = 'YOUR API KEY'
442
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
443
+ # config.api_key_prefix['clientId'] = 'Bearer'
444
+
445
+ # Configure API key authorization: clientSecret
446
+ config.api_key['clientSecret'] = 'YOUR API KEY'
447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
448
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
449
+ end
450
+
451
+ api_instance = Buildium::RentalPropertiesApi.new
452
+ property_id = 56 # Integer |
453
+ note_id = 56 # Integer |
454
+
455
+ begin
456
+ # Retrieve a note
457
+ result = api_instance.get_rental_note_by_note_id(property_id, note_id)
458
+ p result
459
+ rescue Buildium::ApiError => e
460
+ puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id: #{e}"
461
+ end
462
+ ```
463
+
464
+ #### Using the get_rental_note_by_note_id_with_http_info variant
465
+
466
+ This returns an Array which contains the response data, status code and headers.
467
+
468
+ > <Array(<NoteMessage>, Integer, Hash)> get_rental_note_by_note_id_with_http_info(property_id, note_id)
469
+
470
+ ```ruby
471
+ begin
472
+ # Retrieve a note
473
+ data, status_code, headers = api_instance.get_rental_note_by_note_id_with_http_info(property_id, note_id)
474
+ p status_code # => 2xx
475
+ p headers # => { ... }
476
+ p data # => <NoteMessage>
477
+ rescue Buildium::ApiError => e
478
+ puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id_with_http_info: #{e}"
479
+ end
480
+ ```
481
+
482
+ ### Parameters
483
+
484
+ | Name | Type | Description | Notes |
485
+ | ---- | ---- | ----------- | ----- |
486
+ | **property_id** | **Integer** | | |
487
+ | **note_id** | **Integer** | | |
488
+
489
+ ### Return type
490
+
491
+ [**NoteMessage**](NoteMessage.md)
492
+
493
+ ### Authorization
494
+
495
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
496
+
497
+ ### HTTP request headers
498
+
499
+ - **Content-Type**: Not defined
500
+ - **Accept**: application/json
501
+
502
+
503
+ ## get_rental_notes
504
+
505
+ > <Array<NoteMessage>> get_rental_notes(property_id, opts)
506
+
507
+ Retrieve all notes
508
+
509
+ Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View`
510
+
511
+ ### Examples
512
+
513
+ ```ruby
514
+ require 'time'
515
+ require 'buildium-ruby'
516
+ # setup authorization
517
+ Buildium.configure do |config|
518
+ # Configure API key authorization: clientId
519
+ config.api_key['clientId'] = 'YOUR API KEY'
520
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
521
+ # config.api_key_prefix['clientId'] = 'Bearer'
522
+
523
+ # Configure API key authorization: clientSecret
524
+ config.api_key['clientSecret'] = 'YOUR API KEY'
525
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
526
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
527
+ end
528
+
529
+ api_instance = Buildium::RentalPropertiesApi.new
530
+ property_id = 56 # Integer |
531
+ opts = {
532
+ updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
533
+ updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
534
+ lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
535
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
536
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
537
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
538
+ }
539
+
540
+ begin
541
+ # Retrieve all notes
542
+ result = api_instance.get_rental_notes(property_id, opts)
543
+ p result
544
+ rescue Buildium::ApiError => e
545
+ puts "Error when calling RentalPropertiesApi->get_rental_notes: #{e}"
546
+ end
547
+ ```
548
+
549
+ #### Using the get_rental_notes_with_http_info variant
550
+
551
+ This returns an Array which contains the response data, status code and headers.
552
+
553
+ > <Array(<Array<NoteMessage>>, Integer, Hash)> get_rental_notes_with_http_info(property_id, opts)
554
+
555
+ ```ruby
556
+ begin
557
+ # Retrieve all notes
558
+ data, status_code, headers = api_instance.get_rental_notes_with_http_info(property_id, opts)
559
+ p status_code # => 2xx
560
+ p headers # => { ... }
561
+ p data # => <Array<NoteMessage>>
562
+ rescue Buildium::ApiError => e
563
+ puts "Error when calling RentalPropertiesApi->get_rental_notes_with_http_info: #{e}"
564
+ end
565
+ ```
566
+
567
+ ### Parameters
568
+
569
+ | Name | Type | Description | Notes |
570
+ | ---- | ---- | ----------- | ----- |
571
+ | **property_id** | **Integer** | | |
572
+ | **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
573
+ | **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
574
+ | **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
575
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
576
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
577
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
578
+
579
+ ### Return type
580
+
581
+ [**Array&lt;NoteMessage&gt;**](NoteMessage.md)
582
+
583
+ ### Authorization
584
+
585
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
586
+
587
+ ### HTTP request headers
588
+
589
+ - **Content-Type**: Not defined
590
+ - **Accept**: application/json
591
+
592
+
593
+ ## get_rental_preferred_vendors
594
+
595
+ > <Array<RentalPreferredVendorMessage>> get_rental_preferred_vendors(property_id, opts)
596
+
597
+ Retrieve all preferred vendors
598
+
599
+ Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`
600
+
601
+ ### Examples
602
+
603
+ ```ruby
604
+ require 'time'
605
+ require 'buildium-ruby'
606
+ # setup authorization
607
+ Buildium.configure do |config|
608
+ # Configure API key authorization: clientId
609
+ config.api_key['clientId'] = 'YOUR API KEY'
610
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
611
+ # config.api_key_prefix['clientId'] = 'Bearer'
612
+
613
+ # Configure API key authorization: clientSecret
614
+ config.api_key['clientSecret'] = 'YOUR API KEY'
615
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
616
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
617
+ end
618
+
619
+ api_instance = Buildium::RentalPropertiesApi.new
620
+ property_id = 56 # Integer |
621
+ opts = {
622
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
623
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
624
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
625
+ }
626
+
627
+ begin
628
+ # Retrieve all preferred vendors
629
+ result = api_instance.get_rental_preferred_vendors(property_id, opts)
630
+ p result
631
+ rescue Buildium::ApiError => e
632
+ puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors: #{e}"
633
+ end
634
+ ```
635
+
636
+ #### Using the get_rental_preferred_vendors_with_http_info variant
637
+
638
+ This returns an Array which contains the response data, status code and headers.
639
+
640
+ > <Array(<Array<RentalPreferredVendorMessage>>, Integer, Hash)> get_rental_preferred_vendors_with_http_info(property_id, opts)
641
+
642
+ ```ruby
643
+ begin
644
+ # Retrieve all preferred vendors
645
+ data, status_code, headers = api_instance.get_rental_preferred_vendors_with_http_info(property_id, opts)
646
+ p status_code # => 2xx
647
+ p headers # => { ... }
648
+ p data # => <Array<RentalPreferredVendorMessage>>
649
+ rescue Buildium::ApiError => e
650
+ puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors_with_http_info: #{e}"
651
+ end
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+ | Name | Type | Description | Notes |
657
+ | ---- | ---- | ----------- | ----- |
658
+ | **property_id** | **Integer** | | |
659
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
660
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
661
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50. | [optional] |
662
+
663
+ ### Return type
664
+
665
+ [**Array&lt;RentalPreferredVendorMessage&gt;**](RentalPreferredVendorMessage.md)
666
+
667
+ ### Authorization
668
+
669
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
670
+
671
+ ### HTTP request headers
672
+
673
+ - **Content-Type**: Not defined
674
+ - **Accept**: application/json
675
+
676
+
677
+ ## update_rental_features
678
+
679
+ > <RentalFeaturesMessage> update_rental_features(property_id, rental_features_put_message)
680
+
681
+ Update amenities
682
+
683
+ Updates the amenities for a rental property. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
684
+
685
+ ### Examples
686
+
687
+ ```ruby
688
+ require 'time'
689
+ require 'buildium-ruby'
690
+ # setup authorization
691
+ Buildium.configure do |config|
692
+ # Configure API key authorization: clientId
693
+ config.api_key['clientId'] = 'YOUR API KEY'
694
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
695
+ # config.api_key_prefix['clientId'] = 'Bearer'
696
+
697
+ # Configure API key authorization: clientSecret
698
+ config.api_key['clientSecret'] = 'YOUR API KEY'
699
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
700
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
701
+ end
702
+
703
+ api_instance = Buildium::RentalPropertiesApi.new
704
+ property_id = 56 # Integer |
705
+ rental_features_put_message = Buildium::RentalFeaturesPutMessage.new # RentalFeaturesPutMessage |
706
+
707
+ begin
708
+ # Update amenities
709
+ result = api_instance.update_rental_features(property_id, rental_features_put_message)
710
+ p result
711
+ rescue Buildium::ApiError => e
712
+ puts "Error when calling RentalPropertiesApi->update_rental_features: #{e}"
713
+ end
714
+ ```
715
+
716
+ #### Using the update_rental_features_with_http_info variant
717
+
718
+ This returns an Array which contains the response data, status code and headers.
719
+
720
+ > <Array(<RentalFeaturesMessage>, Integer, Hash)> update_rental_features_with_http_info(property_id, rental_features_put_message)
721
+
722
+ ```ruby
723
+ begin
724
+ # Update amenities
725
+ data, status_code, headers = api_instance.update_rental_features_with_http_info(property_id, rental_features_put_message)
726
+ p status_code # => 2xx
727
+ p headers # => { ... }
728
+ p data # => <RentalFeaturesMessage>
729
+ rescue Buildium::ApiError => e
730
+ puts "Error when calling RentalPropertiesApi->update_rental_features_with_http_info: #{e}"
731
+ end
732
+ ```
733
+
734
+ ### Parameters
735
+
736
+ | Name | Type | Description | Notes |
737
+ | ---- | ---- | ----------- | ----- |
738
+ | **property_id** | **Integer** | | |
739
+ | **rental_features_put_message** | [**RentalFeaturesPutMessage**](RentalFeaturesPutMessage.md) | | |
740
+
741
+ ### Return type
742
+
743
+ [**RentalFeaturesMessage**](RentalFeaturesMessage.md)
744
+
745
+ ### Authorization
746
+
747
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
748
+
749
+ ### HTTP request headers
750
+
751
+ - **Content-Type**: application/json
752
+ - **Accept**: application/json
753
+
754
+
755
+ ## update_rental_preferred_vendors
756
+
757
+ > <Array<RentalPreferredVendorMessage>> update_rental_preferred_vendors(property_id, rental_preferred_vendor_put_message)
758
+
759
+ Update preferred vendors
760
+
761
+ Updates preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` `Edit`
762
+
763
+ ### Examples
764
+
765
+ ```ruby
766
+ require 'time'
767
+ require 'buildium-ruby'
768
+ # setup authorization
769
+ Buildium.configure do |config|
770
+ # Configure API key authorization: clientId
771
+ config.api_key['clientId'] = 'YOUR API KEY'
772
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
773
+ # config.api_key_prefix['clientId'] = 'Bearer'
774
+
775
+ # Configure API key authorization: clientSecret
776
+ config.api_key['clientSecret'] = 'YOUR API KEY'
777
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
778
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
779
+ end
780
+
781
+ api_instance = Buildium::RentalPropertiesApi.new
782
+ property_id = 56 # Integer |
783
+ rental_preferred_vendor_put_message = Buildium::RentalPreferredVendorPutMessage.new({vendor_ids: [37]}) # RentalPreferredVendorPutMessage |
784
+
785
+ begin
786
+ # Update preferred vendors
787
+ result = api_instance.update_rental_preferred_vendors(property_id, rental_preferred_vendor_put_message)
788
+ p result
789
+ rescue Buildium::ApiError => e
790
+ puts "Error when calling RentalPropertiesApi->update_rental_preferred_vendors: #{e}"
791
+ end
792
+ ```
793
+
794
+ #### Using the update_rental_preferred_vendors_with_http_info variant
795
+
796
+ This returns an Array which contains the response data, status code and headers.
797
+
798
+ > <Array(<Array<RentalPreferredVendorMessage>>, Integer, Hash)> update_rental_preferred_vendors_with_http_info(property_id, rental_preferred_vendor_put_message)
799
+
800
+ ```ruby
801
+ begin
802
+ # Update preferred vendors
803
+ data, status_code, headers = api_instance.update_rental_preferred_vendors_with_http_info(property_id, rental_preferred_vendor_put_message)
804
+ p status_code # => 2xx
805
+ p headers # => { ... }
806
+ p data # => <Array<RentalPreferredVendorMessage>>
807
+ rescue Buildium::ApiError => e
808
+ puts "Error when calling RentalPropertiesApi->update_rental_preferred_vendors_with_http_info: #{e}"
809
+ end
810
+ ```
811
+
812
+ ### Parameters
813
+
814
+ | Name | Type | Description | Notes |
815
+ | ---- | ---- | ----------- | ----- |
816
+ | **property_id** | **Integer** | | |
817
+ | **rental_preferred_vendor_put_message** | [**RentalPreferredVendorPutMessage**](RentalPreferredVendorPutMessage.md) | | |
818
+
819
+ ### Return type
820
+
821
+ [**Array&lt;RentalPreferredVendorMessage&gt;**](RentalPreferredVendorMessage.md)
822
+
823
+ ### Authorization
824
+
825
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
826
+
827
+ ### HTTP request headers
828
+
829
+ - **Content-Type**: application/json
830
+ - **Accept**: application/json
831
+
832
+
833
+ ## update_rental_property
834
+
835
+ > <RentalMessage> update_rental_property(property_id, rental_property_put_message)
836
+
837
+ Update a property
838
+
839
+ Updates a rental property. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
840
+
841
+ ### Examples
842
+
843
+ ```ruby
844
+ require 'time'
845
+ require 'buildium-ruby'
846
+ # setup authorization
847
+ Buildium.configure do |config|
848
+ # Configure API key authorization: clientId
849
+ config.api_key['clientId'] = 'YOUR API KEY'
850
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
851
+ # config.api_key_prefix['clientId'] = 'Bearer'
852
+
853
+ # Configure API key authorization: clientSecret
854
+ config.api_key['clientSecret'] = 'YOUR API KEY'
855
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
856
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
857
+ end
858
+
859
+ api_instance = Buildium::RentalPropertiesApi.new
860
+ property_id = 56 # Integer |
861
+ rental_property_put_message = Buildium::RentalPropertyPutMessage.new({name: 'name_example', address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'}), rental_sub_type: 'CondoTownhome', operating_bank_account_id: 37}) # RentalPropertyPutMessage |
862
+
863
+ begin
864
+ # Update a property
865
+ result = api_instance.update_rental_property(property_id, rental_property_put_message)
866
+ p result
867
+ rescue Buildium::ApiError => e
868
+ puts "Error when calling RentalPropertiesApi->update_rental_property: #{e}"
869
+ end
870
+ ```
871
+
872
+ #### Using the update_rental_property_with_http_info variant
873
+
874
+ This returns an Array which contains the response data, status code and headers.
875
+
876
+ > <Array(<RentalMessage>, Integer, Hash)> update_rental_property_with_http_info(property_id, rental_property_put_message)
877
+
878
+ ```ruby
879
+ begin
880
+ # Update a property
881
+ data, status_code, headers = api_instance.update_rental_property_with_http_info(property_id, rental_property_put_message)
882
+ p status_code # => 2xx
883
+ p headers # => { ... }
884
+ p data # => <RentalMessage>
885
+ rescue Buildium::ApiError => e
886
+ puts "Error when calling RentalPropertiesApi->update_rental_property_with_http_info: #{e}"
887
+ end
888
+ ```
889
+
890
+ ### Parameters
891
+
892
+ | Name | Type | Description | Notes |
893
+ | ---- | ---- | ----------- | ----- |
894
+ | **property_id** | **Integer** | | |
895
+ | **rental_property_put_message** | [**RentalPropertyPutMessage**](RentalPropertyPutMessage.md) | | |
896
+
897
+ ### Return type
898
+
899
+ [**RentalMessage**](RentalMessage.md)
900
+
901
+ ### Authorization
902
+
903
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
904
+
905
+ ### HTTP request headers
906
+
907
+ - **Content-Type**: application/json
908
+ - **Accept**: application/json
909
+
910
+
911
+ ## update_rental_property_note
912
+
913
+ > <NoteMessage> update_rental_property_note(property_id, note_id, note_put_message)
914
+
915
+ Update a note
916
+
917
+ Updates a note. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals &gt; Rental properties and units</span> - `View` `Edit`
918
+
919
+ ### Examples
920
+
921
+ ```ruby
922
+ require 'time'
923
+ require 'buildium-ruby'
924
+ # setup authorization
925
+ Buildium.configure do |config|
926
+ # Configure API key authorization: clientId
927
+ config.api_key['clientId'] = 'YOUR API KEY'
928
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
929
+ # config.api_key_prefix['clientId'] = 'Bearer'
930
+
931
+ # Configure API key authorization: clientSecret
932
+ config.api_key['clientSecret'] = 'YOUR API KEY'
933
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
934
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
935
+ end
936
+
937
+ api_instance = Buildium::RentalPropertiesApi.new
938
+ property_id = 56 # Integer |
939
+ note_id = 56 # Integer |
940
+ note_put_message = Buildium::NotePutMessage.new({note: 'note_example'}) # NotePutMessage |
941
+
942
+ begin
943
+ # Update a note
944
+ result = api_instance.update_rental_property_note(property_id, note_id, note_put_message)
945
+ p result
946
+ rescue Buildium::ApiError => e
947
+ puts "Error when calling RentalPropertiesApi->update_rental_property_note: #{e}"
948
+ end
949
+ ```
950
+
951
+ #### Using the update_rental_property_note_with_http_info variant
952
+
953
+ This returns an Array which contains the response data, status code and headers.
954
+
955
+ > <Array(<NoteMessage>, Integer, Hash)> update_rental_property_note_with_http_info(property_id, note_id, note_put_message)
956
+
957
+ ```ruby
958
+ begin
959
+ # Update a note
960
+ data, status_code, headers = api_instance.update_rental_property_note_with_http_info(property_id, note_id, note_put_message)
961
+ p status_code # => 2xx
962
+ p headers # => { ... }
963
+ p data # => <NoteMessage>
964
+ rescue Buildium::ApiError => e
965
+ puts "Error when calling RentalPropertiesApi->update_rental_property_note_with_http_info: #{e}"
966
+ end
967
+ ```
968
+
969
+ ### Parameters
970
+
971
+ | Name | Type | Description | Notes |
972
+ | ---- | ---- | ----------- | ----- |
973
+ | **property_id** | **Integer** | | |
974
+ | **note_id** | **Integer** | | |
975
+ | **note_put_message** | [**NotePutMessage**](NotePutMessage.md) | | |
976
+
977
+ ### Return type
978
+
979
+ [**NoteMessage**](NoteMessage.md)
980
+
981
+ ### Authorization
982
+
983
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
984
+
985
+ ### HTTP request headers
986
+
987
+ - **Content-Type**: application/json
988
+ - **Accept**: application/json
989
+