=begin
#Open API, powered by Buildium
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a **Premium Subscription**. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. Congratulations! Your account's enabled. Now, you’re ready to start managing API keys.
If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch.
You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account.
## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
The version of the OpenAPI document: v1
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.0.1
=end
require 'cgi'
module Buildium
class RentalPropertiesApi
attr_accessor :api_client
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# 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`
# @param property_id [Integer]
# @param listing_entity_file_post_message [ListingEntityFilePostMessage]
# @param [Hash] opts the optional parameters
# @return [FileUploadTicketMessage]
def create_rental_image_upload_file_request_async(property_id, listing_entity_file_post_message, opts = {})
data, _status_code, _headers = create_rental_image_upload_file_request_async_with_http_info(property_id, listing_entity_file_post_message, opts)
data
end
# Upload a rental image
# Uploads an image and associates it to the specified rental record. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> 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. <br /><br /><strong>NOTE:</strong> 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. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> 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: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 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 <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> 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. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param listing_entity_file_post_message [ListingEntityFilePostMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(FileUploadTicketMessage, Integer, Hash)>] FileUploadTicketMessage data, response status code and response headers
def create_rental_image_upload_file_request_async_with_http_info(property_id, listing_entity_file_post_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.create_rental_image_upload_file_request_async ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.create_rental_image_upload_file_request_async"
end
# verify the required parameter 'listing_entity_file_post_message' is set
if @api_client.config.client_side_validation && listing_entity_file_post_message.nil?
fail ArgumentError, "Missing the required parameter 'listing_entity_file_post_message' when calling RentalPropertiesApi.create_rental_image_upload_file_request_async"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/uploadrequests'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(listing_entity_file_post_message)
# return_type
return_type = opts[:debug_return_type] || 'FileUploadTicketMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.create_rental_image_upload_file_request_async",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#create_rental_image_upload_file_request_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Create a property
# Creates a new rental property.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit`
# @param rental_property_post_message [RentalPropertyPostMessage]
# @param [Hash] opts the optional parameters
# @return [RentalMessage]
def create_rental_property(rental_property_post_message, opts = {})
data, _status_code, _headers = create_rental_property_with_http_info(rental_property_post_message, opts)
data
end
# Create a property
# Creates a new rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param rental_property_post_message [RentalPropertyPostMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalMessage, Integer, Hash)>] RentalMessage data, response status code and response headers
def create_rental_property_with_http_info(rental_property_post_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.create_rental_property ...'
end
# verify the required parameter 'rental_property_post_message' is set
if @api_client.config.client_side_validation && rental_property_post_message.nil?
fail ArgumentError, "Missing the required parameter 'rental_property_post_message' when calling RentalPropertiesApi.create_rental_property"
end
# resource path
local_var_path = '/v1/rentals'
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_property_post_message)
# return_type
return_type = opts[:debug_return_type] || 'RentalMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.create_rental_property",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#create_rental_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Create a note
# Creates a note.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit`
# @param property_id [Integer]
# @param note_post_message [NotePostMessage]
# @param [Hash] opts the optional parameters
# @return [NoteMessage]
def create_rental_property_note(property_id, note_post_message, opts = {})
data, _status_code, _headers = create_rental_property_note_with_http_info(property_id, note_post_message, opts)
data
end
# Create a note
# Creates a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param note_post_message [NotePostMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(NoteMessage, Integer, Hash)>] NoteMessage data, response status code and response headers
def create_rental_property_note_with_http_info(property_id, note_post_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.create_rental_property_note ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.create_rental_property_note"
end
# verify the required parameter 'note_post_message' is set
if @api_client.config.client_side_validation && note_post_message.nil?
fail ArgumentError, "Missing the required parameter 'note_post_message' when calling RentalPropertiesApi.create_rental_property_note"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/notes'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(note_post_message)
# return_type
return_type = opts[:debug_return_type] || 'NoteMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.create_rental_property_note",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#create_rental_property_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param video_link_request_post_message [VideoLinkRequestPostMessage]
# @param [Hash] opts the optional parameters
# @return [RentalImageMessage]
def create_video_link_request(property_id, video_link_request_post_message, opts = {})
data, _status_code, _headers = create_video_link_request_with_http_info(property_id, video_link_request_post_message, opts)
data
end
# Create an image for a rental using a video link
# Creates an image for a rental using a video link. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param video_link_request_post_message [VideoLinkRequestPostMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalImageMessage, Integer, Hash)>] RentalImageMessage data, response status code and response headers
def create_video_link_request_with_http_info(property_id, video_link_request_post_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.create_video_link_request ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.create_video_link_request"
end
# verify the required parameter 'video_link_request_post_message' is set
if @api_client.config.client_side_validation && video_link_request_post_message.nil?
fail ArgumentError, "Missing the required parameter 'video_link_request_post_message' when calling RentalPropertiesApi.create_video_link_request"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/videolinkrequests'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(video_link_request_post_message)
# return_type
return_type = opts[:debug_return_type] || 'RentalImageMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.create_video_link_request",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#create_video_link_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Delete a property image
# Deletes a rental property image.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit` `Delete`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [nil]
def delete_rental_image(property_id, image_id, opts = {})
delete_rental_image_with_http_info(property_id, image_id, opts)
nil
end
# Delete a property image
# Deletes a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit` `Delete`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def delete_rental_image_with_http_info(property_id, image_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.delete_rental_image ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.delete_rental_image"
end
# verify the required parameter 'image_id' is set
if @api_client.config.client_side_validation && image_id.nil?
fail ArgumentError, "Missing the required parameter 'image_id' when calling RentalPropertiesApi.delete_rental_image"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/{imageId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.delete_rental_image",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#delete_rental_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve all properties
# Retrieves a list of rental properties.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param [Hash] opts the optional parameters
# @option opts [String] :location Filters results to only rental properties whose city or state *contains* the specified value.
# @option opts [Array] :types Filters results by the rental type. If no type is provided all types will be returned.
# @option opts [Array] :subtypes Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.
# @option opts [String] :status Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned.
# @option opts [Array] :rentalownerids Filters results to only rental properties whose RentalOwnerId matches the specified Id.
# @option opts [Array] :propertyids Filters results to only rental properties units whose Rental matches the specified Id.
# @option opts [Time] :lastupdatedfrom 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.
# @option opts [Time] :lastupdatedto 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.
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array]
def get_all_rentals(opts = {})
data, _status_code, _headers = get_all_rentals_with_http_info(opts)
data
end
# Retrieve all properties
# Retrieves a list of rental properties. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param [Hash] opts the optional parameters
# @option opts [String] :location Filters results to only rental properties whose city or state *contains* the specified value.
# @option opts [Array] :types Filters results by the rental type. If no type is provided all types will be returned.
# @option opts [Array] :subtypes Filters results by the sub type of the rental property. If no sub type is specified all sub types will be returned.
# @option opts [String] :status Filters results by the status of the rental property. If no status is specified both `active` and `inactive` rental properties will be returned.
# @option opts [Array] :rentalownerids Filters results to only rental properties whose RentalOwnerId matches the specified Id.
# @option opts [Array] :propertyids Filters results to only rental properties units whose Rental matches the specified Id.
# @option opts [Time] :lastupdatedfrom 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.
# @option opts [Time] :lastupdatedto 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.
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def get_all_rentals_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_all_rentals ...'
end
allowable_values = ["Residential", "Commercial"]
if @api_client.config.client_side_validation && opts[:'types'] && !opts[:'types'].all? { |item| allowable_values.include?(item) }
fail ArgumentError, "invalid value for \"types\", must include one of #{allowable_values}"
end
allowable_values = ["CondoTownhome", "MultiFamily", "SingleFamily", "Industrial", "Office", "Retail", "ShoppingCenter", "Storage", "ParkingSpace"]
if @api_client.config.client_side_validation && opts[:'subtypes'] && !opts[:'subtypes'].all? { |item| allowable_values.include?(item) }
fail ArgumentError, "invalid value for \"subtypes\", must include one of #{allowable_values}"
end
allowable_values = ["Active", "InActive"]
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
end
# resource path
local_var_path = '/v1/rentals'
# query parameters
query_params = opts[:query_params] || {}
query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
query_params[:'types'] = @api_client.build_collection_param(opts[:'types'], :multi) if !opts[:'types'].nil?
query_params[:'subtypes'] = @api_client.build_collection_param(opts[:'subtypes'], :multi) if !opts[:'subtypes'].nil?
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
query_params[:'rentalownerids'] = @api_client.build_collection_param(opts[:'rentalownerids'], :multi) if !opts[:'rentalownerids'].nil?
query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil?
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_all_rentals",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_all_rentals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve ePay settings
# Retrieves ePay settings for a rental property.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [EPaySettingsMessage]
def get_e_pay_settings_for_rental_property(property_id, opts = {})
data, _status_code, _headers = get_e_pay_settings_for_rental_property_with_http_info(property_id, opts)
data
end
# Retrieve ePay settings
# Retrieves ePay settings for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(EPaySettingsMessage, Integer, Hash)>] EPaySettingsMessage data, response status code and response headers
def get_e_pay_settings_for_rental_property_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_e_pay_settings_for_rental_property ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_e_pay_settings_for_rental_property"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/epaysettings'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'EPaySettingsMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_e_pay_settings_for_rental_property",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_e_pay_settings_for_rental_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve all amenities
# Retrieve all the amenities for a rental property.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [RentalFeaturesMessage]
def get_features_by_rental_property_id(property_id, opts = {})
data, _status_code, _headers = get_features_by_rental_property_id_with_http_info(property_id, opts)
data
end
# Retrieve all amenities
# Retrieve all the amenities for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalFeaturesMessage, Integer, Hash)>] RentalFeaturesMessage data, response status code and response headers
def get_features_by_rental_property_id_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_features_by_rental_property_id ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_features_by_rental_property_id"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/amenities'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'RentalFeaturesMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_features_by_rental_property_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_features_by_rental_property_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve a property
# Retrieve a specific rental property.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer] The rental property identifier.
# @param [Hash] opts the optional parameters
# @return [RentalMessage]
def get_rental_by_id(property_id, opts = {})
data, _status_code, _headers = get_rental_by_id_with_http_info(property_id, opts)
data
end
# Retrieve a property
# Retrieve a specific rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer] The rental property identifier.
# @param [Hash] opts the optional parameters
# @return [Array<(RentalMessage, Integer, Hash)>] RentalMessage data, response status code and response headers
def get_rental_by_id_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_by_id ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_by_id"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'RentalMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_by_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve a property image
# Retrieves a rental property image.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [RentalImageMessage]
def get_rental_image_by_id(property_id, image_id, opts = {})
data, _status_code, _headers = get_rental_image_by_id_with_http_info(property_id, image_id, opts)
data
end
# Retrieve a property image
# Retrieves a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalImageMessage, Integer, Hash)>] RentalImageMessage data, response status code and response headers
def get_rental_image_by_id_with_http_info(property_id, image_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_image_by_id ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_image_by_id"
end
# verify the required parameter 'image_id' is set
if @api_client.config.client_side_validation && image_id.nil?
fail ArgumentError, "Missing the required parameter 'image_id' when calling RentalPropertiesApi.get_rental_image_by_id"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/{imageId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'RentalImageMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_image_by_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_image_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [FileDownloadMessage]
def get_rental_image_download_url_by_id(property_id, image_id, opts = {})
data, _status_code, _headers = get_rental_image_download_url_by_id_with_http_info(property_id, image_id, opts)
data
end
# 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. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param image_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(FileDownloadMessage, Integer, Hash)>] FileDownloadMessage data, response status code and response headers
def get_rental_image_download_url_by_id_with_http_info(property_id, image_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_image_download_url_by_id ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_image_download_url_by_id"
end
# verify the required parameter 'image_id' is set
if @api_client.config.client_side_validation && image_id.nil?
fail ArgumentError, "Missing the required parameter 'image_id' when calling RentalPropertiesApi.get_rental_image_download_url_by_id"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/{imageId}/downloadrequests'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'FileDownloadMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_image_download_url_by_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_image_download_url_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array]
def get_rental_images(property_id, opts = {})
data, _status_code, _headers = get_rental_images_with_http_info(property_id, opts)
data
end
# 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. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def get_rental_images_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_images ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_images"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_images",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve a note
# Retrieves a note.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer]
# @param note_id [Integer]
# @param [Hash] opts the optional parameters
# @return [NoteMessage]
def get_rental_note_by_note_id(property_id, note_id, opts = {})
data, _status_code, _headers = get_rental_note_by_note_id_with_http_info(property_id, note_id, opts)
data
end
# Retrieve a note
# Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param note_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(NoteMessage, Integer, Hash)>] NoteMessage data, response status code and response headers
def get_rental_note_by_note_id_with_http_info(property_id, note_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_note_by_note_id ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_note_by_note_id"
end
# verify the required parameter 'note_id' is set
if @api_client.config.client_side_validation && note_id.nil?
fail ArgumentError, "Missing the required parameter 'note_id' when calling RentalPropertiesApi.get_rental_note_by_note_id"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/notes/{noteId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'NoteMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_note_by_note_id",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_note_by_note_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve all notes
# Retrieves all notes.
Required permission(s):
Rentals > Rental properties and units - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [Time] :updateddatetimefrom 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.
# @option opts [Time] :updateddatetimeto 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.
# @option opts [Integer] :lastupdatedbyuserid Filters results to only notes that were last updated by the specified user identifier.
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array]
def get_rental_notes(property_id, opts = {})
data, _status_code, _headers = get_rental_notes_with_http_info(property_id, opts)
data
end
# Retrieve all notes
# Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [Time] :updateddatetimefrom 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.
# @option opts [Time] :updateddatetimeto 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.
# @option opts [Integer] :lastupdatedbyuserid Filters results to only notes that were last updated by the specified user identifier.
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def get_rental_notes_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_notes ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_notes"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/notes'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
query_params[:'updateddatetimefrom'] = opts[:'updateddatetimefrom'] if !opts[:'updateddatetimefrom'].nil?
query_params[:'updateddatetimeto'] = opts[:'updateddatetimeto'] if !opts[:'updateddatetimeto'].nil?
query_params[:'lastupdatedbyuserid'] = opts[:'lastupdatedbyuserid'] if !opts[:'lastupdatedbyuserid'].nil?
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_notes",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Retrieve all preferred vendors
# Retrieves all preferred vendors.
Required permission(s):
Rentals > Rental properties and units - `View` Maintenance > Vendors - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array]
def get_rental_preferred_vendors(property_id, opts = {})
data, _status_code, _headers = get_rental_preferred_vendors_with_http_info(property_id, opts)
data
end
# Retrieve all preferred vendors
# Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @option opts [String] :orderby `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.
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
# @option opts [Integer] :limit `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.
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def get_rental_preferred_vendors_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.get_rental_preferred_vendors ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.get_rental_preferred_vendors"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/vendors'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.get_rental_preferred_vendors",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#get_rental_preferred_vendors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [nil]
def inactivate_rental_property(property_id, opts = {})
inactivate_rental_property_with_http_info(property_id, opts)
nil
end
# 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. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def inactivate_rental_property_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.inactivate_rental_property ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.inactivate_rental_property"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/inactivationrequest'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.inactivate_rental_property",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#inactivate_rental_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [nil]
def reactivate_rental_property(property_id, opts = {})
reactivate_rental_property_with_http_info(property_id, opts)
nil
end
# Reactivate a property
# Reactivates a rental property and all associated units. Any inactive rental owners assigned to this property will also be reactivated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def reactivate_rental_property_with_http_info(property_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.reactivate_rental_property ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.reactivate_rental_property"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/reactivationrequest'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body]
# return_type
return_type = opts[:debug_return_type]
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.reactivate_rental_property",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#reactivate_rental_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param image_reorder_request_put_message [ImageReorderRequestPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array]
def reorder_rental_images(property_id, image_reorder_request_put_message, opts = {})
data, _status_code, _headers = reorder_rental_images_with_http_info(property_id, image_reorder_request_put_message, opts)
data
end
# Update property image order
# Updates the image display order within the Buildium web application and in any associated rental listings. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param image_reorder_request_put_message [ImageReorderRequestPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def reorder_rental_images_with_http_info(property_id, image_reorder_request_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.reorder_rental_images ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.reorder_rental_images"
end
# verify the required parameter 'image_reorder_request_put_message' is set
if @api_client.config.client_side_validation && image_reorder_request_put_message.nil?
fail ArgumentError, "Missing the required parameter 'image_reorder_request_put_message' when calling RentalPropertiesApi.reorder_rental_images"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/order'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(image_reorder_request_put_message)
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.reorder_rental_images",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#reorder_rental_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Update ePay settings
# Updates ePay settings for a rental property.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit`
# @param property_id [Integer]
# @param e_pay_settings_put_message [EPaySettingsPutMessage]
# @param [Hash] opts the optional parameters
# @return [EPaySettingsMessage]
def update_e_pay_settings_for_rental(property_id, e_pay_settings_put_message, opts = {})
data, _status_code, _headers = update_e_pay_settings_for_rental_with_http_info(property_id, e_pay_settings_put_message, opts)
data
end
# Update ePay settings
# Updates ePay settings for a rental property. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param e_pay_settings_put_message [EPaySettingsPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(EPaySettingsMessage, Integer, Hash)>] EPaySettingsMessage data, response status code and response headers
def update_e_pay_settings_for_rental_with_http_info(property_id, e_pay_settings_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_e_pay_settings_for_rental ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_e_pay_settings_for_rental"
end
# verify the required parameter 'e_pay_settings_put_message' is set
if @api_client.config.client_side_validation && e_pay_settings_put_message.nil?
fail ArgumentError, "Missing the required parameter 'e_pay_settings_put_message' when calling RentalPropertiesApi.update_e_pay_settings_for_rental"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/epaysettings'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(e_pay_settings_put_message)
# return_type
return_type = opts[:debug_return_type] || 'EPaySettingsMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_e_pay_settings_for_rental",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_e_pay_settings_for_rental\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param rental_features_put_message [RentalFeaturesPutMessage]
# @param [Hash] opts the optional parameters
# @return [RentalFeaturesMessage]
def update_rental_features(property_id, rental_features_put_message, opts = {})
data, _status_code, _headers = update_rental_features_with_http_info(property_id, rental_features_put_message, opts)
data
end
# Update amenities
# Updates the amenities for a rental property. <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\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param rental_features_put_message [RentalFeaturesPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalFeaturesMessage, Integer, Hash)>] RentalFeaturesMessage data, response status code and response headers
def update_rental_features_with_http_info(property_id, rental_features_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_rental_features ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_rental_features"
end
# verify the required parameter 'rental_features_put_message' is set
if @api_client.config.client_side_validation && rental_features_put_message.nil?
fail ArgumentError, "Missing the required parameter 'rental_features_put_message' when calling RentalPropertiesApi.update_rental_features"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/amenities'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_features_put_message)
# return_type
return_type = opts[:debug_return_type] || 'RentalFeaturesMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_rental_features",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_rental_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Update a property image
# Updates a rental property image.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit`
# @param property_id [Integer]
# @param image_id [Integer]
# @param rental_image_put_message [RentalImagePutMessage]
# @param [Hash] opts the optional parameters
# @return [RentalImageMessage]
def update_rental_image(property_id, image_id, rental_image_put_message, opts = {})
data, _status_code, _headers = update_rental_image_with_http_info(property_id, image_id, rental_image_put_message, opts)
data
end
# Update a property image
# Updates a rental property image. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param image_id [Integer]
# @param rental_image_put_message [RentalImagePutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalImageMessage, Integer, Hash)>] RentalImageMessage data, response status code and response headers
def update_rental_image_with_http_info(property_id, image_id, rental_image_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_rental_image ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_rental_image"
end
# verify the required parameter 'image_id' is set
if @api_client.config.client_side_validation && image_id.nil?
fail ArgumentError, "Missing the required parameter 'image_id' when calling RentalPropertiesApi.update_rental_image"
end
# verify the required parameter 'rental_image_put_message' is set
if @api_client.config.client_side_validation && rental_image_put_message.nil?
fail ArgumentError, "Missing the required parameter 'rental_image_put_message' when calling RentalPropertiesApi.update_rental_image"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/images/{imageId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_image_put_message)
# return_type
return_type = opts[:debug_return_type] || 'RentalImageMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_rental_image",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_rental_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# Update preferred vendors
# Updates preferred vendors.
Required permission(s):
Rentals > Rental properties and units - `View` `Edit` Maintenance > Vendors - `View` `Edit`
# @param property_id [Integer]
# @param rental_preferred_vendor_put_message [RentalPreferredVendorPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array]
def update_rental_preferred_vendors(property_id, rental_preferred_vendor_put_message, opts = {})
data, _status_code, _headers = update_rental_preferred_vendors_with_http_info(property_id, rental_preferred_vendor_put_message, opts)
data
end
# Update preferred vendors
# Updates preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Rental properties and units</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View` `Edit`
# @param property_id [Integer]
# @param rental_preferred_vendor_put_message [RentalPreferredVendorPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers
def update_rental_preferred_vendors_with_http_info(property_id, rental_preferred_vendor_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_rental_preferred_vendors ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_rental_preferred_vendors"
end
# verify the required parameter 'rental_preferred_vendor_put_message' is set
if @api_client.config.client_side_validation && rental_preferred_vendor_put_message.nil?
fail ArgumentError, "Missing the required parameter 'rental_preferred_vendor_put_message' when calling RentalPropertiesApi.update_rental_preferred_vendors"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/vendors'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_preferred_vendor_put_message)
# return_type
return_type = opts[:debug_return_type] || 'Array'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_rental_preferred_vendors",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_rental_preferred_vendors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param rental_property_put_message [RentalPropertyPutMessage]
# @param [Hash] opts the optional parameters
# @return [RentalMessage]
def update_rental_property(property_id, rental_property_put_message, opts = {})
data, _status_code, _headers = update_rental_property_with_http_info(property_id, rental_property_put_message, opts)
data
end
# Update a property
# Updates a rental property. <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\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param rental_property_put_message [RentalPropertyPutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(RentalMessage, Integer, Hash)>] RentalMessage data, response status code and response headers
def update_rental_property_with_http_info(property_id, rental_property_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_rental_property ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_rental_property"
end
# verify the required parameter 'rental_property_put_message' is set
if @api_client.config.client_side_validation && rental_property_put_message.nil?
fail ArgumentError, "Missing the required parameter 'rental_property_put_message' when calling RentalPropertiesApi.update_rental_property"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_property_put_message)
# return_type
return_type = opts[:debug_return_type] || 'RentalMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_rental_property",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_rental_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
# 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`
# @param property_id [Integer]
# @param note_id [Integer]
# @param note_put_message [NotePutMessage]
# @param [Hash] opts the optional parameters
# @return [NoteMessage]
def update_rental_property_note(property_id, note_id, note_put_message, opts = {})
data, _status_code, _headers = update_rental_property_note_with_http_info(property_id, note_id, note_put_message, opts)
data
end
# Update a note
# Updates a note. <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\">Rentals > Rental properties and units</span> - `View` `Edit`
# @param property_id [Integer]
# @param note_id [Integer]
# @param note_put_message [NotePutMessage]
# @param [Hash] opts the optional parameters
# @return [Array<(NoteMessage, Integer, Hash)>] NoteMessage data, response status code and response headers
def update_rental_property_note_with_http_info(property_id, note_id, note_put_message, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: RentalPropertiesApi.update_rental_property_note ...'
end
# verify the required parameter 'property_id' is set
if @api_client.config.client_side_validation && property_id.nil?
fail ArgumentError, "Missing the required parameter 'property_id' when calling RentalPropertiesApi.update_rental_property_note"
end
# verify the required parameter 'note_id' is set
if @api_client.config.client_side_validation && note_id.nil?
fail ArgumentError, "Missing the required parameter 'note_id' when calling RentalPropertiesApi.update_rental_property_note"
end
# verify the required parameter 'note_put_message' is set
if @api_client.config.client_side_validation && note_put_message.nil?
fail ArgumentError, "Missing the required parameter 'note_put_message' when calling RentalPropertiesApi.update_rental_property_note"
end
# resource path
local_var_path = '/v1/rentals/{propertyId}/notes/{noteId}'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s)).sub('{' + 'noteId' + '}', CGI.escape(note_id.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
content_type = @api_client.select_header_content_type(['application/json'])
if !content_type.nil?
header_params['Content-Type'] = content_type
end
# form parameters
form_params = opts[:form_params] || {}
# http body (model)
post_body = opts[:debug_body] || @api_client.object_to_http_body(note_put_message)
# return_type
return_type = opts[:debug_return_type] || 'NoteMessage'
# auth_names
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
new_options = opts.merge(
:operation => :"RentalPropertiesApi.update_rental_property_note",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: RentalPropertiesApi#update_rental_property_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
end
end
![](\"file-upload-example.png\")