propertyware 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (392) 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 +375 -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 +23 -0
  11. data/.rspec +2 -0
  12. data/.rubocop.yml +124 -0
  13. data/CUSTOMIZATIONS.md +11 -0
  14. data/DOCS.md +673 -0
  15. data/Gemfile +9 -0
  16. data/Gemfile.lock +76 -0
  17. data/README.md +93 -0
  18. data/Rakefile +10 -0
  19. data/bin/CUSTOMIZATIONS.md +11 -0
  20. data/bin/README.md +93 -0
  21. data/bin/config.yml +7 -0
  22. data/bin/fix_json.rb +59 -0
  23. data/bin/propertyware.json +1 -0
  24. data/bin/rebuild.sh +31 -0
  25. data/docs/Account.md +84 -0
  26. data/docs/AccountingApi.md +1235 -0
  27. data/docs/Address.md +28 -0
  28. data/docs/Amenity.md +24 -0
  29. data/docs/AutoJournalEntry.md +46 -0
  30. data/docs/AutoPayment.md +42 -0
  31. data/docs/Bank.md +52 -0
  32. data/docs/BankDeposit.md +32 -0
  33. data/docs/BasicVendor.md +40 -0
  34. data/docs/Bill.md +54 -0
  35. data/docs/BillPaid.md +24 -0
  36. data/docs/BillPay.md +20 -0
  37. data/docs/BillPayment.md +46 -0
  38. data/docs/BillSplit.md +42 -0
  39. data/docs/BillsApi.md +1391 -0
  40. data/docs/Building.md +116 -0
  41. data/docs/BuildingsApi.md +1037 -0
  42. data/docs/Campaign.md +60 -0
  43. data/docs/CampaignSource.md +26 -0
  44. data/docs/Charge.md +36 -0
  45. data/docs/ChargeTx.md +52 -0
  46. data/docs/Check.md +48 -0
  47. data/docs/CheckSplit.md +30 -0
  48. data/docs/Comment.md +28 -0
  49. data/docs/Contact.md +74 -0
  50. data/docs/ContactsApi.md +783 -0
  51. data/docs/Conversation.md +36 -0
  52. data/docs/CreditCardAccount.md +18 -0
  53. data/docs/CurrentAsset.md +30 -0
  54. data/docs/CurrentLiability.md +30 -0
  55. data/docs/CustomField.md +24 -0
  56. data/docs/Discount.md +40 -0
  57. data/docs/Document.md +40 -0
  58. data/docs/DocumentsApi.md +267 -0
  59. data/docs/Entry.md +34 -0
  60. data/docs/Equity.md +32 -0
  61. data/docs/ErrorResponse.md +22 -0
  62. data/docs/Expense.md +32 -0
  63. data/docs/GLItem.md +40 -0
  64. data/docs/HealthCheckApi.md +86 -0
  65. data/docs/Income.md +34 -0
  66. data/docs/Inspection.md +46 -0
  67. data/docs/InspectionArea.md +22 -0
  68. data/docs/InspectionItem.md +24 -0
  69. data/docs/InspectionsApi.md +193 -0
  70. data/docs/JournalEntry.md +36 -0
  71. data/docs/JournalEntrySplit.md +24 -0
  72. data/docs/JournalEntrySplitResponse.md +24 -0
  73. data/docs/LateFeeRule.md +26 -0
  74. data/docs/Lease.md +76 -0
  75. data/docs/LeaseClause.md +22 -0
  76. data/docs/LeaseContact.md +36 -0
  77. data/docs/LeasesApi.md +3319 -0
  78. data/docs/ManagementFee.md +30 -0
  79. data/docs/ManagementSettings.md +26 -0
  80. data/docs/Marketing.md +62 -0
  81. data/docs/NonCurrentAsset.md +26 -0
  82. data/docs/NonCurrentLiability.md +30 -0
  83. data/docs/NonOperatingExpense.md +32 -0
  84. data/docs/NonOperatingInome.md +32 -0
  85. data/docs/Note.md +28 -0
  86. data/docs/Owner.md +38 -0
  87. data/docs/OwnerContribution.md +44 -0
  88. data/docs/OwnerDraw.md +44 -0
  89. data/docs/Payment.md +50 -0
  90. data/docs/PaymentCharge.md +36 -0
  91. data/docs/Portfolio.md +60 -0
  92. data/docs/PortfoliosApi.md +701 -0
  93. data/docs/PropertyManager.md +26 -0
  94. data/docs/Prospect.md +114 -0
  95. data/docs/ProspectsApi.md +789 -0
  96. data/docs/RESTAPIBulkErrorResponse.md +22 -0
  97. data/docs/RESTAPIBulkSuccessResponse.md +18 -0
  98. data/docs/RESTAPIError.md +20 -0
  99. data/docs/Refund.md +44 -0
  100. data/docs/ResponseEntity.md +20 -0
  101. data/docs/SaveAccount.md +52 -0
  102. data/docs/SaveAddress.md +28 -0
  103. data/docs/SaveAdjustment.md +26 -0
  104. data/docs/SaveAutoCharge.md +28 -0
  105. data/docs/SaveBankDeposit.md +20 -0
  106. data/docs/SaveBill.md +42 -0
  107. data/docs/SaveBillPayment.md +30 -0
  108. data/docs/SaveBillSplit.md +36 -0
  109. data/docs/SaveBuilding.md +84 -0
  110. data/docs/SaveCharge.md +28 -0
  111. data/docs/SaveCheck.md +30 -0
  112. data/docs/SaveCheckSplit.md +30 -0
  113. data/docs/SaveComment.md +18 -0
  114. data/docs/SaveContact.md +60 -0
  115. data/docs/SaveConversation.md +20 -0
  116. data/docs/SaveCredit.md +26 -0
  117. data/docs/SaveDiscount.md +28 -0
  118. data/docs/SaveJournalEntrySplit.md +22 -0
  119. data/docs/SaveLease.md +50 -0
  120. data/docs/SaveLeaseJournalEntry.md +26 -0
  121. data/docs/SaveOwner.md +36 -0
  122. data/docs/SaveOwnerContribution.md +34 -0
  123. data/docs/SaveOwnerDraw.md +34 -0
  124. data/docs/SavePayment.md +34 -0
  125. data/docs/SavePortfolio.md +38 -0
  126. data/docs/SaveProspect.md +76 -0
  127. data/docs/SaveProspectContact.md +36 -0
  128. data/docs/SaveRefund.md +34 -0
  129. data/docs/SaveUnit.md +60 -0
  130. data/docs/SaveVendor.md +46 -0
  131. data/docs/SaveWorkOrder.md +36 -0
  132. data/docs/SaveWorkOrderTask.md +30 -0
  133. data/docs/SplitPaid.md +34 -0
  134. data/docs/SplitPay.md +20 -0
  135. data/docs/Task.md +42 -0
  136. data/docs/Transaction.md +54 -0
  137. data/docs/Unit.md +96 -0
  138. data/docs/UnitsApi.md +875 -0
  139. data/docs/UpdateLeaseJournalEntry.md +26 -0
  140. data/docs/Vendor.md +76 -0
  141. data/docs/VendorsApi.md +617 -0
  142. data/docs/WorkOrder.md +78 -0
  143. data/docs/WorkOrdersApi.md +883 -0
  144. data/lib/propertyware/api/accounting_api.rb +1041 -0
  145. data/lib/propertyware/api/bills_api.rb +1182 -0
  146. data/lib/propertyware/api/buildings_api.rb +863 -0
  147. data/lib/propertyware/api/contacts_api.rb +666 -0
  148. data/lib/propertyware/api/documents_api.rb +235 -0
  149. data/lib/propertyware/api/health_check_api.rb +79 -0
  150. data/lib/propertyware/api/inspections_api.rb +172 -0
  151. data/lib/propertyware/api/leases_api.rb +2787 -0
  152. data/lib/propertyware/api/portfolios_api.rb +599 -0
  153. data/lib/propertyware/api/prospects_api.rb +671 -0
  154. data/lib/propertyware/api/units_api.rb +740 -0
  155. data/lib/propertyware/api/vendors_api.rb +522 -0
  156. data/lib/propertyware/api/work_orders_api.rb +763 -0
  157. data/lib/propertyware/api_client.rb +428 -0
  158. data/lib/propertyware/api_error.rb +58 -0
  159. data/lib/propertyware/configuration.rb +392 -0
  160. data/lib/propertyware/models/account.rb +549 -0
  161. data/lib/propertyware/models/address.rb +269 -0
  162. data/lib/propertyware/models/amenity.rb +249 -0
  163. data/lib/propertyware/models/auto_journal_entry.rb +358 -0
  164. data/lib/propertyware/models/auto_payment.rb +338 -0
  165. data/lib/propertyware/models/bank.rb +389 -0
  166. data/lib/propertyware/models/bank_deposit.rb +289 -0
  167. data/lib/propertyware/models/basic_vendor.rb +330 -0
  168. data/lib/propertyware/models/bill.rb +401 -0
  169. data/lib/propertyware/models/bill_paid.rb +250 -0
  170. data/lib/propertyware/models/bill_pay.rb +230 -0
  171. data/lib/propertyware/models/bill_payment.rb +361 -0
  172. data/lib/propertyware/models/bill_split.rb +339 -0
  173. data/lib/propertyware/models/building.rb +782 -0
  174. data/lib/propertyware/models/campaign.rb +430 -0
  175. data/lib/propertyware/models/campaign_source.rb +258 -0
  176. data/lib/propertyware/models/charge.rb +318 -0
  177. data/lib/propertyware/models/charge_tx.rb +401 -0
  178. data/lib/propertyware/models/check.rb +425 -0
  179. data/lib/propertyware/models/check_split.rb +284 -0
  180. data/lib/propertyware/models/comment.rb +269 -0
  181. data/lib/propertyware/models/contact.rb +546 -0
  182. data/lib/propertyware/models/conversation.rb +345 -0
  183. data/lib/propertyware/models/credit_card_account.rb +219 -0
  184. data/lib/propertyware/models/current_asset.rb +279 -0
  185. data/lib/propertyware/models/current_liability.rb +279 -0
  186. data/lib/propertyware/models/custom_field.rb +249 -0
  187. data/lib/propertyware/models/discount.rb +339 -0
  188. data/lib/propertyware/models/document.rb +362 -0
  189. data/lib/propertyware/models/entry.rb +297 -0
  190. data/lib/propertyware/models/equity.rb +289 -0
  191. data/lib/propertyware/models/error_response.rb +237 -0
  192. data/lib/propertyware/models/expense.rb +289 -0
  193. data/lib/propertyware/models/gl_item.rb +330 -0
  194. data/lib/propertyware/models/income.rb +299 -0
  195. data/lib/propertyware/models/inspection.rb +361 -0
  196. data/lib/propertyware/models/inspection_area.rb +241 -0
  197. data/lib/propertyware/models/inspection_item.rb +249 -0
  198. data/lib/propertyware/models/journal_entry.rb +311 -0
  199. data/lib/propertyware/models/journal_entry_split.rb +264 -0
  200. data/lib/propertyware/models/journal_entry_split_response.rb +263 -0
  201. data/lib/propertyware/models/late_fee_rule.rb +258 -0
  202. data/lib/propertyware/models/lease.rb +515 -0
  203. data/lib/propertyware/models/lease_clause.rb +238 -0
  204. data/lib/propertyware/models/lease_contact.rb +309 -0
  205. data/lib/propertyware/models/management_fee.rb +279 -0
  206. data/lib/propertyware/models/management_settings.rb +261 -0
  207. data/lib/propertyware/models/marketing.rb +439 -0
  208. data/lib/propertyware/models/non_current_asset.rb +259 -0
  209. data/lib/propertyware/models/non_current_liability.rb +279 -0
  210. data/lib/propertyware/models/non_operating_expense.rb +289 -0
  211. data/lib/propertyware/models/non_operating_inome.rb +289 -0
  212. data/lib/propertyware/models/note.rb +267 -0
  213. data/lib/propertyware/models/owner.rb +318 -0
  214. data/lib/propertyware/models/owner_contribution.rb +418 -0
  215. data/lib/propertyware/models/owner_draw.rb +398 -0
  216. data/lib/propertyware/models/payment.rb +423 -0
  217. data/lib/propertyware/models/payment_charge.rb +358 -0
  218. data/lib/propertyware/models/portfolio.rb +479 -0
  219. data/lib/propertyware/models/property_manager.rb +259 -0
  220. data/lib/propertyware/models/prospect.rb +701 -0
  221. data/lib/propertyware/models/refund.rb +384 -0
  222. data/lib/propertyware/models/response_entity.rb +260 -0
  223. data/lib/propertyware/models/restapi_bulk_error_response.rb +237 -0
  224. data/lib/propertyware/models/restapi_bulk_success_response.rb +217 -0
  225. data/lib/propertyware/models/restapi_error.rb +226 -0
  226. data/lib/propertyware/models/save_account.rb +398 -0
  227. data/lib/propertyware/models/save_address.rb +274 -0
  228. data/lib/propertyware/models/save_adjustment.rb +269 -0
  229. data/lib/propertyware/models/save_auto_charge.rb +328 -0
  230. data/lib/propertyware/models/save_bank_deposit.rb +239 -0
  231. data/lib/propertyware/models/save_bill.rb +356 -0
  232. data/lib/propertyware/models/save_bill_payment.rb +314 -0
  233. data/lib/propertyware/models/save_bill_split.rb +319 -0
  234. data/lib/propertyware/models/save_building.rb +653 -0
  235. data/lib/propertyware/models/save_charge.rb +289 -0
  236. data/lib/propertyware/models/save_check.rb +291 -0
  237. data/lib/propertyware/models/save_check_split.rb +289 -0
  238. data/lib/propertyware/models/save_comment.rb +224 -0
  239. data/lib/propertyware/models/save_contact.rb +472 -0
  240. data/lib/propertyware/models/save_conversation.rb +273 -0
  241. data/lib/propertyware/models/save_credit.rb +271 -0
  242. data/lib/propertyware/models/save_discount.rb +289 -0
  243. data/lib/propertyware/models/save_journal_entry_split.rb +254 -0
  244. data/lib/propertyware/models/save_lease.rb +444 -0
  245. data/lib/propertyware/models/save_lease_journal_entry.rb +276 -0
  246. data/lib/propertyware/models/save_owner.rb +318 -0
  247. data/lib/propertyware/models/save_owner_contribution.rb +373 -0
  248. data/lib/propertyware/models/save_owner_draw.rb +334 -0
  249. data/lib/propertyware/models/save_payment.rb +373 -0
  250. data/lib/propertyware/models/save_portfolio.rb +379 -0
  251. data/lib/propertyware/models/save_prospect.rb +511 -0
  252. data/lib/propertyware/models/save_prospect_contact.rb +318 -0
  253. data/lib/propertyware/models/save_refund.rb +334 -0
  254. data/lib/propertyware/models/save_unit.rb +492 -0
  255. data/lib/propertyware/models/save_vendor.rb +379 -0
  256. data/lib/propertyware/models/save_work_order.rb +345 -0
  257. data/lib/propertyware/models/save_work_order_task.rb +284 -0
  258. data/lib/propertyware/models/split_paid.rb +298 -0
  259. data/lib/propertyware/models/split_pay.rb +228 -0
  260. data/lib/propertyware/models/task.rb +339 -0
  261. data/lib/propertyware/models/transaction.rb +433 -0
  262. data/lib/propertyware/models/unit.rb +670 -0
  263. data/lib/propertyware/models/update_lease_journal_entry.rb +276 -0
  264. data/lib/propertyware/models/vendor.rb +511 -0
  265. data/lib/propertyware/models/work_order.rb +557 -0
  266. data/lib/propertyware/version.rb +15 -0
  267. data/lib/propertyware.rb +158 -0
  268. data/openapitools.json +7 -0
  269. data/propertyware.gemspec +39 -0
  270. data/spec/api/accounting_api_spec.rb +239 -0
  271. data/spec/api/bills_api_spec.rb +260 -0
  272. data/spec/api/buildings_api_spec.rb +199 -0
  273. data/spec/api/contacts_api_spec.rb +159 -0
  274. data/spec/api/documents_api_spec.rb +77 -0
  275. data/spec/api/health_check_api_spec.rb +46 -0
  276. data/spec/api/inspections_api_spec.rb +68 -0
  277. data/spec/api/leases_api_spec.rb +579 -0
  278. data/spec/api/portfolios_api_spec.rb +147 -0
  279. data/spec/api/prospects_api_spec.rb +162 -0
  280. data/spec/api/units_api_spec.rb +176 -0
  281. data/spec/api/vendors_api_spec.rb +134 -0
  282. data/spec/api/work_orders_api_spec.rb +180 -0
  283. data/spec/api_client_spec.rb +223 -0
  284. data/spec/configuration_spec.rb +82 -0
  285. data/spec/models/account_spec.rb +232 -0
  286. data/spec/models/address_spec.rb +64 -0
  287. data/spec/models/amenity_spec.rb +52 -0
  288. data/spec/models/auto_journal_entry_spec.rb +118 -0
  289. data/spec/models/auto_payment_spec.rb +106 -0
  290. data/spec/models/bank_deposit_spec.rb +76 -0
  291. data/spec/models/bank_spec.rb +136 -0
  292. data/spec/models/basic_vendor_spec.rb +100 -0
  293. data/spec/models/bill_paid_spec.rb +52 -0
  294. data/spec/models/bill_pay_spec.rb +40 -0
  295. data/spec/models/bill_payment_spec.rb +118 -0
  296. data/spec/models/bill_spec.rb +142 -0
  297. data/spec/models/bill_split_spec.rb +106 -0
  298. data/spec/models/building_spec.rb +344 -0
  299. data/spec/models/campaign_source_spec.rb +58 -0
  300. data/spec/models/campaign_spec.rb +160 -0
  301. data/spec/models/charge_spec.rb +88 -0
  302. data/spec/models/charge_tx_spec.rb +136 -0
  303. data/spec/models/check_spec.rb +128 -0
  304. data/spec/models/check_split_spec.rb +70 -0
  305. data/spec/models/comment_spec.rb +64 -0
  306. data/spec/models/contact_spec.rb +210 -0
  307. data/spec/models/conversation_spec.rb +92 -0
  308. data/spec/models/credit_card_account_spec.rb +34 -0
  309. data/spec/models/current_asset_spec.rb +70 -0
  310. data/spec/models/current_liability_spec.rb +70 -0
  311. data/spec/models/custom_field_spec.rb +52 -0
  312. data/spec/models/discount_spec.rb +100 -0
  313. data/spec/models/document_spec.rb +104 -0
  314. data/spec/models/entry_spec.rb +82 -0
  315. data/spec/models/equity_spec.rb +76 -0
  316. data/spec/models/error_response_spec.rb +46 -0
  317. data/spec/models/expense_spec.rb +76 -0
  318. data/spec/models/gl_item_spec.rb +100 -0
  319. data/spec/models/income_spec.rb +82 -0
  320. data/spec/models/inspection_area_spec.rb +46 -0
  321. data/spec/models/inspection_item_spec.rb +52 -0
  322. data/spec/models/inspection_spec.rb +118 -0
  323. data/spec/models/journal_entry_spec.rb +88 -0
  324. data/spec/models/journal_entry_split_response_spec.rb +52 -0
  325. data/spec/models/journal_entry_split_spec.rb +52 -0
  326. data/spec/models/late_fee_rule_spec.rb +58 -0
  327. data/spec/models/lease_clause_spec.rb +46 -0
  328. data/spec/models/lease_contact_spec.rb +88 -0
  329. data/spec/models/lease_spec.rb +208 -0
  330. data/spec/models/management_fee_spec.rb +70 -0
  331. data/spec/models/management_settings_spec.rb +58 -0
  332. data/spec/models/marketing_spec.rb +166 -0
  333. data/spec/models/non_current_asset_spec.rb +58 -0
  334. data/spec/models/non_current_liability_spec.rb +70 -0
  335. data/spec/models/non_operating_expense_spec.rb +76 -0
  336. data/spec/models/non_operating_inome_spec.rb +76 -0
  337. data/spec/models/note_spec.rb +64 -0
  338. data/spec/models/owner_contribution_spec.rb +116 -0
  339. data/spec/models/owner_draw_spec.rb +116 -0
  340. data/spec/models/owner_spec.rb +94 -0
  341. data/spec/models/payment_charge_spec.rb +92 -0
  342. data/spec/models/payment_spec.rb +134 -0
  343. data/spec/models/portfolio_spec.rb +168 -0
  344. data/spec/models/property_manager_spec.rb +58 -0
  345. data/spec/models/prospect_spec.rb +322 -0
  346. data/spec/models/refund_spec.rb +112 -0
  347. data/spec/models/response_entity_spec.rb +44 -0
  348. data/spec/models/restapi_bulk_error_response_spec.rb +46 -0
  349. data/spec/models/restapi_bulk_success_response_spec.rb +34 -0
  350. data/spec/models/restapi_error_spec.rb +40 -0
  351. data/spec/models/save_account_spec.rb +136 -0
  352. data/spec/models/save_address_spec.rb +64 -0
  353. data/spec/models/save_adjustment_spec.rb +58 -0
  354. data/spec/models/save_auto_charge_spec.rb +68 -0
  355. data/spec/models/save_bank_deposit_spec.rb +40 -0
  356. data/spec/models/save_bill_payment_spec.rb +74 -0
  357. data/spec/models/save_bill_spec.rb +106 -0
  358. data/spec/models/save_bill_split_spec.rb +88 -0
  359. data/spec/models/save_building_spec.rb +248 -0
  360. data/spec/models/save_charge_spec.rb +64 -0
  361. data/spec/models/save_check_spec.rb +70 -0
  362. data/spec/models/save_check_split_spec.rb +70 -0
  363. data/spec/models/save_comment_spec.rb +34 -0
  364. data/spec/models/save_contact_spec.rb +164 -0
  365. data/spec/models/save_conversation_spec.rb +44 -0
  366. data/spec/models/save_credit_spec.rb +58 -0
  367. data/spec/models/save_discount_spec.rb +64 -0
  368. data/spec/models/save_journal_entry_split_spec.rb +46 -0
  369. data/spec/models/save_lease_journal_entry_spec.rb +58 -0
  370. data/spec/models/save_lease_spec.rb +134 -0
  371. data/spec/models/save_owner_contribution_spec.rb +86 -0
  372. data/spec/models/save_owner_draw_spec.rb +82 -0
  373. data/spec/models/save_owner_spec.rb +88 -0
  374. data/spec/models/save_payment_spec.rb +86 -0
  375. data/spec/models/save_portfolio_spec.rb +102 -0
  376. data/spec/models/save_prospect_contact_spec.rb +88 -0
  377. data/spec/models/save_prospect_spec.rb +208 -0
  378. data/spec/models/save_refund_spec.rb +82 -0
  379. data/spec/models/save_unit_spec.rb +164 -0
  380. data/spec/models/save_vendor_spec.rb +118 -0
  381. data/spec/models/save_work_order_spec.rb +92 -0
  382. data/spec/models/save_work_order_task_spec.rb +70 -0
  383. data/spec/models/split_paid_spec.rb +82 -0
  384. data/spec/models/split_pay_spec.rb +40 -0
  385. data/spec/models/task_spec.rb +106 -0
  386. data/spec/models/transaction_spec.rb +146 -0
  387. data/spec/models/unit_spec.rb +280 -0
  388. data/spec/models/update_lease_journal_entry_spec.rb +58 -0
  389. data/spec/models/vendor_spec.rb +208 -0
  390. data/spec/models/work_order_spec.rb +218 -0
  391. data/spec/spec_helper.rb +111 -0
  392. metadata +609 -0
