propertyware 1.0.5

data/docs/Campaign.md

@@ -0,0 +1,60 @@
+# Propertyware::Campaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accepted_call_tracking_terms** | **Boolean** | Indicates if the call tracking terms have been accepted. | [optional] |
+| **call_tracking_campaign_id** | **String** | Campaign ID used for call tracking. | [optional] |
+| **call_tracking_enabled** | **Boolean** | Indicates if call tracking is enabled for the campaign. | [optional] |
+| **call_tracking_forwar** | **String** | Number to which call tracking calls are forwarded. | [optional] |
+| **call_tracking_forwar_after_hours** | **String** | Number to which call tracking calls are forwarded after hours. | [optional] |
+| **call_tracking_phone_number** | **String** | Phone number used for call tracking. | [optional] |
+| **call_tracking_referrer** | **String** | Referrer for call tracking. | [optional] |
+| **call_tracking_search_phrase** | **String** | Search phrase for call tracking. | [optional] |
+| **campaign_source** | [**CampaignSource**](CampaignSource.md) |  | [optional] |
+| **code** | **String** | Code of the campaign. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **custom_fields** | [**Array<CustomField>**](CustomField.md) | Custom fields. | [optional] |
+| **description** | **String** | Description of the campaign. | [optional] |
+| **end_date** | **Date** | End date of the campaign. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **name** | **String** | Name of the campaign. | [optional] |
+| **start_date** | **Date** | Start date of the campaign. | [optional] |
+| **target_prospect_type** | **String** | Type of the targeted prospect. | [optional] |
+| **timezone** | **String** | Time zone of the campaign. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Campaign.new(
+  accepted_call_tracking_terms: false,
+  call_tracking_campaign_id: null,
+  call_tracking_enabled: false,
+  call_tracking_forwar: null,
+  call_tracking_forwar_after_hours: null,
+  call_tracking_phone_number: null,
+  call_tracking_referrer: null,
+  call_tracking_search_phrase: null,
+  campaign_source: null,
+  code: null,
+  created_by: null,
+  created_date_time: null,
+  custom_fields: null,
+  description: null,
+  end_date: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  name: null,
+  start_date: null,
+  target_prospect_type: null,
+  timezone: null
+)
+```
+

data/docs/CampaignSource.md

@@ -0,0 +1,26 @@
+# Propertyware::CampaignSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **call_tracking_group_id** | **String** | Call tracking group id. | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **name** | **String** | Name of the campaign source. | [optional] |
+| **referrer_domain** | **String** | Referrer domain. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CampaignSource.new(
+  call_tracking_group_id: null,
+  default: null,
+  id: null,
+  name: null,
+  referrer_domain: null
+)
+```
+

data/docs/Charge.md

@@ -0,0 +1,36 @@
+# Propertyware::Charge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | General ledger account. | [optional] |
+| **amount** | **Float** | Amount. | [optional] |
+| **description** | **String** | Description of the auto charge. | [optional] |
+| **due_day** | **String** | Description of the day when the auto charge is due. | [optional] |
+| **end_date** | **Date** | End date of auto charge. | [optional] |
+| **frequency** | **String** | Frequency of the auto charge. |  |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_post_date** | **Date** | Last post date. | [optional] |
+| **reference_number** | **String** | Reference number. | [optional] |
+| **start_date** | **Date** | Start date. |  |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Charge.new(
+  account: null,
+  amount: null,
+  description: null,
+  due_day: null,
+  end_date: null,
+  frequency: null,
+  id: null,
+  last_post_date: null,
+  reference_number: null,
+  start_date: null
+)
+```
+

data/docs/ChargeTx.md

@@ -0,0 +1,52 @@
+# Propertyware::ChargeTx
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **amount_due** | **Float** | The amount due for the charge. | [optional] |
+| **amount_paid** | **Float** | The amount paid for the charge. | [optional] |
+| **charge_status** | **String** | Status of the charge. | [optional] |
+| **comments** | **String** | Comments. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **date** | **Date** | Post date. |  |
+| **gl_account_id** | **Integer** | Id of the general ledger account associated with this charge. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **lease_id** | **Integer** | Id of the lease associated with this charge. | [optional] |
+| **parent_tx_id** | **Integer** | Parent Charge ID. If parent charge date and recharge date are same consider it as a hidden recharge and do not include it in ledger balance calculation. | [optional] |
+| **payments** | [**Array<PaymentCharge>**](PaymentCharge.md) | List of payment charge history. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this charge. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **status** | **String** | The status of the lease. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ChargeTx.new(
+  amount: null,
+  amount_due: null,
+  amount_paid: null,
+  charge_status: null,
+  comments: null,
+  created_by: null,
+  created_date_time: null,
+  date: null,
+  gl_account_id: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  lease_id: null,
+  parent_tx_id: null,
+  payments: null,
+  portfolio_id: null,
+  ref_no: null,
+  status: null
+)
+```
+

