docs/AssociationsApi.md in buildium-ruby-2.0.1 vs docs/AssociationsApi.md in buildium-ruby-2.1.0

- old
+ new

@@ -4,23 +4,23 @@ | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_association**](AssociationsApi.md#create_association) | **POST** /v1/associations | Create an association | | [**create_association_note**](AssociationsApi.md#create_association_note) | **POST** /v1/associations/{associationId}/notes | Create a note | -| [**create_board_member**](AssociationsApi.md#create_board_member) | **POST** /v1/associations/{associationId}/boardmembers | Create a board member | -| [**delete_board_member**](AssociationsApi.md#delete_board_member) | **DELETE** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Delete a board member | -| [**get_all_association_board_members**](AssociationsApi.md#get_all_association_board_members) | **GET** /v1/associations/{associationId}/boardmembers | Retrieve all board members | -| [**get_association_board_member_by_id**](AssociationsApi.md#get_association_board_member_by_id) | **GET** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Retrieve a board member | | [**get_association_by_id**](AssociationsApi.md#get_association_by_id) | **GET** /v1/associations/{associationId} | Retrieve an association | | [**get_association_note_by_note_id**](AssociationsApi.md#get_association_note_by_note_id) | **GET** /v1/associations/{associationId}/notes/{noteId} | Retrieve a note | | [**get_association_notes**](AssociationsApi.md#get_association_notes) | **GET** /v1/associations/{associationId}/notes | Retrieve all notes | | [**get_association_preferred_vendors**](AssociationsApi.md#get_association_preferred_vendors) | **GET** /v1/associations/{associationId}/vendors | Retrieve all preferred vendors | | [**get_associations**](AssociationsApi.md#get_associations) | **GET** /v1/associations | Retrieve all associations | +| [**get_bank_lock_box_data**](AssociationsApi.md#get_bank_lock_box_data) | **GET** /v1/associations/banklockboxdata | Retrieve all association bank lockbox data | +| [**get_e_pay_settings_for_association_by_id**](AssociationsApi.md#get_e_pay_settings_for_association_by_id) | **GET** /v1/associations/{associationId}/epaysettings | Retrieve ePay settings | +| [**inactivate_association**](AssociationsApi.md#inactivate_association) | **POST** /v1/associations/{associationId}/inactivationrequest | Inactivate an association | +| [**reactivate_association**](AssociationsApi.md#reactivate_association) | **POST** /v1/associations/{associationId}/reactivationrequest | Reactivate an association | | [**update_association**](AssociationsApi.md#update_association) | **PUT** /v1/associations/{associationId} | Update an association | | [**update_association_note**](AssociationsApi.md#update_association_note) | **PUT** /v1/associations/{associationId}/notes/{noteId} | Update a note | | [**update_association_preferred_vendors**](AssociationsApi.md#update_association_preferred_vendors) | **PUT** /v1/associations/{associationId}/vendors | Update preferred vendors | -| [**update_board_member**](AssociationsApi.md#update_board_member) | **PUT** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Update a board member | +| [**update_e_pay_settings_for_association**](AssociationsApi.md#update_e_pay_settings_for_association) | **PUT** /v1/associations/{associationId}/epaysettings | Update ePay settings | ## create_association > <AssociationMessage> create_association(association_post_message) @@ -173,17 +173,17 @@ - **Content-Type**: application/json - **Accept**: application/json -## create_board_member +## get_association_by_id -> <AssociationBoardMemberMessage> create_board_member(association_id, association_board_member_post_message) +> <AssociationMessage> get_association_by_id(association_id) -Create a board member +Retrieve an association -Creates a board member for a given association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` `Edit` +Retrieve a specific association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -200,68 +200,66 @@ # 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::AssociationsApi.new -association_id = 56 # Integer | -association_board_member_post_message = Buildium::AssociationBoardMemberPostMessage.new({association_owner_id: 37, board_position_type: 'President'}) # AssociationBoardMemberPostMessage | +association_id = 56 # Integer | The association identifier. begin - # Create a board member - result = api_instance.create_board_member(association_id, association_board_member_post_message) + # Retrieve an association + result = api_instance.get_association_by_id(association_id) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->create_board_member: #{e}" + puts "Error when calling AssociationsApi->get_association_by_id: #{e}" end ``` -#### Using the create_board_member_with_http_info variant +#### Using the get_association_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> create_board_member_with_http_info(association_id, association_board_member_post_message) +> <Array(<AssociationMessage>, Integer, Hash)> get_association_by_id_with_http_info(association_id) ```ruby begin - # Create a board member - data, status_code, headers = api_instance.create_board_member_with_http_info(association_id, association_board_member_post_message) + # Retrieve an association + data, status_code, headers = api_instance.get_association_by_id_with_http_info(association_id) p status_code # => 2xx p headers # => { ... } - p data # => <AssociationBoardMemberMessage> + p data # => <AssociationMessage> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->create_board_member_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_association_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **association_id** | **Integer** | | | -| **association_board_member_post_message** | [**AssociationBoardMemberPostMessage**](AssociationBoardMemberPostMessage.md) | | | +| **association_id** | **Integer** | The association identifier. | | ### Return type -[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md) +[**AssociationMessage**](AssociationMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: Not defined - **Accept**: application/json -## delete_board_member +## get_association_note_by_note_id -> delete_board_member(association_id, board_member_id) +> <NoteMessage> get_association_note_by_note_id(association_id, note_id) -Delete a board member +Retrieve a note -Deletes a board member. Note, this is a hard delete from the database and data can not be restored. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` `Edit` `Delete` +Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -279,48 +277,49 @@ # config.api_key_prefix['clientSecret'] = 'Bearer' end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | -board_member_id = 56 # Integer | +note_id = 56 # Integer | begin - # Delete a board member - api_instance.delete_board_member(association_id, board_member_id) + # Retrieve a note + result = api_instance.get_association_note_by_note_id(association_id, note_id) + p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->delete_board_member: #{e}" + puts "Error when calling AssociationsApi->get_association_note_by_note_id: #{e}" end ``` -#### Using the delete_board_member_with_http_info variant +#### Using the get_association_note_by_note_id_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)> delete_board_member_with_http_info(association_id, board_member_id) +> <Array(<NoteMessage>, Integer, Hash)> get_association_note_by_note_id_with_http_info(association_id, note_id) ```ruby begin - # Delete a board member - data, status_code, headers = api_instance.delete_board_member_with_http_info(association_id, board_member_id) + # Retrieve a note + data, status_code, headers = api_instance.get_association_note_by_note_id_with_http_info(association_id, note_id) p status_code # => 2xx p headers # => { ... } - p data # => nil + p data # => <NoteMessage> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->delete_board_member_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_association_note_by_note_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **board_member_id** | **Integer** | | | +| **note_id** | **Integer** | | | ### Return type -nil (empty response body) +[**NoteMessage**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -328,17 +327,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_all_association_board_members +## get_association_notes -> <Array<AssociationBoardMemberMessage>> get_all_association_board_members(association_id, opts) +> <Array<NoteMessage>> get_association_notes(association_id, opts) -Retrieve all board members +Retrieve all notes -Retrieves all association board members. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` +Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -357,62 +356,60 @@ end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | opts = { - statuses: ['Current'], # Array<String> | Filters results to only records whose status is equal to the specified values. - boardpositiontypes: ['President'], # Array<String> | Filters results to only records whose board position type is equal to the specified values. - createddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to only records that were created before this date. Must be formatted as `YYYY-MM-DD`. - createddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to only records that were created after this date. Must be formatted as `YYYY-MM-DD`. + updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. + updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. + lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier. 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 board members - result = api_instance.get_all_association_board_members(association_id, opts) + # Retrieve all notes + result = api_instance.get_association_notes(association_id, opts) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_all_association_board_members: #{e}" + puts "Error when calling AssociationsApi->get_association_notes: #{e}" end ``` -#### Using the get_all_association_board_members_with_http_info variant +#### Using the get_association_notes_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<Array<AssociationBoardMemberMessage>>, Integer, Hash)> get_all_association_board_members_with_http_info(association_id, opts) +> <Array(<Array<NoteMessage>>, Integer, Hash)> get_association_notes_with_http_info(association_id, opts) ```ruby begin - # Retrieve all board members - data, status_code, headers = api_instance.get_all_association_board_members_with_http_info(association_id, opts) + # Retrieve all notes + data, status_code, headers = api_instance.get_association_notes_with_http_info(association_id, opts) p status_code # => 2xx p headers # => { ... } - p data # => <Array<AssociationBoardMemberMessage>> + p data # => <Array<NoteMessage>> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_all_association_board_members_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_association_notes_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **statuses** | [**Array&lt;String&gt;**](String.md) | Filters results to only records whose status is equal to the specified values. | [optional] | -| **boardpositiontypes** | [**Array&lt;String&gt;**](String.md) | Filters results to only records whose board position type is equal to the specified values. | [optional] | -| **createddatetimeto** | **Time** | Filters results to only records that were created before this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;. | [optional] | -| **createddatetimefrom** | **Time** | Filters results to only records that were created after this date. Must be formatted as &#x60;YYYY-MM-DD&#x60;. | [optional] | +| **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] | +| **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] | +| **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [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;AssociationBoardMemberMessage&gt;**](AssociationBoardMemberMessage.md) +[**Array&lt;NoteMessage&gt;**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -420,17 +417,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_association_board_member_by_id +## get_association_preferred_vendors -> <AssociationBoardMemberMessage> get_association_board_member_by_id(association_id, board_member_id) +> <Array<AssociationPreferredVendorMessage>> get_association_preferred_vendors(association_id, opts) -Retrieve a board member +Retrieve all preferred vendors -Retrieves an association board member. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` +Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` ### Examples ```ruby require 'time' @@ -448,49 +445,55 @@ # config.api_key_prefix['clientSecret'] = 'Bearer' end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | -board_member_id = 56 # Integer | +opts = { + 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 a board member - result = api_instance.get_association_board_member_by_id(association_id, board_member_id) + # Retrieve all preferred vendors + result = api_instance.get_association_preferred_vendors(association_id, opts) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_board_member_by_id: #{e}" + puts "Error when calling AssociationsApi->get_association_preferred_vendors: #{e}" end ``` -#### Using the get_association_board_member_by_id_with_http_info variant +#### Using the get_association_preferred_vendors_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> get_association_board_member_by_id_with_http_info(association_id, board_member_id) +> <Array(<Array<AssociationPreferredVendorMessage>>, Integer, Hash)> get_association_preferred_vendors_with_http_info(association_id, opts) ```ruby begin - # Retrieve a board member - data, status_code, headers = api_instance.get_association_board_member_by_id_with_http_info(association_id, board_member_id) + # Retrieve all preferred vendors + data, status_code, headers = api_instance.get_association_preferred_vendors_with_http_info(association_id, opts) p status_code # => 2xx p headers # => { ... } - p data # => <AssociationBoardMemberMessage> + p data # => <Array<AssociationPreferredVendorMessage>> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_board_member_by_id_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_association_preferred_vendors_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **board_member_id** | **Integer** | | | +| **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 -[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md) +[**Array&lt;AssociationPreferredVendorMessage&gt;**](AssociationPreferredVendorMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -498,17 +501,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_association_by_id +## get_associations -> <AssociationMessage> get_association_by_id(association_id) +> <Array<AssociationMessage>> get_associations(opts) -Retrieve an association +Retrieve all associations -Retrieve a specific association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` +Retrieves a list of associations. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -525,48 +528,66 @@ # 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::AssociationsApi.new -association_id = 56 # Integer | The association identifier. +opts = { + ids: [37], # Array<Integer> | Filters results to the specified set of ids. + location: 'location_example', # String | Filters results to any association whose city or state *contains* the specified value. + status: 'Active', # String | Filters results by the status of the association. If no status is specified both `active` and `inactive` associations will be returned. + lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. + lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. + operatingbankaccountids: [37], # Array<Integer> | Filters results to any associations associated to any of the specified set of operating bank account ids. + 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 an association - result = api_instance.get_association_by_id(association_id) + # Retrieve all associations + result = api_instance.get_associations(opts) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_by_id: #{e}" + puts "Error when calling AssociationsApi->get_associations: #{e}" end ``` -#### Using the get_association_by_id_with_http_info variant +#### Using the get_associations_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AssociationMessage>, Integer, Hash)> get_association_by_id_with_http_info(association_id) +> <Array(<Array<AssociationMessage>>, Integer, Hash)> get_associations_with_http_info(opts) ```ruby begin - # Retrieve an association - data, status_code, headers = api_instance.get_association_by_id_with_http_info(association_id) + # Retrieve all associations + data, status_code, headers = api_instance.get_associations_with_http_info(opts) p status_code # => 2xx p headers # => { ... } - p data # => <AssociationMessage> + p data # => <Array<AssociationMessage>> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_by_id_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_associations_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **association_id** | **Integer** | The association identifier. | | +| **ids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to the specified set of ids. | [optional] | +| **location** | **String** | Filters results to any association whose city or state *contains* the specified value. | [optional] | +| **status** | **String** | Filters results by the status of the association. If no status is specified both &#x60;active&#x60; and &#x60;inactive&#x60; associations will be returned. | [optional] | +| **lastupdatedfrom** | **Time** | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] | +| **lastupdatedto** | **Time** | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] | +| **operatingbankaccountids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to any associations associated to any of the specified set of operating bank account ids. | [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 -[**AssociationMessage**](AssociationMessage.md) +[**Array&lt;AssociationMessage&gt;**](AssociationMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -574,17 +595,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_association_note_by_note_id +## get_bank_lock_box_data -> <NoteMessage> get_association_note_by_note_id(association_id, note_id) +> <Array<BankLockboxDataMessage>> get_bank_lock_box_data(opts) -Retrieve a note +Retrieve all association bank lockbox data -Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` +Retrieves all association bank lockbox data. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -601,50 +622,56 @@ # 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::AssociationsApi.new -association_id = 56 # Integer | -note_id = 56 # Integer | +opts = { + associationids: [37], # Array<Integer> | Filters results to only include Associations with matching IDs + 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 a note - result = api_instance.get_association_note_by_note_id(association_id, note_id) + # Retrieve all association bank lockbox data + result = api_instance.get_bank_lock_box_data(opts) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_note_by_note_id: #{e}" + puts "Error when calling AssociationsApi->get_bank_lock_box_data: #{e}" end ``` -#### Using the get_association_note_by_note_id_with_http_info variant +#### Using the get_bank_lock_box_data_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<NoteMessage>, Integer, Hash)> get_association_note_by_note_id_with_http_info(association_id, note_id) +> <Array(<Array<BankLockboxDataMessage>>, Integer, Hash)> get_bank_lock_box_data_with_http_info(opts) ```ruby begin - # Retrieve a note - data, status_code, headers = api_instance.get_association_note_by_note_id_with_http_info(association_id, note_id) + # Retrieve all association bank lockbox data + data, status_code, headers = api_instance.get_bank_lock_box_data_with_http_info(opts) p status_code # => 2xx p headers # => { ... } - p data # => <NoteMessage> + p data # => <Array<BankLockboxDataMessage>> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_note_by_note_id_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_bank_lock_box_data_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **association_id** | **Integer** | | | -| **note_id** | **Integer** | | | +| **associationids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to only include Associations with matching IDs | [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 -[**NoteMessage**](NoteMessage.md) +[**Array&lt;BankLockboxDataMessage&gt;**](BankLockboxDataMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -652,17 +679,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_association_notes +## get_e_pay_settings_for_association_by_id -> <Array<NoteMessage>> get_association_notes(association_id, opts) +> <EPaySettingsMessage> get_e_pay_settings_for_association_by_id(association_id) -Retrieve all notes +Retrieve ePay settings -Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` +Retrieves ePay settings for an association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` ### Examples ```ruby require 'time' @@ -680,61 +707,47 @@ # config.api_key_prefix['clientSecret'] = 'Bearer' end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | -opts = { - updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. - updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. - lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier. - 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 notes - result = api_instance.get_association_notes(association_id, opts) + # Retrieve ePay settings + result = api_instance.get_e_pay_settings_for_association_by_id(association_id) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_notes: #{e}" + puts "Error when calling AssociationsApi->get_e_pay_settings_for_association_by_id: #{e}" end ``` -#### Using the get_association_notes_with_http_info variant +#### Using the get_e_pay_settings_for_association_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<Array<NoteMessage>>, Integer, Hash)> get_association_notes_with_http_info(association_id, opts) +> <Array(<EPaySettingsMessage>, Integer, Hash)> get_e_pay_settings_for_association_by_id_with_http_info(association_id) ```ruby begin - # Retrieve all notes - data, status_code, headers = api_instance.get_association_notes_with_http_info(association_id, opts) + # Retrieve ePay settings + data, status_code, headers = api_instance.get_e_pay_settings_for_association_by_id_with_http_info(association_id) p status_code # => 2xx p headers # => { ... } - p data # => <Array<NoteMessage>> + p data # => <EPaySettingsMessage> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_notes_with_http_info: #{e}" + puts "Error when calling AssociationsApi->get_e_pay_settings_for_association_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] | -| **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] | -| **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [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;NoteMessage&gt;**](NoteMessage.md) +[**EPaySettingsMessage**](EPaySettingsMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -742,17 +755,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_association_preferred_vendors +## inactivate_association -> <Array<AssociationPreferredVendorMessage>> get_association_preferred_vendors(association_id, opts) +> inactivate_association(association_id) -Retrieve all preferred vendors +Inactivate an association -Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` +Inactivates an association along with associated units and ownership accounts. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` ### Examples ```ruby require 'time' @@ -770,55 +783,46 @@ # config.api_key_prefix['clientSecret'] = 'Bearer' end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | -opts = { - 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 preferred vendors - result = api_instance.get_association_preferred_vendors(association_id, opts) - p result + # Inactivate an association + api_instance.inactivate_association(association_id) rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_preferred_vendors: #{e}" + puts "Error when calling AssociationsApi->inactivate_association: #{e}" end ``` -#### Using the get_association_preferred_vendors_with_http_info variant +#### Using the inactivate_association_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(<Array<AssociationPreferredVendorMessage>>, Integer, Hash)> get_association_preferred_vendors_with_http_info(association_id, opts) +> <Array(nil, Integer, Hash)> inactivate_association_with_http_info(association_id) ```ruby begin - # Retrieve all preferred vendors - data, status_code, headers = api_instance.get_association_preferred_vendors_with_http_info(association_id, opts) + # Inactivate an association + data, status_code, headers = api_instance.inactivate_association_with_http_info(association_id) p status_code # => 2xx p headers # => { ... } - p data # => <Array<AssociationPreferredVendorMessage>> + p data # => nil rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_association_preferred_vendors_with_http_info: #{e}" + puts "Error when calling AssociationsApi->inactivate_association_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **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;AssociationPreferredVendorMessage&gt;**](AssociationPreferredVendorMessage.md) +nil (empty response body) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -826,17 +830,17 @@ - **Content-Type**: Not defined - **Accept**: application/json -## get_associations +## reactivate_association -> <Array<AssociationMessage>> get_associations(opts) +> reactivate_association(association_id) -Retrieve all associations +Reactivate an association -Retrieves a list of associations. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` +Reactivates an association along with associated units and ownership accounts. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` ### Examples ```ruby require 'time' @@ -853,62 +857,47 @@ # 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::AssociationsApi.new -opts = { - location: 'location_example', # String | Filters results to any association whose city or state *contains* the specified value. - status: 'Active', # String | Filters results by the status of the association. If no status is specified both `active` and `inactive` associations will be returned. - lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. - lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. - 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. -} +association_id = 56 # Integer | begin - # Retrieve all associations - result = api_instance.get_associations(opts) - p result + # Reactivate an association + api_instance.reactivate_association(association_id) rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_associations: #{e}" + puts "Error when calling AssociationsApi->reactivate_association: #{e}" end ``` -#### Using the get_associations_with_http_info variant +#### Using the reactivate_association_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(<Array<AssociationMessage>>, Integer, Hash)> get_associations_with_http_info(opts) +> <Array(nil, Integer, Hash)> reactivate_association_with_http_info(association_id) ```ruby begin - # Retrieve all associations - data, status_code, headers = api_instance.get_associations_with_http_info(opts) + # Reactivate an association + data, status_code, headers = api_instance.reactivate_association_with_http_info(association_id) p status_code # => 2xx p headers # => { ... } - p data # => <Array<AssociationMessage>> + p data # => nil rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->get_associations_with_http_info: #{e}" + puts "Error when calling AssociationsApi->reactivate_association_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **location** | **String** | Filters results to any association whose city or state *contains* the specified value. | [optional] | -| **status** | **String** | Filters results by the status of the association. If no status is specified both &#x60;active&#x60; and &#x60;inactive&#x60; associations will be returned. | [optional] | -| **lastupdatedfrom** | **Time** | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] | -| **lastupdatedto** | **Time** | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [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] | +| **association_id** | **Integer** | | | ### Return type -[**Array&lt;AssociationMessage&gt;**](AssociationMessage.md) +nil (empty response body) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) @@ -922,11 +911,11 @@ > <AssociationMessage> update_association(association_id, association_put_message) Update an association -Updates an association. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` +Updates an association. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br /><br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` ### Examples ```ruby require 'time' @@ -1080,11 +1069,11 @@ > <Array<AssociationPreferredVendorMessage>> update_association_preferred_vendors(association_id, association_preferred_vendor_put_message) Update preferred vendors -Updates preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` `Edit` +Updates preferred vendors. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br /><br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` `Edit` ### Examples ```ruby require 'time' @@ -1152,17 +1141,17 @@ - **Content-Type**: application/json - **Accept**: application/json -## update_board_member +## update_e_pay_settings_for_association -> <AssociationBoardMemberMessage> update_board_member(association_id, board_member_id, association_board_member_put_message) +> <EPaySettingsMessage> update_e_pay_settings_for_association(association_id, e_pay_settings_put_message) -Update a board member +Update ePay settings -Updates a board member for a given association. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` `Edit` +Updates ePay settings for an association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations &gt; Associations and units</span> - `View` `Edit` ### Examples ```ruby require 'time' @@ -1180,50 +1169,48 @@ # config.api_key_prefix['clientSecret'] = 'Bearer' end api_instance = Buildium::AssociationsApi.new association_id = 56 # Integer | -board_member_id = 56 # Integer | -association_board_member_put_message = Buildium::AssociationBoardMemberPutMessage.new({board_position_type: 'President'}) # AssociationBoardMemberPutMessage | +e_pay_settings_put_message = Buildium::EPaySettingsPutMessage.new({eft_payments: Buildium::EFTPaymentsPutMessage.new({payments_enabled: false}), credit_card_payments: Buildium::CCPaymentsPutMessage.new({payments_enabled: false}), offline_payments: Buildium::OfflinePaymentsPutMessage.new({display_info_in_resident_center: false, display_company_address: false})}) # EPaySettingsPutMessage | begin - # Update a board member - result = api_instance.update_board_member(association_id, board_member_id, association_board_member_put_message) + # Update ePay settings + result = api_instance.update_e_pay_settings_for_association(association_id, e_pay_settings_put_message) p result rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->update_board_member: #{e}" + puts "Error when calling AssociationsApi->update_e_pay_settings_for_association: #{e}" end ``` -#### Using the update_board_member_with_http_info variant +#### Using the update_e_pay_settings_for_association_with_http_info variant This returns an Array which contains the response data, status code and headers. -> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message) +> <Array(<EPaySettingsMessage>, Integer, Hash)> update_e_pay_settings_for_association_with_http_info(association_id, e_pay_settings_put_message) ```ruby begin - # Update a board member - data, status_code, headers = api_instance.update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message) + # Update ePay settings + data, status_code, headers = api_instance.update_e_pay_settings_for_association_with_http_info(association_id, e_pay_settings_put_message) p status_code # => 2xx p headers # => { ... } - p data # => <AssociationBoardMemberMessage> + p data # => <EPaySettingsMessage> rescue Buildium::ApiError => e - puts "Error when calling AssociationsApi->update_board_member_with_http_info: #{e}" + puts "Error when calling AssociationsApi->update_e_pay_settings_for_association_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **association_id** | **Integer** | | | -| **board_member_id** | **Integer** | | | -| **association_board_member_put_message** | [**AssociationBoardMemberPutMessage**](AssociationBoardMemberPutMessage.md) | | | +| **e_pay_settings_put_message** | [**EPaySettingsPutMessage**](EPaySettingsPutMessage.md) | | | ### Return type -[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md) +[**EPaySettingsMessage**](EPaySettingsMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)