propertyware 1.1.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (312) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +21 -6
  3. data/.tool-versions +2 -0
  4. data/DOCS.md +18 -6
  5. data/Gemfile.lock +4 -2
  6. data/bin/config.yml +1 -1
  7. data/bin/fix_json.rb +0 -1
  8. data/bin/propertyware.json +16589 -1
  9. data/docs/Adjustment.md +40 -0
  10. data/docs/AutoPayment.md +2 -0
  11. data/docs/BankDeposit.md +1 -1
  12. data/docs/Charge.md +4 -2
  13. data/docs/ChargeTx.md +1 -5
  14. data/docs/ContactCategory.md +20 -0
  15. data/docs/ContactsApi.md +79 -0
  16. data/docs/{CustomFieldDefinitionsApi.md → CustomFieldFieldsApi.md} +5 -5
  17. data/docs/Document.md +7 -7
  18. data/docs/DocumentsApi.md +88 -4
  19. data/docs/Inspection.md +8 -0
  20. data/docs/Lease.md +12 -6
  21. data/docs/LeaseStatus.md +28 -0
  22. data/docs/LeasesApi.md +98 -19
  23. data/docs/Note.md +9 -3
  24. data/docs/OwnerContribution.md +5 -5
  25. data/docs/OwnerDraw.md +1 -1
  26. data/docs/Portfolio.md +2 -0
  27. data/docs/Prospect.md +4 -0
  28. data/docs/ProspectContact.md +30 -0
  29. data/docs/ProspectStatus.md +24 -0
  30. data/docs/ProspectsApi.md +79 -0
  31. data/docs/Refund.md +5 -5
  32. data/docs/SaveAdjustment.md +2 -2
  33. data/docs/SaveBankDeposit.md +1 -1
  34. data/docs/SaveContact.md +3 -1
  35. data/docs/SaveDiscount.md +1 -1
  36. data/docs/SaveLease.md +16 -6
  37. data/docs/SaveOwnerContribution.md +5 -5
  38. data/docs/SaveOwnerDraw.md +5 -5
  39. data/docs/SavePayment.md +6 -6
  40. data/docs/SavePortfolio.md +6 -0
  41. data/docs/SaveRefund.md +6 -6
  42. data/docs/SaveVendor.md +31 -1
  43. data/docs/SaveWorkOrder.md +13 -1
  44. data/docs/UpdateDocument.md +24 -0
  45. data/docs/Vendor.md +18 -0
  46. data/docs/WorkOrder.md +8 -0
  47. data/docs/WorkOrdersApi.md +2 -2
  48. data/lib/propertyware/api/accounting_api.rb +1 -1
  49. data/lib/propertyware/api/bills_api.rb +1 -1
  50. data/lib/propertyware/api/buildings_api.rb +1 -1
  51. data/lib/propertyware/api/contacts_api.rb +58 -1
  52. data/lib/propertyware/api/{custom_field_definitions_api.rb → custom_field_fields_api.rb} +6 -6
  53. data/lib/propertyware/api/documents_api.rb +79 -5
  54. data/lib/propertyware/api/health_check_api.rb +1 -1
  55. data/lib/propertyware/api/inspections_api.rb +1 -1
  56. data/lib/propertyware/api/leases_api.rb +72 -15
  57. data/lib/propertyware/api/portfolios_api.rb +1 -1
  58. data/lib/propertyware/api/prospects_api.rb +58 -1
  59. data/lib/propertyware/api/units_api.rb +1 -1
  60. data/lib/propertyware/api/vendors_api.rb +1 -1
  61. data/lib/propertyware/api/work_orders_api.rb +1 -1
  62. data/lib/propertyware/api_client.rb +1 -1
  63. data/lib/propertyware/api_error.rb +1 -1
  64. data/lib/propertyware/configuration.rb +1 -1
  65. data/lib/propertyware/models/account.rb +2 -2
  66. data/lib/propertyware/models/address.rb +1 -1
  67. data/lib/propertyware/models/{transaction.rb → adjustment.rb} +25 -119
  68. data/lib/propertyware/models/amenity.rb +1 -1
  69. data/lib/propertyware/models/auto_journal_entry.rb +35 -1
  70. data/lib/propertyware/models/auto_payment.rb +46 -2
  71. data/lib/propertyware/models/bank.rb +1 -1
  72. data/lib/propertyware/models/bank_deposit.rb +2 -2
  73. data/lib/propertyware/models/basic_vendor.rb +1 -1
  74. data/lib/propertyware/models/bill.rb +1 -1
  75. data/lib/propertyware/models/bill_paid.rb +1 -1
  76. data/lib/propertyware/models/bill_pay.rb +1 -1
  77. data/lib/propertyware/models/bill_payment.rb +1 -1
  78. data/lib/propertyware/models/bill_split.rb +1 -1
  79. data/lib/propertyware/models/building.rb +1 -1
  80. data/lib/propertyware/models/campaign.rb +1 -1
  81. data/lib/propertyware/models/campaign_source.rb +1 -1
  82. data/lib/propertyware/models/charge.rb +48 -4
  83. data/lib/propertyware/models/charge_tx.rb +5 -25
  84. data/lib/propertyware/models/check.rb +1 -1
  85. data/lib/propertyware/models/check_split.rb +1 -1
  86. data/lib/propertyware/models/comment.rb +1 -1
  87. data/lib/propertyware/models/contact.rb +1 -1
  88. data/lib/propertyware/models/contact_category.rb +229 -0
  89. data/lib/propertyware/models/conversation.rb +1 -1
  90. data/lib/propertyware/models/credit_card_account.rb +1 -1
  91. data/lib/propertyware/models/credit_memo.rb +1 -1
  92. data/lib/propertyware/models/current_asset.rb +1 -1
  93. data/lib/propertyware/models/current_liability.rb +1 -1
  94. data/lib/propertyware/models/custom_field.rb +1 -1
  95. data/lib/propertyware/models/custom_field_definition.rb +1 -1
  96. data/lib/propertyware/models/discount.rb +1 -1
  97. data/lib/propertyware/models/document.rb +35 -35
  98. data/lib/propertyware/models/entry.rb +1 -1
  99. data/lib/propertyware/models/equity.rb +1 -1
  100. data/lib/propertyware/models/error_response.rb +1 -1
  101. data/lib/propertyware/models/expense.rb +1 -1
  102. data/lib/propertyware/models/gl_item.rb +1 -1
  103. data/lib/propertyware/models/income.rb +1 -1
  104. data/lib/propertyware/models/inspection.rb +42 -2
  105. data/lib/propertyware/models/inspection_area.rb +1 -1
  106. data/lib/propertyware/models/inspection_item.rb +1 -1
  107. data/lib/propertyware/models/journal_entry.rb +1 -1
  108. data/lib/propertyware/models/journal_entry_split.rb +1 -1
  109. data/lib/propertyware/models/journal_entry_split_response.rb +1 -1
  110. data/lib/propertyware/models/late_fee_rule.rb +1 -1
  111. data/lib/propertyware/models/lease.rb +38 -8
  112. data/lib/propertyware/models/lease_clause.rb +1 -1
  113. data/lib/propertyware/models/lease_contact.rb +1 -1
  114. data/lib/propertyware/models/lease_status.rb +263 -0
  115. data/lib/propertyware/models/management_fee.rb +1 -1
  116. data/lib/propertyware/models/management_settings.rb +1 -1
  117. data/lib/propertyware/models/marketing.rb +1 -1
  118. data/lib/propertyware/models/non_current_asset.rb +1 -1
  119. data/lib/propertyware/models/non_current_liability.rb +1 -1
  120. data/lib/propertyware/models/non_operating_expense.rb +1 -1
  121. data/lib/propertyware/models/non_operating_inome.rb +1 -1
  122. data/lib/propertyware/models/note.rb +45 -15
  123. data/lib/propertyware/models/owner.rb +1 -1
  124. data/lib/propertyware/models/owner_contribution.rb +1 -26
  125. data/lib/propertyware/models/owner_draw.rb +1 -6
  126. data/lib/propertyware/models/payment.rb +1 -1
  127. data/lib/propertyware/models/payment_charge.rb +1 -1
  128. data/lib/propertyware/models/portfolio.rb +12 -2
  129. data/lib/propertyware/models/property_manager.rb +1 -1
  130. data/lib/propertyware/models/prospect.rb +24 -2
  131. data/lib/propertyware/models/prospect_contact.rb +279 -0
  132. data/lib/propertyware/models/prospect_status.rb +249 -0
  133. data/lib/propertyware/models/refund.rb +3 -28
  134. data/lib/propertyware/models/response_entity.rb +1 -1
  135. data/lib/propertyware/models/restapi_bulk_error_response.rb +1 -1
  136. data/lib/propertyware/models/restapi_bulk_success_response.rb +1 -1
  137. data/lib/propertyware/models/restapi_error.rb +1 -1
  138. data/lib/propertyware/models/save_account.rb +1 -1
  139. data/lib/propertyware/models/save_address.rb +1 -1
  140. data/lib/propertyware/models/save_adjustment.rb +3 -3
  141. data/lib/propertyware/models/save_auto_charge.rb +1 -1
  142. data/lib/propertyware/models/save_bank_deposit.rb +2 -2
  143. data/lib/propertyware/models/save_bill.rb +1 -1
  144. data/lib/propertyware/models/save_bill_payment.rb +1 -1
  145. data/lib/propertyware/models/save_bill_split.rb +1 -1
  146. data/lib/propertyware/models/save_building.rb +1 -1
  147. data/lib/propertyware/models/save_charge.rb +1 -1
  148. data/lib/propertyware/models/save_check.rb +1 -1
  149. data/lib/propertyware/models/save_check_split.rb +1 -1
  150. data/lib/propertyware/models/save_comment.rb +1 -1
  151. data/lib/propertyware/models/save_contact.rb +261 -3
  152. data/lib/propertyware/models/save_conversation.rb +1 -1
  153. data/lib/propertyware/models/save_credit.rb +1 -1
  154. data/lib/propertyware/models/save_discount.rb +2 -2
  155. data/lib/propertyware/models/save_journal_entry_split.rb +1 -1
  156. data/lib/propertyware/models/save_lease.rb +58 -8
  157. data/lib/propertyware/models/save_lease_journal_entry.rb +1 -1
  158. data/lib/propertyware/models/save_owner.rb +1 -1
  159. data/lib/propertyware/models/save_owner_contribution.rb +6 -6
  160. data/lib/propertyware/models/save_owner_draw.rb +6 -6
  161. data/lib/propertyware/models/save_payment.rb +7 -7
  162. data/lib/propertyware/models/save_portfolio.rb +32 -2
  163. data/lib/propertyware/models/save_prospect.rb +1 -1
  164. data/lib/propertyware/models/save_prospect_contact.rb +1 -1
  165. data/lib/propertyware/models/save_refund.rb +8 -18
  166. data/lib/propertyware/models/save_unit.rb +1 -1
  167. data/lib/propertyware/models/save_vendor.rb +187 -3
  168. data/lib/propertyware/models/save_work_order.rb +79 -2
  169. data/lib/propertyware/models/save_work_order_task.rb +1 -1
  170. data/lib/propertyware/models/split_paid.rb +1 -1
  171. data/lib/propertyware/models/split_pay.rb +1 -1
  172. data/lib/propertyware/models/task.rb +1 -1
  173. data/lib/propertyware/models/unit.rb +1 -1
  174. data/lib/propertyware/models/update_document.rb +254 -0
  175. data/lib/propertyware/models/update_lease_journal_entry.rb +1 -1
  176. data/lib/propertyware/models/vendor.rb +92 -2
  177. data/lib/propertyware/models/work_order.rb +54 -2
  178. data/lib/propertyware/version.rb +2 -2
  179. data/lib/propertyware.rb +8 -3
  180. data/propertyware.gemspec +1 -1
  181. data/spec/api/accounting_api_spec.rb +1 -1
  182. data/spec/api/bills_api_spec.rb +1 -1
  183. data/spec/api/buildings_api_spec.rb +1 -1
  184. data/spec/api/contacts_api_spec.rb +12 -1
  185. data/spec/api/{custom_field_definitions_api_spec.rb → custom_field_fields_api_spec.rb} +7 -7
  186. data/spec/api/documents_api_spec.rb +16 -3
  187. data/spec/api/health_check_api_spec.rb +1 -1
  188. data/spec/api/inspections_api_spec.rb +1 -1
  189. data/spec/api/leases_api_spec.rb +17 -6
  190. data/spec/api/portfolios_api_spec.rb +1 -1
  191. data/spec/api/prospects_api_spec.rb +12 -1
  192. data/spec/api/units_api_spec.rb +1 -1
  193. data/spec/api/vendors_api_spec.rb +1 -1
  194. data/spec/api/work_orders_api_spec.rb +1 -1
  195. data/spec/api_client_spec.rb +1 -1
  196. data/spec/configuration_spec.rb +1 -1
  197. data/spec/models/account_spec.rb +1 -1
  198. data/spec/models/address_spec.rb +1 -1
  199. data/spec/models/{transaction_spec.rb → adjustment_spec.rb} +7 -53
  200. data/spec/models/amenity_spec.rb +1 -1
  201. data/spec/models/auto_journal_entry_spec.rb +5 -1
  202. data/spec/models/auto_payment_spec.rb +11 -1
  203. data/spec/models/bank_deposit_spec.rb +1 -1
  204. data/spec/models/bank_spec.rb +1 -1
  205. data/spec/models/basic_vendor_spec.rb +1 -1
  206. data/spec/models/bill_paid_spec.rb +1 -1
  207. data/spec/models/bill_pay_spec.rb +1 -1
  208. data/spec/models/bill_payment_spec.rb +1 -1
  209. data/spec/models/bill_spec.rb +1 -1
  210. data/spec/models/bill_split_spec.rb +1 -1
  211. data/spec/models/building_spec.rb +1 -1
  212. data/spec/models/campaign_source_spec.rb +1 -1
  213. data/spec/models/campaign_spec.rb +1 -1
  214. data/spec/models/charge_spec.rb +11 -1
  215. data/spec/models/charge_tx_spec.rb +1 -13
  216. data/spec/models/check_spec.rb +1 -1
  217. data/spec/models/check_split_spec.rb +1 -1
  218. data/spec/models/comment_spec.rb +1 -1
  219. data/spec/models/contact_category_spec.rb +40 -0
  220. data/spec/models/contact_spec.rb +1 -1
  221. data/spec/models/conversation_spec.rb +1 -1
  222. data/spec/models/credit_card_account_spec.rb +1 -1
  223. data/spec/models/credit_memo_spec.rb +1 -1
  224. data/spec/models/current_asset_spec.rb +1 -1
  225. data/spec/models/current_liability_spec.rb +1 -1
  226. data/spec/models/custom_field_definition_spec.rb +1 -1
  227. data/spec/models/custom_field_spec.rb +1 -1
  228. data/spec/models/discount_spec.rb +1 -1
  229. data/spec/models/document_spec.rb +7 -7
  230. data/spec/models/entry_spec.rb +1 -1
  231. data/spec/models/equity_spec.rb +1 -1
  232. data/spec/models/error_response_spec.rb +1 -1
  233. data/spec/models/expense_spec.rb +1 -1
  234. data/spec/models/gl_item_spec.rb +1 -1
  235. data/spec/models/income_spec.rb +1 -1
  236. data/spec/models/inspection_area_spec.rb +1 -1
  237. data/spec/models/inspection_item_spec.rb +1 -1
  238. data/spec/models/inspection_spec.rb +25 -1
  239. data/spec/models/journal_entry_spec.rb +1 -1
  240. data/spec/models/journal_entry_split_response_spec.rb +1 -1
  241. data/spec/models/journal_entry_split_spec.rb +1 -1
  242. data/spec/models/late_fee_rule_spec.rb +1 -1
  243. data/spec/models/lease_clause_spec.rb +1 -1
  244. data/spec/models/lease_contact_spec.rb +1 -1
  245. data/spec/models/lease_spec.rb +19 -1
  246. data/spec/models/lease_status_spec.rb +64 -0
  247. data/spec/models/management_fee_spec.rb +1 -1
  248. data/spec/models/management_settings_spec.rb +1 -1
  249. data/spec/models/marketing_spec.rb +1 -1
  250. data/spec/models/non_current_asset_spec.rb +1 -1
  251. data/spec/models/non_current_liability_spec.rb +1 -1
  252. data/spec/models/non_operating_expense_spec.rb +1 -1
  253. data/spec/models/non_operating_inome_spec.rb +1 -1
  254. data/spec/models/note_spec.rb +22 -4
  255. data/spec/models/owner_contribution_spec.rb +1 -1
  256. data/spec/models/owner_draw_spec.rb +1 -1
  257. data/spec/models/owner_spec.rb +1 -1
  258. data/spec/models/payment_charge_spec.rb +1 -1
  259. data/spec/models/payment_spec.rb +1 -1
  260. data/spec/models/portfolio_spec.rb +7 -1
  261. data/spec/models/property_manager_spec.rb +1 -1
  262. data/spec/models/prospect_contact_spec.rb +70 -0
  263. data/spec/models/prospect_spec.rb +13 -1
  264. data/spec/models/prospect_status_spec.rb +52 -0
  265. data/spec/models/refund_spec.rb +1 -1
  266. data/spec/models/response_entity_spec.rb +1 -1
  267. data/spec/models/restapi_bulk_error_response_spec.rb +1 -1
  268. data/spec/models/restapi_bulk_success_response_spec.rb +1 -1
  269. data/spec/models/restapi_error_spec.rb +1 -1
  270. data/spec/models/save_account_spec.rb +1 -1
  271. data/spec/models/save_address_spec.rb +1 -1
  272. data/spec/models/save_adjustment_spec.rb +1 -1
  273. data/spec/models/save_auto_charge_spec.rb +1 -1
  274. data/spec/models/save_bank_deposit_spec.rb +1 -1
  275. data/spec/models/save_bill_payment_spec.rb +1 -1
  276. data/spec/models/save_bill_spec.rb +1 -1
  277. data/spec/models/save_bill_split_spec.rb +1 -1
  278. data/spec/models/save_building_spec.rb +1 -1
  279. data/spec/models/save_charge_spec.rb +1 -1
  280. data/spec/models/save_check_spec.rb +1 -1
  281. data/spec/models/save_check_split_spec.rb +1 -1
  282. data/spec/models/save_comment_spec.rb +1 -1
  283. data/spec/models/save_contact_spec.rb +7 -1
  284. data/spec/models/save_conversation_spec.rb +1 -1
  285. data/spec/models/save_credit_spec.rb +1 -1
  286. data/spec/models/save_discount_spec.rb +1 -1
  287. data/spec/models/save_journal_entry_split_spec.rb +1 -1
  288. data/spec/models/save_lease_journal_entry_spec.rb +1 -1
  289. data/spec/models/save_lease_spec.rb +31 -1
  290. data/spec/models/save_owner_contribution_spec.rb +1 -1
  291. data/spec/models/save_owner_draw_spec.rb +1 -1
  292. data/spec/models/save_owner_spec.rb +1 -1
  293. data/spec/models/save_payment_spec.rb +1 -1
  294. data/spec/models/save_portfolio_spec.rb +19 -1
  295. data/spec/models/save_prospect_contact_spec.rb +1 -1
  296. data/spec/models/save_prospect_spec.rb +1 -1
  297. data/spec/models/save_refund_spec.rb +1 -1
  298. data/spec/models/save_unit_spec.rb +1 -1
  299. data/spec/models/save_vendor_spec.rb +95 -1
  300. data/spec/models/save_work_order_spec.rb +41 -1
  301. data/spec/models/save_work_order_task_spec.rb +1 -1
  302. data/spec/models/split_paid_spec.rb +1 -1
  303. data/spec/models/split_pay_spec.rb +1 -1
  304. data/spec/models/task_spec.rb +1 -1
  305. data/spec/models/unit_spec.rb +1 -1
  306. data/spec/models/update_document_spec.rb +52 -0
  307. data/spec/models/update_lease_journal_entry_spec.rb +1 -1
  308. data/spec/models/vendor_spec.rb +55 -1
  309. data/spec/models/work_order_spec.rb +29 -1
  310. data/spec/spec_helper.rb +1 -1
  311. metadata +31 -10
  312. data/docs/Transaction.md +0 -54