data/docs/LeasesApi.md ADDED
@@ -0,0 +1,3319 @@
1
+ # Propertyware::LeasesApi
2
+
3
+ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_comment_to_lease_conversation**](LeasesApi.md#add_comment_to_lease_conversation) | **POST** /leases/{leaseID}/conversations/{conversationID}/comments | Add comment to a lease conversation (BETA) |
8
+ | [**create_journal_entry**](LeasesApi.md#create_journal_entry) | **POST** /leases/journalentries | Create a lease journal entry (BETA) |
9
+ | [**create_lease**](LeasesApi.md#create_lease) | **POST** /leases | Create a lease (BETA) |
10
+ | [**create_lease_adjustment**](LeasesApi.md#create_lease_adjustment) | **POST** /leases/adjustments | Create a lease adjustment (BETA) |
11
+ | [**create_lease_charge**](LeasesApi.md#create_lease_charge) | **POST** /leases/charges | Create a lease charge (BETA) |
12
+ | [**create_lease_charges**](LeasesApi.md#create_lease_charges) | **POST** /leases/charges/bulk | Create lease charges in bulk (BETA) |
13
+ | [**create_lease_conversation**](LeasesApi.md#create_lease_conversation) | **POST** /leases/{leaseID}/conversations | Create a lease conversation (BETA) |
14
+ | [**create_lease_discount**](LeasesApi.md#create_lease_discount) | **POST** /leases/discounts | Create a lease discount (BETA) |
15
+ | [**create_lease_payment**](LeasesApi.md#create_lease_payment) | **POST** /leases/payments | Create a lease payment (BETA) |
16
+ | [**create_lease_refund**](LeasesApi.md#create_lease_refund) | **POST** /leases/refunds | Create a lease refund (BETA) |
17
+ | [**delete_lease**](LeasesApi.md#delete_lease) | **DELETE** /leases/{leaseID} | Delete a lease (BETA) |
18
+ | [**delete_lease_conversation**](LeasesApi.md#delete_lease_conversation) | **DELETE** /leases/{leaseID}/conversations/{conversationID} | Delete a lease conversation (BETA) |
19
+ | [**get_lease**](LeasesApi.md#get_lease) | **GET** /leases/{leaseId} | Retrieve a lease |
20
+ | [**get_lease_adjustments**](LeasesApi.md#get_lease_adjustments) | **GET** /leases/adjustments | Retrieve all the adjustments |
21
+ | [**get_lease_auto_charges**](LeasesApi.md#get_lease_auto_charges) | **GET** /leases/{leaseId}/autocharges | Retrieve all lease auto charges |
22
+ | [**get_lease_auto_e_payments**](LeasesApi.md#get_lease_auto_e_payments) | **GET** /leases/{leaseId}/autoepayments | Retrieve all lease auto ePayments (BETA) |
23
+ | [**get_lease_auto_journal_entries**](LeasesApi.md#get_lease_auto_journal_entries) | **GET** /leases/{leaseId}/autojournalentries | Retrieve all lease auto journal entries (BETA) |
24
+ | [**get_lease_charges**](LeasesApi.md#get_lease_charges) | **GET** /leases/charges | Retrieve all the lease charges |
25
+ | [**get_lease_contacts**](LeasesApi.md#get_lease_contacts) | **GET** /leases/{leaseId}/contacts | Retrieve all lease contacts |
26
+ | [**get_lease_conversation**](LeasesApi.md#get_lease_conversation) | **GET** /leases/{leaseID}/conversations/{conversationID} | Retrieve a lease conversation |
27
+ | [**get_lease_conversations**](LeasesApi.md#get_lease_conversations) | **GET** /leases/{leaseID}/conversations | Retrieve all lease conversations |
28
+ | [**get_lease_custom_fields**](LeasesApi.md#get_lease_custom_fields) | **GET** /leases/{leaseId}/customfields | Retrieve all lease custom fields |
29
+ | [**get_lease_discounts**](LeasesApi.md#get_lease_discounts) | **GET** /leases/discounts | Retrieve all the lease discounts |
30
+ | [**get_lease_documents**](LeasesApi.md#get_lease_documents) | **GET** /leases/{leaseId}/document | Retrieve all lease documents |
31
+ | [**get_lease_journal_entry**](LeasesApi.md#get_lease_journal_entry) | **GET** /leases/journalentries/{leaseID} | Retrieve all lease journal entries |
32
+ | [**get_lease_late_fee**](LeasesApi.md#get_lease_late_fee) | **GET** /leases/{leaseId}/latefeerule | Retrieve the lease late fee rule |
33
+ | [**get_lease_notes**](LeasesApi.md#get_lease_notes) | **GET** /leases/{leaseId}/notes | Retrieve all lease notes |
34
+ | [**get_lease_payments**](LeasesApi.md#get_lease_payments) | **GET** /leases/payments | Retrieve all the lease payments |
35
+ | [**get_lease_refunds**](LeasesApi.md#get_lease_refunds) | **GET** /leases/refunds | Retrieve all the tenant refunds |
36
+ | [**get_lease_work_orders**](LeasesApi.md#get_lease_work_orders) | **GET** /leases/{leaseId}/workorders | Retrieve all lease work orders |
37
+ | [**get_leases**](LeasesApi.md#get_leases) | **GET** /leases | Retrieve all leases |
38
+ | [**update_lease**](LeasesApi.md#update_lease) | **PUT** /leases/{leaseId} | Update a lease (BETA) |
39
+ | [**update_lease_adjustment**](LeasesApi.md#update_lease_adjustment) | **PUT** /leases/adjustments/{adjustmentID} | Update a lease adjustment (BETA) |
40
+ | [**update_lease_charge**](LeasesApi.md#update_lease_charge) | **PUT** /leases/charges/{chargeID} | Update a lease charge (BETA) |
41
+ | [**update_lease_discount**](LeasesApi.md#update_lease_discount) | **PUT** /leases/discounts/{discountID} | Updates a lease Discount (BETA) |
42
+ | [**update_lease_journal_entry**](LeasesApi.md#update_lease_journal_entry) | **PUT** /leases/journalentries/{journalentryID} | Update a lease journal entry (BETA) |
43
+ | [**update_lease_payment**](LeasesApi.md#update_lease_payment) | **PUT** /leases/payments/{entityID} | Update a lease payment (BETA) |
44
+ | [**update_lease_refund**](LeasesApi.md#update_lease_refund) | **PUT** /leases/refunds/{refundID} | Update a lease refund (BETA) |
45
+
46
+
47
+ ## add_comment_to_lease_conversation
48
+
49
+ > <Comment> add_comment_to_lease_conversation(lease_id, conversation_id, save_comment)
50
+
51
+ Add comment to a lease conversation (BETA)
52
+
53
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Adds comment to a lease conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
54
+
55
+ ### Examples
56
+
57
+ ```ruby
58
+ require 'time'
59
+ require 'propertyware'
60
+ # setup authorization
61
+ Propertyware.configure do |config|
62
+ # Configure API key authorization: organizationId
63
+ config.api_key['organizationId'] = 'YOUR API KEY'
64
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
65
+ # config.api_key_prefix['organizationId'] = 'Bearer'
66
+
67
+ # Configure API key authorization: clientId
68
+ config.api_key['clientId'] = 'YOUR API KEY'
69
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
70
+ # config.api_key_prefix['clientId'] = 'Bearer'
71
+
72
+ # Configure API key authorization: clientSecret
73
+ config.api_key['clientSecret'] = 'YOUR API KEY'
74
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
75
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
76
+ end
77
+
78
+ api_instance = Propertyware::LeasesApi.new
79
+ lease_id = 789 # Integer | Lease ID
80
+ conversation_id = 789 # Integer | Conversation ID
81
+ save_comment = Propertyware::SaveComment.new({text: 'text_example'}) # SaveComment | saveComment
82
+
83
+ begin
84
+ # Add comment to a lease conversation (BETA)
85
+ result = api_instance.add_comment_to_lease_conversation(lease_id, conversation_id, save_comment)
86
+ p result
87
+ rescue Propertyware::ApiError => e
88
+ puts "Error when calling LeasesApi->add_comment_to_lease_conversation: #{e}"
89
+ end
90
+ ```
91
+
92
+ #### Using the add_comment_to_lease_conversation_with_http_info variant
93
+
94
+ This returns an Array which contains the response data, status code and headers.
95
+
96
+ > <Array(<Comment>, Integer, Hash)> add_comment_to_lease_conversation_with_http_info(lease_id, conversation_id, save_comment)
97
+
98
+ ```ruby
99
+ begin
100
+ # Add comment to a lease conversation (BETA)
101
+ data, status_code, headers = api_instance.add_comment_to_lease_conversation_with_http_info(lease_id, conversation_id, save_comment)
102
+ p status_code # => 2xx
103
+ p headers # => { ... }
104
+ p data # => <Comment>
105
+ rescue Propertyware::ApiError => e
106
+ puts "Error when calling LeasesApi->add_comment_to_lease_conversation_with_http_info: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ | Name | Type | Description | Notes |
113
+ | ---- | ---- | ----------- | ----- |
114
+ | **lease_id** | **Integer** | Lease ID | |
115
+ | **conversation_id** | **Integer** | Conversation ID | |
116
+ | **save_comment** | [**SaveComment**](SaveComment.md) | saveComment | |
117
+
118
+ ### Return type
119
+
120
+ [**Comment**](Comment.md)
121
+
122
+ ### Authorization
123
+
124
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
125
+
126
+ ### HTTP request headers
127
+
128
+ - **Content-Type**: application/json
129
+ - **Accept**: application/json
130
+
131
+
132
+ ## create_journal_entry
133
+
134
+ > <JournalEntry> create_journal_entry(save_lease_journal_entry)
135
+
136
+ Create a lease journal entry (BETA)
137
+
138
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease journal entry.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
139
+
140
+ ### Examples
141
+
142
+ ```ruby
143
+ require 'time'
144
+ require 'propertyware'
145
+ # setup authorization
146
+ Propertyware.configure do |config|
147
+ # Configure API key authorization: organizationId
148
+ config.api_key['organizationId'] = 'YOUR API KEY'
149
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
150
+ # config.api_key_prefix['organizationId'] = 'Bearer'
151
+
152
+ # Configure API key authorization: clientId
153
+ config.api_key['clientId'] = 'YOUR API KEY'
154
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
155
+ # config.api_key_prefix['clientId'] = 'Bearer'
156
+
157
+ # Configure API key authorization: clientSecret
158
+ config.api_key['clientSecret'] = 'YOUR API KEY'
159
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
160
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
161
+ end
162
+
163
+ api_instance = Propertyware::LeasesApi.new
164
+ save_lease_journal_entry = Propertyware::SaveLeaseJournalEntry.new({comments: 'comments_example', date: Date.today, lease_id: 3.56}) # SaveLeaseJournalEntry | saveLeaseJournalEntry
165
+
166
+ begin
167
+ # Create a lease journal entry (BETA)
168
+ result = api_instance.create_journal_entry(save_lease_journal_entry)
169
+ p result
170
+ rescue Propertyware::ApiError => e
171
+ puts "Error when calling LeasesApi->create_journal_entry: #{e}"
172
+ end
173
+ ```
174
+
175
+ #### Using the create_journal_entry_with_http_info variant
176
+
177
+ This returns an Array which contains the response data, status code and headers.
178
+
179
+ > <Array(<JournalEntry>, Integer, Hash)> create_journal_entry_with_http_info(save_lease_journal_entry)
180
+
181
+ ```ruby
182
+ begin
183
+ # Create a lease journal entry (BETA)
184
+ data, status_code, headers = api_instance.create_journal_entry_with_http_info(save_lease_journal_entry)
185
+ p status_code # => 2xx
186
+ p headers # => { ... }
187
+ p data # => <JournalEntry>
188
+ rescue Propertyware::ApiError => e
189
+ puts "Error when calling LeasesApi->create_journal_entry_with_http_info: #{e}"
190
+ end
191
+ ```
192
+
193
+ ### Parameters
194
+
195
+ | Name | Type | Description | Notes |
196
+ | ---- | ---- | ----------- | ----- |
197
+ | **save_lease_journal_entry** | [**SaveLeaseJournalEntry**](SaveLeaseJournalEntry.md) | saveLeaseJournalEntry | |
198
+
199
+ ### Return type
200
+
201
+ [**JournalEntry**](JournalEntry.md)
202
+
203
+ ### Authorization
204
+
205
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## create_lease
214
+
215
+ > <Lease> create_lease(save_lease)
216
+
217
+ Create a lease (BETA)
218
+
219
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a new lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
220
+
221
+ ### Examples
222
+
223
+ ```ruby
224
+ require 'time'
225
+ require 'propertyware'
226
+ # setup authorization
227
+ Propertyware.configure do |config|
228
+ # Configure API key authorization: organizationId
229
+ config.api_key['organizationId'] = 'YOUR API KEY'
230
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
231
+ # config.api_key_prefix['organizationId'] = 'Bearer'
232
+
233
+ # Configure API key authorization: clientId
234
+ config.api_key['clientId'] = 'YOUR API KEY'
235
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
236
+ # config.api_key_prefix['clientId'] = 'Bearer'
237
+
238
+ # Configure API key authorization: clientSecret
239
+ config.api_key['clientSecret'] = 'YOUR API KEY'
240
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
241
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
242
+ end
243
+
244
+ api_instance = Propertyware::LeasesApi.new
245
+ save_lease = Propertyware::SaveLease.new({end_date: Date.today, move_in_date: Date.today, primary_contact_id: 3.56, start_date: Date.today, tenant_ids: [3.56], unit_id: 3.56}) # SaveLease | saveLease
246
+
247
+ begin
248
+ # Create a lease (BETA)
249
+ result = api_instance.create_lease(save_lease)
250
+ p result
251
+ rescue Propertyware::ApiError => e
252
+ puts "Error when calling LeasesApi->create_lease: #{e}"
253
+ end
254
+ ```
255
+
256
+ #### Using the create_lease_with_http_info variant
257
+
258
+ This returns an Array which contains the response data, status code and headers.
259
+
260
+ > <Array(<Lease>, Integer, Hash)> create_lease_with_http_info(save_lease)
261
+
262
+ ```ruby
263
+ begin
264
+ # Create a lease (BETA)
265
+ data, status_code, headers = api_instance.create_lease_with_http_info(save_lease)
266
+ p status_code # => 2xx
267
+ p headers # => { ... }
268
+ p data # => <Lease>
269
+ rescue Propertyware::ApiError => e
270
+ puts "Error when calling LeasesApi->create_lease_with_http_info: #{e}"
271
+ end
272
+ ```
273
+
274
+ ### Parameters
275
+
276
+ | Name | Type | Description | Notes |
277
+ | ---- | ---- | ----------- | ----- |
278
+ | **save_lease** | [**SaveLease**](SaveLease.md) | saveLease | |
279
+
280
+ ### Return type
281
+
282
+ [**Lease**](Lease.md)
283
+
284
+ ### Authorization
285
+
286
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
287
+
288
+ ### HTTP request headers
289
+
290
+ - **Content-Type**: application/json
291
+ - **Accept**: application/json
292
+
293
+
294
+ ## create_lease_adjustment
295
+
296
+ > <ChargeTx> create_lease_adjustment(save_adjustment)
297
+
298
+ Create a lease adjustment (BETA)
299
+
300
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease adjustment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
301
+
302
+ ### Examples
303
+
304
+ ```ruby
305
+ require 'time'
306
+ require 'propertyware'
307
+ # setup authorization
308
+ Propertyware.configure do |config|
309
+ # Configure API key authorization: organizationId
310
+ config.api_key['organizationId'] = 'YOUR API KEY'
311
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
312
+ # config.api_key_prefix['organizationId'] = 'Bearer'
313
+
314
+ # Configure API key authorization: clientId
315
+ config.api_key['clientId'] = 'YOUR API KEY'
316
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
317
+ # config.api_key_prefix['clientId'] = 'Bearer'
318
+
319
+ # Configure API key authorization: clientSecret
320
+ config.api_key['clientSecret'] = 'YOUR API KEY'
321
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
322
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
323
+ end
324
+
325
+ api_instance = Propertyware::LeasesApi.new
326
+ save_adjustment = Propertyware::SaveAdjustment.new({amount: 3.56, lease_id: 3.56}) # SaveAdjustment | saveAdjustment
327
+
328
+ begin
329
+ # Create a lease adjustment (BETA)
330
+ result = api_instance.create_lease_adjustment(save_adjustment)
331
+ p result
332
+ rescue Propertyware::ApiError => e
333
+ puts "Error when calling LeasesApi->create_lease_adjustment: #{e}"
334
+ end
335
+ ```
336
+
337
+ #### Using the create_lease_adjustment_with_http_info variant
338
+
339
+ This returns an Array which contains the response data, status code and headers.
340
+
341
+ > <Array(<ChargeTx>, Integer, Hash)> create_lease_adjustment_with_http_info(save_adjustment)
342
+
343
+ ```ruby
344
+ begin
345
+ # Create a lease adjustment (BETA)
346
+ data, status_code, headers = api_instance.create_lease_adjustment_with_http_info(save_adjustment)
347
+ p status_code # => 2xx
348
+ p headers # => { ... }
349
+ p data # => <ChargeTx>
350
+ rescue Propertyware::ApiError => e
351
+ puts "Error when calling LeasesApi->create_lease_adjustment_with_http_info: #{e}"
352
+ end
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ | Name | Type | Description | Notes |
358
+ | ---- | ---- | ----------- | ----- |
359
+ | **save_adjustment** | [**SaveAdjustment**](SaveAdjustment.md) | saveAdjustment | |
360
+
361
+ ### Return type
362
+
363
+ [**ChargeTx**](ChargeTx.md)
364
+
365
+ ### Authorization
366
+
367
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
368
+
369
+ ### HTTP request headers
370
+
371
+ - **Content-Type**: application/json
372
+ - **Accept**: application/json
373
+
374
+
375
+ ## create_lease_charge
376
+
377
+ > <ChargeTx> create_lease_charge(save_charge)
378
+
379
+ Create a lease charge (BETA)
380
+
381
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease charge.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
382
+
383
+ ### Examples
384
+
385
+ ```ruby
386
+ require 'time'
387
+ require 'propertyware'
388
+ # setup authorization
389
+ Propertyware.configure do |config|
390
+ # Configure API key authorization: organizationId
391
+ config.api_key['organizationId'] = 'YOUR API KEY'
392
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
393
+ # config.api_key_prefix['organizationId'] = 'Bearer'
394
+
395
+ # Configure API key authorization: clientId
396
+ config.api_key['clientId'] = 'YOUR API KEY'
397
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
398
+ # config.api_key_prefix['clientId'] = 'Bearer'
399
+
400
+ # Configure API key authorization: clientSecret
401
+ config.api_key['clientSecret'] = 'YOUR API KEY'
402
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
404
+ end
405
+
406
+ api_instance = Propertyware::LeasesApi.new
407
+ save_charge = Propertyware::SaveCharge.new({amount: 3.56, date: Date.today, gl_account_id: 3.56, lease_id: 3.56}) # SaveCharge | saveCharge
408
+
409
+ begin
410
+ # Create a lease charge (BETA)
411
+ result = api_instance.create_lease_charge(save_charge)
412
+ p result
413
+ rescue Propertyware::ApiError => e
414
+ puts "Error when calling LeasesApi->create_lease_charge: #{e}"
415
+ end
416
+ ```
417
+
418
+ #### Using the create_lease_charge_with_http_info variant
419
+
420
+ This returns an Array which contains the response data, status code and headers.
421
+
422
+ > <Array(<ChargeTx>, Integer, Hash)> create_lease_charge_with_http_info(save_charge)
423
+
424
+ ```ruby
425
+ begin
426
+ # Create a lease charge (BETA)
427
+ data, status_code, headers = api_instance.create_lease_charge_with_http_info(save_charge)
428
+ p status_code # => 2xx
429
+ p headers # => { ... }
430
+ p data # => <ChargeTx>
431
+ rescue Propertyware::ApiError => e
432
+ puts "Error when calling LeasesApi->create_lease_charge_with_http_info: #{e}"
433
+ end
434
+ ```
435
+
436
+ ### Parameters
437
+
438
+ | Name | Type | Description | Notes |
439
+ | ---- | ---- | ----------- | ----- |
440
+ | **save_charge** | [**SaveCharge**](SaveCharge.md) | saveCharge | |
441
+
442
+ ### Return type
443
+
444
+ [**ChargeTx**](ChargeTx.md)
445
+
446
+ ### Authorization
447
+
448
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
449
+
450
+ ### HTTP request headers
451
+
452
+ - **Content-Type**: application/json
453
+ - **Accept**: application/json
454
+
455
+
456
+ ## create_lease_charges
457
+
458
+ > <Array<RESTAPIBulkSuccessResponse>> create_lease_charges(save_charge)
459
+
460
+ Create lease charges in bulk (BETA)
461
+
462
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates lease charges in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
463
+
464
+ ### Examples
465
+
466
+ ```ruby
467
+ require 'time'
468
+ require 'propertyware'
469
+ # setup authorization
470
+ Propertyware.configure do |config|
471
+ # Configure API key authorization: organizationId
472
+ config.api_key['organizationId'] = 'YOUR API KEY'
473
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
474
+ # config.api_key_prefix['organizationId'] = 'Bearer'
475
+
476
+ # Configure API key authorization: clientId
477
+ config.api_key['clientId'] = 'YOUR API KEY'
478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
479
+ # config.api_key_prefix['clientId'] = 'Bearer'
480
+
481
+ # Configure API key authorization: clientSecret
482
+ config.api_key['clientSecret'] = 'YOUR API KEY'
483
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
484
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
485
+ end
486
+
487
+ api_instance = Propertyware::LeasesApi.new
488
+ save_charge = [Propertyware::SaveCharge.new({amount: 3.56, date: Date.today, gl_account_id: 3.56, lease_id: 3.56})] # Array<SaveCharge> | saveCharge
489
+
490
+ begin
491
+ # Create lease charges in bulk (BETA)
492
+ result = api_instance.create_lease_charges(save_charge)
493
+ p result
494
+ rescue Propertyware::ApiError => e
495
+ puts "Error when calling LeasesApi->create_lease_charges: #{e}"
496
+ end
497
+ ```
498
+
499
+ #### Using the create_lease_charges_with_http_info variant
500
+
501
+ This returns an Array which contains the response data, status code and headers.
502
+
503
+ > <Array(<Array<RESTAPIBulkSuccessResponse>>, Integer, Hash)> create_lease_charges_with_http_info(save_charge)
504
+
505
+ ```ruby
506
+ begin
507
+ # Create lease charges in bulk (BETA)
508
+ data, status_code, headers = api_instance.create_lease_charges_with_http_info(save_charge)
509
+ p status_code # => 2xx
510
+ p headers # => { ... }
511
+ p data # => <Array<RESTAPIBulkSuccessResponse>>
512
+ rescue Propertyware::ApiError => e
513
+ puts "Error when calling LeasesApi->create_lease_charges_with_http_info: #{e}"
514
+ end
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ | Name | Type | Description | Notes |
520
+ | ---- | ---- | ----------- | ----- |
521
+ | **save_charge** | [**Array&lt;SaveCharge&gt;**](SaveCharge.md) | saveCharge | |
522
+
523
+ ### Return type
524
+
525
+ [**Array&lt;RESTAPIBulkSuccessResponse&gt;**](RESTAPIBulkSuccessResponse.md)
526
+
527
+ ### Authorization
528
+
529
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: application/json
534
+ - **Accept**: application/json
535
+
536
+
537
+ ## create_lease_conversation
538
+
539
+ > <Conversation> create_lease_conversation(lease_id, save_conversation)
540
+
541
+ Create a lease conversation (BETA)
542
+
543
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
544
+
545
+ ### Examples
546
+
547
+ ```ruby
548
+ require 'time'
549
+ require 'propertyware'
550
+ # setup authorization
551
+ Propertyware.configure do |config|
552
+ # Configure API key authorization: organizationId
553
+ config.api_key['organizationId'] = 'YOUR API KEY'
554
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
555
+ # config.api_key_prefix['organizationId'] = 'Bearer'
556
+
557
+ # Configure API key authorization: clientId
558
+ config.api_key['clientId'] = 'YOUR API KEY'
559
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
560
+ # config.api_key_prefix['clientId'] = 'Bearer'
561
+
562
+ # Configure API key authorization: clientSecret
563
+ config.api_key['clientSecret'] = 'YOUR API KEY'
564
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
565
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
566
+ end
567
+
568
+ api_instance = Propertyware::LeasesApi.new
569
+ lease_id = 789 # Integer | Lease ID
570
+ save_conversation = Propertyware::SaveConversation.new({text: 'text_example', type: 'MANAGEMENT_TEAM'}) # SaveConversation | saveConversation
571
+
572
+ begin
573
+ # Create a lease conversation (BETA)
574
+ result = api_instance.create_lease_conversation(lease_id, save_conversation)
575
+ p result
576
+ rescue Propertyware::ApiError => e
577
+ puts "Error when calling LeasesApi->create_lease_conversation: #{e}"
578
+ end
579
+ ```
580
+
581
+ #### Using the create_lease_conversation_with_http_info variant
582
+
583
+ This returns an Array which contains the response data, status code and headers.
584
+
585
+ > <Array(<Conversation>, Integer, Hash)> create_lease_conversation_with_http_info(lease_id, save_conversation)
586
+
587
+ ```ruby
588
+ begin
589
+ # Create a lease conversation (BETA)
590
+ data, status_code, headers = api_instance.create_lease_conversation_with_http_info(lease_id, save_conversation)
591
+ p status_code # => 2xx
592
+ p headers # => { ... }
593
+ p data # => <Conversation>
594
+ rescue Propertyware::ApiError => e
595
+ puts "Error when calling LeasesApi->create_lease_conversation_with_http_info: #{e}"
596
+ end
597
+ ```
598
+
599
+ ### Parameters
600
+
601
+ | Name | Type | Description | Notes |
602
+ | ---- | ---- | ----------- | ----- |
603
+ | **lease_id** | **Integer** | Lease ID | |
604
+ | **save_conversation** | [**SaveConversation**](SaveConversation.md) | saveConversation | |
605
+
606
+ ### Return type
607
+
608
+ [**Conversation**](Conversation.md)
609
+
610
+ ### Authorization
611
+
612
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
613
+
614
+ ### HTTP request headers
615
+
616
+ - **Content-Type**: application/json
617
+ - **Accept**: application/json
618
+
619
+
620
+ ## create_lease_discount
621
+
622
+ > <Discount> create_lease_discount(save_discount)
623
+
624
+ Create a lease discount (BETA)
625
+
626
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease discount.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
627
+
628
+ ### Examples
629
+
630
+ ```ruby
631
+ require 'time'
632
+ require 'propertyware'
633
+ # setup authorization
634
+ Propertyware.configure do |config|
635
+ # Configure API key authorization: organizationId
636
+ config.api_key['organizationId'] = 'YOUR API KEY'
637
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
638
+ # config.api_key_prefix['organizationId'] = 'Bearer'
639
+
640
+ # Configure API key authorization: clientId
641
+ config.api_key['clientId'] = 'YOUR API KEY'
642
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
643
+ # config.api_key_prefix['clientId'] = 'Bearer'
644
+
645
+ # Configure API key authorization: clientSecret
646
+ config.api_key['clientSecret'] = 'YOUR API KEY'
647
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
648
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
649
+ end
650
+
651
+ api_instance = Propertyware::LeasesApi.new
652
+ save_discount = Propertyware::SaveDiscount.new({amount: 3.56, date: Date.today, discount_account_id: 3.56, lease_id: 3.56}) # SaveDiscount | saveDiscount
653
+
654
+ begin
655
+ # Create a lease discount (BETA)
656
+ result = api_instance.create_lease_discount(save_discount)
657
+ p result
658
+ rescue Propertyware::ApiError => e
659
+ puts "Error when calling LeasesApi->create_lease_discount: #{e}"
660
+ end
661
+ ```
662
+
663
+ #### Using the create_lease_discount_with_http_info variant
664
+
665
+ This returns an Array which contains the response data, status code and headers.
666
+
667
+ > <Array(<Discount>, Integer, Hash)> create_lease_discount_with_http_info(save_discount)
668
+
669
+ ```ruby
670
+ begin
671
+ # Create a lease discount (BETA)
672
+ data, status_code, headers = api_instance.create_lease_discount_with_http_info(save_discount)
673
+ p status_code # => 2xx
674
+ p headers # => { ... }
675
+ p data # => <Discount>
676
+ rescue Propertyware::ApiError => e
677
+ puts "Error when calling LeasesApi->create_lease_discount_with_http_info: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ | Name | Type | Description | Notes |
684
+ | ---- | ---- | ----------- | ----- |
685
+ | **save_discount** | [**SaveDiscount**](SaveDiscount.md) | saveDiscount | |
686
+
687
+ ### Return type
688
+
689
+ [**Discount**](Discount.md)
690
+
691
+ ### Authorization
692
+
693
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
694
+
695
+ ### HTTP request headers
696
+
697
+ - **Content-Type**: application/json
698
+ - **Accept**: application/json
699
+
700
+
701
+ ## create_lease_payment
702
+
703
+ > <Payment> create_lease_payment(save_payment)
704
+
705
+ Create a lease payment (BETA)
706
+
707
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease payment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
708
+
709
+ ### Examples
710
+
711
+ ```ruby
712
+ require 'time'
713
+ require 'propertyware'
714
+ # setup authorization
715
+ Propertyware.configure do |config|
716
+ # Configure API key authorization: organizationId
717
+ config.api_key['organizationId'] = 'YOUR API KEY'
718
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
719
+ # config.api_key_prefix['organizationId'] = 'Bearer'
720
+
721
+ # Configure API key authorization: clientId
722
+ config.api_key['clientId'] = 'YOUR API KEY'
723
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
724
+ # config.api_key_prefix['clientId'] = 'Bearer'
725
+
726
+ # Configure API key authorization: clientSecret
727
+ config.api_key['clientSecret'] = 'YOUR API KEY'
728
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
729
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
730
+ end
731
+
732
+ api_instance = Propertyware::LeasesApi.new
733
+ save_payment = Propertyware::SavePayment.new({amount: 3.56, contact_id: 3.56, date: Date.today, deposit_date: Date.today, destination_account_id: 3.56, lease_id: 3.56, payment_type: 'CHECK', ref_no: 'ref_no_example'}) # SavePayment | savePayment
734
+
735
+ begin
736
+ # Create a lease payment (BETA)
737
+ result = api_instance.create_lease_payment(save_payment)
738
+ p result
739
+ rescue Propertyware::ApiError => e
740
+ puts "Error when calling LeasesApi->create_lease_payment: #{e}"
741
+ end
742
+ ```
743
+
744
+ #### Using the create_lease_payment_with_http_info variant
745
+
746
+ This returns an Array which contains the response data, status code and headers.
747
+
748
+ > <Array(<Payment>, Integer, Hash)> create_lease_payment_with_http_info(save_payment)
749
+
750
+ ```ruby
751
+ begin
752
+ # Create a lease payment (BETA)
753
+ data, status_code, headers = api_instance.create_lease_payment_with_http_info(save_payment)
754
+ p status_code # => 2xx
755
+ p headers # => { ... }
756
+ p data # => <Payment>
757
+ rescue Propertyware::ApiError => e
758
+ puts "Error when calling LeasesApi->create_lease_payment_with_http_info: #{e}"
759
+ end
760
+ ```
761
+
762
+ ### Parameters
763
+
764
+ | Name | Type | Description | Notes |
765
+ | ---- | ---- | ----------- | ----- |
766
+ | **save_payment** | [**SavePayment**](SavePayment.md) | savePayment | |
767
+
768
+ ### Return type
769
+
770
+ [**Payment**](Payment.md)
771
+
772
+ ### Authorization
773
+
774
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: application/json
779
+ - **Accept**: application/json
780
+
781
+
782
+ ## create_lease_refund
783
+
784
+ > <Refund> create_lease_refund(save_refund)
785
+
786
+ Create a lease refund (BETA)
787
+
788
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease refund.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
789
+
790
+ ### Examples
791
+
792
+ ```ruby
793
+ require 'time'
794
+ require 'propertyware'
795
+ # setup authorization
796
+ Propertyware.configure do |config|
797
+ # Configure API key authorization: organizationId
798
+ config.api_key['organizationId'] = 'YOUR API KEY'
799
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
800
+ # config.api_key_prefix['organizationId'] = 'Bearer'
801
+
802
+ # Configure API key authorization: clientId
803
+ config.api_key['clientId'] = 'YOUR API KEY'
804
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
805
+ # config.api_key_prefix['clientId'] = 'Bearer'
806
+
807
+ # Configure API key authorization: clientSecret
808
+ config.api_key['clientSecret'] = 'YOUR API KEY'
809
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
810
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
811
+ end
812
+
813
+ api_instance = Propertyware::LeasesApi.new
814
+ save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56, to_be_printed: false, to_primary_tenant: false}) # SaveRefund | saveRefund
815
+
816
+ begin
817
+ # Create a lease refund (BETA)
818
+ result = api_instance.create_lease_refund(save_refund)
819
+ p result
820
+ rescue Propertyware::ApiError => e
821
+ puts "Error when calling LeasesApi->create_lease_refund: #{e}"
822
+ end
823
+ ```
824
+
825
+ #### Using the create_lease_refund_with_http_info variant
826
+
827
+ This returns an Array which contains the response data, status code and headers.
828
+
829
+ > <Array(<Refund>, Integer, Hash)> create_lease_refund_with_http_info(save_refund)
830
+
831
+ ```ruby
832
+ begin
833
+ # Create a lease refund (BETA)
834
+ data, status_code, headers = api_instance.create_lease_refund_with_http_info(save_refund)
835
+ p status_code # => 2xx
836
+ p headers # => { ... }
837
+ p data # => <Refund>
838
+ rescue Propertyware::ApiError => e
839
+ puts "Error when calling LeasesApi->create_lease_refund_with_http_info: #{e}"
840
+ end
841
+ ```
842
+
843
+ ### Parameters
844
+
845
+ | Name | Type | Description | Notes |
846
+ | ---- | ---- | ----------- | ----- |
847
+ | **save_refund** | [**SaveRefund**](SaveRefund.md) | saveRefund | |
848
+
849
+ ### Return type
850
+
851
+ [**Refund**](Refund.md)
852
+
853
+ ### Authorization
854
+
855
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
856
+
857
+ ### HTTP request headers
858
+
859
+ - **Content-Type**: application/json
860
+ - **Accept**: application/json
861
+
862
+
863
+ ## delete_lease
864
+
865
+ > <ResponseEntity> delete_lease(lease_id)
866
+
867
+ Delete a lease (BETA)
868
+
869
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Deletes a lease<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Delete</code>
870
+
871
+ ### Examples
872
+
873
+ ```ruby
874
+ require 'time'
875
+ require 'propertyware'
876
+ # setup authorization
877
+ Propertyware.configure do |config|
878
+ # Configure API key authorization: organizationId
879
+ config.api_key['organizationId'] = 'YOUR API KEY'
880
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
881
+ # config.api_key_prefix['organizationId'] = 'Bearer'
882
+
883
+ # Configure API key authorization: clientId
884
+ config.api_key['clientId'] = 'YOUR API KEY'
885
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
886
+ # config.api_key_prefix['clientId'] = 'Bearer'
887
+
888
+ # Configure API key authorization: clientSecret
889
+ config.api_key['clientSecret'] = 'YOUR API KEY'
890
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
891
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
892
+ end
893
+
894
+ api_instance = Propertyware::LeasesApi.new
895
+ lease_id = 789 # Integer | Lease ID
896
+
897
+ begin
898
+ # Delete a lease (BETA)
899
+ result = api_instance.delete_lease(lease_id)
900
+ p result
901
+ rescue Propertyware::ApiError => e
902
+ puts "Error when calling LeasesApi->delete_lease: #{e}"
903
+ end
904
+ ```
905
+
906
+ #### Using the delete_lease_with_http_info variant
907
+
908
+ This returns an Array which contains the response data, status code and headers.
909
+
910
+ > <Array(<ResponseEntity>, Integer, Hash)> delete_lease_with_http_info(lease_id)
911
+
912
+ ```ruby
913
+ begin
914
+ # Delete a lease (BETA)
915
+ data, status_code, headers = api_instance.delete_lease_with_http_info(lease_id)
916
+ p status_code # => 2xx
917
+ p headers # => { ... }
918
+ p data # => <ResponseEntity>
919
+ rescue Propertyware::ApiError => e
920
+ puts "Error when calling LeasesApi->delete_lease_with_http_info: #{e}"
921
+ end
922
+ ```
923
+
924
+ ### Parameters
925
+
926
+ | Name | Type | Description | Notes |
927
+ | ---- | ---- | ----------- | ----- |
928
+ | **lease_id** | **Integer** | Lease ID | |
929
+
930
+ ### Return type
931
+
932
+ [**ResponseEntity**](ResponseEntity.md)
933
+
934
+ ### Authorization
935
+
936
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: Not defined
941
+ - **Accept**: */*
942
+
943
+
944
+ ## delete_lease_conversation
945
+
946
+ > <ResponseEntity> delete_lease_conversation(lease_id, conversation_id)
947
+
948
+ Delete a lease conversation (BETA)
949
+
950
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Deletes a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Delete</code>
951
+
952
+ ### Examples
953
+
954
+ ```ruby
955
+ require 'time'
956
+ require 'propertyware'
957
+ # setup authorization
958
+ Propertyware.configure do |config|
959
+ # Configure API key authorization: organizationId
960
+ config.api_key['organizationId'] = 'YOUR API KEY'
961
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
962
+ # config.api_key_prefix['organizationId'] = 'Bearer'
963
+
964
+ # Configure API key authorization: clientId
965
+ config.api_key['clientId'] = 'YOUR API KEY'
966
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
967
+ # config.api_key_prefix['clientId'] = 'Bearer'
968
+
969
+ # Configure API key authorization: clientSecret
970
+ config.api_key['clientSecret'] = 'YOUR API KEY'
971
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
972
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
973
+ end
974
+
975
+ api_instance = Propertyware::LeasesApi.new
976
+ lease_id = 789 # Integer | Lease ID
977
+ conversation_id = 789 # Integer | Conversation ID
978
+
979
+ begin
980
+ # Delete a lease conversation (BETA)
981
+ result = api_instance.delete_lease_conversation(lease_id, conversation_id)
982
+ p result
983
+ rescue Propertyware::ApiError => e
984
+ puts "Error when calling LeasesApi->delete_lease_conversation: #{e}"
985
+ end
986
+ ```
987
+
988
+ #### Using the delete_lease_conversation_with_http_info variant
989
+
990
+ This returns an Array which contains the response data, status code and headers.
991
+
992
+ > <Array(<ResponseEntity>, Integer, Hash)> delete_lease_conversation_with_http_info(lease_id, conversation_id)
993
+
994
+ ```ruby
995
+ begin
996
+ # Delete a lease conversation (BETA)
997
+ data, status_code, headers = api_instance.delete_lease_conversation_with_http_info(lease_id, conversation_id)
998
+ p status_code # => 2xx
999
+ p headers # => { ... }
1000
+ p data # => <ResponseEntity>
1001
+ rescue Propertyware::ApiError => e
1002
+ puts "Error when calling LeasesApi->delete_lease_conversation_with_http_info: #{e}"
1003
+ end
1004
+ ```
1005
+
1006
+ ### Parameters
1007
+
1008
+ | Name | Type | Description | Notes |
1009
+ | ---- | ---- | ----------- | ----- |
1010
+ | **lease_id** | **Integer** | Lease ID | |
1011
+ | **conversation_id** | **Integer** | Conversation ID | |
1012
+
1013
+ ### Return type
1014
+
1015
+ [**ResponseEntity**](ResponseEntity.md)
1016
+
1017
+ ### Authorization
1018
+
1019
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1020
+
1021
+ ### HTTP request headers
1022
+
1023
+ - **Content-Type**: Not defined
1024
+ - **Accept**: application/json
1025
+
1026
+
1027
+ ## get_lease
1028
+
1029
+ > <Lease> get_lease(lease_id, opts)
1030
+
1031
+ Retrieve a lease
1032
+
1033
+ Retrieves a specific lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1034
+
1035
+ ### Examples
1036
+
1037
+ ```ruby
1038
+ require 'time'
1039
+ require 'propertyware'
1040
+ # setup authorization
1041
+ Propertyware.configure do |config|
1042
+ # Configure API key authorization: organizationId
1043
+ config.api_key['organizationId'] = 'YOUR API KEY'
1044
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1045
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1046
+
1047
+ # Configure API key authorization: clientId
1048
+ config.api_key['clientId'] = 'YOUR API KEY'
1049
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1050
+ # config.api_key_prefix['clientId'] = 'Bearer'
1051
+
1052
+ # Configure API key authorization: clientSecret
1053
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1054
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1055
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1056
+ end
1057
+
1058
+ api_instance = Propertyware::LeasesApi.new
1059
+ lease_id = 789 # Integer | Lease ID
1060
+ opts = {
1061
+ include_custom_fields: true # Boolean | includeCustomFields
1062
+ }
1063
+
1064
+ begin
1065
+ # Retrieve a lease
1066
+ result = api_instance.get_lease(lease_id, opts)
1067
+ p result
1068
+ rescue Propertyware::ApiError => e
1069
+ puts "Error when calling LeasesApi->get_lease: #{e}"
1070
+ end
1071
+ ```
1072
+
1073
+ #### Using the get_lease_with_http_info variant
1074
+
1075
+ This returns an Array which contains the response data, status code and headers.
1076
+
1077
+ > <Array(<Lease>, Integer, Hash)> get_lease_with_http_info(lease_id, opts)
1078
+
1079
+ ```ruby
1080
+ begin
1081
+ # Retrieve a lease
1082
+ data, status_code, headers = api_instance.get_lease_with_http_info(lease_id, opts)
1083
+ p status_code # => 2xx
1084
+ p headers # => { ... }
1085
+ p data # => <Lease>
1086
+ rescue Propertyware::ApiError => e
1087
+ puts "Error when calling LeasesApi->get_lease_with_http_info: #{e}"
1088
+ end
1089
+ ```
1090
+
1091
+ ### Parameters
1092
+
1093
+ | Name | Type | Description | Notes |
1094
+ | ---- | ---- | ----------- | ----- |
1095
+ | **lease_id** | **Integer** | Lease ID | |
1096
+ | **include_custom_fields** | **Boolean** | includeCustomFields | [optional][default to true] |
1097
+
1098
+ ### Return type
1099
+
1100
+ [**Lease**](Lease.md)
1101
+
1102
+ ### Authorization
1103
+
1104
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1105
+
1106
+ ### HTTP request headers
1107
+
1108
+ - **Content-Type**: Not defined
1109
+ - **Accept**: application/json
1110
+
1111
+
1112
+ ## get_lease_adjustments
1113
+
1114
+ > <Array<Transaction>> get_lease_adjustments(opts)
1115
+
1116
+ Retrieve all the adjustments
1117
+
1118
+ Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>id</code>
1119
+
1120
+ ### Examples
1121
+
1122
+ ```ruby
1123
+ require 'time'
1124
+ require 'propertyware'
1125
+ # setup authorization
1126
+ Propertyware.configure do |config|
1127
+ # Configure API key authorization: organizationId
1128
+ config.api_key['organizationId'] = 'YOUR API KEY'
1129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1130
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1131
+
1132
+ # Configure API key authorization: clientId
1133
+ config.api_key['clientId'] = 'YOUR API KEY'
1134
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1135
+ # config.api_key_prefix['clientId'] = 'Bearer'
1136
+
1137
+ # Configure API key authorization: clientSecret
1138
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1139
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1140
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1141
+ end
1142
+
1143
+ api_instance = Propertyware::LeasesApi.new
1144
+ opts = {
1145
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
1146
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
1147
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
1148
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
1149
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
1150
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
1151
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
1152
+ portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
1153
+ lease_id: 789, # Integer | Filters results with Lease ID.
1154
+ status: 'status_example' # String | Filters results to with Lease Status.
1155
+ }
1156
+
1157
+ begin
1158
+ # Retrieve all the adjustments
1159
+ result = api_instance.get_lease_adjustments(opts)
1160
+ p result
1161
+ rescue Propertyware::ApiError => e
1162
+ puts "Error when calling LeasesApi->get_lease_adjustments: #{e}"
1163
+ end
1164
+ ```
1165
+
1166
+ #### Using the get_lease_adjustments_with_http_info variant
1167
+
1168
+ This returns an Array which contains the response data, status code and headers.
1169
+
1170
+ > <Array(<Array<Transaction>>, Integer, Hash)> get_lease_adjustments_with_http_info(opts)
1171
+
1172
+ ```ruby
1173
+ begin
1174
+ # Retrieve all the adjustments
1175
+ data, status_code, headers = api_instance.get_lease_adjustments_with_http_info(opts)
1176
+ p status_code # => 2xx
1177
+ p headers # => { ... }
1178
+ p data # => <Array<Transaction>>
1179
+ rescue Propertyware::ApiError => e
1180
+ puts "Error when calling LeasesApi->get_lease_adjustments_with_http_info: #{e}"
1181
+ end
1182
+ ```
1183
+
1184
+ ### Parameters
1185
+
1186
+ | Name | Type | Description | Notes |
1187
+ | ---- | ---- | ----------- | ----- |
1188
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
1189
+ | **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 500 and the default is 100. | [optional][default to 100] |
1190
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
1191
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
1192
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
1193
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
1194
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
1195
+ | **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
1196
+ | **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
1197
+ | **status** | **String** | Filters results to with Lease Status. | [optional] |
1198
+
1199
+ ### Return type
1200
+
1201
+ [**Array&lt;Transaction&gt;**](Transaction.md)
1202
+
1203
+ ### Authorization
1204
+
1205
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1206
+
1207
+ ### HTTP request headers
1208
+
1209
+ - **Content-Type**: Not defined
1210
+ - **Accept**: application/json
1211
+
1212
+
1213
+ ## get_lease_auto_charges
1214
+
1215
+ > <Array<Charge>> get_lease_auto_charges(lease_id)
1216
+
1217
+ Retrieve all lease auto charges
1218
+
1219
+ Retrieves all the auto charges of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1220
+
1221
+ ### Examples
1222
+
1223
+ ```ruby
1224
+ require 'time'
1225
+ require 'propertyware'
1226
+ # setup authorization
1227
+ Propertyware.configure do |config|
1228
+ # Configure API key authorization: organizationId
1229
+ config.api_key['organizationId'] = 'YOUR API KEY'
1230
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1231
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1232
+
1233
+ # Configure API key authorization: clientId
1234
+ config.api_key['clientId'] = 'YOUR API KEY'
1235
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1236
+ # config.api_key_prefix['clientId'] = 'Bearer'
1237
+
1238
+ # Configure API key authorization: clientSecret
1239
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1240
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1241
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1242
+ end
1243
+
1244
+ api_instance = Propertyware::LeasesApi.new
1245
+ lease_id = 789 # Integer | Lease ID
1246
+
1247
+ begin
1248
+ # Retrieve all lease auto charges
1249
+ result = api_instance.get_lease_auto_charges(lease_id)
1250
+ p result
1251
+ rescue Propertyware::ApiError => e
1252
+ puts "Error when calling LeasesApi->get_lease_auto_charges: #{e}"
1253
+ end
1254
+ ```
1255
+
1256
+ #### Using the get_lease_auto_charges_with_http_info variant
1257
+
1258
+ This returns an Array which contains the response data, status code and headers.
1259
+
1260
+ > <Array(<Array<Charge>>, Integer, Hash)> get_lease_auto_charges_with_http_info(lease_id)
1261
+
1262
+ ```ruby
1263
+ begin
1264
+ # Retrieve all lease auto charges
1265
+ data, status_code, headers = api_instance.get_lease_auto_charges_with_http_info(lease_id)
1266
+ p status_code # => 2xx
1267
+ p headers # => { ... }
1268
+ p data # => <Array<Charge>>
1269
+ rescue Propertyware::ApiError => e
1270
+ puts "Error when calling LeasesApi->get_lease_auto_charges_with_http_info: #{e}"
1271
+ end
1272
+ ```
1273
+
1274
+ ### Parameters
1275
+
1276
+ | Name | Type | Description | Notes |
1277
+ | ---- | ---- | ----------- | ----- |
1278
+ | **lease_id** | **Integer** | Lease ID | |
1279
+
1280
+ ### Return type
1281
+
1282
+ [**Array&lt;Charge&gt;**](Charge.md)
1283
+
1284
+ ### Authorization
1285
+
1286
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1287
+
1288
+ ### HTTP request headers
1289
+
1290
+ - **Content-Type**: Not defined
1291
+ - **Accept**: application/json
1292
+
1293
+
1294
+ ## get_lease_auto_e_payments
1295
+
1296
+ > <AutoPayment> get_lease_auto_e_payments(lease_id)
1297
+
1298
+ Retrieve all lease auto ePayments (BETA)
1299
+
1300
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the auto ePayments of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1301
+
1302
+ ### Examples
1303
+
1304
+ ```ruby
1305
+ require 'time'
1306
+ require 'propertyware'
1307
+ # setup authorization
1308
+ Propertyware.configure do |config|
1309
+ # Configure API key authorization: organizationId
1310
+ config.api_key['organizationId'] = 'YOUR API KEY'
1311
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1312
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1313
+
1314
+ # Configure API key authorization: clientId
1315
+ config.api_key['clientId'] = 'YOUR API KEY'
1316
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1317
+ # config.api_key_prefix['clientId'] = 'Bearer'
1318
+
1319
+ # Configure API key authorization: clientSecret
1320
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1321
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1322
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1323
+ end
1324
+
1325
+ api_instance = Propertyware::LeasesApi.new
1326
+ lease_id = 789 # Integer | Lease ID
1327
+
1328
+ begin
1329
+ # Retrieve all lease auto ePayments (BETA)
1330
+ result = api_instance.get_lease_auto_e_payments(lease_id)
1331
+ p result
1332
+ rescue Propertyware::ApiError => e
1333
+ puts "Error when calling LeasesApi->get_lease_auto_e_payments: #{e}"
1334
+ end
1335
+ ```
1336
+
1337
+ #### Using the get_lease_auto_e_payments_with_http_info variant
1338
+
1339
+ This returns an Array which contains the response data, status code and headers.
1340
+
1341
+ > <Array(<AutoPayment>, Integer, Hash)> get_lease_auto_e_payments_with_http_info(lease_id)
1342
+
1343
+ ```ruby
1344
+ begin
1345
+ # Retrieve all lease auto ePayments (BETA)
1346
+ data, status_code, headers = api_instance.get_lease_auto_e_payments_with_http_info(lease_id)
1347
+ p status_code # => 2xx
1348
+ p headers # => { ... }
1349
+ p data # => <AutoPayment>
1350
+ rescue Propertyware::ApiError => e
1351
+ puts "Error when calling LeasesApi->get_lease_auto_e_payments_with_http_info: #{e}"
1352
+ end
1353
+ ```
1354
+
1355
+ ### Parameters
1356
+
1357
+ | Name | Type | Description | Notes |
1358
+ | ---- | ---- | ----------- | ----- |
1359
+ | **lease_id** | **Integer** | Lease ID | |
1360
+
1361
+ ### Return type
1362
+
1363
+ [**AutoPayment**](AutoPayment.md)
1364
+
1365
+ ### Authorization
1366
+
1367
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1368
+
1369
+ ### HTTP request headers
1370
+
1371
+ - **Content-Type**: Not defined
1372
+ - **Accept**: application/json
1373
+
1374
+
1375
+ ## get_lease_auto_journal_entries
1376
+
1377
+ > <AutoJournalEntry> get_lease_auto_journal_entries(lease_id)
1378
+
1379
+ Retrieve all lease auto journal entries (BETA)
1380
+
1381
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves all the auto journal entries of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1382
+
1383
+ ### Examples
1384
+
1385
+ ```ruby
1386
+ require 'time'
1387
+ require 'propertyware'
1388
+ # setup authorization
1389
+ Propertyware.configure do |config|
1390
+ # Configure API key authorization: organizationId
1391
+ config.api_key['organizationId'] = 'YOUR API KEY'
1392
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1393
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1394
+
1395
+ # Configure API key authorization: clientId
1396
+ config.api_key['clientId'] = 'YOUR API KEY'
1397
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1398
+ # config.api_key_prefix['clientId'] = 'Bearer'
1399
+
1400
+ # Configure API key authorization: clientSecret
1401
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1402
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1403
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1404
+ end
1405
+
1406
+ api_instance = Propertyware::LeasesApi.new
1407
+ lease_id = 789 # Integer | Lease ID
1408
+
1409
+ begin
1410
+ # Retrieve all lease auto journal entries (BETA)
1411
+ result = api_instance.get_lease_auto_journal_entries(lease_id)
1412
+ p result
1413
+ rescue Propertyware::ApiError => e
1414
+ puts "Error when calling LeasesApi->get_lease_auto_journal_entries: #{e}"
1415
+ end
1416
+ ```
1417
+
1418
+ #### Using the get_lease_auto_journal_entries_with_http_info variant
1419
+
1420
+ This returns an Array which contains the response data, status code and headers.
1421
+
1422
+ > <Array(<AutoJournalEntry>, Integer, Hash)> get_lease_auto_journal_entries_with_http_info(lease_id)
1423
+
1424
+ ```ruby
1425
+ begin
1426
+ # Retrieve all lease auto journal entries (BETA)
1427
+ data, status_code, headers = api_instance.get_lease_auto_journal_entries_with_http_info(lease_id)
1428
+ p status_code # => 2xx
1429
+ p headers # => { ... }
1430
+ p data # => <AutoJournalEntry>
1431
+ rescue Propertyware::ApiError => e
1432
+ puts "Error when calling LeasesApi->get_lease_auto_journal_entries_with_http_info: #{e}"
1433
+ end
1434
+ ```
1435
+
1436
+ ### Parameters
1437
+
1438
+ | Name | Type | Description | Notes |
1439
+ | ---- | ---- | ----------- | ----- |
1440
+ | **lease_id** | **Integer** | Lease ID | |
1441
+
1442
+ ### Return type
1443
+
1444
+ [**AutoJournalEntry**](AutoJournalEntry.md)
1445
+
1446
+ ### Authorization
1447
+
1448
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1449
+
1450
+ ### HTTP request headers
1451
+
1452
+ - **Content-Type**: Not defined
1453
+ - **Accept**: application/json
1454
+
1455
+
1456
+ ## get_lease_charges
1457
+
1458
+ > <Array<ChargeTx>> get_lease_charges(opts)
1459
+
1460
+ Retrieve all the lease charges
1461
+
1462
+ Retrieves a list of lease charges.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
1463
+
1464
+ ### Examples
1465
+
1466
+ ```ruby
1467
+ require 'time'
1468
+ require 'propertyware'
1469
+ # setup authorization
1470
+ Propertyware.configure do |config|
1471
+ # Configure API key authorization: organizationId
1472
+ config.api_key['organizationId'] = 'YOUR API KEY'
1473
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1474
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1475
+
1476
+ # Configure API key authorization: clientId
1477
+ config.api_key['clientId'] = 'YOUR API KEY'
1478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1479
+ # config.api_key_prefix['clientId'] = 'Bearer'
1480
+
1481
+ # Configure API key authorization: clientSecret
1482
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1483
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1484
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1485
+ end
1486
+
1487
+ api_instance = Propertyware::LeasesApi.new
1488
+ opts = {
1489
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
1490
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
1491
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
1492
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
1493
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
1494
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
1495
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
1496
+ portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
1497
+ lease_id: 789, # Integer | Filters results with Lease ID.
1498
+ status: 'status_example' # String | Filters results to with Lease Status.
1499
+ }
1500
+
1501
+ begin
1502
+ # Retrieve all the lease charges
1503
+ result = api_instance.get_lease_charges(opts)
1504
+ p result
1505
+ rescue Propertyware::ApiError => e
1506
+ puts "Error when calling LeasesApi->get_lease_charges: #{e}"
1507
+ end
1508
+ ```
1509
+
1510
+ #### Using the get_lease_charges_with_http_info variant
1511
+
1512
+ This returns an Array which contains the response data, status code and headers.
1513
+
1514
+ > <Array(<Array<ChargeTx>>, Integer, Hash)> get_lease_charges_with_http_info(opts)
1515
+
1516
+ ```ruby
1517
+ begin
1518
+ # Retrieve all the lease charges
1519
+ data, status_code, headers = api_instance.get_lease_charges_with_http_info(opts)
1520
+ p status_code # => 2xx
1521
+ p headers # => { ... }
1522
+ p data # => <Array<ChargeTx>>
1523
+ rescue Propertyware::ApiError => e
1524
+ puts "Error when calling LeasesApi->get_lease_charges_with_http_info: #{e}"
1525
+ end
1526
+ ```
1527
+
1528
+ ### Parameters
1529
+
1530
+ | Name | Type | Description | Notes |
1531
+ | ---- | ---- | ----------- | ----- |
1532
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
1533
+ | **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 500 and the default is 100. | [optional][default to 100] |
1534
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
1535
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
1536
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
1537
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
1538
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
1539
+ | **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
1540
+ | **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
1541
+ | **status** | **String** | Filters results to with Lease Status. | [optional] |
1542
+
1543
+ ### Return type
1544
+
1545
+ [**Array&lt;ChargeTx&gt;**](ChargeTx.md)
1546
+
1547
+ ### Authorization
1548
+
1549
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1550
+
1551
+ ### HTTP request headers
1552
+
1553
+ - **Content-Type**: Not defined
1554
+ - **Accept**: application/json
1555
+
1556
+
1557
+ ## get_lease_contacts
1558
+
1559
+ > <Array<Contact>> get_lease_contacts(lease_id, opts)
1560
+
1561
+ Retrieve all lease contacts
1562
+
1563
+ Retrieves all the contacts of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1564
+
1565
+ ### Examples
1566
+
1567
+ ```ruby
1568
+ require 'time'
1569
+ require 'propertyware'
1570
+ # setup authorization
1571
+ Propertyware.configure do |config|
1572
+ # Configure API key authorization: organizationId
1573
+ config.api_key['organizationId'] = 'YOUR API KEY'
1574
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1575
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1576
+
1577
+ # Configure API key authorization: clientId
1578
+ config.api_key['clientId'] = 'YOUR API KEY'
1579
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1580
+ # config.api_key_prefix['clientId'] = 'Bearer'
1581
+
1582
+ # Configure API key authorization: clientSecret
1583
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1584
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1585
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1586
+ end
1587
+
1588
+ api_instance = Propertyware::LeasesApi.new
1589
+ lease_id = 789 # Integer | Lease ID
1590
+ opts = {
1591
+ include_contact_custom_fields_in_the_response_: true # Boolean | Include contact custom fields in the response.
1592
+ }
1593
+
1594
+ begin
1595
+ # Retrieve all lease contacts
1596
+ result = api_instance.get_lease_contacts(lease_id, opts)
1597
+ p result
1598
+ rescue Propertyware::ApiError => e
1599
+ puts "Error when calling LeasesApi->get_lease_contacts: #{e}"
1600
+ end
1601
+ ```
1602
+
1603
+ #### Using the get_lease_contacts_with_http_info variant
1604
+
1605
+ This returns an Array which contains the response data, status code and headers.
1606
+
1607
+ > <Array(<Array<Contact>>, Integer, Hash)> get_lease_contacts_with_http_info(lease_id, opts)
1608
+
1609
+ ```ruby
1610
+ begin
1611
+ # Retrieve all lease contacts
1612
+ data, status_code, headers = api_instance.get_lease_contacts_with_http_info(lease_id, opts)
1613
+ p status_code # => 2xx
1614
+ p headers # => { ... }
1615
+ p data # => <Array<Contact>>
1616
+ rescue Propertyware::ApiError => e
1617
+ puts "Error when calling LeasesApi->get_lease_contacts_with_http_info: #{e}"
1618
+ end
1619
+ ```
1620
+
1621
+ ### Parameters
1622
+
1623
+ | Name | Type | Description | Notes |
1624
+ | ---- | ---- | ----------- | ----- |
1625
+ | **lease_id** | **Integer** | Lease ID | |
1626
+ | **include_contact_custom_fields_in_the_response_** | **Boolean** | Include contact custom fields in the response. | [optional] |
1627
+
1628
+ ### Return type
1629
+
1630
+ [**Array&lt;Contact&gt;**](Contact.md)
1631
+
1632
+ ### Authorization
1633
+
1634
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1635
+
1636
+ ### HTTP request headers
1637
+
1638
+ - **Content-Type**: Not defined
1639
+ - **Accept**: application/json
1640
+
1641
+
1642
+ ## get_lease_conversation
1643
+
1644
+ > <Conversation> get_lease_conversation(lease_id, conversation_id)
1645
+
1646
+ Retrieve a lease conversation
1647
+
1648
+ Retrieves a specific lease conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1649
+
1650
+ ### Examples
1651
+
1652
+ ```ruby
1653
+ require 'time'
1654
+ require 'propertyware'
1655
+ # setup authorization
1656
+ Propertyware.configure do |config|
1657
+ # Configure API key authorization: organizationId
1658
+ config.api_key['organizationId'] = 'YOUR API KEY'
1659
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1660
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1661
+
1662
+ # Configure API key authorization: clientId
1663
+ config.api_key['clientId'] = 'YOUR API KEY'
1664
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1665
+ # config.api_key_prefix['clientId'] = 'Bearer'
1666
+
1667
+ # Configure API key authorization: clientSecret
1668
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1669
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1670
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1671
+ end
1672
+
1673
+ api_instance = Propertyware::LeasesApi.new
1674
+ lease_id = 789 # Integer | Lease ID
1675
+ conversation_id = 789 # Integer | Conversation ID
1676
+
1677
+ begin
1678
+ # Retrieve a lease conversation
1679
+ result = api_instance.get_lease_conversation(lease_id, conversation_id)
1680
+ p result
1681
+ rescue Propertyware::ApiError => e
1682
+ puts "Error when calling LeasesApi->get_lease_conversation: #{e}"
1683
+ end
1684
+ ```
1685
+
1686
+ #### Using the get_lease_conversation_with_http_info variant
1687
+
1688
+ This returns an Array which contains the response data, status code and headers.
1689
+
1690
+ > <Array(<Conversation>, Integer, Hash)> get_lease_conversation_with_http_info(lease_id, conversation_id)
1691
+
1692
+ ```ruby
1693
+ begin
1694
+ # Retrieve a lease conversation
1695
+ data, status_code, headers = api_instance.get_lease_conversation_with_http_info(lease_id, conversation_id)
1696
+ p status_code # => 2xx
1697
+ p headers # => { ... }
1698
+ p data # => <Conversation>
1699
+ rescue Propertyware::ApiError => e
1700
+ puts "Error when calling LeasesApi->get_lease_conversation_with_http_info: #{e}"
1701
+ end
1702
+ ```
1703
+
1704
+ ### Parameters
1705
+
1706
+ | Name | Type | Description | Notes |
1707
+ | ---- | ---- | ----------- | ----- |
1708
+ | **lease_id** | **Integer** | Lease ID | |
1709
+ | **conversation_id** | **Integer** | Conversation ID | |
1710
+
1711
+ ### Return type
1712
+
1713
+ [**Conversation**](Conversation.md)
1714
+
1715
+ ### Authorization
1716
+
1717
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1718
+
1719
+ ### HTTP request headers
1720
+
1721
+ - **Content-Type**: Not defined
1722
+ - **Accept**: application/json
1723
+
1724
+
1725
+ ## get_lease_conversations
1726
+
1727
+ > <Array<Conversation>> get_lease_conversations(lease_id, opts)
1728
+
1729
+ Retrieve all lease conversations
1730
+
1731
+ Retrieves all the conversations of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
1732
+
1733
+ ### Examples
1734
+
1735
+ ```ruby
1736
+ require 'time'
1737
+ require 'propertyware'
1738
+ # setup authorization
1739
+ Propertyware.configure do |config|
1740
+ # Configure API key authorization: organizationId
1741
+ config.api_key['organizationId'] = 'YOUR API KEY'
1742
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1743
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1744
+
1745
+ # Configure API key authorization: clientId
1746
+ config.api_key['clientId'] = 'YOUR API KEY'
1747
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1748
+ # config.api_key_prefix['clientId'] = 'Bearer'
1749
+
1750
+ # Configure API key authorization: clientSecret
1751
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1752
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1753
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1754
+ end
1755
+
1756
+ api_instance = Propertyware::LeasesApi.new
1757
+ lease_id = 789 # Integer | Lease ID
1758
+ opts = {
1759
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
1760
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
1761
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
1762
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
1763
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
1764
+ type: 'MANAGEMENT_TEAM' # String | Filters results by the conversation type.
1765
+ }
1766
+
1767
+ begin
1768
+ # Retrieve all lease conversations
1769
+ result = api_instance.get_lease_conversations(lease_id, opts)
1770
+ p result
1771
+ rescue Propertyware::ApiError => e
1772
+ puts "Error when calling LeasesApi->get_lease_conversations: #{e}"
1773
+ end
1774
+ ```
1775
+
1776
+ #### Using the get_lease_conversations_with_http_info variant
1777
+
1778
+ This returns an Array which contains the response data, status code and headers.
1779
+
1780
+ > <Array(<Array<Conversation>>, Integer, Hash)> get_lease_conversations_with_http_info(lease_id, opts)
1781
+
1782
+ ```ruby
1783
+ begin
1784
+ # Retrieve all lease conversations
1785
+ data, status_code, headers = api_instance.get_lease_conversations_with_http_info(lease_id, opts)
1786
+ p status_code # => 2xx
1787
+ p headers # => { ... }
1788
+ p data # => <Array<Conversation>>
1789
+ rescue Propertyware::ApiError => e
1790
+ puts "Error when calling LeasesApi->get_lease_conversations_with_http_info: #{e}"
1791
+ end
1792
+ ```
1793
+
1794
+ ### Parameters
1795
+
1796
+ | Name | Type | Description | Notes |
1797
+ | ---- | ---- | ----------- | ----- |
1798
+ | **lease_id** | **Integer** | Lease ID | |
1799
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
1800
+ | **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 500 and the default is 100. | [optional][default to 100] |
1801
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
1802
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
1803
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
1804
+ | **type** | **String** | Filters results by the conversation type. | [optional] |
1805
+
1806
+ ### Return type
1807
+
1808
+ [**Array&lt;Conversation&gt;**](Conversation.md)
1809
+
1810
+ ### Authorization
1811
+
1812
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1813
+
1814
+ ### HTTP request headers
1815
+
1816
+ - **Content-Type**: Not defined
1817
+ - **Accept**: application/json
1818
+
1819
+
1820
+ ## get_lease_custom_fields
1821
+
1822
+ > <Array<CustomField>> get_lease_custom_fields(lease_id)
1823
+
1824
+ Retrieve all lease custom fields
1825
+
1826
+ Retrieves all the custom fields of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1827
+
1828
+ ### Examples
1829
+
1830
+ ```ruby
1831
+ require 'time'
1832
+ require 'propertyware'
1833
+ # setup authorization
1834
+ Propertyware.configure do |config|
1835
+ # Configure API key authorization: organizationId
1836
+ config.api_key['organizationId'] = 'YOUR API KEY'
1837
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1838
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1839
+
1840
+ # Configure API key authorization: clientId
1841
+ config.api_key['clientId'] = 'YOUR API KEY'
1842
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1843
+ # config.api_key_prefix['clientId'] = 'Bearer'
1844
+
1845
+ # Configure API key authorization: clientSecret
1846
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1847
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1848
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1849
+ end
1850
+
1851
+ api_instance = Propertyware::LeasesApi.new
1852
+ lease_id = 789 # Integer | Lease ID
1853
+
1854
+ begin
1855
+ # Retrieve all lease custom fields
1856
+ result = api_instance.get_lease_custom_fields(lease_id)
1857
+ p result
1858
+ rescue Propertyware::ApiError => e
1859
+ puts "Error when calling LeasesApi->get_lease_custom_fields: #{e}"
1860
+ end
1861
+ ```
1862
+
1863
+ #### Using the get_lease_custom_fields_with_http_info variant
1864
+
1865
+ This returns an Array which contains the response data, status code and headers.
1866
+
1867
+ > <Array(<Array<CustomField>>, Integer, Hash)> get_lease_custom_fields_with_http_info(lease_id)
1868
+
1869
+ ```ruby
1870
+ begin
1871
+ # Retrieve all lease custom fields
1872
+ data, status_code, headers = api_instance.get_lease_custom_fields_with_http_info(lease_id)
1873
+ p status_code # => 2xx
1874
+ p headers # => { ... }
1875
+ p data # => <Array<CustomField>>
1876
+ rescue Propertyware::ApiError => e
1877
+ puts "Error when calling LeasesApi->get_lease_custom_fields_with_http_info: #{e}"
1878
+ end
1879
+ ```
1880
+
1881
+ ### Parameters
1882
+
1883
+ | Name | Type | Description | Notes |
1884
+ | ---- | ---- | ----------- | ----- |
1885
+ | **lease_id** | **Integer** | Lease ID | |
1886
+
1887
+ ### Return type
1888
+
1889
+ [**Array&lt;CustomField&gt;**](CustomField.md)
1890
+
1891
+ ### Authorization
1892
+
1893
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1894
+
1895
+ ### HTTP request headers
1896
+
1897
+ - **Content-Type**: Not defined
1898
+ - **Accept**: application/json
1899
+
1900
+
1901
+ ## get_lease_discounts
1902
+
1903
+ > <Array<Transaction>> get_lease_discounts(opts)
1904
+
1905
+ Retrieve all the lease discounts
1906
+
1907
+ Retrieves a list of lease discounts<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
1908
+
1909
+ ### Examples
1910
+
1911
+ ```ruby
1912
+ require 'time'
1913
+ require 'propertyware'
1914
+ # setup authorization
1915
+ Propertyware.configure do |config|
1916
+ # Configure API key authorization: organizationId
1917
+ config.api_key['organizationId'] = 'YOUR API KEY'
1918
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1919
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1920
+
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 = Propertyware::LeasesApi.new
1933
+ opts = {
1934
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
1935
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
1936
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
1937
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
1938
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
1939
+ lease_id: 789, # Integer | Filters results to any LeaseID.
1940
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any discount with a start date on or after the date specified.
1941
+ post_date_end: Date.parse('2013-10-20') # Date | Filters results to any discount with a start date on or prior to the date specified.
1942
+ }
1943
+
1944
+ begin
1945
+ # Retrieve all the lease discounts
1946
+ result = api_instance.get_lease_discounts(opts)
1947
+ p result
1948
+ rescue Propertyware::ApiError => e
1949
+ puts "Error when calling LeasesApi->get_lease_discounts: #{e}"
1950
+ end
1951
+ ```
1952
+
1953
+ #### Using the get_lease_discounts_with_http_info variant
1954
+
1955
+ This returns an Array which contains the response data, status code and headers.
1956
+
1957
+ > <Array(<Array<Transaction>>, Integer, Hash)> get_lease_discounts_with_http_info(opts)
1958
+
1959
+ ```ruby
1960
+ begin
1961
+ # Retrieve all the lease discounts
1962
+ data, status_code, headers = api_instance.get_lease_discounts_with_http_info(opts)
1963
+ p status_code # => 2xx
1964
+ p headers # => { ... }
1965
+ p data # => <Array<Transaction>>
1966
+ rescue Propertyware::ApiError => e
1967
+ puts "Error when calling LeasesApi->get_lease_discounts_with_http_info: #{e}"
1968
+ end
1969
+ ```
1970
+
1971
+ ### Parameters
1972
+
1973
+ | Name | Type | Description | Notes |
1974
+ | ---- | ---- | ----------- | ----- |
1975
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
1976
+ | **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 500 and the default is 100. | [optional][default to 100] |
1977
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
1978
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
1979
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
1980
+ | **lease_id** | **Integer** | Filters results to any LeaseID. | [optional] |
1981
+ | **post_date_start** | **Date** | Filters results to any discount with a start date on or after the date specified. | [optional] |
1982
+ | **post_date_end** | **Date** | Filters results to any discount with a start date on or prior to the date specified. | [optional] |
1983
+
1984
+ ### Return type
1985
+
1986
+ [**Array&lt;Transaction&gt;**](Transaction.md)
1987
+
1988
+ ### Authorization
1989
+
1990
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1991
+
1992
+ ### HTTP request headers
1993
+
1994
+ - **Content-Type**: Not defined
1995
+ - **Accept**: application/json
1996
+
1997
+
1998
+ ## get_lease_documents
1999
+
2000
+ > <Array<Document>> get_lease_documents(lease_id)
2001
+
2002
+ Retrieve all lease documents
2003
+
2004
+ Retrieves all the documents of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
2005
+
2006
+ ### Examples
2007
+
2008
+ ```ruby
2009
+ require 'time'
2010
+ require 'propertyware'
2011
+ # setup authorization
2012
+ Propertyware.configure do |config|
2013
+ # Configure API key authorization: organizationId
2014
+ config.api_key['organizationId'] = 'YOUR API KEY'
2015
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2016
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2017
+
2018
+ # Configure API key authorization: clientId
2019
+ config.api_key['clientId'] = 'YOUR API KEY'
2020
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2021
+ # config.api_key_prefix['clientId'] = 'Bearer'
2022
+
2023
+ # Configure API key authorization: clientSecret
2024
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2025
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2026
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2027
+ end
2028
+
2029
+ api_instance = Propertyware::LeasesApi.new
2030
+ lease_id = 789 # Integer | Lease ID
2031
+
2032
+ begin
2033
+ # Retrieve all lease documents
2034
+ result = api_instance.get_lease_documents(lease_id)
2035
+ p result
2036
+ rescue Propertyware::ApiError => e
2037
+ puts "Error when calling LeasesApi->get_lease_documents: #{e}"
2038
+ end
2039
+ ```
2040
+
2041
+ #### Using the get_lease_documents_with_http_info variant
2042
+
2043
+ This returns an Array which contains the response data, status code and headers.
2044
+
2045
+ > <Array(<Array<Document>>, Integer, Hash)> get_lease_documents_with_http_info(lease_id)
2046
+
2047
+ ```ruby
2048
+ begin
2049
+ # Retrieve all lease documents
2050
+ data, status_code, headers = api_instance.get_lease_documents_with_http_info(lease_id)
2051
+ p status_code # => 2xx
2052
+ p headers # => { ... }
2053
+ p data # => <Array<Document>>
2054
+ rescue Propertyware::ApiError => e
2055
+ puts "Error when calling LeasesApi->get_lease_documents_with_http_info: #{e}"
2056
+ end
2057
+ ```
2058
+
2059
+ ### Parameters
2060
+
2061
+ | Name | Type | Description | Notes |
2062
+ | ---- | ---- | ----------- | ----- |
2063
+ | **lease_id** | **Integer** | Lease ID | |
2064
+
2065
+ ### Return type
2066
+
2067
+ [**Array&lt;Document&gt;**](Document.md)
2068
+
2069
+ ### Authorization
2070
+
2071
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2072
+
2073
+ ### HTTP request headers
2074
+
2075
+ - **Content-Type**: Not defined
2076
+ - **Accept**: application/json
2077
+
2078
+
2079
+ ## get_lease_journal_entry
2080
+
2081
+ > <JournalEntry> get_lease_journal_entry(lease_id, opts)
2082
+
2083
+ Retrieve all lease journal entries
2084
+
2085
+ Retrieves a specific lease journal entries.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
2086
+
2087
+ ### Examples
2088
+
2089
+ ```ruby
2090
+ require 'time'
2091
+ require 'propertyware'
2092
+ # setup authorization
2093
+ Propertyware.configure do |config|
2094
+ # Configure API key authorization: organizationId
2095
+ config.api_key['organizationId'] = 'YOUR API KEY'
2096
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2097
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2098
+
2099
+ # Configure API key authorization: clientId
2100
+ config.api_key['clientId'] = 'YOUR API KEY'
2101
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2102
+ # config.api_key_prefix['clientId'] = 'Bearer'
2103
+
2104
+ # Configure API key authorization: clientSecret
2105
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2107
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2108
+ end
2109
+
2110
+ api_instance = Propertyware::LeasesApi.new
2111
+ lease_id = 789 # Integer | Lease ID
2112
+ opts = {
2113
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
2114
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
2115
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
2116
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
2117
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
2118
+ lease_id2: 789, # Integer | Filters results to transactions associated with a specific lease.
2119
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with post date on or after to the date specified.
2120
+ post_date_end: Date.parse('2013-10-20') # Date | Filters results to any transaction with post date on or prior to the date specified.
2121
+ }
2122
+
2123
+ begin
2124
+ # Retrieve all lease journal entries
2125
+ result = api_instance.get_lease_journal_entry(lease_id, opts)
2126
+ p result
2127
+ rescue Propertyware::ApiError => e
2128
+ puts "Error when calling LeasesApi->get_lease_journal_entry: #{e}"
2129
+ end
2130
+ ```
2131
+
2132
+ #### Using the get_lease_journal_entry_with_http_info variant
2133
+
2134
+ This returns an Array which contains the response data, status code and headers.
2135
+
2136
+ > <Array(<JournalEntry>, Integer, Hash)> get_lease_journal_entry_with_http_info(lease_id, opts)
2137
+
2138
+ ```ruby
2139
+ begin
2140
+ # Retrieve all lease journal entries
2141
+ data, status_code, headers = api_instance.get_lease_journal_entry_with_http_info(lease_id, opts)
2142
+ p status_code # => 2xx
2143
+ p headers # => { ... }
2144
+ p data # => <JournalEntry>
2145
+ rescue Propertyware::ApiError => e
2146
+ puts "Error when calling LeasesApi->get_lease_journal_entry_with_http_info: #{e}"
2147
+ end
2148
+ ```
2149
+
2150
+ ### Parameters
2151
+
2152
+ | Name | Type | Description | Notes |
2153
+ | ---- | ---- | ----------- | ----- |
2154
+ | **lease_id** | **Integer** | Lease ID | |
2155
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
2156
+ | **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 500 and the default is 100. | [optional][default to 100] |
2157
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
2158
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
2159
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
2160
+ | **lease_id2** | **Integer** | Filters results to transactions associated with a specific lease. | [optional] |
2161
+ | **post_date_start** | **Date** | Filters results to any transaction with post date on or after to the date specified. | [optional] |
2162
+ | **post_date_end** | **Date** | Filters results to any transaction with post date on or prior to the date specified. | [optional] |
2163
+
2164
+ ### Return type
2165
+
2166
+ [**JournalEntry**](JournalEntry.md)
2167
+
2168
+ ### Authorization
2169
+
2170
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2171
+
2172
+ ### HTTP request headers
2173
+
2174
+ - **Content-Type**: Not defined
2175
+ - **Accept**: application/json
2176
+
2177
+
2178
+ ## get_lease_late_fee
2179
+
2180
+ > <LateFeeRule> get_lease_late_fee(lease_id)
2181
+
2182
+ Retrieve the lease late fee rule
2183
+
2184
+ Retrieves the lease late fee rule.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
2185
+
2186
+ ### Examples
2187
+
2188
+ ```ruby
2189
+ require 'time'
2190
+ require 'propertyware'
2191
+ # setup authorization
2192
+ Propertyware.configure do |config|
2193
+ # Configure API key authorization: organizationId
2194
+ config.api_key['organizationId'] = 'YOUR API KEY'
2195
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2196
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2197
+
2198
+ # Configure API key authorization: clientId
2199
+ config.api_key['clientId'] = 'YOUR API KEY'
2200
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2201
+ # config.api_key_prefix['clientId'] = 'Bearer'
2202
+
2203
+ # Configure API key authorization: clientSecret
2204
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2205
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2206
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2207
+ end
2208
+
2209
+ api_instance = Propertyware::LeasesApi.new
2210
+ lease_id = 789 # Integer | Lease ID
2211
+
2212
+ begin
2213
+ # Retrieve the lease late fee rule
2214
+ result = api_instance.get_lease_late_fee(lease_id)
2215
+ p result
2216
+ rescue Propertyware::ApiError => e
2217
+ puts "Error when calling LeasesApi->get_lease_late_fee: #{e}"
2218
+ end
2219
+ ```
2220
+
2221
+ #### Using the get_lease_late_fee_with_http_info variant
2222
+
2223
+ This returns an Array which contains the response data, status code and headers.
2224
+
2225
+ > <Array(<LateFeeRule>, Integer, Hash)> get_lease_late_fee_with_http_info(lease_id)
2226
+
2227
+ ```ruby
2228
+ begin
2229
+ # Retrieve the lease late fee rule
2230
+ data, status_code, headers = api_instance.get_lease_late_fee_with_http_info(lease_id)
2231
+ p status_code # => 2xx
2232
+ p headers # => { ... }
2233
+ p data # => <LateFeeRule>
2234
+ rescue Propertyware::ApiError => e
2235
+ puts "Error when calling LeasesApi->get_lease_late_fee_with_http_info: #{e}"
2236
+ end
2237
+ ```
2238
+
2239
+ ### Parameters
2240
+
2241
+ | Name | Type | Description | Notes |
2242
+ | ---- | ---- | ----------- | ----- |
2243
+ | **lease_id** | **Integer** | Lease ID | |
2244
+
2245
+ ### Return type
2246
+
2247
+ [**LateFeeRule**](LateFeeRule.md)
2248
+
2249
+ ### Authorization
2250
+
2251
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2252
+
2253
+ ### HTTP request headers
2254
+
2255
+ - **Content-Type**: Not defined
2256
+ - **Accept**: application/json
2257
+
2258
+
2259
+ ## get_lease_notes
2260
+
2261
+ > <Array<Note>> get_lease_notes(lease_id)
2262
+
2263
+ Retrieve all lease notes
2264
+
2265
+ Retrieves all the notes of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
2266
+
2267
+ ### Examples
2268
+
2269
+ ```ruby
2270
+ require 'time'
2271
+ require 'propertyware'
2272
+ # setup authorization
2273
+ Propertyware.configure do |config|
2274
+ # Configure API key authorization: organizationId
2275
+ config.api_key['organizationId'] = 'YOUR API KEY'
2276
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2277
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2278
+
2279
+ # Configure API key authorization: clientId
2280
+ config.api_key['clientId'] = 'YOUR API KEY'
2281
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2282
+ # config.api_key_prefix['clientId'] = 'Bearer'
2283
+
2284
+ # Configure API key authorization: clientSecret
2285
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2286
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2287
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2288
+ end
2289
+
2290
+ api_instance = Propertyware::LeasesApi.new
2291
+ lease_id = 789 # Integer | Lease ID
2292
+
2293
+ begin
2294
+ # Retrieve all lease notes
2295
+ result = api_instance.get_lease_notes(lease_id)
2296
+ p result
2297
+ rescue Propertyware::ApiError => e
2298
+ puts "Error when calling LeasesApi->get_lease_notes: #{e}"
2299
+ end
2300
+ ```
2301
+
2302
+ #### Using the get_lease_notes_with_http_info variant
2303
+
2304
+ This returns an Array which contains the response data, status code and headers.
2305
+
2306
+ > <Array(<Array<Note>>, Integer, Hash)> get_lease_notes_with_http_info(lease_id)
2307
+
2308
+ ```ruby
2309
+ begin
2310
+ # Retrieve all lease notes
2311
+ data, status_code, headers = api_instance.get_lease_notes_with_http_info(lease_id)
2312
+ p status_code # => 2xx
2313
+ p headers # => { ... }
2314
+ p data # => <Array<Note>>
2315
+ rescue Propertyware::ApiError => e
2316
+ puts "Error when calling LeasesApi->get_lease_notes_with_http_info: #{e}"
2317
+ end
2318
+ ```
2319
+
2320
+ ### Parameters
2321
+
2322
+ | Name | Type | Description | Notes |
2323
+ | ---- | ---- | ----------- | ----- |
2324
+ | **lease_id** | **Integer** | Lease ID | |
2325
+
2326
+ ### Return type
2327
+
2328
+ [**Array&lt;Note&gt;**](Note.md)
2329
+
2330
+ ### Authorization
2331
+
2332
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2333
+
2334
+ ### HTTP request headers
2335
+
2336
+ - **Content-Type**: Not defined
2337
+ - **Accept**: application/json
2338
+
2339
+
2340
+ ## get_lease_payments
2341
+
2342
+ > <Array<Payment>> get_lease_payments(opts)
2343
+
2344
+ Retrieve all the lease payments
2345
+
2346
+ Retrieves a list of lease payments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
2347
+
2348
+ ### Examples
2349
+
2350
+ ```ruby
2351
+ require 'time'
2352
+ require 'propertyware'
2353
+ # setup authorization
2354
+ Propertyware.configure do |config|
2355
+ # Configure API key authorization: organizationId
2356
+ config.api_key['organizationId'] = 'YOUR API KEY'
2357
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2358
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2359
+
2360
+ # Configure API key authorization: clientId
2361
+ config.api_key['clientId'] = 'YOUR API KEY'
2362
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2363
+ # config.api_key_prefix['clientId'] = 'Bearer'
2364
+
2365
+ # Configure API key authorization: clientSecret
2366
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2367
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2368
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2369
+ end
2370
+
2371
+ api_instance = Propertyware::LeasesApi.new
2372
+ opts = {
2373
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
2374
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
2375
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
2376
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
2377
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
2378
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
2379
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
2380
+ portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
2381
+ lease_id: 789, # Integer | Filters results with Lease ID.
2382
+ status: 'status_example' # String | Filters results to with Lease Status.
2383
+ }
2384
+
2385
+ begin
2386
+ # Retrieve all the lease payments
2387
+ result = api_instance.get_lease_payments(opts)
2388
+ p result
2389
+ rescue Propertyware::ApiError => e
2390
+ puts "Error when calling LeasesApi->get_lease_payments: #{e}"
2391
+ end
2392
+ ```
2393
+
2394
+ #### Using the get_lease_payments_with_http_info variant
2395
+
2396
+ This returns an Array which contains the response data, status code and headers.
2397
+
2398
+ > <Array(<Array<Payment>>, Integer, Hash)> get_lease_payments_with_http_info(opts)
2399
+
2400
+ ```ruby
2401
+ begin
2402
+ # Retrieve all the lease payments
2403
+ data, status_code, headers = api_instance.get_lease_payments_with_http_info(opts)
2404
+ p status_code # => 2xx
2405
+ p headers # => { ... }
2406
+ p data # => <Array<Payment>>
2407
+ rescue Propertyware::ApiError => e
2408
+ puts "Error when calling LeasesApi->get_lease_payments_with_http_info: #{e}"
2409
+ end
2410
+ ```
2411
+
2412
+ ### Parameters
2413
+
2414
+ | Name | Type | Description | Notes |
2415
+ | ---- | ---- | ----------- | ----- |
2416
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
2417
+ | **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 500 and the default is 100. | [optional][default to 100] |
2418
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
2419
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
2420
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
2421
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
2422
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
2423
+ | **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
2424
+ | **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
2425
+ | **status** | **String** | Filters results to with Lease Status. | [optional] |
2426
+
2427
+ ### Return type
2428
+
2429
+ [**Array&lt;Payment&gt;**](Payment.md)
2430
+
2431
+ ### Authorization
2432
+
2433
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2434
+
2435
+ ### HTTP request headers
2436
+
2437
+ - **Content-Type**: Not defined
2438
+ - **Accept**: application/json
2439
+
2440
+
2441
+ ## get_lease_refunds
2442
+
2443
+ > <Array<Refund>> get_lease_refunds(opts)
2444
+
2445
+ Retrieve all the tenant refunds
2446
+
2447
+ Retrieves a list of tenant refunds.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
2448
+
2449
+ ### Examples
2450
+
2451
+ ```ruby
2452
+ require 'time'
2453
+ require 'propertyware'
2454
+ # setup authorization
2455
+ Propertyware.configure do |config|
2456
+ # Configure API key authorization: organizationId
2457
+ config.api_key['organizationId'] = 'YOUR API KEY'
2458
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2459
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2460
+
2461
+ # Configure API key authorization: clientId
2462
+ config.api_key['clientId'] = 'YOUR API KEY'
2463
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2464
+ # config.api_key_prefix['clientId'] = 'Bearer'
2465
+
2466
+ # Configure API key authorization: clientSecret
2467
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2469
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2470
+ end
2471
+
2472
+ api_instance = Propertyware::LeasesApi.new
2473
+ opts = {
2474
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
2475
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
2476
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
2477
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
2478
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
2479
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
2480
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
2481
+ portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
2482
+ lease_id: 789, # Integer | Filters results with Lease ID.
2483
+ status: 'status_example' # String | Filters results to with Lease Status.
2484
+ }
2485
+
2486
+ begin
2487
+ # Retrieve all the tenant refunds
2488
+ result = api_instance.get_lease_refunds(opts)
2489
+ p result
2490
+ rescue Propertyware::ApiError => e
2491
+ puts "Error when calling LeasesApi->get_lease_refunds: #{e}"
2492
+ end
2493
+ ```
2494
+
2495
+ #### Using the get_lease_refunds_with_http_info variant
2496
+
2497
+ This returns an Array which contains the response data, status code and headers.
2498
+
2499
+ > <Array(<Array<Refund>>, Integer, Hash)> get_lease_refunds_with_http_info(opts)
2500
+
2501
+ ```ruby
2502
+ begin
2503
+ # Retrieve all the tenant refunds
2504
+ data, status_code, headers = api_instance.get_lease_refunds_with_http_info(opts)
2505
+ p status_code # => 2xx
2506
+ p headers # => { ... }
2507
+ p data # => <Array<Refund>>
2508
+ rescue Propertyware::ApiError => e
2509
+ puts "Error when calling LeasesApi->get_lease_refunds_with_http_info: #{e}"
2510
+ end
2511
+ ```
2512
+
2513
+ ### Parameters
2514
+
2515
+ | Name | Type | Description | Notes |
2516
+ | ---- | ---- | ----------- | ----- |
2517
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
2518
+ | **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 500 and the default is 100. | [optional][default to 100] |
2519
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
2520
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
2521
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
2522
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
2523
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
2524
+ | **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
2525
+ | **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
2526
+ | **status** | **String** | Filters results to with Lease Status. | [optional] |
2527
+
2528
+ ### Return type
2529
+
2530
+ [**Array&lt;Refund&gt;**](Refund.md)
2531
+
2532
+ ### Authorization
2533
+
2534
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2535
+
2536
+ ### HTTP request headers
2537
+
2538
+ - **Content-Type**: Not defined
2539
+ - **Accept**: application/json
2540
+
2541
+
2542
+ ## get_lease_work_orders
2543
+
2544
+ > <Array<WorkOrder>> get_lease_work_orders(lease_id)
2545
+
2546
+ Retrieve all lease work orders
2547
+
2548
+ Retrieves all the work orders of a lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
2549
+
2550
+ ### Examples
2551
+
2552
+ ```ruby
2553
+ require 'time'
2554
+ require 'propertyware'
2555
+ # setup authorization
2556
+ Propertyware.configure do |config|
2557
+ # Configure API key authorization: organizationId
2558
+ config.api_key['organizationId'] = 'YOUR API KEY'
2559
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2560
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2561
+
2562
+ # Configure API key authorization: clientId
2563
+ config.api_key['clientId'] = 'YOUR API KEY'
2564
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2565
+ # config.api_key_prefix['clientId'] = 'Bearer'
2566
+
2567
+ # Configure API key authorization: clientSecret
2568
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2569
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2570
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2571
+ end
2572
+
2573
+ api_instance = Propertyware::LeasesApi.new
2574
+ lease_id = 789 # Integer | Lease ID
2575
+
2576
+ begin
2577
+ # Retrieve all lease work orders
2578
+ result = api_instance.get_lease_work_orders(lease_id)
2579
+ p result
2580
+ rescue Propertyware::ApiError => e
2581
+ puts "Error when calling LeasesApi->get_lease_work_orders: #{e}"
2582
+ end
2583
+ ```
2584
+
2585
+ #### Using the get_lease_work_orders_with_http_info variant
2586
+
2587
+ This returns an Array which contains the response data, status code and headers.
2588
+
2589
+ > <Array(<Array<WorkOrder>>, Integer, Hash)> get_lease_work_orders_with_http_info(lease_id)
2590
+
2591
+ ```ruby
2592
+ begin
2593
+ # Retrieve all lease work orders
2594
+ data, status_code, headers = api_instance.get_lease_work_orders_with_http_info(lease_id)
2595
+ p status_code # => 2xx
2596
+ p headers # => { ... }
2597
+ p data # => <Array<WorkOrder>>
2598
+ rescue Propertyware::ApiError => e
2599
+ puts "Error when calling LeasesApi->get_lease_work_orders_with_http_info: #{e}"
2600
+ end
2601
+ ```
2602
+
2603
+ ### Parameters
2604
+
2605
+ | Name | Type | Description | Notes |
2606
+ | ---- | ---- | ----------- | ----- |
2607
+ | **lease_id** | **Integer** | Lease ID | |
2608
+
2609
+ ### Return type
2610
+
2611
+ [**Array&lt;WorkOrder&gt;**](WorkOrder.md)
2612
+
2613
+ ### Authorization
2614
+
2615
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2616
+
2617
+ ### HTTP request headers
2618
+
2619
+ - **Content-Type**: Not defined
2620
+ - **Accept**: application/json
2621
+
2622
+
2623
+ ## get_leases
2624
+
2625
+ > <Array<Lease>> get_leases(opts)
2626
+
2627
+ Retrieve all leases
2628
+
2629
+ Retrieves a list of leases.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>startdate</code>, <code>idnumber</code>, <code>scheduledmoveoutdate</code>, <code>enddate</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>moveoutdate</code>, <code>id</code>, <code>moveindate</code>
2630
+
2631
+ ### Examples
2632
+
2633
+ ```ruby
2634
+ require 'time'
2635
+ require 'propertyware'
2636
+ # setup authorization
2637
+ Propertyware.configure do |config|
2638
+ # Configure API key authorization: organizationId
2639
+ config.api_key['organizationId'] = 'YOUR API KEY'
2640
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2641
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2642
+
2643
+ # Configure API key authorization: clientId
2644
+ config.api_key['clientId'] = 'YOUR API KEY'
2645
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2646
+ # config.api_key_prefix['clientId'] = 'Bearer'
2647
+
2648
+ # Configure API key authorization: clientSecret
2649
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2650
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2651
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2652
+ end
2653
+
2654
+ api_instance = Propertyware::LeasesApi.new
2655
+ opts = {
2656
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
2657
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
2658
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
2659
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
2660
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
2661
+ start_date_start: Date.parse('2013-10-20'), # Date | Filters results to any lease with a start date on or after the date specified.
2662
+ start_date_end: Date.parse('2013-10-20'), # Date | Filters results to any lease with a start date on or prior to the date specified.
2663
+ end_date_start: Date.parse('2013-10-20'), # Date | Filters results to any lease with a end date on or after the date specified.
2664
+ end_date_end: Date.parse('2013-10-20'), # Date | Filters results to any lease with a end date on or prior to the date specified.
2665
+ move_in_date_start: Date.parse('2013-10-20'), # Date | Filters results to any lease with a move-in date on or after the date specified.
2666
+ move_in_date_end: Date.parse('2013-10-20'), # Date | Filters results to any lease with a move-in date on or prior to the date specified.
2667
+ schedule_move_out_date_start: Date.parse('2013-10-20'), # Date | Filters results to any lease with a move-out date on or after the date specified.
2668
+ schedule_move_out_date_end: Date.parse('2013-10-20'), # Date | Filters results to any lease with a move-out date on or prior to the date specified.
2669
+ portfolio_id: 789, # Integer | Filters results to leases associated with a specific portfolio.
2670
+ building_id: 789, # Integer | Filters results to leases associated with a specific building.
2671
+ unit_id: 789, # Integer | Filters results to leases associated with a specific unit.
2672
+ status: 'status_example', # String | Filters results to inspections with a specific status.
2673
+ include_custom_fields: true # Boolean | includeCustomFields
2674
+ }
2675
+
2676
+ begin
2677
+ # Retrieve all leases
2678
+ result = api_instance.get_leases(opts)
2679
+ p result
2680
+ rescue Propertyware::ApiError => e
2681
+ puts "Error when calling LeasesApi->get_leases: #{e}"
2682
+ end
2683
+ ```
2684
+
2685
+ #### Using the get_leases_with_http_info variant
2686
+
2687
+ This returns an Array which contains the response data, status code and headers.
2688
+
2689
+ > <Array(<Array<Lease>>, Integer, Hash)> get_leases_with_http_info(opts)
2690
+
2691
+ ```ruby
2692
+ begin
2693
+ # Retrieve all leases
2694
+ data, status_code, headers = api_instance.get_leases_with_http_info(opts)
2695
+ p status_code # => 2xx
2696
+ p headers # => { ... }
2697
+ p data # => <Array<Lease>>
2698
+ rescue Propertyware::ApiError => e
2699
+ puts "Error when calling LeasesApi->get_leases_with_http_info: #{e}"
2700
+ end
2701
+ ```
2702
+
2703
+ ### Parameters
2704
+
2705
+ | Name | Type | Description | Notes |
2706
+ | ---- | ---- | ----------- | ----- |
2707
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
2708
+ | **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 500 and the default is 100. | [optional][default to 100] |
2709
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
2710
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
2711
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
2712
+ | **start_date_start** | **Date** | Filters results to any lease with a start date on or after the date specified. | [optional] |
2713
+ | **start_date_end** | **Date** | Filters results to any lease with a start date on or prior to the date specified. | [optional] |
2714
+ | **end_date_start** | **Date** | Filters results to any lease with a end date on or after the date specified. | [optional] |
2715
+ | **end_date_end** | **Date** | Filters results to any lease with a end date on or prior to the date specified. | [optional] |
2716
+ | **move_in_date_start** | **Date** | Filters results to any lease with a move-in date on or after the date specified. | [optional] |
2717
+ | **move_in_date_end** | **Date** | Filters results to any lease with a move-in date on or prior to the date specified. | [optional] |
2718
+ | **schedule_move_out_date_start** | **Date** | Filters results to any lease with a move-out date on or after the date specified. | [optional] |
2719
+ | **schedule_move_out_date_end** | **Date** | Filters results to any lease with a move-out date on or prior to the date specified. | [optional] |
2720
+ | **portfolio_id** | **Integer** | Filters results to leases associated with a specific portfolio. | [optional] |
2721
+ | **building_id** | **Integer** | Filters results to leases associated with a specific building. | [optional] |
2722
+ | **unit_id** | **Integer** | Filters results to leases associated with a specific unit. | [optional] |
2723
+ | **status** | **String** | Filters results to inspections with a specific status. | [optional] |
2724
+ | **include_custom_fields** | **Boolean** | includeCustomFields | [optional][default to false] |
2725
+
2726
+ ### Return type
2727
+
2728
+ [**Array&lt;Lease&gt;**](Lease.md)
2729
+
2730
+ ### Authorization
2731
+
2732
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2733
+
2734
+ ### HTTP request headers
2735
+
2736
+ - **Content-Type**: Not defined
2737
+ - **Accept**: application/json
2738
+
2739
+
2740
+ ## update_lease
2741
+
2742
+ > <Lease> update_lease(lease_id, save_lease)
2743
+
2744
+ Update a lease (BETA)
2745
+
2746
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates an existing lease.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
2747
+
2748
+ ### Examples
2749
+
2750
+ ```ruby
2751
+ require 'time'
2752
+ require 'propertyware'
2753
+ # setup authorization
2754
+ Propertyware.configure do |config|
2755
+ # Configure API key authorization: organizationId
2756
+ config.api_key['organizationId'] = 'YOUR API KEY'
2757
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2758
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2759
+
2760
+ # Configure API key authorization: clientId
2761
+ config.api_key['clientId'] = 'YOUR API KEY'
2762
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2763
+ # config.api_key_prefix['clientId'] = 'Bearer'
2764
+
2765
+ # Configure API key authorization: clientSecret
2766
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2767
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2768
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2769
+ end
2770
+
2771
+ api_instance = Propertyware::LeasesApi.new
2772
+ lease_id = 789 # Integer | Lease ID
2773
+ save_lease = Propertyware::SaveLease.new({end_date: Date.today, move_in_date: Date.today, primary_contact_id: 3.56, start_date: Date.today, tenant_ids: [3.56], unit_id: 3.56}) # SaveLease | lease
2774
+
2775
+ begin
2776
+ # Update a lease (BETA)
2777
+ result = api_instance.update_lease(lease_id, save_lease)
2778
+ p result
2779
+ rescue Propertyware::ApiError => e
2780
+ puts "Error when calling LeasesApi->update_lease: #{e}"
2781
+ end
2782
+ ```
2783
+
2784
+ #### Using the update_lease_with_http_info variant
2785
+
2786
+ This returns an Array which contains the response data, status code and headers.
2787
+
2788
+ > <Array(<Lease>, Integer, Hash)> update_lease_with_http_info(lease_id, save_lease)
2789
+
2790
+ ```ruby
2791
+ begin
2792
+ # Update a lease (BETA)
2793
+ data, status_code, headers = api_instance.update_lease_with_http_info(lease_id, save_lease)
2794
+ p status_code # => 2xx
2795
+ p headers # => { ... }
2796
+ p data # => <Lease>
2797
+ rescue Propertyware::ApiError => e
2798
+ puts "Error when calling LeasesApi->update_lease_with_http_info: #{e}"
2799
+ end
2800
+ ```
2801
+
2802
+ ### Parameters
2803
+
2804
+ | Name | Type | Description | Notes |
2805
+ | ---- | ---- | ----------- | ----- |
2806
+ | **lease_id** | **Integer** | Lease ID | |
2807
+ | **save_lease** | [**SaveLease**](SaveLease.md) | lease | |
2808
+
2809
+ ### Return type
2810
+
2811
+ [**Lease**](Lease.md)
2812
+
2813
+ ### Authorization
2814
+
2815
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2816
+
2817
+ ### HTTP request headers
2818
+
2819
+ - **Content-Type**: application/json
2820
+ - **Accept**: application/json
2821
+
2822
+
2823
+ ## update_lease_adjustment
2824
+
2825
+ > <ChargeTx> update_lease_adjustment(adjustment_id, save_adjustment)
2826
+
2827
+ Update a lease adjustment (BETA)
2828
+
2829
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates an lease adjustment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
2830
+
2831
+ ### Examples
2832
+
2833
+ ```ruby
2834
+ require 'time'
2835
+ require 'propertyware'
2836
+ # setup authorization
2837
+ Propertyware.configure do |config|
2838
+ # Configure API key authorization: organizationId
2839
+ config.api_key['organizationId'] = 'YOUR API KEY'
2840
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2841
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2842
+
2843
+ # Configure API key authorization: clientId
2844
+ config.api_key['clientId'] = 'YOUR API KEY'
2845
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2846
+ # config.api_key_prefix['clientId'] = 'Bearer'
2847
+
2848
+ # Configure API key authorization: clientSecret
2849
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2850
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2851
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2852
+ end
2853
+
2854
+ api_instance = Propertyware::LeasesApi.new
2855
+ adjustment_id = 789 # Integer | Adjustment ID
2856
+ save_adjustment = Propertyware::SaveAdjustment.new({amount: 3.56, lease_id: 3.56}) # SaveAdjustment | saveAdjustment
2857
+
2858
+ begin
2859
+ # Update a lease adjustment (BETA)
2860
+ result = api_instance.update_lease_adjustment(adjustment_id, save_adjustment)
2861
+ p result
2862
+ rescue Propertyware::ApiError => e
2863
+ puts "Error when calling LeasesApi->update_lease_adjustment: #{e}"
2864
+ end
2865
+ ```
2866
+
2867
+ #### Using the update_lease_adjustment_with_http_info variant
2868
+
2869
+ This returns an Array which contains the response data, status code and headers.
2870
+
2871
+ > <Array(<ChargeTx>, Integer, Hash)> update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
2872
+
2873
+ ```ruby
2874
+ begin
2875
+ # Update a lease adjustment (BETA)
2876
+ data, status_code, headers = api_instance.update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
2877
+ p status_code # => 2xx
2878
+ p headers # => { ... }
2879
+ p data # => <ChargeTx>
2880
+ rescue Propertyware::ApiError => e
2881
+ puts "Error when calling LeasesApi->update_lease_adjustment_with_http_info: #{e}"
2882
+ end
2883
+ ```
2884
+
2885
+ ### Parameters
2886
+
2887
+ | Name | Type | Description | Notes |
2888
+ | ---- | ---- | ----------- | ----- |
2889
+ | **adjustment_id** | **Integer** | Adjustment ID | |
2890
+ | **save_adjustment** | [**SaveAdjustment**](SaveAdjustment.md) | saveAdjustment | |
2891
+
2892
+ ### Return type
2893
+
2894
+ [**ChargeTx**](ChargeTx.md)
2895
+
2896
+ ### Authorization
2897
+
2898
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2899
+
2900
+ ### HTTP request headers
2901
+
2902
+ - **Content-Type**: application/json
2903
+ - **Accept**: application/json
2904
+
2905
+
2906
+ ## update_lease_charge
2907
+
2908
+ > <ChargeTx> update_lease_charge(charge_id, save_charge)
2909
+
2910
+ Update a lease charge (BETA)
2911
+
2912
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates a lease charge.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
2913
+
2914
+ ### Examples
2915
+
2916
+ ```ruby
2917
+ require 'time'
2918
+ require 'propertyware'
2919
+ # setup authorization
2920
+ Propertyware.configure do |config|
2921
+ # Configure API key authorization: organizationId
2922
+ config.api_key['organizationId'] = 'YOUR API KEY'
2923
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2924
+ # config.api_key_prefix['organizationId'] = 'Bearer'
2925
+
2926
+ # Configure API key authorization: clientId
2927
+ config.api_key['clientId'] = 'YOUR API KEY'
2928
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2929
+ # config.api_key_prefix['clientId'] = 'Bearer'
2930
+
2931
+ # Configure API key authorization: clientSecret
2932
+ config.api_key['clientSecret'] = 'YOUR API KEY'
2933
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2934
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
2935
+ end
2936
+
2937
+ api_instance = Propertyware::LeasesApi.new
2938
+ charge_id = 789 # Integer | Charge ID
2939
+ save_charge = Propertyware::SaveCharge.new({amount: 3.56, date: Date.today, gl_account_id: 3.56, lease_id: 3.56}) # SaveCharge | saveCharge
2940
+
2941
+ begin
2942
+ # Update a lease charge (BETA)
2943
+ result = api_instance.update_lease_charge(charge_id, save_charge)
2944
+ p result
2945
+ rescue Propertyware::ApiError => e
2946
+ puts "Error when calling LeasesApi->update_lease_charge: #{e}"
2947
+ end
2948
+ ```
2949
+
2950
+ #### Using the update_lease_charge_with_http_info variant
2951
+
2952
+ This returns an Array which contains the response data, status code and headers.
2953
+
2954
+ > <Array(<ChargeTx>, Integer, Hash)> update_lease_charge_with_http_info(charge_id, save_charge)
2955
+
2956
+ ```ruby
2957
+ begin
2958
+ # Update a lease charge (BETA)
2959
+ data, status_code, headers = api_instance.update_lease_charge_with_http_info(charge_id, save_charge)
2960
+ p status_code # => 2xx
2961
+ p headers # => { ... }
2962
+ p data # => <ChargeTx>
2963
+ rescue Propertyware::ApiError => e
2964
+ puts "Error when calling LeasesApi->update_lease_charge_with_http_info: #{e}"
2965
+ end
2966
+ ```
2967
+
2968
+ ### Parameters
2969
+
2970
+ | Name | Type | Description | Notes |
2971
+ | ---- | ---- | ----------- | ----- |
2972
+ | **charge_id** | **Integer** | Charge ID | |
2973
+ | **save_charge** | [**SaveCharge**](SaveCharge.md) | saveCharge | |
2974
+
2975
+ ### Return type
2976
+
2977
+ [**ChargeTx**](ChargeTx.md)
2978
+
2979
+ ### Authorization
2980
+
2981
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2982
+
2983
+ ### HTTP request headers
2984
+
2985
+ - **Content-Type**: application/json
2986
+ - **Accept**: application/json
2987
+
2988
+
2989
+ ## update_lease_discount
2990
+
2991
+ > <Discount> update_lease_discount(discount_id, save_discount)
2992
+
2993
+ Updates a lease Discount (BETA)
2994
+
2995
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates a lease Discount.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
2996
+
2997
+ ### Examples
2998
+
2999
+ ```ruby
3000
+ require 'time'
3001
+ require 'propertyware'
3002
+ # setup authorization
3003
+ Propertyware.configure do |config|
3004
+ # Configure API key authorization: organizationId
3005
+ config.api_key['organizationId'] = 'YOUR API KEY'
3006
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3007
+ # config.api_key_prefix['organizationId'] = 'Bearer'
3008
+
3009
+ # Configure API key authorization: clientId
3010
+ config.api_key['clientId'] = 'YOUR API KEY'
3011
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3012
+ # config.api_key_prefix['clientId'] = 'Bearer'
3013
+
3014
+ # Configure API key authorization: clientSecret
3015
+ config.api_key['clientSecret'] = 'YOUR API KEY'
3016
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3017
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
3018
+ end
3019
+
3020
+ api_instance = Propertyware::LeasesApi.new
3021
+ discount_id = 789 # Integer | Discount ID
3022
+ save_discount = Propertyware::SaveDiscount.new({amount: 3.56, date: Date.today, discount_account_id: 3.56, lease_id: 3.56}) # SaveDiscount | saveDiscount
3023
+
3024
+ begin
3025
+ # Updates a lease Discount (BETA)
3026
+ result = api_instance.update_lease_discount(discount_id, save_discount)
3027
+ p result
3028
+ rescue Propertyware::ApiError => e
3029
+ puts "Error when calling LeasesApi->update_lease_discount: #{e}"
3030
+ end
3031
+ ```
3032
+
3033
+ #### Using the update_lease_discount_with_http_info variant
3034
+
3035
+ This returns an Array which contains the response data, status code and headers.
3036
+
3037
+ > <Array(<Discount>, Integer, Hash)> update_lease_discount_with_http_info(discount_id, save_discount)
3038
+
3039
+ ```ruby
3040
+ begin
3041
+ # Updates a lease Discount (BETA)
3042
+ data, status_code, headers = api_instance.update_lease_discount_with_http_info(discount_id, save_discount)
3043
+ p status_code # => 2xx
3044
+ p headers # => { ... }
3045
+ p data # => <Discount>
3046
+ rescue Propertyware::ApiError => e
3047
+ puts "Error when calling LeasesApi->update_lease_discount_with_http_info: #{e}"
3048
+ end
3049
+ ```
3050
+
3051
+ ### Parameters
3052
+
3053
+ | Name | Type | Description | Notes |
3054
+ | ---- | ---- | ----------- | ----- |
3055
+ | **discount_id** | **Integer** | Discount ID | |
3056
+ | **save_discount** | [**SaveDiscount**](SaveDiscount.md) | saveDiscount | |
3057
+
3058
+ ### Return type
3059
+
3060
+ [**Discount**](Discount.md)
3061
+
3062
+ ### Authorization
3063
+
3064
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
3065
+
3066
+ ### HTTP request headers
3067
+
3068
+ - **Content-Type**: application/json
3069
+ - **Accept**: application/json
3070
+
3071
+
3072
+ ## update_lease_journal_entry
3073
+
3074
+ > <JournalEntry> update_lease_journal_entry(journalentry_id, update_lease_journal_entry)
3075
+
3076
+ Update a lease journal entry (BETA)
3077
+
3078
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates a lease journal entry.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code> <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
3079
+
3080
+ ### Examples
3081
+
3082
+ ```ruby
3083
+ require 'time'
3084
+ require 'propertyware'
3085
+ # setup authorization
3086
+ Propertyware.configure do |config|
3087
+ # Configure API key authorization: organizationId
3088
+ config.api_key['organizationId'] = 'YOUR API KEY'
3089
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3090
+ # config.api_key_prefix['organizationId'] = 'Bearer'
3091
+
3092
+ # Configure API key authorization: clientId
3093
+ config.api_key['clientId'] = 'YOUR API KEY'
3094
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3095
+ # config.api_key_prefix['clientId'] = 'Bearer'
3096
+
3097
+ # Configure API key authorization: clientSecret
3098
+ config.api_key['clientSecret'] = 'YOUR API KEY'
3099
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3100
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
3101
+ end
3102
+
3103
+ api_instance = Propertyware::LeasesApi.new
3104
+ journalentry_id = 789 # Integer | Journal Entry ID
3105
+ update_lease_journal_entry = Propertyware::UpdateLeaseJournalEntry.new({comments: 'comments_example', date: Date.today, lease_id: 3.56}) # UpdateLeaseJournalEntry | updateLeaseJournalEntry
3106
+
3107
+ begin
3108
+ # Update a lease journal entry (BETA)
3109
+ result = api_instance.update_lease_journal_entry(journalentry_id, update_lease_journal_entry)
3110
+ p result
3111
+ rescue Propertyware::ApiError => e
3112
+ puts "Error when calling LeasesApi->update_lease_journal_entry: #{e}"
3113
+ end
3114
+ ```
3115
+
3116
+ #### Using the update_lease_journal_entry_with_http_info variant
3117
+
3118
+ This returns an Array which contains the response data, status code and headers.
3119
+
3120
+ > <Array(<JournalEntry>, Integer, Hash)> update_lease_journal_entry_with_http_info(journalentry_id, update_lease_journal_entry)
3121
+
3122
+ ```ruby
3123
+ begin
3124
+ # Update a lease journal entry (BETA)
3125
+ data, status_code, headers = api_instance.update_lease_journal_entry_with_http_info(journalentry_id, update_lease_journal_entry)
3126
+ p status_code # => 2xx
3127
+ p headers # => { ... }
3128
+ p data # => <JournalEntry>
3129
+ rescue Propertyware::ApiError => e
3130
+ puts "Error when calling LeasesApi->update_lease_journal_entry_with_http_info: #{e}"
3131
+ end
3132
+ ```
3133
+
3134
+ ### Parameters
3135
+
3136
+ | Name | Type | Description | Notes |
3137
+ | ---- | ---- | ----------- | ----- |
3138
+ | **journalentry_id** | **Integer** | Journal Entry ID | |
3139
+ | **update_lease_journal_entry** | [**UpdateLeaseJournalEntry**](UpdateLeaseJournalEntry.md) | updateLeaseJournalEntry | |
3140
+
3141
+ ### Return type
3142
+
3143
+ [**JournalEntry**](JournalEntry.md)
3144
+
3145
+ ### Authorization
3146
+
3147
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
3148
+
3149
+ ### HTTP request headers
3150
+
3151
+ - **Content-Type**: application/json
3152
+ - **Accept**: application/json
3153
+
3154
+
3155
+ ## update_lease_payment
3156
+
3157
+ > <Payment> update_lease_payment(entity_id, save_payment)
3158
+
3159
+ Update a lease payment (BETA)
3160
+
3161
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates a lease payment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
3162
+
3163
+ ### Examples
3164
+
3165
+ ```ruby
3166
+ require 'time'
3167
+ require 'propertyware'
3168
+ # setup authorization
3169
+ Propertyware.configure do |config|
3170
+ # Configure API key authorization: organizationId
3171
+ config.api_key['organizationId'] = 'YOUR API KEY'
3172
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3173
+ # config.api_key_prefix['organizationId'] = 'Bearer'
3174
+
3175
+ # Configure API key authorization: clientId
3176
+ config.api_key['clientId'] = 'YOUR API KEY'
3177
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3178
+ # config.api_key_prefix['clientId'] = 'Bearer'
3179
+
3180
+ # Configure API key authorization: clientSecret
3181
+ config.api_key['clientSecret'] = 'YOUR API KEY'
3182
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3183
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
3184
+ end
3185
+
3186
+ api_instance = Propertyware::LeasesApi.new
3187
+ entity_id = 789 # Integer | Lease Payment ID
3188
+ save_payment = Propertyware::SavePayment.new({amount: 3.56, contact_id: 3.56, date: Date.today, deposit_date: Date.today, destination_account_id: 3.56, lease_id: 3.56, payment_type: 'CHECK', ref_no: 'ref_no_example'}) # SavePayment | savePayment
3189
+
3190
+ begin
3191
+ # Update a lease payment (BETA)
3192
+ result = api_instance.update_lease_payment(entity_id, save_payment)
3193
+ p result
3194
+ rescue Propertyware::ApiError => e
3195
+ puts "Error when calling LeasesApi->update_lease_payment: #{e}"
3196
+ end
3197
+ ```
3198
+
3199
+ #### Using the update_lease_payment_with_http_info variant
3200
+
3201
+ This returns an Array which contains the response data, status code and headers.
3202
+
3203
+ > <Array(<Payment>, Integer, Hash)> update_lease_payment_with_http_info(entity_id, save_payment)
3204
+
3205
+ ```ruby
3206
+ begin
3207
+ # Update a lease payment (BETA)
3208
+ data, status_code, headers = api_instance.update_lease_payment_with_http_info(entity_id, save_payment)
3209
+ p status_code # => 2xx
3210
+ p headers # => { ... }
3211
+ p data # => <Payment>
3212
+ rescue Propertyware::ApiError => e
3213
+ puts "Error when calling LeasesApi->update_lease_payment_with_http_info: #{e}"
3214
+ end
3215
+ ```
3216
+
3217
+ ### Parameters
3218
+
3219
+ | Name | Type | Description | Notes |
3220
+ | ---- | ---- | ----------- | ----- |
3221
+ | **entity_id** | **Integer** | Lease Payment ID | |
3222
+ | **save_payment** | [**SavePayment**](SavePayment.md) | savePayment | |
3223
+
3224
+ ### Return type
3225
+
3226
+ [**Payment**](Payment.md)
3227
+
3228
+ ### Authorization
3229
+
3230
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
3231
+
3232
+ ### HTTP request headers
3233
+
3234
+ - **Content-Type**: application/json
3235
+ - **Accept**: application/json
3236
+
3237
+
3238
+ ## update_lease_refund
3239
+
3240
+ > <Refund> update_lease_refund(refund_id, save_refund)
3241
+
3242
+ Update a lease refund (BETA)
3243
+
3244
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update an lease refund.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
3245
+
3246
+ ### Examples
3247
+
3248
+ ```ruby
3249
+ require 'time'
3250
+ require 'propertyware'
3251
+ # setup authorization
3252
+ Propertyware.configure do |config|
3253
+ # Configure API key authorization: organizationId
3254
+ config.api_key['organizationId'] = 'YOUR API KEY'
3255
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3256
+ # config.api_key_prefix['organizationId'] = 'Bearer'
3257
+
3258
+ # Configure API key authorization: clientId
3259
+ config.api_key['clientId'] = 'YOUR API KEY'
3260
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3261
+ # config.api_key_prefix['clientId'] = 'Bearer'
3262
+
3263
+ # Configure API key authorization: clientSecret
3264
+ config.api_key['clientSecret'] = 'YOUR API KEY'
3265
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3266
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
3267
+ end
3268
+
3269
+ api_instance = Propertyware::LeasesApi.new
3270
+ refund_id = 789 # Integer | Refund ID
3271
+ save_refund = Propertyware::SaveRefund.new({amount: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, lease_id: 3.56, to_be_printed: false, to_primary_tenant: false}) # SaveRefund | saveRefund
3272
+
3273
+ begin
3274
+ # Update a lease refund (BETA)
3275
+ result = api_instance.update_lease_refund(refund_id, save_refund)
3276
+ p result
3277
+ rescue Propertyware::ApiError => e
3278
+ puts "Error when calling LeasesApi->update_lease_refund: #{e}"
3279
+ end
3280
+ ```
3281
+
3282
+ #### Using the update_lease_refund_with_http_info variant
3283
+
3284
+ This returns an Array which contains the response data, status code and headers.
3285
+
3286
+ > <Array(<Refund>, Integer, Hash)> update_lease_refund_with_http_info(refund_id, save_refund)
3287
+
3288
+ ```ruby
3289
+ begin
3290
+ # Update a lease refund (BETA)
3291
+ data, status_code, headers = api_instance.update_lease_refund_with_http_info(refund_id, save_refund)
3292
+ p status_code # => 2xx
3293
+ p headers # => { ... }
3294
+ p data # => <Refund>
3295
+ rescue Propertyware::ApiError => e
3296
+ puts "Error when calling LeasesApi->update_lease_refund_with_http_info: #{e}"
3297
+ end
3298
+ ```
3299
+
3300
+ ### Parameters
3301
+
3302
+ | Name | Type | Description | Notes |
3303
+ | ---- | ---- | ----------- | ----- |
3304
+ | **refund_id** | **Integer** | Refund ID | |
3305
+ | **save_refund** | [**SaveRefund**](SaveRefund.md) | saveRefund | |
3306
+
3307
+ ### Return type
3308
+
3309
+ [**Refund**](Refund.md)
3310
+
3311
+ ### Authorization
3312
+
3313
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
3314
+
3315
+ ### HTTP request headers
3316
+
3317
+ - **Content-Type**: application/json
3318
+ - **Accept**: application/json
3319
+