propertyware 1.0.5 → 1.1.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 +9 -0
- data/DOCS.md +13 -4
- data/Gemfile.lock +2 -2
- data/bin/config.yml +1 -1
- data/bin/fix_json.rb +8 -7
- data/bin/propertyware.json +1 -1
- data/docs/Building.md +2 -2
- data/docs/CreditMemo.md +42 -0
- data/docs/CustomFieldDefinition.md +26 -0
- data/docs/CustomFieldDefinitionsApi.md +89 -0
- data/docs/DocumentsApi.md +176 -2
- data/docs/LeasesApi.md +102 -0
- data/docs/SaveBuilding.md +2 -2
- data/docs/SaveUnit.md +6 -6
- data/docs/Unit.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_definitions_api.rb +85 -0
- data/lib/propertyware/api/documents_api.rb +154 -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 +88 -1
- data/lib/propertyware/api/portfolios_api.rb +1 -1
- data/lib/propertyware/api/prospects_api.rb +1 -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 +1 -1
- data/lib/propertyware/models/auto_payment.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/propertyware/models/lease_clause.rb +1 -1
- data/lib/propertyware/models/lease_contact.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/propertyware/models/save_work_order.rb +1 -1
- 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_lease_journal_entry.rb +1 -1
- data/lib/propertyware/models/vendor.rb +1 -1
- data/lib/propertyware/models/work_order.rb +1 -1
- data/lib/propertyware/version.rb +2 -2
- data/lib/propertyware.rb +4 -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_definitions_api_spec.rb +47 -0
- data/spec/api/documents_api_spec.rb +30 -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 +22 -1
- data/spec/api/portfolios_api_spec.rb +1 -1
- data/spec/api/prospects_api_spec.rb +1 -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 +1 -1
- data/spec/models/auto_payment_spec.rb +1 -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 +1 -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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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_spec.rb +1 -1
- 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 +1 -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 +1 -1
- data/spec/models/save_work_order_spec.rb +1 -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_lease_journal_entry_spec.rb +1 -1
- data/spec/models/vendor_spec.rb +1 -1
- data/spec/models/work_order_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +14 -2
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/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::CustomFieldDefinitionsApi
|
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**](CustomFieldDefinitionsApi.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::CustomFieldDefinitionsApi.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 CustomFieldDefinitionsApi->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 CustomFieldDefinitionsApi->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/DocumentsApi.md
CHANGED
@@ -4,9 +4,92 @@ 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
|
+
| [**upload_document**](DocumentsApi.md#upload_document) | **POST** /docs | Upload a document (BETA) |
|
12
|
+
|
13
|
+
|
14
|
+
## delete_document
|
15
|
+
|
16
|
+
> <ResponseEntity> delete_document(document_id)
|
17
|
+
|
18
|
+
Delete a document (BETA)
|
19
|
+
|
20
|
+
<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>
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'propertyware'
|
27
|
+
# setup authorization
|
28
|
+
Propertyware.configure do |config|
|
29
|
+
# Configure API key authorization: organizationId
|
30
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
33
|
+
|
34
|
+
# Configure API key authorization: clientId
|
35
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
38
|
+
|
39
|
+
# Configure API key authorization: clientSecret
|
40
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
41
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
42
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
43
|
+
end
|
44
|
+
|
45
|
+
api_instance = Propertyware::DocumentsApi.new
|
46
|
+
document_id = 789 # Integer | ID of the document to delete
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Delete a document (BETA)
|
50
|
+
result = api_instance.delete_document(document_id)
|
51
|
+
p result
|
52
|
+
rescue Propertyware::ApiError => e
|
53
|
+
puts "Error when calling DocumentsApi->delete_document: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the delete_document_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
60
|
+
|
61
|
+
> <Array(<ResponseEntity>, Integer, Hash)> delete_document_with_http_info(document_id)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Delete a document (BETA)
|
66
|
+
data, status_code, headers = api_instance.delete_document_with_http_info(document_id)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => <ResponseEntity>
|
70
|
+
rescue Propertyware::ApiError => e
|
71
|
+
puts "Error when calling DocumentsApi->delete_document_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **document_id** | **Integer** | ID of the document to delete | |
|
80
|
+
|
81
|
+
### Return type
|
82
|
+
|
83
|
+
[**ResponseEntity**](ResponseEntity.md)
|
84
|
+
|
85
|
+
### Authorization
|
86
|
+
|
87
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
88
|
+
|
89
|
+
### HTTP request headers
|
90
|
+
|
91
|
+
- **Content-Type**: Not defined
|
92
|
+
- **Accept**: application/json
|
10
93
|
|
11
94
|
|
12
95
|
## download_document
|
@@ -129,7 +212,7 @@ opts = {
|
|
129
212
|
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
213
|
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
214
|
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.
|
215
|
+
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
216
|
}
|
134
217
|
|
135
218
|
begin
|
@@ -169,7 +252,7 @@ end
|
|
169
252
|
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
170
253
|
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
171
254
|
| **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] |
|
255
|
+
| **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
256
|
|
174
257
|
### Return type
|
175
258
|
|
@@ -265,3 +348,94 @@ end
|
|
265
348
|
- **Content-Type**: Not defined
|
266
349
|
- **Accept**: application/json
|
267
350
|
|
351
|
+
|
352
|
+
## upload_document
|
353
|
+
|
354
|
+
> <Document> upload_document(entity_id, entity_type, body, opts)
|
355
|
+
|
356
|
+
Upload a document (BETA)
|
357
|
+
|
358
|
+
<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>
|
359
|
+
|
360
|
+
### Examples
|
361
|
+
|
362
|
+
```ruby
|
363
|
+
require 'time'
|
364
|
+
require 'propertyware'
|
365
|
+
# setup authorization
|
366
|
+
Propertyware.configure do |config|
|
367
|
+
# Configure API key authorization: organizationId
|
368
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
369
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
370
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
371
|
+
|
372
|
+
# Configure API key authorization: clientId
|
373
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
374
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
375
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
376
|
+
|
377
|
+
# Configure API key authorization: clientSecret
|
378
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
379
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
380
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
381
|
+
end
|
382
|
+
|
383
|
+
api_instance = Propertyware::DocumentsApi.new
|
384
|
+
entity_id = 789 # Integer | Unique identifier of an entity document is attached to.
|
385
|
+
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)
|
386
|
+
body = File.new('/path/to/some/file') # File |
|
387
|
+
opts = {
|
388
|
+
publish_to_tenant_portal: true, # Boolean | Indicates if the document is published to the tenant portal.
|
389
|
+
publish_to_owner_portal: true # Boolean | Indicates if the document is published to the owner portal.
|
390
|
+
}
|
391
|
+
|
392
|
+
begin
|
393
|
+
# Upload a document (BETA)
|
394
|
+
result = api_instance.upload_document(entity_id, entity_type, body, opts)
|
395
|
+
p result
|
396
|
+
rescue Propertyware::ApiError => e
|
397
|
+
puts "Error when calling DocumentsApi->upload_document: #{e}"
|
398
|
+
end
|
399
|
+
```
|
400
|
+
|
401
|
+
#### Using the upload_document_with_http_info variant
|
402
|
+
|
403
|
+
This returns an Array which contains the response data, status code and headers.
|
404
|
+
|
405
|
+
> <Array(<Document>, Integer, Hash)> upload_document_with_http_info(entity_id, entity_type, body, opts)
|
406
|
+
|
407
|
+
```ruby
|
408
|
+
begin
|
409
|
+
# Upload a document (BETA)
|
410
|
+
data, status_code, headers = api_instance.upload_document_with_http_info(entity_id, entity_type, body, opts)
|
411
|
+
p status_code # => 2xx
|
412
|
+
p headers # => { ... }
|
413
|
+
p data # => <Document>
|
414
|
+
rescue Propertyware::ApiError => e
|
415
|
+
puts "Error when calling DocumentsApi->upload_document_with_http_info: #{e}"
|
416
|
+
end
|
417
|
+
```
|
418
|
+
|
419
|
+
### Parameters
|
420
|
+
|
421
|
+
| Name | Type | Description | Notes |
|
422
|
+
| ---- | ---- | ----------- | ----- |
|
423
|
+
| **entity_id** | **Integer** | Unique identifier of an entity document is attached to. | |
|
424
|
+
| **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) | |
|
425
|
+
| **body** | **File** | | |
|
426
|
+
| **publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
|
427
|
+
| **publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
|
428
|
+
|
429
|
+
### Return type
|
430
|
+
|
431
|
+
[**Document**](Document.md)
|
432
|
+
|
433
|
+
### Authorization
|
434
|
+
|
435
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
436
|
+
|
437
|
+
### HTTP request headers
|
438
|
+
|
439
|
+
- **Content-Type**: application/octet-stream
|
440
|
+
- **Accept**: application/json
|
441
|
+
|
data/docs/LeasesApi.md
CHANGED
@@ -25,6 +25,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
|
25
25
|
| [**get_lease_contacts**](LeasesApi.md#get_lease_contacts) | **GET** /leases/{leaseId}/contacts | Retrieve all lease contacts |
|
26
26
|
| [**get_lease_conversation**](LeasesApi.md#get_lease_conversation) | **GET** /leases/{leaseID}/conversations/{conversationID} | Retrieve a lease conversation |
|
27
27
|
| [**get_lease_conversations**](LeasesApi.md#get_lease_conversations) | **GET** /leases/{leaseID}/conversations | Retrieve all lease conversations |
|
28
|
+
| [**get_lease_credit_memos**](LeasesApi.md#get_lease_credit_memos) | **GET** /leases/creditmemos | Retrieve all the credit memos |
|
28
29
|
| [**get_lease_custom_fields**](LeasesApi.md#get_lease_custom_fields) | **GET** /leases/{leaseId}/customfields | Retrieve all lease custom fields |
|
29
30
|
| [**get_lease_discounts**](LeasesApi.md#get_lease_discounts) | **GET** /leases/discounts | Retrieve all the lease discounts |
|
30
31
|
| [**get_lease_documents**](LeasesApi.md#get_lease_documents) | **GET** /leases/{leaseId}/document | Retrieve all lease documents |
|
@@ -1817,6 +1818,107 @@ end
|
|
1817
1818
|
- **Accept**: application/json
|
1818
1819
|
|
1819
1820
|
|
1821
|
+
## get_lease_credit_memos
|
1822
|
+
|
1823
|
+
> <Array<CreditMemo>> get_lease_credit_memos(opts)
|
1824
|
+
|
1825
|
+
Retrieve all the credit memos
|
1826
|
+
|
1827
|
+
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>
|
1828
|
+
|
1829
|
+
### Examples
|
1830
|
+
|
1831
|
+
```ruby
|
1832
|
+
require 'time'
|
1833
|
+
require 'propertyware'
|
1834
|
+
# setup authorization
|
1835
|
+
Propertyware.configure do |config|
|
1836
|
+
# Configure API key authorization: organizationId
|
1837
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1838
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1839
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1840
|
+
|
1841
|
+
# Configure API key authorization: clientId
|
1842
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1843
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1844
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1845
|
+
|
1846
|
+
# Configure API key authorization: clientSecret
|
1847
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1848
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1849
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
api_instance = Propertyware::LeasesApi.new
|
1853
|
+
opts = {
|
1854
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
1855
|
+
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.
|
1856
|
+
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.
|
1857
|
+
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.
|
1858
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
1859
|
+
post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
|
1860
|
+
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.
|
1861
|
+
portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
|
1862
|
+
lease_id: 789, # Integer | Filters results with Lease ID.
|
1863
|
+
status: 'status_example' # String | Filters results to with Lease Status.
|
1864
|
+
}
|
1865
|
+
|
1866
|
+
begin
|
1867
|
+
# Retrieve all the credit memos
|
1868
|
+
result = api_instance.get_lease_credit_memos(opts)
|
1869
|
+
p result
|
1870
|
+
rescue Propertyware::ApiError => e
|
1871
|
+
puts "Error when calling LeasesApi->get_lease_credit_memos: #{e}"
|
1872
|
+
end
|
1873
|
+
```
|
1874
|
+
|
1875
|
+
#### Using the get_lease_credit_memos_with_http_info variant
|
1876
|
+
|
1877
|
+
This returns an Array which contains the response data, status code and headers.
|
1878
|
+
|
1879
|
+
> <Array(<Array<CreditMemo>>, Integer, Hash)> get_lease_credit_memos_with_http_info(opts)
|
1880
|
+
|
1881
|
+
```ruby
|
1882
|
+
begin
|
1883
|
+
# Retrieve all the credit memos
|
1884
|
+
data, status_code, headers = api_instance.get_lease_credit_memos_with_http_info(opts)
|
1885
|
+
p status_code # => 2xx
|
1886
|
+
p headers # => { ... }
|
1887
|
+
p data # => <Array<CreditMemo>>
|
1888
|
+
rescue Propertyware::ApiError => e
|
1889
|
+
puts "Error when calling LeasesApi->get_lease_credit_memos_with_http_info: #{e}"
|
1890
|
+
end
|
1891
|
+
```
|
1892
|
+
|
1893
|
+
### Parameters
|
1894
|
+
|
1895
|
+
| Name | Type | Description | Notes |
|
1896
|
+
| ---- | ---- | ----------- | ----- |
|
1897
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
1898
|
+
| **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] |
|
1899
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
1900
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
1901
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
1902
|
+
| **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
|
1903
|
+
| **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
|
1904
|
+
| **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
|
1905
|
+
| **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
|
1906
|
+
| **status** | **String** | Filters results to with Lease Status. | [optional] |
|
1907
|
+
|
1908
|
+
### Return type
|
1909
|
+
|
1910
|
+
[**Array<CreditMemo>**](CreditMemo.md)
|
1911
|
+
|
1912
|
+
### Authorization
|
1913
|
+
|
1914
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1915
|
+
|
1916
|
+
### HTTP request headers
|
1917
|
+
|
1918
|
+
- **Content-Type**: Not defined
|
1919
|
+
- **Accept**: application/json
|
1920
|
+
|
1921
|
+
|
1820
1922
|
## get_lease_custom_fields
|
1821
1923
|
|
1822
1924
|
> <Array<CustomField>> get_lease_custom_fields(lease_id)
|
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/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/Unit.md
CHANGED
@@ -28,7 +28,7 @@
|
|
28
28
|
| **name** | **String** | Name of the property. | [optional] |
|
29
29
|
| **neighborhood** | **String** | Property neighborhood. | [optional] |
|
30
30
|
| **number_floors** | **Integer** | Number floors | [optional] |
|
31
|
-
| **number_of_bathrooms** | **
|
31
|
+
| **number_of_bathrooms** | **Float** | Number of bathrooms in the property. | [optional] |
|
32
32
|
| **number_of_bedrooms** | **Integer** | Number of bedrooms in the property. | [optional] |
|
33
33
|
| **portfolio_id** | **Integer** | ID of the portfolio associated with this property. | [optional] |
|
34
34
|
| **property_manager_list** | [**Array<PropertyManager>**](PropertyManager.md) | Property manager details. | [optional] |
|
@@ -37,7 +37,7 @@
|
|
37
37
|
| **search_tag** | **String** | Property search tag. | [optional] |
|
38
38
|
| **status** | **String** | Property status (occupied/vacant). | [optional] |
|
39
39
|
| **syndicate** | **Boolean** | Property syndicate. | [optional] |
|
40
|
-
| **target_deposit** | **
|
40
|
+
| **target_deposit** | **Float** | Target deposit. | [optional] |
|
41
41
|
| **target_rent** | **Float** | Property target rent. | [optional] |
|
42
42
|
| **target_rent_units** | **String** | Property target rent units. | [optional] |
|
43
43
|
| **total_area** | **Float** | Property total area. | [optional] |
|