propertyware 1.1.0 → 1.2.0

data/docs/AutoPayment.md

@@ -12,6 +12,7 @@
 | **end_date** | **Date** | End date. | [optional] |
 | **fee_amount** | **Float** | Fee amount. | [optional] |
 | **frequency** | **String** | Payment frequency. | [optional] |
+| **gl_account_id** | **Integer** | Payment general ledger account ID. | [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] |
@@ -32,6 +33,7 @@ instance = Propertyware::AutoPayment.new(
   end_date: null,
   fee_amount: null,
   frequency: null,
+  gl_account_id: null,
   id: null,
   last_modified_by: null,
   last_modified_date_time: null,

data/docs/Charge.md

@@ -5,15 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **account** | **String** | General ledger account. | [optional] |
-| **amount** | **Float** | Amount. | [optional] |
+| **amount** | **Float** | Auto charge 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. |  |
+| **gl_account_id** | **Integer** | ID of the General Ledger Account associated to this auto charge. | [optional] |
 | **id** | **Integer** | Unique identifier. | [optional] |
 | **last_post_date** | **Date** | Last post date. | [optional] |
 | **reference_number** | **String** | Reference number. | [optional] |
-| **start_date** | **Date** | Start date. |  |
+| **start_date** | **Date** | Start date of auto charge. |  |
 
 ## Example
 
@@ -27,6 +28,7 @@ instance = Propertyware::Charge.new(
   due_day: null,
   end_date: null,
   frequency: null,
+  gl_account_id: null,
   id: null,
   last_post_date: null,
   reference_number: null,

data/docs/{CustomFieldDefinitionsApi.md → CustomFieldFieldsApi.md}

@@ -1,10 +1,10 @@
-# Propertyware::CustomFieldDefinitionsApi
+# Propertyware::CustomFieldFieldsApi
 
 All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**retrieve_custom_field_definitions**](CustomFieldDefinitionsApi.md#retrieve_custom_field_definitions) | **GET** /customfields/{entityType}/definitions | Retrieve list of custom field definitions. |
+| [**retrieve_custom_field_definitions**](CustomFieldFieldsApi.md#retrieve_custom_field_definitions) | **GET** /customfields/{entityType}/definitions | Retrieve list of custom field definitions. |
 
 
 ## retrieve_custom_field_definitions
@@ -38,7 +38,7 @@ Propertyware.configure do |config|
   # config.api_key_prefix['clientSecret'] = 'Bearer'
 end
 
-api_instance = Propertyware::CustomFieldDefinitionsApi.new
+api_instance = Propertyware::CustomFieldFieldsApi.new
 entity_type = 'entity_type_example' # String | Entity type, allowed entity types (Asset, Building, Contact, Lease, Portfolio, Prospect, Unit, Vendor, WorkOrder, ServiceAgreement)
 
 begin
@@ -46,7 +46,7 @@ begin
   result = api_instance.retrieve_custom_field_definitions(entity_type)
   p result
 rescue Propertyware::ApiError => e
-  puts "Error when calling CustomFieldDefinitionsApi->retrieve_custom_field_definitions: #{e}"
+  puts "Error when calling CustomFieldFieldsApi->retrieve_custom_field_definitions: #{e}"
 end
 ```
 
@@ -64,7 +64,7 @@ begin
   p headers # => { ... }
   p data # => <Array<CustomFieldDefinition>>
 rescue Propertyware::ApiError => e
-  puts "Error when calling CustomFieldDefinitionsApi->retrieve_custom_field_definitions_with_http_info: #{e}"
+  puts "Error when calling CustomFieldFieldsApi->retrieve_custom_field_definitions_with_http_info: #{e}"
 end
 ```
 

data/docs/Document.md

@@ -9,13 +9,13 @@
 | **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_name** | **String** | File name. | [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] |
+| **publish_to_owner_portal** | **Boolean** | Indicates if the document is published to the owner portal. | [optional] |
+| **publish_to_tenant_portal** | **Boolean** | Indicates if the document is published to the tenant portal. | [optional] |
 
 ## Example
 
@@ -28,13 +28,13 @@ instance = Propertyware::Document.new(
   description: null,
   entity_id: null,
   entity_type: null,
+  file_name: 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
+  last_modified_date_time: null,
+  publish_to_owner_portal: false,
+  publish_to_tenant_portal: false
 )
 ```
 

data/docs/DocumentsApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
 | [**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 |
+| [**update_document**](DocumentsApi.md#update_document) | **PUT** /docs/{documentId} | Update a document (BETA) |
 | [**upload_document**](DocumentsApi.md#upload_document) | **POST** /docs | Upload a document (BETA) |
 
 
@@ -212,7 +213,7 @@ opts = {
   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. entity ID is not required for “DESKTOP” and “OTHER”. Remaining entities need “entity ID”.
+  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†.
 }
 
 begin
@@ -252,7 +253,7 @@ end
 | **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. entity ID is not required for “DESKTOP” and “OTHER”. Remaining entities need “entity ID”. | [optional] |
+| **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] |
 
 ### Return type
 
@@ -349,6 +350,89 @@ end
 - **Accept**: application/json
 
 
+## update_document
+
+> <Document> update_document(document_id, update_document)
+
+Update a document (BETA)
+
+<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> 
+
+### 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 be updated
+update_document = Propertyware::UpdateDocument.new({file_name: 'file_name_example'}) # UpdateDocument | updateDocument
+
+begin
+  # Update a document (BETA)
+  result = api_instance.update_document(document_id, update_document)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->update_document: #{e}"
+end
+```
+
+#### Using the update_document_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Document>, Integer, Hash)> update_document_with_http_info(document_id, update_document)
+
+```ruby
+begin
+  # Update a document (BETA)
+  data, status_code, headers = api_instance.update_document_with_http_info(document_id, update_document)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Document>
+rescue Propertyware::ApiError => e
+  puts "Error when calling DocumentsApi->update_document_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_id** | **Integer** | ID of the document to be updated |  |
+| **update_document** | [**UpdateDocument**](UpdateDocument.md) | updateDocument |  |
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## upload_document
 
 > <Document> upload_document(entity_id, entity_type, body, opts)

data/docs/Lease.md

@@ -4,11 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | **Boolean** | Active | [optional] |
-| **addendums** | [**Array<LeaseClause>**](LeaseClause.md) | Lease addendums. | [optional] |
+| **active** | **Boolean** | Indicates if lease is Active. | [optional] |
+| **addendums** | [**Array<LeaseClause>**](LeaseClause.md) | Lease addendum(s). | [optional] |
+| **base_rent** | **Float** | Property base rent. | [optional] |
 | **building_id** | **Integer** | Id of the building associated with this lease. | [optional] |
 | **comments** | **String** | Description of the lease. | [optional] |
-| **contacts** | [**Array<LeaseContact>**](LeaseContact.md) | Contacts of the lease | [optional] |
+| **contacts** | [**Array<LeaseContact>**](LeaseContact.md) | List of the current tenants on the lease. | [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] |
@@ -18,8 +19,8 @@
 | **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] |
 | **late_fee_rule** | **String** | Textual description of the late fee rule applied to delinquent or unpaid lease charges. | [optional] |
-| **lease_balance** | **Float** | Lease Balance | [optional] |
-| **lease_name** | **String** | Lease Name | [optional] |
+| **lease_balance** | **Float** | Lease Balance. | [optional] |
+| **lease_name** | **String** | Lease Name. | [optional] |
 | **location** | **String** | Building and/or units the lease is currently attached to. | [optional] |
 | **move_in_date** | **Date** | Day that the tenant(s) moved into the property. | [optional] |
 | **move_out_date** | **Date** | Day that the tenant(s) vacated the property. | [optional] |
@@ -29,10 +30,12 @@
 | **public_assistance_program** | **String** | Indicates if the tenant(s) of the lease receive any aid from a Public Assistance Program. | [optional] |
 | **reason_for_leaving** | **String** | Reason for vacating the property. | [optional] |
 | **schedule_move_out_date** | **Date** | Day that the tenant(s) are expected to vacate the property. | [optional] |
+| **search_tag** | **String** | Search tag. | [optional] |
+| **signed_date** | **Date** | Lease signed date. | [optional] |
 | **start_date** | **Date** | Start date of the lease term. | [optional] |
 | **status** | **String** | Lease's current status. | [optional] |
 | **tenants_opts_into_asset_protection_plan** | **String** | Indicates if the tenants opted into Asset Protection Plan. | [optional] |
-| **terminated_date** | **Date** | Terminated Date | [optional] |
+| **terminated_date** | **Date** | Lease Terminated Date. | [optional] |
 | **unit_id** | **Integer** | Id of the unit associated with this lease. | [optional] |
 
 ## Example
@@ -43,6 +46,7 @@ require 'propertyware'
 instance = Propertyware::Lease.new(
   active: false,
   addendums: null,
+  base_rent: null,
   building_id: null,
   comments: null,
   contacts: null,
@@ -66,6 +70,8 @@ instance = Propertyware::Lease.new(
   public_assistance_program: null,
   reason_for_leaving: null,
   schedule_move_out_date: null,
+  search_tag: null,
+  signed_date: null,
   start_date: null,
   status: null,
   tenants_opts_into_asset_protection_plan: null,

data/docs/LeaseStatus.md

@@ -0,0 +1,28 @@
+# Propertyware::LeaseStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **define_active** | **Boolean** |  | [optional] |
+| **id** | **Integer** |  | [optional] |
+| **order_index** | **Integer** |  | [optional] |
+| **portal_login_enabled** | **Boolean** |  | [optional] |
+| **readonly** | **Boolean** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::LeaseStatus.new(
+  define_active: null,
+  id: null,
+  order_index: null,
+  portal_login_enabled: null,
+  readonly: null,
+  status: null
+)
+```
+

data/docs/LeasesApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
 | [**create_lease_refund**](LeasesApi.md#create_lease_refund) | **POST** /leases/refunds | Create a lease refund (BETA) |
 | [**delete_lease**](LeasesApi.md#delete_lease) | **DELETE** /leases/{leaseID} | Delete a lease (BETA) |
 | [**delete_lease_conversation**](LeasesApi.md#delete_lease_conversation) | **DELETE** /leases/{leaseID}/conversations/{conversationID} | Delete a lease conversation (BETA) |
+| [**get_all_lease_statuses**](LeasesApi.md#get_all_lease_statuses) | **GET** /leases/statuses | Retrieve all lease statuses (BETA) |
 | [**get_lease**](LeasesApi.md#get_lease) | **GET** /leases/{leaseId} | Retrieve a lease |
 | [**get_lease_adjustments**](LeasesApi.md#get_lease_adjustments) | **GET** /leases/adjustments | Retrieve all the adjustments |
 | [**get_lease_auto_charges**](LeasesApi.md#get_lease_auto_charges) | **GET** /leases/{leaseId}/autocharges | Retrieve all lease auto charges |
@@ -1025,6 +1026,84 @@ end
 - **Accept**: application/json
 
 
+## get_all_lease_statuses
+
+> <Array<LeaseStatus>> get_all_lease_statuses
+
+Retrieve all lease statuses (BETA)
+
+<p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all lease statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> 
+
+### 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::LeasesApi.new
+
+begin
+  # Retrieve all lease statuses (BETA)
+  result = api_instance.get_all_lease_statuses
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling LeasesApi->get_all_lease_statuses: #{e}"
+end
+```
+
+#### Using the get_all_lease_statuses_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LeaseStatus>>, Integer, Hash)> get_all_lease_statuses_with_http_info
+
+```ruby
+begin
+  # Retrieve all lease statuses (BETA)
+  data, status_code, headers = api_instance.get_all_lease_statuses_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LeaseStatus>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling LeasesApi->get_all_lease_statuses_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;LeaseStatus&gt;**](LeaseStatus.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_lease
 
 > <Lease> get_lease(lease_id, opts)

data/docs/Note.md

@@ -5,11 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **body** | **String** | Content of the note. | [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** | Date the note was created. | [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] |
 | **private** | **Boolean** |  | [optional] |
 | **subject** | **String** | Subject. | [optional] |
-| **type** | **String** | Note type. | [optional] |
 
 ## Example
 
@@ -18,11 +21,14 @@ require 'propertyware'
 
 instance = Propertyware::Note.new(
   body: null,
+  created_by: null,
+  created_date_time: null,
   date: null,
   id: null,
+  last_modified_by: null,
+  last_modified_date_time: null,
   private: null,
-  subject: null,
-  type: null
+  subject: null
 )
 ```
 

data/docs/Prospect.md

@@ -9,6 +9,7 @@
 | **building_id** | **Integer** | Id of the building associated with the prospect. | [optional] |
 | **city_desired** | **String** | Desired city. | [optional] |
 | **comments** | **String** | Indicates if the prospect has any comments. | [optional] |
+| **contacts** | [**Array<ProspectContact>**](ProspectContact.md) | Contacts of the prospect | [optional] |
 | **created_by** | **String** | User who created the record. | [optional] |
 | **created_date_time** | **Time** | Date and time the record was created. (Timezone: UTC) | [optional] |
 | **current_home_type** | **String** | Current home type. | [optional] |
@@ -51,6 +52,7 @@
 | **type** | **String** | Prospect type. | [optional] |
 | **type_of_inquiry** | **String** | Type of inquiry made by the prospect. | [optional] |
 | **unit_desired** | **String** | Desired unit. | [optional] |
+| **unit_id** | **Integer** | Id of the unit associated with the prospect. | [optional] |
 | **unit_type_desired** | **String** | Desired unit type. | [optional] |
 | **zip_desired** | **String** | Desired zip code. | [optional] |
 
@@ -65,6 +67,7 @@ instance = Propertyware::Prospect.new(
   building_id: null,
   city_desired: null,
   comments: null,
+  contacts: null,
   created_by: null,
   created_date_time: null,
   current_home_type: null,
@@ -107,6 +110,7 @@ instance = Propertyware::Prospect.new(
   type: null,
   type_of_inquiry: null,
   unit_desired: null,
+  unit_id: null,
   unit_type_desired: null,
   zip_desired: null
 )

data/docs/ProspectContact.md

@@ -0,0 +1,30 @@
+# Propertyware::ProspectContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | E-mail address. | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **home_phone** | **String** | Home phone. | [optional] |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **mobile_phone** | **String** | Mobile phone. | [optional] |
+| **work_phone** | **String** | Work phone. | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ProspectContact.new(
+  email: null,
+  first_name: null,
+  home_phone: null,
+  id: null,
+  last_name: null,
+  mobile_phone: null,
+  work_phone: null
+)
+```
+

data/docs/ProspectStatus.md

@@ -0,0 +1,24 @@
+# Propertyware::ProspectStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique identifier. | [optional] |
+| **readonly** | **Boolean** | Read Only | [optional] |
+| **status** | **String** | Status | [optional] |
+| **visible_on_portal** | **Boolean** | Status visible On Portal | [optional] |
+
+## Example
+
+```ruby
+require 'propertyware'
+
+instance = Propertyware::ProspectStatus.new(
+  id: null,
+  readonly: false,
+  status: null,
+  visible_on_portal: false
+)
+```
+

data/docs/ProspectsApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
 | [**get_prospect_campaign**](ProspectsApi.md#get_prospect_campaign) | **GET** /prospects/{prospectID}/campaign | Retrieve prospect campaign |
 | [**get_prospect_conversation**](ProspectsApi.md#get_prospect_conversation) | **GET** /prospects/{prospectID}/conversations/{conversationID} | Retrieve a prospect conversation |
 | [**get_prospect_conversations**](ProspectsApi.md#get_prospect_conversations) | **GET** /prospects/{prospectID}/conversations | Retrieve all prospect conversations |
+| [**get_prospect_statuses**](ProspectsApi.md#get_prospect_statuses) | **GET** /prospects/statuses | Retrieve all prospect statuses (BETA) |
 | [**get_prospects**](ProspectsApi.md#get_prospects) | **GET** /prospects | Retrieve all prospects |
 
 
@@ -687,6 +688,84 @@ end
 - **Accept**: application/json
 
 
+## get_prospect_statuses
+
+> <Array<ProspectStatus>> get_prospect_statuses
+
+Retrieve all prospect statuses (BETA)
+
+<p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of all prospect statuses<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PROSPECTS</span> - <code>Read</code> 
+
+### 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::ProspectsApi.new
+
+begin
+  # Retrieve all prospect statuses (BETA)
+  result = api_instance.get_prospect_statuses
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ProspectsApi->get_prospect_statuses: #{e}"
+end
+```
+
+#### Using the get_prospect_statuses_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ProspectStatus>>, Integer, Hash)> get_prospect_statuses_with_http_info
+
+```ruby
+begin
+  # Retrieve all prospect statuses (BETA)
+  data, status_code, headers = api_instance.get_prospect_statuses_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ProspectStatus>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ProspectsApi->get_prospect_statuses_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;ProspectStatus&gt;**](ProspectStatus.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_prospects
 
 > <Array<Prospect>> get_prospects(opts)

data/docs/SaveContact.md

@@ -17,7 +17,7 @@
 | **home_phone** | **String** | Home Phone. | [optional] |
 | **job_title** | **String** | Professional title or position for the contact. | [optional] |
 | **last_name** | **String** | Last Name. |  |
-| **middle_name** | **String** | First 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** | Is Named On Lease. | [optional] |