# Buildium::RentalPropertiesApi All URIs are relative to *https://api.buildium.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_rental_image_upload_file_request_async**](RentalPropertiesApi.md#create_rental_image_upload_file_request_async) | **POST** /v1/rentals/{propertyId}/images/uploadrequests | Upload a rental image | | [**create_rental_property**](RentalPropertiesApi.md#create_rental_property) | **POST** /v1/rentals | Create a property | | [**create_rental_property_note**](RentalPropertiesApi.md#create_rental_property_note) | **POST** /v1/rentals/{propertyId}/notes | Create a note | | [**create_rental_unit**](RentalPropertiesApi.md#create_rental_unit) | **POST** /v1/rentals/units | Create a unit | | [**create_video_link_request**](RentalPropertiesApi.md#create_video_link_request) | **POST** /v1/rentals/{propertyId}/images/videolinkrequests | Create an image for a rental using a video link | | [**delete_rental_image**](RentalPropertiesApi.md#delete_rental_image) | **DELETE** /v1/rentals/{propertyId}/images/{imageId} | Delete a property image | | [**get_all_rental_units**](RentalPropertiesApi.md#get_all_rental_units) | **GET** /v1/rentals/units | Retrieve all units | | [**get_all_rentals**](RentalPropertiesApi.md#get_all_rentals) | **GET** /v1/rentals | Retrieve all properties | | [**get_e_pay_settings_for_rental_property**](RentalPropertiesApi.md#get_e_pay_settings_for_rental_property) | **GET** /v1/rentals/{propertyId}/epaysettings | Retrieve ePay settings | | [**get_features_by_rental_property_id**](RentalPropertiesApi.md#get_features_by_rental_property_id) | **GET** /v1/rentals/{propertyId}/amenities | Retrieve all amenities | | [**get_rental_by_id**](RentalPropertiesApi.md#get_rental_by_id) | **GET** /v1/rentals/{propertyId} | Retrieve a property | | [**get_rental_image_by_id**](RentalPropertiesApi.md#get_rental_image_by_id) | **GET** /v1/rentals/{propertyId}/images/{imageId} | Retrieve a property image | | [**get_rental_image_download_url_by_id**](RentalPropertiesApi.md#get_rental_image_download_url_by_id) | **POST** /v1/rentals/{propertyId}/images/{imageId}/downloadrequests | Download a property image | | [**get_rental_images**](RentalPropertiesApi.md#get_rental_images) | **GET** /v1/rentals/{propertyId}/images | Retrieve all property images | | [**get_rental_note_by_note_id**](RentalPropertiesApi.md#get_rental_note_by_note_id) | **GET** /v1/rentals/{propertyId}/notes/{noteId} | Retrieve a note | | [**get_rental_notes**](RentalPropertiesApi.md#get_rental_notes) | **GET** /v1/rentals/{propertyId}/notes | Retrieve all notes | | [**get_rental_preferred_vendors**](RentalPropertiesApi.md#get_rental_preferred_vendors) | **GET** /v1/rentals/{propertyId}/vendors | Retrieve all preferred vendors | | [**get_rental_unit_by_id**](RentalPropertiesApi.md#get_rental_unit_by_id) | **GET** /v1/rentals/units/{unitId} | Retrieve a unit | | [**inactivate_rental_property**](RentalPropertiesApi.md#inactivate_rental_property) | **POST** /v1/rentals/{propertyId}/inactivationrequest | Inactivate a property | | [**reactivate_rental_property**](RentalPropertiesApi.md#reactivate_rental_property) | **POST** /v1/rentals/{propertyId}/reactivationrequest | Reactivate a property | | [**reorder_rental_images**](RentalPropertiesApi.md#reorder_rental_images) | **PUT** /v1/rentals/{propertyId}/images/order | Update property image order | | [**update_e_pay_settings_for_rental**](RentalPropertiesApi.md#update_e_pay_settings_for_rental) | **PUT** /v1/rentals/{propertyId}/epaysettings | Update ePay settings | | [**update_rental_features**](RentalPropertiesApi.md#update_rental_features) | **PUT** /v1/rentals/{propertyId}/amenities | Update amenities | | [**update_rental_image**](RentalPropertiesApi.md#update_rental_image) | **PUT** /v1/rentals/{propertyId}/images/{imageId} | Update a property image | | [**update_rental_preferred_vendors**](RentalPropertiesApi.md#update_rental_preferred_vendors) | **PUT** /v1/rentals/{propertyId}/vendors | Update preferred vendors | | [**update_rental_property**](RentalPropertiesApi.md#update_rental_property) | **PUT** /v1/rentals/{propertyId} | Update a property | | [**update_rental_property_note**](RentalPropertiesApi.md#update_rental_property_note) | **PUT** /v1/rentals/{propertyId}/notes/{noteId} | Update a note | | [**update_rental_unit**](RentalPropertiesApi.md#update_rental_unit) | **PUT** /v1/rentals/units/{unitId} | Update a unit | ## create_rental_image_upload_file_request_async > create_rental_image_upload_file_request_async(property_id, create_rental_image_upload_file_request_async_request) Upload a rental image Uploads an image and associates it to the specified rental record.

