=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 RentalTenantsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a tenant # Creates a rental tenant.

Required permission(s):

Rentals > Tenants - `View` `Edit`
Rentals > Leases - `View` `Edit` # @param create_rental_tenant_request [CreateRentalTenantRequest] # @param [Hash] opts the optional parameters # @return [TenantMessage] def create_rental_tenant(create_rental_tenant_request, opts = {}) data, _status_code, _headers = create_rental_tenant_with_http_info(create_rental_tenant_request, opts) data end # Create a tenant # Creates a rental tenant. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Rentals > Leases</span> - `View` `Edit` # @param create_rental_tenant_request [CreateRentalTenantRequest] # @param [Hash] opts the optional parameters # @return [Array<(TenantMessage, Integer, Hash)>] TenantMessage data, response status code and response headers def create_rental_tenant_with_http_info(create_rental_tenant_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.create_rental_tenant ...' end # verify the required parameter 'create_rental_tenant_request' is set if @api_client.config.client_side_validation && create_rental_tenant_request.nil? fail ArgumentError, "Missing the required parameter 'create_rental_tenant_request' when calling RentalTenantsApi.create_rental_tenant" end # resource path local_var_path = '/v1/leases/tenants' # 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(create_rental_tenant_request) # return_type return_type = opts[:debug_return_type] || 'TenantMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"RentalTenantsApi.create_rental_tenant", :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: RentalTenantsApi#create_rental_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a note # Creates a tenant note.

Required permission(s):

Rentals > Tenants - `View` `Edit` # @param tenant_id [Integer] # @param create_lease_note_request [CreateLeaseNoteRequest] # @param [Hash] opts the optional parameters # @return [NoteMessage] def create_tenant_note(tenant_id, create_lease_note_request, opts = {}) data, _status_code, _headers = create_tenant_note_with_http_info(tenant_id, create_lease_note_request, opts) data end # Create a note # Creates a tenant note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` `Edit` # @param tenant_id [Integer] # @param create_lease_note_request [CreateLeaseNoteRequest] # @param [Hash] opts the optional parameters # @return [Array<(NoteMessage, Integer, Hash)>] NoteMessage data, response status code and response headers def create_tenant_note_with_http_info(tenant_id, create_lease_note_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.create_tenant_note ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.create_tenant_note" end # verify the required parameter 'create_lease_note_request' is set if @api_client.config.client_side_validation && create_lease_note_request.nil? fail ArgumentError, "Missing the required parameter 'create_lease_note_request' when calling RentalTenantsApi.create_tenant_note" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}/notes'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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(create_lease_note_request) # return_type return_type = opts[:debug_return_type] || 'NoteMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"RentalTenantsApi.create_tenant_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: RentalTenantsApi#create_tenant_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all notes # Retrieves all tenant notes.

Required permission(s):

Rentals > Tenants - `View` # @param tenant_id [Integer] The tenant identifier. # @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_all_tenant_notes(tenant_id, opts = {}) data, _status_code, _headers = get_all_tenant_notes_with_http_info(tenant_id, opts) data end # Retrieve all notes # Retrieves all tenant notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` # @param tenant_id [Integer] The tenant identifier. # @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_all_tenant_notes_with_http_info(tenant_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.get_all_tenant_notes ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.get_all_tenant_notes" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}/notes'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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 => :"RentalTenantsApi.get_all_tenant_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: RentalTenantsApi#get_all_tenant_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all tenants # Retrieves a list of tenants.

Required permission(s):

