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,763 @@
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 'cgi'
14
+
15
+ module Propertyware
16
+ class WorkOrdersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create a work order (BETA)
23
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a work order.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Write</code>
24
+ # @param save_work_order [SaveWorkOrder] saveWorkOrder
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [WorkOrder]
27
+ def create_work_order(save_work_order, opts = {})
28
+ data, _status_code, _headers = create_work_order_with_http_info(save_work_order, opts)
29
+ data
30
+ end
31
+
32
+ # Create a work order (BETA)
33
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a work order.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
34
+ # @param save_work_order [SaveWorkOrder] saveWorkOrder
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(WorkOrder, Integer, Hash)>] WorkOrder data, response status code and response headers
37
+ def create_work_order_with_http_info(save_work_order, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.create_work_order ...'
40
+ end
41
+ # verify the required parameter 'save_work_order' is set
42
+ if @api_client.config.client_side_validation && save_work_order.nil?
43
+ fail ArgumentError, "Missing the required parameter 'save_work_order' when calling WorkOrdersApi.create_work_order"
44
+ end
45
+ # resource path
46
+ local_var_path = '/workorders'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_work_order)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'WorkOrder'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"WorkOrdersApi.create_work_order",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: WorkOrdersApi#create_work_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Create a task to workOrder (BETA)
91
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Create a task to an workOrder.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Write</code>
92
+ # @param work_order_id [Integer] Work Order ID
93
+ # @param save_work_order_task [SaveWorkOrderTask] saveWorkOrderTask
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [Task]
96
+ def create_work_order_task(work_order_id, save_work_order_task, opts = {})
97
+ data, _status_code, _headers = create_work_order_task_with_http_info(work_order_id, save_work_order_task, opts)
98
+ data
99
+ end
100
+
101
+ # Create a task to workOrder (BETA)
102
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Create a task to an workOrder.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
103
+ # @param work_order_id [Integer] Work Order ID
104
+ # @param save_work_order_task [SaveWorkOrderTask] saveWorkOrderTask
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
107
+ def create_work_order_task_with_http_info(work_order_id, save_work_order_task, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.create_work_order_task ...'
110
+ end
111
+ # verify the required parameter 'work_order_id' is set
112
+ if @api_client.config.client_side_validation && work_order_id.nil?
113
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.create_work_order_task"
114
+ end
115
+ # verify the required parameter 'save_work_order_task' is set
116
+ if @api_client.config.client_side_validation && save_work_order_task.nil?
117
+ fail ArgumentError, "Missing the required parameter 'save_work_order_task' when calling WorkOrdersApi.create_work_order_task"
118
+ end
119
+ # resource path
120
+ local_var_path = '/workorders/{workOrderId}/tasks'.sub('{' + 'workOrderId' + '}', CGI.escape(work_order_id.to_s))
121
+
122
+ # query parameters
123
+ query_params = opts[:query_params] || {}
124
+
125
+ # header parameters
126
+ header_params = opts[:header_params] || {}
127
+ # HTTP header 'Accept' (if needed)
128
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
129
+ # HTTP header 'Content-Type'
130
+ content_type = @api_client.select_header_content_type(['application/json'])
131
+ if !content_type.nil?
132
+ header_params['Content-Type'] = content_type
133
+ end
134
+
135
+ # form parameters
136
+ form_params = opts[:form_params] || {}
137
+
138
+ # http body (model)
139
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_work_order_task)
140
+
141
+ # return_type
142
+ return_type = opts[:debug_return_type] || 'Task'
143
+
144
+ # auth_names
145
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
146
+
147
+ new_options = opts.merge(
148
+ :operation => :"WorkOrdersApi.create_work_order_task",
149
+ :header_params => header_params,
150
+ :query_params => query_params,
151
+ :form_params => form_params,
152
+ :body => post_body,
153
+ :auth_names => auth_names,
154
+ :return_type => return_type
155
+ )
156
+
157
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
158
+ if @api_client.config.debugging
159
+ @api_client.config.logger.debug "API called: WorkOrdersApi#create_work_order_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
160
+ end
161
+ return data, status_code, headers
162
+ end
163
+
164
+ # Create work orders in bulk (BETA)
165
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates word orders in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Write</code>
166
+ # @param save_work_order [Array<SaveWorkOrder>] saveWorkOrder
167
+ # @param [Hash] opts the optional parameters
168
+ # @return [Array<RESTAPIBulkSuccessResponse>]
169
+ def create_work_orders(save_work_order, opts = {})
170
+ data, _status_code, _headers = create_work_orders_with_http_info(save_work_order, opts)
171
+ data
172
+ end
173
+
174
+ # Create work orders in bulk (BETA)
175
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates word orders in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
176
+ # @param save_work_order [Array<SaveWorkOrder>] saveWorkOrder
177
+ # @param [Hash] opts the optional parameters
178
+ # @return [Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>] Array<RESTAPIBulkSuccessResponse> data, response status code and response headers
179
+ def create_work_orders_with_http_info(save_work_order, opts = {})
180
+ if @api_client.config.debugging
181
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.create_work_orders ...'
182
+ end
183
+ # verify the required parameter 'save_work_order' is set
184
+ if @api_client.config.client_side_validation && save_work_order.nil?
185
+ fail ArgumentError, "Missing the required parameter 'save_work_order' when calling WorkOrdersApi.create_work_orders"
186
+ end
187
+ # resource path
188
+ local_var_path = '/workorders/bulk'
189
+
190
+ # query parameters
191
+ query_params = opts[:query_params] || {}
192
+
193
+ # header parameters
194
+ header_params = opts[:header_params] || {}
195
+ # HTTP header 'Accept' (if needed)
196
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
197
+ # HTTP header 'Content-Type'
198
+ content_type = @api_client.select_header_content_type(['application/json'])
199
+ if !content_type.nil?
200
+ header_params['Content-Type'] = content_type
201
+ end
202
+
203
+ # form parameters
204
+ form_params = opts[:form_params] || {}
205
+
206
+ # http body (model)
207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_work_order)
208
+
209
+ # return_type
210
+ return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>'
211
+
212
+ # auth_names
213
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
214
+
215
+ new_options = opts.merge(
216
+ :operation => :"WorkOrdersApi.create_work_orders",
217
+ :header_params => header_params,
218
+ :query_params => query_params,
219
+ :form_params => form_params,
220
+ :body => post_body,
221
+ :auth_names => auth_names,
222
+ :return_type => return_type
223
+ )
224
+
225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug "API called: WorkOrdersApi#create_work_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
228
+ end
229
+ return data, status_code, headers
230
+ end
231
+
232
+ # Delete a Work Order (BETA)
233
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Delete a Work Order.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Delete</code>
234
+ # @param work_order_id [Integer] Work Order ID
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [ResponseEntity]
237
+ def delete_work_order(work_order_id, opts = {})
238
+ data, _status_code, _headers = delete_work_order_with_http_info(work_order_id, opts)
239
+ data
240
+ end
241
+
242
+ # Delete a Work Order (BETA)
243
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Delete a Work Order.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;
244
+ # @param work_order_id [Integer] Work Order ID
245
+ # @param [Hash] opts the optional parameters
246
+ # @return [Array<(ResponseEntity, Integer, Hash)>] ResponseEntity data, response status code and response headers
247
+ def delete_work_order_with_http_info(work_order_id, opts = {})
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.delete_work_order ...'
250
+ end
251
+ # verify the required parameter 'work_order_id' is set
252
+ if @api_client.config.client_side_validation && work_order_id.nil?
253
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.delete_work_order"
254
+ end
255
+ # resource path
256
+ local_var_path = '/workorders/{workOrderID}'.sub('{' + 'workOrderID' + '}', CGI.escape(work_order_id.to_s))
257
+
258
+ # query parameters
259
+ query_params = opts[:query_params] || {}
260
+
261
+ # header parameters
262
+ header_params = opts[:header_params] || {}
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
265
+
266
+ # form parameters
267
+ form_params = opts[:form_params] || {}
268
+
269
+ # http body (model)
270
+ post_body = opts[:debug_body]
271
+
272
+ # return_type
273
+ return_type = opts[:debug_return_type] || 'ResponseEntity'
274
+
275
+ # auth_names
276
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
277
+
278
+ new_options = opts.merge(
279
+ :operation => :"WorkOrdersApi.delete_work_order",
280
+ :header_params => header_params,
281
+ :query_params => query_params,
282
+ :form_params => form_params,
283
+ :body => post_body,
284
+ :auth_names => auth_names,
285
+ :return_type => return_type
286
+ )
287
+
288
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug "API called: WorkOrdersApi#delete_work_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
+ end
292
+ return data, status_code, headers
293
+ end
294
+
295
+ # Delete a work order task (BETA)
296
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Deletes a specific work order task.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Delete</code>
297
+ # @param work_order_id [Integer] Work Order ID
298
+ # @param task_id [Integer] Task ID
299
+ # @param [Hash] opts the optional parameters
300
+ # @return [ResponseEntity]
301
+ def delete_work_order_task(work_order_id, task_id, opts = {})
302
+ data, _status_code, _headers = delete_work_order_task_with_http_info(work_order_id, task_id, opts)
303
+ data
304
+ end
305
+
306
+ # Delete a work order task (BETA)
307
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Deletes a specific work order task.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;
308
+ # @param work_order_id [Integer] Work Order ID
309
+ # @param task_id [Integer] Task ID
310
+ # @param [Hash] opts the optional parameters
311
+ # @return [Array<(ResponseEntity, Integer, Hash)>] ResponseEntity data, response status code and response headers
312
+ def delete_work_order_task_with_http_info(work_order_id, task_id, opts = {})
313
+ if @api_client.config.debugging
314
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.delete_work_order_task ...'
315
+ end
316
+ # verify the required parameter 'work_order_id' is set
317
+ if @api_client.config.client_side_validation && work_order_id.nil?
318
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.delete_work_order_task"
319
+ end
320
+ # verify the required parameter 'task_id' is set
321
+ if @api_client.config.client_side_validation && task_id.nil?
322
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling WorkOrdersApi.delete_work_order_task"
323
+ end
324
+ # resource path
325
+ local_var_path = '/workorders/{workOrderID}/tasks/{taskID}'.sub('{' + 'workOrderID' + '}', CGI.escape(work_order_id.to_s)).sub('{' + 'taskID' + '}', CGI.escape(task_id.to_s))
326
+
327
+ # query parameters
328
+ query_params = opts[:query_params] || {}
329
+
330
+ # header parameters
331
+ header_params = opts[:header_params] || {}
332
+ # HTTP header 'Accept' (if needed)
333
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
334
+
335
+ # form parameters
336
+ form_params = opts[:form_params] || {}
337
+
338
+ # http body (model)
339
+ post_body = opts[:debug_body]
340
+
341
+ # return_type
342
+ return_type = opts[:debug_return_type] || 'ResponseEntity'
343
+
344
+ # auth_names
345
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
346
+
347
+ new_options = opts.merge(
348
+ :operation => :"WorkOrdersApi.delete_work_order_task",
349
+ :header_params => header_params,
350
+ :query_params => query_params,
351
+ :form_params => form_params,
352
+ :body => post_body,
353
+ :auth_names => auth_names,
354
+ :return_type => return_type
355
+ )
356
+
357
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
358
+ if @api_client.config.debugging
359
+ @api_client.config.logger.debug "API called: WorkOrdersApi#delete_work_order_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
360
+ end
361
+ return data, status_code, headers
362
+ end
363
+
364
+ # Retrieve a work order
365
+ # Retrieves a specific work order.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Read</code>
366
+ # @param work_order_id [Integer] Work Order ID
367
+ # @param [Hash] opts the optional parameters
368
+ # @option opts [Boolean] :include_custom_fields includeCustomFields (default to true)
369
+ # @return [WorkOrder]
370
+ def get_work_order(work_order_id, opts = {})
371
+ data, _status_code, _headers = get_work_order_with_http_info(work_order_id, opts)
372
+ data
373
+ end
374
+
375
+ # Retrieve a work order
376
+ # Retrieves a specific work order.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;
377
+ # @param work_order_id [Integer] Work Order ID
378
+ # @param [Hash] opts the optional parameters
379
+ # @option opts [Boolean] :include_custom_fields includeCustomFields (default to true)
380
+ # @return [Array<(WorkOrder, Integer, Hash)>] WorkOrder data, response status code and response headers
381
+ def get_work_order_with_http_info(work_order_id, opts = {})
382
+ if @api_client.config.debugging
383
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.get_work_order ...'
384
+ end
385
+ # verify the required parameter 'work_order_id' is set
386
+ if @api_client.config.client_side_validation && work_order_id.nil?
387
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.get_work_order"
388
+ end
389
+ # resource path
390
+ local_var_path = '/workorders/{workOrderId}'.sub('{' + 'workOrderId' + '}', CGI.escape(work_order_id.to_s))
391
+
392
+ # query parameters
393
+ query_params = opts[:query_params] || {}
394
+ query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].nil?
395
+
396
+ # header parameters
397
+ header_params = opts[:header_params] || {}
398
+ # HTTP header 'Accept' (if needed)
399
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
400
+
401
+ # form parameters
402
+ form_params = opts[:form_params] || {}
403
+
404
+ # http body (model)
405
+ post_body = opts[:debug_body]
406
+
407
+ # return_type
408
+ return_type = opts[:debug_return_type] || 'WorkOrder'
409
+
410
+ # auth_names
411
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
412
+
413
+ new_options = opts.merge(
414
+ :operation => :"WorkOrdersApi.get_work_order",
415
+ :header_params => header_params,
416
+ :query_params => query_params,
417
+ :form_params => form_params,
418
+ :body => post_body,
419
+ :auth_names => auth_names,
420
+ :return_type => return_type
421
+ )
422
+
423
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
424
+ if @api_client.config.debugging
425
+ @api_client.config.logger.debug "API called: WorkOrdersApi#get_work_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
426
+ end
427
+ return data, status_code, headers
428
+ end
429
+
430
+ # Retrieve a work order task
431
+ # Retrieves a specific work order task.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Read</code>
432
+ # @param work_order_id [Integer] Work Order ID
433
+ # @param task_id [Integer] Task ID
434
+ # @param [Hash] opts the optional parameters
435
+ # @return [Array<Task>]
436
+ def get_work_order_task(work_order_id, task_id, opts = {})
437
+ data, _status_code, _headers = get_work_order_task_with_http_info(work_order_id, task_id, opts)
438
+ data
439
+ end
440
+
441
+ # Retrieve a work order task
442
+ # Retrieves a specific work order task.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;
443
+ # @param work_order_id [Integer] Work Order ID
444
+ # @param task_id [Integer] Task ID
445
+ # @param [Hash] opts the optional parameters
446
+ # @return [Array<(Array<Task>, Integer, Hash)>] Array<Task> data, response status code and response headers
447
+ def get_work_order_task_with_http_info(work_order_id, task_id, opts = {})
448
+ if @api_client.config.debugging
449
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.get_work_order_task ...'
450
+ end
451
+ # verify the required parameter 'work_order_id' is set
452
+ if @api_client.config.client_side_validation && work_order_id.nil?
453
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.get_work_order_task"
454
+ end
455
+ # verify the required parameter 'task_id' is set
456
+ if @api_client.config.client_side_validation && task_id.nil?
457
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling WorkOrdersApi.get_work_order_task"
458
+ end
459
+ # resource path
460
+ local_var_path = '/workorders/{workOrderID}/tasks/{taskID}'.sub('{' + 'workOrderID' + '}', CGI.escape(work_order_id.to_s)).sub('{' + 'taskID' + '}', CGI.escape(task_id.to_s))
461
+
462
+ # query parameters
463
+ query_params = opts[:query_params] || {}
464
+
465
+ # header parameters
466
+ header_params = opts[:header_params] || {}
467
+ # HTTP header 'Accept' (if needed)
468
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
469
+
470
+ # form parameters
471
+ form_params = opts[:form_params] || {}
472
+
473
+ # http body (model)
474
+ post_body = opts[:debug_body]
475
+
476
+ # return_type
477
+ return_type = opts[:debug_return_type] || 'Array<Task>'
478
+
479
+ # auth_names
480
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
481
+
482
+ new_options = opts.merge(
483
+ :operation => :"WorkOrdersApi.get_work_order_task",
484
+ :header_params => header_params,
485
+ :query_params => query_params,
486
+ :form_params => form_params,
487
+ :body => post_body,
488
+ :auth_names => auth_names,
489
+ :return_type => return_type
490
+ )
491
+
492
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug "API called: WorkOrdersApi#get_work_order_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
495
+ end
496
+ return data, status_code, headers
497
+ end
498
+
499
+ # Retrieve all work order tasks
500
+ # Retrieves a list of work order tasks.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
501
+ # @param work_order_id [Integer] Work Order ID
502
+ # @param [Hash] opts the optional parameters
503
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
504
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
505
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
506
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
507
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
508
+ # @option opts [Date] :due_date Filters results by due day.
509
+ # @option opts [Boolean] :completed Filters results by task status.
510
+ # @return [Array<Task>]
511
+ def get_work_order_tasks(work_order_id, opts = {})
512
+ data, _status_code, _headers = get_work_order_tasks_with_http_info(work_order_id, opts)
513
+ data
514
+ end
515
+
516
+ # Retrieve all work order tasks
517
+ # Retrieves a list of work order tasks.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
518
+ # @param work_order_id [Integer] Work Order ID
519
+ # @param [Hash] opts the optional parameters
520
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
521
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
522
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
523
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
524
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
525
+ # @option opts [Date] :due_date Filters results by due day.
526
+ # @option opts [Boolean] :completed Filters results by task status.
527
+ # @return [Array<(Array<Task>, Integer, Hash)>] Array<Task> data, response status code and response headers
528
+ def get_work_order_tasks_with_http_info(work_order_id, opts = {})
529
+ if @api_client.config.debugging
530
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.get_work_order_tasks ...'
531
+ end
532
+ # verify the required parameter 'work_order_id' is set
533
+ if @api_client.config.client_side_validation && work_order_id.nil?
534
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.get_work_order_tasks"
535
+ end
536
+ # resource path
537
+ local_var_path = '/workorders/{workOrderId}/tasks'.sub('{' + 'workOrderId' + '}', CGI.escape(work_order_id.to_s))
538
+
539
+ # query parameters
540
+ query_params = opts[:query_params] || {}
541
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
542
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
543
+ query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
544
+ query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
545
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
546
+ query_params[:'dueDate'] = opts[:'due_date'] if !opts[:'due_date'].nil?
547
+ query_params[:'completed'] = opts[:'completed'] if !opts[:'completed'].nil?
548
+
549
+ # header parameters
550
+ header_params = opts[:header_params] || {}
551
+ # HTTP header 'Accept' (if needed)
552
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
553
+
554
+ # form parameters
555
+ form_params = opts[:form_params] || {}
556
+
557
+ # http body (model)
558
+ post_body = opts[:debug_body]
559
+
560
+ # return_type
561
+ return_type = opts[:debug_return_type] || 'Array<Task>'
562
+
563
+ # auth_names
564
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
565
+
566
+ new_options = opts.merge(
567
+ :operation => :"WorkOrdersApi.get_work_order_tasks",
568
+ :header_params => header_params,
569
+ :query_params => query_params,
570
+ :form_params => form_params,
571
+ :body => post_body,
572
+ :auth_names => auth_names,
573
+ :return_type => return_type
574
+ )
575
+
576
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
577
+ if @api_client.config.debugging
578
+ @api_client.config.logger.debug "API called: WorkOrdersApi#get_work_order_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
579
+ end
580
+ return data, status_code, headers
581
+ end
582
+
583
+ # Retrieve all work orders
584
+ # Retrieves a list of work orders.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>number</code>, <code>type</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>id</code>
585
+ # @param [Hash] opts the optional parameters
586
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
587
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
588
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
589
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
590
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
591
+ # @option opts [Integer] :portfolio_id Filters results to prospects associated with a specific portfolio.
592
+ # @option opts [Integer] :building_id Filters results to prospects associated with a specific building.
593
+ # @option opts [String] :status Filters results to work orders with a specific status.
594
+ # @option opts [String] :type Filters results to work orders with a specific type.
595
+ # @option opts [String] :priority Filters results to work orders with a specific priority.
596
+ # @option opts [Date] :completed_date_start Filters results to any payment with a date on or after to the date specified.
597
+ # @option opts [Date] :completed_date_end Filters results to any payment with a date on or prior to the date specified.
598
+ # @option opts [Boolean] :include_custom_fields includeCustomFields (default to false)
599
+ # @return [Array<WorkOrder>]
600
+ def get_work_orders(opts = {})
601
+ data, _status_code, _headers = get_work_orders_with_http_info(opts)
602
+ data
603
+ end
604
+
605
+ # Retrieve all work orders
606
+ # Retrieves a list of work orders.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;number&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;status&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
607
+ # @param [Hash] opts the optional parameters
608
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
609
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
610
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
611
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
612
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
613
+ # @option opts [Integer] :portfolio_id Filters results to prospects associated with a specific portfolio.
614
+ # @option opts [Integer] :building_id Filters results to prospects associated with a specific building.
615
+ # @option opts [String] :status Filters results to work orders with a specific status.
616
+ # @option opts [String] :type Filters results to work orders with a specific type.
617
+ # @option opts [String] :priority Filters results to work orders with a specific priority.
618
+ # @option opts [Date] :completed_date_start Filters results to any payment with a date on or after to the date specified.
619
+ # @option opts [Date] :completed_date_end Filters results to any payment with a date on or prior to the date specified.
620
+ # @option opts [Boolean] :include_custom_fields includeCustomFields (default to false)
621
+ # @return [Array<(Array<WorkOrder>, Integer, Hash)>] Array<WorkOrder> data, response status code and response headers
622
+ def get_work_orders_with_http_info(opts = {})
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.get_work_orders ...'
625
+ end
626
+ allowable_values = ["HIGH", "MEDIUM", "LOW"]
627
+ if @api_client.config.client_side_validation && opts[:'priority'] && !allowable_values.include?(opts[:'priority'])
628
+ fail ArgumentError, "invalid value for \"priority\", must be one of #{allowable_values}"
629
+ end
630
+ # resource path
631
+ local_var_path = '/workorders'
632
+
633
+ # query parameters
634
+ query_params = opts[:query_params] || {}
635
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
636
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
637
+ query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
638
+ query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
639
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
640
+ query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
641
+ query_params[:'buildingID'] = opts[:'building_id'] if !opts[:'building_id'].nil?
642
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
643
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
644
+ query_params[:'priority'] = opts[:'priority'] if !opts[:'priority'].nil?
645
+ query_params[:'completedDateStart'] = opts[:'completed_date_start'] if !opts[:'completed_date_start'].nil?
646
+ query_params[:'completedDateEnd'] = opts[:'completed_date_end'] if !opts[:'completed_date_end'].nil?
647
+ query_params[:'includeCustomFields'] = opts[:'include_custom_fields'] if !opts[:'include_custom_fields'].nil?
648
+
649
+ # header parameters
650
+ header_params = opts[:header_params] || {}
651
+ # HTTP header 'Accept' (if needed)
652
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
653
+
654
+ # form parameters
655
+ form_params = opts[:form_params] || {}
656
+
657
+ # http body (model)
658
+ post_body = opts[:debug_body]
659
+
660
+ # return_type
661
+ return_type = opts[:debug_return_type] || 'Array<WorkOrder>'
662
+
663
+ # auth_names
664
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
665
+
666
+ new_options = opts.merge(
667
+ :operation => :"WorkOrdersApi.get_work_orders",
668
+ :header_params => header_params,
669
+ :query_params => query_params,
670
+ :form_params => form_params,
671
+ :body => post_body,
672
+ :auth_names => auth_names,
673
+ :return_type => return_type
674
+ )
675
+
676
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
677
+ if @api_client.config.debugging
678
+ @api_client.config.logger.debug "API called: WorkOrdersApi#get_work_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
679
+ end
680
+ return data, status_code, headers
681
+ end
682
+
683
+ # Update a task in workOrder (BETA)
684
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update an existing workOrder task.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">WORK ORDERS</span> - <code>Write</code>
685
+ # @param work_order_id [Integer] Work Order ID
686
+ # @param task_id [Integer] Task ID
687
+ # @param save_work_order_task [SaveWorkOrderTask] saveWorkOrderTask
688
+ # @param [Hash] opts the optional parameters
689
+ # @return [Task]
690
+ def update_work_order_task(work_order_id, task_id, save_work_order_task, opts = {})
691
+ data, _status_code, _headers = update_work_order_task_with_http_info(work_order_id, task_id, save_work_order_task, opts)
692
+ data
693
+ end
694
+
695
+ # Update a task in workOrder (BETA)
696
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update an existing workOrder task.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;WORK ORDERS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
697
+ # @param work_order_id [Integer] Work Order ID
698
+ # @param task_id [Integer] Task ID
699
+ # @param save_work_order_task [SaveWorkOrderTask] saveWorkOrderTask
700
+ # @param [Hash] opts the optional parameters
701
+ # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
702
+ def update_work_order_task_with_http_info(work_order_id, task_id, save_work_order_task, opts = {})
703
+ if @api_client.config.debugging
704
+ @api_client.config.logger.debug 'Calling API: WorkOrdersApi.update_work_order_task ...'
705
+ end
706
+ # verify the required parameter 'work_order_id' is set
707
+ if @api_client.config.client_side_validation && work_order_id.nil?
708
+ fail ArgumentError, "Missing the required parameter 'work_order_id' when calling WorkOrdersApi.update_work_order_task"
709
+ end
710
+ # verify the required parameter 'task_id' is set
711
+ if @api_client.config.client_side_validation && task_id.nil?
712
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling WorkOrdersApi.update_work_order_task"
713
+ end
714
+ # verify the required parameter 'save_work_order_task' is set
715
+ if @api_client.config.client_side_validation && save_work_order_task.nil?
716
+ fail ArgumentError, "Missing the required parameter 'save_work_order_task' when calling WorkOrdersApi.update_work_order_task"
717
+ end
718
+ # resource path
719
+ local_var_path = '/workorders/{workOrderId}/tasks/{taskId}'.sub('{' + 'workOrderId' + '}', CGI.escape(work_order_id.to_s)).sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
720
+
721
+ # query parameters
722
+ query_params = opts[:query_params] || {}
723
+
724
+ # header parameters
725
+ header_params = opts[:header_params] || {}
726
+ # HTTP header 'Accept' (if needed)
727
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
728
+ # HTTP header 'Content-Type'
729
+ content_type = @api_client.select_header_content_type(['application/json'])
730
+ if !content_type.nil?
731
+ header_params['Content-Type'] = content_type
732
+ end
733
+
734
+ # form parameters
735
+ form_params = opts[:form_params] || {}
736
+
737
+ # http body (model)
738
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_work_order_task)
739
+
740
+ # return_type
741
+ return_type = opts[:debug_return_type] || 'Task'
742
+
743
+ # auth_names
744
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
745
+
746
+ new_options = opts.merge(
747
+ :operation => :"WorkOrdersApi.update_work_order_task",
748
+ :header_params => header_params,
749
+ :query_params => query_params,
750
+ :form_params => form_params,
751
+ :body => post_body,
752
+ :auth_names => auth_names,
753
+ :return_type => return_type
754
+ )
755
+
756
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
757
+ if @api_client.config.debugging
758
+ @api_client.config.logger.debug "API called: WorkOrdersApi#update_work_order_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
759
+ end
760
+ return data, status_code, headers
761
+ end
762
+ end
763
+ end