Uploading a file requires making two API requests. Each step is outlined below.

Step 1 - Save file metadata
The first step in the file upload process is to submit the file metadata to `/v1/rentals/{rentalId}/images/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload.

NOTE: The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully.

Step 2 - Upload the file binary
Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request:
1. Form a POST request using the value of the `BucketUrl` property as the URL.

2. Set the `Content-Type` header to `multipart/form-data`.

3. Copy the fields from the `FormData` property to this request as form-data key/value pairs.
NOTE: These values must added to the request form-data in the order they were received in the response.

4. Lastly create a form-data key named `file` and set the value to the file binary.
NOTE: This must be the last field in the form-data list.

This image shows what the POST request should look like if you're using Postman:

5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to AWS documentation on REST error responses.

NOTE: The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | create_rental_image_upload_file_request_async_request = Buildium::CreateRentalImageUploadFileRequestAsyncRequest.new({file_name: 'file_name_example', show_in_listing: false}) # CreateRentalImageUploadFileRequestAsyncRequest | begin # Upload a rental image result = api_instance.create_rental_image_upload_file_request_async(property_id, create_rental_image_upload_file_request_async_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_image_upload_file_request_async: #{e}" end ``` #### Using the create_rental_image_upload_file_request_async_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_rental_image_upload_file_request_async_with_http_info(property_id, create_rental_image_upload_file_request_async_request) ```ruby begin # Upload a rental image data, status_code, headers = api_instance.create_rental_image_upload_file_request_async_with_http_info(property_id, create_rental_image_upload_file_request_async_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_image_upload_file_request_async_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **create_rental_image_upload_file_request_async_request** | [**CreateRentalImageUploadFileRequestAsyncRequest**](CreateRentalImageUploadFileRequestAsyncRequest.md) | | | ### Return type [**FileUploadTicketMessage**](FileUploadTicketMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## create_rental_property > create_rental_property(create_rental_property_request) Create a property Creates a new rental property.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new create_rental_property_request = Buildium::CreateRentalPropertyRequest.new({name: 'name_example', address: Buildium::RentalPropertyPostMessageAddress.new({address_line1: 'address_line1_example', country: 'Afghanistan'}), rental_sub_type: 'CondoTownhome', operating_bank_account_id: 37}) # CreateRentalPropertyRequest | begin # Create a property result = api_instance.create_rental_property(create_rental_property_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_property: #{e}" end ``` #### Using the create_rental_property_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_rental_property_with_http_info(create_rental_property_request) ```ruby begin # Create a property data, status_code, headers = api_instance.create_rental_property_with_http_info(create_rental_property_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_property_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **create_rental_property_request** | [**CreateRentalPropertyRequest**](CreateRentalPropertyRequest.md) | | | ### Return type [**RentalMessage**](RentalMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## create_rental_property_note > create_rental_property_note(property_id, create_lease_note_request) Create a note Creates a note.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | create_lease_note_request = Buildium::CreateLeaseNoteRequest.new({note: 'note_example'}) # CreateLeaseNoteRequest | begin # Create a note result = api_instance.create_rental_property_note(property_id, create_lease_note_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_property_note: #{e}" end ``` #### Using the create_rental_property_note_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_rental_property_note_with_http_info(property_id, create_lease_note_request) ```ruby begin # Create a note data, status_code, headers = api_instance.create_rental_property_note_with_http_info(property_id, create_lease_note_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_property_note_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **create_lease_note_request** | [**CreateLeaseNoteRequest**](CreateLeaseNoteRequest.md) | | | ### Return type [**NoteMessage**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## create_rental_unit > create_rental_unit(create_rental_unit_request) Create a unit Creates a rental unit.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new create_rental_unit_request = Buildium::CreateRentalUnitRequest.new({unit_number: 'unit_number_example', property_id: 37, address: Buildium::RentalPropertyUnitPostMessageAddress.new({address_line1: 'address_line1_example', country: 'Afghanistan'})}) # CreateRentalUnitRequest | begin # Create a unit result = api_instance.create_rental_unit(create_rental_unit_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_unit: #{e}" end ``` #### Using the create_rental_unit_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_rental_unit_with_http_info(create_rental_unit_request) ```ruby begin # Create a unit data, status_code, headers = api_instance.create_rental_unit_with_http_info(create_rental_unit_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_rental_unit_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **create_rental_unit_request** | [**CreateRentalUnitRequest**](CreateRentalUnitRequest.md) | | | ### Return type [**RentalUnitMessage**](RentalUnitMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## create_video_link_request > create_video_link_request(property_id, create_video_link_request_request) Create an image for a rental using a video link Creates an image for a rental using a video link.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | create_video_link_request_request = Buildium::CreateVideoLinkRequestRequest.new({video_url: 'video_url_example', show_in_listing: false}) # CreateVideoLinkRequestRequest | begin # Create an image for a rental using a video link result = api_instance.create_video_link_request(property_id, create_video_link_request_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_video_link_request: #{e}" end ``` #### Using the create_video_link_request_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_video_link_request_with_http_info(property_id, create_video_link_request_request) ```ruby begin # Create an image for a rental using a video link data, status_code, headers = api_instance.create_video_link_request_with_http_info(property_id, create_video_link_request_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->create_video_link_request_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **create_video_link_request_request** | [**CreateVideoLinkRequestRequest**](CreateVideoLinkRequestRequest.md) | | | ### Return type [**RentalImageMessage**](RentalImageMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## delete_rental_image > delete_rental_image(property_id, image_id) Delete a property image Deletes a rental property image.