Rentals > Tenants - `View` # @param [Hash] opts the optional parameters # @option opts [Array] :buildingstatuses Filters results by the status of the rental property the tenants are associated with. If no status is specified tenants in either `active` and `inactive` rental properties will be returned. # @option opts [Array] :leasetermstatuses Filters results to any tenant whose lease term matches the specified status. If no status is specified tenants with any lease terms status will be returned. # @option opts [String] :unitnumber Filters results to any tenant whose unit number *contains* the specified value. # @option opts [String] :name Filters results to any tenant whose name *contains* the specified value. # @option opts [String] :phone Filters results to any tenant whose phone number *contains* the specified value. # @option opts [String] :email Filters results to any tenant whose email *contains* the specified value. # @option opts [Array] :propertyids Filters results to tenants whose rental unit belongs to the specified set of property ids. # @option opts [Array] :rentalownerids Filters results to tenants whose rental unit belongs to a property with a rental owner in the specified set of rental owner ids. # @option opts [Time] :lastupdatedfrom Filters results to any rental tenants 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 tenants 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 [Array] :unitids Filters results to only tenants associated with the specified set of unit ids. # @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_tenants(opts = {}) data, _status_code, _headers = get_all_tenants_with_http_info(opts) data end # Retrieve all tenants # Retrieves a list of tenants. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` # @param [Hash] opts the optional parameters # @option opts [Array] :buildingstatuses Filters results by the status of the rental property the tenants are associated with. If no status is specified tenants in either `active` and `inactive` rental properties will be returned. # @option opts [Array] :leasetermstatuses Filters results to any tenant whose lease term matches the specified status. If no status is specified tenants with any lease terms status will be returned. # @option opts [String] :unitnumber Filters results to any tenant whose unit number *contains* the specified value. # @option opts [String] :name Filters results to any tenant whose name *contains* the specified value. # @option opts [String] :phone Filters results to any tenant whose phone number *contains* the specified value. # @option opts [String] :email Filters results to any tenant whose email *contains* the specified value. # @option opts [Array] :propertyids Filters results to tenants whose rental unit belongs to the specified set of property ids. # @option opts [Array] :rentalownerids Filters results to tenants whose rental unit belongs to a property with a rental owner in the specified set of rental owner ids. # @option opts [Time] :lastupdatedfrom Filters results to any rental tenants 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 tenants 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 [Array] :unitids Filters results to only tenants associated with the specified set of unit ids. # @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_tenants_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.get_all_tenants ...' end allowable_values = ["Active", "InActive"] if @api_client.config.client_side_validation && opts[:'buildingstatuses'] && !opts[:'buildingstatuses'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"buildingstatuses\", must include one of #{allowable_values}" end allowable_values = ["Active", "Past", "Future"] if @api_client.config.client_side_validation && opts[:'leasetermstatuses'] && !opts[:'leasetermstatuses'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"leasetermstatuses\", must include one of #{allowable_values}" end # resource path local_var_path = '/v1/leases/tenants' # query parameters query_params = opts[:query_params] || {} query_params[:'buildingstatuses'] = @api_client.build_collection_param(opts[:'buildingstatuses'], :multi) if !opts[:'buildingstatuses'].nil? query_params[:'leasetermstatuses'] = @api_client.build_collection_param(opts[:'leasetermstatuses'], :multi) if !opts[:'leasetermstatuses'].nil? query_params[:'unitnumber'] = opts[:'unitnumber'] if !opts[:'unitnumber'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'phone'] = opts[:'phone'] if !opts[:'phone'].nil? query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil? query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil? query_params[:'rentalownerids'] = @api_client.build_collection_param(opts[:'rentalownerids'], :multi) if !opts[:'rentalownerids'].nil? query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil? query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil? query_params[:'unitids'] = @api_client.build_collection_param(opts[:'unitids'], :multi) if !opts[:'unitids'].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 => :"RentalTenantsApi.get_all_tenants", :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: RentalTenantsApi#get_all_tenants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a tenant # Retrieve a specific tenant.

Required permission(s):

Rentals > Tenants - `View` # @param tenant_id [Integer] The tenant identifier. # @param [Hash] opts the optional parameters # @return [TenantMessage] def get_tenant_by_id(tenant_id, opts = {}) data, _status_code, _headers = get_tenant_by_id_with_http_info(tenant_id, opts) data end # Retrieve a tenant # Retrieve a specific tenant. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` # @param tenant_id [Integer] The tenant identifier. # @param [Hash] opts the optional parameters # @return [Array<(TenantMessage, Integer, Hash)>] TenantMessage data, response status code and response headers def get_tenant_by_id_with_http_info(tenant_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.get_tenant_by_id ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.get_tenant_by_id" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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] || 'TenantMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"RentalTenantsApi.get_tenant_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: RentalTenantsApi#get_tenant_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a note # Retrieves a tenant note.

