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,2224 @@
1
+ # Buildium::BankAccountsApi
2
+
3
+ All URIs are relative to *https://api.buildium.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_bank_account**](BankAccountsApi.md#create_bank_account) | **POST** /v1/bankaccounts | Create a bank account |
8
+ | [**create_bank_account_check**](BankAccountsApi.md#create_bank_account_check) | **POST** /v1/bankaccounts/{bankAccountId}/checks | Create a check |
9
+ | [**create_bank_account_deposit**](BankAccountsApi.md#create_bank_account_deposit) | **POST** /v1/bankaccounts/{bankAccountId}/deposits | Create a deposit |
10
+ | [**create_bank_account_transfer**](BankAccountsApi.md#create_bank_account_transfer) | **POST** /v1/bankaccounts/{bankAccountId}/transfers | Create a transfer |
11
+ | [**create_quick_deposit**](BankAccountsApi.md#create_quick_deposit) | **POST** /v1/bankaccounts/{bankAccountId}/quickdeposits | Create a quick deposit |
12
+ | [**create_withdrawal_for_bank_account**](BankAccountsApi.md#create_withdrawal_for_bank_account) | **POST** /v1/bankaccounts/{bankAccountId}/withdrawals | Create a withdrawal |
13
+ | [**get_all_bank_accounts**](BankAccountsApi.md#get_all_bank_accounts) | **GET** /v1/bankaccounts | Retrieve all bank accounts |
14
+ | [**get_all_quick_deposits**](BankAccountsApi.md#get_all_quick_deposits) | **GET** /v1/bankaccounts/{bankAccountId}/quickdeposits | Retrieve all quick deposits |
15
+ | [**get_bank_account**](BankAccountsApi.md#get_bank_account) | **GET** /v1/bankaccounts/{bankAccountId} | Retrieve a bank account |
16
+ | [**get_bank_account_checks**](BankAccountsApi.md#get_bank_account_checks) | **GET** /v1/bankaccounts/{bankAccountId}/checks | Retrieve all checks |
17
+ | [**get_bank_account_deposit_by_id**](BankAccountsApi.md#get_bank_account_deposit_by_id) | **GET** /v1/bankaccounts/{bankAccountId}/deposits/{depositId} | Retrieve a deposit |
18
+ | [**get_bank_account_deposits**](BankAccountsApi.md#get_bank_account_deposits) | **GET** /v1/bankaccounts/{bankAccountId}/deposits | Retrieve all deposits |
19
+ | [**get_bank_account_transaction_by_id**](BankAccountsApi.md#get_bank_account_transaction_by_id) | **GET** /v1/bankaccounts/{bankAccountId}/transactions/{transactionId} | Retrieve a transaction |
20
+ | [**get_bank_account_transactions**](BankAccountsApi.md#get_bank_account_transactions) | **GET** /v1/bankaccounts/{bankAccountId}/transactions | Retrieve all transactions |
21
+ | [**get_bank_account_transfer_by_id**](BankAccountsApi.md#get_bank_account_transfer_by_id) | **GET** /v1/bankaccounts/{bankAccountId}/transfers/{transferId} | Retrieve a transfer |
22
+ | [**get_bank_account_transfers**](BankAccountsApi.md#get_bank_account_transfers) | **GET** /v1/bankaccounts/{bankAccountId}/transfers | Retrieve all transfers |
23
+ | [**get_bank_account_withdrawal_by_id**](BankAccountsApi.md#get_bank_account_withdrawal_by_id) | **GET** /v1/bankaccounts/{bankAccountId}/withdrawals/{withdrawalId} | Retrieve a withdrawal |
24
+ | [**get_bank_account_withdrawals**](BankAccountsApi.md#get_bank_account_withdrawals) | **GET** /v1/bankaccounts/{bankAccountId}/withdrawals | Retrieve all withdrawals |
25
+ | [**get_check_for_bank_account**](BankAccountsApi.md#get_check_for_bank_account) | **GET** /v1/bankaccounts/{bankAccountId}/checks/{checkId} | Retrieve a check |
26
+ | [**get_quick_deposit_by_id**](BankAccountsApi.md#get_quick_deposit_by_id) | **GET** /v1/bankaccounts/{bankAccountId}/quickdeposits/{quickDepositId} | Retrieve a quick deposit |
27
+ | [**get_undeposited_funds**](BankAccountsApi.md#get_undeposited_funds) | **GET** /v1/bankaccounts/{bankAccountId}/undepositedfunds | Retrieve all undeposited funds |
28
+ | [**update_bank_account**](BankAccountsApi.md#update_bank_account) | **PUT** /v1/bankaccounts/{bankAccountId} | Update a bank account |
29
+ | [**update_bank_account_deposit**](BankAccountsApi.md#update_bank_account_deposit) | **PUT** /v1/bankaccounts/{bankAccountId}/deposits/{depositId} | Update a deposit |
30
+ | [**update_bank_account_transfer**](BankAccountsApi.md#update_bank_account_transfer) | **PUT** /v1/bankaccounts/{bankAccountId}/transfers/{transferId} | Update a transfer |
31
+ | [**update_bank_account_withdrawal**](BankAccountsApi.md#update_bank_account_withdrawal) | **PUT** /v1/bankaccounts/{bankAccountId}/withdrawals/{withdrawalId} | Update a withdrawal |
32
+ | [**update_check_for_bank_account**](BankAccountsApi.md#update_check_for_bank_account) | **PUT** /v1/bankaccounts/{bankAccountId}/checks/{checkId} | Update a check |
33
+ | [**update_quick_deposit**](BankAccountsApi.md#update_quick_deposit) | **PUT** /v1/bankaccounts/{bankAccountId}/quickdeposits/{quickDepositId} | Update a quick deposit |
34
+
35
+
36
+ ## create_bank_account
37
+
38
+ > <BankAccountMessage> create_bank_account(bank_account_post_message)
39
+
40
+ Create a bank account
41
+
42
+ Creates a bank account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Banking</span> - `View` `Edit`
43
+
44
+ ### Examples
45
+
46
+ ```ruby
47
+ require 'time'
48
+ require 'buildium-ruby'
49
+ # setup authorization
50
+ Buildium.configure do |config|
51
+ # Configure API key authorization: clientId
52
+ config.api_key['clientId'] = 'YOUR API KEY'
53
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
54
+ # config.api_key_prefix['clientId'] = 'Bearer'
55
+
56
+ # Configure API key authorization: clientSecret
57
+ config.api_key['clientSecret'] = 'YOUR API KEY'
58
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
59
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
60
+ end
61
+
62
+ api_instance = Buildium::BankAccountsApi.new
63
+ bank_account_post_message = Buildium::BankAccountPostMessage.new({name: 'name_example', bank_account_type: 'Checking', country: 'UnitedStates'}) # BankAccountPostMessage |
64
+
65
+ begin
66
+ # Create a bank account
67
+ result = api_instance.create_bank_account(bank_account_post_message)
68
+ p result
69
+ rescue Buildium::ApiError => e
70
+ puts "Error when calling BankAccountsApi->create_bank_account: #{e}"
71
+ end
72
+ ```
73
+
74
+ #### Using the create_bank_account_with_http_info variant
75
+
76
+ This returns an Array which contains the response data, status code and headers.
77
+
78
+ > <Array(<BankAccountMessage>, Integer, Hash)> create_bank_account_with_http_info(bank_account_post_message)
79
+
80
+ ```ruby
81
+ begin
82
+ # Create a bank account
83
+ data, status_code, headers = api_instance.create_bank_account_with_http_info(bank_account_post_message)
84
+ p status_code # => 2xx
85
+ p headers # => { ... }
86
+ p data # => <BankAccountMessage>
87
+ rescue Buildium::ApiError => e
88
+ puts "Error when calling BankAccountsApi->create_bank_account_with_http_info: #{e}"
89
+ end
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ | Name | Type | Description | Notes |
95
+ | ---- | ---- | ----------- | ----- |
96
+ | **bank_account_post_message** | [**BankAccountPostMessage**](BankAccountPostMessage.md) | | |
97
+
98
+ ### Return type
99
+
100
+ [**BankAccountMessage**](BankAccountMessage.md)
101
+
102
+ ### Authorization
103
+
104
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
105
+
106
+ ### HTTP request headers
107
+
108
+ - **Content-Type**: application/json
109
+ - **Accept**: application/json
110
+
111
+
112
+ ## create_bank_account_check
113
+
114
+ > <BankAccountCheckMessage> create_bank_account_check(bank_account_id, bank_account_check_post_message)
115
+
116
+ Create a check
117
+
118
+ Creates a check. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
119
+
120
+ ### Examples
121
+
122
+ ```ruby
123
+ require 'time'
124
+ require 'buildium-ruby'
125
+ # setup authorization
126
+ Buildium.configure do |config|
127
+ # Configure API key authorization: clientId
128
+ config.api_key['clientId'] = 'YOUR API KEY'
129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
130
+ # config.api_key_prefix['clientId'] = 'Bearer'
131
+
132
+ # Configure API key authorization: clientSecret
133
+ config.api_key['clientSecret'] = 'YOUR API KEY'
134
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
135
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
136
+ end
137
+
138
+ api_instance = Buildium::BankAccountsApi.new
139
+ bank_account_id = 56 # Integer |
140
+ bank_account_check_post_message = Buildium::BankAccountCheckPostMessage.new({payee: Buildium::BankAccountCheckPayeeSaveMessage.new({id: 37, type: 'Vendor'}), entry_date: Date.today, lines: [Buildium::BankAccountCheckLineSaveMessage.new({gl_account_id: 37, accounting_entity: Buildium::BankAccountCheckAccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'}), amount: 3.56})]}) # BankAccountCheckPostMessage |
141
+
142
+ begin
143
+ # Create a check
144
+ result = api_instance.create_bank_account_check(bank_account_id, bank_account_check_post_message)
145
+ p result
146
+ rescue Buildium::ApiError => e
147
+ puts "Error when calling BankAccountsApi->create_bank_account_check: #{e}"
148
+ end
149
+ ```
150
+
151
+ #### Using the create_bank_account_check_with_http_info variant
152
+
153
+ This returns an Array which contains the response data, status code and headers.
154
+
155
+ > <Array(<BankAccountCheckMessage>, Integer, Hash)> create_bank_account_check_with_http_info(bank_account_id, bank_account_check_post_message)
156
+
157
+ ```ruby
158
+ begin
159
+ # Create a check
160
+ data, status_code, headers = api_instance.create_bank_account_check_with_http_info(bank_account_id, bank_account_check_post_message)
161
+ p status_code # => 2xx
162
+ p headers # => { ... }
163
+ p data # => <BankAccountCheckMessage>
164
+ rescue Buildium::ApiError => e
165
+ puts "Error when calling BankAccountsApi->create_bank_account_check_with_http_info: #{e}"
166
+ end
167
+ ```
168
+
169
+ ### Parameters
170
+
171
+ | Name | Type | Description | Notes |
172
+ | ---- | ---- | ----------- | ----- |
173
+ | **bank_account_id** | **Integer** | | |
174
+ | **bank_account_check_post_message** | [**BankAccountCheckPostMessage**](BankAccountCheckPostMessage.md) | | |
175
+
176
+ ### Return type
177
+
178
+ [**BankAccountCheckMessage**](BankAccountCheckMessage.md)
179
+
180
+ ### Authorization
181
+
182
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
183
+
184
+ ### HTTP request headers
185
+
186
+ - **Content-Type**: application/json
187
+ - **Accept**: application/json
188
+
189
+
190
+ ## create_bank_account_deposit
191
+
192
+ > <BankAccountDepositMessage> create_bank_account_deposit(bank_account_id, bank_account_deposit_post_message)
193
+
194
+ Create a deposit
195
+
196
+ Creates a deposit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
197
+
198
+ ### Examples
199
+
200
+ ```ruby
201
+ require 'time'
202
+ require 'buildium-ruby'
203
+ # setup authorization
204
+ Buildium.configure do |config|
205
+ # Configure API key authorization: clientId
206
+ config.api_key['clientId'] = 'YOUR API KEY'
207
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
+ # config.api_key_prefix['clientId'] = 'Bearer'
209
+
210
+ # Configure API key authorization: clientSecret
211
+ config.api_key['clientSecret'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = Buildium::BankAccountsApi.new
217
+ bank_account_id = 56 # Integer |
218
+ bank_account_deposit_post_message = Buildium::BankAccountDepositPostMessage.new({entry_date: Date.today}) # BankAccountDepositPostMessage |
219
+
220
+ begin
221
+ # Create a deposit
222
+ result = api_instance.create_bank_account_deposit(bank_account_id, bank_account_deposit_post_message)
223
+ p result
224
+ rescue Buildium::ApiError => e
225
+ puts "Error when calling BankAccountsApi->create_bank_account_deposit: #{e}"
226
+ end
227
+ ```
228
+
229
+ #### Using the create_bank_account_deposit_with_http_info variant
230
+
231
+ This returns an Array which contains the response data, status code and headers.
232
+
233
+ > <Array(<BankAccountDepositMessage>, Integer, Hash)> create_bank_account_deposit_with_http_info(bank_account_id, bank_account_deposit_post_message)
234
+
235
+ ```ruby
236
+ begin
237
+ # Create a deposit
238
+ data, status_code, headers = api_instance.create_bank_account_deposit_with_http_info(bank_account_id, bank_account_deposit_post_message)
239
+ p status_code # => 2xx
240
+ p headers # => { ... }
241
+ p data # => <BankAccountDepositMessage>
242
+ rescue Buildium::ApiError => e
243
+ puts "Error when calling BankAccountsApi->create_bank_account_deposit_with_http_info: #{e}"
244
+ end
245
+ ```
246
+
247
+ ### Parameters
248
+
249
+ | Name | Type | Description | Notes |
250
+ | ---- | ---- | ----------- | ----- |
251
+ | **bank_account_id** | **Integer** | | |
252
+ | **bank_account_deposit_post_message** | [**BankAccountDepositPostMessage**](BankAccountDepositPostMessage.md) | | |
253
+
254
+ ### Return type
255
+
256
+ [**BankAccountDepositMessage**](BankAccountDepositMessage.md)
257
+
258
+ ### Authorization
259
+
260
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: application/json
265
+ - **Accept**: application/json
266
+
267
+
268
+ ## create_bank_account_transfer
269
+
270
+ > <BankAccountTransferMessage> create_bank_account_transfer(bank_account_id, bank_account_transfer_save_message)
271
+
272
+ Create a transfer
273
+
274
+ Creates a bank account transfer. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
275
+
276
+ ### Examples
277
+
278
+ ```ruby
279
+ require 'time'
280
+ require 'buildium-ruby'
281
+ # setup authorization
282
+ Buildium.configure do |config|
283
+ # Configure API key authorization: clientId
284
+ config.api_key['clientId'] = 'YOUR API KEY'
285
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
286
+ # config.api_key_prefix['clientId'] = 'Bearer'
287
+
288
+ # Configure API key authorization: clientSecret
289
+ config.api_key['clientSecret'] = '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['clientSecret'] = 'Bearer'
292
+ end
293
+
294
+ api_instance = Buildium::BankAccountsApi.new
295
+ bank_account_id = 56 # Integer |
296
+ bank_account_transfer_save_message = Buildium::BankAccountTransferSaveMessage.new({entry_date: Date.today, transfer_to_bank_account_id: 37, total_amount: 3.56, accounting_entity: Buildium::BankAccountTransferAccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountTransferSaveMessage |
297
+
298
+ begin
299
+ # Create a transfer
300
+ result = api_instance.create_bank_account_transfer(bank_account_id, bank_account_transfer_save_message)
301
+ p result
302
+ rescue Buildium::ApiError => e
303
+ puts "Error when calling BankAccountsApi->create_bank_account_transfer: #{e}"
304
+ end
305
+ ```
306
+
307
+ #### Using the create_bank_account_transfer_with_http_info variant
308
+
309
+ This returns an Array which contains the response data, status code and headers.
310
+
311
+ > <Array(<BankAccountTransferMessage>, Integer, Hash)> create_bank_account_transfer_with_http_info(bank_account_id, bank_account_transfer_save_message)
312
+
313
+ ```ruby
314
+ begin
315
+ # Create a transfer
316
+ data, status_code, headers = api_instance.create_bank_account_transfer_with_http_info(bank_account_id, bank_account_transfer_save_message)
317
+ p status_code # => 2xx
318
+ p headers # => { ... }
319
+ p data # => <BankAccountTransferMessage>
320
+ rescue Buildium::ApiError => e
321
+ puts "Error when calling BankAccountsApi->create_bank_account_transfer_with_http_info: #{e}"
322
+ end
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ | Name | Type | Description | Notes |
328
+ | ---- | ---- | ----------- | ----- |
329
+ | **bank_account_id** | **Integer** | | |
330
+ | **bank_account_transfer_save_message** | [**BankAccountTransferSaveMessage**](BankAccountTransferSaveMessage.md) | | |
331
+
332
+ ### Return type
333
+
334
+ [**BankAccountTransferMessage**](BankAccountTransferMessage.md)
335
+
336
+ ### Authorization
337
+
338
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
339
+
340
+ ### HTTP request headers
341
+
342
+ - **Content-Type**: application/json
343
+ - **Accept**: application/json
344
+
345
+
346
+ ## create_quick_deposit
347
+
348
+ > <BankAccountQuickDepositMessage> create_quick_deposit(bank_account_id, bank_account_quick_deposit_save_message)
349
+
350
+ Create a quick deposit
351
+
352
+ Creates a quick deposit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View` `Edit`
353
+
354
+ ### Examples
355
+
356
+ ```ruby
357
+ require 'time'
358
+ require 'buildium-ruby'
359
+ # setup authorization
360
+ Buildium.configure do |config|
361
+ # Configure API key authorization: clientId
362
+ config.api_key['clientId'] = 'YOUR API KEY'
363
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
364
+ # config.api_key_prefix['clientId'] = 'Bearer'
365
+
366
+ # Configure API key authorization: clientSecret
367
+ config.api_key['clientSecret'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = Buildium::BankAccountsApi.new
373
+ bank_account_id = 56 # Integer |
374
+ bank_account_quick_deposit_save_message = Buildium::BankAccountQuickDepositSaveMessage.new({entry_date: Date.today, offset_gl_account_id: 37, amount: 3.56, accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountQuickDepositSaveMessage |
375
+
376
+ begin
377
+ # Create a quick deposit
378
+ result = api_instance.create_quick_deposit(bank_account_id, bank_account_quick_deposit_save_message)
379
+ p result
380
+ rescue Buildium::ApiError => e
381
+ puts "Error when calling BankAccountsApi->create_quick_deposit: #{e}"
382
+ end
383
+ ```
384
+
385
+ #### Using the create_quick_deposit_with_http_info variant
386
+
387
+ This returns an Array which contains the response data, status code and headers.
388
+
389
+ > <Array(<BankAccountQuickDepositMessage>, Integer, Hash)> create_quick_deposit_with_http_info(bank_account_id, bank_account_quick_deposit_save_message)
390
+
391
+ ```ruby
392
+ begin
393
+ # Create a quick deposit
394
+ data, status_code, headers = api_instance.create_quick_deposit_with_http_info(bank_account_id, bank_account_quick_deposit_save_message)
395
+ p status_code # => 2xx
396
+ p headers # => { ... }
397
+ p data # => <BankAccountQuickDepositMessage>
398
+ rescue Buildium::ApiError => e
399
+ puts "Error when calling BankAccountsApi->create_quick_deposit_with_http_info: #{e}"
400
+ end
401
+ ```
402
+
403
+ ### Parameters
404
+
405
+ | Name | Type | Description | Notes |
406
+ | ---- | ---- | ----------- | ----- |
407
+ | **bank_account_id** | **Integer** | | |
408
+ | **bank_account_quick_deposit_save_message** | [**BankAccountQuickDepositSaveMessage**](BankAccountQuickDepositSaveMessage.md) | | |
409
+
410
+ ### Return type
411
+
412
+ [**BankAccountQuickDepositMessage**](BankAccountQuickDepositMessage.md)
413
+
414
+ ### Authorization
415
+
416
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
417
+
418
+ ### HTTP request headers
419
+
420
+ - **Content-Type**: application/json
421
+ - **Accept**: application/json
422
+
423
+
424
+ ## create_withdrawal_for_bank_account
425
+
426
+ > <BankAccountWithdrawalMessage> create_withdrawal_for_bank_account(bank_account_id, bank_account_withdrawal_save_message)
427
+
428
+ Create a withdrawal
429
+
430
+ Creates a bank account withdrawal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
431
+
432
+ ### Examples
433
+
434
+ ```ruby
435
+ require 'time'
436
+ require 'buildium-ruby'
437
+ # setup authorization
438
+ Buildium.configure do |config|
439
+ # Configure API key authorization: clientId
440
+ config.api_key['clientId'] = 'YOUR API KEY'
441
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
442
+ # config.api_key_prefix['clientId'] = 'Bearer'
443
+
444
+ # Configure API key authorization: clientSecret
445
+ config.api_key['clientSecret'] = 'YOUR API KEY'
446
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
447
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
448
+ end
449
+
450
+ api_instance = Buildium::BankAccountsApi.new
451
+ bank_account_id = 56 # Integer |
452
+ bank_account_withdrawal_save_message = Buildium::BankAccountWithdrawalSaveMessage.new({entry_date: Date.today, offset_gl_account_id: 37, amount: 3.56, accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountWithdrawalSaveMessage |
453
+
454
+ begin
455
+ # Create a withdrawal
456
+ result = api_instance.create_withdrawal_for_bank_account(bank_account_id, bank_account_withdrawal_save_message)
457
+ p result
458
+ rescue Buildium::ApiError => e
459
+ puts "Error when calling BankAccountsApi->create_withdrawal_for_bank_account: #{e}"
460
+ end
461
+ ```
462
+
463
+ #### Using the create_withdrawal_for_bank_account_with_http_info variant
464
+
465
+ This returns an Array which contains the response data, status code and headers.
466
+
467
+ > <Array(<BankAccountWithdrawalMessage>, Integer, Hash)> create_withdrawal_for_bank_account_with_http_info(bank_account_id, bank_account_withdrawal_save_message)
468
+
469
+ ```ruby
470
+ begin
471
+ # Create a withdrawal
472
+ data, status_code, headers = api_instance.create_withdrawal_for_bank_account_with_http_info(bank_account_id, bank_account_withdrawal_save_message)
473
+ p status_code # => 2xx
474
+ p headers # => { ... }
475
+ p data # => <BankAccountWithdrawalMessage>
476
+ rescue Buildium::ApiError => e
477
+ puts "Error when calling BankAccountsApi->create_withdrawal_for_bank_account_with_http_info: #{e}"
478
+ end
479
+ ```
480
+
481
+ ### Parameters
482
+
483
+ | Name | Type | Description | Notes |
484
+ | ---- | ---- | ----------- | ----- |
485
+ | **bank_account_id** | **Integer** | | |
486
+ | **bank_account_withdrawal_save_message** | [**BankAccountWithdrawalSaveMessage**](BankAccountWithdrawalSaveMessage.md) | | |
487
+
488
+ ### Return type
489
+
490
+ [**BankAccountWithdrawalMessage**](BankAccountWithdrawalMessage.md)
491
+
492
+ ### Authorization
493
+
494
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: application/json
499
+ - **Accept**: application/json
500
+
501
+
502
+ ## get_all_bank_accounts
503
+
504
+ > <Array<BankAccountMessage>> get_all_bank_accounts(opts)
505
+
506
+ Retrieve all bank accounts
507
+
508
+ Retrieves a list of bank accounts. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
509
+
510
+ ### Examples
511
+
512
+ ```ruby
513
+ require 'time'
514
+ require 'buildium-ruby'
515
+ # setup authorization
516
+ Buildium.configure do |config|
517
+ # Configure API key authorization: clientId
518
+ config.api_key['clientId'] = 'YOUR API KEY'
519
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
520
+ # config.api_key_prefix['clientId'] = 'Bearer'
521
+
522
+ # Configure API key authorization: clientSecret
523
+ config.api_key['clientSecret'] = 'YOUR API KEY'
524
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
525
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
526
+ end
527
+
528
+ api_instance = Buildium::BankAccountsApi.new
529
+ opts = {
530
+ bankaccountstatus: 'Active', # String | Filters results by the status of the bank account. If no status is specified, bank accounts with any status will be returned.
531
+ bankname: 'bankname_example', # String | Filters results to any bank account whose name *contains* the specified value.
532
+ 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.
533
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
534
+ 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.
535
+ }
536
+
537
+ begin
538
+ # Retrieve all bank accounts
539
+ result = api_instance.get_all_bank_accounts(opts)
540
+ p result
541
+ rescue Buildium::ApiError => e
542
+ puts "Error when calling BankAccountsApi->get_all_bank_accounts: #{e}"
543
+ end
544
+ ```
545
+
546
+ #### Using the get_all_bank_accounts_with_http_info variant
547
+
548
+ This returns an Array which contains the response data, status code and headers.
549
+
550
+ > <Array(<Array<BankAccountMessage>>, Integer, Hash)> get_all_bank_accounts_with_http_info(opts)
551
+
552
+ ```ruby
553
+ begin
554
+ # Retrieve all bank accounts
555
+ data, status_code, headers = api_instance.get_all_bank_accounts_with_http_info(opts)
556
+ p status_code # => 2xx
557
+ p headers # => { ... }
558
+ p data # => <Array<BankAccountMessage>>
559
+ rescue Buildium::ApiError => e
560
+ puts "Error when calling BankAccountsApi->get_all_bank_accounts_with_http_info: #{e}"
561
+ end
562
+ ```
563
+
564
+ ### Parameters
565
+
566
+ | Name | Type | Description | Notes |
567
+ | ---- | ---- | ----------- | ----- |
568
+ | **bankaccountstatus** | **String** | Filters results by the status of the bank account. If no status is specified, bank accounts with any status will be returned. | [optional] |
569
+ | **bankname** | **String** | Filters results to any bank account whose name *contains* the specified value. | [optional] |
570
+ | **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] |
571
+ | **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] |
572
+ | **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] |
573
+
574
+ ### Return type
575
+
576
+ [**Array&lt;BankAccountMessage&gt;**](BankAccountMessage.md)
577
+
578
+ ### Authorization
579
+
580
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
581
+
582
+ ### HTTP request headers
583
+
584
+ - **Content-Type**: Not defined
585
+ - **Accept**: application/json
586
+
587
+
588
+ ## get_all_quick_deposits
589
+
590
+ > <Array<BankAccountQuickDepositMessage>> get_all_quick_deposits(bank_account_id, startdate, enddate, opts)
591
+
592
+ Retrieve all quick deposits
593
+
594
+ Retrieves all quick deposits. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View`
595
+
596
+ ### Examples
597
+
598
+ ```ruby
599
+ require 'time'
600
+ require 'buildium-ruby'
601
+ # setup authorization
602
+ Buildium.configure do |config|
603
+ # Configure API key authorization: clientId
604
+ config.api_key['clientId'] = 'YOUR API KEY'
605
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
606
+ # config.api_key_prefix['clientId'] = 'Bearer'
607
+
608
+ # Configure API key authorization: clientSecret
609
+ config.api_key['clientSecret'] = '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['clientSecret'] = 'Bearer'
612
+ end
613
+
614
+ api_instance = Buildium::BankAccountsApi.new
615
+ bank_account_id = 56 # Integer |
616
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
617
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
618
+ opts = {
619
+ 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.
620
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
621
+ 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.
622
+ }
623
+
624
+ begin
625
+ # Retrieve all quick deposits
626
+ result = api_instance.get_all_quick_deposits(bank_account_id, startdate, enddate, opts)
627
+ p result
628
+ rescue Buildium::ApiError => e
629
+ puts "Error when calling BankAccountsApi->get_all_quick_deposits: #{e}"
630
+ end
631
+ ```
632
+
633
+ #### Using the get_all_quick_deposits_with_http_info variant
634
+
635
+ This returns an Array which contains the response data, status code and headers.
636
+
637
+ > <Array(<Array<BankAccountQuickDepositMessage>>, Integer, Hash)> get_all_quick_deposits_with_http_info(bank_account_id, startdate, enddate, opts)
638
+
639
+ ```ruby
640
+ begin
641
+ # Retrieve all quick deposits
642
+ data, status_code, headers = api_instance.get_all_quick_deposits_with_http_info(bank_account_id, startdate, enddate, opts)
643
+ p status_code # => 2xx
644
+ p headers # => { ... }
645
+ p data # => <Array<BankAccountQuickDepositMessage>>
646
+ rescue Buildium::ApiError => e
647
+ puts "Error when calling BankAccountsApi->get_all_quick_deposits_with_http_info: #{e}"
648
+ end
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ | Name | Type | Description | Notes |
654
+ | ---- | ---- | ----------- | ----- |
655
+ | **bank_account_id** | **Integer** | | |
656
+ | **startdate** | **Date** | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
657
+ | **enddate** | **Date** | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
658
+ | **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] |
659
+ | **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] |
660
+ | **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] |
661
+
662
+ ### Return type
663
+
664
+ [**Array&lt;BankAccountQuickDepositMessage&gt;**](BankAccountQuickDepositMessage.md)
665
+
666
+ ### Authorization
667
+
668
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
669
+
670
+ ### HTTP request headers
671
+
672
+ - **Content-Type**: Not defined
673
+ - **Accept**: application/json
674
+
675
+
676
+ ## get_bank_account
677
+
678
+ > <BankAccountMessage> get_bank_account(bank_account_id)
679
+
680
+ Retrieve a bank account
681
+
682
+ Retrieves a specific bank account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
683
+
684
+ ### Examples
685
+
686
+ ```ruby
687
+ require 'time'
688
+ require 'buildium-ruby'
689
+ # setup authorization
690
+ Buildium.configure do |config|
691
+ # Configure API key authorization: clientId
692
+ config.api_key['clientId'] = 'YOUR API KEY'
693
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
694
+ # config.api_key_prefix['clientId'] = 'Bearer'
695
+
696
+ # Configure API key authorization: clientSecret
697
+ config.api_key['clientSecret'] = 'YOUR API KEY'
698
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
699
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
700
+ end
701
+
702
+ api_instance = Buildium::BankAccountsApi.new
703
+ bank_account_id = 56 # Integer | The bank account identifier.
704
+
705
+ begin
706
+ # Retrieve a bank account
707
+ result = api_instance.get_bank_account(bank_account_id)
708
+ p result
709
+ rescue Buildium::ApiError => e
710
+ puts "Error when calling BankAccountsApi->get_bank_account: #{e}"
711
+ end
712
+ ```
713
+
714
+ #### Using the get_bank_account_with_http_info variant
715
+
716
+ This returns an Array which contains the response data, status code and headers.
717
+
718
+ > <Array(<BankAccountMessage>, Integer, Hash)> get_bank_account_with_http_info(bank_account_id)
719
+
720
+ ```ruby
721
+ begin
722
+ # Retrieve a bank account
723
+ data, status_code, headers = api_instance.get_bank_account_with_http_info(bank_account_id)
724
+ p status_code # => 2xx
725
+ p headers # => { ... }
726
+ p data # => <BankAccountMessage>
727
+ rescue Buildium::ApiError => e
728
+ puts "Error when calling BankAccountsApi->get_bank_account_with_http_info: #{e}"
729
+ end
730
+ ```
731
+
732
+ ### Parameters
733
+
734
+ | Name | Type | Description | Notes |
735
+ | ---- | ---- | ----------- | ----- |
736
+ | **bank_account_id** | **Integer** | The bank account identifier. | |
737
+
738
+ ### Return type
739
+
740
+ [**BankAccountMessage**](BankAccountMessage.md)
741
+
742
+ ### Authorization
743
+
744
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
745
+
746
+ ### HTTP request headers
747
+
748
+ - **Content-Type**: Not defined
749
+ - **Accept**: application/json
750
+
751
+
752
+ ## get_bank_account_checks
753
+
754
+ > <Array<BankAccountCheckMessage>> get_bank_account_checks(bank_account_id, startdate, enddate, opts)
755
+
756
+ Retrieve all checks
757
+
758
+ Retrieves all bank account checks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` <br /><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` <span class=\"permissionBlock\">(Required for checks associated with a Company) </span>
759
+
760
+ ### Examples
761
+
762
+ ```ruby
763
+ require 'time'
764
+ require 'buildium-ruby'
765
+ # setup authorization
766
+ Buildium.configure do |config|
767
+ # Configure API key authorization: clientId
768
+ config.api_key['clientId'] = 'YOUR API KEY'
769
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
770
+ # config.api_key_prefix['clientId'] = 'Bearer'
771
+
772
+ # Configure API key authorization: clientSecret
773
+ config.api_key['clientSecret'] = 'YOUR API KEY'
774
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
775
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
776
+ end
777
+
778
+ api_instance = Buildium::BankAccountsApi.new
779
+ bank_account_id = 56 # Integer |
780
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
781
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
782
+ opts = {
783
+ 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.
784
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
785
+ 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.
786
+ }
787
+
788
+ begin
789
+ # Retrieve all checks
790
+ result = api_instance.get_bank_account_checks(bank_account_id, startdate, enddate, opts)
791
+ p result
792
+ rescue Buildium::ApiError => e
793
+ puts "Error when calling BankAccountsApi->get_bank_account_checks: #{e}"
794
+ end
795
+ ```
796
+
797
+ #### Using the get_bank_account_checks_with_http_info variant
798
+
799
+ This returns an Array which contains the response data, status code and headers.
800
+
801
+ > <Array(<Array<BankAccountCheckMessage>>, Integer, Hash)> get_bank_account_checks_with_http_info(bank_account_id, startdate, enddate, opts)
802
+
803
+ ```ruby
804
+ begin
805
+ # Retrieve all checks
806
+ data, status_code, headers = api_instance.get_bank_account_checks_with_http_info(bank_account_id, startdate, enddate, opts)
807
+ p status_code # => 2xx
808
+ p headers # => { ... }
809
+ p data # => <Array<BankAccountCheckMessage>>
810
+ rescue Buildium::ApiError => e
811
+ puts "Error when calling BankAccountsApi->get_bank_account_checks_with_http_info: #{e}"
812
+ end
813
+ ```
814
+
815
+ ### Parameters
816
+
817
+ | Name | Type | Description | Notes |
818
+ | ---- | ---- | ----------- | ----- |
819
+ | **bank_account_id** | **Integer** | | |
820
+ | **startdate** | **Date** | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
821
+ | **enddate** | **Date** | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
822
+ | **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] |
823
+ | **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] |
824
+ | **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] |
825
+
826
+ ### Return type
827
+
828
+ [**Array&lt;BankAccountCheckMessage&gt;**](BankAccountCheckMessage.md)
829
+
830
+ ### Authorization
831
+
832
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
833
+
834
+ ### HTTP request headers
835
+
836
+ - **Content-Type**: Not defined
837
+ - **Accept**: application/json
838
+
839
+
840
+ ## get_bank_account_deposit_by_id
841
+
842
+ > <BankAccountDepositMessage> get_bank_account_deposit_by_id(bank_account_id, deposit_id)
843
+
844
+ Retrieve a deposit
845
+
846
+ Retrieves a bank account deposit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View` <br /><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` <span class=\"permissionBlock\">(Required for deposits associated with a Company) </span>
847
+
848
+ ### Examples
849
+
850
+ ```ruby
851
+ require 'time'
852
+ require 'buildium-ruby'
853
+ # setup authorization
854
+ Buildium.configure do |config|
855
+ # Configure API key authorization: clientId
856
+ config.api_key['clientId'] = 'YOUR API KEY'
857
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
858
+ # config.api_key_prefix['clientId'] = 'Bearer'
859
+
860
+ # Configure API key authorization: clientSecret
861
+ config.api_key['clientSecret'] = 'YOUR API KEY'
862
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
863
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
864
+ end
865
+
866
+ api_instance = Buildium::BankAccountsApi.new
867
+ bank_account_id = 56 # Integer |
868
+ deposit_id = 56 # Integer |
869
+
870
+ begin
871
+ # Retrieve a deposit
872
+ result = api_instance.get_bank_account_deposit_by_id(bank_account_id, deposit_id)
873
+ p result
874
+ rescue Buildium::ApiError => e
875
+ puts "Error when calling BankAccountsApi->get_bank_account_deposit_by_id: #{e}"
876
+ end
877
+ ```
878
+
879
+ #### Using the get_bank_account_deposit_by_id_with_http_info variant
880
+
881
+ This returns an Array which contains the response data, status code and headers.
882
+
883
+ > <Array(<BankAccountDepositMessage>, Integer, Hash)> get_bank_account_deposit_by_id_with_http_info(bank_account_id, deposit_id)
884
+
885
+ ```ruby
886
+ begin
887
+ # Retrieve a deposit
888
+ data, status_code, headers = api_instance.get_bank_account_deposit_by_id_with_http_info(bank_account_id, deposit_id)
889
+ p status_code # => 2xx
890
+ p headers # => { ... }
891
+ p data # => <BankAccountDepositMessage>
892
+ rescue Buildium::ApiError => e
893
+ puts "Error when calling BankAccountsApi->get_bank_account_deposit_by_id_with_http_info: #{e}"
894
+ end
895
+ ```
896
+
897
+ ### Parameters
898
+
899
+ | Name | Type | Description | Notes |
900
+ | ---- | ---- | ----------- | ----- |
901
+ | **bank_account_id** | **Integer** | | |
902
+ | **deposit_id** | **Integer** | | |
903
+
904
+ ### Return type
905
+
906
+ [**BankAccountDepositMessage**](BankAccountDepositMessage.md)
907
+
908
+ ### Authorization
909
+
910
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
911
+
912
+ ### HTTP request headers
913
+
914
+ - **Content-Type**: Not defined
915
+ - **Accept**: application/json
916
+
917
+
918
+ ## get_bank_account_deposits
919
+
920
+ > <Array<BankAccountDepositMessage>> get_bank_account_deposits(bank_account_id, startdate, enddate, opts)
921
+
922
+ Retrieve all deposits
923
+
924
+ Retrieves all bank account deposits. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View` <br /><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` <span class=\"permissionBlock\">(Required for deposits associated with a Company) </span>
925
+
926
+ ### Examples
927
+
928
+ ```ruby
929
+ require 'time'
930
+ require 'buildium-ruby'
931
+ # setup authorization
932
+ Buildium.configure do |config|
933
+ # Configure API key authorization: clientId
934
+ config.api_key['clientId'] = 'YOUR API KEY'
935
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
936
+ # config.api_key_prefix['clientId'] = 'Bearer'
937
+
938
+ # Configure API key authorization: clientSecret
939
+ config.api_key['clientSecret'] = 'YOUR API KEY'
940
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
941
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
942
+ end
943
+
944
+ api_instance = Buildium::BankAccountsApi.new
945
+ bank_account_id = 56 # Integer |
946
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any deposits that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
947
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any deposits that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
948
+ opts = {
949
+ 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.
950
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
951
+ 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.
952
+ }
953
+
954
+ begin
955
+ # Retrieve all deposits
956
+ result = api_instance.get_bank_account_deposits(bank_account_id, startdate, enddate, opts)
957
+ p result
958
+ rescue Buildium::ApiError => e
959
+ puts "Error when calling BankAccountsApi->get_bank_account_deposits: #{e}"
960
+ end
961
+ ```
962
+
963
+ #### Using the get_bank_account_deposits_with_http_info variant
964
+
965
+ This returns an Array which contains the response data, status code and headers.
966
+
967
+ > <Array(<Array<BankAccountDepositMessage>>, Integer, Hash)> get_bank_account_deposits_with_http_info(bank_account_id, startdate, enddate, opts)
968
+
969
+ ```ruby
970
+ begin
971
+ # Retrieve all deposits
972
+ data, status_code, headers = api_instance.get_bank_account_deposits_with_http_info(bank_account_id, startdate, enddate, opts)
973
+ p status_code # => 2xx
974
+ p headers # => { ... }
975
+ p data # => <Array<BankAccountDepositMessage>>
976
+ rescue Buildium::ApiError => e
977
+ puts "Error when calling BankAccountsApi->get_bank_account_deposits_with_http_info: #{e}"
978
+ end
979
+ ```
980
+
981
+ ### Parameters
982
+
983
+ | Name | Type | Description | Notes |
984
+ | ---- | ---- | ----------- | ----- |
985
+ | **bank_account_id** | **Integer** | | |
986
+ | **startdate** | **Date** | Filters results to any deposits that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
987
+ | **enddate** | **Date** | Filters results to any deposits that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
988
+ | **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] |
989
+ | **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] |
990
+ | **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] |
991
+
992
+ ### Return type
993
+
994
+ [**Array&lt;BankAccountDepositMessage&gt;**](BankAccountDepositMessage.md)
995
+
996
+ ### Authorization
997
+
998
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
999
+
1000
+ ### HTTP request headers
1001
+
1002
+ - **Content-Type**: Not defined
1003
+ - **Accept**: application/json
1004
+
1005
+
1006
+ ## get_bank_account_transaction_by_id
1007
+
1008
+ > <BankAccountTransactionMessage> get_bank_account_transaction_by_id(bank_account_id, transaction_id)
1009
+
1010
+ Retrieve a transaction
1011
+
1012
+ Retrieves a specific bank account transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Account</span> - `View`
1013
+
1014
+ ### Examples
1015
+
1016
+ ```ruby
1017
+ require 'time'
1018
+ require 'buildium-ruby'
1019
+ # setup authorization
1020
+ Buildium.configure do |config|
1021
+ # Configure API key authorization: clientId
1022
+ config.api_key['clientId'] = 'YOUR API KEY'
1023
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1024
+ # config.api_key_prefix['clientId'] = 'Bearer'
1025
+
1026
+ # Configure API key authorization: clientSecret
1027
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1028
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1029
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1030
+ end
1031
+
1032
+ api_instance = Buildium::BankAccountsApi.new
1033
+ bank_account_id = 56 # Integer |
1034
+ transaction_id = 56 # Integer |
1035
+
1036
+ begin
1037
+ # Retrieve a transaction
1038
+ result = api_instance.get_bank_account_transaction_by_id(bank_account_id, transaction_id)
1039
+ p result
1040
+ rescue Buildium::ApiError => e
1041
+ puts "Error when calling BankAccountsApi->get_bank_account_transaction_by_id: #{e}"
1042
+ end
1043
+ ```
1044
+
1045
+ #### Using the get_bank_account_transaction_by_id_with_http_info variant
1046
+
1047
+ This returns an Array which contains the response data, status code and headers.
1048
+
1049
+ > <Array(<BankAccountTransactionMessage>, Integer, Hash)> get_bank_account_transaction_by_id_with_http_info(bank_account_id, transaction_id)
1050
+
1051
+ ```ruby
1052
+ begin
1053
+ # Retrieve a transaction
1054
+ data, status_code, headers = api_instance.get_bank_account_transaction_by_id_with_http_info(bank_account_id, transaction_id)
1055
+ p status_code # => 2xx
1056
+ p headers # => { ... }
1057
+ p data # => <BankAccountTransactionMessage>
1058
+ rescue Buildium::ApiError => e
1059
+ puts "Error when calling BankAccountsApi->get_bank_account_transaction_by_id_with_http_info: #{e}"
1060
+ end
1061
+ ```
1062
+
1063
+ ### Parameters
1064
+
1065
+ | Name | Type | Description | Notes |
1066
+ | ---- | ---- | ----------- | ----- |
1067
+ | **bank_account_id** | **Integer** | | |
1068
+ | **transaction_id** | **Integer** | | |
1069
+
1070
+ ### Return type
1071
+
1072
+ [**BankAccountTransactionMessage**](BankAccountTransactionMessage.md)
1073
+
1074
+ ### Authorization
1075
+
1076
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1077
+
1078
+ ### HTTP request headers
1079
+
1080
+ - **Content-Type**: Not defined
1081
+ - **Accept**: application/json
1082
+
1083
+
1084
+ ## get_bank_account_transactions
1085
+
1086
+ > <Array<BankAccountTransactionMessage>> get_bank_account_transactions(bank_account_id, startdate, enddate, opts)
1087
+
1088
+ Retrieve all transactions
1089
+
1090
+ Retrieves all bank account transactions. <br /><br /> Note: When using the `orderby` query string parameter, the only supported parameter is `EntryDate`. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
1091
+
1092
+ ### Examples
1093
+
1094
+ ```ruby
1095
+ require 'time'
1096
+ require 'buildium-ruby'
1097
+ # setup authorization
1098
+ Buildium.configure do |config|
1099
+ # Configure API key authorization: clientId
1100
+ config.api_key['clientId'] = 'YOUR API KEY'
1101
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1102
+ # config.api_key_prefix['clientId'] = 'Bearer'
1103
+
1104
+ # Configure API key authorization: clientSecret
1105
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1107
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1108
+ end
1109
+
1110
+ api_instance = Buildium::BankAccountsApi.new
1111
+ bank_account_id = 56 # Integer |
1112
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
1113
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
1114
+ opts = {
1115
+ selectionentityid: 56, # Integer | Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType.
1116
+ selectionentitytype: 'Company', # String | Specifies the type of entity that SelectionEntityId refers to.
1117
+ 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.
1118
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1119
+ 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.
1120
+ }
1121
+
1122
+ begin
1123
+ # Retrieve all transactions
1124
+ result = api_instance.get_bank_account_transactions(bank_account_id, startdate, enddate, opts)
1125
+ p result
1126
+ rescue Buildium::ApiError => e
1127
+ puts "Error when calling BankAccountsApi->get_bank_account_transactions: #{e}"
1128
+ end
1129
+ ```
1130
+
1131
+ #### Using the get_bank_account_transactions_with_http_info variant
1132
+
1133
+ This returns an Array which contains the response data, status code and headers.
1134
+
1135
+ > <Array(<Array<BankAccountTransactionMessage>>, Integer, Hash)> get_bank_account_transactions_with_http_info(bank_account_id, startdate, enddate, opts)
1136
+
1137
+ ```ruby
1138
+ begin
1139
+ # Retrieve all transactions
1140
+ data, status_code, headers = api_instance.get_bank_account_transactions_with_http_info(bank_account_id, startdate, enddate, opts)
1141
+ p status_code # => 2xx
1142
+ p headers # => { ... }
1143
+ p data # => <Array<BankAccountTransactionMessage>>
1144
+ rescue Buildium::ApiError => e
1145
+ puts "Error when calling BankAccountsApi->get_bank_account_transactions_with_http_info: #{e}"
1146
+ end
1147
+ ```
1148
+
1149
+ ### Parameters
1150
+
1151
+ | Name | Type | Description | Notes |
1152
+ | ---- | ---- | ----------- | ----- |
1153
+ | **bank_account_id** | **Integer** | | |
1154
+ | **startdate** | **Date** | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
1155
+ | **enddate** | **Date** | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
1156
+ | **selectionentityid** | **Integer** | Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType. | [optional] |
1157
+ | **selectionentitytype** | **String** | Specifies the type of entity that SelectionEntityId refers to. | [optional] |
1158
+ | **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] |
1159
+ | **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] |
1160
+ | **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] |
1161
+
1162
+ ### Return type
1163
+
1164
+ [**Array&lt;BankAccountTransactionMessage&gt;**](BankAccountTransactionMessage.md)
1165
+
1166
+ ### Authorization
1167
+
1168
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1169
+
1170
+ ### HTTP request headers
1171
+
1172
+ - **Content-Type**: Not defined
1173
+ - **Accept**: application/json
1174
+
1175
+
1176
+ ## get_bank_account_transfer_by_id
1177
+
1178
+ > <BankAccountMessage> get_bank_account_transfer_by_id(bank_account_id, transfer_id)
1179
+
1180
+ Retrieve a transfer
1181
+
1182
+ Retrieves a bank account transfer. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
1183
+
1184
+ ### Examples
1185
+
1186
+ ```ruby
1187
+ require 'time'
1188
+ require 'buildium-ruby'
1189
+ # setup authorization
1190
+ Buildium.configure do |config|
1191
+ # Configure API key authorization: clientId
1192
+ config.api_key['clientId'] = 'YOUR API KEY'
1193
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1194
+ # config.api_key_prefix['clientId'] = 'Bearer'
1195
+
1196
+ # Configure API key authorization: clientSecret
1197
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1198
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1199
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1200
+ end
1201
+
1202
+ api_instance = Buildium::BankAccountsApi.new
1203
+ bank_account_id = 56 # Integer | The bank account identifier.
1204
+ transfer_id = 56 # Integer | The transfer identifier.
1205
+
1206
+ begin
1207
+ # Retrieve a transfer
1208
+ result = api_instance.get_bank_account_transfer_by_id(bank_account_id, transfer_id)
1209
+ p result
1210
+ rescue Buildium::ApiError => e
1211
+ puts "Error when calling BankAccountsApi->get_bank_account_transfer_by_id: #{e}"
1212
+ end
1213
+ ```
1214
+
1215
+ #### Using the get_bank_account_transfer_by_id_with_http_info variant
1216
+
1217
+ This returns an Array which contains the response data, status code and headers.
1218
+
1219
+ > <Array(<BankAccountMessage>, Integer, Hash)> get_bank_account_transfer_by_id_with_http_info(bank_account_id, transfer_id)
1220
+
1221
+ ```ruby
1222
+ begin
1223
+ # Retrieve a transfer
1224
+ data, status_code, headers = api_instance.get_bank_account_transfer_by_id_with_http_info(bank_account_id, transfer_id)
1225
+ p status_code # => 2xx
1226
+ p headers # => { ... }
1227
+ p data # => <BankAccountMessage>
1228
+ rescue Buildium::ApiError => e
1229
+ puts "Error when calling BankAccountsApi->get_bank_account_transfer_by_id_with_http_info: #{e}"
1230
+ end
1231
+ ```
1232
+
1233
+ ### Parameters
1234
+
1235
+ | Name | Type | Description | Notes |
1236
+ | ---- | ---- | ----------- | ----- |
1237
+ | **bank_account_id** | **Integer** | The bank account identifier. | |
1238
+ | **transfer_id** | **Integer** | The transfer identifier. | |
1239
+
1240
+ ### Return type
1241
+
1242
+ [**BankAccountMessage**](BankAccountMessage.md)
1243
+
1244
+ ### Authorization
1245
+
1246
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1247
+
1248
+ ### HTTP request headers
1249
+
1250
+ - **Content-Type**: Not defined
1251
+ - **Accept**: application/json
1252
+
1253
+
1254
+ ## get_bank_account_transfers
1255
+
1256
+ > <Array<BankAccountTransferMessage>> get_bank_account_transfers(bank_account_id, startdate, enddate, opts)
1257
+
1258
+ Retrieve all transfers
1259
+
1260
+ Retrieves all bank account transfers. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View`
1261
+
1262
+ ### Examples
1263
+
1264
+ ```ruby
1265
+ require 'time'
1266
+ require 'buildium-ruby'
1267
+ # setup authorization
1268
+ Buildium.configure do |config|
1269
+ # Configure API key authorization: clientId
1270
+ config.api_key['clientId'] = 'YOUR API KEY'
1271
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1272
+ # config.api_key_prefix['clientId'] = 'Bearer'
1273
+
1274
+ # Configure API key authorization: clientSecret
1275
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1276
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1277
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1278
+ end
1279
+
1280
+ api_instance = Buildium::BankAccountsApi.new
1281
+ bank_account_id = 56 # Integer |
1282
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transfers that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
1283
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transfers that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
1284
+ opts = {
1285
+ 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.
1286
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1287
+ 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.
1288
+ }
1289
+
1290
+ begin
1291
+ # Retrieve all transfers
1292
+ result = api_instance.get_bank_account_transfers(bank_account_id, startdate, enddate, opts)
1293
+ p result
1294
+ rescue Buildium::ApiError => e
1295
+ puts "Error when calling BankAccountsApi->get_bank_account_transfers: #{e}"
1296
+ end
1297
+ ```
1298
+
1299
+ #### Using the get_bank_account_transfers_with_http_info variant
1300
+
1301
+ This returns an Array which contains the response data, status code and headers.
1302
+
1303
+ > <Array(<Array<BankAccountTransferMessage>>, Integer, Hash)> get_bank_account_transfers_with_http_info(bank_account_id, startdate, enddate, opts)
1304
+
1305
+ ```ruby
1306
+ begin
1307
+ # Retrieve all transfers
1308
+ data, status_code, headers = api_instance.get_bank_account_transfers_with_http_info(bank_account_id, startdate, enddate, opts)
1309
+ p status_code # => 2xx
1310
+ p headers # => { ... }
1311
+ p data # => <Array<BankAccountTransferMessage>>
1312
+ rescue Buildium::ApiError => e
1313
+ puts "Error when calling BankAccountsApi->get_bank_account_transfers_with_http_info: #{e}"
1314
+ end
1315
+ ```
1316
+
1317
+ ### Parameters
1318
+
1319
+ | Name | Type | Description | Notes |
1320
+ | ---- | ---- | ----------- | ----- |
1321
+ | **bank_account_id** | **Integer** | | |
1322
+ | **startdate** | **Date** | Filters results to any transfers that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
1323
+ | **enddate** | **Date** | Filters results to any transfers that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
1324
+ | **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] |
1325
+ | **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] |
1326
+ | **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] |
1327
+
1328
+ ### Return type
1329
+
1330
+ [**Array&lt;BankAccountTransferMessage&gt;**](BankAccountTransferMessage.md)
1331
+
1332
+ ### Authorization
1333
+
1334
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1335
+
1336
+ ### HTTP request headers
1337
+
1338
+ - **Content-Type**: Not defined
1339
+ - **Accept**: application/json
1340
+
1341
+
1342
+ ## get_bank_account_withdrawal_by_id
1343
+
1344
+ > <BankAccountWithdrawalMessage> get_bank_account_withdrawal_by_id(bank_account_id, withdrawal_id)
1345
+
1346
+ Retrieve a withdrawal
1347
+
1348
+ Retrieves a bank account withdrawal. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccounts</span> - `View`
1349
+
1350
+ ### Examples
1351
+
1352
+ ```ruby
1353
+ require 'time'
1354
+ require 'buildium-ruby'
1355
+ # setup authorization
1356
+ Buildium.configure do |config|
1357
+ # Configure API key authorization: clientId
1358
+ config.api_key['clientId'] = 'YOUR API KEY'
1359
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1360
+ # config.api_key_prefix['clientId'] = 'Bearer'
1361
+
1362
+ # Configure API key authorization: clientSecret
1363
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1364
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1365
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1366
+ end
1367
+
1368
+ api_instance = Buildium::BankAccountsApi.new
1369
+ bank_account_id = 56 # Integer |
1370
+ withdrawal_id = 56 # Integer |
1371
+
1372
+ begin
1373
+ # Retrieve a withdrawal
1374
+ result = api_instance.get_bank_account_withdrawal_by_id(bank_account_id, withdrawal_id)
1375
+ p result
1376
+ rescue Buildium::ApiError => e
1377
+ puts "Error when calling BankAccountsApi->get_bank_account_withdrawal_by_id: #{e}"
1378
+ end
1379
+ ```
1380
+
1381
+ #### Using the get_bank_account_withdrawal_by_id_with_http_info variant
1382
+
1383
+ This returns an Array which contains the response data, status code and headers.
1384
+
1385
+ > <Array(<BankAccountWithdrawalMessage>, Integer, Hash)> get_bank_account_withdrawal_by_id_with_http_info(bank_account_id, withdrawal_id)
1386
+
1387
+ ```ruby
1388
+ begin
1389
+ # Retrieve a withdrawal
1390
+ data, status_code, headers = api_instance.get_bank_account_withdrawal_by_id_with_http_info(bank_account_id, withdrawal_id)
1391
+ p status_code # => 2xx
1392
+ p headers # => { ... }
1393
+ p data # => <BankAccountWithdrawalMessage>
1394
+ rescue Buildium::ApiError => e
1395
+ puts "Error when calling BankAccountsApi->get_bank_account_withdrawal_by_id_with_http_info: #{e}"
1396
+ end
1397
+ ```
1398
+
1399
+ ### Parameters
1400
+
1401
+ | Name | Type | Description | Notes |
1402
+ | ---- | ---- | ----------- | ----- |
1403
+ | **bank_account_id** | **Integer** | | |
1404
+ | **withdrawal_id** | **Integer** | | |
1405
+
1406
+ ### Return type
1407
+
1408
+ [**BankAccountWithdrawalMessage**](BankAccountWithdrawalMessage.md)
1409
+
1410
+ ### Authorization
1411
+
1412
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1413
+
1414
+ ### HTTP request headers
1415
+
1416
+ - **Content-Type**: Not defined
1417
+ - **Accept**: application/json
1418
+
1419
+
1420
+ ## get_bank_account_withdrawals
1421
+
1422
+ > <Array<BankAccountWithdrawalMessage>> get_bank_account_withdrawals(bank_account_id, startdate, enddate, opts)
1423
+
1424
+ Retrieve all withdrawals
1425
+
1426
+ Retrieves all bank account withdrawals. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccounts</span> - `View`
1427
+
1428
+ ### Examples
1429
+
1430
+ ```ruby
1431
+ require 'time'
1432
+ require 'buildium-ruby'
1433
+ # setup authorization
1434
+ Buildium.configure do |config|
1435
+ # Configure API key authorization: clientId
1436
+ config.api_key['clientId'] = 'YOUR API KEY'
1437
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1438
+ # config.api_key_prefix['clientId'] = 'Bearer'
1439
+
1440
+ # Configure API key authorization: clientSecret
1441
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1442
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1443
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1444
+ end
1445
+
1446
+ api_instance = Buildium::BankAccountsApi.new
1447
+ bank_account_id = 56 # Integer |
1448
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD.
1449
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD.
1450
+ opts = {
1451
+ 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.
1452
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1453
+ 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.
1454
+ }
1455
+
1456
+ begin
1457
+ # Retrieve all withdrawals
1458
+ result = api_instance.get_bank_account_withdrawals(bank_account_id, startdate, enddate, opts)
1459
+ p result
1460
+ rescue Buildium::ApiError => e
1461
+ puts "Error when calling BankAccountsApi->get_bank_account_withdrawals: #{e}"
1462
+ end
1463
+ ```
1464
+
1465
+ #### Using the get_bank_account_withdrawals_with_http_info variant
1466
+
1467
+ This returns an Array which contains the response data, status code and headers.
1468
+
1469
+ > <Array(<Array<BankAccountWithdrawalMessage>>, Integer, Hash)> get_bank_account_withdrawals_with_http_info(bank_account_id, startdate, enddate, opts)
1470
+
1471
+ ```ruby
1472
+ begin
1473
+ # Retrieve all withdrawals
1474
+ data, status_code, headers = api_instance.get_bank_account_withdrawals_with_http_info(bank_account_id, startdate, enddate, opts)
1475
+ p status_code # => 2xx
1476
+ p headers # => { ... }
1477
+ p data # => <Array<BankAccountWithdrawalMessage>>
1478
+ rescue Buildium::ApiError => e
1479
+ puts "Error when calling BankAccountsApi->get_bank_account_withdrawals_with_http_info: #{e}"
1480
+ end
1481
+ ```
1482
+
1483
+ ### Parameters
1484
+
1485
+ | Name | Type | Description | Notes |
1486
+ | ---- | ---- | ----------- | ----- |
1487
+ | **bank_account_id** | **Integer** | | |
1488
+ | **startdate** | **Date** | Filters results to any transactions that were recorded on or after the specified date. The value must be formatted as YYYY-MM-DD. | |
1489
+ | **enddate** | **Date** | Filters results to any transactions that were recorded on or before the specified date. The value must be formatted as YYYY-MM-DD. | |
1490
+ | **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] |
1491
+ | **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] |
1492
+ | **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] |
1493
+
1494
+ ### Return type
1495
+
1496
+ [**Array&lt;BankAccountWithdrawalMessage&gt;**](BankAccountWithdrawalMessage.md)
1497
+
1498
+ ### Authorization
1499
+
1500
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1501
+
1502
+ ### HTTP request headers
1503
+
1504
+ - **Content-Type**: Not defined
1505
+ - **Accept**: application/json
1506
+
1507
+
1508
+ ## get_check_for_bank_account
1509
+
1510
+ > <BankAccountCheckMessage> get_check_for_bank_account(bank_account_id, check_id)
1511
+
1512
+ Retrieve a check
1513
+
1514
+ Retrieves a bank account check. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` <br /><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` <span class=\"permissionBlock\">(Required for checks associated with a Company) </span>
1515
+
1516
+ ### Examples
1517
+
1518
+ ```ruby
1519
+ require 'time'
1520
+ require 'buildium-ruby'
1521
+ # setup authorization
1522
+ Buildium.configure do |config|
1523
+ # Configure API key authorization: clientId
1524
+ config.api_key['clientId'] = 'YOUR API KEY'
1525
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1526
+ # config.api_key_prefix['clientId'] = 'Bearer'
1527
+
1528
+ # Configure API key authorization: clientSecret
1529
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1530
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1531
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1532
+ end
1533
+
1534
+ api_instance = Buildium::BankAccountsApi.new
1535
+ bank_account_id = 56 # Integer |
1536
+ check_id = 56 # Integer |
1537
+
1538
+ begin
1539
+ # Retrieve a check
1540
+ result = api_instance.get_check_for_bank_account(bank_account_id, check_id)
1541
+ p result
1542
+ rescue Buildium::ApiError => e
1543
+ puts "Error when calling BankAccountsApi->get_check_for_bank_account: #{e}"
1544
+ end
1545
+ ```
1546
+
1547
+ #### Using the get_check_for_bank_account_with_http_info variant
1548
+
1549
+ This returns an Array which contains the response data, status code and headers.
1550
+
1551
+ > <Array(<BankAccountCheckMessage>, Integer, Hash)> get_check_for_bank_account_with_http_info(bank_account_id, check_id)
1552
+
1553
+ ```ruby
1554
+ begin
1555
+ # Retrieve a check
1556
+ data, status_code, headers = api_instance.get_check_for_bank_account_with_http_info(bank_account_id, check_id)
1557
+ p status_code # => 2xx
1558
+ p headers # => { ... }
1559
+ p data # => <BankAccountCheckMessage>
1560
+ rescue Buildium::ApiError => e
1561
+ puts "Error when calling BankAccountsApi->get_check_for_bank_account_with_http_info: #{e}"
1562
+ end
1563
+ ```
1564
+
1565
+ ### Parameters
1566
+
1567
+ | Name | Type | Description | Notes |
1568
+ | ---- | ---- | ----------- | ----- |
1569
+ | **bank_account_id** | **Integer** | | |
1570
+ | **check_id** | **Integer** | | |
1571
+
1572
+ ### Return type
1573
+
1574
+ [**BankAccountCheckMessage**](BankAccountCheckMessage.md)
1575
+
1576
+ ### Authorization
1577
+
1578
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1579
+
1580
+ ### HTTP request headers
1581
+
1582
+ - **Content-Type**: Not defined
1583
+ - **Accept**: application/json
1584
+
1585
+
1586
+ ## get_quick_deposit_by_id
1587
+
1588
+ > <BankAccountQuickDepositMessage> get_quick_deposit_by_id(bank_account_id, quick_deposit_id)
1589
+
1590
+ Retrieve a quick deposit
1591
+
1592
+ Retrieves a quick deposit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; BankAccount</span> - `View`
1593
+
1594
+ ### Examples
1595
+
1596
+ ```ruby
1597
+ require 'time'
1598
+ require 'buildium-ruby'
1599
+ # setup authorization
1600
+ Buildium.configure do |config|
1601
+ # Configure API key authorization: clientId
1602
+ config.api_key['clientId'] = 'YOUR API KEY'
1603
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1604
+ # config.api_key_prefix['clientId'] = 'Bearer'
1605
+
1606
+ # Configure API key authorization: clientSecret
1607
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1608
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1609
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1610
+ end
1611
+
1612
+ api_instance = Buildium::BankAccountsApi.new
1613
+ bank_account_id = 56 # Integer |
1614
+ quick_deposit_id = 56 # Integer |
1615
+
1616
+ begin
1617
+ # Retrieve a quick deposit
1618
+ result = api_instance.get_quick_deposit_by_id(bank_account_id, quick_deposit_id)
1619
+ p result
1620
+ rescue Buildium::ApiError => e
1621
+ puts "Error when calling BankAccountsApi->get_quick_deposit_by_id: #{e}"
1622
+ end
1623
+ ```
1624
+
1625
+ #### Using the get_quick_deposit_by_id_with_http_info variant
1626
+
1627
+ This returns an Array which contains the response data, status code and headers.
1628
+
1629
+ > <Array(<BankAccountQuickDepositMessage>, Integer, Hash)> get_quick_deposit_by_id_with_http_info(bank_account_id, quick_deposit_id)
1630
+
1631
+ ```ruby
1632
+ begin
1633
+ # Retrieve a quick deposit
1634
+ data, status_code, headers = api_instance.get_quick_deposit_by_id_with_http_info(bank_account_id, quick_deposit_id)
1635
+ p status_code # => 2xx
1636
+ p headers # => { ... }
1637
+ p data # => <BankAccountQuickDepositMessage>
1638
+ rescue Buildium::ApiError => e
1639
+ puts "Error when calling BankAccountsApi->get_quick_deposit_by_id_with_http_info: #{e}"
1640
+ end
1641
+ ```
1642
+
1643
+ ### Parameters
1644
+
1645
+ | Name | Type | Description | Notes |
1646
+ | ---- | ---- | ----------- | ----- |
1647
+ | **bank_account_id** | **Integer** | | |
1648
+ | **quick_deposit_id** | **Integer** | | |
1649
+
1650
+ ### Return type
1651
+
1652
+ [**BankAccountQuickDepositMessage**](BankAccountQuickDepositMessage.md)
1653
+
1654
+ ### Authorization
1655
+
1656
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1657
+
1658
+ ### HTTP request headers
1659
+
1660
+ - **Content-Type**: Not defined
1661
+ - **Accept**: application/json
1662
+
1663
+
1664
+ ## get_undeposited_funds
1665
+
1666
+ > <Array<UndepositedFundsMessage>> get_undeposited_funds(bank_account_id, opts)
1667
+
1668
+ Retrieve all undeposited funds
1669
+
1670
+ Retrieve all bank account undeposited funds. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View`
1671
+
1672
+ ### Examples
1673
+
1674
+ ```ruby
1675
+ require 'time'
1676
+ require 'buildium-ruby'
1677
+ # setup authorization
1678
+ Buildium.configure do |config|
1679
+ # Configure API key authorization: clientId
1680
+ config.api_key['clientId'] = 'YOUR API KEY'
1681
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1682
+ # config.api_key_prefix['clientId'] = 'Bearer'
1683
+
1684
+ # Configure API key authorization: clientSecret
1685
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1686
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1687
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1688
+ end
1689
+
1690
+ api_instance = Buildium::BankAccountsApi.new
1691
+ bank_account_id = 56 # Integer |
1692
+ opts = {
1693
+ 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.
1694
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1695
+ 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.
1696
+ }
1697
+
1698
+ begin
1699
+ # Retrieve all undeposited funds
1700
+ result = api_instance.get_undeposited_funds(bank_account_id, opts)
1701
+ p result
1702
+ rescue Buildium::ApiError => e
1703
+ puts "Error when calling BankAccountsApi->get_undeposited_funds: #{e}"
1704
+ end
1705
+ ```
1706
+
1707
+ #### Using the get_undeposited_funds_with_http_info variant
1708
+
1709
+ This returns an Array which contains the response data, status code and headers.
1710
+
1711
+ > <Array(<Array<UndepositedFundsMessage>>, Integer, Hash)> get_undeposited_funds_with_http_info(bank_account_id, opts)
1712
+
1713
+ ```ruby
1714
+ begin
1715
+ # Retrieve all undeposited funds
1716
+ data, status_code, headers = api_instance.get_undeposited_funds_with_http_info(bank_account_id, opts)
1717
+ p status_code # => 2xx
1718
+ p headers # => { ... }
1719
+ p data # => <Array<UndepositedFundsMessage>>
1720
+ rescue Buildium::ApiError => e
1721
+ puts "Error when calling BankAccountsApi->get_undeposited_funds_with_http_info: #{e}"
1722
+ end
1723
+ ```
1724
+
1725
+ ### Parameters
1726
+
1727
+ | Name | Type | Description | Notes |
1728
+ | ---- | ---- | ----------- | ----- |
1729
+ | **bank_account_id** | **Integer** | | |
1730
+ | **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] |
1731
+ | **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] |
1732
+ | **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] |
1733
+
1734
+ ### Return type
1735
+
1736
+ [**Array&lt;UndepositedFundsMessage&gt;**](UndepositedFundsMessage.md)
1737
+
1738
+ ### Authorization
1739
+
1740
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1741
+
1742
+ ### HTTP request headers
1743
+
1744
+ - **Content-Type**: Not defined
1745
+ - **Accept**: application/json
1746
+
1747
+
1748
+ ## update_bank_account
1749
+
1750
+ > <BankAccountMessage> update_bank_account(bank_account_id, bank_account_put_message)
1751
+
1752
+ Update a bank account
1753
+
1754
+ Updates a bank account. <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\">Accounting &gt; Banking</span> - `View` `Edit`
1755
+
1756
+ ### Examples
1757
+
1758
+ ```ruby
1759
+ require 'time'
1760
+ require 'buildium-ruby'
1761
+ # setup authorization
1762
+ Buildium.configure do |config|
1763
+ # Configure API key authorization: clientId
1764
+ config.api_key['clientId'] = 'YOUR API KEY'
1765
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1766
+ # config.api_key_prefix['clientId'] = 'Bearer'
1767
+
1768
+ # Configure API key authorization: clientSecret
1769
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1770
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1771
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1772
+ end
1773
+
1774
+ api_instance = Buildium::BankAccountsApi.new
1775
+ bank_account_id = 56 # Integer |
1776
+ bank_account_put_message = Buildium::BankAccountPutMessage.new({check_printing_info: Buildium::CheckPrintingInfoPutMessage.new({enable_remote_check_printing: false, enable_local_check_printing: false, check_layout_type: 'Voucher1StubBottomMemo1Signature'}), name: 'name_example', bank_account_type: 'Checking', country: 'UnitedStates'}) # BankAccountPutMessage |
1777
+
1778
+ begin
1779
+ # Update a bank account
1780
+ result = api_instance.update_bank_account(bank_account_id, bank_account_put_message)
1781
+ p result
1782
+ rescue Buildium::ApiError => e
1783
+ puts "Error when calling BankAccountsApi->update_bank_account: #{e}"
1784
+ end
1785
+ ```
1786
+
1787
+ #### Using the update_bank_account_with_http_info variant
1788
+
1789
+ This returns an Array which contains the response data, status code and headers.
1790
+
1791
+ > <Array(<BankAccountMessage>, Integer, Hash)> update_bank_account_with_http_info(bank_account_id, bank_account_put_message)
1792
+
1793
+ ```ruby
1794
+ begin
1795
+ # Update a bank account
1796
+ data, status_code, headers = api_instance.update_bank_account_with_http_info(bank_account_id, bank_account_put_message)
1797
+ p status_code # => 2xx
1798
+ p headers # => { ... }
1799
+ p data # => <BankAccountMessage>
1800
+ rescue Buildium::ApiError => e
1801
+ puts "Error when calling BankAccountsApi->update_bank_account_with_http_info: #{e}"
1802
+ end
1803
+ ```
1804
+
1805
+ ### Parameters
1806
+
1807
+ | Name | Type | Description | Notes |
1808
+ | ---- | ---- | ----------- | ----- |
1809
+ | **bank_account_id** | **Integer** | | |
1810
+ | **bank_account_put_message** | [**BankAccountPutMessage**](BankAccountPutMessage.md) | | |
1811
+
1812
+ ### Return type
1813
+
1814
+ [**BankAccountMessage**](BankAccountMessage.md)
1815
+
1816
+ ### Authorization
1817
+
1818
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1819
+
1820
+ ### HTTP request headers
1821
+
1822
+ - **Content-Type**: application/json
1823
+ - **Accept**: application/json
1824
+
1825
+
1826
+ ## update_bank_account_deposit
1827
+
1828
+ > <BankAccountDepositMessage> update_bank_account_deposit(bank_account_id, deposit_id, bank_account_deposit_put_message)
1829
+
1830
+ Update a deposit
1831
+
1832
+ Updates a deposit. <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\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
1833
+
1834
+ ### Examples
1835
+
1836
+ ```ruby
1837
+ require 'time'
1838
+ require 'buildium-ruby'
1839
+ # setup authorization
1840
+ Buildium.configure do |config|
1841
+ # Configure API key authorization: clientId
1842
+ config.api_key['clientId'] = 'YOUR API KEY'
1843
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1844
+ # config.api_key_prefix['clientId'] = 'Bearer'
1845
+
1846
+ # Configure API key authorization: clientSecret
1847
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1848
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1849
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1850
+ end
1851
+
1852
+ api_instance = Buildium::BankAccountsApi.new
1853
+ bank_account_id = 56 # Integer |
1854
+ deposit_id = 56 # Integer |
1855
+ bank_account_deposit_put_message = Buildium::BankAccountDepositPutMessage.new({entry_date: Date.today, lines: [Buildium::BankAccountDepositLineSaveMessage.new]}) # BankAccountDepositPutMessage |
1856
+
1857
+ begin
1858
+ # Update a deposit
1859
+ result = api_instance.update_bank_account_deposit(bank_account_id, deposit_id, bank_account_deposit_put_message)
1860
+ p result
1861
+ rescue Buildium::ApiError => e
1862
+ puts "Error when calling BankAccountsApi->update_bank_account_deposit: #{e}"
1863
+ end
1864
+ ```
1865
+
1866
+ #### Using the update_bank_account_deposit_with_http_info variant
1867
+
1868
+ This returns an Array which contains the response data, status code and headers.
1869
+
1870
+ > <Array(<BankAccountDepositMessage>, Integer, Hash)> update_bank_account_deposit_with_http_info(bank_account_id, deposit_id, bank_account_deposit_put_message)
1871
+
1872
+ ```ruby
1873
+ begin
1874
+ # Update a deposit
1875
+ data, status_code, headers = api_instance.update_bank_account_deposit_with_http_info(bank_account_id, deposit_id, bank_account_deposit_put_message)
1876
+ p status_code # => 2xx
1877
+ p headers # => { ... }
1878
+ p data # => <BankAccountDepositMessage>
1879
+ rescue Buildium::ApiError => e
1880
+ puts "Error when calling BankAccountsApi->update_bank_account_deposit_with_http_info: #{e}"
1881
+ end
1882
+ ```
1883
+
1884
+ ### Parameters
1885
+
1886
+ | Name | Type | Description | Notes |
1887
+ | ---- | ---- | ----------- | ----- |
1888
+ | **bank_account_id** | **Integer** | | |
1889
+ | **deposit_id** | **Integer** | | |
1890
+ | **bank_account_deposit_put_message** | [**BankAccountDepositPutMessage**](BankAccountDepositPutMessage.md) | | |
1891
+
1892
+ ### Return type
1893
+
1894
+ [**BankAccountDepositMessage**](BankAccountDepositMessage.md)
1895
+
1896
+ ### Authorization
1897
+
1898
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1899
+
1900
+ ### HTTP request headers
1901
+
1902
+ - **Content-Type**: application/json
1903
+ - **Accept**: application/json
1904
+
1905
+
1906
+ ## update_bank_account_transfer
1907
+
1908
+ > <BankAccountTransferMessage> update_bank_account_transfer(bank_account_id, transfer_id, bank_account_transfer_save_message)
1909
+
1910
+ Update a transfer
1911
+
1912
+ Updates a bank account transfer. <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\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
1913
+
1914
+ ### Examples
1915
+
1916
+ ```ruby
1917
+ require 'time'
1918
+ require 'buildium-ruby'
1919
+ # setup authorization
1920
+ Buildium.configure do |config|
1921
+ # Configure API key authorization: clientId
1922
+ config.api_key['clientId'] = 'YOUR API KEY'
1923
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1924
+ # config.api_key_prefix['clientId'] = 'Bearer'
1925
+
1926
+ # Configure API key authorization: clientSecret
1927
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1928
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1929
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1930
+ end
1931
+
1932
+ api_instance = Buildium::BankAccountsApi.new
1933
+ bank_account_id = 56 # Integer |
1934
+ transfer_id = 56 # Integer |
1935
+ bank_account_transfer_save_message = Buildium::BankAccountTransferSaveMessage.new({entry_date: Date.today, transfer_to_bank_account_id: 37, total_amount: 3.56, accounting_entity: Buildium::BankAccountTransferAccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountTransferSaveMessage |
1936
+
1937
+ begin
1938
+ # Update a transfer
1939
+ result = api_instance.update_bank_account_transfer(bank_account_id, transfer_id, bank_account_transfer_save_message)
1940
+ p result
1941
+ rescue Buildium::ApiError => e
1942
+ puts "Error when calling BankAccountsApi->update_bank_account_transfer: #{e}"
1943
+ end
1944
+ ```
1945
+
1946
+ #### Using the update_bank_account_transfer_with_http_info variant
1947
+
1948
+ This returns an Array which contains the response data, status code and headers.
1949
+
1950
+ > <Array(<BankAccountTransferMessage>, Integer, Hash)> update_bank_account_transfer_with_http_info(bank_account_id, transfer_id, bank_account_transfer_save_message)
1951
+
1952
+ ```ruby
1953
+ begin
1954
+ # Update a transfer
1955
+ data, status_code, headers = api_instance.update_bank_account_transfer_with_http_info(bank_account_id, transfer_id, bank_account_transfer_save_message)
1956
+ p status_code # => 2xx
1957
+ p headers # => { ... }
1958
+ p data # => <BankAccountTransferMessage>
1959
+ rescue Buildium::ApiError => e
1960
+ puts "Error when calling BankAccountsApi->update_bank_account_transfer_with_http_info: #{e}"
1961
+ end
1962
+ ```
1963
+
1964
+ ### Parameters
1965
+
1966
+ | Name | Type | Description | Notes |
1967
+ | ---- | ---- | ----------- | ----- |
1968
+ | **bank_account_id** | **Integer** | | |
1969
+ | **transfer_id** | **Integer** | | |
1970
+ | **bank_account_transfer_save_message** | [**BankAccountTransferSaveMessage**](BankAccountTransferSaveMessage.md) | | |
1971
+
1972
+ ### Return type
1973
+
1974
+ [**BankAccountTransferMessage**](BankAccountTransferMessage.md)
1975
+
1976
+ ### Authorization
1977
+
1978
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1979
+
1980
+ ### HTTP request headers
1981
+
1982
+ - **Content-Type**: application/json
1983
+ - **Accept**: application/json
1984
+
1985
+
1986
+ ## update_bank_account_withdrawal
1987
+
1988
+ > <BankAccountWithdrawalMessage> update_bank_account_withdrawal(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message)
1989
+
1990
+ Update a withdrawal
1991
+
1992
+ Updates a bank account withdrawal. <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\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
1993
+
1994
+ ### Examples
1995
+
1996
+ ```ruby
1997
+ require 'time'
1998
+ require 'buildium-ruby'
1999
+ # setup authorization
2000
+ Buildium.configure do |config|
2001
+ # Configure API key authorization: clientId
2002
+ config.api_key['clientId'] = 'YOUR API KEY'
2003
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2004
+ # config.api_key_prefix['clientId'] = 'Bearer'
2005
+
2006
+ # Configure API key authorization: clientSecret
2007
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2008
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2009
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2010
+ end
2011
+
2012
+ api_instance = Buildium::BankAccountsApi.new
2013
+ bank_account_id = 56 # Integer |
2014
+ withdrawal_id = 56 # Integer |
2015
+ bank_account_withdrawal_save_message = Buildium::BankAccountWithdrawalSaveMessage.new({entry_date: Date.today, offset_gl_account_id: 37, amount: 3.56, accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountWithdrawalSaveMessage |
2016
+
2017
+ begin
2018
+ # Update a withdrawal
2019
+ result = api_instance.update_bank_account_withdrawal(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message)
2020
+ p result
2021
+ rescue Buildium::ApiError => e
2022
+ puts "Error when calling BankAccountsApi->update_bank_account_withdrawal: #{e}"
2023
+ end
2024
+ ```
2025
+
2026
+ #### Using the update_bank_account_withdrawal_with_http_info variant
2027
+
2028
+ This returns an Array which contains the response data, status code and headers.
2029
+
2030
+ > <Array(<BankAccountWithdrawalMessage>, Integer, Hash)> update_bank_account_withdrawal_with_http_info(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message)
2031
+
2032
+ ```ruby
2033
+ begin
2034
+ # Update a withdrawal
2035
+ data, status_code, headers = api_instance.update_bank_account_withdrawal_with_http_info(bank_account_id, withdrawal_id, bank_account_withdrawal_save_message)
2036
+ p status_code # => 2xx
2037
+ p headers # => { ... }
2038
+ p data # => <BankAccountWithdrawalMessage>
2039
+ rescue Buildium::ApiError => e
2040
+ puts "Error when calling BankAccountsApi->update_bank_account_withdrawal_with_http_info: #{e}"
2041
+ end
2042
+ ```
2043
+
2044
+ ### Parameters
2045
+
2046
+ | Name | Type | Description | Notes |
2047
+ | ---- | ---- | ----------- | ----- |
2048
+ | **bank_account_id** | **Integer** | | |
2049
+ | **withdrawal_id** | **Integer** | | |
2050
+ | **bank_account_withdrawal_save_message** | [**BankAccountWithdrawalSaveMessage**](BankAccountWithdrawalSaveMessage.md) | | |
2051
+
2052
+ ### Return type
2053
+
2054
+ [**BankAccountWithdrawalMessage**](BankAccountWithdrawalMessage.md)
2055
+
2056
+ ### Authorization
2057
+
2058
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2059
+
2060
+ ### HTTP request headers
2061
+
2062
+ - **Content-Type**: application/json
2063
+ - **Accept**: application/json
2064
+
2065
+
2066
+ ## update_check_for_bank_account
2067
+
2068
+ > <BankAccountCheckMessage> update_check_for_bank_account(bank_account_id, check_id, bank_account_check_put_message)
2069
+
2070
+ Update a check
2071
+
2072
+ Updates a check. <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\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
2073
+
2074
+ ### Examples
2075
+
2076
+ ```ruby
2077
+ require 'time'
2078
+ require 'buildium-ruby'
2079
+ # setup authorization
2080
+ Buildium.configure do |config|
2081
+ # Configure API key authorization: clientId
2082
+ config.api_key['clientId'] = 'YOUR API KEY'
2083
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2084
+ # config.api_key_prefix['clientId'] = 'Bearer'
2085
+
2086
+ # Configure API key authorization: clientSecret
2087
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2088
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2089
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2090
+ end
2091
+
2092
+ api_instance = Buildium::BankAccountsApi.new
2093
+ bank_account_id = 56 # Integer |
2094
+ check_id = 56 # Integer |
2095
+ bank_account_check_put_message = Buildium::BankAccountCheckPutMessage.new({payee: Buildium::BankAccountCheckPayeeSaveMessage.new({id: 37, type: 'Vendor'}), entry_date: Date.today, lines: [Buildium::BankAccountCheckLineSaveMessage.new({gl_account_id: 37, accounting_entity: Buildium::BankAccountCheckAccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'}), amount: 3.56})]}) # BankAccountCheckPutMessage |
2096
+
2097
+ begin
2098
+ # Update a check
2099
+ result = api_instance.update_check_for_bank_account(bank_account_id, check_id, bank_account_check_put_message)
2100
+ p result
2101
+ rescue Buildium::ApiError => e
2102
+ puts "Error when calling BankAccountsApi->update_check_for_bank_account: #{e}"
2103
+ end
2104
+ ```
2105
+
2106
+ #### Using the update_check_for_bank_account_with_http_info variant
2107
+
2108
+ This returns an Array which contains the response data, status code and headers.
2109
+
2110
+ > <Array(<BankAccountCheckMessage>, Integer, Hash)> update_check_for_bank_account_with_http_info(bank_account_id, check_id, bank_account_check_put_message)
2111
+
2112
+ ```ruby
2113
+ begin
2114
+ # Update a check
2115
+ data, status_code, headers = api_instance.update_check_for_bank_account_with_http_info(bank_account_id, check_id, bank_account_check_put_message)
2116
+ p status_code # => 2xx
2117
+ p headers # => { ... }
2118
+ p data # => <BankAccountCheckMessage>
2119
+ rescue Buildium::ApiError => e
2120
+ puts "Error when calling BankAccountsApi->update_check_for_bank_account_with_http_info: #{e}"
2121
+ end
2122
+ ```
2123
+
2124
+ ### Parameters
2125
+
2126
+ | Name | Type | Description | Notes |
2127
+ | ---- | ---- | ----------- | ----- |
2128
+ | **bank_account_id** | **Integer** | | |
2129
+ | **check_id** | **Integer** | | |
2130
+ | **bank_account_check_put_message** | [**BankAccountCheckPutMessage**](BankAccountCheckPutMessage.md) | | |
2131
+
2132
+ ### Return type
2133
+
2134
+ [**BankAccountCheckMessage**](BankAccountCheckMessage.md)
2135
+
2136
+ ### Authorization
2137
+
2138
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2139
+
2140
+ ### HTTP request headers
2141
+
2142
+ - **Content-Type**: application/json
2143
+ - **Accept**: application/json
2144
+
2145
+
2146
+ ## update_quick_deposit
2147
+
2148
+ > <BankAccountQuickDepositMessage> update_quick_deposit(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message)
2149
+
2150
+ Update a quick deposit
2151
+
2152
+ Updates a quick deposit. <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\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
2153
+
2154
+ ### Examples
2155
+
2156
+ ```ruby
2157
+ require 'time'
2158
+ require 'buildium-ruby'
2159
+ # setup authorization
2160
+ Buildium.configure do |config|
2161
+ # Configure API key authorization: clientId
2162
+ config.api_key['clientId'] = 'YOUR API KEY'
2163
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2164
+ # config.api_key_prefix['clientId'] = 'Bearer'
2165
+
2166
+ # Configure API key authorization: clientSecret
2167
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2168
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2169
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2170
+ end
2171
+
2172
+ api_instance = Buildium::BankAccountsApi.new
2173
+ bank_account_id = 56 # Integer |
2174
+ quick_deposit_id = 56 # Integer |
2175
+ bank_account_quick_deposit_save_message = Buildium::BankAccountQuickDepositSaveMessage.new({entry_date: Date.today, offset_gl_account_id: 37, amount: 3.56, accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'})}) # BankAccountQuickDepositSaveMessage |
2176
+
2177
+ begin
2178
+ # Update a quick deposit
2179
+ result = api_instance.update_quick_deposit(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message)
2180
+ p result
2181
+ rescue Buildium::ApiError => e
2182
+ puts "Error when calling BankAccountsApi->update_quick_deposit: #{e}"
2183
+ end
2184
+ ```
2185
+
2186
+ #### Using the update_quick_deposit_with_http_info variant
2187
+
2188
+ This returns an Array which contains the response data, status code and headers.
2189
+
2190
+ > <Array(<BankAccountQuickDepositMessage>, Integer, Hash)> update_quick_deposit_with_http_info(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message)
2191
+
2192
+ ```ruby
2193
+ begin
2194
+ # Update a quick deposit
2195
+ data, status_code, headers = api_instance.update_quick_deposit_with_http_info(bank_account_id, quick_deposit_id, bank_account_quick_deposit_save_message)
2196
+ p status_code # => 2xx
2197
+ p headers # => { ... }
2198
+ p data # => <BankAccountQuickDepositMessage>
2199
+ rescue Buildium::ApiError => e
2200
+ puts "Error when calling BankAccountsApi->update_quick_deposit_with_http_info: #{e}"
2201
+ end
2202
+ ```
2203
+
2204
+ ### Parameters
2205
+
2206
+ | Name | Type | Description | Notes |
2207
+ | ---- | ---- | ----------- | ----- |
2208
+ | **bank_account_id** | **Integer** | | |
2209
+ | **quick_deposit_id** | **Integer** | | |
2210
+ | **bank_account_quick_deposit_save_message** | [**BankAccountQuickDepositSaveMessage**](BankAccountQuickDepositSaveMessage.md) | | |
2211
+
2212
+ ### Return type
2213
+
2214
+ [**BankAccountQuickDepositMessage**](BankAccountQuickDepositMessage.md)
2215
+
2216
+ ### Authorization
2217
+
2218
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2219
+
2220
+ ### HTTP request headers
2221
+
2222
+ - **Content-Type**: application/json
2223
+ - **Accept**: application/json
2224
+