Required permission(s):

Rentals > Rental properties and units - `View` `Edit` `Delete` ### 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::RentalPropertiesApi.new property_id = 56 # Integer | image_id = 56 # Integer | begin # Delete a property image api_instance.delete_rental_image(property_id, image_id) rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->delete_rental_image: #{e}" end ``` #### Using the delete_rental_image_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > delete_rental_image_with_http_info(property_id, image_id) ```ruby begin # Delete a property image data, status_code, headers = api_instance.delete_rental_image_with_http_info(property_id, image_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->delete_rental_image_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **image_id** | **Integer** | | | ### Return type nil (empty response body) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_all_rental_units > > get_all_rental_units(opts) Retrieve all units Retrieves a list of rental property units.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new opts = { propertyids: [37], # Array | Filters results to rental units that belong to the specified set of property ids. lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental units 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 rental units 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 Bulk Request Options 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 units result = api_instance.get_all_rental_units(opts) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_all_rental_units: #{e}" end ``` #### Using the get_all_rental_units_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_all_rental_units_with_http_info(opts) ```ruby begin # Retrieve all units data, status_code, headers = api_instance.get_all_rental_units_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_all_rental_units_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **propertyids** | [**Array<Integer>**](Integer.md) | Filters results to rental units that belong to the specified set of property ids. | [optional] | | **lastupdatedfrom** | **Time** | Filters results to any rental units 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 rental units 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** | `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. | [optional] | | **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] | | **limit** | **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. | [optional] | ### Return type [**Array<RentalUnitMessage>**](RentalUnitMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_all_rentals > > get_all_rentals(opts) Retrieve all properties Retrieves a list of rental properties.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new opts = { location: 'location_example', # String | Filters results to only rental properties whose city or state *contains* the specified value. types: ['Residential'], # Array | Filters results by the rental type. If no type is provided all types will be returned. subtypes: ['CondoTownhome'], # Array | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned. status: 'Active', # String | Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned. rentalownerids: [37], # Array | Filters results to only rental properties whose RentalOwnerId matches the specified Id. propertyids: [37], # Array | Filters results to only rental properties units whose Rental matches the specified Id. lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any rental properties 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 rental properties 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 Bulk Request Options 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 properties result = api_instance.get_all_rentals(opts) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_all_rentals: #{e}" end ``` #### Using the get_all_rentals_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_all_rentals_with_http_info(opts) ```ruby begin # Retrieve all properties data, status_code, headers = api_instance.get_all_rentals_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_all_rentals_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **location** | **String** | Filters results to only rental properties whose city or state *contains* the specified value. | [optional] | | **types** | [**Array<String>**](String.md) | Filters results by the rental type. If no type is provided all types will be returned. | [optional] | | **subtypes** | [**Array<String>**](String.md) | Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned. | [optional] | | **status** | **String** | Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned. | [optional] | | **rentalownerids** | [**Array<Integer>**](Integer.md) | Filters results to only rental properties whose RentalOwnerId matches the specified Id. | [optional] | | **propertyids** | [**Array<Integer>**](Integer.md) | Filters results to only rental properties units whose Rental matches the specified Id. | [optional] | | **lastupdatedfrom** | **Time** | Filters results to any rental properties 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 rental properties 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** | `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. | [optional] | | **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] | | **limit** | **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. | [optional] | ### Return type [**Array<RentalMessage>**](RentalMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_e_pay_settings_for_rental_property > get_e_pay_settings_for_rental_property(property_id) Retrieve ePay settings Retrieves ePay settings for a rental property.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | begin # Retrieve ePay settings result = api_instance.get_e_pay_settings_for_rental_property(property_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_e_pay_settings_for_rental_property: #{e}" end ``` #### Using the get_e_pay_settings_for_rental_property_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_e_pay_settings_for_rental_property_with_http_info(property_id) ```ruby begin # Retrieve ePay settings data, status_code, headers = api_instance.get_e_pay_settings_for_rental_property_with_http_info(property_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_e_pay_settings_for_rental_property_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | ### Return type [**EPaySettingsMessage**](EPaySettingsMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_features_by_rental_property_id > get_features_by_rental_property_id(property_id) Retrieve all amenities Retrieve all the amenities for a rental property.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | begin # Retrieve all amenities result = api_instance.get_features_by_rental_property_id(property_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id: #{e}" end ``` #### Using the get_features_by_rental_property_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_features_by_rental_property_id_with_http_info(property_id) ```ruby begin # Retrieve all amenities data, status_code, headers = api_instance.get_features_by_rental_property_id_with_http_info(property_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_features_by_rental_property_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | ### Return type [**RentalFeaturesMessage**](RentalFeaturesMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_by_id > get_rental_by_id(property_id) Retrieve a property Retrieve a specific rental property.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | The rental property identifier. begin # Retrieve a property result = api_instance.get_rental_by_id(property_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_by_id: #{e}" end ``` #### Using the get_rental_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_rental_by_id_with_http_info(property_id) ```ruby begin # Retrieve a property data, status_code, headers = api_instance.get_rental_by_id_with_http_info(property_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | The rental property identifier. | | ### Return type [**RentalMessage**](RentalMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_image_by_id > get_rental_image_by_id(property_id, image_id) Retrieve a property image Retrieves a rental property image.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | image_id = 56 # Integer | begin # Retrieve a property image result = api_instance.get_rental_image_by_id(property_id, image_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_image_by_id: #{e}" end ``` #### Using the get_rental_image_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_rental_image_by_id_with_http_info(property_id, image_id) ```ruby begin # Retrieve a property image data, status_code, headers = api_instance.get_rental_image_by_id_with_http_info(property_id, image_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_image_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **image_id** | **Integer** | | | ### Return type [**RentalImageMessage**](RentalImageMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_image_download_url_by_id > get_rental_image_download_url_by_id(property_id, image_id) Download a property image Use this endpoint to create a temporary URL that can be used to download a property image. This URL expires after 5 minutes.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | image_id = 56 # Integer | begin # Download a property image result = api_instance.get_rental_image_download_url_by_id(property_id, image_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_image_download_url_by_id: #{e}" end ``` #### Using the get_rental_image_download_url_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_rental_image_download_url_by_id_with_http_info(property_id, image_id) ```ruby begin # Download a property image data, status_code, headers = api_instance.get_rental_image_download_url_by_id_with_http_info(property_id, image_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_image_download_url_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **image_id** | **Integer** | | | ### Return type [**FileDownloadMessage**](FileDownloadMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_images > > get_rental_images(property_id, opts) Retrieve all property images Retrieves all images for a rental property. Note this endpoint will only return file metadata such as file names and descriptions. To download files make requests to the [Download File](#tag/Rental-Properties/operation/GetRentalImageDownloadUrlById) endpoint.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | opts = { orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See Bulk Request Options 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 property images result = api_instance.get_rental_images(property_id, opts) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_images: #{e}" end ``` #### Using the get_rental_images_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_rental_images_with_http_info(property_id, opts) ```ruby begin # Retrieve all property images data, status_code, headers = api_instance.get_rental_images_with_http_info(property_id, opts) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_images_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **orderby** | **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. | [optional] | | **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] | | **limit** | **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. | [optional] | ### Return type [**Array<RentalImageMessage>**](RentalImageMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_note_by_note_id > get_rental_note_by_note_id(property_id, note_id) Retrieve a note Retrieves a note.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | note_id = 56 # Integer | begin # Retrieve a note result = api_instance.get_rental_note_by_note_id(property_id, note_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id: #{e}" end ``` #### Using the get_rental_note_by_note_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_rental_note_by_note_id_with_http_info(property_id, note_id) ```ruby begin # Retrieve a note data, status_code, headers = api_instance.get_rental_note_by_note_id_with_http_info(property_id, note_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_note_by_note_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **note_id** | **Integer** | | | ### Return type [**NoteMessage**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_notes > > get_rental_notes(property_id, opts) Retrieve all notes Retrieves all notes.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_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 Bulk Request Options 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_rental_notes(property_id, opts) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_notes: #{e}" end ``` #### Using the get_rental_notes_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_rental_notes_with_http_info(property_id, opts) ```ruby begin # Retrieve all notes data, status_code, headers = api_instance.get_rental_notes_with_http_info(property_id, opts) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_notes_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_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** | `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. | [optional] | | **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] | | **limit** | **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. | [optional] | ### Return type [**Array<NoteMessage>**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_preferred_vendors > > get_rental_preferred_vendors(property_id, opts) Retrieve all preferred vendors Retrieves all preferred vendors.

