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
@@ -0,0 +1,701 @@
1
+ =begin
2
+ #Open API, powered by Propertyware
3
+
4
+ #<script type=\"text/javascript\" src=\"https://buildium.atlassian.net/s/d41d8cd98f00b204e9800998ecf8427e-T/-raa8on/b/8/c95134bc67d3a521bb3f4331beb9b804/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?locale=en-US&collectorId=e43cd15d\"></script> # Introduction Welcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data. ## Account Configuration Before you can use Propertyware’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Administration Setup > API Keys*** to set things up properly. **Let's Begin!** 1. Sign in to your [Propertyware](https://app.propertyware.com/pw/login.jsp) account from your browser. 2. Open the ***Setup*** page 3. On the left navigation bar, expand ***Administration Setup*** and then click ***API Keys***. If you are having issues accessing the API keys page within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Propertyware API key and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open API is enabled, you’ll be able to create API keys. You’re almost there! **How to create an API key** 1. On the API Keys page, click ***Create API Key***. A modal will appear. <p> <img src=\"APIKey_Page.JPG\"/> </p> <p> <img src=\"APIKey_New.JPG\"/> </p> 2. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. 3. Now, choose which pieces of Propertyware data you want this API key to have access to by selecting the corresponding radio buttons. Once finished, click **GENERATE KEY**. 4. You have successfully created an API key! The client id and secret associated to this key will be presented. <p> <img src=\"APIKey_Generate.JPG\"/> </p> > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. You have now successfully created an API key and have everything you need to send requests to the Propertyware API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping API Keys Safe](#section/Getting-Started/Keeping-API-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Propertyware data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Propertyware entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Propertyware account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Propertyware account. Your API key is how the Propertyware API authenticates requests and ensures only you can access your data. #### Step 2: Install a HTTP client The Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Propertyware API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Buildings](#operation/getBuildingsUsingGET) in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below. 1. Open the Postman application. 2. Open the *verb* menu and select **GET**. 3. Enter the request endpoint in the field next to GET. - Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings. 4. To authenticate the request, enter your `client ID`, your `secret` and your `organization iD` respectively in these request headers: - `x-propertyware-client-id` - `x-propertyware-client-secret` - `x-propertyware-system-id` _(organization id)_ The organization id uniquely identifies your Propertyware account and is an additional measure to enforce proper access to the correct data. ___Your client id and secret pair will only work with the organization it belongs to___. Your full request should look similar to the image below. <kbd><img src=\"request_example.png\" /></kbd> 5. Review the parameters of your request on last time. Once finished, click **Send**. 6. If successful, you should see a JSON response and a `200` HTTP status code. Congratulations! You've connected to the Propertyware API. You now have the knowledge required to make requests for any of our resources. If you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the [Response Codes](#section/API-Overview/Response-Codes) section. If you are still having trouble making a request after reviewing these sections please submit a [Support](#section/API-Overview/Support) request. # API Overview The Propertyware API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs. ## Base URL The base URL for production environment API requests is: `https://api.propertyware.com/pw/api/v1/rest` In order to ensure all requests and responses are secure between the API consumer and Propertyware servers, requests must be made using the `https` protocol. Any requests not made with the `https` protocol will be refused by the Propertyware API platform. > **Note:** URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a `404` response code reminding you of this constraint. ## API Versioning The Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations. Propertyware uses only a major version nomenclature to manage changes. The current version of the Propertyware API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all leases resource: `https://api.propertyware.com/pw/api/rest/v1/leases` Any request submitted without the version in the URL path will result in a `404` error response code. ### Releasing Changes to the API The Propertyware API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible. We’ll provide advance notice for all API releases–regardless of the type of modifications being made. #### Backward-compatible Changes Backward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these. It's important as you develop against the Propertyware API that you ensure these types of changes don't impact your integration. Here's are examples of backward-compatible modifications. * Adding new API resources and/or endpoints. * Adding new optional request parameters to existing API methods. * Adding new properties to existing API responses and non-required properties for request messages. * Changing property order in existing API responses. All backward-compatible changes to the API will be documented in the [Changelog](#section/Changelog). #### Backwards-incompatible Changes When backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path to consume resources under the new API version. Backwards-incompatible changes include: * Removing a property from a request and/or response message. * Changing the name of a property in a message. * Adding a required parameter to a request message. * Changing existing enumeration values. New versions of the API will have full reference documentation and an upgrade guide. ## Authentication The Propertyware API uses API key’s client IDs and secrets to authenticate requests. An organization ID, an API key client ID and secret must be passed in every request header using the following parameters: - `x-propertyware-client-id` - `x-propertyware-client-secret` - `x-propertyware-system-id` Failing to provide both of them in the request header will cause the API to return a `401` HTTP status code. <!-- ## Rate Limiting (FUTURE) Rate limits help us ensure consistent and reliable performance for all users, even during peak loads. That’s why we limit clients to **10 concurrent requests per second**. If your request rate violates that limit, a response code of `429` is returned. Simply retry the request after a short interval (~200ms). --> ## Bulk Request Options All top-level API resources support bulk fetches. For instance, you can retrieve all [Portfolios](#operation/getPortfoliosUsingGET). These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available. In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order. ### Pagination Endpoints that return result sets allow for pagination using `limit` and `offset` request parameters to reduce the amount of data returned. The `limit` request parameter will cap the number of results that come back in the response. If you don't specify a `limit` value, a **default of 100 results** are returned. The maximum `limit` value is 500. If a `limit` value is specified greater than 500, it will be overridden to the default to 500. The `offset` request parameter indicates the record position within the resultset to start at when returning the results. The `offset` is zero-based and is inclusive. If no `offset` value is submitted it will default to 0. The total resultset count is returned in the HTTP Header `X-Total-Count` #### Pagination Example As an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the `X-Total-Count` header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the `offset` set to 100 and the `limit` set to 50. > **Note:** The `limit` and `offset` parameter names are case-sensitive. If they aren't formatted correctly, the API will return a `404` HTTP status code. ### Sorting Results You can specify the sort order of returned data by assigning properties from the returned object to the `orderby` parameter in the querystring. For example: ``` orderby=name ``` By default, the sort is performed in ascending order. To specify sort order, use \"asc\" for ascending or \"desc\" for descending. For example: ``` orderby=name desc ``` Additionally, you can sort by multiple properties by comma separating the properties. For example: ``` orderby=abbreviation asc,name desc ``` > **Note:** While the `orderby` parameter is case-sensitive, the properties specified in the `orderby` value aren't. ## Response Codes The Propertyware API supports standard HTTP status codes. |Response Code |Description | |--|--| |200 OK | Everything worked as expected. | |400 Bad Request | The request was unacceptable, often due to missing a required parameter.| |401 Unauthorized|The API client ID and secret weren’t provided or they’re no longer valid. Be sure that the client ID and secret combination are correct and they are still active.| |403 Forbidden|The API key doesn't have permission to perform the request. This could be due to authorization for the given endpoint or an inability to access given entities within the platform (e.g. properties). |404 Not Found|The requested resource doesn't exist.| |415 Unsupported Media Type |Ensure you have the appropriate content-type header value set on your request. Each resource is documented with media type(s) that are accepted.| |429 Too Many Requests |Too many requests against the API too quickly. We recommend an exponential backoff of your requests.| |500 and above - Server Errors|Something went wrong on Propertyware's end. Review the JSON response message for more details about the error.| ## API Date Format * For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24). * For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z). ## Support If you are unable to resolve your issue after reviewing the API documentation our support team can assist you. # Changelog ### 2023-07-11 * Retrieve all documents * Retrieve a document * Download a document ### 2023-06-10 * Lease contacts are included in Retrieve all leases API response * Lease contacts are included in Retrieve a lease API response ### 2023-04-24 * Bulk Insertion: Prospects * Bulk Insertion: Bill Payments ### 2023-04-11 * Bulk Insertion: Portfolios * Bulk Insertion: Buildings * Bulk Insertion: Units ### 2023-03-19 * Bulk insertion: contacts ### 2023-03-08 * Bulk insertion: bills ### 2023-01-24 * Custom fields in \"Get all\" endpoints * Prospect creation * Bill removals ### 2022-10-25 * API Read operations for non-financial data ### 2022-09-21 * API Read operations available
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: support@propertyware.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.6.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Propertyware
17
+ # Prospect
18
+ class Prospect
19
+ # Indicates if the application fee has been paid by the prospect.
20
+ attr_accessor :application_fee_paid
21
+
22
+ # Name of the assigned prospect.
23
+ attr_accessor :assigne_full_name
24
+
25
+ # Id of the building associated with the prospect.
26
+ attr_accessor :building_id
27
+
28
+ # Desired city.
29
+ attr_accessor :city_desired
30
+
31
+ # Indicates if the prospect has any comments.
32
+ attr_accessor :comments
33
+
34
+ # User who created the record.
35
+ attr_accessor :created_by
36
+
37
+ # Date and time the record was created. (Timezone: UTC)
38
+ attr_accessor :created_date_time
39
+
40
+ # Current home type.
41
+ attr_accessor :current_home_type
42
+
43
+ # Current home mortgage.
44
+ attr_accessor :current_rent_mortgage
45
+
46
+ # Custom fields.
47
+ attr_accessor :custom_fields
48
+
49
+ # Indicates if the prospect has pets.
50
+ attr_accessor :has_pets
51
+
52
+ # Unique identifier.
53
+ attr_accessor :id
54
+
55
+ # User who last modified the record.
56
+ attr_accessor :last_modified_by
57
+
58
+ # Date and time the record was last modified. (Timezone: UTC)
59
+ attr_accessor :last_modified_date_time
60
+
61
+ # Confirmed lease end date.
62
+ attr_accessor :lease_end_date
63
+
64
+ # Confirmed lease start date.
65
+ attr_accessor :lease_start_date
66
+
67
+ # Desired move-in date.
68
+ attr_accessor :move_in_date
69
+
70
+ # Desired neighborhood.
71
+ attr_accessor :neighborhood_desired
72
+
73
+ # Number of bathrooms desired by the prospect.
74
+ attr_accessor :number_bathrooms
75
+
76
+ # Number of bedrooms desired by the prospect.
77
+ attr_accessor :number_bedrooms
78
+
79
+ # Number of pets.
80
+ attr_accessor :number_of_pets
81
+
82
+ # Pet type.
83
+ attr_accessor :pet_type
84
+
85
+ # Pet weights.
86
+ attr_accessor :pet_weights
87
+
88
+ # Id of the portfolio associated with the prospect.
89
+ attr_accessor :portfolio_id
90
+
91
+ # Preferred contact method.
92
+ attr_accessor :preferred_contact_method
93
+
94
+ # Address of the property.
95
+ attr_accessor :property_address
96
+
97
+ # Additional address information of the property.
98
+ attr_accessor :property_address2
99
+
100
+ # Area of the property.
101
+ attr_accessor :property_area
102
+
103
+ # Unit of measurement for the area of the property.
104
+ attr_accessor :property_area_units
105
+
106
+ # City of the property.
107
+ attr_accessor :property_city
108
+
109
+ # Country of the property.
110
+ attr_accessor :property_country
111
+
112
+ # Number of bathrooms.
113
+ attr_accessor :property_number_bathrooms
114
+
115
+ # Number of bedrooms.
116
+ attr_accessor :property_number_bedrooms
117
+
118
+ # State of the property.
119
+ attr_accessor :property_state
120
+
121
+ # Zip code of the property.
122
+ attr_accessor :property_zip
123
+
124
+ # Reason for moving.
125
+ attr_accessor :reason_for_moving
126
+
127
+ # Confirmed lease rent.
128
+ attr_accessor :rent
129
+
130
+ # Maximum desired rent.
131
+ attr_accessor :rent_max
132
+
133
+ # Minimum desired rent.
134
+ attr_accessor :rent_min
135
+
136
+ # Confirmed lease security deposit.
137
+ attr_accessor :security_deposit
138
+
139
+ # Prospect source.
140
+ attr_accessor :source
141
+
142
+ # Desired state.
143
+ attr_accessor :state_desired
144
+
145
+ # Status.
146
+ attr_accessor :status
147
+
148
+ # Time the prospect is living at the current residence.
149
+ attr_accessor :time_at_current_residence
150
+
151
+ # Prospect type.
152
+ attr_accessor :type
153
+
154
+ # Type of inquiry made by the prospect.
155
+ attr_accessor :type_of_inquiry
156
+
157
+ # Desired unit.
158
+ attr_accessor :unit_desired
159
+
160
+ # Desired unit type.
161
+ attr_accessor :unit_type_desired
162
+
163
+ # Desired zip code.
164
+ attr_accessor :zip_desired
165
+
166
+ # Attribute mapping from ruby-style variable name to JSON key.
167
+ def self.attribute_map
168
+ {
169
+ :'application_fee_paid' => :'applicationFeePaid',
170
+ :'assigne_full_name' => :'assigneFullName',
171
+ :'building_id' => :'buildingID',
172
+ :'city_desired' => :'cityDesired',
173
+ :'comments' => :'comments',
174
+ :'created_by' => :'createdBy',
175
+ :'created_date_time' => :'createdDateTime',
176
+ :'current_home_type' => :'currentHomeType',
177
+ :'current_rent_mortgage' => :'currentRentMortgage',
178
+ :'custom_fields' => :'customFields',
179
+ :'has_pets' => :'hasPets',
180
+ :'id' => :'id',
181
+ :'last_modified_by' => :'lastModifiedBy',
182
+ :'last_modified_date_time' => :'lastModifiedDateTime',
183
+ :'lease_end_date' => :'leaseEndDate',
184
+ :'lease_start_date' => :'leaseStartDate',
185
+ :'move_in_date' => :'moveInDate',
186
+ :'neighborhood_desired' => :'neighborhoodDesired',
187
+ :'number_bathrooms' => :'numberBathrooms',
188
+ :'number_bedrooms' => :'numberBedrooms',
189
+ :'number_of_pets' => :'numberOfPets',
190
+ :'pet_type' => :'petType',
191
+ :'pet_weights' => :'petWeights',
192
+ :'portfolio_id' => :'portfolioID',
193
+ :'preferred_contact_method' => :'preferredContactMethod',
194
+ :'property_address' => :'propertyAddress',
195
+ :'property_address2' => :'propertyAddress2',
196
+ :'property_area' => :'propertyArea',
197
+ :'property_area_units' => :'propertyAreaUnits',
198
+ :'property_city' => :'propertyCity',
199
+ :'property_country' => :'propertyCountry',
200
+ :'property_number_bathrooms' => :'propertyNumberBathrooms',
201
+ :'property_number_bedrooms' => :'propertyNumberBedrooms',
202
+ :'property_state' => :'propertyState',
203
+ :'property_zip' => :'propertyZip',
204
+ :'reason_for_moving' => :'reasonForMoving',
205
+ :'rent' => :'rent',
206
+ :'rent_max' => :'rentMax',
207
+ :'rent_min' => :'rentMin',
208
+ :'security_deposit' => :'securityDeposit',
209
+ :'source' => :'source',
210
+ :'state_desired' => :'stateDesired',
211
+ :'status' => :'status',
212
+ :'time_at_current_residence' => :'timeAtCurrentResidence',
213
+ :'type' => :'type',
214
+ :'type_of_inquiry' => :'typeOfInquiry',
215
+ :'unit_desired' => :'unitDesired',
216
+ :'unit_type_desired' => :'unitTypeDesired',
217
+ :'zip_desired' => :'zipDesired'
218
+ }
219
+ end
220
+
221
+ # Returns all the JSON keys this model knows about
222
+ def self.acceptable_attributes
223
+ attribute_map.values
224
+ end
225
+
226
+ # Attribute type mapping.
227
+ def self.openapi_types
228
+ {
229
+ :'application_fee_paid' => :'Boolean',
230
+ :'assigne_full_name' => :'String',
231
+ :'building_id' => :'Integer',
232
+ :'city_desired' => :'String',
233
+ :'comments' => :'String',
234
+ :'created_by' => :'String',
235
+ :'created_date_time' => :'Time',
236
+ :'current_home_type' => :'String',
237
+ :'current_rent_mortgage' => :'Float',
238
+ :'custom_fields' => :'Array<CustomField>',
239
+ :'has_pets' => :'Boolean',
240
+ :'id' => :'Integer',
241
+ :'last_modified_by' => :'String',
242
+ :'last_modified_date_time' => :'Time',
243
+ :'lease_end_date' => :'Date',
244
+ :'lease_start_date' => :'Date',
245
+ :'move_in_date' => :'Date',
246
+ :'neighborhood_desired' => :'String',
247
+ :'number_bathrooms' => :'Float',
248
+ :'number_bedrooms' => :'Integer',
249
+ :'number_of_pets' => :'Integer',
250
+ :'pet_type' => :'String',
251
+ :'pet_weights' => :'String',
252
+ :'portfolio_id' => :'Integer',
253
+ :'preferred_contact_method' => :'String',
254
+ :'property_address' => :'String',
255
+ :'property_address2' => :'String',
256
+ :'property_area' => :'Float',
257
+ :'property_area_units' => :'String',
258
+ :'property_city' => :'String',
259
+ :'property_country' => :'String',
260
+ :'property_number_bathrooms' => :'Float',
261
+ :'property_number_bedrooms' => :'Integer',
262
+ :'property_state' => :'String',
263
+ :'property_zip' => :'String',
264
+ :'reason_for_moving' => :'String',
265
+ :'rent' => :'Float',
266
+ :'rent_max' => :'Float',
267
+ :'rent_min' => :'Float',
268
+ :'security_deposit' => :'Float',
269
+ :'source' => :'String',
270
+ :'state_desired' => :'String',
271
+ :'status' => :'String',
272
+ :'time_at_current_residence' => :'String',
273
+ :'type' => :'String',
274
+ :'type_of_inquiry' => :'String',
275
+ :'unit_desired' => :'String',
276
+ :'unit_type_desired' => :'String',
277
+ :'zip_desired' => :'String'
278
+ }
279
+ end
280
+
281
+ # List of attributes with nullable: true
282
+ def self.openapi_nullable
283
+ Set.new([
284
+ ])
285
+ end
286
+
287
+ # Initializes the object
288
+ # @param [Hash] attributes Model attributes in the form of hash
289
+ def initialize(attributes = {})
290
+ if (!attributes.is_a?(Hash))
291
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Propertyware::Prospect` initialize method"
292
+ end
293
+
294
+ # check to see if the attribute exists and convert string to symbol for hash key
295
+ attributes = attributes.each_with_object({}) { |(k, v), h|
296
+ if (!self.class.attribute_map.key?(k.to_sym))
297
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Propertyware::Prospect`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
298
+ end
299
+ h[k.to_sym] = v
300
+ }
301
+
302
+ if attributes.key?(:'application_fee_paid')
303
+ self.application_fee_paid = attributes[:'application_fee_paid']
304
+ end
305
+
306
+ if attributes.key?(:'assigne_full_name')
307
+ self.assigne_full_name = attributes[:'assigne_full_name']
308
+ end
309
+
310
+ if attributes.key?(:'building_id')
311
+ self.building_id = attributes[:'building_id']
312
+ end
313
+
314
+ if attributes.key?(:'city_desired')
315
+ self.city_desired = attributes[:'city_desired']
316
+ end
317
+
318
+ if attributes.key?(:'comments')
319
+ self.comments = attributes[:'comments']
320
+ end
321
+
322
+ if attributes.key?(:'created_by')
323
+ self.created_by = attributes[:'created_by']
324
+ end
325
+
326
+ if attributes.key?(:'created_date_time')
327
+ self.created_date_time = attributes[:'created_date_time']
328
+ end
329
+
330
+ if attributes.key?(:'current_home_type')
331
+ self.current_home_type = attributes[:'current_home_type']
332
+ end
333
+
334
+ if attributes.key?(:'current_rent_mortgage')
335
+ self.current_rent_mortgage = attributes[:'current_rent_mortgage']
336
+ end
337
+
338
+ if attributes.key?(:'custom_fields')
339
+ if (value = attributes[:'custom_fields']).is_a?(Array)
340
+ self.custom_fields = value
341
+ end
342
+ end
343
+
344
+ if attributes.key?(:'has_pets')
345
+ self.has_pets = attributes[:'has_pets']
346
+ end
347
+
348
+ if attributes.key?(:'id')
349
+ self.id = attributes[:'id']
350
+ end
351
+
352
+ if attributes.key?(:'last_modified_by')
353
+ self.last_modified_by = attributes[:'last_modified_by']
354
+ end
355
+
356
+ if attributes.key?(:'last_modified_date_time')
357
+ self.last_modified_date_time = attributes[:'last_modified_date_time']
358
+ end
359
+
360
+ if attributes.key?(:'lease_end_date')
361
+ self.lease_end_date = attributes[:'lease_end_date']
362
+ end
363
+
364
+ if attributes.key?(:'lease_start_date')
365
+ self.lease_start_date = attributes[:'lease_start_date']
366
+ end
367
+
368
+ if attributes.key?(:'move_in_date')
369
+ self.move_in_date = attributes[:'move_in_date']
370
+ end
371
+
372
+ if attributes.key?(:'neighborhood_desired')
373
+ self.neighborhood_desired = attributes[:'neighborhood_desired']
374
+ end
375
+
376
+ if attributes.key?(:'number_bathrooms')
377
+ self.number_bathrooms = attributes[:'number_bathrooms']
378
+ end
379
+
380
+ if attributes.key?(:'number_bedrooms')
381
+ self.number_bedrooms = attributes[:'number_bedrooms']
382
+ end
383
+
384
+ if attributes.key?(:'number_of_pets')
385
+ self.number_of_pets = attributes[:'number_of_pets']
386
+ end
387
+
388
+ if attributes.key?(:'pet_type')
389
+ self.pet_type = attributes[:'pet_type']
390
+ end
391
+
392
+ if attributes.key?(:'pet_weights')
393
+ self.pet_weights = attributes[:'pet_weights']
394
+ end
395
+
396
+ if attributes.key?(:'portfolio_id')
397
+ self.portfolio_id = attributes[:'portfolio_id']
398
+ end
399
+
400
+ if attributes.key?(:'preferred_contact_method')
401
+ self.preferred_contact_method = attributes[:'preferred_contact_method']
402
+ end
403
+
404
+ if attributes.key?(:'property_address')
405
+ self.property_address = attributes[:'property_address']
406
+ end
407
+
408
+ if attributes.key?(:'property_address2')
409
+ self.property_address2 = attributes[:'property_address2']
410
+ end
411
+
412
+ if attributes.key?(:'property_area')
413
+ self.property_area = attributes[:'property_area']
414
+ end
415
+
416
+ if attributes.key?(:'property_area_units')
417
+ self.property_area_units = attributes[:'property_area_units']
418
+ end
419
+
420
+ if attributes.key?(:'property_city')
421
+ self.property_city = attributes[:'property_city']
422
+ end
423
+
424
+ if attributes.key?(:'property_country')
425
+ self.property_country = attributes[:'property_country']
426
+ end
427
+
428
+ if attributes.key?(:'property_number_bathrooms')
429
+ self.property_number_bathrooms = attributes[:'property_number_bathrooms']
430
+ end
431
+
432
+ if attributes.key?(:'property_number_bedrooms')
433
+ self.property_number_bedrooms = attributes[:'property_number_bedrooms']
434
+ end
435
+
436
+ if attributes.key?(:'property_state')
437
+ self.property_state = attributes[:'property_state']
438
+ end
439
+
440
+ if attributes.key?(:'property_zip')
441
+ self.property_zip = attributes[:'property_zip']
442
+ end
443
+
444
+ if attributes.key?(:'reason_for_moving')
445
+ self.reason_for_moving = attributes[:'reason_for_moving']
446
+ end
447
+
448
+ if attributes.key?(:'rent')
449
+ self.rent = attributes[:'rent']
450
+ end
451
+
452
+ if attributes.key?(:'rent_max')
453
+ self.rent_max = attributes[:'rent_max']
454
+ end
455
+
456
+ if attributes.key?(:'rent_min')
457
+ self.rent_min = attributes[:'rent_min']
458
+ end
459
+
460
+ if attributes.key?(:'security_deposit')
461
+ self.security_deposit = attributes[:'security_deposit']
462
+ end
463
+
464
+ if attributes.key?(:'source')
465
+ self.source = attributes[:'source']
466
+ end
467
+
468
+ if attributes.key?(:'state_desired')
469
+ self.state_desired = attributes[:'state_desired']
470
+ end
471
+
472
+ if attributes.key?(:'status')
473
+ self.status = attributes[:'status']
474
+ end
475
+
476
+ if attributes.key?(:'time_at_current_residence')
477
+ self.time_at_current_residence = attributes[:'time_at_current_residence']
478
+ end
479
+
480
+ if attributes.key?(:'type')
481
+ self.type = attributes[:'type']
482
+ end
483
+
484
+ if attributes.key?(:'type_of_inquiry')
485
+ self.type_of_inquiry = attributes[:'type_of_inquiry']
486
+ end
487
+
488
+ if attributes.key?(:'unit_desired')
489
+ self.unit_desired = attributes[:'unit_desired']
490
+ end
491
+
492
+ if attributes.key?(:'unit_type_desired')
493
+ self.unit_type_desired = attributes[:'unit_type_desired']
494
+ end
495
+
496
+ if attributes.key?(:'zip_desired')
497
+ self.zip_desired = attributes[:'zip_desired']
498
+ end
499
+ end
500
+
501
+ # Show invalid properties with the reasons. Usually used together with valid?
502
+ # @return Array for valid properties with the reasons
503
+ def list_invalid_properties
504
+ invalid_properties = Array.new
505
+ invalid_properties
506
+ end
507
+
508
+ # Check to see if the all the properties in the model are valid
509
+ # @return true if the model is valid
510
+ def valid?
511
+ true
512
+ end
513
+
514
+ # Checks equality by comparing each attribute.
515
+ # @param [Object] Object to be compared
516
+ def ==(o)
517
+ return true if self.equal?(o)
518
+ self.class == o.class &&
519
+ application_fee_paid == o.application_fee_paid &&
520
+ assigne_full_name == o.assigne_full_name &&
521
+ building_id == o.building_id &&
522
+ city_desired == o.city_desired &&
523
+ comments == o.comments &&
524
+ created_by == o.created_by &&
525
+ created_date_time == o.created_date_time &&
526
+ current_home_type == o.current_home_type &&
527
+ current_rent_mortgage == o.current_rent_mortgage &&
528
+ custom_fields == o.custom_fields &&
529
+ has_pets == o.has_pets &&
530
+ id == o.id &&
531
+ last_modified_by == o.last_modified_by &&
532
+ last_modified_date_time == o.last_modified_date_time &&
533
+ lease_end_date == o.lease_end_date &&
534
+ lease_start_date == o.lease_start_date &&
535
+ move_in_date == o.move_in_date &&
536
+ neighborhood_desired == o.neighborhood_desired &&
537
+ number_bathrooms == o.number_bathrooms &&
538
+ number_bedrooms == o.number_bedrooms &&
539
+ number_of_pets == o.number_of_pets &&
540
+ pet_type == o.pet_type &&
541
+ pet_weights == o.pet_weights &&
542
+ portfolio_id == o.portfolio_id &&
543
+ preferred_contact_method == o.preferred_contact_method &&
544
+ property_address == o.property_address &&
545
+ property_address2 == o.property_address2 &&
546
+ property_area == o.property_area &&
547
+ property_area_units == o.property_area_units &&
548
+ property_city == o.property_city &&
549
+ property_country == o.property_country &&
550
+ property_number_bathrooms == o.property_number_bathrooms &&
551
+ property_number_bedrooms == o.property_number_bedrooms &&
552
+ property_state == o.property_state &&
553
+ property_zip == o.property_zip &&
554
+ reason_for_moving == o.reason_for_moving &&
555
+ rent == o.rent &&
556
+ rent_max == o.rent_max &&
557
+ rent_min == o.rent_min &&
558
+ security_deposit == o.security_deposit &&
559
+ source == o.source &&
560
+ state_desired == o.state_desired &&
561
+ status == o.status &&
562
+ time_at_current_residence == o.time_at_current_residence &&
563
+ type == o.type &&
564
+ type_of_inquiry == o.type_of_inquiry &&
565
+ unit_desired == o.unit_desired &&
566
+ unit_type_desired == o.unit_type_desired &&
567
+ zip_desired == o.zip_desired
568
+ end
569
+
570
+ # @see the `==` method
571
+ # @param [Object] Object to be compared
572
+ def eql?(o)
573
+ self == o
574
+ end
575
+
576
+ # Calculates hash code according to all attributes.
577
+ # @return [Integer] Hash code
578
+ def hash
579
+ [application_fee_paid, assigne_full_name, building_id, city_desired, comments, created_by, created_date_time, current_home_type, current_rent_mortgage, custom_fields, has_pets, id, last_modified_by, last_modified_date_time, lease_end_date, lease_start_date, move_in_date, neighborhood_desired, number_bathrooms, number_bedrooms, number_of_pets, pet_type, pet_weights, portfolio_id, preferred_contact_method, property_address, property_address2, property_area, property_area_units, property_city, property_country, property_number_bathrooms, property_number_bedrooms, property_state, property_zip, reason_for_moving, rent, rent_max, rent_min, security_deposit, source, state_desired, status, time_at_current_residence, type, type_of_inquiry, unit_desired, unit_type_desired, zip_desired].hash
580
+ end
581
+
582
+ # Builds the object from hash
583
+ # @param [Hash] attributes Model attributes in the form of hash
584
+ # @return [Object] Returns the model itself
585
+ def self.build_from_hash(attributes)
586
+ new.build_from_hash(attributes)
587
+ end
588
+
589
+ # Builds the object from hash
590
+ # @param [Hash] attributes Model attributes in the form of hash
591
+ # @return [Object] Returns the model itself
592
+ def build_from_hash(attributes)
593
+ return unless attributes.is_a?(Hash)
594
+ attributes = attributes.transform_keys(&:to_sym)
595
+ self.class.openapi_types.each_pair do |key, type|
596
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
597
+ self.send("#{key}=", nil)
598
+ elsif type =~ /\AArray<(.*)>/i
599
+ # check to ensure the input is an array given that the attribute
600
+ # is documented as an array but the input is not
601
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
602
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
603
+ end
604
+ elsif !attributes[self.class.attribute_map[key]].nil?
605
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
606
+ end
607
+ end
608
+
609
+ self
610
+ end
611
+
612
+ # Deserializes the data based on type
613
+ # @param string type Data type
614
+ # @param string value Value to be deserialized
615
+ # @return [Object] Deserialized data
616
+ def _deserialize(type, value)
617
+ case type.to_sym
618
+ when :Time
619
+ Time.parse(value)
620
+ when :Date
621
+ Date.parse(value)
622
+ when :String
623
+ value.to_s
624
+ when :Integer
625
+ value.to_i
626
+ when :Float
627
+ value.to_f
628
+ when :Boolean
629
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
630
+ true
631
+ else
632
+ false
633
+ end
634
+ when :Object
635
+ # generic object (usually a Hash), return directly
636
+ value
637
+ when /\AArray<(?<inner_type>.+)>\z/
638
+ inner_type = Regexp.last_match[:inner_type]
639
+ value.map { |v| _deserialize(inner_type, v) }
640
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
641
+ k_type = Regexp.last_match[:k_type]
642
+ v_type = Regexp.last_match[:v_type]
643
+ {}.tap do |hash|
644
+ value.each do |k, v|
645
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
646
+ end
647
+ end
648
+ else # model
649
+ # models (e.g. Pet) or oneOf
650
+ klass = Propertyware.const_get(type)
651
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
652
+ end
653
+ end
654
+
655
+ # Returns the string representation of the object
656
+ # @return [String] String presentation of the object
657
+ def to_s
658
+ to_hash.to_s
659
+ end
660
+
661
+ # to_body is an alias to to_hash (backward compatibility)
662
+ # @return [Hash] Returns the object in the form of hash
663
+ def to_body
664
+ to_hash
665
+ end
666
+
667
+ # Returns the object in the form of hash
668
+ # @return [Hash] Returns the object in the form of hash
669
+ def to_hash
670
+ hash = {}
671
+ self.class.attribute_map.each_pair do |attr, param|
672
+ value = self.send(attr)
673
+ if value.nil?
674
+ is_nullable = self.class.openapi_nullable.include?(attr)
675
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
676
+ end
677
+
678
+ hash[param] = _to_hash(value)
679
+ end
680
+ hash
681
+ end
682
+
683
+ # Outputs non-array value in the form of hash
684
+ # For object, use to_hash. Otherwise, just return the value
685
+ # @param [Object] value Any valid value
686
+ # @return [Hash] Returns the value in the form of hash
687
+ def _to_hash(value)
688
+ if value.is_a?(Array)
689
+ value.compact.map { |v| _to_hash(v) }
690
+ elsif value.is_a?(Hash)
691
+ {}.tap do |hash|
692
+ value.each { |k, v| hash[k] = _to_hash(v) }
693
+ end
694
+ elsif value.respond_to? :to_hash
695
+ value.to_hash
696
+ else
697
+ value
698
+ end
699
+ end
700
+ end
701
+ end