propertyware 1.0.5

data/docs/Conversation.md

@@ -0,0 +1,36 @@
+# Propertyware::Conversation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comments** | [**Array<Comment>**](Comment.md) | List of comments in the conversation. | [optional] |
+| **created_by** | **String** | User who created the record. | [optional] |
+| **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
+| **entity_id** | **Integer** | Id of the entity related to this conversation. | [optional] |
+| **entity_type** | **String** | Type of the entity related to this conversation. | [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] |
+| **subject** | **String** | Conversation subject. | [optional] |
+| **type** | **String** | Conversation type. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Conversation.new(
+  comments: null,
+  created_by: null,
+  created_date_time: null,
+  entity_id: null,
+  entity_type: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  subject: null,
+  type: null
+)
+```
+

data/docs/CreditCardAccount.md

@@ -0,0 +1,18 @@
+# Propertyware::CreditCardAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_card_number** | **String** | Credit card number. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CreditCardAccount.new(
+  credit_card_number: null
+)
+```
+

data/docs/CurrentAsset.md

@@ -0,0 +1,30 @@
+# Propertyware::CurrentAsset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_account** | **Boolean** | Indicates if the account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if the account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if the account is excluded from 1099 tax forms. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if the account is a tax account. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluded from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if the account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if the account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CurrentAsset.new(
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/CurrentLiability.md