Required permission(s):

Rentals > Rental properties and units - `View`
Maintenance > Vendors - `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::RentalPropertiesApi.new property_id = 56 # Integer | opts = { orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See Bulk Request Options 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_rental_preferred_vendors(property_id, opts) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors: #{e}" end ``` #### Using the get_rental_preferred_vendors_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_rental_preferred_vendors_with_http_info(property_id, opts) ```ruby begin # Retrieve all preferred vendors data, status_code, headers = api_instance.get_rental_preferred_vendors_with_http_info(property_id, opts) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_preferred_vendors_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **orderby** | **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. | [optional] | | **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] | | **limit** | **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. | [optional] | ### Return type [**Array<RentalPreferredVendorMessage>**](RentalPreferredVendorMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_rental_unit_by_id > get_rental_unit_by_id(unit_id) Retrieve a unit Retrieves a specific rental property unit.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new unit_id = 56 # Integer | The rental unit identifier. begin # Retrieve a unit result = api_instance.get_rental_unit_by_id(unit_id) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_unit_by_id: #{e}" end ``` #### Using the get_rental_unit_by_id_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_rental_unit_by_id_with_http_info(unit_id) ```ruby begin # Retrieve a unit data, status_code, headers = api_instance.get_rental_unit_by_id_with_http_info(unit_id) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->get_rental_unit_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **unit_id** | **Integer** | The rental unit identifier. | | ### Return type [**RentalUnitMessage**](RentalUnitMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## inactivate_rental_property > inactivate_rental_property(property_id) Inactivate a property Inactivates a rental property and all associated units. Any associated property's owners that have no remaining active properties will be inactivated.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | begin # Inactivate a property api_instance.inactivate_rental_property(property_id) rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->inactivate_rental_property: #{e}" end ``` #### Using the inactivate_rental_property_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > inactivate_rental_property_with_http_info(property_id) ```ruby begin # Inactivate a property data, status_code, headers = api_instance.inactivate_rental_property_with_http_info(property_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->inactivate_rental_property_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | ### Return type nil (empty response body) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## reactivate_rental_property > reactivate_rental_property(property_id) Reactivate a property Reactivates a rental property and all associated units. Any inactive rental owners assigned to this property will also be reactivated.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | begin # Reactivate a property api_instance.reactivate_rental_property(property_id) rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->reactivate_rental_property: #{e}" end ``` #### Using the reactivate_rental_property_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > reactivate_rental_property_with_http_info(property_id) ```ruby begin # Reactivate a property data, status_code, headers = api_instance.reactivate_rental_property_with_http_info(property_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->reactivate_rental_property_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | ### Return type nil (empty response body) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## reorder_rental_images > > reorder_rental_images(property_id, reorder_rental_images_request) Update property image order Updates the image display order within the Buildium web application and in any associated rental listings.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | reorder_rental_images_request = Buildium::ReorderRentalImagesRequest.new({ids: [37]}) # ReorderRentalImagesRequest | begin # Update property image order result = api_instance.reorder_rental_images(property_id, reorder_rental_images_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->reorder_rental_images: #{e}" end ``` #### Using the reorder_rental_images_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> reorder_rental_images_with_http_info(property_id, reorder_rental_images_request) ```ruby begin # Update property image order data, status_code, headers = api_instance.reorder_rental_images_with_http_info(property_id, reorder_rental_images_request) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->reorder_rental_images_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **reorder_rental_images_request** | [**ReorderRentalImagesRequest**](ReorderRentalImagesRequest.md) | | | ### Return type [**Array<RentalImageMessage>**](RentalImageMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_e_pay_settings_for_rental > update_e_pay_settings_for_rental(property_id, update_e_pay_settings_for_association_request) Update ePay settings Updates ePay settings for a rental property.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | update_e_pay_settings_for_association_request = Buildium::UpdateEPaySettingsForAssociationRequest.new({eft_payments: Buildium::EPaySettingsPutMessageEFTPayments.new({payments_enabled: false}), credit_card_payments: Buildium::EPaySettingsPutMessageCreditCardPayments.new({payments_enabled: false}), offline_payments: Buildium::EPaySettingsPutMessageOfflinePayments.new({display_info_in_resident_center: false, display_company_address: false})}) # UpdateEPaySettingsForAssociationRequest | begin # Update ePay settings result = api_instance.update_e_pay_settings_for_rental(property_id, update_e_pay_settings_for_association_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_e_pay_settings_for_rental: #{e}" end ``` #### Using the update_e_pay_settings_for_rental_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_e_pay_settings_for_rental_with_http_info(property_id, update_e_pay_settings_for_association_request) ```ruby begin # Update ePay settings data, status_code, headers = api_instance.update_e_pay_settings_for_rental_with_http_info(property_id, update_e_pay_settings_for_association_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_e_pay_settings_for_rental_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **update_e_pay_settings_for_association_request** | [**UpdateEPaySettingsForAssociationRequest**](UpdateEPaySettingsForAssociationRequest.md) | | | ### Return type [**EPaySettingsMessage**](EPaySettingsMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_features > update_rental_features(property_id, update_rental_features_request) Update amenities Updates the amenities for a rental property.