data/docs/Check.md

@@ -0,0 +1,48 @@
+# Propertyware::Check
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **check_splits** | [**Array<CheckSplit>**](CheckSplit.md) | List of check splits. | [optional] |
+| **comments** | **String** | Comments. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **date** | **Date** | Post date. |  |
+| **destination_account_id** | **Integer** | Destination general ledger account ID associated with this check. |  |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **payee_payer** | **String** | Name of the payee or payer. |  |
+| **payment_type** | **String** | Type of payment. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this transaction. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+| **to_be_printed** | **Boolean** | Indicates if the check is to be printed. | [optional] |
+| **vendor_id** | **Integer** | Id of the vendor associated with this check. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Check.new(
+  amount: null,
+  check_splits: null,
+  comments: null,
+  created_by: null,
+  created_date_time: null,
+  date: null,
+  destination_account_id: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  payee_payer: null,
+  payment_type: null,
+  portfolio_id: null,
+  ref_no: null,
+  to_be_printed: false,
+  vendor_id: null
+)
+```
+

data/docs/CheckSplit.md

@@ -0,0 +1,30 @@
+# Propertyware::CheckSplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. | [optional] |
+| **building_id** | **Integer** | Id of the building associated with this check split. | [optional] |
+| **comments** | **String** | Comments. | [optional] |
+| **gl_account_id** | **Integer** | Id of the general ledger account associated with this check split. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this check split. |  |
+| **unit_id** | **Integer** | Id of the unit associated with this check split. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CheckSplit.new(
+  amount: null,
+  building_id: null,
+  comments: null,
+  gl_account_id: null,
+  id: null,
+  portfolio_id: null,
+  unit_id: null
+)
+```
+

data/docs/Comment.md

@@ -0,0 +1,28 @@
+# Propertyware::Comment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **text** | **String** | Comment text. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Comment.new(
+  created_by: null,
+  created_date_time: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  text: null
+)
+```
+

data/docs/Contact.md

@@ -0,0 +1,74 @@
+# Propertyware::Contact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **allow_e_signature** | **Boolean** | Indicates if the contact can receive eSignature request e-mail messages sent through Propertyware. | [optional] |
+| **alt_email** | **String** | Alternate e-mail address. | [optional] |
+| **birth_date** | **Date** | Date of birth. | [optional] |
+| **category** | **String** | Contact category. | [optional] |
+| **comments** | **String** | Comments. | [optional] |
+| **company** | **String** | Company where the contact is employed. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **custom_fields** | [**Array<CustomField>**](CustomField.md) | Custom fields. | [optional] |
+| **email** | **String** | E-mail address. | [optional] |
+| **fax** | **String** | Fax. | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **gender** | **String** | Gender. | [optional] |
+| **home_phone** | **String** | Home phone. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **job_title** | **String** | Professional title or position for the contact. | [optional] |
+| **last_modified_by** | **String** | User who last modified the record. | [optional] |
+| **last_modified_date_time** | **Time** | Date and time the record was last modified. (Timezone: UTC) | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **middle_name** | **String** | Middle name. | [optional] |
+| **mobile_phone** | **String** | Mobile phone. | [optional] |
+| **name_on_check** | **String** | Name on check. | [optional] |
+| **named_on_lease** | **Boolean** | Indicates if contact is named on lease. | [optional] |
+| **other_phone** | **String** | Other phone. | [optional] |
+| **salutation** | **String** | Salutation. | [optional] |
+| **suffix** | **String** | Suffix. | [optional] |
+| **type** | **String** | Contact type. | [optional] |
+| **work_phone** | **String** | Work phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Contact.new(
+  address: null,
+  allow_e_signature: false,
+  alt_email: null,
+  birth_date: null,
+  category: null,
+  comments: null,
+  company: null,
+  created_by: null,
+  created_date_time: null,
+  custom_fields: null,
+  email: null,
+  fax: null,
+  first_name: null,
+  gender: null,
+  home_phone: null,
+  id: null,
+  job_title: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  last_name: null,
+  middle_name: null,
+  mobile_phone: null,
+  name_on_check: null,
+  named_on_lease: false,
+  other_phone: null,
+  salutation: null,
+  suffix: null,
+  type: null,
+  work_phone: null
+)
+```
+