propertyware 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +27 -0
- data/.github/workflows/publish.yml +48 -0
- data/.gitignore +39 -0
- data/.openapi-generator/FILES +375 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
- data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
- data/.openapi-generator-ignore +23 -0
- data/.rspec +2 -0
- data/.rubocop.yml +124 -0
- data/CUSTOMIZATIONS.md +11 -0
- data/DOCS.md +673 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +76 -0
- data/README.md +93 -0
- data/Rakefile +10 -0
- data/bin/CUSTOMIZATIONS.md +11 -0
- data/bin/README.md +93 -0
- data/bin/config.yml +7 -0
- data/bin/fix_json.rb +59 -0
- data/bin/propertyware.json +1 -0
- data/bin/rebuild.sh +31 -0
- data/docs/Account.md +84 -0
- data/docs/AccountingApi.md +1235 -0
- data/docs/Address.md +28 -0
- data/docs/Amenity.md +24 -0
- data/docs/AutoJournalEntry.md +46 -0
- data/docs/AutoPayment.md +42 -0
- data/docs/Bank.md +52 -0
- data/docs/BankDeposit.md +32 -0
- data/docs/BasicVendor.md +40 -0
- data/docs/Bill.md +54 -0
- data/docs/BillPaid.md +24 -0
- data/docs/BillPay.md +20 -0
- data/docs/BillPayment.md +46 -0
- data/docs/BillSplit.md +42 -0
- data/docs/BillsApi.md +1391 -0
- data/docs/Building.md +116 -0
- data/docs/BuildingsApi.md +1037 -0
- data/docs/Campaign.md +60 -0
- data/docs/CampaignSource.md +26 -0
- data/docs/Charge.md +36 -0
- data/docs/ChargeTx.md +52 -0
- data/docs/Check.md +48 -0
- data/docs/CheckSplit.md +30 -0
- data/docs/Comment.md +28 -0
- data/docs/Contact.md +74 -0
- data/docs/ContactsApi.md +783 -0
- data/docs/Conversation.md +36 -0
- data/docs/CreditCardAccount.md +18 -0
- data/docs/CurrentAsset.md +30 -0
- data/docs/CurrentLiability.md +30 -0
- data/docs/CustomField.md +24 -0
- data/docs/Discount.md +40 -0
- data/docs/Document.md +40 -0
- data/docs/DocumentsApi.md +267 -0
- data/docs/Entry.md +34 -0
- data/docs/Equity.md +32 -0
- data/docs/ErrorResponse.md +22 -0
- data/docs/Expense.md +32 -0
- data/docs/GLItem.md +40 -0
- data/docs/HealthCheckApi.md +86 -0
- data/docs/Income.md +34 -0
- data/docs/Inspection.md +46 -0
- data/docs/InspectionArea.md +22 -0
- data/docs/InspectionItem.md +24 -0
- data/docs/InspectionsApi.md +193 -0
- data/docs/JournalEntry.md +36 -0
- data/docs/JournalEntrySplit.md +24 -0
- data/docs/JournalEntrySplitResponse.md +24 -0
- data/docs/LateFeeRule.md +26 -0
- data/docs/Lease.md +76 -0
- data/docs/LeaseClause.md +22 -0
- data/docs/LeaseContact.md +36 -0
- data/docs/LeasesApi.md +3319 -0
- data/docs/ManagementFee.md +30 -0
- data/docs/ManagementSettings.md +26 -0
- data/docs/Marketing.md +62 -0
- data/docs/NonCurrentAsset.md +26 -0
- data/docs/NonCurrentLiability.md +30 -0
- data/docs/NonOperatingExpense.md +32 -0
- data/docs/NonOperatingInome.md +32 -0
- data/docs/Note.md +28 -0
- data/docs/Owner.md +38 -0
- data/docs/OwnerContribution.md +44 -0
- data/docs/OwnerDraw.md +44 -0
- data/docs/Payment.md +50 -0
- data/docs/PaymentCharge.md +36 -0
- data/docs/Portfolio.md +60 -0
- data/docs/PortfoliosApi.md +701 -0
- data/docs/PropertyManager.md +26 -0
- data/docs/Prospect.md +114 -0
- data/docs/ProspectsApi.md +789 -0
- data/docs/RESTAPIBulkErrorResponse.md +22 -0
- data/docs/RESTAPIBulkSuccessResponse.md +18 -0
- data/docs/RESTAPIError.md +20 -0
- data/docs/Refund.md +44 -0
- data/docs/ResponseEntity.md +20 -0
- data/docs/SaveAccount.md +52 -0
- data/docs/SaveAddress.md +28 -0
- data/docs/SaveAdjustment.md +26 -0
- data/docs/SaveAutoCharge.md +28 -0
- data/docs/SaveBankDeposit.md +20 -0
- data/docs/SaveBill.md +42 -0
- data/docs/SaveBillPayment.md +30 -0
- data/docs/SaveBillSplit.md +36 -0
- data/docs/SaveBuilding.md +84 -0
- data/docs/SaveCharge.md +28 -0
- data/docs/SaveCheck.md +30 -0
- data/docs/SaveCheckSplit.md +30 -0
- data/docs/SaveComment.md +18 -0
- data/docs/SaveContact.md +60 -0
- data/docs/SaveConversation.md +20 -0
- data/docs/SaveCredit.md +26 -0
- data/docs/SaveDiscount.md +28 -0
- data/docs/SaveJournalEntrySplit.md +22 -0
- data/docs/SaveLease.md +50 -0
- data/docs/SaveLeaseJournalEntry.md +26 -0
- data/docs/SaveOwner.md +36 -0
- data/docs/SaveOwnerContribution.md +34 -0
- data/docs/SaveOwnerDraw.md +34 -0
- data/docs/SavePayment.md +34 -0
- data/docs/SavePortfolio.md +38 -0
- data/docs/SaveProspect.md +76 -0
- data/docs/SaveProspectContact.md +36 -0
- data/docs/SaveRefund.md +34 -0
- data/docs/SaveUnit.md +60 -0
- data/docs/SaveVendor.md +46 -0
- data/docs/SaveWorkOrder.md +36 -0
- data/docs/SaveWorkOrderTask.md +30 -0
- data/docs/SplitPaid.md +34 -0
- data/docs/SplitPay.md +20 -0
- data/docs/Task.md +42 -0
- data/docs/Transaction.md +54 -0
- data/docs/Unit.md +96 -0
- data/docs/UnitsApi.md +875 -0
- data/docs/UpdateLeaseJournalEntry.md +26 -0
- data/docs/Vendor.md +76 -0
- data/docs/VendorsApi.md +617 -0
- data/docs/WorkOrder.md +78 -0
- data/docs/WorkOrdersApi.md +883 -0
- data/lib/propertyware/api/accounting_api.rb +1041 -0
- data/lib/propertyware/api/bills_api.rb +1182 -0
- data/lib/propertyware/api/buildings_api.rb +863 -0
- data/lib/propertyware/api/contacts_api.rb +666 -0
- data/lib/propertyware/api/documents_api.rb +235 -0
- data/lib/propertyware/api/health_check_api.rb +79 -0
- data/lib/propertyware/api/inspections_api.rb +172 -0
- data/lib/propertyware/api/leases_api.rb +2787 -0
- data/lib/propertyware/api/portfolios_api.rb +599 -0
- data/lib/propertyware/api/prospects_api.rb +671 -0
- data/lib/propertyware/api/units_api.rb +740 -0
- data/lib/propertyware/api/vendors_api.rb +522 -0
- data/lib/propertyware/api/work_orders_api.rb +763 -0
- data/lib/propertyware/api_client.rb +428 -0
- data/lib/propertyware/api_error.rb +58 -0
- data/lib/propertyware/configuration.rb +392 -0
- data/lib/propertyware/models/account.rb +549 -0
- data/lib/propertyware/models/address.rb +269 -0
- data/lib/propertyware/models/amenity.rb +249 -0
- data/lib/propertyware/models/auto_journal_entry.rb +358 -0
- data/lib/propertyware/models/auto_payment.rb +338 -0
- data/lib/propertyware/models/bank.rb +389 -0
- data/lib/propertyware/models/bank_deposit.rb +289 -0
- data/lib/propertyware/models/basic_vendor.rb +330 -0
- data/lib/propertyware/models/bill.rb +401 -0
- data/lib/propertyware/models/bill_paid.rb +250 -0
- data/lib/propertyware/models/bill_pay.rb +230 -0
- data/lib/propertyware/models/bill_payment.rb +361 -0
- data/lib/propertyware/models/bill_split.rb +339 -0
- data/lib/propertyware/models/building.rb +782 -0
- data/lib/propertyware/models/campaign.rb +430 -0
- data/lib/propertyware/models/campaign_source.rb +258 -0
- data/lib/propertyware/models/charge.rb +318 -0
- data/lib/propertyware/models/charge_tx.rb +401 -0
- data/lib/propertyware/models/check.rb +425 -0
- data/lib/propertyware/models/check_split.rb +284 -0
- data/lib/propertyware/models/comment.rb +269 -0
- data/lib/propertyware/models/contact.rb +546 -0
- data/lib/propertyware/models/conversation.rb +345 -0
- data/lib/propertyware/models/credit_card_account.rb +219 -0
- data/lib/propertyware/models/current_asset.rb +279 -0
- data/lib/propertyware/models/current_liability.rb +279 -0
- data/lib/propertyware/models/custom_field.rb +249 -0
- data/lib/propertyware/models/discount.rb +339 -0
- data/lib/propertyware/models/document.rb +362 -0
- data/lib/propertyware/models/entry.rb +297 -0
- data/lib/propertyware/models/equity.rb +289 -0
- data/lib/propertyware/models/error_response.rb +237 -0
- data/lib/propertyware/models/expense.rb +289 -0
- data/lib/propertyware/models/gl_item.rb +330 -0
- data/lib/propertyware/models/income.rb +299 -0
- data/lib/propertyware/models/inspection.rb +361 -0
- data/lib/propertyware/models/inspection_area.rb +241 -0
- data/lib/propertyware/models/inspection_item.rb +249 -0
- data/lib/propertyware/models/journal_entry.rb +311 -0
- data/lib/propertyware/models/journal_entry_split.rb +264 -0
- data/lib/propertyware/models/journal_entry_split_response.rb +263 -0
- data/lib/propertyware/models/late_fee_rule.rb +258 -0
- data/lib/propertyware/models/lease.rb +515 -0
- data/lib/propertyware/models/lease_clause.rb +238 -0
- data/lib/propertyware/models/lease_contact.rb +309 -0
- data/lib/propertyware/models/management_fee.rb +279 -0
- data/lib/propertyware/models/management_settings.rb +261 -0
- data/lib/propertyware/models/marketing.rb +439 -0
- data/lib/propertyware/models/non_current_asset.rb +259 -0
- data/lib/propertyware/models/non_current_liability.rb +279 -0
- data/lib/propertyware/models/non_operating_expense.rb +289 -0
- data/lib/propertyware/models/non_operating_inome.rb +289 -0
- data/lib/propertyware/models/note.rb +267 -0
- data/lib/propertyware/models/owner.rb +318 -0
- data/lib/propertyware/models/owner_contribution.rb +418 -0
- data/lib/propertyware/models/owner_draw.rb +398 -0
- data/lib/propertyware/models/payment.rb +423 -0
- data/lib/propertyware/models/payment_charge.rb +358 -0
- data/lib/propertyware/models/portfolio.rb +479 -0
- data/lib/propertyware/models/property_manager.rb +259 -0
- data/lib/propertyware/models/prospect.rb +701 -0
- data/lib/propertyware/models/refund.rb +384 -0
- data/lib/propertyware/models/response_entity.rb +260 -0
- data/lib/propertyware/models/restapi_bulk_error_response.rb +237 -0
- data/lib/propertyware/models/restapi_bulk_success_response.rb +217 -0
- data/lib/propertyware/models/restapi_error.rb +226 -0
- data/lib/propertyware/models/save_account.rb +398 -0
- data/lib/propertyware/models/save_address.rb +274 -0
- data/lib/propertyware/models/save_adjustment.rb +269 -0
- data/lib/propertyware/models/save_auto_charge.rb +328 -0
- data/lib/propertyware/models/save_bank_deposit.rb +239 -0
- data/lib/propertyware/models/save_bill.rb +356 -0
- data/lib/propertyware/models/save_bill_payment.rb +314 -0
- data/lib/propertyware/models/save_bill_split.rb +319 -0
- data/lib/propertyware/models/save_building.rb +653 -0
- data/lib/propertyware/models/save_charge.rb +289 -0
- data/lib/propertyware/models/save_check.rb +291 -0
- data/lib/propertyware/models/save_check_split.rb +289 -0
- data/lib/propertyware/models/save_comment.rb +224 -0
- data/lib/propertyware/models/save_contact.rb +472 -0
- data/lib/propertyware/models/save_conversation.rb +273 -0
- data/lib/propertyware/models/save_credit.rb +271 -0
- data/lib/propertyware/models/save_discount.rb +289 -0
- data/lib/propertyware/models/save_journal_entry_split.rb +254 -0
- data/lib/propertyware/models/save_lease.rb +444 -0
- data/lib/propertyware/models/save_lease_journal_entry.rb +276 -0
- data/lib/propertyware/models/save_owner.rb +318 -0
- data/lib/propertyware/models/save_owner_contribution.rb +373 -0
- data/lib/propertyware/models/save_owner_draw.rb +334 -0
- data/lib/propertyware/models/save_payment.rb +373 -0
- data/lib/propertyware/models/save_portfolio.rb +379 -0
- data/lib/propertyware/models/save_prospect.rb +511 -0
- data/lib/propertyware/models/save_prospect_contact.rb +318 -0
- data/lib/propertyware/models/save_refund.rb +334 -0
- data/lib/propertyware/models/save_unit.rb +492 -0
- data/lib/propertyware/models/save_vendor.rb +379 -0
- data/lib/propertyware/models/save_work_order.rb +345 -0
- data/lib/propertyware/models/save_work_order_task.rb +284 -0
- data/lib/propertyware/models/split_paid.rb +298 -0
- data/lib/propertyware/models/split_pay.rb +228 -0
- data/lib/propertyware/models/task.rb +339 -0
- data/lib/propertyware/models/transaction.rb +433 -0
- data/lib/propertyware/models/unit.rb +670 -0
- data/lib/propertyware/models/update_lease_journal_entry.rb +276 -0
- data/lib/propertyware/models/vendor.rb +511 -0
- data/lib/propertyware/models/work_order.rb +557 -0
- data/lib/propertyware/version.rb +15 -0
- data/lib/propertyware.rb +158 -0
- data/openapitools.json +7 -0
- data/propertyware.gemspec +39 -0
- data/spec/api/accounting_api_spec.rb +239 -0
- data/spec/api/bills_api_spec.rb +260 -0
- data/spec/api/buildings_api_spec.rb +199 -0
- data/spec/api/contacts_api_spec.rb +159 -0
- data/spec/api/documents_api_spec.rb +77 -0
- data/spec/api/health_check_api_spec.rb +46 -0
- data/spec/api/inspections_api_spec.rb +68 -0
- data/spec/api/leases_api_spec.rb +579 -0
- data/spec/api/portfolios_api_spec.rb +147 -0
- data/spec/api/prospects_api_spec.rb +162 -0
- data/spec/api/units_api_spec.rb +176 -0
- data/spec/api/vendors_api_spec.rb +134 -0
- data/spec/api/work_orders_api_spec.rb +180 -0
- data/spec/api_client_spec.rb +223 -0
- data/spec/configuration_spec.rb +82 -0
- data/spec/models/account_spec.rb +232 -0
- data/spec/models/address_spec.rb +64 -0
- data/spec/models/amenity_spec.rb +52 -0
- data/spec/models/auto_journal_entry_spec.rb +118 -0
- data/spec/models/auto_payment_spec.rb +106 -0
- data/spec/models/bank_deposit_spec.rb +76 -0
- data/spec/models/bank_spec.rb +136 -0
- data/spec/models/basic_vendor_spec.rb +100 -0
- data/spec/models/bill_paid_spec.rb +52 -0
- data/spec/models/bill_pay_spec.rb +40 -0
- data/spec/models/bill_payment_spec.rb +118 -0
- data/spec/models/bill_spec.rb +142 -0
- data/spec/models/bill_split_spec.rb +106 -0
- data/spec/models/building_spec.rb +344 -0
- data/spec/models/campaign_source_spec.rb +58 -0
- data/spec/models/campaign_spec.rb +160 -0
- data/spec/models/charge_spec.rb +88 -0
- data/spec/models/charge_tx_spec.rb +136 -0
- data/spec/models/check_spec.rb +128 -0
- data/spec/models/check_split_spec.rb +70 -0
- data/spec/models/comment_spec.rb +64 -0
- data/spec/models/contact_spec.rb +210 -0
- data/spec/models/conversation_spec.rb +92 -0
- data/spec/models/credit_card_account_spec.rb +34 -0
- data/spec/models/current_asset_spec.rb +70 -0
- data/spec/models/current_liability_spec.rb +70 -0
- data/spec/models/custom_field_spec.rb +52 -0
- data/spec/models/discount_spec.rb +100 -0
- data/spec/models/document_spec.rb +104 -0
- data/spec/models/entry_spec.rb +82 -0
- data/spec/models/equity_spec.rb +76 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/expense_spec.rb +76 -0
- data/spec/models/gl_item_spec.rb +100 -0
- data/spec/models/income_spec.rb +82 -0
- data/spec/models/inspection_area_spec.rb +46 -0
- data/spec/models/inspection_item_spec.rb +52 -0
- data/spec/models/inspection_spec.rb +118 -0
- data/spec/models/journal_entry_spec.rb +88 -0
- data/spec/models/journal_entry_split_response_spec.rb +52 -0
- data/spec/models/journal_entry_split_spec.rb +52 -0
- data/spec/models/late_fee_rule_spec.rb +58 -0
- data/spec/models/lease_clause_spec.rb +46 -0
- data/spec/models/lease_contact_spec.rb +88 -0
- data/spec/models/lease_spec.rb +208 -0
- data/spec/models/management_fee_spec.rb +70 -0
- data/spec/models/management_settings_spec.rb +58 -0
- data/spec/models/marketing_spec.rb +166 -0
- data/spec/models/non_current_asset_spec.rb +58 -0
- data/spec/models/non_current_liability_spec.rb +70 -0
- data/spec/models/non_operating_expense_spec.rb +76 -0
- data/spec/models/non_operating_inome_spec.rb +76 -0
- data/spec/models/note_spec.rb +64 -0
- data/spec/models/owner_contribution_spec.rb +116 -0
- data/spec/models/owner_draw_spec.rb +116 -0
- data/spec/models/owner_spec.rb +94 -0
- data/spec/models/payment_charge_spec.rb +92 -0
- data/spec/models/payment_spec.rb +134 -0
- data/spec/models/portfolio_spec.rb +168 -0
- data/spec/models/property_manager_spec.rb +58 -0
- data/spec/models/prospect_spec.rb +322 -0
- data/spec/models/refund_spec.rb +112 -0
- data/spec/models/response_entity_spec.rb +44 -0
- data/spec/models/restapi_bulk_error_response_spec.rb +46 -0
- data/spec/models/restapi_bulk_success_response_spec.rb +34 -0
- data/spec/models/restapi_error_spec.rb +40 -0
- data/spec/models/save_account_spec.rb +136 -0
- data/spec/models/save_address_spec.rb +64 -0
- data/spec/models/save_adjustment_spec.rb +58 -0
- data/spec/models/save_auto_charge_spec.rb +68 -0
- data/spec/models/save_bank_deposit_spec.rb +40 -0
- data/spec/models/save_bill_payment_spec.rb +74 -0
- data/spec/models/save_bill_spec.rb +106 -0
- data/spec/models/save_bill_split_spec.rb +88 -0
- data/spec/models/save_building_spec.rb +248 -0
- data/spec/models/save_charge_spec.rb +64 -0
- data/spec/models/save_check_spec.rb +70 -0
- data/spec/models/save_check_split_spec.rb +70 -0
- data/spec/models/save_comment_spec.rb +34 -0
- data/spec/models/save_contact_spec.rb +164 -0
- data/spec/models/save_conversation_spec.rb +44 -0
- data/spec/models/save_credit_spec.rb +58 -0
- data/spec/models/save_discount_spec.rb +64 -0
- data/spec/models/save_journal_entry_split_spec.rb +46 -0
- data/spec/models/save_lease_journal_entry_spec.rb +58 -0
- data/spec/models/save_lease_spec.rb +134 -0
- data/spec/models/save_owner_contribution_spec.rb +86 -0
- data/spec/models/save_owner_draw_spec.rb +82 -0
- data/spec/models/save_owner_spec.rb +88 -0
- data/spec/models/save_payment_spec.rb +86 -0
- data/spec/models/save_portfolio_spec.rb +102 -0
- data/spec/models/save_prospect_contact_spec.rb +88 -0
- data/spec/models/save_prospect_spec.rb +208 -0
- data/spec/models/save_refund_spec.rb +82 -0
- data/spec/models/save_unit_spec.rb +164 -0
- data/spec/models/save_vendor_spec.rb +118 -0
- data/spec/models/save_work_order_spec.rb +92 -0
- data/spec/models/save_work_order_task_spec.rb +70 -0
- data/spec/models/split_paid_spec.rb +82 -0
- data/spec/models/split_pay_spec.rb +40 -0
- data/spec/models/task_spec.rb +106 -0
- data/spec/models/transaction_spec.rb +146 -0
- data/spec/models/unit_spec.rb +280 -0
- data/spec/models/update_lease_journal_entry_spec.rb +58 -0
- data/spec/models/vendor_spec.rb +208 -0
- data/spec/models/work_order_spec.rb +218 -0
- data/spec/spec_helper.rb +111 -0
- metadata +609 -0
@@ -0,0 +1,86 @@
|
|
1
|
+
# Propertyware::HealthCheckApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**health**](HealthCheckApi.md#health) | **GET** /health | Health check |
|
8
|
+
|
9
|
+
|
10
|
+
## health
|
11
|
+
|
12
|
+
> <ResponseEntity> health
|
13
|
+
|
14
|
+
Health check
|
15
|
+
|
16
|
+
Indicates whether the API is up and running correctly.<br/><br/>
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'propertyware'
|
23
|
+
# setup authorization
|
24
|
+
Propertyware.configure do |config|
|
25
|
+
# Configure API key authorization: organizationId
|
26
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
29
|
+
|
30
|
+
# Configure API key authorization: clientId
|
31
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
34
|
+
|
35
|
+
# Configure API key authorization: clientSecret
|
36
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
37
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
38
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
39
|
+
end
|
40
|
+
|
41
|
+
api_instance = Propertyware::HealthCheckApi.new
|
42
|
+
|
43
|
+
begin
|
44
|
+
# Health check
|
45
|
+
result = api_instance.health
|
46
|
+
p result
|
47
|
+
rescue Propertyware::ApiError => e
|
48
|
+
puts "Error when calling HealthCheckApi->health: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Using the health_with_http_info variant
|
53
|
+
|
54
|
+
This returns an Array which contains the response data, status code and headers.
|
55
|
+
|
56
|
+
> <Array(<ResponseEntity>, Integer, Hash)> health_with_http_info
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
begin
|
60
|
+
# Health check
|
61
|
+
data, status_code, headers = api_instance.health_with_http_info
|
62
|
+
p status_code # => 2xx
|
63
|
+
p headers # => { ... }
|
64
|
+
p data # => <ResponseEntity>
|
65
|
+
rescue Propertyware::ApiError => e
|
66
|
+
puts "Error when calling HealthCheckApi->health_with_http_info: #{e}"
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
This endpoint does not need any parameter.
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**ResponseEntity**](ResponseEntity.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: Not defined
|
85
|
+
- **Accept**: */*
|
86
|
+
|
data/docs/Income.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# Propertyware::Income
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cam_recovery_account** | **Boolean** | Indicates if account is a CAM recovery account. | [optional] |
|
8
|
+
| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
|
9
|
+
| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
|
10
|
+
| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
|
11
|
+
| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
|
12
|
+
| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
|
13
|
+
| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
|
14
|
+
| **section8** | **Boolean** | Indicates if account is a section8 account. | [optional] |
|
15
|
+
| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'propertyware'
|
21
|
+
|
22
|
+
instance = Propertyware::Income.new(
|
23
|
+
cam_recovery_account: false,
|
24
|
+
discount_account: false,
|
25
|
+
escrow_account: false,
|
26
|
+
exclude_from1099: false,
|
27
|
+
exclude_from_pay_in_full: false,
|
28
|
+
exclude_late_fee: false,
|
29
|
+
rent_account: false,
|
30
|
+
section8: false,
|
31
|
+
tax_account: false
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/Inspection.md
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# Propertyware::Inspection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **building_id** | **Integer** | Id of the building associated with this inspection. | [optional] |
|
8
|
+
| **comment** | **String** | Inspection comments. | [optional] |
|
9
|
+
| **created_by** | **String** | User who created the record. | [optional] |
|
10
|
+
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
11
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
12
|
+
| **inspected_date_and_time** | **Time** | Date and time the inspection occurred (customer time zone). | [optional] |
|
13
|
+
| **inspection_areas** | [**Array<InspectionArea>**](InspectionArea.md) | List of inspection areas. | [optional] |
|
14
|
+
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
15
|
+
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
16
|
+
| **number** | **Integer** | Inspection number. | [optional] |
|
17
|
+
| **portfolio_id** | **Integer** | Id of the portfolio associated with this inspection. | [optional] |
|
18
|
+
| **scheduled_date_and_time** | **Time** | Date and time the inspection is/was scheduled to occur (customer time zone). | [optional] |
|
19
|
+
| **status** | **String** | Inspection status. | [optional] |
|
20
|
+
| **template_name** | **String** | Inspection template name. | [optional] |
|
21
|
+
| **type** | **String** | Inspection type. | [optional] |
|
22
|
+
|
23
|
+
## Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'propertyware'
|
27
|
+
|
28
|
+
instance = Propertyware::Inspection.new(
|
29
|
+
building_id: null,
|
30
|
+
comment: null,
|
31
|
+
created_by: null,
|
32
|
+
created_date_time: null,
|
33
|
+
id: null,
|
34
|
+
inspected_date_and_time: null,
|
35
|
+
inspection_areas: null,
|
36
|
+
last_modified_by: null,
|
37
|
+
last_modified_date_time: null,
|
38
|
+
number: null,
|
39
|
+
portfolio_id: null,
|
40
|
+
scheduled_date_and_time: null,
|
41
|
+
status: null,
|
42
|
+
template_name: null,
|
43
|
+
type: null
|
44
|
+
)
|
45
|
+
```
|
46
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Propertyware::InspectionArea
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
8
|
+
| **items** | [**Array<InspectionItem>**](InspectionItem.md) | List of items in the inspection. | [optional] |
|
9
|
+
| **name** | **String** | Name of the inspection area. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'propertyware'
|
15
|
+
|
16
|
+
instance = Propertyware::InspectionArea.new(
|
17
|
+
id: null,
|
18
|
+
items: null,
|
19
|
+
name: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Propertyware::InspectionItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **comments** | **String** | Comments. | [optional] |
|
8
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
9
|
+
| **name** | **String** | Name of the inspection item. | [optional] |
|
10
|
+
| **status** | **String** | Status of the inspection. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'propertyware'
|
16
|
+
|
17
|
+
instance = Propertyware::InspectionItem.new(
|
18
|
+
comments: null,
|
19
|
+
id: null,
|
20
|
+
name: null,
|
21
|
+
status: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,193 @@
|
|
1
|
+
# Propertyware::InspectionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_inspection**](InspectionsApi.md#get_inspection) | **GET** /inspections/{inspectionId} | Retrieve a inspection |
|
8
|
+
| [**get_inspections**](InspectionsApi.md#get_inspections) | **GET** /inspections | Retrieve all inspections |
|
9
|
+
|
10
|
+
|
11
|
+
## get_inspection
|
12
|
+
|
13
|
+
> <Inspection> get_inspection(inspection_id, opts)
|
14
|
+
|
15
|
+
Retrieve a inspection
|
16
|
+
|
17
|
+
Retrieves a specific inspection.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">INSPECTIONS</span> - <code>Read</code>
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'propertyware'
|
24
|
+
# setup authorization
|
25
|
+
Propertyware.configure do |config|
|
26
|
+
# Configure API key authorization: organizationId
|
27
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
30
|
+
|
31
|
+
# Configure API key authorization: clientId
|
32
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
35
|
+
|
36
|
+
# Configure API key authorization: clientSecret
|
37
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = Propertyware::InspectionsApi.new
|
43
|
+
inspection_id = 789 # Integer | Inspection ID
|
44
|
+
opts = {
|
45
|
+
include_custom_fields: true # Boolean | includeCustomFields
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Retrieve a inspection
|
50
|
+
result = api_instance.get_inspection(inspection_id, opts)
|
51
|
+
p result
|
52
|
+
rescue Propertyware::ApiError => e
|
53
|
+
puts "Error when calling InspectionsApi->get_inspection: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the get_inspection_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
60
|
+
|
61
|
+
> <Array(<Inspection>, Integer, Hash)> get_inspection_with_http_info(inspection_id, opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Retrieve a inspection
|
66
|
+
data, status_code, headers = api_instance.get_inspection_with_http_info(inspection_id, opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => <Inspection>
|
70
|
+
rescue Propertyware::ApiError => e
|
71
|
+
puts "Error when calling InspectionsApi->get_inspection_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **inspection_id** | **Integer** | Inspection ID | |
|
80
|
+
| **include_custom_fields** | **Boolean** | includeCustomFields | [optional][default to true] |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**Inspection**](Inspection.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
96
|
+
## get_inspections
|
97
|
+
|
98
|
+
> <Array<Inspection>> get_inspections(opts)
|
99
|
+
|
100
|
+
Retrieve all inspections
|
101
|
+
|
102
|
+
Retrieves a list of inspections.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">INSPECTIONS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>number</code>, <code>lastmodifieddatetime</code>, <code>status</code>, <code>id</code>
|
103
|
+
|
104
|
+
### Examples
|
105
|
+
|
106
|
+
```ruby
|
107
|
+
require 'time'
|
108
|
+
require 'propertyware'
|
109
|
+
# setup authorization
|
110
|
+
Propertyware.configure do |config|
|
111
|
+
# Configure API key authorization: organizationId
|
112
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
113
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
114
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
115
|
+
|
116
|
+
# Configure API key authorization: clientId
|
117
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
118
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
119
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
120
|
+
|
121
|
+
# Configure API key authorization: clientSecret
|
122
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
125
|
+
end
|
126
|
+
|
127
|
+
api_instance = Propertyware::InspectionsApi.new
|
128
|
+
opts = {
|
129
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
130
|
+
limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
|
131
|
+
last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
|
132
|
+
last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
|
133
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
134
|
+
status: 'status_example', # String | Filters results to inspections with a specific status.
|
135
|
+
portfolio_id: 789, # Integer | Filters results to inspections associated with a specific portfolio.
|
136
|
+
building_id: 789, # Integer | Filters results to inspections associated with a specific building.
|
137
|
+
type: 'type_example' # String | Filters results to inspections with a specific type.
|
138
|
+
}
|
139
|
+
|
140
|
+
begin
|
141
|
+
# Retrieve all inspections
|
142
|
+
result = api_instance.get_inspections(opts)
|
143
|
+
p result
|
144
|
+
rescue Propertyware::ApiError => e
|
145
|
+
puts "Error when calling InspectionsApi->get_inspections: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
#### Using the get_inspections_with_http_info variant
|
150
|
+
|
151
|
+
This returns an Array which contains the response data, status code and headers.
|
152
|
+
|
153
|
+
> <Array(<Array<Inspection>>, Integer, Hash)> get_inspections_with_http_info(opts)
|
154
|
+
|
155
|
+
```ruby
|
156
|
+
begin
|
157
|
+
# Retrieve all inspections
|
158
|
+
data, status_code, headers = api_instance.get_inspections_with_http_info(opts)
|
159
|
+
p status_code # => 2xx
|
160
|
+
p headers # => { ... }
|
161
|
+
p data # => <Array<Inspection>>
|
162
|
+
rescue Propertyware::ApiError => e
|
163
|
+
puts "Error when calling InspectionsApi->get_inspections_with_http_info: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
### Parameters
|
168
|
+
|
169
|
+
| Name | Type | Description | Notes |
|
170
|
+
| ---- | ---- | ----------- | ----- |
|
171
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
172
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100. | [optional][default to 100] |
|
173
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
174
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
175
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
176
|
+
| **status** | **String** | Filters results to inspections with a specific status. | [optional] |
|
177
|
+
| **portfolio_id** | **Integer** | Filters results to inspections associated with a specific portfolio. | [optional] |
|
178
|
+
| **building_id** | **Integer** | Filters results to inspections associated with a specific building. | [optional] |
|
179
|
+
| **type** | **String** | Filters results to inspections with a specific type. | [optional] |
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
[**Array<Inspection>**](Inspection.md)
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: Not defined
|
192
|
+
- **Accept**: application/json
|
193
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# Propertyware::JournalEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **comments** | **String** | Comments. | [optional] |
|
8
|
+
| **created_by** | **String** | User who created the record. | [optional] |
|
9
|
+
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
10
|
+
| **date** | **String** | Journal entry post date. | [optional] |
|
11
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
12
|
+
| **journal_entry_split** | [**Array<JournalEntrySplitResponse>**](JournalEntrySplitResponse.md) | List of journal entry splits. | [optional] |
|
13
|
+
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
14
|
+
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
15
|
+
| **lease_id** | **Integer** | Id of the lease associated with this journal entry. | [optional] |
|
16
|
+
| **ref_no** | **String** | Journal entry reference number. | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'propertyware'
|
22
|
+
|
23
|
+
instance = Propertyware::JournalEntry.new(
|
24
|
+
comments: null,
|
25
|
+
created_by: null,
|
26
|
+
created_date_time: null,
|
27
|
+
date: null,
|
28
|
+
id: null,
|
29
|
+
journal_entry_split: null,
|
30
|
+
last_modified_by: null,
|
31
|
+
last_modified_date_time: null,
|
32
|
+
lease_id: null,
|
33
|
+
ref_no: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Propertyware::JournalEntrySplit
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **credit_amount** | **Float** | Credit amount. | |
|
8
|
+
| **debit_amount** | **Float** | Debit amount. | |
|
9
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this journal entry split. | |
|
10
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'propertyware'
|
16
|
+
|
17
|
+
instance = Propertyware::JournalEntrySplit.new(
|
18
|
+
credit_amount: null,
|
19
|
+
debit_amount: null,
|
20
|
+
gl_account_id: null,
|
21
|
+
id: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Propertyware::JournalEntrySplitResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **credit_amount** | **Float** | Credit amount. | |
|
8
|
+
| **debit_amount** | **Float** | Debit amount. | |
|
9
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this journal entry split. | |
|
10
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'propertyware'
|
16
|
+
|
17
|
+
instance = Propertyware::JournalEntrySplitResponse.new(
|
18
|
+
credit_amount: null,
|
19
|
+
debit_amount: null,
|
20
|
+
gl_account_id: null,
|
21
|
+
id: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/LateFeeRule.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Propertyware::LateFeeRule
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **due_day** | **Integer** | Fee due day. | [optional] |
|
8
|
+
| **fee_type** | **String** | Late fee type. | [optional] |
|
9
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
10
|
+
| **minimum_due** | **Float** | Minimum amount due to trigger the late fee process. | [optional] |
|
11
|
+
| **summary** | **String** | Textual description of the late fee calculation. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'propertyware'
|
17
|
+
|
18
|
+
instance = Propertyware::LateFeeRule.new(
|
19
|
+
due_day: null,
|
20
|
+
fee_type: null,
|
21
|
+
id: null,
|
22
|
+
minimum_due: null,
|
23
|
+
summary: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Lease.md
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
# Propertyware::Lease
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active** | **Boolean** | Active | [optional] |
|
8
|
+
| **addendums** | [**Array<LeaseClause>**](LeaseClause.md) | Lease addendums. | [optional] |
|
9
|
+
| **building_id** | **Integer** | Id of the building associated with this lease. | [optional] |
|
10
|
+
| **comments** | **String** | Description of the lease. | [optional] |
|
11
|
+
| **contacts** | [**Array<LeaseContact>**](LeaseContact.md) | Contacts of the lease | [optional] |
|
12
|
+
| **created_by** | **String** | User who created the record. | [optional] |
|
13
|
+
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
14
|
+
| **custom_fields** | [**Array<CustomField>**](CustomField.md) | Custom fields. | [optional] |
|
15
|
+
| **end_date** | **Date** | End date of the lease term. | [optional] |
|
16
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
17
|
+
| **id_number** | **Integer** | Lease identification number. | [optional] |
|
18
|
+
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
19
|
+
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
20
|
+
| **late_fee_rule** | **String** | Textual description of the late fee rule applied to delinquent or unpaid lease charges. | [optional] |
|
21
|
+
| **lease_balance** | **Float** | Lease Balance | [optional] |
|
22
|
+
| **lease_name** | **String** | Lease Name | [optional] |
|
23
|
+
| **location** | **String** | Building and/or units the lease is currently attached to. | [optional] |
|
24
|
+
| **move_in_date** | **Date** | Day that the tenant(s) moved into the property. | [optional] |
|
25
|
+
| **move_out_date** | **Date** | Day that the tenant(s) vacated the property. | [optional] |
|
26
|
+
| **notice_given_date** | **Date** | Day that the tenant(s) turned in a notice to vacate. | [optional] |
|
27
|
+
| **payment_restriction** | **String** | Indicates if the lease has any payment types that they are prevented from using. For example, a lease with several bounced checks may be restricted from paying with checks for future payments. | [optional] |
|
28
|
+
| **portfolio_id** | **Integer** | Id of the portfolio associated with this lease. | [optional] |
|
29
|
+
| **public_assistance_program** | **String** | Indicates if the tenant(s) of the lease receive any aid from a Public Assistance Program. | [optional] |
|
30
|
+
| **reason_for_leaving** | **String** | Reason for vacating the property. | [optional] |
|
31
|
+
| **schedule_move_out_date** | **Date** | Day that the tenant(s) are expected to vacate the property. | [optional] |
|
32
|
+
| **start_date** | **Date** | Start date of the lease term. | [optional] |
|
33
|
+
| **status** | **String** | Lease's current status. | [optional] |
|
34
|
+
| **tenants_opts_into_asset_protection_plan** | **String** | Indicates if the tenants opted into Asset Protection Plan. | [optional] |
|
35
|
+
| **terminated_date** | **Date** | Terminated Date | [optional] |
|
36
|
+
| **unit_id** | **Integer** | Id of the unit associated with this lease. | [optional] |
|
37
|
+
|
38
|
+
## Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
require 'propertyware'
|
42
|
+
|
43
|
+
instance = Propertyware::Lease.new(
|
44
|
+
active: false,
|
45
|
+
addendums: null,
|
46
|
+
building_id: null,
|
47
|
+
comments: null,
|
48
|
+
contacts: null,
|
49
|
+
created_by: null,
|
50
|
+
created_date_time: null,
|
51
|
+
custom_fields: null,
|
52
|
+
end_date: null,
|
53
|
+
id: null,
|
54
|
+
id_number: null,
|
55
|
+
last_modified_by: null,
|
56
|
+
last_modified_date_time: null,
|
57
|
+
late_fee_rule: null,
|
58
|
+
lease_balance: null,
|
59
|
+
lease_name: null,
|
60
|
+
location: null,
|
61
|
+
move_in_date: null,
|
62
|
+
move_out_date: null,
|
63
|
+
notice_given_date: null,
|
64
|
+
payment_restriction: null,
|
65
|
+
portfolio_id: null,
|
66
|
+
public_assistance_program: null,
|
67
|
+
reason_for_leaving: null,
|
68
|
+
schedule_move_out_date: null,
|
69
|
+
start_date: null,
|
70
|
+
status: null,
|
71
|
+
tenants_opts_into_asset_protection_plan: null,
|
72
|
+
terminated_date: null,
|
73
|
+
unit_id: null
|
74
|
+
)
|
75
|
+
```
|
76
|
+
|
data/docs/LeaseClause.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Propertyware::LeaseClause
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | Description of the clause. | [optional] |
|
8
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
9
|
+
| **name** | **String** | Name of the clause. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'propertyware'
|
15
|
+
|
16
|
+
instance = Propertyware::LeaseClause.new(
|
17
|
+
description: null,
|
18
|
+
id: null,
|
19
|
+
name: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# Propertyware::LeaseContact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **company** | **String** | Company where the contact is employed. | [optional] |
|
8
|
+
| **email** | **String** | E-mail address. | [optional] |
|
9
|
+
| **first_name** | **String** | First name. | [optional] |
|
10
|
+
| **home_phone** | **String** | Home phone. | [optional] |
|
11
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
12
|
+
| **last_name** | **String** | Last name. | [optional] |
|
13
|
+
| **mobile_phone** | **String** | Mobile phone. | [optional] |
|
14
|
+
| **named_on_lease** | **Boolean** | Indicates if contact is named on lease. | [optional] |
|
15
|
+
| **primary** | **Boolean** | Indicates if contact is primary contact of the lease. | [optional] |
|
16
|
+
| **work_phone** | **String** | Work phone. | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'propertyware'
|
22
|
+
|
23
|
+
instance = Propertyware::LeaseContact.new(
|
24
|
+
company: null,
|
25
|
+
email: null,
|
26
|
+
first_name: null,
|
27
|
+
home_phone: null,
|
28
|
+
id: null,
|
29
|
+
last_name: null,
|
30
|
+
mobile_phone: null,
|
31
|
+
named_on_lease: false,
|
32
|
+
primary: false,
|
33
|
+
work_phone: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|