NOTE: 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.
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.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | update_rental_features_request = Buildium::UpdateRentalFeaturesRequest.new # UpdateRentalFeaturesRequest | begin # Update amenities result = api_instance.update_rental_features(property_id, update_rental_features_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_features: #{e}" end ``` #### Using the update_rental_features_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_rental_features_with_http_info(property_id, update_rental_features_request) ```ruby begin # Update amenities data, status_code, headers = api_instance.update_rental_features_with_http_info(property_id, update_rental_features_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_features_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **update_rental_features_request** | [**UpdateRentalFeaturesRequest**](UpdateRentalFeaturesRequest.md) | | | ### Return type [**RentalFeaturesMessage**](RentalFeaturesMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_image > update_rental_image(property_id, image_id, update_rental_image_request) Update a property image Updates a rental property image.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | image_id = 56 # Integer | update_rental_image_request = Buildium::UpdateRentalImageRequest.new({show_in_listing: false}) # UpdateRentalImageRequest | begin # Update a property image result = api_instance.update_rental_image(property_id, image_id, update_rental_image_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_image: #{e}" end ``` #### Using the update_rental_image_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_rental_image_with_http_info(property_id, image_id, update_rental_image_request) ```ruby begin # Update a property image data, status_code, headers = api_instance.update_rental_image_with_http_info(property_id, image_id, update_rental_image_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_image_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **image_id** | **Integer** | | | | **update_rental_image_request** | [**UpdateRentalImageRequest**](UpdateRentalImageRequest.md) | | | ### Return type [**RentalImageMessage**](RentalImageMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_preferred_vendors > > update_rental_preferred_vendors(property_id, update_rental_preferred_vendors_request) Update preferred vendors Updates preferred vendors.