Required permission(s):

Rentals > Tenants - `View` # @param tenant_id [Integer] # @param note_id [Integer] # @param [Hash] opts the optional parameters # @return [NoteMessage] def get_tenant_note_by_id(tenant_id, note_id, opts = {}) data, _status_code, _headers = get_tenant_note_by_id_with_http_info(tenant_id, note_id, opts) data end # Retrieve a note # Retrieves a tenant note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` # @param tenant_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_tenant_note_by_id_with_http_info(tenant_id, note_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.get_tenant_note_by_id ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.get_tenant_note_by_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 RentalTenantsApi.get_tenant_note_by_id" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}/notes/{noteId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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 => :"RentalTenantsApi.get_tenant_note_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: RentalTenantsApi#get_tenant_note_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a note # Updates a tenant 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 > Tenants - `View` `Edit` # @param tenant_id [Integer] # @param note_id [Integer] # @param update_lease_note_request [UpdateLeaseNoteRequest] # @param [Hash] opts the optional parameters # @return [NoteMessage] def update_lease_tenant_note(tenant_id, note_id, update_lease_note_request, opts = {}) data, _status_code, _headers = update_lease_tenant_note_with_http_info(tenant_id, note_id, update_lease_note_request, opts) data end # Update a note # Updates a tenant 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 > Tenants</span> - `View` `Edit` # @param tenant_id [Integer] # @param note_id [Integer] # @param update_lease_note_request [UpdateLeaseNoteRequest] # @param [Hash] opts the optional parameters # @return [Array<(NoteMessage, Integer, Hash)>] NoteMessage data, response status code and response headers def update_lease_tenant_note_with_http_info(tenant_id, note_id, update_lease_note_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.update_lease_tenant_note ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.update_lease_tenant_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 RentalTenantsApi.update_lease_tenant_note" end # verify the required parameter 'update_lease_note_request' is set if @api_client.config.client_side_validation && update_lease_note_request.nil? fail ArgumentError, "Missing the required parameter 'update_lease_note_request' when calling RentalTenantsApi.update_lease_tenant_note" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}/notes/{noteId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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(update_lease_note_request) # return_type return_type = opts[:debug_return_type] || 'NoteMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"RentalTenantsApi.update_lease_tenant_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: RentalTenantsApi#update_lease_tenant_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a tenant # Updates a rental tenant.

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 > Tenants - `View` `Edit` # @param tenant_id [Integer] # @param update_rental_tenant_request [UpdateRentalTenantRequest] # @param [Hash] opts the optional parameters # @return [TenantMessage] def update_rental_tenant(tenant_id, update_rental_tenant_request, opts = {}) data, _status_code, _headers = update_rental_tenant_with_http_info(tenant_id, update_rental_tenant_request, opts) data end # Update a tenant # Updates a rental tenant. <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 > Tenants</span> - `View` `Edit` # @param tenant_id [Integer] # @param update_rental_tenant_request [UpdateRentalTenantRequest] # @param [Hash] opts the optional parameters # @return [Array<(TenantMessage, Integer, Hash)>] TenantMessage data, response status code and response headers def update_rental_tenant_with_http_info(tenant_id, update_rental_tenant_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RentalTenantsApi.update_rental_tenant ...' end # verify the required parameter 'tenant_id' is set if @api_client.config.client_side_validation && tenant_id.nil? fail ArgumentError, "Missing the required parameter 'tenant_id' when calling RentalTenantsApi.update_rental_tenant" end # verify the required parameter 'update_rental_tenant_request' is set if @api_client.config.client_side_validation && update_rental_tenant_request.nil? fail ArgumentError, "Missing the required parameter 'update_rental_tenant_request' when calling RentalTenantsApi.update_rental_tenant" end # resource path local_var_path = '/v1/leases/tenants/{tenantId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_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(update_rental_tenant_request) # return_type return_type = opts[:debug_return_type] || 'TenantMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"RentalTenantsApi.update_rental_tenant", :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: RentalTenantsApi#update_rental_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end