data/docs/LeasesApi.md CHANGED
@@ -16,6 +16,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
16
16
  | [**create_lease_refund**](LeasesApi.md#create_lease_refund) | **POST** /leases/refunds | Create a lease refund (BETA) |
17
17
  | [**delete_lease**](LeasesApi.md#delete_lease) | **DELETE** /leases/{leaseID} | Delete a lease (BETA) |
18
18
  | [**delete_lease_conversation**](LeasesApi.md#delete_lease_conversation) | **DELETE** /leases/{leaseID}/conversations/{conversationID} | Delete a lease conversation (BETA) |
19
+ | [**get_all_lease_statuses**](LeasesApi.md#get_all_lease_statuses) | **GET** /leases/statuses | Retrieve all lease statuses (BETA) |
19
20
  | [**get_lease**](LeasesApi.md#get_lease) | **GET** /leases/{leaseId} | Retrieve a lease |
20
21
  | [**get_lease_adjustments**](LeasesApi.md#get_lease_adjustments) | **GET** /leases/adjustments | Retrieve all the adjustments |
21
22
  | [**get_lease_auto_charges**](LeasesApi.md#get_lease_auto_charges) | **GET** /leases/{leaseId}/autocharges | Retrieve all lease auto charges |
@@ -294,7 +295,7 @@ end
294
295
 
295
296
  ## create_lease_adjustment
296
297
 
297
- > <ChargeTx> create_lease_adjustment(save_adjustment)
298
+ > <Adjustment> create_lease_adjustment(save_adjustment)
298
299
 
299
300
  Create a lease adjustment (BETA)
300
301
 
@@ -339,7 +340,7 @@ end
339
340
 
340
341
  This returns an Array which contains the response data, status code and headers.
341
342
 
342
- > <Array(<ChargeTx>, Integer, Hash)> create_lease_adjustment_with_http_info(save_adjustment)
343
+ > <Array(<Adjustment>, Integer, Hash)> create_lease_adjustment_with_http_info(save_adjustment)
343
344
 
344
345
  ```ruby
345
346
  begin
@@ -347,7 +348,7 @@ begin
347
348
  data, status_code, headers = api_instance.create_lease_adjustment_with_http_info(save_adjustment)
348
349
  p status_code # => 2xx
349
350
  p headers # => { ... }
350
- p data # => <ChargeTx>
351
+ p data # => <Adjustment>
351
352
  rescue Propertyware::ApiError => e
352
353
  puts "Error when calling LeasesApi->create_lease_adjustment_with_http_info: #{e}"
353
354
  end
@@ -361,7 +362,7 @@ end
361
362
 
362
363
  ### Return type
363
364
 
364
- [**ChargeTx**](ChargeTx.md)
365
+ [**Adjustment**](Adjustment.md)
365
366
 
366
367
  ### Authorization
367
368
 
@@ -812,7 +813,7 @@ Propertyware.configure do |config|
812
813
  end
813
814
 
814
815
  api_instance = Propertyware::LeasesApi.new
815
- 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
816
+ 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}) # SaveRefund | saveRefund
816
817
 
817
818
  begin
818
819
  # Create a lease refund (BETA)
@@ -1025,6 +1026,84 @@ end
1025
1026
  - **Accept**: application/json
1026
1027
 
1027
1028
 
1029
+ ## get_all_lease_statuses
1030
+
1031
+ > <Array<LeaseStatus>> get_all_lease_statuses
1032
+
1033
+ Retrieve all lease statuses (BETA)
1034
+
1035
+ <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 a list of all lease statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
1036
+
1037
+ ### Examples
1038
+
1039
+ ```ruby
1040
+ require 'time'
1041
+ require 'propertyware'
1042
+ # setup authorization
1043
+ Propertyware.configure do |config|
1044
+ # Configure API key authorization: organizationId
1045
+ config.api_key['organizationId'] = 'YOUR API KEY'
1046
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1047
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1048
+
1049
+ # Configure API key authorization: clientId
1050
+ config.api_key['clientId'] = 'YOUR API KEY'
1051
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1052
+ # config.api_key_prefix['clientId'] = 'Bearer'
1053
+
1054
+ # Configure API key authorization: clientSecret
1055
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1056
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1057
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1058
+ end
1059
+
1060
+ api_instance = Propertyware::LeasesApi.new
1061
+
1062
+ begin
1063
+ # Retrieve all lease statuses (BETA)
1064
+ result = api_instance.get_all_lease_statuses
1065
+ p result
1066
+ rescue Propertyware::ApiError => e
1067
+ puts "Error when calling LeasesApi->get_all_lease_statuses: #{e}"
1068
+ end
1069
+ ```
1070
+
1071
+ #### Using the get_all_lease_statuses_with_http_info variant
1072
+
1073
+ This returns an Array which contains the response data, status code and headers.
1074
+
1075
+ > <Array(<Array<LeaseStatus>>, Integer, Hash)> get_all_lease_statuses_with_http_info
1076
+
1077
+ ```ruby
1078
+ begin
1079
+ # Retrieve all lease statuses (BETA)
1080
+ data, status_code, headers = api_instance.get_all_lease_statuses_with_http_info
1081
+ p status_code # => 2xx
1082
+ p headers # => { ... }
1083
+ p data # => <Array<LeaseStatus>>
1084
+ rescue Propertyware::ApiError => e
1085
+ puts "Error when calling LeasesApi->get_all_lease_statuses_with_http_info: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+
1091
+ This endpoint does not need any parameter.
1092
+
1093
+ ### Return type
1094
+
1095
+ [**Array&lt;LeaseStatus&gt;**](LeaseStatus.md)
1096
+
1097
+ ### Authorization
1098
+
1099
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1100
+
1101
+ ### HTTP request headers
1102
+
1103
+ - **Content-Type**: Not defined
1104
+ - **Accept**: application/json
1105
+
1106
+
1028
1107
  ## get_lease
1029
1108
 
1030
1109
  > <Lease> get_lease(lease_id, opts)
@@ -1112,11 +1191,11 @@ end
1112
1191
 
1113
1192
  ## get_lease_adjustments
1114
1193
 
1115
- > <Array<Transaction>> get_lease_adjustments(opts)
1194
+ > <Array<Adjustment>> get_lease_adjustments(opts)
1116
1195
 
1117
1196
  Retrieve all the adjustments
1118
1197
 
1119
- 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>
1198
+ Retrieves a list of adjustments.<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>id</code>
1120
1199
 
1121
1200
  ### Examples
1122
1201
 
@@ -1168,7 +1247,7 @@ end
1168
1247
 
1169
1248
  This returns an Array which contains the response data, status code and headers.
1170
1249
 
1171
- > <Array(<Array<Transaction>>, Integer, Hash)> get_lease_adjustments_with_http_info(opts)
1250
+ > <Array(<Array<Adjustment>>, Integer, Hash)> get_lease_adjustments_with_http_info(opts)
1172
1251
 
1173
1252
  ```ruby
1174
1253
  begin
@@ -1176,7 +1255,7 @@ begin
1176
1255
  data, status_code, headers = api_instance.get_lease_adjustments_with_http_info(opts)
1177
1256
  p status_code # => 2xx
1178
1257
  p headers # => { ... }
1179
- p data # => <Array<Transaction>>
1258
+ p data # => <Array<Adjustment>>
1180
1259
  rescue Propertyware::ApiError => e
1181
1260
  puts "Error when calling LeasesApi->get_lease_adjustments_with_http_info: #{e}"
1182
1261
  end
@@ -1199,7 +1278,7 @@ end
1199
1278
 
1200
1279
  ### Return type
1201
1280
 
1202
- [**Array&lt;Transaction&gt;**](Transaction.md)
1281
+ [**Array&lt;Adjustment&gt;**](Adjustment.md)
1203
1282
 
1204
1283
  ### Authorization
1205
1284
 
@@ -2002,7 +2081,7 @@ end
2002
2081
 
2003
2082
  ## get_lease_discounts
2004
2083
 
2005
- > <Array<Transaction>> get_lease_discounts(opts)
2084
+ > <Array<Discount>> get_lease_discounts(opts)
2006
2085
 
2007
2086
  Retrieve all the lease discounts
2008
2087
 
@@ -2056,7 +2135,7 @@ end
2056
2135
 
2057
2136
  This returns an Array which contains the response data, status code and headers.
2058
2137
 
2059
- > <Array(<Array<Transaction>>, Integer, Hash)> get_lease_discounts_with_http_info(opts)
2138
+ > <Array(<Array<Discount>>, Integer, Hash)> get_lease_discounts_with_http_info(opts)
2060
2139
 
2061
2140
  ```ruby
2062
2141
  begin
@@ -2064,7 +2143,7 @@ begin
2064
2143
  data, status_code, headers = api_instance.get_lease_discounts_with_http_info(opts)
2065
2144
  p status_code # => 2xx
2066
2145
  p headers # => { ... }
2067
- p data # => <Array<Transaction>>
2146
+ p data # => <Array<Discount>>
2068
2147
  rescue Propertyware::ApiError => e
2069
2148
  puts "Error when calling LeasesApi->get_lease_discounts_with_http_info: #{e}"
2070
2149
  end
@@ -2085,7 +2164,7 @@ end
2085
2164
 
2086
2165
  ### Return type
2087
2166
 
2088
- [**Array&lt;Transaction&gt;**](Transaction.md)
2167
+ [**Array&lt;Discount&gt;**](Discount.md)
2089
2168
 
2090
2169
  ### Authorization
2091
2170
 
@@ -2924,7 +3003,7 @@ end
2924
3003
 
2925
3004
  ## update_lease_adjustment
2926
3005
 
2927
- > <ChargeTx> update_lease_adjustment(adjustment_id, save_adjustment)
3006
+ > <Adjustment> update_lease_adjustment(adjustment_id, save_adjustment)
2928
3007
 
2929
3008
  Update a lease adjustment (BETA)
2930
3009
 
@@ -2970,7 +3049,7 @@ end
2970
3049
 
2971
3050
  This returns an Array which contains the response data, status code and headers.
2972
3051
 
2973
- > <Array(<ChargeTx>, Integer, Hash)> update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
3052
+ > <Array(<Adjustment>, Integer, Hash)> update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
2974
3053
 
2975
3054
  ```ruby
2976
3055
  begin
@@ -2978,7 +3057,7 @@ begin
2978
3057
  data, status_code, headers = api_instance.update_lease_adjustment_with_http_info(adjustment_id, save_adjustment)
2979
3058
  p status_code # => 2xx
2980
3059
  p headers # => { ... }
2981
- p data # => <ChargeTx>
3060
+ p data # => <Adjustment>
2982
3061
  rescue Propertyware::ApiError => e
2983
3062
  puts "Error when calling LeasesApi->update_lease_adjustment_with_http_info: #{e}"
2984
3063
  end
@@ -2993,7 +3072,7 @@ end
2993
3072
 
2994
3073
  ### Return type
2995
3074
 
2996
- [**ChargeTx**](ChargeTx.md)
3075
+ [**Adjustment**](Adjustment.md)
2997
3076
 
2998
3077
  ### Authorization
2999
3078
 
@@ -3370,7 +3449,7 @@ end
3370
3449
 
3371
3450
  api_instance = Propertyware::LeasesApi.new
3372
3451
  refund_id = 789 # Integer | Refund ID
3373
- 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
3452
+ 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}) # SaveRefund | saveRefund
3374
3453
 
3375
3454
  begin
3376
3455
  # Update a lease refund (BETA)
data/docs/Note.md CHANGED
@@ -5,11 +5,14 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **body** | **String** | Content of the note. | [optional] |
8
+ | **created_by** | **String** | User who created the record. | [optional] |
9
+ | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
8
10
  | **date** | **Date** | Date the note was created. | [optional] |
9
11
  | **id** | **Integer** | Unique identifier. | [optional] |
12
+ | **last_modified_by** | **String** | User who last modified the record. | [optional] |
13
+ | **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
10
14
  | **private** | **Boolean** | | [optional] |
11
15
  | **subject** | **String** | Subject. | [optional] |
12
- | **type** | **String** | Note type. | [optional] |
13
16
 
14
17
  ## Example
15
18
 
@@ -18,11 +21,14 @@ require 'propertyware'
18
21
 
19
22
  instance = Propertyware::Note.new(
20
23
  body: null,
24
+ created_by: null,
25
+ created_date_time: null,
21
26
  date: null,
22
27
  id: null,
28
+ last_modified_by: null,
29
+ last_modified_date_time: null,
23
30
  private: null,
24
- subject: null,
25
- type: null
31
+ subject: null
26
32
  )
27
33
  ```
28
34
 
@@ -6,17 +6,17 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **amount** | **Float** | Amount. | |
8
8
  | **comments** | **String** | Comments. | [optional] |
9
- | **contact_id** | **Integer** | Id of the contact associated with this owner contribution. | |
9
+ | **contact_id** | **Integer** | Id of the contact associated with this owner contribution. | [optional] |
10
10
  | **created_by** | **String** | User who created the record. | [optional] |
11
11
  | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
12
12
  | **date** | **Date** | Post date. | |
13
- | **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. | |
14
- | **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. | |
13
+ | **destination_account_id** | **Integer** | Id of the bank account where the payment will be deposited. | [optional] |
14
+ | **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner contribution. | [optional] |
15
15
  | **id** | **Integer** | Unique identifier. | [optional] |
16
16
  | **last_modified_by** | **String** | User who last modified the record. | [optional] |
17
17
  | **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
18
- | **payment_type** | **String** | Payment type. | |
19
- | **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. | |
18
+ | **payment_type** | **String** | Payment type. | [optional] |
19
+ | **portfolio_id** | **Integer** | Id of the portfolio to apply the payment to. | [optional] |
20
20
  | **ref_no** | **String** | Reference number. | [optional] |
21
21
 
22
22
  ## Example
data/docs/OwnerDraw.md CHANGED
@@ -11,7 +11,7 @@
11
11
  | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
12
12
  | **date** | **Date** | Post date. | |
13
13
  | **destination_account_id** | **Integer** | Id of the bank account where the payment will be made from. | [optional] |
14
- | **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. | |
14
+ | **gl_account_id** | **Integer** | Id of the general ledger account associated with this owner draw. | [optional] |
15
15
  | **id** | **Integer** | Unique identifier. | [optional] |
16
16
  | **last_modified_by** | **String** | User who last modified the record. | [optional] |
17
17
  | **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
data/docs/Portfolio.md CHANGED
@@ -23,6 +23,7 @@
23
23
  | **maintenance_spending_limit_time** | **String** | Monthly or yearly maintenance spending limit time set for the portfolio for maintenance bills created by work orders. | [optional] |
24
24
  | **modified_by** | **String** | Id of the user who last modified the portfolio information. | [optional] |
25
25
  | **name** | **String** | Portfolio name. | [optional] |
26
+ | **owner_statement_report_id** | **Integer** | Portfolio Owner Statement Report ID | [optional] |
26
27
  | **owners** | [**Array&lt;Owner&gt;**](Owner.md) | List of portfolio owners. | [optional] |
27
28
  | **sticky_note** | **String** | Sticky notes. | [optional] |
28
29
  | **target_operating_reserve** | **Float** | Minimum balance to be maintained within the portfolio at all times. | [optional] |
@@ -52,6 +53,7 @@ instance = Propertyware::Portfolio.new(
52
53
  maintenance_spending_limit_time: null,
53
54
  modified_by: null,
54
55
  name: null,
56
+ owner_statement_report_id: null,
55
57
  owners: null,
56
58
  sticky_note: null,
57
59
  target_operating_reserve: null
data/docs/Prospect.md CHANGED
@@ -9,6 +9,7 @@
9
9
  | **building_id** | **Integer** | Id of the building associated with the prospect. | [optional] |
10
10
  | **city_desired** | **String** | Desired city. | [optional] |
11
11
  | **comments** | **String** | Indicates if the prospect has any comments. | [optional] |
12
+ | **contacts** | [**Array&lt;ProspectContact&gt;**](ProspectContact.md) | Contacts of the prospect | [optional] |
12
13
  | **created_by** | **String** | User who created the record. | [optional] |
13
14
  | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
14
15
  | **current_home_type** | **String** | Current home type. | [optional] |
@@ -51,6 +52,7 @@
51
52
  | **type** | **String** | Prospect type. | [optional] |
52
53
  | **type_of_inquiry** | **String** | Type of inquiry made by the prospect. | [optional] |
53
54
  | **unit_desired** | **String** | Desired unit. | [optional] |
55
+ | **unit_id** | **Integer** | Id of the unit associated with the prospect. | [optional] |
54
56
  | **unit_type_desired** | **String** | Desired unit type. | [optional] |
55
57
  | **zip_desired** | **String** | Desired zip code. | [optional] |
56
58
 
@@ -65,6 +67,7 @@ instance = Propertyware::Prospect.new(
65
67
  building_id: null,
66
68
  city_desired: null,
67
69
  comments: null,
70
+ contacts: null,
68
71
  created_by: null,
69
72
  created_date_time: null,
70
73
  current_home_type: null,
@@ -107,6 +110,7 @@ instance = Propertyware::Prospect.new(
107
110
  type: null,
108
111
  type_of_inquiry: null,
109
112
  unit_desired: null,
113
+ unit_id: null,
110
114
  unit_type_desired: null,
111
115
  zip_desired: null
112
116
  )
@@ -0,0 +1,30 @@
1
+ # Propertyware::ProspectContact
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | E-mail address. | [optional] |
8
+ | **first_name** | **String** | First name. | [optional] |
9
+ | **home_phone** | **String** | Home phone. | [optional] |
10
+ | **id** | **Integer** | Unique identifier. | [optional] |
11
+ | **last_name** | **String** | Last name. | [optional] |
12
+ | **mobile_phone** | **String** | Mobile phone. | [optional] |
13
+ | **work_phone** | **String** | Work phone. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'propertyware'
19
+
20
+ instance = Propertyware::ProspectContact.new(
21
+ email: null,
22
+ first_name: null,
23
+ home_phone: null,
24
+ id: null,
25
+ last_name: null,
26
+ mobile_phone: null,
27
+ work_phone: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # Propertyware::ProspectStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | Unique identifier. | [optional] |
8
+ | **readonly** | **Boolean** | Read Only | [optional] |
9
+ | **status** | **String** | Status | [optional] |
10
+ | **visible_on_portal** | **Boolean** | Status visible On Portal | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'propertyware'
16
+
17
+ instance = Propertyware::ProspectStatus.new(
18
+ id: null,
19
+ readonly: false,
20
+ status: null,
21
+ visible_on_portal: false
22
+ )
23
+ ```
24
+
data/docs/ProspectsApi.md CHANGED
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
12
12
  | [**get_prospect_campaign**](ProspectsApi.md#get_prospect_campaign) | **GET** /prospects/{prospectID}/campaign | Retrieve prospect campaign |
13
13
  | [**get_prospect_conversation**](ProspectsApi.md#get_prospect_conversation) | **GET** /prospects/{prospectID}/conversations/{conversationID} | Retrieve a prospect conversation |
14
14
  | [**get_prospect_conversations**](ProspectsApi.md#get_prospect_conversations) | **GET** /prospects/{prospectID}/conversations | Retrieve all prospect conversations |
15
+ | [**get_prospect_statuses**](ProspectsApi.md#get_prospect_statuses) | **GET** /prospects/statuses | Retrieve all prospect statuses (BETA) |
15
16
  | [**get_prospects**](ProspectsApi.md#get_prospects) | **GET** /prospects | Retrieve all prospects |
16
17
 
17
18
 
@@ -687,6 +688,84 @@ end
687
688
  - **Accept**: application/json
688
689
 
689
690
 
691
+ ## get_prospect_statuses
692
+
693
+ > <Array<ProspectStatus>> get_prospect_statuses
694
+
695
+ Retrieve all prospect statuses (BETA)
696
+
697
+ <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 a list of all prospect statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>
698
+
699
+ ### Examples
700
+
701
+ ```ruby
702
+ require 'time'
703
+ require 'propertyware'
704
+ # setup authorization
705
+ Propertyware.configure do |config|
706
+ # Configure API key authorization: organizationId
707
+ config.api_key['organizationId'] = 'YOUR API KEY'
708
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
709
+ # config.api_key_prefix['organizationId'] = 'Bearer'
710
+
711
+ # Configure API key authorization: clientId
712
+ config.api_key['clientId'] = 'YOUR API KEY'
713
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
714
+ # config.api_key_prefix['clientId'] = 'Bearer'
715
+
716
+ # Configure API key authorization: clientSecret
717
+ config.api_key['clientSecret'] = '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['clientSecret'] = 'Bearer'
720
+ end
721
+
722
+ api_instance = Propertyware::ProspectsApi.new
723
+
724
+ begin
725
+ # Retrieve all prospect statuses (BETA)
726
+ result = api_instance.get_prospect_statuses
727
+ p result
728
+ rescue Propertyware::ApiError => e
729
+ puts "Error when calling ProspectsApi->get_prospect_statuses: #{e}"
730
+ end
731
+ ```
732
+
733
+ #### Using the get_prospect_statuses_with_http_info variant
734
+
735
+ This returns an Array which contains the response data, status code and headers.
736
+
737
+ > <Array(<Array<ProspectStatus>>, Integer, Hash)> get_prospect_statuses_with_http_info
738
+
739
+ ```ruby
740
+ begin
741
+ # Retrieve all prospect statuses (BETA)
742
+ data, status_code, headers = api_instance.get_prospect_statuses_with_http_info
743
+ p status_code # => 2xx
744
+ p headers # => { ... }
745
+ p data # => <Array<ProspectStatus>>
746
+ rescue Propertyware::ApiError => e
747
+ puts "Error when calling ProspectsApi->get_prospect_statuses_with_http_info: #{e}"
748
+ end
749
+ ```
750
+
751
+ ### Parameters
752
+
753
+ This endpoint does not need any parameter.
754
+
755
+ ### Return type
756
+
757
+ [**Array&lt;ProspectStatus&gt;**](ProspectStatus.md)
758
+
759
+ ### Authorization
760
+
761
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
762
+
763
+ ### HTTP request headers
764
+
765
+ - **Content-Type**: Not defined
766
+ - **Accept**: application/json
767
+
768
+
690
769
  ## get_prospects
691
770
 
692
771
  > <Array<Prospect>> get_prospects(opts)
data/docs/Refund.md CHANGED
@@ -8,16 +8,16 @@
8
8
  | **created_by** | **String** | User who created the record. | [optional] |
9
9
  | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
10
10
  | **date** | **Date** | Post date. | |
11
- | **destination_account_id** | **Integer** | Id of the bank account to send the refund to. | |
12
- | **gl_account_id** | **Integer** | Id of the general ledger associated with the refund. | |
11
+ | **destination_account_id** | **Integer** | Id of the bank account to send the refund from. | [optional] |
12
+ | **gl_account_id** | **Integer** | Id of the general ledger account associated with the refund. | [optional] |
13
13
  | **id** | **Integer** | Unique identifier. | [optional] |
14
14
  | **last_modified_by** | **String** | User who last modified the record. | [optional] |
15
15
  | **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
16
- | **lease_id** | **Integer** | Id of the lease associated with the refund. | |
17
- | **payee_payer** | **String** | Name of the payee. | |
16
+ | **lease_id** | **Integer** | Id of the lease associated with the refund. | [optional] |
17
+ | **payee_payer** | **String** | Name of the payee. | [optional] |
18
18
  | **portfolio_id** | **Integer** | Id of the portfolio associated with the refund. | [optional] |
19
19
  | **ref_no** | **String** | Reference number. | [optional] |
20
- | **to_be_printed** | **Boolean** | Indicates if the check is to be printed. | |
20
+ | **to_be_printed** | **Boolean** | Indicates if the check is to be printed. | [optional] |
21
21
 
22
22
  ## Example
23
23
 
@@ -7,8 +7,8 @@
7
7
  | **amount** | **Float** | Amount, should be negative. | |
8
8
  | **comments** | **String** | Comments. | [optional] |
9
9
  | **date** | **Date** | Lease Adjustment date. | [optional] |
10
- | **lease_id** | **Integer** | Lease id. | |
11
- | **ref_no** | **String** | Ref No. | [optional] |
10
+ | **lease_id** | **Integer** | Id of the lease associated with the Adjustment. | |
11
+ | **ref_no** | **String** | Reference number. | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **bank_gl_account_id** | **Integer** | Bank Account Number. | |
7
+ | **bank_gl_account_id** | **Integer** | Bank general ledger account ID. | |
8
8
  | **list_of_tx_ids** | **String** | Comma separated list of Transaction IDs. | |
9
9
 
10
10
  ## Example
data/docs/SaveContact.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **allow_e_signature** | **Boolean** | Indicate if the contact can receive eSignature request e-mail messages sent through Propertyware. | [optional] |
9
9
  | **alt_email** | **String** | Alternate Email Address. | [optional] |
10
10
  | **birth_date** | **Date** | Date of Birth. | [optional] |
11
+ | **category** | **String** | Indicate contact category. Send empty \&quot;\&quot; value if contact is Uncategorized | [optional] |
11
12
  | **comments** | **String** | Description. | [optional] |
12
13
  | **company** | **String** | Company where the contact is employed. | [optional] |
13
14
  | **email** | **String** | E-mail Address. | [optional] |
@@ -17,7 +18,7 @@
17
18
  | **home_phone** | **String** | Home Phone. | [optional] |
18
19
  | **job_title** | **String** | Professional title or position for the contact. | [optional] |
19
20
  | **last_name** | **String** | Last Name. | |
20
- | **middle_name** | **String** | First Name. | [optional] |
21
+ | **middle_name** | **String** | Middle Name. | [optional] |
21
22
  | **mobile_phone** | **String** | Mobile Phone. | [optional] |
22
23
  | **name_on_check** | **String** | Name On Check. | [optional] |
23
24
  | **named_on_lease** | **Boolean** | Is Named On Lease. | [optional] |
@@ -37,6 +38,7 @@ instance = Propertyware::SaveContact.new(
37
38
  allow_e_signature: false,
38
39
  alt_email: null,
39
40
  birth_date: null,
41
+ category: null,
40
42
  comments: null,
41
43
  company: null,
42
44
  email: null,
data/docs/SaveDiscount.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **comments** | **String** | Comments. | [optional] |
9
9
  | **date** | **Date** | Date. | |
10
10
  | **discount_account_id** | **Integer** | Discount GL Account ID. | |
11
- | **lease_id** | **Integer** | Lease id. | |
11
+ | **lease_id** | **Integer** | Id of the lease associated with this discount. | |
12
12
  | **ref_no** | **String** | Ref No. | [optional] |
13
13
 
14
14
  ## Example
data/docs/SaveLease.md CHANGED
@@ -4,23 +4,28 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **base_rent** | **Float** | Property base rent. | [optional] |
7
8
  | **comments** | **String** | Comments. | [optional] |
8
- | **end_date** | **Date** | End Date. | |
9
+ | **end_date** | **Date** | End date of the lease term. | |
9
10
  | **leasing_fee_amount** | **Float** | Move in leasing fee amount. | [optional] |
10
11
  | **leasing_fee_date** | **Date** | Move in leasing fee post date. | [optional] |
11
12
  | **leasing_fee_ref_no** | **String** | Move in leasing fee reference number. | [optional] |
12
13
  | **move_in_date** | **Date** | Move In Date. | |
13
14
  | **move_out_date** | **Date** | Move Out Date. | [optional] |
14
15
  | **post_first_charge** | **Boolean** | Indicates how to post first rent charge while move in. | [optional] |
15
- | **primary_contact_id** | **Integer** | Primary contact ID, Should be one of Tenant IDs. | |
16
+ | **primary_contact_id** | **Integer** | Primary contact ID, Should be one of tenant IDs. | |
16
17
  | **prorate_month** | **String** | Indicates how to post first rent charge while move in. | [optional] |
18
+ | **public_assistance_program** | **String** | Public assistance program. Allowed values are &#39;None&#39;, &#39;Section 8&#39;, &#39;SCRIE&#39;, &#39;Rent Control&#39;, &#39;EDEN INC. - Shelter Care Plus&#39;, &#39;CLC&#39;, &#39;DHAP&#39;, &#39;FEMA&#39;, &#39;Harris County&#39; etc. | [optional] |
17
19
  | **rent_auto_charge** | [**SaveAutoCharge**](SaveAutoCharge.md) | | [optional] |
20
+ | **schedule_move_out_date** | **Date** | Scheduled move out date. | [optional] |
21
+ | **search_tag** | **String** | Search tag. | [optional] |
18
22
  | **sec_dep_amount** | **Float** | Move in security deposit amount. | [optional] |
19
23
  | **sec_dep_charge_date** | **Date** | Move in security deposit charge date. | [optional] |
20
- | **start_date** | **Date** | Start Date. | |
21
- | **status** | **String** | Lease Status. | [optional] |
22
- | **tenant_ids** | **Array&lt;Integer&gt;** | Tenant IDs. | |
23
- | **unit_id** | **Integer** | Unit/Building ID. | |
24
+ | **signed_date** | **Date** | Lease signed date. | [optional] |
25
+ | **start_date** | **Date** | Start date of the lease term. | |
26
+ | **status** | **String** | Indicates lease status. Allowed values are &#39;Active&#39;, &#39;Active - Notice Given&#39;, &#39;Draft&#39;, &#39;Eviction&#39;, &#39;Terminated&#39; etc. | [optional] |
27
+ | **tenant_ids** | **Array&lt;Integer&gt;** | List of tenant IDs. | |
28
+ | **unit_id** | **Integer** | Unit/Building ID associated with this lease. | |
24
29
 
25
30
  ## Example
26
31
 
@@ -28,6 +33,7 @@
28
33
  require 'propertyware'
29
34
 
30
35
  instance = Propertyware::SaveLease.new(
36
+ base_rent: null,
31
37
  comments: null,
32
38
  end_date: null,
33
39
  leasing_fee_amount: null,
@@ -38,9 +44,13 @@ instance = Propertyware::SaveLease.new(
38
44
  post_first_charge: false,
39
45
  primary_contact_id: null,
40
46
  prorate_month: null,
47
+ public_assistance_program: null,
41
48
  rent_auto_charge: null,
49
+ schedule_move_out_date: null,
50
+ search_tag: null,
42
51
  sec_dep_amount: null,
43
52
  sec_dep_charge_date: null,
53
+ signed_date: null,
44
54
  start_date: null,
45
55
  status: null,
46
56
  tenant_ids: null,