Required permission(s):

Rentals > Rental properties and units - `View` `Edit`
Maintenance > Vendors - `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::RentalPropertiesApi.new property_id = 56 # Integer | update_rental_preferred_vendors_request = Buildium::UpdateRentalPreferredVendorsRequest.new({vendor_ids: [37]}) # UpdateRentalPreferredVendorsRequest | begin # Update preferred vendors result = api_instance.update_rental_preferred_vendors(property_id, update_rental_preferred_vendors_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_preferred_vendors: #{e}" end ``` #### Using the update_rental_preferred_vendors_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> update_rental_preferred_vendors_with_http_info(property_id, update_rental_preferred_vendors_request) ```ruby begin # Update preferred vendors data, status_code, headers = api_instance.update_rental_preferred_vendors_with_http_info(property_id, update_rental_preferred_vendors_request) p status_code # => 2xx p headers # => { ... } p data # => > rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_preferred_vendors_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **update_rental_preferred_vendors_request** | [**UpdateRentalPreferredVendorsRequest**](UpdateRentalPreferredVendorsRequest.md) | | | ### Return type [**Array<RentalPreferredVendorMessage>**](RentalPreferredVendorMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_property > update_rental_property(property_id, update_rental_property_request) Update a property Updates a rental property.

NOTE: 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.
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.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | update_rental_property_request = Buildium::UpdateRentalPropertyRequest.new({name: 'name_example', address: Buildium::RentalPropertyPutMessageAddress.new({address_line1: 'address_line1_example', country: 'Afghanistan'}), rental_sub_type: 'CondoTownhome', operating_bank_account_id: 37}) # UpdateRentalPropertyRequest | begin # Update a property result = api_instance.update_rental_property(property_id, update_rental_property_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_property: #{e}" end ``` #### Using the update_rental_property_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_rental_property_with_http_info(property_id, update_rental_property_request) ```ruby begin # Update a property data, status_code, headers = api_instance.update_rental_property_with_http_info(property_id, update_rental_property_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_property_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **update_rental_property_request** | [**UpdateRentalPropertyRequest**](UpdateRentalPropertyRequest.md) | | | ### Return type [**RentalMessage**](RentalMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_property_note > update_rental_property_note(property_id, note_id, update_lease_note_request) Update a note Updates a note.

