buildium-ruby 2.0.1 → 3.0.0

data/docs/BudgetsApi.md

@@ -0,0 +1,329 @@
+# Buildium::BudgetsApi
+
+All URIs are relative to *https://api.buildium.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_budget**](BudgetsApi.md#create_budget) | **POST** /v1/budgets | Create a budget |
+| [**get_budget_by_id**](BudgetsApi.md#get_budget_by_id) | **GET** /v1/budgets/{budgetId} | Retrieve a budget |
+| [**get_budgets**](BudgetsApi.md#get_budgets) | **GET** /v1/budgets | Retrieve all budgets |
+| [**update_budget**](BudgetsApi.md#update_budget) | **PUT** /v1/budgets/{budgetId} | Update a budget |
+
+
+## create_budget
+
+> <BudgetMessage> create_budget(budget_post_message)
+
+Create a budget
+
+Creates a budget.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View` `Edit`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # 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 = Buildium::BudgetsApi.new
+budget_post_message = Buildium::BudgetPostMessage.new({name: 'name_example', property_id: 37, start_month: 'January', fiscal_year: 37, details: [Buildium::BudgetDetailsSaveMessage.new({gl_account_id: 37, monthly_amounts: Buildium::BudgetMonthlyAmountsSaveMessage.new({january: 3.56, february: 3.56, march: 3.56, april: 3.56, may: 3.56, june: 3.56, july: 3.56, august: 3.56, september: 3.56, october: 3.56, november: 3.56, december: 3.56})})]}) # BudgetPostMessage | 
+
+begin
+  # Create a budget
+  result = api_instance.create_budget(budget_post_message)
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->create_budget: #{e}"
+end
+```
+
+#### Using the create_budget_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BudgetMessage>, Integer, Hash)> create_budget_with_http_info(budget_post_message)
+
+```ruby
+begin
+  # Create a budget
+  data, status_code, headers = api_instance.create_budget_with_http_info(budget_post_message)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BudgetMessage>
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->create_budget_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_post_message** | [**BudgetPostMessage**](BudgetPostMessage.md) |  |  |
+
+### Return type
+
+[**BudgetMessage**](BudgetMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_budget_by_id
+
+> <BudgetMessage> get_budget_by_id(budget_id)
+
+Retrieve a budget
+
+Retrieves a budget.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # 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 = Buildium::BudgetsApi.new
+budget_id = 56 # Integer | 
+
+begin
+  # Retrieve a budget
+  result = api_instance.get_budget_by_id(budget_id)
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->get_budget_by_id: #{e}"
+end
+```
+
+#### Using the get_budget_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BudgetMessage>, Integer, Hash)> get_budget_by_id_with_http_info(budget_id)
+
+```ruby
+begin
+  # Retrieve a budget
+  data, status_code, headers = api_instance.get_budget_by_id_with_http_info(budget_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BudgetMessage>
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->get_budget_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **Integer** |  |  |
+
+### Return type
+
+[**BudgetMessage**](BudgetMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_budgets
+
+> <Array<BudgetMessage>> get_budgets(opts)
+
+Retrieve all budgets
+
+Retrieves all budgets.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # 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 = Buildium::BudgetsApi.new
+opts = {
+  propertyids: [37], # Array<Integer> | Filters results to any budget associated to any of the specified set of property ids.
+  fiscalyear: 56, # Integer | Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number.
+  name: 'name_example', # String | Filters results to any budgets whose name *contains* the specified value.
+  orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
+  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 1000 and the default is 50.
+}
+
+begin
+  # Retrieve all budgets
+  result = api_instance.get_budgets(opts)
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->get_budgets: #{e}"
+end
+```
+
+#### Using the get_budgets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<BudgetMessage>>, Integer, Hash)> get_budgets_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve all budgets
+  data, status_code, headers = api_instance.get_budgets_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<BudgetMessage>>
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->get_budgets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to any budget associated to any of the specified set of property ids. | [optional] |
+| **fiscalyear** | **Integer** | Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number. | [optional] |
+| **name** | **String** | Filters results to any budgets whose name *contains* the specified value. | [optional] |
+| **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
+| **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; 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 1000 and the default is 50. | [optional] |
+
+### Return type
+
+[**Array&lt;BudgetMessage&gt;**](BudgetMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_budget
+
+> <BudgetMessage> update_budget(budget_id, budget_put_message)
+
+Update a budget
+
+Updates a budget.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View` `Edit`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # 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 = Buildium::BudgetsApi.new
+budget_id = 56 # Integer | 
+budget_put_message = Buildium::BudgetPutMessage.new({name: 'name_example', details: [Buildium::BudgetDetailsSaveMessage.new({gl_account_id: 37, monthly_amounts: Buildium::BudgetMonthlyAmountsSaveMessage.new({january: 3.56, february: 3.56, march: 3.56, april: 3.56, may: 3.56, june: 3.56, july: 3.56, august: 3.56, september: 3.56, october: 3.56, november: 3.56, december: 3.56})})]}) # BudgetPutMessage | 
+
+begin
+  # Update a budget
+  result = api_instance.update_budget(budget_id, budget_put_message)
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->update_budget: #{e}"
+end
+```
+
+#### Using the update_budget_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BudgetMessage>, Integer, Hash)> update_budget_with_http_info(budget_id, budget_put_message)
+
+```ruby
+begin
+  # Update a budget
+  data, status_code, headers = api_instance.update_budget_with_http_info(budget_id, budget_put_message)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BudgetMessage>
+rescue Buildium::ApiError => e
+  puts "Error when calling BudgetsApi->update_budget_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_id** | **Integer** |  |  |
+| **budget_put_message** | [**BudgetPutMessage**](BudgetPutMessage.md) |  |  |
+
+### Return type
+
+[**BudgetMessage**](BudgetMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CCPaymentsMessage.md

@@ -0,0 +1,18 @@
+# Buildium::CCPaymentsMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payments_enabled** | **Boolean** | Indicates whether credit card payments are enabled in the Buildium Resident Center for all residents of this property. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CCPaymentsMessage.new(
+  payments_enabled: null
+)
+```
+

data/docs/CCPaymentsPutMessage.md

@@ -0,0 +1,18 @@
+# Buildium::CCPaymentsPutMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payments_enabled** | **Boolean** | Indicates whether credit card payments are enabled in the Buildium Resident Center for all residents of this property. Note, to enable credit card payments the operating bank account for the property must have credit card payments provisioned. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CCPaymentsPutMessage.new(
+  payments_enabled: null
+)
+```
+

data/docs/CancellationToken.md

@@ -0,0 +1,22 @@
+# Buildium::CancellationToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_cancellation_requested** | **Boolean** |  | [optional] |
+| **can_be_canceled** | **Boolean** |  | [optional] |
+| **wait_handle** | [**WaitHandle**](WaitHandle.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::CancellationToken.new(
+  is_cancellation_requested: null,
+  can_be_canceled: null,
+  wait_handle: null
+)
+```
+

data/docs/CommunicationsApi.md

@@ -5,8 +5,8 @@ All URIs are relative to *https://api.buildium.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_announcement**](CommunicationsApi.md#create_announcement) | **POST** /v1/communications/announcements | Create an announcement |
+| [**create_email**](CommunicationsApi.md#create_email) | **POST** /v1/communications/emails | Send an email |
 | [**create_phone_log**](CommunicationsApi.md#create_phone_log) | **POST** /v1/communications/phonelogs | Create a phone log |
-| [**emails_external_api_write_create_email**](CommunicationsApi.md#emails_external_api_write_create_email) | **POST** /v1/communications/emails | Create an email. |
 | [**expire_announcement**](CommunicationsApi.md#expire_announcement) | **POST** /v1/communications/announcements/{announcementId}/expirationrequest | Expire an announcement |
 | [**get_all_announcements**](CommunicationsApi.md#get_all_announcements) | **GET** /v1/communications/announcements | Retrieve all announcements |
 | [**get_announcement_by_id**](CommunicationsApi.md#get_announcement_by_id) | **GET** /v1/communications/announcements/{announcementId} | Retrieve an announcement |
@@ -97,13 +97,13 @@ end
 - **Accept**: application/json
 
 
-## create_phone_log
+## create_email
 
-> <PhoneLogMessage> create_phone_log(phone_log_post_message)
+> create_email(email_post_message)
 
-Create a phone log
+Send an email
 
-Creates a phone log.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Timelines (Phone Logs)</span> - `View` `Edit`
+Sends an email to one or more recipients using the specified email template.               <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication &gt; Emails</span> - `View` `Edit`
 
 ### Examples
 
@@ -124,32 +124,31 @@ Buildium.configure do |config|
 end
 
 api_instance = Buildium::CommunicationsApi.new
-phone_log_post_message = Buildium::PhoneLogPostMessage.new({participant: Buildium::PhoneLogParticipantPostMessage.new({entity_type: 'Vendor', entity_id: 37}), subject: 'subject_example', description: 'description_example', call_date_time: Time.now}) # PhoneLogPostMessage | 
+email_post_message = Buildium::EmailPostMessage.new({template_id: 37, subject: 'subject_example', include_alternate_emails: false, exclude_delinquent_recipients: false, include_association_tenants: false}) # EmailPostMessage | 
 
 begin
-  # Create a phone log
-  result = api_instance.create_phone_log(phone_log_post_message)
-  p result
+  # Send an email
+  api_instance.create_email(email_post_message)
 rescue Buildium::ApiError => e
-  puts "Error when calling CommunicationsApi->create_phone_log: #{e}"
+  puts "Error when calling CommunicationsApi->create_email: #{e}"
 end
 ```
 
-#### Using the create_phone_log_with_http_info variant
+#### Using the create_email_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<PhoneLogMessage>, Integer, Hash)> create_phone_log_with_http_info(phone_log_post_message)
+> <Array(nil, Integer, Hash)> create_email_with_http_info(email_post_message)
 
 ```ruby
 begin
-  # Create a phone log
-  data, status_code, headers = api_instance.create_phone_log_with_http_info(phone_log_post_message)
+  # Send an email
+  data, status_code, headers = api_instance.create_email_with_http_info(email_post_message)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PhoneLogMessage>
+  p data # => nil
 rescue Buildium::ApiError => e
-  puts "Error when calling CommunicationsApi->create_phone_log_with_http_info: #{e}"
+  puts "Error when calling CommunicationsApi->create_email_with_http_info: #{e}"
 end
 ```
 
@@ -157,11 +156,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **phone_log_post_message** | [**PhoneLogPostMessage**](PhoneLogPostMessage.md) |  |  |
+| **email_post_message** | [**EmailPostMessage**](EmailPostMessage.md) |  |  |
 
 ### Return type
 
-[**PhoneLogMessage**](PhoneLogMessage.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -173,13 +172,13 @@ end
 - **Accept**: application/json
 
 
-## emails_external_api_write_create_email
+## create_phone_log
 
-> emails_external_api_write_create_email(email_post_message)
+> <PhoneLogMessage> create_phone_log(phone_log_post_message)
 
-Create an email.
+Create a phone log
 
-Creates an email              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication &gt; Emails</span> - `View` `Edit`
+Creates a phone log.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Timelines (Phone Logs)</span> - `View` `Edit`
 
 ### Examples
 
@@ -200,31 +199,32 @@ Buildium.configure do |config|
 end
 
 api_instance = Buildium::CommunicationsApi.new
-email_post_message = Buildium::EmailPostMessage.new({template_id: 37, subject: 'subject_example', include_alternate_emails: false, exclude_delinquent_recipients: false, include_association_tenants: false}) # EmailPostMessage | 
+phone_log_post_message = Buildium::PhoneLogPostMessage.new({participant: Buildium::PhoneLogParticipantPostMessage.new({entity_type: 'Vendor', entity_id: 37}), subject: 'subject_example', description: 'description_example', call_date_time: Time.now}) # PhoneLogPostMessage | 
 
 begin
-  # Create an email.
-  api_instance.emails_external_api_write_create_email(email_post_message)
+  # Create a phone log
+  result = api_instance.create_phone_log(phone_log_post_message)
+  p result
 rescue Buildium::ApiError => e
-  puts "Error when calling CommunicationsApi->emails_external_api_write_create_email: #{e}"
+  puts "Error when calling CommunicationsApi->create_phone_log: #{e}"
 end
 ```
 
-#### Using the emails_external_api_write_create_email_with_http_info variant
+#### Using the create_phone_log_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> emails_external_api_write_create_email_with_http_info(email_post_message)
+> <Array(<PhoneLogMessage>, Integer, Hash)> create_phone_log_with_http_info(phone_log_post_message)
 
 ```ruby
 begin
-  # Create an email.
-  data, status_code, headers = api_instance.emails_external_api_write_create_email_with_http_info(email_post_message)
+  # Create a phone log
+  data, status_code, headers = api_instance.create_phone_log_with_http_info(phone_log_post_message)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <PhoneLogMessage>
 rescue Buildium::ApiError => e
-  puts "Error when calling CommunicationsApi->emails_external_api_write_create_email_with_http_info: #{e}"
+  puts "Error when calling CommunicationsApi->create_phone_log_with_http_info: #{e}"
 end
 ```
 
@@ -232,11 +232,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email_post_message** | [**EmailPostMessage**](EmailPostMessage.md) |  |  |
+| **phone_log_post_message** | [**PhoneLogPostMessage**](PhoneLogPostMessage.md) |  |  |
 
 ### Return type
 
-nil (empty response body)
+[**PhoneLogMessage**](PhoneLogMessage.md)
 
 ### Authorization
 
@@ -581,7 +581,7 @@ end
 
 Retrieve an email
 
-Retrieves an email.               <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Emails</span> - `View`
+Retrieves the content of an email. To retrieve the recipients of the email see the [Retrieve all email recipients](#tag/Communications/operation/GetEmailRecipients) endpoint.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Emails</span> - `View`
 
 ### Examples
 
@@ -833,7 +833,7 @@ end
 
 Retrieve all communication templates
 
-Retrieves all mailing and email templates.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View`              <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View`              <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View`              <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+Retrieves all mailing and email templates. A template is a tool in Buildium that allows you to create \"mail merge\" templates for emails and postal mailings to easily send common messages to residents, rental owners and vendors.               <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View`              <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View`              <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View`              <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
 
 ### Examples
 
@@ -915,7 +915,7 @@ end
 
 Retrieve a communication template
 
-Retrieves a communication template.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View`              <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View`              <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View`              <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
+Retrieves a communication template. A template is a tool in Buildium that allows you to create \"mail merge\" templates for emails and postal mailings to easily send common messages to residents, rental owners and vendors.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View`              <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View`              <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View`              <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View`              <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
 
 ### Examples