propertyware 1.0.5

data/docs/ContactsApi.md

@@ -0,0 +1,783 @@
+# Propertyware::ContactsApi
+
+All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact (BETA) |
+| [**create_contacts_using_post1**](ContactsApi.md#create_contacts_using_post1) | **POST** /contacts/bulk | Create contacts in bulk (BETA) |
+| [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{contactID} | Delete a contact (BETA) |
+| [**delete_contact_conversation**](ContactsApi.md#delete_contact_conversation) | **DELETE** /contacts/{contactID}/conversations/{conversationID} | Delete a contact conversation (BETA) |
+| [**get_contact**](ContactsApi.md#get_contact) | **GET** /contacts/{contactID} | Retrieve a contact |
+| [**get_contact_conversation**](ContactsApi.md#get_contact_conversation) | **GET** /contacts/{contactID}/conversations/{conversationID} | Retrieve a contact conversation |
+| [**get_contact_conversations**](ContactsApi.md#get_contact_conversations) | **GET** /contacts/{contactID}/conversations | Retrieve all contact conversations |
+| [**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Retrieve all contacts |
+| [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{contactID} | Update a contact (BETA) |
+
+
+## create_contact
+
+> <Contact> create_contact(save_contact)
+
+Create a contact (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> Creates a contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+save_contact = Propertyware::SaveContact.new({first_name: 'first_name_example', last_name: 'last_name_example'}) # SaveContact | saveContact
+
+begin
+  # Create a contact (BETA)
+  result = api_instance.create_contact(save_contact)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->create_contact: #{e}"
+end
+```
+
+#### Using the create_contact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> create_contact_with_http_info(save_contact)
+
+```ruby
+begin
+  # Create a contact (BETA)
+  data, status_code, headers = api_instance.create_contact_with_http_info(save_contact)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->create_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_contact** | [**SaveContact**](SaveContact.md) | saveContact |  |
+
+### Return type
+
+[**Contact**](Contact.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_contacts_using_post1
+
+> <Array<RESTAPIBulkSuccessResponse>> create_contacts_using_post1(save_contact)
+
+Create contacts in bulk (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> Creates contacts in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+save_contact = [Propertyware::SaveContact.new({first_name: 'first_name_example', last_name: 'last_name_example'})] # Array<SaveContact> | saveContact
+
+begin
+  # Create contacts in bulk (BETA)
+  result = api_instance.create_contacts_using_post1(save_contact)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->create_contacts_using_post1: #{e}"
+end
+```
+
+#### Using the create_contacts_using_post1_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RESTAPIBulkSuccessResponse>>, Integer, Hash)> create_contacts_using_post1_with_http_info(save_contact)
+
+```ruby
+begin
+  # Create contacts in bulk (BETA)
+  data, status_code, headers = api_instance.create_contacts_using_post1_with_http_info(save_contact)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RESTAPIBulkSuccessResponse>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->create_contacts_using_post1_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_contact** | [**Array&lt;SaveContact&gt;**](SaveContact.md) | saveContact |  |
+
+### Return type
+
+[**Array&lt;RESTAPIBulkSuccessResponse&gt;**](RESTAPIBulkSuccessResponse.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_contact
+
+> <ResponseEntity> delete_contact(contact_id)
+
+Delete a contact (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> Deletes a contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Delete</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+
+begin
+  # Delete a contact (BETA)
+  result = api_instance.delete_contact(contact_id)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact: #{e}"
+end
+```
+
+#### Using the delete_contact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEntity>, Integer, Hash)> delete_contact_with_http_info(contact_id)
+
+```ruby
+begin
+  # Delete a contact (BETA)
+  data, status_code, headers = api_instance.delete_contact_with_http_info(contact_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEntity>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+
+### 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/json
+
+
+## delete_contact_conversation
+
+> <ResponseEntity> delete_contact_conversation(contact_id, conversation_id)
+
+Delete a contact conversation (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> Deletes a specific contact conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Delete</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+conversation_id = 789 # Integer | Conversation ID
+
+begin
+  # Delete a contact conversation (BETA)
+  result = api_instance.delete_contact_conversation(contact_id, conversation_id)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact_conversation: #{e}"
+end
+```
+
+#### Using the delete_contact_conversation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEntity>, Integer, Hash)> delete_contact_conversation_with_http_info(contact_id, conversation_id)
+
+```ruby
+begin
+  # Delete a contact conversation (BETA)
+  data, status_code, headers = api_instance.delete_contact_conversation_with_http_info(contact_id, conversation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEntity>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+| **conversation_id** | **Integer** | Conversation ID |  |
+
+### 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/json
+
+
+## get_contact
+
+> <Contact> get_contact(contact_id, opts)
+
+Retrieve a contact
+
+Retrieves a specific contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+opts = {
+  include_custom_fields: true # Boolean | includeCustomFields
+}
+
+begin
+  # Retrieve a contact
+  result = api_instance.get_contact(contact_id, opts)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact: #{e}"
+end
+```
+
+#### Using the get_contact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> get_contact_with_http_info(contact_id, opts)
+
+```ruby
+begin
+  # Retrieve a contact
+  data, status_code, headers = api_instance.get_contact_with_http_info(contact_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+| **include_custom_fields** | **Boolean** | includeCustomFields | [optional][default to true] |
+
+### Return type
+
+[**Contact**](Contact.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_contact_conversation
+
+> <Conversation> get_contact_conversation(contact_id, conversation_id)
+
+Retrieve a contact conversation
+
+Retrieves a specific contact conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+conversation_id = 789 # Integer | Conversation ID
+
+begin
+  # Retrieve a contact conversation
+  result = api_instance.get_contact_conversation(contact_id, conversation_id)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_conversation: #{e}"
+end
+```
+
+#### Using the get_contact_conversation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Conversation>, Integer, Hash)> get_contact_conversation_with_http_info(contact_id, conversation_id)
+
+```ruby
+begin
+  # Retrieve a contact conversation
+  data, status_code, headers = api_instance.get_contact_conversation_with_http_info(contact_id, conversation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Conversation>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+| **conversation_id** | **Integer** | Conversation ID |  |
+
+### Return type
+
+[**Conversation**](Conversation.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_contact_conversations
+
+> <Array<Conversation>> get_contact_conversations(contact_id, opts)
+
+Retrieve all contact conversations
+
+Retrieves all the conversations of a contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+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.
+  type: 'MANAGEMENT_TEAM' # String | Filters results by the conversation type.
+}
+
+begin
+  # Retrieve all contact conversations
+  result = api_instance.get_contact_conversations(contact_id, opts)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_conversations: #{e}"
+end
+```
+
+#### Using the get_contact_conversations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Conversation>>, Integer, Hash)> get_contact_conversations_with_http_info(contact_id, opts)
+
+```ruby
+begin
+  # Retrieve all contact conversations
+  data, status_code, headers = api_instance.get_contact_conversations_with_http_info(contact_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Conversation>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_conversations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+| **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] |
+| **type** | **String** | Filters results by the conversation type. | [optional] |
+
+### Return type
+
+[**Array&lt;Conversation&gt;**](Conversation.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_contacts
+
+> <Array<Contact>> get_contacts(opts)
+
+Retrieve all contacts
+
+Retrieves a list of contacts.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>firstname</code>, <code>createddate</code>, <code>lastname</code>, <code>email</code>, <code>type</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::ContactsApi.new
+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.
+  type: 'TENANT', # String | Filters results by the contact type.
+  include_custom_fields: true # Boolean | includeCustomFields
+}
+
+begin
+  # Retrieve all contacts
+  result = api_instance.get_contacts(opts)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contacts: #{e}"
+end
+```
+
+#### Using the get_contacts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Contact>>, Integer, Hash)> get_contacts_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve all contacts
+  data, status_code, headers = api_instance.get_contacts_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Contact>>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->get_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **type** | **String** | Filters results by the contact type. | [optional] |
+| **include_custom_fields** | **Boolean** | includeCustomFields | [optional][default to false] |
+
+### Return type
+
+[**Array&lt;Contact&gt;**](Contact.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_contact
+
+> <Contact> update_contact(contact_id, save_contact)
+
+Update a contact (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 a contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</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::ContactsApi.new
+contact_id = 789 # Integer | Contact ID
+save_contact = Propertyware::SaveContact.new({first_name: 'first_name_example', last_name: 'last_name_example'}) # SaveContact | saveContact
+
+begin
+  # Update a contact (BETA)
+  result = api_instance.update_contact(contact_id, save_contact)
+  p result
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->update_contact: #{e}"
+end
+```
+
+#### Using the update_contact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Contact>, Integer, Hash)> update_contact_with_http_info(contact_id, save_contact)
+
+```ruby
+begin
+  # Update a contact (BETA)
+  data, status_code, headers = api_instance.update_contact_with_http_info(contact_id, save_contact)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Contact>
+rescue Propertyware::ApiError => e
+  puts "Error when calling ContactsApi->update_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **Integer** | Contact ID |  |
+| **save_contact** | [**SaveContact**](SaveContact.md) | saveContact |  |
+
+### Return type
+
+[**Contact**](Contact.md)
+
+### Authorization
+
+[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+