NOTE: 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.
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.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new property_id = 56 # Integer | note_id = 56 # Integer | update_lease_note_request = Buildium::UpdateLeaseNoteRequest.new({note: 'note_example'}) # UpdateLeaseNoteRequest | begin # Update a note result = api_instance.update_rental_property_note(property_id, note_id, update_lease_note_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_property_note: #{e}" end ``` #### Using the update_rental_property_note_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_rental_property_note_with_http_info(property_id, note_id, update_lease_note_request) ```ruby begin # Update a note data, status_code, headers = api_instance.update_rental_property_note_with_http_info(property_id, note_id, update_lease_note_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_property_note_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **property_id** | **Integer** | | | | **note_id** | **Integer** | | | | **update_lease_note_request** | [**UpdateLeaseNoteRequest**](UpdateLeaseNoteRequest.md) | | | ### Return type [**NoteMessage**](NoteMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_rental_unit > update_rental_unit(unit_id, update_rental_unit_request) Update a unit Updates a rental unit.

NOTE: 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.
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.

Required permission(s):

Rentals > Rental properties and units - `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::RentalPropertiesApi.new unit_id = 56 # Integer | The identifier of the unit to update. update_rental_unit_request = Buildium::UpdateRentalUnitRequest.new({unit_number: 'unit_number_example', address: Buildium::RentalPropertyUnitPostMessageAddress.new({address_line1: 'address_line1_example', country: 'Afghanistan'})}) # UpdateRentalUnitRequest | begin # Update a unit result = api_instance.update_rental_unit(unit_id, update_rental_unit_request) p result rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_unit: #{e}" end ``` #### Using the update_rental_unit_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_rental_unit_with_http_info(unit_id, update_rental_unit_request) ```ruby begin # Update a unit data, status_code, headers = api_instance.update_rental_unit_with_http_info(unit_id, update_rental_unit_request) p status_code # => 2xx p headers # => { ... } p data # => rescue Buildium::ApiError => e puts "Error when calling RentalPropertiesApi->update_rental_unit_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **unit_id** | **Integer** | The identifier of the unit to update. | | | **update_rental_unit_request** | [**UpdateRentalUnitRequest**](UpdateRentalUnitRequest.md) | | | ### Return type [**RentalUnitMessage**](RentalUnitMessage.md) ### Authorization [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json