@@ -0,0 +1,30 @@
+# Propertyware::CurrentLiability
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_account** | **Boolean** | Indicates if the account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if the account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if the account is excluded from 1099 tax forms. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if the account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if the account is excluded from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if the account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if the account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CurrentLiability.new(
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/CustomField.md

@@ -0,0 +1,24 @@
+# Propertyware::CustomField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data_type** | **String** | Data type of the custom field. | [optional] |
+| **definition_id** | **Integer** | Id of the custom field definition. | [optional] |
+| **field_name** | **String** | Name of the custom field. | [optional] |
+| **value** | **String** | Value of the custom field. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::CustomField.new(
+  data_type: null,
+  definition_id: null,
+  field_name: null,
+  value: null
+)
+```
+

data/docs/Discount.md

@@ -0,0 +1,40 @@
+# Propertyware::Discount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount. |  |
+| **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 discount. | [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 discount. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this transaction. | [optional] |
+| **ref_no** | **String** | Reference number. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Discount.new(
+  amount: 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,
+  portfolio_id: null,
+  ref_no: null
+)
+```
+

data/docs/Document.md

@@ -0,0 +1,40 @@
+# Propertyware::Document
+
+## 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] |
+| **description** | **String** | Description of a document. | [optional] |
+| **entity_id** | **Integer** | Unique identifier of an entity document is attached to. | [optional] |
+| **entity_type** | **String** | Type of an entity document is attached to. | [optional] |
+| **file_type** | **String** | File type. | [optional] |
+| **filename** | **String** | File name. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **indicates_if_publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
+| **indicates_if_publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [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] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Document.new(
+  created_by: null,
+  created_date_time: null,
+  description: null,
+  entity_id: null,
+  entity_type: null,
+  file_type: null,
+  filename: null,
+  id: null,
+  indicates_if_publish_to_owner_portal: false,
+  indicates_if_publish_to_tenant_portal: false,
+  last_modified_by: null,
+  last_modified_date_time: null
+)
+```
+

data/docs/DocumentsApi.md

@@ -0,0 +1,267 @@
+# Propertyware::DocumentsApi
+
+All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**download_document**](DocumentsApi.md#download_document) | **GET** /docs/{documentId}/download | Download a document |
+| [**retrieve_all_documents**](DocumentsApi.md#retrieve_all_documents) | **GET** /docs | Retrieve all documents |
+| [**retrieve_document**](DocumentsApi.md#retrieve_document) | **GET** /docs/{documentId} | Retrieve a document |
+
+
+## download_document
+
+> <ResponseEntity> download_document(document_id)
+
+Download a document
+
+Retrieve a temporary download URL for a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'propertyware'
+# setup authorization
+Propertyware.configure do |config|
+  # Configure API key authorization: organizationId
+  config.api_key['organizationId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['organizationId'] = 'Bearer'
+
+  # Configure API key authorization: clientId
+  config.api_key['clientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientId'] = 'Bearer'
+
+  # Configure API key authorization: clientSecret
+  config.api_key['clientSecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientSecret'] = 'Bearer'
+end
+
+api_instance = Propertyware::DocumentsApi.new
+document_id = 789 # Integer | ID of the document to download
+
+begin
+  # Download a document
+  result = api_instance.download_document(document_id)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->download_document: #{e}"
+end
+```
+
+#### Using the download_document_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEntity>, Integer, Hash)> download_document_with_http_info(document_id)
+
+```ruby
+begin
+  # Download a document
+  data, status_code, headers = api_instance.download_document_with_http_info(document_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEntity>
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->download_document_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_id** | **Integer** | ID of the document to download |  |
+
+### Return type
+
+[**ResponseEntity**](ResponseEntity.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
+## retrieve_all_documents
+
+> <Array<Document>> retrieve_all_documents(entity_type, opts)
+
+Retrieve all documents
+
+Retrieves a list of documents associated with a specific entity.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
+
+### Examples
+
+```ruby
+require 'time'
+require 'propertyware'
+# setup authorization
+Propertyware.configure do |config|
+  # Configure API key authorization: organizationId
+  config.api_key['organizationId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['organizationId'] = 'Bearer'
+
+  # Configure API key authorization: clientId
+  config.api_key['clientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientId'] = 'Bearer'
+
+  # Configure API key authorization: clientSecret
+  config.api_key['clientSecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientSecret'] = 'Bearer'
+end
+
+api_instance = Propertyware::DocumentsApi.new
+entity_type = 'APPOINTMENT' # String | Filters results to documents associated with a specific entity type.
+opts = {
+  offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
+  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.
+  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. 
+  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. 
+  orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
+  entity_id: 789 # Integer | Filters results to documents associated with a specific entity id.
+}
+
+begin
+  # Retrieve all documents
+  result = api_instance.retrieve_all_documents(entity_type, opts)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->retrieve_all_documents: #{e}"
+end
+```
+
+#### Using the retrieve_all_documents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Document>>, Integer, Hash)> retrieve_all_documents_with_http_info(entity_type, opts)
+
+```ruby
+begin
+  # Retrieve all documents
+  data, status_code, headers = api_instance.retrieve_all_documents_with_http_info(entity_type, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Document>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->retrieve_all_documents_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_type** | **String** | Filters results to documents associated with a specific entity type. |  |
+| **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
+| **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. | [optional][default to 100] |
+| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified.  | [optional] |
+| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified.  | [optional] |
+| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
+| **entity_id** | **Integer** | Filters results to documents associated with a specific entity id. | [optional] |
+
+### Return type
+
+[**Array&lt;Document&gt;**](Document.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retrieve_document
+
+> <Document> retrieve_document(document_id)
+
+Retrieve a document
+
+Retrieves the metadata of a specific document.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Read</code> 
+
+### Examples
+
+```ruby
+require 'time'
+require 'propertyware'
+# setup authorization
+Propertyware.configure do |config|
+  # Configure API key authorization: organizationId
+  config.api_key['organizationId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['organizationId'] = 'Bearer'
+
+  # Configure API key authorization: clientId
+  config.api_key['clientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientId'] = 'Bearer'
+
+  # Configure API key authorization: clientSecret
+  config.api_key['clientSecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientSecret'] = 'Bearer'
+end
+
+api_instance = Propertyware::DocumentsApi.new
+document_id = 789 # Integer | ID of the document to retrieve
+
+begin
+  # Retrieve a document
+  result = api_instance.retrieve_document(document_id)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->retrieve_document: #{e}"
+end
+```
+
+#### Using the retrieve_document_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Document>, Integer, Hash)> retrieve_document_with_http_info(document_id)
+
+```ruby
+begin
+  # Retrieve a document
+  data, status_code, headers = api_instance.retrieve_document_with_http_info(document_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Document>
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->retrieve_document_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_id** | **Integer** | ID of the document to retrieve |  |
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Entry.md

@@ -0,0 +1,34 @@
+# Propertyware::Entry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **building_id** | **Integer** | Id of the building associated with this entry. | [optional] |
+| **comment** | **String** | Transaction comment. | [optional] |
+| **credit** | **Float** | Credit amount. | [optional] |
+| **debit** | **Float** | Debit amount. | [optional] |
+| **glaccount_code** | **String** |  | [optional] |
+| **glaccount_id** | **Integer** |  | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **portfolio_id** | **Integer** | Id of the portfolio associated with this entry. | [optional] |
+| **unit_id** | **Integer** | Id of the unit associated with this entry. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Entry.new(
+  building_id: null,
+  comment: null,
+  credit: null,
+  debit: null,
+  glaccount_code: null,
+  glaccount_id: null,
+  id: null,
+  portfolio_id: null,
+  unit_id: null
+)
+```
+

data/docs/Equity.md

@@ -0,0 +1,32 @@
+# Propertyware::Equity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
+| **transfer_balance_to_retained_earnings** | **Boolean** | Indicates if Transfer balance at year end to Retained earnings. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Equity.new(
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false,
+  transfer_balance_to_retained_earnings: false
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,22 @@
+# Propertyware::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  | [optional] |
+| **errors** | [**Array<RESTAPIError>**](RESTAPIError.md) |  | [optional] |
+| **user_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ErrorResponse.new(
+  error_code: null,
+  errors: null,
+  user_message: null
+)
+```
+

data/docs/Expense.md

@@ -0,0 +1,32 @@
+# Propertyware::Expense
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cam_recovery_account** | **Boolean** | Indicates if account is a CAM recovery account. | [optional] |
+| **discount_account** | **Boolean** | Indicates if account is a discount account. | [optional] |
+| **escrow_account** | **Boolean** | Indicates if account is a escrow account. | [optional] |
+| **exclude_from1099** | **Boolean** | Indicates if account is excluded from Form1099. | [optional] |
+| **exclude_from_pay_in_full** | **Boolean** | Indicates if account is excluded from paying in full. | [optional] |
+| **exclude_late_fee** | **Boolean** | Indicates if excluding from late fees. | [optional] |
+| **rent_account** | **Boolean** | Indicates if account is a rent account. | [optional] |
+| **tax_account** | **Boolean** | Indicates if account is a tax account. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::Expense.new(
+  cam_recovery_account: false,
+  discount_account: false,
+  escrow_account: false,
+  exclude_from1099: false,
+  exclude_from_pay_in_full: false,
+  exclude_late_fee: false,
+  rent_account: false,
+  tax_account: false
+)
+```
+

data/docs/GLItem.md

@@ -0,0 +1,40 @@
+# Propertyware::GLItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **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] |
+| **glentries** | [**Array<Entry>**](Entry.md) |  | [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 transaction. | [optional] |
+| **owner_id** | **Integer** | Id of the owner associated with this transaction. | [optional] |
+| **transaction_type** | **String** | Transaction type. | [optional] |
+| **tx_date** | **Date** | Transaction date. | [optional] |
+| **vendor_id** | **Integer** | Id of the vendor associated with this transaction. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::GLItem.new(
+  comment: null,
+  created_by: null,
+  created_date_time: null,
+  glentries: null,
+  id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
+  lease_id: null,
+  owner_id: null,
+  transaction_type: null,
+  tx_date: null,
+  vendor_id: null
+)
+```
+