propertyware 1.0.5 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- 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/AutoPayment.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **end_date** | **Date** | End date. | [optional] |
|
13
13
|
| **fee_amount** | **Float** | Fee amount. | [optional] |
|
14
14
|
| **frequency** | **String** | Payment frequency. | [optional] |
|
15
|
+
| **gl_account_id** | **Integer** | Payment general ledger account ID. | [optional] |
|
15
16
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
16
17
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
17
18
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
@@ -32,6 +33,7 @@ instance = Propertyware::AutoPayment.new(
|
|
32
33
|
end_date: null,
|
33
34
|
fee_amount: null,
|
34
35
|
frequency: null,
|
36
|
+
gl_account_id: null,
|
35
37
|
id: null,
|
36
38
|
last_modified_by: null,
|
37
39
|
last_modified_date_time: null,
|
data/docs/Building.md
CHANGED
@@ -36,7 +36,7 @@
|
|
36
36
|
| **name** | **String** | Name of the property. | [optional] |
|
37
37
|
| **neighborhood** | **String** | Property neighborhood. | [optional] |
|
38
38
|
| **number_floors** | **Integer** | Number floors | [optional] |
|
39
|
-
| **number_of_bathrooms** | **
|
39
|
+
| **number_of_bathrooms** | **Float** | Number of bathrooms in the property. | [optional] |
|
40
40
|
| **number_of_bedrooms** | **Integer** | Number of bedrooms in the property. | [optional] |
|
41
41
|
| **portfolio_id** | **Integer** | ID of the portfolio associated with this property. | [optional] |
|
42
42
|
| **property_manager_list** | [**Array<PropertyManager>**](PropertyManager.md) | Property manager details. | [optional] |
|
@@ -47,7 +47,7 @@
|
|
47
47
|
| **search_tag** | **String** | Property search tag. | [optional] |
|
48
48
|
| **status** | **String** | Property status (occupied/vacant). | [optional] |
|
49
49
|
| **syndicate** | **Boolean** | Property syndicate. | [optional] |
|
50
|
-
| **target_deposit** | **
|
50
|
+
| **target_deposit** | **Float** | Target deposit. | [optional] |
|
51
51
|
| **target_rent** | **Float** | Property target rent. | [optional] |
|
52
52
|
| **target_rent_units** | **String** | Property target rent units. | [optional] |
|
53
53
|
| **total_area** | **Float** | Property total area. | [optional] |
|
data/docs/Charge.md
CHANGED
@@ -5,15 +5,16 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **account** | **String** | General ledger account. | [optional] |
|
8
|
-
| **amount** | **Float** |
|
8
|
+
| **amount** | **Float** | Auto charge amount. | [optional] |
|
9
9
|
| **description** | **String** | Description of the auto charge. | [optional] |
|
10
10
|
| **due_day** | **String** | Description of the day when the auto charge is due. | [optional] |
|
11
11
|
| **end_date** | **Date** | End date of auto charge. | [optional] |
|
12
12
|
| **frequency** | **String** | Frequency of the auto charge. | |
|
13
|
+
| **gl_account_id** | **Integer** | ID of the General Ledger Account associated to this auto charge. | [optional] |
|
13
14
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
14
15
|
| **last_post_date** | **Date** | Last post date. | [optional] |
|
15
16
|
| **reference_number** | **String** | Reference number. | [optional] |
|
16
|
-
| **start_date** | **Date** | Start date. | |
|
17
|
+
| **start_date** | **Date** | Start date of auto charge. | |
|
17
18
|
|
18
19
|
## Example
|
19
20
|
|
@@ -27,6 +28,7 @@ instance = Propertyware::Charge.new(
|
|
27
28
|
due_day: null,
|
28
29
|
end_date: null,
|
29
30
|
frequency: null,
|
31
|
+
gl_account_id: null,
|
30
32
|
id: null,
|
31
33
|
last_post_date: null,
|
32
34
|
reference_number: null,
|
data/docs/CreditMemo.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Propertyware::CreditMemo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **amount** | **Float** | Amount. | |
|
8
|
+
| **comments** | **String** | 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
|
+
| **date** | **Date** | Post date. | |
|
12
|
+
| **gl_account_id** | **Integer** | Id of the general ledger account associated with this credit memo. | [optional] |
|
13
|
+
| **id** | **Integer** | Unique identifier. | [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
|
+
| **lease_id** | **Integer** | Id of the lease associated with this credit memo. | [optional] |
|
17
|
+
| **parent_tx_id** | **Integer** | Id of the payment causing this prepay application. | [optional] |
|
18
|
+
| **portfolio_id** | **Integer** | Id of the portfolio associated with this credit memo. | [optional] |
|
19
|
+
| **ref_no** | **String** | Reference number. | [optional] |
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'propertyware'
|
25
|
+
|
26
|
+
instance = Propertyware::CreditMemo.new(
|
27
|
+
amount: null,
|
28
|
+
comments: null,
|
29
|
+
created_by: null,
|
30
|
+
created_date_time: null,
|
31
|
+
date: null,
|
32
|
+
gl_account_id: null,
|
33
|
+
id: null,
|
34
|
+
last_modified_by: null,
|
35
|
+
last_modified_date_time: null,
|
36
|
+
lease_id: null,
|
37
|
+
parent_tx_id: null,
|
38
|
+
portfolio_id: null,
|
39
|
+
ref_no: null
|
40
|
+
)
|
41
|
+
```
|
42
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Propertyware::CustomFieldDefinition
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data_type** | **String** | | [optional] |
|
8
|
+
| **default_value** | **String** | | [optional] |
|
9
|
+
| **field_name** | **String** | | [optional] |
|
10
|
+
| **group_name** | **String** | | [optional] |
|
11
|
+
| **required_field** | **String** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'propertyware'
|
17
|
+
|
18
|
+
instance = Propertyware::CustomFieldDefinition.new(
|
19
|
+
data_type: null,
|
20
|
+
default_value: null,
|
21
|
+
field_name: null,
|
22
|
+
group_name: null,
|
23
|
+
required_field: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,89 @@
|
|
1
|
+
# Propertyware::CustomFieldFieldsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**retrieve_custom_field_definitions**](CustomFieldFieldsApi.md#retrieve_custom_field_definitions) | **GET** /customfields/{entityType}/definitions | Retrieve list of custom field definitions. |
|
8
|
+
|
9
|
+
|
10
|
+
## retrieve_custom_field_definitions
|
11
|
+
|
12
|
+
> <Array<CustomFieldDefinition>> retrieve_custom_field_definitions(entity_type)
|
13
|
+
|
14
|
+
Retrieve list of custom field definitions.
|
15
|
+
|
16
|
+
Retrieve list of custom field definitions.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CUSTOM FIELD</span> - <code>Read</code>
|
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::CustomFieldFieldsApi.new
|
42
|
+
entity_type = 'entity_type_example' # String | Entity type, allowed entity types (Asset, Building, Contact, Lease, Portfolio, Prospect, Unit, Vendor, WorkOrder, ServiceAgreement)
|
43
|
+
|
44
|
+
begin
|
45
|
+
# Retrieve list of custom field definitions.
|
46
|
+
result = api_instance.retrieve_custom_field_definitions(entity_type)
|
47
|
+
p result
|
48
|
+
rescue Propertyware::ApiError => e
|
49
|
+
puts "Error when calling CustomFieldFieldsApi->retrieve_custom_field_definitions: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
#### Using the retrieve_custom_field_definitions_with_http_info variant
|
54
|
+
|
55
|
+
This returns an Array which contains the response data, status code and headers.
|
56
|
+
|
57
|
+
> <Array(<Array<CustomFieldDefinition>>, Integer, Hash)> retrieve_custom_field_definitions_with_http_info(entity_type)
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
begin
|
61
|
+
# Retrieve list of custom field definitions.
|
62
|
+
data, status_code, headers = api_instance.retrieve_custom_field_definitions_with_http_info(entity_type)
|
63
|
+
p status_code # => 2xx
|
64
|
+
p headers # => { ... }
|
65
|
+
p data # => <Array<CustomFieldDefinition>>
|
66
|
+
rescue Propertyware::ApiError => e
|
67
|
+
puts "Error when calling CustomFieldFieldsApi->retrieve_custom_field_definitions_with_http_info: #{e}"
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
| Name | Type | Description | Notes |
|
74
|
+
| ---- | ---- | ----------- | ----- |
|
75
|
+
| **entity_type** | **String** | Entity type, allowed entity types (Asset, Building, Contact, Lease, Portfolio, Prospect, Unit, Vendor, WorkOrder, ServiceAgreement) | |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**Array<CustomFieldDefinition>**](CustomFieldDefinition.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: Not defined
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
data/docs/Document.md
CHANGED
@@ -9,13 +9,13 @@
|
|
9
9
|
| **description** | **String** | Description of a document. | [optional] |
|
10
10
|
| **entity_id** | **Integer** | Unique identifier of an entity document is attached to. | [optional] |
|
11
11
|
| **entity_type** | **String** | Type of an entity document is attached to. | [optional] |
|
12
|
+
| **file_name** | **String** | File name. | [optional] |
|
12
13
|
| **file_type** | **String** | File type. | [optional] |
|
13
|
-
| **filename** | **String** | File name. | [optional] |
|
14
14
|
| **id** | **Integer** | Unique identifier. | [optional] |
|
15
|
-
| **indicates_if_publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
|
16
|
-
| **indicates_if_publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
|
17
15
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
18
16
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
17
|
+
| **publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
|
18
|
+
| **publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
|
19
19
|
|
20
20
|
## Example
|
21
21
|
|
@@ -28,13 +28,13 @@ instance = Propertyware::Document.new(
|
|
28
28
|
description: null,
|
29
29
|
entity_id: null,
|
30
30
|
entity_type: null,
|
31
|
+
file_name: null,
|
31
32
|
file_type: null,
|
32
|
-
filename: null,
|
33
33
|
id: null,
|
34
|
-
indicates_if_publish_to_owner_portal: false,
|
35
|
-
indicates_if_publish_to_tenant_portal: false,
|
36
34
|
last_modified_by: null,
|
37
|
-
last_modified_date_time: null
|
35
|
+
last_modified_date_time: null,
|
36
|
+
publish_to_owner_portal: false,
|
37
|
+
publish_to_tenant_portal: false
|
38
38
|
)
|
39
39
|
```
|
40
40
|
|
data/docs/DocumentsApi.md
CHANGED
@@ -4,9 +4,93 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_document**](DocumentsApi.md#delete_document) | **DELETE** /docs/{documentId} | Delete a document (BETA) |
|
7
8
|
| [**download_document**](DocumentsApi.md#download_document) | **GET** /docs/{documentId}/download | Download a document |
|
8
9
|
| [**retrieve_all_documents**](DocumentsApi.md#retrieve_all_documents) | **GET** /docs | Retrieve all documents |
|
9
10
|
| [**retrieve_document**](DocumentsApi.md#retrieve_document) | **GET** /docs/{documentId} | Retrieve a document |
|
11
|
+
| [**update_document**](DocumentsApi.md#update_document) | **PUT** /docs/{documentId} | Update a document (BETA) |
|
12
|
+
| [**upload_document**](DocumentsApi.md#upload_document) | **POST** /docs | Upload a document (BETA) |
|
13
|
+
|
14
|
+
|
15
|
+
## delete_document
|
16
|
+
|
17
|
+
> <ResponseEntity> delete_document(document_id)
|
18
|
+
|
19
|
+
Delete a document (BETA)
|
20
|
+
|
21
|
+
<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Deletes a specific document and its associated content.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Delete</code>
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'propertyware'
|
28
|
+
# setup authorization
|
29
|
+
Propertyware.configure do |config|
|
30
|
+
# Configure API key authorization: organizationId
|
31
|
+
config.api_key['organizationId'] = '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['organizationId'] = 'Bearer'
|
34
|
+
|
35
|
+
# Configure API key authorization: clientId
|
36
|
+
config.api_key['clientId'] = '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['clientId'] = 'Bearer'
|
39
|
+
|
40
|
+
# Configure API key authorization: clientSecret
|
41
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
42
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
43
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
44
|
+
end
|
45
|
+
|
46
|
+
api_instance = Propertyware::DocumentsApi.new
|
47
|
+
document_id = 789 # Integer | ID of the document to delete
|
48
|
+
|
49
|
+
begin
|
50
|
+
# Delete a document (BETA)
|
51
|
+
result = api_instance.delete_document(document_id)
|
52
|
+
p result
|
53
|
+
rescue Propertyware::ApiError => e
|
54
|
+
puts "Error when calling DocumentsApi->delete_document: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
#### Using the delete_document_with_http_info variant
|
59
|
+
|
60
|
+
This returns an Array which contains the response data, status code and headers.
|
61
|
+
|
62
|
+
> <Array(<ResponseEntity>, Integer, Hash)> delete_document_with_http_info(document_id)
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
begin
|
66
|
+
# Delete a document (BETA)
|
67
|
+
data, status_code, headers = api_instance.delete_document_with_http_info(document_id)
|
68
|
+
p status_code # => 2xx
|
69
|
+
p headers # => { ... }
|
70
|
+
p data # => <ResponseEntity>
|
71
|
+
rescue Propertyware::ApiError => e
|
72
|
+
puts "Error when calling DocumentsApi->delete_document_with_http_info: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
| Name | Type | Description | Notes |
|
79
|
+
| ---- | ---- | ----------- | ----- |
|
80
|
+
| **document_id** | **Integer** | ID of the document to delete | |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**ResponseEntity**](ResponseEntity.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
|
10
94
|
|
11
95
|
|
12
96
|
## download_document
|
@@ -129,7 +213,7 @@ opts = {
|
|
129
213
|
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.
|
130
214
|
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.
|
131
215
|
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
132
|
-
entity_id: 789 # Integer | Filters results to documents associated with a specific entity id.
|
216
|
+
entity_id: 789 # Integer | Filters results to documents associated with a specific entity id. entity ID is not required for “DESKTOP†and “OTHER†. Remaining entities need “entity ID†.
|
133
217
|
}
|
134
218
|
|
135
219
|
begin
|
@@ -169,7 +253,7 @@ end
|
|
169
253
|
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
170
254
|
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
171
255
|
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
172
|
-
| **entity_id** | **Integer** | Filters results to documents associated with a specific entity id. | [optional] |
|
256
|
+
| **entity_id** | **Integer** | Filters results to documents associated with a specific entity id. entity ID is not required for “DESKTOP†and “OTHER†. Remaining entities need “entity ID†. | [optional] |
|
173
257
|
|
174
258
|
### Return type
|
175
259
|
|
@@ -265,3 +349,177 @@ end
|
|
265
349
|
- **Content-Type**: Not defined
|
266
350
|
- **Accept**: application/json
|
267
351
|
|
352
|
+
|
353
|
+
## update_document
|
354
|
+
|
355
|
+
> <Document> update_document(document_id, update_document)
|
356
|
+
|
357
|
+
Update a document (BETA)
|
358
|
+
|
359
|
+
<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates the metadata of a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Write</code>
|
360
|
+
|
361
|
+
### Examples
|
362
|
+
|
363
|
+
```ruby
|
364
|
+
require 'time'
|
365
|
+
require 'propertyware'
|
366
|
+
# setup authorization
|
367
|
+
Propertyware.configure do |config|
|
368
|
+
# Configure API key authorization: organizationId
|
369
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
370
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
371
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
372
|
+
|
373
|
+
# Configure API key authorization: clientId
|
374
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
375
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
376
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
377
|
+
|
378
|
+
# Configure API key authorization: clientSecret
|
379
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
380
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
381
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
382
|
+
end
|
383
|
+
|
384
|
+
api_instance = Propertyware::DocumentsApi.new
|
385
|
+
document_id = 789 # Integer | ID of the document to be updated
|
386
|
+
update_document = Propertyware::UpdateDocument.new({file_name: 'file_name_example'}) # UpdateDocument | updateDocument
|
387
|
+
|
388
|
+
begin
|
389
|
+
# Update a document (BETA)
|
390
|
+
result = api_instance.update_document(document_id, update_document)
|
391
|
+
p result
|
392
|
+
rescue Propertyware::ApiError => e
|
393
|
+
puts "Error when calling DocumentsApi->update_document: #{e}"
|
394
|
+
end
|
395
|
+
```
|
396
|
+
|
397
|
+
#### Using the update_document_with_http_info variant
|
398
|
+
|
399
|
+
This returns an Array which contains the response data, status code and headers.
|
400
|
+
|
401
|
+
> <Array(<Document>, Integer, Hash)> update_document_with_http_info(document_id, update_document)
|
402
|
+
|
403
|
+
```ruby
|
404
|
+
begin
|
405
|
+
# Update a document (BETA)
|
406
|
+
data, status_code, headers = api_instance.update_document_with_http_info(document_id, update_document)
|
407
|
+
p status_code # => 2xx
|
408
|
+
p headers # => { ... }
|
409
|
+
p data # => <Document>
|
410
|
+
rescue Propertyware::ApiError => e
|
411
|
+
puts "Error when calling DocumentsApi->update_document_with_http_info: #{e}"
|
412
|
+
end
|
413
|
+
```
|
414
|
+
|
415
|
+
### Parameters
|
416
|
+
|
417
|
+
| Name | Type | Description | Notes |
|
418
|
+
| ---- | ---- | ----------- | ----- |
|
419
|
+
| **document_id** | **Integer** | ID of the document to be updated | |
|
420
|
+
| **update_document** | [**UpdateDocument**](UpdateDocument.md) | updateDocument | |
|
421
|
+
|
422
|
+
### Return type
|
423
|
+
|
424
|
+
[**Document**](Document.md)
|
425
|
+
|
426
|
+
### Authorization
|
427
|
+
|
428
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
429
|
+
|
430
|
+
### HTTP request headers
|
431
|
+
|
432
|
+
- **Content-Type**: application/json
|
433
|
+
- **Accept**: application/json
|
434
|
+
|
435
|
+
|
436
|
+
## upload_document
|
437
|
+
|
438
|
+
> <Document> upload_document(entity_id, entity_type, body, opts)
|
439
|
+
|
440
|
+
Upload a document (BETA)
|
441
|
+
|
442
|
+
<p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Upload a document<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Write</code>
|
443
|
+
|
444
|
+
### Examples
|
445
|
+
|
446
|
+
```ruby
|
447
|
+
require 'time'
|
448
|
+
require 'propertyware'
|
449
|
+
# setup authorization
|
450
|
+
Propertyware.configure do |config|
|
451
|
+
# Configure API key authorization: organizationId
|
452
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
453
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
454
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
455
|
+
|
456
|
+
# Configure API key authorization: clientId
|
457
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
458
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
459
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
460
|
+
|
461
|
+
# Configure API key authorization: clientSecret
|
462
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
463
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
464
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
465
|
+
end
|
466
|
+
|
467
|
+
api_instance = Propertyware::DocumentsApi.new
|
468
|
+
entity_id = 789 # Integer | Unique identifier of an entity document is attached to.
|
469
|
+
entity_type = 'entity_type_example' # String | Entity type Document is attached to (Bill, Building, Desktop, Inspection, Lease, Portfolio, Prospect, Unit, Vendor, Work Order, Tenant, Owner, Bank Deposit, Asset)
|
470
|
+
body = File.new('/path/to/some/file') # File |
|
471
|
+
opts = {
|
472
|
+
publish_to_tenant_portal: true, # Boolean | Indicates if the document is published to the tenant portal.
|
473
|
+
publish_to_owner_portal: true # Boolean | Indicates if the document is published to the owner portal.
|
474
|
+
}
|
475
|
+
|
476
|
+
begin
|
477
|
+
# Upload a document (BETA)
|
478
|
+
result = api_instance.upload_document(entity_id, entity_type, body, opts)
|
479
|
+
p result
|
480
|
+
rescue Propertyware::ApiError => e
|
481
|
+
puts "Error when calling DocumentsApi->upload_document: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
#### Using the upload_document_with_http_info variant
|
486
|
+
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
488
|
+
|
489
|
+
> <Array(<Document>, Integer, Hash)> upload_document_with_http_info(entity_id, entity_type, body, opts)
|
490
|
+
|
491
|
+
```ruby
|
492
|
+
begin
|
493
|
+
# Upload a document (BETA)
|
494
|
+
data, status_code, headers = api_instance.upload_document_with_http_info(entity_id, entity_type, body, opts)
|
495
|
+
p status_code # => 2xx
|
496
|
+
p headers # => { ... }
|
497
|
+
p data # => <Document>
|
498
|
+
rescue Propertyware::ApiError => e
|
499
|
+
puts "Error when calling DocumentsApi->upload_document_with_http_info: #{e}"
|
500
|
+
end
|
501
|
+
```
|
502
|
+
|
503
|
+
### Parameters
|
504
|
+
|
505
|
+
| Name | Type | Description | Notes |
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
507
|
+
| **entity_id** | **Integer** | Unique identifier of an entity document is attached to. | |
|
508
|
+
| **entity_type** | **String** | Entity type Document is attached to (Bill, Building, Desktop, Inspection, Lease, Portfolio, Prospect, Unit, Vendor, Work Order, Tenant, Owner, Bank Deposit, Asset) | |
|
509
|
+
| **body** | **File** | | |
|
510
|
+
| **publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
|
511
|
+
| **publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
|
512
|
+
|
513
|
+
### Return type
|
514
|
+
|
515
|
+
[**Document**](Document.md)
|
516
|
+
|
517
|
+
### Authorization
|
518
|
+
|
519
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
520
|
+
|
521
|
+
### HTTP request headers
|
522
|
+
|
523
|
+
- **Content-Type**: application/octet-stream
|
524
|
+
- **Accept**: application/json
|
525
|
+
|
data/docs/Lease.md
CHANGED
@@ -4,11 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **active** | **Boolean** | Active | [optional] |
|
8
|
-
| **addendums** | [**Array<LeaseClause>**](LeaseClause.md) | Lease
|
7
|
+
| **active** | **Boolean** | Indicates if lease is Active. | [optional] |
|
8
|
+
| **addendums** | [**Array<LeaseClause>**](LeaseClause.md) | Lease addendum(s). | [optional] |
|
9
|
+
| **base_rent** | **Float** | Property base rent. | [optional] |
|
9
10
|
| **building_id** | **Integer** | Id of the building associated with this lease. | [optional] |
|
10
11
|
| **comments** | **String** | Description of the lease. | [optional] |
|
11
|
-
| **contacts** | [**Array<LeaseContact>**](LeaseContact.md) |
|
12
|
+
| **contacts** | [**Array<LeaseContact>**](LeaseContact.md) | List of the current tenants on the lease. | [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
|
| **custom_fields** | [**Array<CustomField>**](CustomField.md) | Custom fields. | [optional] |
|
@@ -18,8 +19,8 @@
|
|
18
19
|
| **last_modified_by** | **String** | User who last modified the record. | [optional] |
|
19
20
|
| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
|
20
21
|
| **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] |
|
22
|
+
| **lease_balance** | **Float** | Lease Balance. | [optional] |
|
23
|
+
| **lease_name** | **String** | Lease Name. | [optional] |
|
23
24
|
| **location** | **String** | Building and/or units the lease is currently attached to. | [optional] |
|
24
25
|
| **move_in_date** | **Date** | Day that the tenant(s) moved into the property. | [optional] |
|
25
26
|
| **move_out_date** | **Date** | Day that the tenant(s) vacated the property. | [optional] |
|
@@ -29,10 +30,12 @@
|
|
29
30
|
| **public_assistance_program** | **String** | Indicates if the tenant(s) of the lease receive any aid from a Public Assistance Program. | [optional] |
|
30
31
|
| **reason_for_leaving** | **String** | Reason for vacating the property. | [optional] |
|
31
32
|
| **schedule_move_out_date** | **Date** | Day that the tenant(s) are expected to vacate the property. | [optional] |
|
33
|
+
| **search_tag** | **String** | Search tag. | [optional] |
|
34
|
+
| **signed_date** | **Date** | Lease signed date. | [optional] |
|
32
35
|
| **start_date** | **Date** | Start date of the lease term. | [optional] |
|
33
36
|
| **status** | **String** | Lease's current status. | [optional] |
|
34
37
|
| **tenants_opts_into_asset_protection_plan** | **String** | Indicates if the tenants opted into Asset Protection Plan. | [optional] |
|
35
|
-
| **terminated_date** | **Date** | Terminated Date | [optional] |
|
38
|
+
| **terminated_date** | **Date** | Lease Terminated Date. | [optional] |
|
36
39
|
| **unit_id** | **Integer** | Id of the unit associated with this lease. | [optional] |
|
37
40
|
|
38
41
|
## Example
|
@@ -43,6 +46,7 @@ require 'propertyware'
|
|
43
46
|
instance = Propertyware::Lease.new(
|
44
47
|
active: false,
|
45
48
|
addendums: null,
|
49
|
+
base_rent: null,
|
46
50
|
building_id: null,
|
47
51
|
comments: null,
|
48
52
|
contacts: null,
|
@@ -66,6 +70,8 @@ instance = Propertyware::Lease.new(
|
|
66
70
|
public_assistance_program: null,
|
67
71
|
reason_for_leaving: null,
|
68
72
|
schedule_move_out_date: null,
|
73
|
+
search_tag: null,
|
74
|
+
signed_date: null,
|
69
75
|
start_date: null,
|
70
76
|
status: null,
|
71
77
|
tenants_opts_into_asset_protection_plan: null,
|
data/docs/LeaseStatus.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Propertyware::LeaseStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **define_active** | **Boolean** | | [optional] |
|
8
|
+
| **id** | **Integer** | | [optional] |
|
9
|
+
| **order_index** | **Integer** | | [optional] |
|
10
|
+
| **portal_login_enabled** | **Boolean** | | [optional] |
|
11
|
+
| **readonly** | **Boolean** | | [optional] |
|
12
|
+
| **status** | **String** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'propertyware'
|
18
|
+
|
19
|
+
instance = Propertyware::LeaseStatus.new(
|
20
|
+
define_active: null,
|
21
|
+
id: null,
|
22
|
+
order_index: null,
|
23
|
+
portal_login_enabled: null,
|
24
|
+
readonly: null,
|
25
|
+
status: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|