propertyware 1.0.5 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +21 -0
- data/DOCS.md +23 -4
- data/Gemfile.lock +2 -2
- data/bin/config.yml +1 -1
- data/bin/fix_json.rb +8 -7
- data/bin/propertyware.json +16549 -1
- data/docs/AutoPayment.md +2 -0
- data/docs/Building.md +2 -2
- data/docs/Charge.md +4 -2
- data/docs/CreditMemo.md +42 -0
- data/docs/CustomFieldDefinition.md +26 -0
- data/docs/CustomFieldFieldsApi.md +89 -0
- data/docs/Document.md +7 -7
- data/docs/DocumentsApi.md +260 -2
- data/docs/Lease.md +12 -6
- data/docs/LeaseStatus.md +28 -0
- data/docs/LeasesApi.md +181 -0
- data/docs/Note.md +9 -3
- data/docs/Prospect.md +4 -0
- data/docs/ProspectContact.md +30 -0
- data/docs/ProspectStatus.md +24 -0
- data/docs/ProspectsApi.md +79 -0
- data/docs/SaveBuilding.md +2 -2
- data/docs/SaveContact.md +1 -1
- data/docs/SaveLease.md +16 -6
- data/docs/SaveUnit.md +6 -6
- data/docs/SaveVendor.md +31 -1
- data/docs/SaveWorkOrder.md +13 -1
- data/docs/Unit.md +2 -2
- data/docs/UpdateDocument.md +24 -0
- data/docs/Vendor.md +18 -0
- data/docs/WorkOrder.md +8 -0
- data/docs/WorkOrdersApi.md +2 -2
- data/lib/propertyware/api/accounting_api.rb +1 -1
- data/lib/propertyware/api/bills_api.rb +1 -1
- data/lib/propertyware/api/buildings_api.rb +1 -1
- data/lib/propertyware/api/contacts_api.rb +1 -1
- data/lib/propertyware/api/custom_field_fields_api.rb +85 -0
- data/lib/propertyware/api/documents_api.rb +228 -3
- data/lib/propertyware/api/health_check_api.rb +1 -1
- data/lib/propertyware/api/inspections_api.rb +1 -1
- data/lib/propertyware/api/leases_api.rb +145 -1
- data/lib/propertyware/api/portfolios_api.rb +1 -1
- data/lib/propertyware/api/prospects_api.rb +58 -1
- data/lib/propertyware/api/units_api.rb +1 -1
- data/lib/propertyware/api/vendors_api.rb +1 -1
- data/lib/propertyware/api/work_orders_api.rb +1 -1
- data/lib/propertyware/api_client.rb +1 -1
- data/lib/propertyware/api_error.rb +1 -1
- data/lib/propertyware/configuration.rb +1 -1
- data/lib/propertyware/models/account.rb +1 -1
- data/lib/propertyware/models/address.rb +1 -1
- data/lib/propertyware/models/amenity.rb +1 -1
- data/lib/propertyware/models/auto_journal_entry.rb +35 -1
- data/lib/propertyware/models/auto_payment.rb +46 -2
- data/lib/propertyware/models/bank.rb +1 -1
- data/lib/propertyware/models/bank_deposit.rb +1 -1
- data/lib/propertyware/models/basic_vendor.rb +1 -1
- data/lib/propertyware/models/bill.rb +1 -1
- data/lib/propertyware/models/bill_paid.rb +1 -1
- data/lib/propertyware/models/bill_pay.rb +1 -1
- data/lib/propertyware/models/bill_payment.rb +1 -1
- data/lib/propertyware/models/bill_split.rb +1 -1
- data/lib/propertyware/models/building.rb +15 -3
- data/lib/propertyware/models/campaign.rb +1 -1
- data/lib/propertyware/models/campaign_source.rb +1 -1
- data/lib/propertyware/models/charge.rb +48 -4
- data/lib/propertyware/models/charge_tx.rb +1 -1
- data/lib/propertyware/models/check.rb +1 -1
- data/lib/propertyware/models/check_split.rb +1 -1
- data/lib/propertyware/models/comment.rb +1 -1
- data/lib/propertyware/models/contact.rb +1 -1
- data/lib/propertyware/models/conversation.rb +1 -1
- data/lib/propertyware/models/credit_card_account.rb +1 -1
- data/lib/propertyware/models/credit_memo.rb +349 -0
- data/lib/propertyware/models/current_asset.rb +1 -1
- data/lib/propertyware/models/current_liability.rb +1 -1
- data/lib/propertyware/models/custom_field.rb +1 -1
- data/lib/propertyware/models/custom_field_definition.rb +254 -0
- data/lib/propertyware/models/discount.rb +1 -1
- data/lib/propertyware/models/document.rb +35 -35
- data/lib/propertyware/models/entry.rb +1 -1
- data/lib/propertyware/models/equity.rb +1 -1
- data/lib/propertyware/models/error_response.rb +1 -1
- data/lib/propertyware/models/expense.rb +1 -1
- data/lib/propertyware/models/gl_item.rb +1 -1
- data/lib/propertyware/models/income.rb +1 -1
- data/lib/propertyware/models/inspection.rb +1 -1
- data/lib/propertyware/models/inspection_area.rb +1 -1
- data/lib/propertyware/models/inspection_item.rb +1 -1
- data/lib/propertyware/models/journal_entry.rb +1 -1
- data/lib/propertyware/models/journal_entry_split.rb +1 -1
- data/lib/propertyware/models/journal_entry_split_response.rb +1 -1
- data/lib/propertyware/models/late_fee_rule.rb +1 -1
- data/lib/propertyware/models/lease.rb +38 -8
- data/lib/propertyware/models/lease_clause.rb +1 -1
- data/lib/propertyware/models/lease_contact.rb +1 -1
- data/lib/propertyware/models/lease_status.rb +263 -0
- data/lib/propertyware/models/management_fee.rb +1 -1
- data/lib/propertyware/models/management_settings.rb +1 -1
- data/lib/propertyware/models/marketing.rb +1 -1
- data/lib/propertyware/models/non_current_asset.rb +1 -1
- data/lib/propertyware/models/non_current_liability.rb +1 -1
- data/lib/propertyware/models/non_operating_expense.rb +1 -1
- data/lib/propertyware/models/non_operating_inome.rb +1 -1
- data/lib/propertyware/models/note.rb +45 -15
- data/lib/propertyware/models/owner.rb +1 -1
- data/lib/propertyware/models/owner_contribution.rb +1 -1
- data/lib/propertyware/models/owner_draw.rb +1 -1
- data/lib/propertyware/models/payment.rb +1 -1
- data/lib/propertyware/models/payment_charge.rb +1 -1
- data/lib/propertyware/models/portfolio.rb +1 -1
- data/lib/propertyware/models/property_manager.rb +1 -1
- data/lib/propertyware/models/prospect.rb +24 -2
- data/lib/propertyware/models/prospect_contact.rb +279 -0
- data/lib/propertyware/models/prospect_status.rb +249 -0
- data/lib/propertyware/models/refund.rb +1 -1
- data/lib/propertyware/models/response_entity.rb +1 -1
- data/lib/propertyware/models/restapi_bulk_error_response.rb +1 -1
- data/lib/propertyware/models/restapi_bulk_success_response.rb +1 -1
- data/lib/propertyware/models/restapi_error.rb +1 -1
- data/lib/propertyware/models/save_account.rb +1 -1
- data/lib/propertyware/models/save_address.rb +2 -2
- data/lib/propertyware/models/save_adjustment.rb +1 -1
- data/lib/propertyware/models/save_auto_charge.rb +1 -1
- data/lib/propertyware/models/save_bank_deposit.rb +1 -1
- data/lib/propertyware/models/save_bill.rb +1 -1
- data/lib/propertyware/models/save_bill_payment.rb +1 -1
- data/lib/propertyware/models/save_bill_split.rb +1 -1
- data/lib/propertyware/models/save_building.rb +4 -4
- data/lib/propertyware/models/save_charge.rb +1 -1
- data/lib/propertyware/models/save_check.rb +1 -1
- data/lib/propertyware/models/save_check_split.rb +1 -1
- data/lib/propertyware/models/save_comment.rb +1 -1
- data/lib/propertyware/models/save_contact.rb +250 -2
- data/lib/propertyware/models/save_conversation.rb +1 -1
- data/lib/propertyware/models/save_credit.rb +1 -1
- data/lib/propertyware/models/save_discount.rb +1 -1
- data/lib/propertyware/models/save_journal_entry_split.rb +1 -1
- data/lib/propertyware/models/save_lease.rb +58 -8
- data/lib/propertyware/models/save_lease_journal_entry.rb +1 -1
- data/lib/propertyware/models/save_owner.rb +1 -1
- data/lib/propertyware/models/save_owner_contribution.rb +1 -1
- data/lib/propertyware/models/save_owner_draw.rb +1 -1
- data/lib/propertyware/models/save_payment.rb +1 -1
- data/lib/propertyware/models/save_portfolio.rb +1 -1
- data/lib/propertyware/models/save_prospect.rb +1 -1
- data/lib/propertyware/models/save_prospect_contact.rb +1 -1
- data/lib/propertyware/models/save_refund.rb +1 -1
- data/lib/propertyware/models/save_unit.rb +189 -17
- data/lib/propertyware/models/save_vendor.rb +187 -3
- data/lib/propertyware/models/save_work_order.rb +79 -2
- data/lib/propertyware/models/save_work_order_task.rb +1 -1
- data/lib/propertyware/models/split_paid.rb +1 -1
- data/lib/propertyware/models/split_pay.rb +1 -1
- data/lib/propertyware/models/task.rb +1 -1
- data/lib/propertyware/models/transaction.rb +1 -1
- data/lib/propertyware/models/unit.rb +15 -3
- data/lib/propertyware/models/update_document.rb +254 -0
- data/lib/propertyware/models/update_lease_journal_entry.rb +1 -1
- data/lib/propertyware/models/vendor.rb +92 -2
- data/lib/propertyware/models/work_order.rb +54 -2
- data/lib/propertyware/version.rb +2 -2
- data/lib/propertyware.rb +8 -1
- data/propertyware.gemspec +1 -1
- data/spec/api/accounting_api_spec.rb +1 -1
- data/spec/api/bills_api_spec.rb +1 -1
- data/spec/api/buildings_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +1 -1
- data/spec/api/custom_field_fields_api_spec.rb +47 -0
- data/spec/api/documents_api_spec.rb +43 -2
- data/spec/api/health_check_api_spec.rb +1 -1
- data/spec/api/inspections_api_spec.rb +1 -1
- data/spec/api/leases_api_spec.rb +33 -1
- data/spec/api/portfolios_api_spec.rb +1 -1
- data/spec/api/prospects_api_spec.rb +12 -1
- data/spec/api/units_api_spec.rb +1 -1
- data/spec/api/vendors_api_spec.rb +1 -1
- data/spec/api/work_orders_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/amenity_spec.rb +1 -1
- data/spec/models/auto_journal_entry_spec.rb +5 -1
- data/spec/models/auto_payment_spec.rb +11 -1
- data/spec/models/bank_deposit_spec.rb +1 -1
- data/spec/models/bank_spec.rb +1 -1
- data/spec/models/basic_vendor_spec.rb +1 -1
- data/spec/models/bill_paid_spec.rb +1 -1
- data/spec/models/bill_pay_spec.rb +1 -1
- data/spec/models/bill_payment_spec.rb +1 -1
- data/spec/models/bill_spec.rb +1 -1
- data/spec/models/bill_split_spec.rb +1 -1
- data/spec/models/building_spec.rb +5 -1
- data/spec/models/campaign_source_spec.rb +1 -1
- data/spec/models/campaign_spec.rb +1 -1
- data/spec/models/charge_spec.rb +11 -1
- data/spec/models/charge_tx_spec.rb +1 -1
- data/spec/models/check_spec.rb +1 -1
- data/spec/models/check_split_spec.rb +1 -1
- data/spec/models/comment_spec.rb +1 -1
- data/spec/models/contact_spec.rb +1 -1
- data/spec/models/conversation_spec.rb +1 -1
- data/spec/models/credit_card_account_spec.rb +1 -1
- data/spec/models/credit_memo_spec.rb +106 -0
- data/spec/models/current_asset_spec.rb +1 -1
- data/spec/models/current_liability_spec.rb +1 -1
- data/spec/models/custom_field_definition_spec.rb +58 -0
- data/spec/models/custom_field_spec.rb +1 -1
- data/spec/models/discount_spec.rb +1 -1
- data/spec/models/document_spec.rb +7 -7
- data/spec/models/entry_spec.rb +1 -1
- data/spec/models/equity_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/expense_spec.rb +1 -1
- data/spec/models/gl_item_spec.rb +1 -1
- data/spec/models/income_spec.rb +1 -1
- data/spec/models/inspection_area_spec.rb +1 -1
- data/spec/models/inspection_item_spec.rb +1 -1
- data/spec/models/inspection_spec.rb +1 -1
- data/spec/models/journal_entry_spec.rb +1 -1
- data/spec/models/journal_entry_split_response_spec.rb +1 -1
- data/spec/models/journal_entry_split_spec.rb +1 -1
- data/spec/models/late_fee_rule_spec.rb +1 -1
- data/spec/models/lease_clause_spec.rb +1 -1
- data/spec/models/lease_contact_spec.rb +1 -1
- data/spec/models/lease_spec.rb +19 -1
- data/spec/models/lease_status_spec.rb +64 -0
- data/spec/models/management_fee_spec.rb +1 -1
- data/spec/models/management_settings_spec.rb +1 -1
- data/spec/models/marketing_spec.rb +1 -1
- data/spec/models/non_current_asset_spec.rb +1 -1
- data/spec/models/non_current_liability_spec.rb +1 -1
- data/spec/models/non_operating_expense_spec.rb +1 -1
- data/spec/models/non_operating_inome_spec.rb +1 -1
- data/spec/models/note_spec.rb +22 -4
- data/spec/models/owner_contribution_spec.rb +1 -1
- data/spec/models/owner_draw_spec.rb +1 -1
- data/spec/models/owner_spec.rb +1 -1
- data/spec/models/payment_charge_spec.rb +1 -1
- data/spec/models/payment_spec.rb +1 -1
- data/spec/models/portfolio_spec.rb +1 -1
- data/spec/models/property_manager_spec.rb +1 -1
- data/spec/models/prospect_contact_spec.rb +70 -0
- data/spec/models/prospect_spec.rb +13 -1
- data/spec/models/prospect_status_spec.rb +52 -0
- data/spec/models/refund_spec.rb +1 -1
- data/spec/models/response_entity_spec.rb +1 -1
- data/spec/models/restapi_bulk_error_response_spec.rb +1 -1
- data/spec/models/restapi_bulk_success_response_spec.rb +1 -1
- data/spec/models/restapi_error_spec.rb +1 -1
- data/spec/models/save_account_spec.rb +1 -1
- data/spec/models/save_address_spec.rb +1 -1
- data/spec/models/save_adjustment_spec.rb +1 -1
- data/spec/models/save_auto_charge_spec.rb +1 -1
- data/spec/models/save_bank_deposit_spec.rb +1 -1
- data/spec/models/save_bill_payment_spec.rb +1 -1
- data/spec/models/save_bill_spec.rb +1 -1
- data/spec/models/save_bill_split_spec.rb +1 -1
- data/spec/models/save_building_spec.rb +1 -1
- data/spec/models/save_charge_spec.rb +1 -1
- data/spec/models/save_check_spec.rb +1 -1
- data/spec/models/save_check_split_spec.rb +1 -1
- data/spec/models/save_comment_spec.rb +1 -1
- data/spec/models/save_contact_spec.rb +1 -1
- data/spec/models/save_conversation_spec.rb +1 -1
- data/spec/models/save_credit_spec.rb +1 -1
- data/spec/models/save_discount_spec.rb +1 -1
- data/spec/models/save_journal_entry_split_spec.rb +1 -1
- data/spec/models/save_lease_journal_entry_spec.rb +1 -1
- data/spec/models/save_lease_spec.rb +31 -1
- data/spec/models/save_owner_contribution_spec.rb +1 -1
- data/spec/models/save_owner_draw_spec.rb +1 -1
- data/spec/models/save_owner_spec.rb +1 -1
- data/spec/models/save_payment_spec.rb +1 -1
- data/spec/models/save_portfolio_spec.rb +1 -1
- data/spec/models/save_prospect_contact_spec.rb +1 -1
- data/spec/models/save_prospect_spec.rb +1 -1
- data/spec/models/save_refund_spec.rb +1 -1
- data/spec/models/save_unit_spec.rb +23 -7
- data/spec/models/save_vendor_spec.rb +95 -1
- data/spec/models/save_work_order_spec.rb +41 -1
- data/spec/models/save_work_order_task_spec.rb +1 -1
- data/spec/models/split_paid_spec.rb +1 -1
- data/spec/models/split_pay_spec.rb +1 -1
- data/spec/models/task_spec.rb +1 -1
- data/spec/models/transaction_spec.rb +1 -1
- data/spec/models/unit_spec.rb +5 -1
- data/spec/models/update_document_spec.rb +52 -0
- data/spec/models/update_lease_journal_entry_spec.rb +1 -1
- data/spec/models/vendor_spec.rb +55 -1
- data/spec/models/work_order_spec.rb +29 -1
- data/spec/spec_helper.rb +1 -1
- metadata +30 -2
data/docs/LeasesApi.md
CHANGED
@@ -16,6 +16,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
16
16
|
| [**create_lease_refund**](LeasesApi.md#create_lease_refund) | **POST** /leases/refunds | Create a lease refund (BETA) |
|
17
17
|
| [**delete_lease**](LeasesApi.md#delete_lease) | **DELETE** /leases/{leaseID} | Delete a lease (BETA) |
|
18
18
|
| [**delete_lease_conversation**](LeasesApi.md#delete_lease_conversation) | **DELETE** /leases/{leaseID}/conversations/{conversationID} | Delete a lease conversation (BETA) |
|
19
|
+
| [**get_all_lease_statuses**](LeasesApi.md#get_all_lease_statuses) | **GET** /leases/statuses | Retrieve all lease statuses (BETA) |
|
19
20
|
| [**get_lease**](LeasesApi.md#get_lease) | **GET** /leases/{leaseId} | Retrieve a lease |
|
20
21
|
| [**get_lease_adjustments**](LeasesApi.md#get_lease_adjustments) | **GET** /leases/adjustments | Retrieve all the adjustments |
|
21
22
|
| [**get_lease_auto_charges**](LeasesApi.md#get_lease_auto_charges) | **GET** /leases/{leaseId}/autocharges | Retrieve all lease auto charges |
|
@@ -25,6 +26,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
25
26
|
| [**get_lease_contacts**](LeasesApi.md#get_lease_contacts) | **GET** /leases/{leaseId}/contacts | Retrieve all lease contacts |
|
26
27
|
| [**get_lease_conversation**](LeasesApi.md#get_lease_conversation) | **GET** /leases/{leaseID}/conversations/{conversationID} | Retrieve a lease conversation |
|
27
28
|
| [**get_lease_conversations**](LeasesApi.md#get_lease_conversations) | **GET** /leases/{leaseID}/conversations | Retrieve all lease conversations |
|
29
|
+
| [**get_lease_credit_memos**](LeasesApi.md#get_lease_credit_memos) | **GET** /leases/creditmemos | Retrieve all the credit memos |
|
28
30
|
| [**get_lease_custom_fields**](LeasesApi.md#get_lease_custom_fields) | **GET** /leases/{leaseId}/customfields | Retrieve all lease custom fields |
|
29
31
|
| [**get_lease_discounts**](LeasesApi.md#get_lease_discounts) | **GET** /leases/discounts | Retrieve all the lease discounts |
|
30
32
|
| [**get_lease_documents**](LeasesApi.md#get_lease_documents) | **GET** /leases/{leaseId}/document | Retrieve all lease documents |
|
@@ -1024,6 +1026,84 @@ end
|
|
1024
1026
|
- **Accept**: application/json
|
1025
1027
|
|
1026
1028
|
|
1029
|
+
## get_all_lease_statuses
|
1030
|
+
|
1031
|
+
> <Array<LeaseStatus>> get_all_lease_statuses
|
1032
|
+
|
1033
|
+
Retrieve all lease statuses (BETA)
|
1034
|
+
|
1035
|
+
<p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all lease statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code>
|
1036
|
+
|
1037
|
+
### Examples
|
1038
|
+
|
1039
|
+
```ruby
|
1040
|
+
require 'time'
|
1041
|
+
require 'propertyware'
|
1042
|
+
# setup authorization
|
1043
|
+
Propertyware.configure do |config|
|
1044
|
+
# Configure API key authorization: organizationId
|
1045
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1046
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1047
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1048
|
+
|
1049
|
+
# Configure API key authorization: clientId
|
1050
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1051
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1052
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1053
|
+
|
1054
|
+
# Configure API key authorization: clientSecret
|
1055
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1056
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1057
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1058
|
+
end
|
1059
|
+
|
1060
|
+
api_instance = Propertyware::LeasesApi.new
|
1061
|
+
|
1062
|
+
begin
|
1063
|
+
# Retrieve all lease statuses (BETA)
|
1064
|
+
result = api_instance.get_all_lease_statuses
|
1065
|
+
p result
|
1066
|
+
rescue Propertyware::ApiError => e
|
1067
|
+
puts "Error when calling LeasesApi->get_all_lease_statuses: #{e}"
|
1068
|
+
end
|
1069
|
+
```
|
1070
|
+
|
1071
|
+
#### Using the get_all_lease_statuses_with_http_info variant
|
1072
|
+
|
1073
|
+
This returns an Array which contains the response data, status code and headers.
|
1074
|
+
|
1075
|
+
> <Array(<Array<LeaseStatus>>, Integer, Hash)> get_all_lease_statuses_with_http_info
|
1076
|
+
|
1077
|
+
```ruby
|
1078
|
+
begin
|
1079
|
+
# Retrieve all lease statuses (BETA)
|
1080
|
+
data, status_code, headers = api_instance.get_all_lease_statuses_with_http_info
|
1081
|
+
p status_code # => 2xx
|
1082
|
+
p headers # => { ... }
|
1083
|
+
p data # => <Array<LeaseStatus>>
|
1084
|
+
rescue Propertyware::ApiError => e
|
1085
|
+
puts "Error when calling LeasesApi->get_all_lease_statuses_with_http_info: #{e}"
|
1086
|
+
end
|
1087
|
+
```
|
1088
|
+
|
1089
|
+
### Parameters
|
1090
|
+
|
1091
|
+
This endpoint does not need any parameter.
|
1092
|
+
|
1093
|
+
### Return type
|
1094
|
+
|
1095
|
+
[**Array<LeaseStatus>**](LeaseStatus.md)
|
1096
|
+
|
1097
|
+
### Authorization
|
1098
|
+
|
1099
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1100
|
+
|
1101
|
+
### HTTP request headers
|
1102
|
+
|
1103
|
+
- **Content-Type**: Not defined
|
1104
|
+
- **Accept**: application/json
|
1105
|
+
|
1106
|
+
|
1027
1107
|
## get_lease
|
1028
1108
|
|
1029
1109
|
> <Lease> get_lease(lease_id, opts)
|
@@ -1817,6 +1897,107 @@ end
|
|
1817
1897
|
- **Accept**: application/json
|
1818
1898
|
|
1819
1899
|
|
1900
|
+
## get_lease_credit_memos
|
1901
|
+
|
1902
|
+
> <Array<CreditMemo>> get_lease_credit_memos(opts)
|
1903
|
+
|
1904
|
+
Retrieve all the credit memos
|
1905
|
+
|
1906
|
+
Retrieves a list of credit memos.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
|
1907
|
+
|
1908
|
+
### Examples
|
1909
|
+
|
1910
|
+
```ruby
|
1911
|
+
require 'time'
|
1912
|
+
require 'propertyware'
|
1913
|
+
# setup authorization
|
1914
|
+
Propertyware.configure do |config|
|
1915
|
+
# Configure API key authorization: organizationId
|
1916
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1917
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1918
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1919
|
+
|
1920
|
+
# Configure API key authorization: clientId
|
1921
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1922
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1923
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1924
|
+
|
1925
|
+
# Configure API key authorization: clientSecret
|
1926
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1927
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1928
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1929
|
+
end
|
1930
|
+
|
1931
|
+
api_instance = Propertyware::LeasesApi.new
|
1932
|
+
opts = {
|
1933
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
1934
|
+
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.
|
1935
|
+
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.
|
1936
|
+
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.
|
1937
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
1938
|
+
post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
|
1939
|
+
post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
|
1940
|
+
portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
|
1941
|
+
lease_id: 789, # Integer | Filters results with Lease ID.
|
1942
|
+
status: 'status_example' # String | Filters results to with Lease Status.
|
1943
|
+
}
|
1944
|
+
|
1945
|
+
begin
|
1946
|
+
# Retrieve all the credit memos
|
1947
|
+
result = api_instance.get_lease_credit_memos(opts)
|
1948
|
+
p result
|
1949
|
+
rescue Propertyware::ApiError => e
|
1950
|
+
puts "Error when calling LeasesApi->get_lease_credit_memos: #{e}"
|
1951
|
+
end
|
1952
|
+
```
|
1953
|
+
|
1954
|
+
#### Using the get_lease_credit_memos_with_http_info variant
|
1955
|
+
|
1956
|
+
This returns an Array which contains the response data, status code and headers.
|
1957
|
+
|
1958
|
+
> <Array(<Array<CreditMemo>>, Integer, Hash)> get_lease_credit_memos_with_http_info(opts)
|
1959
|
+
|
1960
|
+
```ruby
|
1961
|
+
begin
|
1962
|
+
# Retrieve all the credit memos
|
1963
|
+
data, status_code, headers = api_instance.get_lease_credit_memos_with_http_info(opts)
|
1964
|
+
p status_code # => 2xx
|
1965
|
+
p headers # => { ... }
|
1966
|
+
p data # => <Array<CreditMemo>>
|
1967
|
+
rescue Propertyware::ApiError => e
|
1968
|
+
puts "Error when calling LeasesApi->get_lease_credit_memos_with_http_info: #{e}"
|
1969
|
+
end
|
1970
|
+
```
|
1971
|
+
|
1972
|
+
### Parameters
|
1973
|
+
|
1974
|
+
| Name | Type | Description | Notes |
|
1975
|
+
| ---- | ---- | ----------- | ----- |
|
1976
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
1977
|
+
| **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] |
|
1978
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
1979
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
1980
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
1981
|
+
| **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
|
1982
|
+
| **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
|
1983
|
+
| **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
|
1984
|
+
| **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
|
1985
|
+
| **status** | **String** | Filters results to with Lease Status. | [optional] |
|
1986
|
+
|
1987
|
+
### Return type
|
1988
|
+
|
1989
|
+
[**Array<CreditMemo>**](CreditMemo.md)
|
1990
|
+
|
1991
|
+
### Authorization
|
1992
|
+
|
1993
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1994
|
+
|
1995
|
+
### HTTP request headers
|
1996
|
+
|
1997
|
+
- **Content-Type**: Not defined
|
1998
|
+
- **Accept**: application/json
|
1999
|
+
|
2000
|
+
|
1820
2001
|
## get_lease_custom_fields
|
1821
2002
|
|
1822
2003
|
> <Array<CustomField>> get_lease_custom_fields(lease_id)
|
data/docs/Note.md
CHANGED
@@ -5,11 +5,14 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **body** | **String** | Content of the note. | [optional] |
|
8
|
+
| **created_by** | **String** | User who created the record. | [optional] |
|
9
|
+
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
8
10
|
| **date** | **Date** | Date the note was created. | [optional] |
|
9
11
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
12
|
+
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
13
|
+
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
10
14
|
| **private** | **Boolean** | | [optional] |
|
11
15
|
| **subject** | **String** | Subject. | [optional] |
|
12
|
-
| **type** | **String** | Note type. | [optional] |
|
13
16
|
|
14
17
|
## Example
|
15
18
|
|
@@ -18,11 +21,14 @@ require 'propertyware'
|
|
18
21
|
|
19
22
|
instance = Propertyware::Note.new(
|
20
23
|
body: null,
|
24
|
+
created_by: null,
|
25
|
+
created_date_time: null,
|
21
26
|
date: null,
|
22
27
|
id: null,
|
28
|
+
last_modified_by: null,
|
29
|
+
last_modified_date_time: null,
|
23
30
|
private: null,
|
24
|
-
subject: null
|
25
|
-
type: null
|
31
|
+
subject: null
|
26
32
|
)
|
27
33
|
```
|
28
34
|
|
data/docs/Prospect.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **building_id** | **Integer** | Id of the building associated with the prospect. | [optional] |
|
10
10
|
| **city_desired** | **String** | Desired city. | [optional] |
|
11
11
|
| **comments** | **String** | Indicates if the prospect has any comments. | [optional] |
|
12
|
+
| **contacts** | [**Array<ProspectContact>**](ProspectContact.md) | Contacts of the prospect | [optional] |
|
12
13
|
| **created_by** | **String** | User who created the record. | [optional] |
|
13
14
|
| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
|
14
15
|
| **current_home_type** | **String** | Current home type. | [optional] |
|
@@ -51,6 +52,7 @@
|
|
51
52
|
| **type** | **String** | Prospect type. | [optional] |
|
52
53
|
| **type_of_inquiry** | **String** | Type of inquiry made by the prospect. | [optional] |
|
53
54
|
| **unit_desired** | **String** | Desired unit. | [optional] |
|
55
|
+
| **unit_id** | **Integer** | Id of the unit associated with the prospect. | [optional] |
|
54
56
|
| **unit_type_desired** | **String** | Desired unit type. | [optional] |
|
55
57
|
| **zip_desired** | **String** | Desired zip code. | [optional] |
|
56
58
|
|
@@ -65,6 +67,7 @@ instance = Propertyware::Prospect.new(
|
|
65
67
|
building_id: null,
|
66
68
|
city_desired: null,
|
67
69
|
comments: null,
|
70
|
+
contacts: null,
|
68
71
|
created_by: null,
|
69
72
|
created_date_time: null,
|
70
73
|
current_home_type: null,
|
@@ -107,6 +110,7 @@ instance = Propertyware::Prospect.new(
|
|
107
110
|
type: null,
|
108
111
|
type_of_inquiry: null,
|
109
112
|
unit_desired: null,
|
113
|
+
unit_id: null,
|
110
114
|
unit_type_desired: null,
|
111
115
|
zip_desired: null
|
112
116
|
)
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Propertyware::ProspectContact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | E-mail address. | [optional] |
|
8
|
+
| **first_name** | **String** | First name. | [optional] |
|
9
|
+
| **home_phone** | **String** | Home phone. | [optional] |
|
10
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
11
|
+
| **last_name** | **String** | Last name. | [optional] |
|
12
|
+
| **mobile_phone** | **String** | Mobile phone. | [optional] |
|
13
|
+
| **work_phone** | **String** | Work phone. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'propertyware'
|
19
|
+
|
20
|
+
instance = Propertyware::ProspectContact.new(
|
21
|
+
email: null,
|
22
|
+
first_name: null,
|
23
|
+
home_phone: null,
|
24
|
+
id: null,
|
25
|
+
last_name: null,
|
26
|
+
mobile_phone: null,
|
27
|
+
work_phone: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Propertyware::ProspectStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | Unique identifier. | [optional] |
|
8
|
+
| **readonly** | **Boolean** | Read Only | [optional] |
|
9
|
+
| **status** | **String** | Status | [optional] |
|
10
|
+
| **visible_on_portal** | **Boolean** | Status visible On Portal | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'propertyware'
|
16
|
+
|
17
|
+
instance = Propertyware::ProspectStatus.new(
|
18
|
+
id: null,
|
19
|
+
readonly: false,
|
20
|
+
status: null,
|
21
|
+
visible_on_portal: false
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/ProspectsApi.md
CHANGED
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
12
12
|
| [**get_prospect_campaign**](ProspectsApi.md#get_prospect_campaign) | **GET** /prospects/{prospectID}/campaign | Retrieve prospect campaign |
|
13
13
|
| [**get_prospect_conversation**](ProspectsApi.md#get_prospect_conversation) | **GET** /prospects/{prospectID}/conversations/{conversationID} | Retrieve a prospect conversation |
|
14
14
|
| [**get_prospect_conversations**](ProspectsApi.md#get_prospect_conversations) | **GET** /prospects/{prospectID}/conversations | Retrieve all prospect conversations |
|
15
|
+
| [**get_prospect_statuses**](ProspectsApi.md#get_prospect_statuses) | **GET** /prospects/statuses | Retrieve all prospect statuses (BETA) |
|
15
16
|
| [**get_prospects**](ProspectsApi.md#get_prospects) | **GET** /prospects | Retrieve all prospects |
|
16
17
|
|
17
18
|
|
@@ -687,6 +688,84 @@ end
|
|
687
688
|
- **Accept**: application/json
|
688
689
|
|
689
690
|
|
691
|
+
## get_prospect_statuses
|
692
|
+
|
693
|
+
> <Array<ProspectStatus>> get_prospect_statuses
|
694
|
+
|
695
|
+
Retrieve all prospect statuses (BETA)
|
696
|
+
|
697
|
+
<p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all prospect statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code>
|
698
|
+
|
699
|
+
### Examples
|
700
|
+
|
701
|
+
```ruby
|
702
|
+
require 'time'
|
703
|
+
require 'propertyware'
|
704
|
+
# setup authorization
|
705
|
+
Propertyware.configure do |config|
|
706
|
+
# Configure API key authorization: organizationId
|
707
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
708
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
709
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
710
|
+
|
711
|
+
# Configure API key authorization: clientId
|
712
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
713
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
714
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
715
|
+
|
716
|
+
# Configure API key authorization: clientSecret
|
717
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
718
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
719
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
720
|
+
end
|
721
|
+
|
722
|
+
api_instance = Propertyware::ProspectsApi.new
|
723
|
+
|
724
|
+
begin
|
725
|
+
# Retrieve all prospect statuses (BETA)
|
726
|
+
result = api_instance.get_prospect_statuses
|
727
|
+
p result
|
728
|
+
rescue Propertyware::ApiError => e
|
729
|
+
puts "Error when calling ProspectsApi->get_prospect_statuses: #{e}"
|
730
|
+
end
|
731
|
+
```
|
732
|
+
|
733
|
+
#### Using the get_prospect_statuses_with_http_info variant
|
734
|
+
|
735
|
+
This returns an Array which contains the response data, status code and headers.
|
736
|
+
|
737
|
+
> <Array(<Array<ProspectStatus>>, Integer, Hash)> get_prospect_statuses_with_http_info
|
738
|
+
|
739
|
+
```ruby
|
740
|
+
begin
|
741
|
+
# Retrieve all prospect statuses (BETA)
|
742
|
+
data, status_code, headers = api_instance.get_prospect_statuses_with_http_info
|
743
|
+
p status_code # => 2xx
|
744
|
+
p headers # => { ... }
|
745
|
+
p data # => <Array<ProspectStatus>>
|
746
|
+
rescue Propertyware::ApiError => e
|
747
|
+
puts "Error when calling ProspectsApi->get_prospect_statuses_with_http_info: #{e}"
|
748
|
+
end
|
749
|
+
```
|
750
|
+
|
751
|
+
### Parameters
|
752
|
+
|
753
|
+
This endpoint does not need any parameter.
|
754
|
+
|
755
|
+
### Return type
|
756
|
+
|
757
|
+
[**Array<ProspectStatus>**](ProspectStatus.md)
|
758
|
+
|
759
|
+
### Authorization
|
760
|
+
|
761
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
762
|
+
|
763
|
+
### HTTP request headers
|
764
|
+
|
765
|
+
- **Content-Type**: Not defined
|
766
|
+
- **Accept**: application/json
|
767
|
+
|
768
|
+
|
690
769
|
## get_prospects
|
691
770
|
|
692
771
|
> <Array<Prospect>> get_prospects(opts)
|
data/docs/SaveBuilding.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **abbreviation** | **String** | Building
|
7
|
+
| **abbreviation** | **String** | Abbreviation of Building. | |
|
8
8
|
| **address** | [**SaveAddress**](SaveAddress.md) | | [optional] |
|
9
9
|
| **allocation_method** | **String** | Allocation method. | [optional] |
|
10
10
|
| **available_date** | **Date** | Date the building is available for leasing. | [optional] |
|
@@ -33,7 +33,7 @@
|
|
33
33
|
| **rentable** | **Boolean** | Indicates if the building is rentable. | [optional] |
|
34
34
|
| **search_tag** | **String** | Search tag name. | [optional] |
|
35
35
|
| **short_description** | **String** | Marketing short description. | [optional] |
|
36
|
-
| **target_deposit** | **
|
36
|
+
| **target_deposit** | **Float** | Target deposit amount. | [optional] |
|
37
37
|
| **target_rent** | **Float** | Market rent for the building. | [optional] |
|
38
38
|
| **total_area** | **Float** | Building area. | [optional] |
|
39
39
|
| **type** | **String** | Indicates Building type like Office, Industrial, Retail, Healthcare, Government, Airport, Garage/Parking, Apartment Building, Duplex / Triplex, Mobile Home / RV Community etc. | |
|
data/docs/SaveContact.md
CHANGED
@@ -17,7 +17,7 @@
|
|
17
17
|
| **home_phone** | **String** | Home Phone. | [optional] |
|
18
18
|
| **job_title** | **String** | Professional title or position for the contact. | [optional] |
|
19
19
|
| **last_name** | **String** | Last Name. | |
|
20
|
-
| **middle_name** | **String** |
|
20
|
+
| **middle_name** | **String** | Middle Name. | [optional] |
|
21
21
|
| **mobile_phone** | **String** | Mobile Phone. | [optional] |
|
22
22
|
| **name_on_check** | **String** | Name On Check. | [optional] |
|
23
23
|
| **named_on_lease** | **Boolean** | Is Named On Lease. | [optional] |
|
data/docs/SaveLease.md
CHANGED
@@ -4,23 +4,28 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **base_rent** | **Float** | Property base rent. | [optional] |
|
7
8
|
| **comments** | **String** | Comments. | [optional] |
|
8
|
-
| **end_date** | **Date** | End
|
9
|
+
| **end_date** | **Date** | End date of the lease term. | |
|
9
10
|
| **leasing_fee_amount** | **Float** | Move in leasing fee amount. | [optional] |
|
10
11
|
| **leasing_fee_date** | **Date** | Move in leasing fee post date. | [optional] |
|
11
12
|
| **leasing_fee_ref_no** | **String** | Move in leasing fee reference number. | [optional] |
|
12
13
|
| **move_in_date** | **Date** | Move In Date. | |
|
13
14
|
| **move_out_date** | **Date** | Move Out Date. | [optional] |
|
14
15
|
| **post_first_charge** | **Boolean** | Indicates how to post first rent charge while move in. | [optional] |
|
15
|
-
| **primary_contact_id** | **Integer** | Primary contact ID, Should be one of
|
16
|
+
| **primary_contact_id** | **Integer** | Primary contact ID, Should be one of tenant IDs. | |
|
16
17
|
| **prorate_month** | **String** | Indicates how to post first rent charge while move in. | [optional] |
|
18
|
+
| **public_assistance_program** | **String** | Public assistance program. Allowed values are 'None', 'Section 8', 'SCRIE', 'Rent Control', 'EDEN INC. - Shelter Care Plus', 'CLC', 'DHAP', 'FEMA', 'Harris County' etc. | [optional] |
|
17
19
|
| **rent_auto_charge** | [**SaveAutoCharge**](SaveAutoCharge.md) | | [optional] |
|
20
|
+
| **schedule_move_out_date** | **Date** | Scheduled move out date. | [optional] |
|
21
|
+
| **search_tag** | **String** | Search tag. | [optional] |
|
18
22
|
| **sec_dep_amount** | **Float** | Move in security deposit amount. | [optional] |
|
19
23
|
| **sec_dep_charge_date** | **Date** | Move in security deposit charge date. | [optional] |
|
20
|
-
| **
|
21
|
-
| **
|
22
|
-
| **
|
23
|
-
| **
|
24
|
+
| **signed_date** | **Date** | Lease signed date. | [optional] |
|
25
|
+
| **start_date** | **Date** | Start date of the lease term. | |
|
26
|
+
| **status** | **String** | Indicates lease status. Allowed values are 'Active', 'Active - Notice Given', 'Draft', 'Eviction', 'Terminated' etc. | [optional] |
|
27
|
+
| **tenant_ids** | **Array<Integer>** | List of tenant IDs. | |
|
28
|
+
| **unit_id** | **Integer** | Unit/Building ID associated with this lease. | |
|
24
29
|
|
25
30
|
## Example
|
26
31
|
|
@@ -28,6 +33,7 @@
|
|
28
33
|
require 'propertyware'
|
29
34
|
|
30
35
|
instance = Propertyware::SaveLease.new(
|
36
|
+
base_rent: null,
|
31
37
|
comments: null,
|
32
38
|
end_date: null,
|
33
39
|
leasing_fee_amount: null,
|
@@ -38,9 +44,13 @@ instance = Propertyware::SaveLease.new(
|
|
38
44
|
post_first_charge: false,
|
39
45
|
primary_contact_id: null,
|
40
46
|
prorate_month: null,
|
47
|
+
public_assistance_program: null,
|
41
48
|
rent_auto_charge: null,
|
49
|
+
schedule_move_out_date: null,
|
50
|
+
search_tag: null,
|
42
51
|
sec_dep_amount: null,
|
43
52
|
sec_dep_charge_date: null,
|
53
|
+
signed_date: null,
|
44
54
|
start_date: null,
|
45
55
|
status: null,
|
46
56
|
tenant_ids: null,
|
data/docs/SaveUnit.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **abbreviation** | **String** | Unit
|
7
|
+
| **abbreviation** | **String** | Abbreviation of Unit. | |
|
8
8
|
| **address** | [**SaveAddress**](SaveAddress.md) | | [optional] |
|
9
9
|
| **available_date** | **Date** | Unit Available date to lease. | [optional] |
|
10
10
|
| **building_id** | **Integer** | Id of the building associated with this unit. | |
|
@@ -16,16 +16,16 @@
|
|
16
16
|
| **neighborhood** | **String** | Neighborhood. | [optional] |
|
17
17
|
| **number_bathrooms** | **Float** | Number of bathrooms in the unit. | [optional] |
|
18
18
|
| **number_bedrooms** | **Integer** | Number of bedrooms in the unit. | [optional] |
|
19
|
-
| **other_unit_country** | **String** | Other Unit country is required only if unit outside of USA or Canada. | [optional] |
|
20
19
|
| **portfolio_id** | **Integer** | Id of the portfolio associated with this unit. | |
|
21
20
|
| **ready** | **Boolean** | Indicates if property is ready to be leased. | [optional] |
|
22
21
|
| **reason_for_property_lost** | **String** | Reason for property lost. | [optional] |
|
23
22
|
| **residential** | **Boolean** | Is Unit is Residential or Commercial. | [optional] |
|
24
|
-
| **search_tag** | **String** |
|
25
|
-
| **target_deposit** | **
|
23
|
+
| **search_tag** | **String** | Search tag. | [optional] |
|
24
|
+
| **target_deposit** | **Float** | Target deposit amount. | [optional] |
|
26
25
|
| **target_rent** | **Float** | Market rent for the unit. | [optional] |
|
26
|
+
| **target_rent_units** | **String** | Property target rent units. | [optional] |
|
27
27
|
| **total_area** | **Float** | Unit Area. | [optional] |
|
28
|
-
| **type** | **String** | Unit
|
28
|
+
| **type** | **String** | Indicates Unit type like Business Office,Medical Office,Showroom,R and D,Assigned Parking (Indoor),Assigned Parking (Outdoor),Warehouse,Restaurant,Shopping Mall Retail,Street Retail,Manufacturing,House,Town House,Apartment,Flat,Studio,Loft,Assigned Parking (Indoor),Assigned Parking (Outdoor) etc. | |
|
29
29
|
|
30
30
|
## Example
|
31
31
|
|
@@ -45,7 +45,6 @@ instance = Propertyware::SaveUnit.new(
|
|
45
45
|
neighborhood: null,
|
46
46
|
number_bathrooms: null,
|
47
47
|
number_bedrooms: null,
|
48
|
-
other_unit_country: null,
|
49
48
|
portfolio_id: null,
|
50
49
|
ready: false,
|
51
50
|
reason_for_property_lost: null,
|
@@ -53,6 +52,7 @@ instance = Propertyware::SaveUnit.new(
|
|
53
52
|
search_tag: null,
|
54
53
|
target_deposit: null,
|
55
54
|
target_rent: null,
|
55
|
+
target_rent_units: null,
|
56
56
|
total_area: null,
|
57
57
|
type: null
|
58
58
|
)
|
data/docs/SaveVendor.md
CHANGED
@@ -7,17 +7,32 @@
|
|
7
7
|
| **account_number** | **String** | Account Number | [optional] |
|
8
8
|
| **address** | **String** | Address | [optional] |
|
9
9
|
| **address2** | **String** | Address2 | [optional] |
|
10
|
+
| **alert_email** | **String** | Alert Email | [optional] |
|
10
11
|
| **city** | **String** | City | [optional] |
|
11
12
|
| **company_name** | **String** | Vendor Company Name | |
|
12
13
|
| **country** | **String** | Country | [optional] |
|
14
|
+
| **credit_limit** | **Float** | Credit Limit | [optional] |
|
15
|
+
| **days_to_pay** | **Integer** | Payment Terms days to pay. | [optional] |
|
16
|
+
| **default_bill_split_account_id** | **Integer** | Default bill split id | [optional] |
|
17
|
+
| **default_markup_discount_percentage** | **Float** | Default markup discount | [optional] |
|
18
|
+
| **description** | **String** | Description | [optional] |
|
19
|
+
| **eligible1099** | **Boolean** | Eligible For 1099 | [optional] |
|
13
20
|
| **email** | **String** | EMail | [optional] |
|
14
21
|
| **fax** | **String** | Fax | [optional] |
|
22
|
+
| **include_company_name_on1099** | **Boolean** | Include company name on 1099 | [optional] |
|
23
|
+
| **markup_account_id** | **Integer** | Markup account id | [optional] |
|
15
24
|
| **name** | **String** | Vendor Name | |
|
16
25
|
| **name_on_check** | **String** | Vendor Name On Check | |
|
17
26
|
| **phone** | **String** | Phone | [optional] |
|
27
|
+
| **search_tag** | **String** | Search Tag | [optional] |
|
18
28
|
| **state** | **String** | State | [optional] |
|
29
|
+
| **sync_to_vmm** | **Boolean** | Sync to maintenance | [optional] |
|
19
30
|
| **tax_id** | **String** | Tax ID | [optional] |
|
20
|
-
| **
|
31
|
+
| **tax_payer_name** | **String** | Tax Payer Name | [optional] |
|
32
|
+
| **terms** | **String** | Payment Terms Description, default value('NET 30') | [optional] |
|
33
|
+
| **time_tracking** | **Boolean** | Time Tracking, is enabled or disabled | [optional] |
|
34
|
+
| **vendor_type** | **String** | Vendor type. This is a user configurable list with the following initial default values <Banking - General>, <Banking - Mortgage>, <Banking - Investment>, <Contractors - Carpentry>, <Contractors - Dry Wall>, <Contractors - Electrical>, <Contractors - Fencing>, <Contractors - Flooring>, <Contractors - General>, <Contractors - HVAC>, <Contractors - Landscaping>, <Contractors - Masonry>, <Contractors - Miscellaneous>, <Contractors - Painting>, <Contractors - Paving>, <Contractors - Plumbing>, <Contractors - Roofing>, <Contractors - Sheet Metal>, <Contractors - Windows>, <Owners>, <Management Company>, <Suppliers - Carpets>, <Suppliers - Electrical>, <Suppliers - General>, <Suppliers - Lighting>, <Suppliers - Lumber>, <Suppliers - Plumbing>, <Suppliers - Security>, <Suppliers - Stone>, <Suppliers - Tiling>, <Suppliers - Windows>, <Utilities - Communications>, <Utilities - Gas & Electric>, <Utilities - Waste Management>, <Utilities - Water> | |
|
35
|
+
| **website** | **String** | Website | [optional] |
|
21
36
|
| **zip** | **String** | Zip | [optional] |
|
22
37
|
|
23
38
|
## Example
|
@@ -29,17 +44,32 @@ instance = Propertyware::SaveVendor.new(
|
|
29
44
|
account_number: null,
|
30
45
|
address: null,
|
31
46
|
address2: null,
|
47
|
+
alert_email: null,
|
32
48
|
city: null,
|
33
49
|
company_name: null,
|
34
50
|
country: null,
|
51
|
+
credit_limit: null,
|
52
|
+
days_to_pay: null,
|
53
|
+
default_bill_split_account_id: null,
|
54
|
+
default_markup_discount_percentage: null,
|
55
|
+
description: null,
|
56
|
+
eligible1099: false,
|
35
57
|
email: null,
|
36
58
|
fax: null,
|
59
|
+
include_company_name_on1099: false,
|
60
|
+
markup_account_id: null,
|
37
61
|
name: null,
|
38
62
|
name_on_check: null,
|
39
63
|
phone: null,
|
64
|
+
search_tag: null,
|
40
65
|
state: null,
|
66
|
+
sync_to_vmm: false,
|
41
67
|
tax_id: null,
|
68
|
+
tax_payer_name: null,
|
69
|
+
terms: null,
|
70
|
+
time_tracking: false,
|
42
71
|
vendor_type: null,
|
72
|
+
website: null,
|
43
73
|
zip: null
|
44
74
|
)
|
45
75
|
```
|
data/docs/SaveWorkOrder.md
CHANGED
@@ -4,13 +4,19 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
7
|
+
| **authorize_enter** | **String** | This field indicates if the tenant has granted the maintenance staff permission to enter the unit. | [optional] |
|
8
|
+
| **building_id** | **Integer** | Id of the building associated with this work order. | |
|
8
9
|
| **category** | **String** | Category of the work order. | [optional] |
|
10
|
+
| **cost_estimate** | **Float** | Enter an estimate of the cost for performing the work outlined in the work order. | [optional] |
|
11
|
+
| **date_to_enter** | **Date** | Authorized date to enter unit. | [optional] |
|
9
12
|
| **description** | **String** | Description of the work order. | [optional] |
|
10
13
|
| **hour_estimate** | **Float** | Estimated number of hours to complete the work order. | [optional] |
|
14
|
+
| **hour_to_enter** | **Integer** | Hour to enter. Allowed Value : 0 , 1, 2 ... 23 | [optional] |
|
15
|
+
| **minute_to_enter** | **Integer** | Minute to enter. Allowed Value : 0, 10, 20, 30, 40, 50 | [optional] |
|
11
16
|
| **priority** | **String** | Priority of the work order. | [optional] |
|
12
17
|
| **requested_by** | **Integer** | Id of the person that reported the problem, typically the tenant or owner associated with the buildings or units. | [optional] |
|
13
18
|
| **scheduled_end_date** | **Date** | Date on which the work is scheduled to be completed. | [optional] |
|
19
|
+
| **search_tag** | **String** | Enter a key term to allow you to quickly locate the work order. | [optional] |
|
14
20
|
| **start_date** | **Date** | Date on which the work was started. | [optional] |
|
15
21
|
| **type** | **String** | This classifies the work order into one of the following types: General, Service Request, Turnover, Inspection, Estimate etc. | [optional] |
|
16
22
|
| **unit_ids** | **Array<Integer>** | List of unit Ids that are attached to the building. | [optional] |
|
@@ -21,13 +27,19 @@
|
|
21
27
|
require 'propertyware'
|
22
28
|
|
23
29
|
instance = Propertyware::SaveWorkOrder.new(
|
30
|
+
authorize_enter: null,
|
24
31
|
building_id: null,
|
25
32
|
category: null,
|
33
|
+
cost_estimate: null,
|
34
|
+
date_to_enter: null,
|
26
35
|
description: null,
|
27
36
|
hour_estimate: null,
|
37
|
+
hour_to_enter: null,
|
38
|
+
minute_to_enter: null,
|
28
39
|
priority: null,
|
29
40
|
requested_by: null,
|
30
41
|
scheduled_end_date: null,
|
42
|
+
search_tag: null,
|
31
43
|
start_date: null,
|
32
44
|
type: null,
|
33
45
|
unit_ids: null
|